com.sun.enterprise.deployment.types

Interface EjbReference

All Superinterfaces:

InjectionCapable, NamedInformation

All Known Implementing Classes:

EjbReferenceDescriptor

public interface EjbReference
extends NamedInformation, InjectionCapable

Protocol associated with defining an EJB Interface

Author:

Jerome Dochez

Method Summary

Modifier and Type	Method and Description
EjbDescriptor	getEjbDescriptor()
String	getEjbHomeInterface() Gets the home classname of the referee EJB.
String	getEjbInterface() Gets the local or remote interface classname of the referee EJB.
String	getJndiName()
String	getLinkName() Gets the link name of the reference.
String	getLookupName()
BundleDescriptor	getReferringBundleDescriptor() Get the referring bundle, i.e.
String	getType() Get the type of the EJB (Session, Entity or Message-Driven).
boolean	hasJndiName() Returns true if the reference has a non-null non-zero length jndiname
boolean	hasLookupName() Returns true if the lookup name is non-null and has a non-zero length
boolean	isEJB30ClientView()
boolean	isLocal() Tests if the reference to the referree EJB is through local or remote interface
void	setEjbDescriptor(EjbDescriptor descriptor)
void	setEjbHomeInterface(String ejbHomeInterface) Sets the local or remote home classname of the referee EJB.
void	setEjbInterface(String ejbInterface) Sets the local or remote bean interface classname of the referee EJB.
void	setJndiName(String jndiName) Set the jndi name for this ejb reference
void	setLinkName(String linkName) Sets the link name of the reference.
void	setLocal(boolean isLocal) Sets whether the reference uses the local or remote interfaces of the referring EJB
void	setReferringBundleDescriptor(BundleDescriptor referringBundle) Set the referring bundle, i.e.
void	setType(String type) Set the type of the EJB.

Methods inherited from interface com.sun.enterprise.deployment.types.NamedInformation

getDescription, getName, setDescription, setName

Methods inherited from interface com.sun.enterprise.deployment.InjectionCapable

addInjectionTarget, getComponentEnvName, getInjectionTargets, getInjectResourceType, isInjectable, setInjectResourceType

Method Detail

getType

String getType()

Get the type of the EJB (Session, Entity or Message-Driven).

Returns:

the type of the EJB.

setType

void setType(String type)

Set the type of the EJB. Allowed values are Session, Entity or Message-driven.

Parameters:

type - the type of the EJB.

getEjbHomeInterface

String getEjbHomeInterface()

Gets the home classname of the referee EJB.

Returns:

the class name of the EJB home.

setEjbHomeInterface

void setEjbHomeInterface(String ejbHomeInterface)

Sets the local or remote home classname of the referee EJB.

Parameters:

ejbHomeInterface - the class name of the EJB home.

getEjbInterface

String getEjbInterface()

Gets the local or remote interface classname of the referee EJB.

Returns:

the classname of the EJB remote object.

setEjbInterface

void setEjbInterface(String ejbInterface)

Sets the local or remote bean interface classname of the referee EJB.

Parameters:

ejbInterface - the classname of the EJB remote object.

getLinkName

String getLinkName()

Gets the link name of the reference. For use when linking to an EJB within a J2EE application.

Returns:

the link name.

setLinkName

void setLinkName(String linkName)

Sets the link name of the reference. For use when linking to an EJB within a J2EE application.

Parameters:

linkName - the link name.

isLocal

boolean isLocal()

Tests if the reference to the referree EJB is through local or remote interface

Returns:

true if using the local interfaces

setLocal

void setLocal(boolean isLocal)

Sets whether the reference uses the local or remote interfaces of the referring EJB

Parameters:

isLocal - true if using the local interface

setReferringBundleDescriptor

void setReferringBundleDescriptor(BundleDescriptor referringBundle)

Set the referring bundle, i.e. the bundle within which this EJB reference is declared.

Parameters:

referringBundle -

getReferringBundleDescriptor

BundleDescriptor getReferringBundleDescriptor()

Get the referring bundle, i.e. the bundle within which this EJB reference is declared.

Returns:

setJndiName

void setJndiName(String jndiName)

Set the jndi name for this ejb reference

Parameters:

jndiName -

getJndiName

String getJndiName()

Returns:

the jndi name for this ejb reference

hasJndiName

boolean hasJndiName()

Returns true if the reference has a non-null non-zero length jndiname

Returns:

hasLookupName

boolean hasLookupName()

Returns true if the lookup name is non-null and has a non-zero length

Returns:

getLookupName

String getLookupName()

Returns:

getEjbDescriptor

EjbDescriptor getEjbDescriptor()

setEjbDescriptor

void setEjbDescriptor(EjbDescriptor descriptor)

isEJB30ClientView

boolean isEJB30ClientView()

Returns:

true if the EJB reference is a 30 client view