Package org.jboss.metadata.ejb.spec

Class EjbJarMetaData

java.lang.Object

org.jboss.metadata.javaee.support.IdMetaDataImpl

org.jboss.metadata.javaee.support.IdMetaDataImplWithDescriptionGroup

org.jboss.metadata.ejb.spec.EjbJarMetaData

All Implemented Interfaces:

java.io.Serializable, IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>, IdMetaData

public class EjbJarMetaData
extends IdMetaDataImplWithDescriptionGroup
implements IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

EjbJarMetaData.

Version:

$Revision: 1.1 $

Author:

Adrian Brock

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	LATEST_EJB_JAR_XSD_VERSION	The latest available ejb-jar xsd version

Constructor Summary

Constructors

Constructor	Description
EjbJarMetaData(EjbJarVersion ejbJarVersion)	Create a new EjbJarMetaData.

Method Summary

Modifier and Type	Method	Description
EjbJarMetaData	createMerged(EjbJarMetaData original)
static java.util.Collection<java.lang.String>	getAllInterceptorClasses(EjbJarMetaData ejbJar)	Returns all interceptor classes which are present in the passed ejbJar.
AssemblyDescriptorMetaData	getAssemblyDescriptor()	Get the assemblyDescriptor.
java.lang.String	getDistinctName()
java.lang.String	getDtdPublicId()	Get the DTD public id if one was seen
java.lang.String	getDtdSystemId()	Get the DTD system id if one was seen
java.lang.String	getEjbClientJar()	Get the ejbClientJar.
EjbJarVersion	getEjbJarVersion()
AbstractEnterpriseBeanMetaData	getEnterpriseBean(java.lang.String name)
EnterpriseBeansMetaData	getEnterpriseBeans()	Get the enterpriseBeans.
InterceptorsMetaData	getInterceptors()	Get the interceptors.
static InterceptorsMetaData	getInterceptors(java.lang.String beanName, EjbJarMetaData ejbJarMetaData)	Returns the InterceptorsMetaData which are applicable for the beanName in the ejbJarMetaData
java.lang.String	getModuleName()
RelationsMetaData	getRelationships()	Get the relationships.
java.lang.String	getVersion()	Get the version.
boolean	isEJB1x()	Whether this is ejb1.x
boolean	isEJB21()	Whether this is ejb2.1
boolean	isEJB2x()	Whether this is ejb2.x
boolean	isEJB30()	Whether this is EJB3.0 bean
boolean	isEJB31()	Whether this is EJB3.1 bean
boolean	isEJB32()	Whether this is EJB3.2 bean
boolean	isEJB3x()	Whether this is ejb3.x
boolean	isMetadataComplete()	Get the metadataComplete.
boolean	isVersionGreaterThan(EjbJarVersion version)	Returns true if the version represented by this EjbJarMetaData is greater than the passed version
boolean	isVersionGreaterThanOrEqual(EjbJarVersion version)	Returns true if the version represented by this EjbJarMetaData is greater than or equal to the passed version
protected void	merge(EjbJarMetaData override, EjbJarMetaData original)
void	setAssemblyDescriptor(AssemblyDescriptorMetaData assemblyDescriptor)	Set the assemblyDescriptor.
void	setDistinctName(java.lang.String distinctName)
void	setDTD(java.lang.String root, java.lang.String publicId, java.lang.String systemId)	Callback for the DTD information
void	setEjbClientJar(java.lang.String ejbClientJar)	Set the ejbClientJar.
void	setEnterpriseBeans(EnterpriseBeansMetaData enterpriseBeans)	Set the enterpriseBeans.
void	setInterceptors(InterceptorsMetaData interceptors)	Set the interceptors.
void	setMetadataComplete(boolean metadataComplete)	Set the metadataComplete.
void	setModuleName(java.lang.String moduleName)
void	setRelationships(RelationsMetaData relationships)	Set the relationships.
void	setVersion(java.lang.String version)	Set the version.

