Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Every module that you install in Geronimo, whether it is a service, application, resource, etc., can be configured via a deployment plan. These deployment plans are XML files based on XML Schemas containing the configuration details for a specific application module or component. The Java EE 5 specification defines standard deployment descriptors such as web.xml, application.xml, etc. In some cases, the deployment descriptor is all that is required to install a module into a Geronimo server. However, in many cases, server-specific configuration is required when modules are installed. This server-specific configuration is accomplished by using Geronimo deployment plans.

Geronimo deployment plans can be packaged along with the application or specified externally at deployment time. If provided during deployment, this plan will overwrite any other Geronimo specific deployment plan provided with the application.

To package the deployment plans in you application you have to follow some naming conventions and place the file in a specific directory within your packaged application. For example, in a web application you would include the geronimo-web.xml under the /WEB-INF directory, same place where you are also providing the web.xml descriptor, all within the WAR. For an enterprise application you would include the geronimo-application.xml under the /META-INF directory, same place where you are also providing the application.xml descriptor, all within the WAR.

The Java EE 5 specification also let's you use Annotations where you add resource references, dependencies, etc. directly in the code. Geronimo provides a Deployment plan wizard that automatically generates the necessary deployment plans based on the standard deployment descriptors and annotations.

Note

The default namespace of the above XML document is http://java.sun.com/xml/ns/javaeeImage Removed. The XML elements that do not have a namespace prefix belong to the default namespace.

With Servlet 2.5 specification, many of the declarations done through web.xml can also be done through corresponding annotations in the servlets and JSPs. When both annotations and web.xml are provided, the declarations in web.xml takes precedence over annotations.

The web module connects to back end datasource using its JNDI name jdbc/DataSource as declared in the web.xml.

Note

The default namespace of the above XML document is http://java.sun.com/xml/ns/javaeeImage Removed. The XML elements that do not have a namespace prefix belong to the default namespace.

In EJB3.0, most of the deployment descriptor declarations can be done through the corresponding annotations in the bean class. However, if a deployment descriptor is supplied (ejb-jar.xml), the declarations in the deployment descriptor will override the annotations.

The ejb module connects to back end datasource using its JNDI name jdbc/DataSource as declared in the ejb-jar.xml. It also declares that the ejb is a stateless session bean and provides an interceptor class for the bean. The interceptor class will have callback methods which container calls when the corresponding events occur in the bean's life cycle.

...

Here is a list of all Java EE 5 annotations supported by Geronimo:


JSR

Annotation

Deployment
Descriptor
Tag(s)

Supported in

Notes

JSR 250
(Common Annotations)

1. javax.annotation.Generated

 

 

The only annotation with SOURCE retention. All the others are RUNTIME.

 

2. javax.annotation.PostConstruct

<post-construct>

(tick) Client JAR
(tick) EJB JAR
(tick) WAR
(info) TLD

(info) See JavaServer
Pages™ Specification Version 2.1, Section JSP.7.1.11 Resource Injection

 

3. javax.annotation.PreDestroy

<pre-destroy>

(tick) Client JAR
(tick) EJB JAR
(tick) WAR
(info) TLD

(info) See JavaServer Pages™ Specification Version 2.1, Section JSP.7.1.11 Resource Injection

 

4. javax.annotation.Resource

1. <env-entry>

(tick) EJB JAR
(tick) WAR
(info) TLD

(info) See JavaServer Pages™ Specification Version 2.1, Section JSP.7.1.11 Resource Injection

 

4. javax.annotation.Resource

2. <service-ref>

(tick) EJB JAR
(tick) WAR
(info) TLD

(info) See JavaServer Pages™ Specification Version 2.1, Section JSP.7.1.11 Resource Injection

 

4. javax.annotation.Resource

3. <resource-ref>

(tick) EJB JAR
(tick) RAR
(tick) WAR
(info) TLD

(info) See JavaServer Pages™ Specification Version 2.1, Section JSP.7.1.11 Resource Injection

 

4. javax.annotation.Resource

4. <message-destination-ref>

(tick) EJB JAR
(tick) RAR
(tick) WAR
(info) TLD

(info) See JavaServer Pages™ Specification Version 2.1, Section JSP.7.1.11 Resource Injection

 

