org.apache.openejb.jee
Class EjbRef
java.lang.Object
org.apache.openejb.jee.EjbRef
- All Implemented Interfaces:
- EjbReference, Injectable, JndiReference, Keyable<java.lang.String>
public class EjbRef
- extends java.lang.Object
- implements EjbReference
The ejb-refType is used by ejb-ref elements for the
declaration of a reference to an enterprise bean's home or
to the remote business interface of a 3.0 bean.
The declaration consists of:
- an optional description
- the EJB reference name used in the code of
the Deployment Component that's referencing the enterprise
bean.
- the optional expected type of the referenced enterprise bean
- the optional remote interface of the referenced enterprise bean
or the remote business interface of the referenced enterprise
bean
- the optional expected home interface of the referenced
enterprise bean. Not applicable if this ejb-ref
refers to the remote business interface of a 3.0 bean.
- optional ejb-link information, used to specify the
referenced enterprise bean
- optional elements to define injection of the named enterprise
bean into a component field or property
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
description
protected java.util.List<Text> description
ejbRefName
protected java.lang.String ejbRefName
ejbRefType
protected EjbRefType ejbRefType
home
protected java.lang.String home
remote
protected java.lang.String remote
ejbLink
protected java.lang.String ejbLink
mappedName
protected java.lang.String mappedName
injectionTarget
protected java.util.List<InjectionTarget> injectionTarget
id
protected java.lang.String id
refType
protected EjbReference.Type refType
EjbRef
public EjbRef()
getRefType
public EjbReference.Type getRefType()
- Specified by:
getRefType
in interface EjbReference
setRefType
public void setRefType(EjbReference.Type refType)
- Specified by:
setRefType
in interface EjbReference
getDescription
public java.util.List<Text> getDescription()
- Specified by:
getDescription
in interface EjbReference
getEjbRefName
public java.lang.String getEjbRefName()
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
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)
getHome
public java.lang.String getHome()
- Specified by:
getHome
in interface EjbReference
setHome
public void setHome(java.lang.String value)
getRemote
public java.lang.String getRemote()
getInterface
public java.lang.String getInterface()
- Specified by:
getInterface
in interface EjbReference
setRemote
public void setRemote(java.lang.String value)
getEjbLink
public java.lang.String getEjbLink()
- 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
- Specified by:
getEjbLink
in interface EjbReference
setEjbLink
public void setEjbLink(java.lang.String value)
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
getInjectionTarget
public java.util.List<InjectionTarget> getInjectionTarget()
- Specified by:
getInjectionTarget
in interface Injectable
getId
public java.lang.String getId()
setId
public void setId(java.lang.String value)
Copyright © 1999-2011 The Apache OpenEJB development community. All Rights Reserved.