org.eclipse.jst.j2ee.client
Interface ApplicationClient

All Superinterfaces:
CompatibilityDescriptionGroup, DescriptionGroup, J2EEEObject

public interface ApplicationClient
extends CompatibilityDescriptionGroup

The application-client element is the root element of an application client deployment descriptor. The application client deployment descriptor describes the EJB components and external resources referenced by the application client.

Since:
1.0

Method Summary
 JavaClass getCallbackHandler()
           
 java.lang.String getCallbackHandlerClassName()
          Returns the String name of the call back handler
 EList getEjbReferences()
           
 EList getEnvironmentProps()
           
 int getJ2EEVersionID()
          This returns the j2ee version id.
 EList getMessageDestinationRefs()
          Returns the value of the 'Message Destination Refs' containment reference list.
 EList getMessageDestinations()
          Returns the value of the 'Message Destinations' containment reference list.
 EList getResourceEnvRefs()
           
 EList getResourceRefs()
           
 EList getServiceRefs()
          Returns the value of the 'Service Refs' containment reference list.
 java.lang.String getVersion()
          Returns the value of the 'Version' attribute
 int getVersionID()
          This returns the module version id.
 boolean isVersion1_2Descriptor()
          Deprecated. Use getVersionID() to determine module level
 boolean isVersion1_3Descriptor()
          Deprecated. Use getVersionID() to determine module level
 boolean isVersion1_4Descriptor()
          Deprecated. Use getVersionID() to determine module level
 void setCallbackHandler(JavaClass value)
           
 void setCallbackHandlerClassName(java.lang.String callbackHandlerClassName)
          The class must have a no args constructor and must implement the javax.security.auth.callback.CallbackHandler interface.
 void setVersion(java.lang.String value)
          Sets the value of the 'Version' attribute
 
Methods inherited from interface org.eclipse.jst.j2ee.common.CompatibilityDescriptionGroup
getDescription, getDisplayName, getLargeIcon, getSmallIcon, setDescription, setDescriptionGen, setDisplayName, setDisplayNameGen, setLargeIcon, setLargeIconGen, setSmallIcon, setSmallIconGen
 
Methods inherited from interface org.eclipse.jst.j2ee.common.DescriptionGroup
getDescriptions, getDisplayNames, getIcons
 

Method Detail

getCallbackHandlerClassName

public java.lang.String getCallbackHandlerClassName()
Returns the String name of the call back handler

Returns:
the class name of the callback handler

isVersion1_2Descriptor

public boolean isVersion1_2Descriptor()
Deprecated. Use getVersionID() to determine module level

Return boolean indicating if this Application Client was populated from an Application Client 1.2 compliant descriptor

Returns:
boolean

isVersion1_3Descriptor

public boolean isVersion1_3Descriptor()
Deprecated. Use getVersionID() to determine module level

Return boolean indicating if this Application client was populated from an Application Client 1.3 compliant descriptor

Returns:
boolean

isVersion1_4Descriptor

public boolean isVersion1_4Descriptor()
Deprecated. Use getVersionID() to determine module level

Return boolean indicating if this Application client was populated from an Application Client 1.4 compliant descriptor

Returns:
boolean

setCallbackHandlerClassName

public void setCallbackHandlerClassName(java.lang.String callbackHandlerClassName)
The class must have a no args constructor and must implement the javax.security.auth.callback.CallbackHandler interface.

Parameters:
callbackHandlerClassName - the name of the class of the CallbackHandler reference

getVersion

public java.lang.String getVersion()
Returns the value of the 'Version' attribute.

If the meaning of the 'Version' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Version' attribute.
See Also:
setVersion(String), ClientPackage.getApplicationClient_Version()

setVersion

public void setVersion(java.lang.String value)
Sets the value of the 'Version' attribute.

Parameters:
value - the new value of the 'Version' attribute.
See Also:
getVersion()

getResourceRefs

public EList getResourceRefs()
Returns:
The list of ResourceRefs references Contains declarations of the application clients's references to an external resources.

getVersionID

public int getVersionID()
                 throws java.lang.IllegalStateException
This returns the module version id. Compare with J2EEVersionConstants to determine module level

Returns:
the int representing the app client module version
Throws:
java.lang.IllegalStateException - - when EMF resource is not loaded

getJ2EEVersionID

public int getJ2EEVersionID()
                     throws java.lang.IllegalStateException
This returns the j2ee version id. Compare with J2EEVersionConstants to determine j2ee level

Returns:
the int representing the J2EE spec version.
Throws:
java.lang.IllegalStateException - - when EMF resource is not loaded

getEnvironmentProps

public EList getEnvironmentProps()
Returns:
The list of EnvironmentProps references The env-entry element contains the declaration of an application client's environment entries. Each declaration consists of an optional description, the name of the environment entry, and an optional value.

getEjbReferences

public EList getEjbReferences()
Returns:
The list of EjbReferences references Contains a list of ejb-ref elements used for the declaration of a reference to an enterprise bean's home.

getResourceEnvRefs

public EList getResourceEnvRefs()
Returns:
The list of ResourceEnvRefs references The resource-env-ref element contains a declaration of an application client's reference to an administered object associated with a resource in the application client's environment. It consists of an optional description, the resource environment reference name, and an indication of the resource environment reference type expected by the application client code. Used in: application-client Example: jms//StockQueue javax.jms.Queue

getCallbackHandler

public JavaClass getCallbackHandler()
Returns:
The CallbackHandler reference A class provided by the application. The class must have a no args constructor and must implement the javax.security.auth.callback.CallbackHandler interface. The class will be instantiated by the application client container and used by the container to collect authentication information from the user.

setCallbackHandler

public void setCallbackHandler(JavaClass value)
Parameters:
value - The new value of the CallbackHandler reference

getServiceRefs

public EList getServiceRefs()
Returns the value of the 'Service Refs' containment reference list. The list contents are of type ServiceRef.

If the meaning of the 'Service Refs' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Service Refs' containment reference list.
See Also:
ClientPackage.getApplicationClient_ServiceRefs()

getMessageDestinationRefs

public EList getMessageDestinationRefs()
Returns the value of the 'Message Destination Refs' containment reference list. The list contents are of type MessageDestinationRef.

If the meaning of the 'Message Destination Refs' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Message Destination Refs' containment reference list.
See Also:
ClientPackage.getApplicationClient_MessageDestinationRefs()

getMessageDestinations

public EList getMessageDestinations()
Returns the value of the 'Message Destinations' containment reference list. The list contents are of type MessageDestination.

If the meaning of the 'Message Destinations' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Message Destinations' containment reference list.
See Also:
ClientPackage.getApplicationClient_MessageDestinations()