4. javax.annotation.Resource

5. <resource-env-ref>

(tick) EJB JAR
(tick) RAR
(tick) WAR
(info) TLD

(info) See JavaServer Pages™ Specification Version 2.1, Section JSP.7.1.11 Resource Injection

 

4. javax.annotation.Resource

6. <webservice-context>

(tick) EJB JAR
(tick) WAR
(info) TLD

(info) See JavaServer Pages™ Specification Version 2.1, Section JSP.7.1.11 Resource Injection

 

5. javax.annotation.Resources

 

 

Same as javax.annotation.Resource

 

6. javax.annotation.security.DeclareRoles

<security-role-ref>

(tick) EJB JAR
(tick) WAR

 

 

7. javax.annotation.security.DenyAll

 

(tick) EJB JAR
(tick) WAR

Not supported in servlets. See Java™ Platform, Enterprise Edition (Java EE) Specification, v5, Page 141, Section EE.6.24, Table EE.6-E

 

8. javax.annotation.security.PermitAll

<unchecked>

(tick) EJB JAR
(tick) WAR

Not supported in servlets. See Java™ Platform, Enterprise Edition (Java EE) Specification, v5, Page 141, Section EE.6.24, Table EE.6-E

 

9. javax.annotation.security.RolesAllowed

<role-name>

(tick) EJB JAR
(tick) WAR

Not supported in servlets. See Java™ Platform, Enterprise Edition (Java EE) Specification, v5, Page 141, Section EE.6.24, Table EE.6-E

 

10. javax.annotation.security.RunAs

<run-as>

(tick) EJB JAR
(tick) WAR

Servlets only. See Java™ Platform, Enterprise Edition (Java EE) Specification, v5, Page 141, Section EE.6.24, Table EE.6-E

JSR

Annotation

Deployment
Descriptor
Tag(s)

Supported in

Notes

JSR-220
(EJB 3.0)

1. javax.ejb.ActivationConfigProperty

<activation-config-property>

(tick) Client JAR
(tick) EJB JAR

 

 

2. javax.ejb.ApplicationException

<application-exception>

(tick) Client JAR
(tick) EJB JAR

 

 

3. javax.ejb.EJB

1. <ejb-ref>

(tick) Client JAR
(tick) EJB JAR
(tick) WAR
(info) TLD

(info) See JavaServer Pages™ Specification Version 2.1, Section JSP.7.1.11 Resource Injection

 

3. javax.ejb.EJB

2. <ejb-local-ref>

(tick) Client JAR
(tick) EJB JAR
(tick) WAR
(info) TLD

(info) See JavaServer Pages™ Specification Version 2.1, Section JSP.7.1.11 Resource Injection

 

4. javax.ejb.EJBs

 

 

Same as javax.ejb.EJB

 

5. javax.ejb.Init

 

(tick) Client JAR
(tick) EJB JAR

 

 

6. javax.ejb.Local

<local>

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

7. javax.ejb.LocalHome

<local-home>

(tick) Client JAR
(tick) EJB JAR

 

 

8. javax.ejb.MessageDriven

<message-driven>

(tick) Client JAR
(tick) EJB JAR

 

 

9. javax.ejb.PostActivate

<post-activate>

(tick) Client JAR
(tick) EJB JAR

 

 

10. javax.ejb.PrePassivate

<pre-passivate>

(tick) Client JAR
(tick) EJB JAR

 

 

11. javax.ejb.Remote

<remote>

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

12. javax.ejb.RemoteHome

<home>

(tick) Client JAR
(tick) EJB JAR

 

 

13. javax.ejb.Remove

 

(tick) Client JAR
(tick) EJB JAR

 

 

14. javax.ejb.Stateful

<stateful>

(tick) Client JAR
(tick) EJB JAR

 

 

15. javax.ejb.Stateless

<stateless>

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

16. javax.ejb.Timeout

 

(tick) Client JAR
(tick) EJB JAR

 

 

17. javax.ejb.TransactionAttribute

<trans-attribute>

(tick) Client JAR
(tick) EJB JAR

 

 

18. javax.ejb.TransactionManagement

 

(tick) Client JAR
(tick) EJB JAR

 