Methods inherited from class org.jboss.metadata.javaee.support.IdMetaDataImpl

clone, equals, getId, hashCode, setId

Methods inherited from class org.jboss.metadata.javaee.support.IdMetaDataImplWithDescriptionGroup

getDescriptionGroup, setDescriptionGroup

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

LATEST_EJB_JAR_XSD_VERSION

public static final java.lang.String LATEST_EJB_JAR_XSD_VERSION

The latest available ejb-jar xsd version

See Also:

Constant Field Values

Constructor Detail

EjbJarMetaData

public EjbJarMetaData(EjbJarVersion ejbJarVersion)

Create a new EjbJarMetaData.

Parameters:

ejbJarVersion -

Method Detail

isMetadataComplete

public boolean isMetadataComplete()

Get the metadataComplete.

Returns:

the metadataComplete.

setMetadataComplete

public void setMetadataComplete(boolean metadataComplete)

Set the metadataComplete.

Parameters:

metadataComplete - the metadataComplete.

getInterceptors

public InterceptorsMetaData getInterceptors()

Get the interceptors.

Specified by:

getInterceptors in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Returns:

the interceptors.

setInterceptors

public void setInterceptors(InterceptorsMetaData interceptors)

Set the interceptors.

Parameters:

interceptors - the interceptors.

Throws:

java.lang.IllegalArgumentException - for a null interceptors

merge

protected void merge(EjbJarMetaData override,
                     EjbJarMetaData original)

setDTD

public void setDTD(java.lang.String root,
                   java.lang.String publicId,
                   java.lang.String systemId)

Callback for the DTD information

Parameters:

root -

publicId -

systemId -

getDtdPublicId

public java.lang.String getDtdPublicId()

Get the DTD public id if one was seen

Returns:

the value of the web.xml dtd public id

getDtdSystemId

public java.lang.String getDtdSystemId()

Get the DTD system id if one was seen

Returns:

the value of the web.xml dtd system id

getVersion

public java.lang.String getVersion()

Get the version.

Specified by:

getVersion in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Returns:

the version.

setVersion

public void setVersion(java.lang.String version)

Set the version.

Specified by:

setVersion in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Parameters:

version - the version.

Throws:

java.lang.IllegalArgumentException - for a null version

isEJB1x

public boolean isEJB1x()

Whether this is ejb1.x

Specified by:

isEJB1x in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Returns:

true when ejb1.x

isEJB2x

public boolean isEJB2x()

Whether this is ejb2.x

Specified by:

isEJB2x in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Returns:

true when ejb2.x

isEJB21

public boolean isEJB21()

Whether this is ejb2.1

Specified by:

isEJB21 in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Returns:

true when ejb2.1

isEJB3x

public boolean isEJB3x()

Whether this is ejb3.x

Specified by:

isEJB3x in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Returns:

true when ejb3.x

isEJB30

public boolean isEJB30()

Whether this is EJB3.0 bean

Returns:

isEJB31

public boolean isEJB31()

Whether this is EJB3.1 bean

Returns:

isEJB32

public boolean isEJB32()

Whether this is EJB3.2 bean

Returns:

isVersionGreaterThan

public boolean isVersionGreaterThan(EjbJarVersion version)

Returns true if the version represented by this EjbJarMetaData is greater than the passed version

Parameters:

version - The version being compared

Returns:

isVersionGreaterThanOrEqual

public boolean isVersionGreaterThanOrEqual(EjbJarVersion version)

Returns true if the version represented by this EjbJarMetaData is greater than or equal to the passed version

Parameters:

version - The version being compared

Returns:

getEjbClientJar

public java.lang.String getEjbClientJar()

Get the ejbClientJar.

Specified by:

getEjbClientJar in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Returns:

the ejbClientJar.

setEjbClientJar

public void setEjbClientJar(java.lang.String ejbClientJar)

Set the ejbClientJar.

Specified by:

setEjbClientJar in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Parameters:

ejbClientJar - the ejbClientJar.

Throws:

