xdoclet.modules.ejb.env

Class EnvEjbRefTagsHandler

public class EnvEjbRefTagsHandler extends EnvTagsHandler

Version: $Revision 1.1 $

Author: Matthias Germann

UNKNOWN: April 5, 2005 namespace = "EjbEnvEjbRef" refactor ejbRefId properly to account for ejb:bean - it may not be needed anymore. refactor storeReferringClassId properly to take ejb:bean into account - may not be needed anymore.

Method Summary
StringcomponentInterface()
Returns the component interface for the current ejb reference
protected voiddoGenerate(String template)
StringejbRefId()
Returns unique id for the specified ejb-ref.
StringejbRefJndiName()
Returns the global JNDI name for the current EJB ref.
protected XClassfindEjb(String ejbName)
Finds and returns the class with the specified ejbName.
voidforAllEjbRefMembers(String template, Properties attributes)
Evaluates the body block for each method- and field-level ejb reference.
voidforAllEjbRefMethods(String template, Properties attributes)
Evaluates the body block for each method-level ejb reference.
voidforAllEjbRefs(String template, Properties attributes)
Evaluates the body block for each ejb reference.
StringhomeInterface()
Returns the home interface for the current ejb reference
voidifLocalEjbRef(String template)
Generates code if the ejb-ref is local
voidifRemoteEjbRef(String template)
Generates code if the ejb-ref is local
protected booleanisLocalEjbRef(XTag ejbRefTag)
Return true if the ejb-ref is local
protected booleanisRemoteEjbRef(XTag ejbRefTag)
Return true if the ejb-ref is remote
Stringname(Properties attributes)
protected voidstoreReferringClassId()
Stores the id of current EJB for further use by other tags in referringClassId attribute.

Method Detail

componentInterface

public String componentInterface()
Returns the component interface for the current ejb reference

Returns: the fully qualified class name

Throws: XDocletException if an error occures

UNKNOWN: type = "content"

doGenerate

protected void doGenerate(String template)

ejbRefId

public String ejbRefId()
Returns unique id for the specified ejb-ref. It prefixes it with the referring class's id, then a _ and the id of the ejb object.

Returns: Description of the Returned Value

Throws: XDocletException

UNKNOWN: refactor this properly to account for ejb:bean - it may not be needed anymore. type = "content"

ejbRefJndiName

public String ejbRefJndiName()
Returns the global JNDI name for the current EJB ref.

Returns: The JNDI name of current EJB ref.

Throws: XDocletException

UNKNOWN: type = "content"

findEjb

protected XClass findEjb(String ejbName)
Finds and returns the class with the specified ejbName. An XDocletException is thrown if not found.

Parameters: ejbName Description of Parameter

Returns: Description of the Returned Value

Throws: XDocletException

forAllEjbRefMembers

public void forAllEjbRefMembers(String template, Properties attributes)
Evaluates the body block for each method- and field-level ejb reference.

Parameters: template The body of the block tag attributes The attributes of the template tag

Throws: XDocletException

UNKNOWN: type = "block" name = "tagName" description = "the ejb-ref tag" default = "ejb.ejb-ref"

forAllEjbRefMethods

public void forAllEjbRefMethods(String template, Properties attributes)
Evaluates the body block for each method-level ejb reference.

Parameters: template The body of the block tag attributes The attributes of the template tag

Throws: XDocletException

UNKNOWN: type = "block" name = "tagName" description = "the ejb-ref tag" default = "ejb.ejb-ref"

forAllEjbRefs

public void forAllEjbRefs(String template, Properties attributes)
Evaluates the body block for each ejb reference.

Parameters: template The body of the block tag attributes The attributes of the template tag

Throws: XDocletException

UNKNOWN: type = "block" name = "tagName" description = "the ejb-ref tag" default = "ejb.ejb-ref"

homeInterface

public String homeInterface()
Returns the home interface for the current ejb reference

Returns: the fully qualified class name

Throws: XDocletException if an error occures

UNKNOWN: type = "content"

ifLocalEjbRef

public void ifLocalEjbRef(String template)
Generates code if the ejb-ref is local

Parameters: template

Throws: XDocletException

UNKNOWN: type = "block"

ifRemoteEjbRef

public void ifRemoteEjbRef(String template)
Generates code if the ejb-ref is local

Parameters: template

Throws: XDocletException

UNKNOWN: type = "block"

isLocalEjbRef

protected boolean isLocalEjbRef(XTag ejbRefTag)
Return true if the ejb-ref is local

Parameters: ejbRefTag

Returns: true if the ejb-ref is local otherwise false

Throws: XDocletException

isRemoteEjbRef

protected boolean isRemoteEjbRef(XTag ejbRefTag)
Return true if the ejb-ref is remote

Parameters: ejbRefTag

Returns: true if the ejb-ref is remote otherwise false

Throws: XDocletException

name

public String name(Properties attributes)

storeReferringClassId

protected void storeReferringClassId()
Stores the id of current EJB for further use by other tags in referringClassId attribute.

Throws: XDocletException

UNKNOWN: refactor this properly to take ejb:bean into account - may not be needed anymore.