JSR

Annotation

Deployment
Descriptor
Tag(s)

Supported in

Notes

JSR-220
(EJB 3.0)

1. javax.interceptor.AroundInvoke

<around-invoke>

(tick) EJB JAR
(tick) WAR

 

 

2. javax.interceptor.ExcludeClassInterceptors

<exclude-class-interceptors>

(tick) EJB JAR
(tick) WAR

 

 

3. javax.interceptor.ExcludeDefaultInterceptors

<exclude-default-interceptors>

(tick) EJB JAR
(tick) WAR

 

 

4. javax.interceptor.Interceptors

<interceptors>

(tick) EJB JAR
(tick) WAR

 

JSR

Annotation

Deployment
Descriptor
Tag(s)

Supported in

Notes

JSR-181
(Web
Services
Metadata 2.0)

1. javax.jws.HandlerChain

<handler-chain>

(tick) EJB JAR
(tick) WAR
(info) HC

(info) See Web Services Metadata
for the JavaTM Platform, Section 4.6 Annotation HandlerChain

 

2. javax.jws.Oneway

 

(tick) EJB JAR
(tick) WAR

 

 

3. javax.jws.WebMethod

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

4. javax.jws.WebParam

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

5. javax.jws.WebResult

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

6. javax.jws.WebService

<service-ref-type>

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

7. javax.jws.soap.InitParam

 

(tick) EJB JAR
(tick) WAR

 

 

8. javax.jws.soap.SOAPBinding

 

(tick) EJB JAR
(tick) WAR

 

 

9. javax.jws.soap.SOAPMessageHandler

 

(tick) EJB JAR
(tick) WAR

 

 

10. javax.jws.soap.SOAPMessageHandlers

 

 

Same as javax.jws.soap.SOAPMessageHandler

JSR

Annotation

Deployment
Descriptor
Tag(s)

Supported in

Notes

JSR-220
(JPA 1.0)

1. javax.persistence.AssociationOverride

 

(tick) EJB JAR
(tick) WAR

 

 

2. javax.persistence.AssociationOverrides

 

 

Same as javax.persistence.AssociationOverride

 

3. javax.persistence.AttributeOverride

 

(tick) EJB JAR
(tick) WAR

 

 

4. javax.persistence.AttributeOverrides

 

 

javax.persistence.AttributeOverride

 

5. javax.persistence.Basic

 

(tick) EJB JAR
(tick) WAR

 

 

6. javax.persistence.Column

 

(tick) EJB JAR
(tick) WAR

 

 

7. javax.persistence.ColumnResult

 

(tick) EJB JAR
(tick) WAR

 

 

8. javax.persistence.DiscriminatorColumn

 

(tick) EJB JAR
(tick) WAR

 

 

9. javax.persistence.DiscriminatorValue

 

(tick) EJB JAR
(tick) WAR

 

 

10. javax.persistence.Embeddable

 

(tick) EJB JAR
(tick) WAR

 

 

11. javax.persistence.Embedded

 

(tick) EJB JAR
(tick) WAR

 

 

12. javax.persistence.EmbeddedId

 

(tick) EJB JAR
(tick) WAR

 

 

13. javax.persistence.Entity

 

(tick) EJB JAR
(tick) WAR

 

 

14. javax.persistence.EntityListeners

 

(tick) EJB JAR
(tick) WAR

 

 

15. javax.persistence.EntityResult

 

(tick) EJB JAR
(tick) WAR

 

 

16. javax.persistence.Enumerated

 

(tick) EJB JAR
(tick) WAR

 

 

17. javax.persistence.ExcludeDefaultListeners

 

(tick) EJB JAR
(tick) WAR

 

 

18. javax.persistence.ExcludeSuperclassListeners

 

(tick) EJB JAR
(tick) WAR

 

 

19. javax.persistence.FieldResult

 

(tick) EJB JAR
(tick) WAR

 

 

20. javax.persistence.GeneratedValue

 

(tick) EJB JAR
(tick) WAR

 

 

21. javax.persistence.Id

 

(tick) EJB JAR
(tick) WAR

 

 

22. javax.persistence.IdClass

 

(tick) EJB JAR
(tick) WAR

 

 

