EjbLocalRef

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

All Implemented Interfaces:: EjbReference, Injectable, JndiReference, Keyable<java.lang.String>

public class EjbLocalRef
extends java.lang.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

Fields
Modifier and Type	Field and Description
`protected TextMap`	`description`
`protected java.lang.String`	`ejbLink`
`protected java.lang.String`	`ejbRefName`
`protected EjbRefType`	`ejbRefType`
`protected java.lang.String`	`id`
`protected java.util.Set<InjectionTarget>`	`injectionTarget`
`protected java.lang.String`	`local`
`protected java.lang.String`	`localHome`
`protected java.lang.String`	`lookupName`
`protected java.lang.String`	`mappedName`

Constructor Summary

Constructors
Constructor and Description

EjbLocalRef()

EjbLocalRef(EjbReference ref)

EjbLocalRef(java.lang.String ejbRefName, java.lang.String ejbLink)

Constructors
Constructor and Description
`EjbLocalRef()`
`EjbLocalRef(EjbReference ref)`
`EjbLocalRef(java.lang.String ejbRefName, java.lang.String ejbLink)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDescription()`
`Text[]`	`getDescriptions()`
`java.lang.String`	`getEjbLink()`
`java.lang.String`	`getEjbRefName()`
`EjbRefType`	`getEjbRefType()`
`java.lang.String`	`getHome()`
`java.lang.String`	`getId()`
`java.util.Set<InjectionTarget>`	`getInjectionTarget()`
`java.lang.String`	`getInterface()`
`java.lang.String`	`getKey()` Gets the immutable key for this object.
`java.lang.String`	`getLocal()`
`java.lang.String`	`getLocalHome()`
`java.lang.String`	`getLookupName()`
`java.lang.String`	`getMappedName()`
`java.lang.String`	`getName()`
`EjbReference.Type`	`getRefType()`
`java.lang.String`	`getType()`
`EjbLocalRef`	`injectionTarget(java.lang.Class<?> clazz, java.lang.String property)`
`EjbLocalRef`	`injectionTarget(java.lang.String className, java.lang.String property)`
`EjbLocalRef`	`link(java.lang.String link)`
`EjbLocalRef`	`local(java.lang.Class<?> local)`
`EjbLocalRef`	`local(java.lang.String local)`
`EjbLocalRef`	`localHome(java.lang.Class<?> localHome)`
`EjbLocalRef`	`localHome(java.lang.String localHome)`
`EjbLocalRef`	`lookup(java.lang.String lookupName)`
`EjbLocalRef`	`mappedName(java.lang.String mappedName)`
`EjbLocalRef`	`name(java.lang.String ejbRefName)`
`void`	`setDescriptions(Text[] text)`
`void`	`setEjbLink(java.lang.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(java.lang.String value)` The ejb-ref-name element contains the name of an EJB reference.
`void`	`setEjbRefType(EjbRefType value)`
`void`	`setId(java.lang.String value)`
`void`	`setLocal(java.lang.String value)`
`void`	`setLocalHome(java.lang.String value)`
`void`	`setLookupName(java.lang.String lookupName)`
`void`	`setMappedName(java.lang.String value)`
`void`	`setName(java.lang.String name)`
`void`	`setRefType(EjbReference.Type refType)`
`void`	`setType(java.lang.String type)`
`java.lang.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 java.lang.String ejbRefName
```

ejbRefType
```
protected EjbRefType ejbRefType
```

localHome
```
protected java.lang.String localHome
```

local
```
protected java.lang.String local
```

ejbLink
```
protected java.lang.String ejbLink
```

mappedName
```
protected java.lang.String mappedName
```

lookupName
```
protected java.lang.String lookupName
```

injectionTarget

protected java.util.Set<InjectionTarget> injectionTarget

id
```
protected java.lang.String id
```

Constructor Detail

EjbLocalRef
```
public EjbLocalRef()
```

EjbLocalRef

public EjbLocalRef(java.lang.String ejbRefName,
                   java.lang.String ejbLink)

