org.apache.openejb.jee
Class EjbLocalRef

java.lang.Object
  org.apache.openejb.jee.EjbLocalRef

All Implemented Interfaces:

EjbReference, Injectable, JndiReference, Keyable<String>

public class EjbLocalRef
extends Object
implements EjbReference

javaee6.xsd

Java class for ejb-local-refType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ejb-local-refType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="description" type="{http://java.sun.com/xml/ns/javaee}descriptionType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="ejb-ref-name" type="{http://java.sun.com/xml/ns/javaee}ejb-ref-nameType"/>
         <element name="ejb-ref-type" type="{http://java.sun.com/xml/ns/javaee}ejb-ref-typeType" minOccurs="0"/>
         <element name="local-home" type="{http://java.sun.com/xml/ns/javaee}local-homeType" minOccurs="0"/>
         <element name="local" type="{http://java.sun.com/xml/ns/javaee}localType" minOccurs="0"/>
         <element name="ejb-link" type="{http://java.sun.com/xml/ns/javaee}ejb-linkType" minOccurs="0"/>
         <group ref="{http://java.sun.com/xml/ns/javaee}resourceGroup"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.openejb.jee.EjbReference

EjbReference.Type

Field Summary

protected TextMap	description
protected String	ejbLink
protected String	ejbRefName
protected EjbRefType	ejbRefType
protected String	id
protected Set<InjectionTarget>	injectionTarget
protected String	local
protected String	localHome
protected String	lookupName
protected String	mappedName

Constructor Summary

EjbLocalRef()

EjbLocalRef(EjbReference ref)

EjbLocalRef(String ejbRefName, String ejbLink)

Method Summary

String	getDescription()
Text[]	getDescriptions()
String	getEjbLink()
String	getEjbRefName()
EjbRefType	getEjbRefType()
String	getHome()
String	getId()
Set<InjectionTarget>	getInjectionTarget()
String	getInterface()
String	getKey() Gets the immutable key for this object.
String	getLocal()
String	getLocalHome()
String	getLookupName()
String	getMappedName()
String	getName()
EjbReference.Type	getRefType()
String	getType()
EjbLocalRef	injectionTarget(Class<?> clazz, String property)
EjbLocalRef	injectionTarget(String className, String property)
EjbLocalRef	link(String link)
EjbLocalRef	local(Class<?> local)
EjbLocalRef	local(String local)
EjbLocalRef	localHome(Class<?> localHome)
EjbLocalRef	localHome(String localHome)
EjbLocalRef	lookup(String lookupName)
EjbLocalRef	mappedName(String mappedName)
EjbLocalRef	name(String ejbRefName)
void	setDescriptions(Text[] text)
void	setEjbLink(String value) The value of the ejb-link element must be the ejb-name of an enterprise bean in the same ejb-jar file or in another ejb-jar file in the same Java EE application unit.
void	setEjbRefName(String value) The ejb-ref-name element contains the name of an EJB reference.
void	setEjbRefType(EjbRefType value)
void	setId(String value)
void	setLocal(String value)
void	setLocalHome(String value)
void	setLookupName(String lookupName)
void	setMappedName(String value)
void	setName(String name)
void	setRefType(EjbReference.Type refType)
void	setType(String type)
String	toString()
EjbLocalRef	type(EjbRefType ejbRefType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

description

protected TextMap description

ejbRefName

protected String ejbRefName

ejbRefType

protected EjbRefType ejbRefType

localHome

protected String localHome

local

protected String local

ejbLink

protected String ejbLink

mappedName

protected String mappedName

lookupName

protected String lookupName

injectionTarget

protected Set<InjectionTarget> injectionTarget

id

protected String id

Constructor Detail

EjbLocalRef

public EjbLocalRef()

EjbLocalRef

public EjbLocalRef(String ejbRefName,
                   String ejbLink)

EjbLocalRef

public EjbLocalRef(EjbReference ref)

Method Detail

name

public EjbLocalRef name(String ejbRefName)

type

public EjbLocalRef type(EjbRefType ejbRefType)

link

public EjbLocalRef link(String link)

local

public EjbLocalRef local(String local)

local

public EjbLocalRef local(Class<?> local)

localHome

public EjbLocalRef localHome(String localHome)

localHome

public EjbLocalRef localHome(Class<?> localHome)

mappedName

public EjbLocalRef mappedName(String mappedName)

lookup

public EjbLocalRef lookup(String lookupName)

injectionTarget

public EjbLocalRef injectionTarget(String className,
                                   String property)

injectionTarget

public EjbLocalRef injectionTarget(Class<?> clazz,
                                   String property)

getName

public String getName()

Specified by:

getName in interface JndiReference

getKey

public String getKey()

Description copied from interface: Keyable

Gets the immutable key for this object.

Specified by:

getKey in interface Keyable<String>

Returns:

gets the immutable key for this object

getType

public String getType()

Specified by:

getType in interface JndiReference

setName

public void setName(String name)

Specified by:

setName in interface JndiReference

setType

public void setType(String type)

Specified by:

setType in interface JndiReference

getDescriptions

public Text[] getDescriptions()

Specified by:

getDescriptions in interface EjbReference

setDescriptions

public void setDescriptions(Text[] text)

getDescription

public String getDescription()

getEjbRefName

public String getEjbRefName()

setEjbRefName

public void setEjbRefName(String value)

The ejb-ref-name element contains the name of an EJB reference. The EJB reference is an entry in the Deployment Component's environment and is relative to the java:comp/env context. The name must be unique within the Deployment Component.

It is recommended that name is prefixed with "ejb/".

Example:

ejb/Payroll

getEjbRefType

public EjbRefType getEjbRefType()

Specified by:

getEjbRefType in interface EjbReference

setEjbRefType

public void setEjbRefType(EjbRefType value)

getLocalHome

public String getLocalHome()

getHome

public String getHome()

Specified by:

getHome in interface EjbReference

getInterface

public String getInterface()

Specified by:

getInterface in interface EjbReference

getRefType

public EjbReference.Type getRefType()

Specified by:

getRefType in interface EjbReference

setRefType

public void setRefType(EjbReference.Type refType)

Specified by:

setRefType in interface EjbReference

setLocalHome

public void setLocalHome(String value)

getLocal

public String getLocal()

setLocal

public void setLocal(String value)

getEjbLink

public String getEjbLink()

Specified by:

getEjbLink in interface EjbReference

setEjbLink

public void setEjbLink(String value)

The value of the ejb-link element must be the ejb-name of an enterprise bean in the same ejb-jar file or in another ejb-jar file in the same Java EE application unit.

Alternatively, the name in the ejb-link element may be composed of a path name specifying the ejb-jar containing the referenced enterprise bean with the ejb-name of the target bean appended and separated from the path name by "#". The path name is relative to the Deployment File containing Deployment Component that is referencing the enterprise bean. This allows multiple enterprise beans with the same ejb-name to be uniquely identified.

Examples:

EmployeeRecord

../products/product.jar#ProductEJB

getMappedName

public String getMappedName()

Specified by:

getMappedName in interface JndiReference

setMappedName

public void setMappedName(String value)

Specified by:

setMappedName in interface JndiReference

getLookupName

public String getLookupName()

Specified by:

getLookupName in interface JndiReference

setLookupName

public void setLookupName(String lookupName)

Specified by:

setLookupName in interface JndiReference

getInjectionTarget

public Set<InjectionTarget> getInjectionTarget()

Specified by:

getInjectionTarget in interface Injectable

getId

public String getId()

setId

public void setId(String value)

toString

public String toString()

Overrides:

toString in class Object