23. javax.persistence.Inheritance

 

(tick) EJB JAR
(tick) WAR

 

 

24. javax.persistence.JoinColumn

 

(tick) EJB JAR
(tick) WAR

 

 

25. javax.persistence.JoinColumns

 

 

Same as javax.persistence.JoinColumn

 

26. javax.persistence.JoinTable

 

(tick) EJB JAR
(tick) WAR

 

 

27. javax.persistence.Lob

 

(tick) EJB JAR
(tick) WAR

 

 

28. javax.persistence.ManyToMany

 

(tick) EJB JAR
(tick) WAR

 

 

29. javax.persistence.ManyToOne

 

(tick) EJB JAR
(tick) WAR

 

 

30. javax.persistence.MapKey

 

(tick) EJB JAR
(tick) WAR

 

 

31. javax.persistence.MappedSuperclass

 

(tick) EJB JAR
(tick) WAR

 

 

32. javax.persistence.NamedNativeQueries

 

(tick) EJB JAR
(tick) WAR

 

 

33. javax.persistence.NamedNativeQuery

 

(tick) EJB JAR
(tick) WAR

 

 

34. javax.persistence.NamedQueries

 

(tick) EJB JAR
(tick) WAR

 

 

35. javax.persistence.NamedQuery

 

(tick) EJB JAR
(tick) WAR

 

 

36. javax.persistence.OneToMany

 

(tick) EJB JAR
(tick) WAR

 

 

37. javax.persistence.OneToOne

 

(tick) EJB JAR
(tick) WAR

 

 

38. javax.persistence.OrderBy

 

(tick) EJB JAR
(tick) WAR

 

 

39. javax.persistence.PersistenceContext

<persistence-context-ref>

(tick) EJB JAR
(tick) WAR
(info) TLD

(info) See JavaServer Pages™ Specification Version 2.1, Section JSP.7.1.11 Resource Injection

 

40. javax.persistence.PersistenceContexts

 

 

Same as javax.persistence.PersistenceContext

 

41. javax.persistence.PersistenceProperty

<persistence-property>

(tick) EJB JAR
(tick) WAR

 

 

42. javax.persistence.PersistenceUnit

<persistence-unit-ref>

(tick) EJB JAR
(tick) WAR
(info) TLD

(info) See JavaServer Pages™ Specification Version 2.1, Section JSP.7.1.11 Resource Injection

 

43. javax.persistence.PersistenceUnits

 

 

Same as javax.persistence.PersistenceUnits

 

44. javax.persistence.PostLoad

 

(tick) EJB JAR
(tick) WAR

 

 

45. javax.persistence.PostPersist

 

(tick) EJB JAR
(tick) WAR

 

 

46. javax.persistence.PostRemove

 

(tick) EJB JAR
(tick) WAR

 

 

47. javax.persistence.PostUpdate

 

(tick) EJB JAR
(tick) WAR

 

 

48. javax.persistence.PrePersist

 

(tick) EJB JAR
(tick) WAR

 

 

49. javax.persistence.PreRemove

 

(tick) EJB JAR
(tick) WAR

 

 

50. javax.persistence.PreUpdate

 

(tick) EJB JAR
(tick) WAR

 

 

51. javax.persistence.PrimaryKeyJoinColumn

 

(tick) EJB JAR
(tick) WAR

 

 

52. javax.persistence.PrimaryKeyJoinColumns

 

 

Same as javax.persistence.PrimaryKeyJoinColumn

 

53. javax.persistence.QueryHint

 

(tick) EJB JAR
(tick) WAR

 

 

54. javax.persistence.SecondaryTable

 

(tick) EJB JAR
(tick) WAR

 

 

55. javax.persistence.SecondaryTables

 

 

Same as javax.persistence.SecondaryTable

 

56. javax.persistence.SequenceGenerator

 

(tick) EJB JAR
(tick) WAR

 

 

57. javax.persistence.SqlResultSetMapping

 

(tick) EJB JAR
(tick) WAR

 

 

58. javax.persistence.SqlResultSetMappings

 

 

Same as javax.persistence.SqlResultSetMapping

 

59. javax.persistence.Table

 

(tick) EJB JAR
(tick) WAR

 

 

