weblogic.security.service
Class EISResource

java.lang.Object
  weblogic.security.service.ResourceBase
      weblogic.security.service.EISResource

All Implemented Interfaces:

Serializable, Resource, SelfDescribingResource, SelfDescribingResourceV2

public class EISResource
extends ResourceBase

The EISResource class is used by a container to specify the EIS resource (and method related to the resource) that a caller is attempting to access.

The toString format (which is produced by the ResourceBase class) for an EIS resource is:
type=<eis>, application=MyApplication, module=My.rar, eis=myResource

See Also:

Serialized Form

EISResource

public EISResource(String application,
                   String module,
                   String eis)
            throws InvalidParameterException

Constructs a new EISResource with a target name composed from the application, module, and eis parameters.

Parameters:

application - a String indicating the name of the application in which the resource is deployed, as it appears in the corresponding <display-name> element. The <display-name> element is associated with an <application> element in the deployment descriptor, in an .ear file. A value of null indicates that the resource is not deployed as part of an application.

module - a String name of the module, as it appears in the corresponding <display-name> element. The <display-name> is associated with the <connector> element in the deployment descriptor. Because the <display-name> element is optional in the <connector> element of the deployment descriptor, the name of the .rar file containing the EIS, less the '.rar' extension, may be used in its absence.

eis - a String representing the name of the EIS resource, as it appears in the corresponding <eis-type> element in the deployment descriptor.

Throws:

InvalidParameterException - if the parameters are not specified.

EISResource

public EISResource(String application,
                   String module,
                   String eis,
                   String destinationId)
            throws InvalidParameterException

Constructs a new EISResource with a target name composed from the application, module, eis, and destinationId parameters.

Parameters:

application - a String indicating the name of the application in which the resource is deployed, as it appears in the corresponding <display-name> element. The <display-name> element is associated with an <application> element in the deployment descriptor, in an .ear file. A value of null indicates that the resource is not deployed as part of an application.

module - a String name of the module, as it appears in the corresponding <display-name> element. The <display-name> is associated with the <connector> element in the deployment descriptor. Because the <display-name> element is optional in the <connector> element of the deployment descriptor, the name of the .rar file containing the EIS, less the '.rar' extension, may be used in its absence.

eis - a String representing the name of the EIS resource, as it appears in the corresponding <eis-type> element in the deployment descriptor.

destinationId - a String representing the specific outbound destination for the resource as it appears in the corresponding <jndi-name> element in the deployment descriptor.

Throws:

InvalidParameterException - if the parameters are not specified.

initialize

public void initialize(String application,
                       String module,
                       String eis)

Deprecated. As of 04/01/02, the constructor should be used instead.

Replaces application, module, eis parameters of the resource with the specified values.

Parameters:

application - a String indicating the name of the application in which the resource is deployed, as it appears in the corresponding <display-name> element. The <display-name> element is associated with an <application> element in the deployment descriptor, in an .ear file. A value of null indicates that the resource is not deployed as part of an application.

module - a String name of the module, as it appears in the corresponding <display-name> element. The <display-name> is associated with the <connector> element in the deployment descriptor. Because the <display-name> element is optional in the <connector> element of the deployment descriptor, the name of the .rar file containing the EIS, less the '.rar' extension, may be used in its absence.

eis - a String representing the name of the EIS resource, as it appears in the corresponding <eis-type> element in the deployment descriptor.

getType

public String getType()

Gets the type of this resource (EISResource).

Returns:

the type of this resource, represented as a String.

makeParent

protected Resource makeParent()

Gets a Resource object that represents the parent of the current EISResource. If the resource does not have a parent, the value of null must be returned.

The parentage hierarchy for the EISResource (that is, the values returned from successive calls to this method) is:

type=<eis>, application=MyApplication, module=My.rar
type=<eis>, application=MyApplication
type=<app>, application=MyApplication
type=<eis>

Overrides:

makeParent in class ResourceBase

Returns:

the Resource object of the parent resource.

getKeys

public String[] getKeys()

Gets keys for the EISResource.

Specified by:

getKeys in interface Resource

Specified by:

getKeys in class ResourceBase

Returns:

an array of Strings containing the EISResource's keys.

getApplicationName

public String getApplicationName()

Gets the name of the application associated with the EISResource.

Returns:

the name of the application associated with the EISResource, represented as a String.

getModuleName

public String getModuleName()

Gets the name of the EISResource module.

Returns:

the name of the EISResource module, represented as a String.

getEISName

public String getEISName()

Gets the name of the EISResource.

Returns:

the name of the EISResource, represented as a String.

getDestinationId

public String getDestinationId()

Gets the name of the EISResource.

Returns:

the destinationId of the EISResource, represented as a String.