Oracle Application Server TopLink API Reference
10g Release 2 (10.1.2)

B15903-01


oracle.toplink.tools.ejb11
Class EJBXmlWebLogicBeanDefinition

java.lang.Object
  extended byoracle.toplink.tools.ejb11.EJBXmlWebLogicBeanDefinition


public class EJBXmlWebLogicBeanDefinition
extends java.lang.Object

This type defines the fields used by the Weblogic XML deployment descriptor


Field Summary
java.lang.Boolean clusterable
java.lang.String ejbName
java.lang.String jndiName
boolean sessionBean

Constructor Summary
EJBXmlWebLogicBeanDefinition(java.lang.String beanName)
EJBXmlWebLogicBeanDefinition constructor

Method Summary
java.lang.Boolean getClusterable()
Return the clusterability setting of the bean.
java.lang.String getClusterableString()
Return the clusterability setting of the bean as a String suitable for XML
java.lang.String getEjbName()
Get the name of the bean.
java.lang.String getJndiName()
Get the name used to store the home interface of the bean in JNDI.
void initializeToDefaults()
Initialize this object to contain the default values.
boolean isSessionBean()
Get whether this is a session bean.
void isSessionBean(boolean flag)
Set whether this is a session bean.
void setClusterable(boolean clusterableFlag)
Set the flag that indicates clusterability of the bean.
void setEjbName(java.lang.String beanName)
Set the name of the bean.
void setJndiName(java.lang.String jName)
Set the name used to store the home interface of the bean in JNDI.
org.w3c.dom.Element storeProperties(org.w3c.dom.Element parentElement, org.w3c.dom.Document xmlDoc)
Store the properties in the element passed in and using the XML document.
java.lang.String topLinkBeanFileName()
Return the file name for a TopLink CMP bean.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ejbName

public java.lang.String ejbName

jndiName

public java.lang.String jndiName

clusterable

public java.lang.Boolean clusterable

sessionBean

public boolean sessionBean

Constructor Detail

EJBXmlWebLogicBeanDefinition

public EJBXmlWebLogicBeanDefinition(java.lang.String beanName)
EJBXmlWebLogicBeanDefinition constructor

Method Detail

getClusterable

public java.lang.Boolean getClusterable()
Return the clusterability setting of the bean.
Returns:
Boolean True if the bean is clusterable, False if not, and null if this attribute was not set

getClusterableString

public java.lang.String getClusterableString()
Return the clusterability setting of the bean as a String suitable for XML
Returns:
String 'True' if the bean is clusterable, 'False' if not, or if not set

getEjbName

public java.lang.String getEjbName()
Get the name of the bean. This name is not used for anything other than referencing this bean in the deployment descriptor, must must match the name in the corresponding EJBXmlBeanDescriptor.
Returns:
String The String chosen by the bean provider

getJndiName

public java.lang.String getJndiName()
Get the name used to store the home interface of the bean in JNDI.
Returns:
String The name to use when looking up the bean home interface

initializeToDefaults

public void initializeToDefaults()
Initialize this object to contain the default values.

isSessionBean

public boolean isSessionBean()
Get whether this is a session bean.
Returns:
boolean True if this is a session bean, false if this is an entity bean

isSessionBean

public void isSessionBean(boolean flag)
Set whether this is a session bean.
Parameters:
flag - True if this is a session bean, false if this is an entity bean

setClusterable

public void setClusterable(boolean clusterableFlag)
Set the flag that indicates clusterability of the bean.

setEjbName

public void setEjbName(java.lang.String beanName)
Set the name of the bean. This name is not used for anything other than referencing this bean in the deployment descriptor, must must match the name in the corresponding EJBXmlBeanDescriptor.
Parameters:
beanName - The String chosen by the bean provider

setJndiName

public void setJndiName(java.lang.String jName)
Set the name used to store the home interface of the bean in JNDI.

storeProperties

public org.w3c.dom.Element storeProperties(org.w3c.dom.Element parentElement,
                                           org.w3c.dom.Document xmlDoc)
Store the properties in the element passed in and using the XML document.
Returns:
Element The parent element

topLinkBeanFileName

public java.lang.String topLinkBeanFileName()
Return the file name for a TopLink CMP bean.
Returns:
String The TopLink file name String for this bean

Copyright © 1998, 2005 Oracle Corporation. All Rights Reserved.