60. javax.persistence.TableGenerator

 

(tick) EJB JAR
(tick) WAR

 

 

61. javax.persistence.Temporal

 

(tick) EJB JAR
(tick) WAR

 

 

62. javax.persistence.Transient

 

(tick) EJB JAR
(tick) WAR

 

 

63. javax.persistence.UniqueConstraint

 

(tick) EJB JAR
(tick) WAR

 

 

64. javax.persistence.Version

 

(tick) EJB JAR
(tick) WAR

 

JSR

Annotation

Deployment
Descriptor
Tag(s)

Supported in

Notes

JSR-222
(JAXB 2.0)

1. javax.xml.bind.annotation.XmlAccessorOrder

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

2. javax.xml.bind.annotation.XmlAccessorType

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

3. javax.xml.bind.annotation.XmlAnyAttribute

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

4. javax.xml.bind.annotation.XmlAnyElement

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

5. javax.xml.bind.annotation.XmlAttachmentRef

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

6. javax.xml.bind.annotation.XmlAttribute

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

7. javax.xml.bind.annotation.XmlElement

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

8. javax.xml.bind.annotation.XmlElementDecl

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

9. javax.xml.bind.annotation.XmlElementRef

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

10. javax.xml.bind.annotation.XmlElementRefs

 

 

Same as javax.xml.bind.annotation.XmlElementRef

 

11. javax.xml.bind.annotation.XmlElementWrapper

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

12. javax.xml.bind.annotation.XmlElements

 

 

Same as javax.xml.bind.annotation.XmlElement

 

13. javax.xml.bind.annotation.XmlEnum

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

14. javax.xml.bind.annotation.XmlEnumValue

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

15. javax.xml.bind.annotation.XmlID

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

16. javax.xml.bind.annotation.XmlIDREF

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

17. javax.xml.bind.annotation.XmlInlineBinaryData

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

18. javax.xml.bind.annotation.XmlList

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

19. javax.xml.bind.annotation.XmlMimeType

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

20. javax.xml.bind.annotation.XmlMixed

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

21. javax.xml.bind.annotation.XmlNs

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

22. javax.xml.bind.annotation.XmlRegistry

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

23. javax.xml.bind.annotation.XmlRootElement

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

24. javax.xml.bind.annotation.XmlSchema

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

25. javax.xml.bind.annotation.XmlSchemaType

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

26. javax.xml.bind.annotation.XmlSchemaTypes

 

 

Same as javax.xml.bind.annotation.XmlSchemaType

 

27. javax.xml.bind.annotation.XmlTransient

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

28. javax.xml.bind.annotation.XmlType

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

29. javax.xml.bind.annotation.XmlValue

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

30. javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

31. javax.xml.bind.annotation.adapters.XmlJavaTypeAdapters

 

 

Same as javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter

JSR

Annotation

Deployment
Descriptor
Tag(s)

Supported_in

Notes

JSR-224
(JAX-WS 2.0)

1. javax.xml.ws.BindingType

 

(tick) EJB JAR
(tick) WAR

 

 

2. javax.xml.ws.RequestWrapper

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

3. javax.xml.ws.ResponseWrapper

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

4. javax.xml.ws.ServiceMode

 

(tick) EJB JAR
(tick) WAR

 

 

5. javax.xml.ws.WebEndpoint

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

6. javax.xml.ws.WebFault

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

7. javax.xml.ws.WebServiceClient

 

(tick) Client JAR
(tick) EJB JAR
(tick) WAR

 

 

8. javax.xml.ws.WebServiceProvider

 

(tick) EJB JAR
(tick) WAR

 

 

9. javax.xml.ws.WebServiceRef

<service-ref>

(tick) EJB JAR
(tick) WAR
(info) TLD

(info) See JavaServer Pages™ Specification Version 2.1, Section JSP.7.1.11 Resource Injection

 

10. javax.xml.ws.WebServiceRefs

 

 

Same as javax.xml.ws.WebServiceRef

 

11. javax.xml.ws.addressing.Action

 

(tick) EJB JAR
(tick) WAR

 

 

12. javax.xml.ws.addressing.FaultAction

 

(tick) EJB JAR
(tick) WAR