java.lang.IllegalArgumentException - for a null ejbClientJar

getEnterpriseBeans

public EnterpriseBeansMetaData getEnterpriseBeans()

Get the enterpriseBeans.

Specified by:

getEnterpriseBeans in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Returns:

the enterpriseBeans.

setEnterpriseBeans

public void setEnterpriseBeans(EnterpriseBeansMetaData enterpriseBeans)

Set the enterpriseBeans.

Specified by:

setEnterpriseBeans in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Parameters:

enterpriseBeans - the enterpriseBeans.

Throws:

java.lang.IllegalArgumentException - for a null enterpriseBeans

getEnterpriseBean

public AbstractEnterpriseBeanMetaData getEnterpriseBean(java.lang.String name)

Specified by:

getEnterpriseBean in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

getEjbJarVersion

public final EjbJarVersion getEjbJarVersion()

getRelationships

public RelationsMetaData getRelationships()

Get the relationships.

Specified by:

getRelationships in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Returns:

the relationships.

setRelationships

public void setRelationships(RelationsMetaData relationships)

Set the relationships.

Specified by:

setRelationships in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Parameters:

relationships - the relationships.

Throws:

java.lang.IllegalArgumentException - for a null relationships

getAssemblyDescriptor

public AssemblyDescriptorMetaData getAssemblyDescriptor()

Get the assemblyDescriptor.

Specified by:

getAssemblyDescriptor in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Returns:

the assemblyDescriptor.

setAssemblyDescriptor

public void setAssemblyDescriptor(AssemblyDescriptorMetaData assemblyDescriptor)

Set the assemblyDescriptor.

Specified by:

setAssemblyDescriptor in interface IEjbJarMetaData<AssemblyDescriptorMetaData,EnterpriseBeansMetaData,AbstractEnterpriseBeanMetaData,EjbJarMetaData>

Parameters:

assemblyDescriptor - the assemblyDescriptor.

Throws:

java.lang.IllegalArgumentException - for a null assemblyDescriptor

getModuleName

public java.lang.String getModuleName()

setModuleName

public void setModuleName(java.lang.String moduleName)

getInterceptors

public static InterceptorsMetaData getInterceptors(java.lang.String beanName,
                                                   EjbJarMetaData ejbJarMetaData)

Returns the InterceptorsMetaData which are applicable for the beanName in the ejbJarMetaData

An interceptor is considered as bound to an EJB if there's atleast one interceptor binding between the EJB and the interceptor class. The interceptor binding can either be through the use of element in ejb-jar.xml or through the use of Interceptors annotation(s) in the EJB class.

If the EJB has an around-invoke element which uses class name other than the EJB class name, then even that class is considered as an interceptor class and is considered to be bound to the EJB.

For example: Dummy org.myapp.ejb.MyBean org.myapp.SomeClass blah

The org.myapp.SomeClass will be considered as a interceptor class bound to the EJB, org.myapp.ejb.MyBean, even if there is no explicit interceptor binding between that EJB and the org.myapp.SomeClass

Parameters:

beanName - The EJB name

ejbJarMetaData - The EjbJarMetaData corresponding to the beanName

Returns:

Throws:

java.lang.NullPointerException - If either of beanName or ejbJarMetaData is null

getAllInterceptorClasses

public static java.util.Collection<java.lang.String> getAllInterceptorClasses(EjbJarMetaData ejbJar)

Returns all interceptor classes which are present in the passed ejbJar.

A class is considered an interceptor class, if it is listed in either of the following:

• In the element of ejb-jar.xml
• In the element of ejb-jar.xml
• In the sub-element of element in the ejb-jar.xml
• Marked as an interceptor class through the use of Interceptors annotation in a bean class

Parameters:

ejbJar - The EjbJarMetaData which will scanned for interceptor classes

Returns:

createMerged

public EjbJarMetaData createMerged(EjbJarMetaData original)

setDistinctName

public void setDistinctName(java.lang.String distinctName)

getDistinctName

public java.lang.String getDistinctName()