EjbLocalRef
```
public EjbLocalRef(EjbReference ref)
```

Method Detail
- name
```
public EjbLocalRef name(java.lang.String ejbRefName)
```
- type
```
public EjbLocalRef type(EjbRefType ejbRefType)
```
- link
```
public EjbLocalRef link(java.lang.String link)
```
- local
```
public EjbLocalRef local(java.lang.String local)
```
- local
```
public EjbLocalRef local(java.lang.Class<?> local)
```
- localHome
```
public EjbLocalRef localHome(java.lang.String localHome)
```
- localHome
```
public EjbLocalRef localHome(java.lang.Class<?> localHome)
```
- mappedName
```
public EjbLocalRef mappedName(java.lang.String mappedName)
```
- lookup
```
public EjbLocalRef lookup(java.lang.String lookupName)
```
- injectionTarget
```
public EjbLocalRef injectionTarget(java.lang.String className,
                                   java.lang.String property)
```
- injectionTarget
```
public EjbLocalRef injectionTarget(java.lang.Class<?> clazz,
                                   java.lang.String property)
```
- getName
```
public java.lang.String getName()
```
  Specified by:
  
  getName in interface JndiReference
- getKey
```
public java.lang.String getKey()
```
  Description copied from interface: Keyable
  
  Gets the immutable key for this object.
  
  Specified by:
  
  getKey in interface Keyable<java.lang.String>
  
  Returns:
  
  gets the immutable key for this object
- getType
```
public java.lang.String getType()
```
  Specified by:
  
  getType in interface JndiReference
- setName
```
public void setName(java.lang.String name)
```
  Specified by:
  
  setName in interface JndiReference
- setType
```
public void setType(java.lang.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 java.lang.String getDescription()
```
- getEjbRefName
```
public java.lang.String getEjbRefName()
```
- setEjbRefName
```
public void setEjbRefName(java.lang.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 java.lang.String getLocalHome()
```
- getHome
```
public java.lang.String getHome()
```
  Specified by:
  
  getHome in interface EjbReference
- getInterface
```
public java.lang.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(java.lang.String value)
```
- getLocal
```
public java.lang.String getLocal()
```
- setLocal
```
public void setLocal(java.lang.String value)
```
- getEjbLink
```
public java.lang.String getEjbLink()
```
  Specified by:
  
  getEjbLink in interface EjbReference
- setEjbLink
```
public void setEjbLink(java.lang.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 java.lang.String getMappedName()
```
  Specified by:
  
  getMappedName in interface JndiReference
- setMappedName
```
public void setMappedName(java.lang.String value)
```
  Specified by:
  
  setMappedName in interface JndiReference
- getLookupName
```
public java.lang.String getLookupName()
```
  Specified by:
  
  getLookupName in interface JndiReference
- setLookupName
```
public void setLookupName(java.lang.String lookupName)
```
  Specified by:
  
  setLookupName in interface JndiReference
- getInjectionTarget
```
public java.util.Set<InjectionTarget> getInjectionTarget()
```
  Specified by:
  
  getInjectionTarget in interface Injectable
- getId
```
public java.lang.String getId()
```
- setId
```
public void setId(java.lang.String value)
```
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class java.lang.Object

Class EjbLocalRef

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

description

ejbRefName

ejbRefType

localHome

local

ejbLink

mappedName

lookupName

injectionTarget

id

Constructor Detail

EjbLocalRef

EjbLocalRef

EjbLocalRef

Method Detail

name

type

link

local

local

localHome

localHome

mappedName

lookup

injectionTarget

injectionTarget

getName

getKey

getType

setName

setType

getDescriptions

setDescriptions

getDescription

getEjbRefName

setEjbRefName

getEjbRefType

setEjbRefType

getLocalHome

getHome

getInterface

getRefType

setRefType

setLocalHome

getLocal

setLocal

getEjbLink

setEjbLink

getMappedName

setMappedName

getLookupName

setLookupName

getInjectionTarget

getId

setId

toString