org.codehaus.cargo.module.webapp
Class EjbRef

java.lang.Object
  org.codehaus.cargo.module.webapp.EjbRef

public class EjbRef
extends java.lang.Object

Represents a ejb-ref element of a web application descriptor.

Version:

$Id $

Field Summary

static java.lang.String	ENTITY Constant representing an entity ejb reference.
static java.lang.String	SESSION Constant representing an session ejb reference.

Constructor Summary

EjbRef()
Empty constructor.

EjbRef(java.lang.String name, java.lang.String ejbInterface, java.lang.String ejbHomeInterface)
Construct a new ejb-ref.

Method Summary

java.lang.String	getEjbHomeInterface() Returns the ejb home inteface.
java.lang.String	getEjbInterface() Returns the ejb inteface.
java.lang.String	getEjbName() Returns the ejb name.
java.lang.String	getJndiName() Returns the jndi inteface.
java.lang.String	getName() Returns the name of the reference.
java.lang.String	getType() Returns the type of reference.
boolean	isLocal() Indicates if the ejb referenced is a local ejb.
void	setEjbHomeInterface(java.lang.String ejbHomeInterface) Sets the ejb home interface.
void	setEjbInterface(java.lang.String ejbInterface) Sets the ejb interface.
void	setEjbName(java.lang.String ejbName) Sets the ejb name.
void	setJndiName(java.lang.String jndiName) Sets the jndi name.
void	setLocal(boolean local) Set if the referenced ejb is a local ejb.
void	setName(java.lang.String name) Sets the name of the reference.
void	setType(java.lang.String type) Sets the type of the reference.

Methods inherited from class java.lang.Object

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

Field Detail

SESSION

public static final java.lang.String SESSION

Constant representing an session ejb reference.

See Also:

Constant Field Values

ENTITY

public static final java.lang.String ENTITY

Constant representing an entity ejb reference.

See Also:

Constant Field Values

Constructor Detail

EjbRef

public EjbRef()

Empty constructor.

EjbRef

public EjbRef(java.lang.String name,
              java.lang.String ejbInterface,
              java.lang.String ejbHomeInterface)

Construct a new ejb-ref.

Parameters:

name - Name of the reference. For example ejb/MyEjb.

ejbInterface - Class name of the ejb interface.

ejbHomeInterface - Class name of the ejb home interface.

Method Detail

getEjbHomeInterface

public java.lang.String getEjbHomeInterface()

Returns the ejb home inteface.

Returns:

ejb home interface.

setEjbHomeInterface

public void setEjbHomeInterface(java.lang.String ejbHomeInterface)

Sets the ejb home interface.

Parameters:

ejbHomeInterface - the home interface of the ejb.

getEjbInterface

public java.lang.String getEjbInterface()

Returns the ejb inteface.

Returns:

ejb interface.

setEjbInterface

public void setEjbInterface(java.lang.String ejbInterface)

Sets the ejb interface.

Parameters:

ejbInterface - the interface of the ejb.

getEjbName

public java.lang.String getEjbName()

Returns the ejb name.

Returns:

ejb name.

setEjbName

public void setEjbName(java.lang.String ejbName)

Sets the ejb name. This will result in an ejb ref by ejb-link.

Parameters:

ejbName - the name of the ejb.

getJndiName

public java.lang.String getJndiName()

Returns the jndi inteface.

Returns:

jndi interface.

setJndiName

public void setJndiName(java.lang.String jndiName)

Sets the jndi name. This will result in an ejb ref by vendor specific mappings.

Parameters:

jndiName - jndi name of the referenced ejb.

isLocal

public boolean isLocal()

Indicates if the ejb referenced is a local ejb.

Returns:

true if the ejb referenced is a local ejb.

setLocal

public void setLocal(boolean local)

Set if the referenced ejb is a local ejb.

Parameters:

local - true if the referenced ejb is local.

getName

public java.lang.String getName()

Returns the name of the reference.

Returns:

name of the reference.

setName

public void setName(java.lang.String name)

Sets the name of the reference.

Parameters:

name - name of the reference.

getType

public java.lang.String getType()

Returns the type of reference.

Returns:

type of reference.

See Also:

EjbRef.SESSION, EjbRef.ENTITY

setType

public void setType(java.lang.String type)

Sets the type of the reference.

Parameters:

type - type of reference.

See Also:

EjbRef.SESSION, EjbRef.ENTITY