xdoclet.modules.ejb.dd

Class EjbRefTagsHandler


public class EjbRefTagsHandler
extends EjbTagsHandler

Version:
$Revision 1.1 $
Author:
Ara Abrahamian
xdoclet.taghandler
namespace = "EjbRef"
created
Oct 16, 2001
To do:
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.

Field Summary

protected String
referringClassId
The id of the EJB referencing another EJB, used for setting up a correct unique id for the ejb-ref.

Method Summary

String
ejbRefId()
Returns unique id for the specified ejb-ref.
String
ejbRefJndiName()
Returns the global JNDI name for the current EJB ref.
protected XClass
findEjb(String ejbName)
Finds and returns the class with the specified ejbName.
void
forAllEjbRefs(String template, Properties attributes)
Evaluates the body block for each ejb:ejb-ref defined for the EJB.
void
ifLocalEjbRef(String template)
Generates code if the ejb-ref is local
void
ifRemoteEjbRef(String template)
Generates code if the ejb-ref is local
protected boolean
isLocalEjbRef(XTag ejbRefTag)
Return true if the ejb-ref is local
protected boolean
isRemoteEjbRef(XTag ejbRefTag)
Return true if the ejb-ref is remote
protected void
storeReferringClassId()
Stores the id of current EJB for further use by other tags in referringClassId attribute.

Field Details

referringClassId

protected String referringClassId
The id of the EJB referencing another EJB, used for setting up a correct unique id for the ejb-ref.
See Also:
ejbRefId(), forAllEjbRefs(java.lang.String,java.util.Properties), storeReferringClassId()

Method Details

ejbRefId

public String ejbRefId()
            throws xdoclet.XDocletException
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:
xdoclet.XDocletException -
doc.tag
type = "content"
To do:
refactor this properly to account for ejb:bean - it may not be needed anymore.

ejbRefJndiName

public String ejbRefJndiName()
            throws xdoclet.XDocletException
Returns the global JNDI name for the current EJB ref.
Returns:
The JNDI name of current EJB ref.
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"

findEjb

protected XClass findEjb(String ejbName)
            throws xdoclet.XDocletException
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:
xdoclet.XDocletException -

forAllEjbRefs

public void forAllEjbRefs(String template,
                          Properties attributes)
            throws xdoclet.XDocletException
Evaluates the body block for each ejb:ejb-ref defined for the EJB. One of the useful things is does is to lookup the EJB using the ejb-name parameter of ejb:ejb-ref and fill in other required info.
Parameters:
template - The body of the block tag
attributes - The attributes of the template tag
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

ifLocalEjbRef

public void ifLocalEjbRef(String template)
            throws xdoclet.XDocletException
Generates code if the ejb-ref is local
Parameters:
template -
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

ifRemoteEjbRef

public void ifRemoteEjbRef(String template)
            throws xdoclet.XDocletException
Generates code if the ejb-ref is local
Parameters:
template -
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

isLocalEjbRef

protected boolean isLocalEjbRef(XTag ejbRefTag)
            throws xdoclet.XDocletException
Return true if the ejb-ref is local
Parameters:
ejbRefTag -
Returns:
true if the ejb-ref is local otherwise false
Throws:
xdoclet.XDocletException -

isRemoteEjbRef

protected boolean isRemoteEjbRef(XTag ejbRefTag)
            throws xdoclet.XDocletException
Return true if the ejb-ref is remote
Parameters:
ejbRefTag -
Returns:
true if the ejb-ref is remote otherwise false
Throws:
xdoclet.XDocletException -

storeReferringClassId

protected void storeReferringClassId()
            throws xdoclet.XDocletException
Stores the id of current EJB for further use by other tags in referringClassId attribute.
Throws:
xdoclet.XDocletException -
To do:
refactor this properly to take ejb:bean into account - may not be needed anymore.