BEA WebLogic Server 9.1 API Reference

weblogic.security.service
Class EISResource

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

All Implemented Interfaces:

Resource, SelfDescribingResource, SelfDescribingResourceV2, Serializable

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

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Field Summary

Fields inherited from class weblogic.security.service.ResourceBase

id, length, NO_PARENT, parent, resStr, SCOPE_RESOURCE_ACTION, values

Fields inherited from interface weblogic.security.spi.SelfDescribingResource

LIST_FIELD_TYPE, NORMAL_FIELD_TYPE, PATH_FIELD_TYPE, UNDEFINED_FIELD_TYPE

Constructor Summary

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

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

Method Summary

String	getApplicationName() Gets the name of the application associated with the EISResource.
String	getDestinationId() Gets the name of the EISResource.
String	getEISName() Gets the name of the EISResource.
String[]	getKeys() Gets keys for the EISResource.
String	getModuleName() Gets the name of the EISResource module.
String	getType() Gets the type of this resource (EISResource).
void	initialize(String application, String module, String eis) Deprecated. As of 04/01/02, the constructor should be used instead.
protected Resource	makeParent() Gets a Resource object that represents the parent of the current EISResource.

Methods inherited from class weblogic.security.service.ResourceBase

appendArrayValue, appendValue, equals, getFieldType, getID, getParentResource, getRepeatingFieldIndex, getRepeatingFieldTerminatingIndex, getValues, hashCode, init, init, isTransitiveField, reset, toString, writeResourceString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

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.

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.

Throws:

InvalidParameterException - if the parameters are not specified.

Method Detail

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.

getDestinationId

public String getDestinationId()

Gets the name of the EISResource.

Returns:

the destinationId of the EISResource, represented as a String.

getEISName

public String getEISName()

Gets the name of the EISResource.

Returns:

the name of the EISResource, represented as a String.

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.

getModuleName

public String getModuleName()

Gets the name of the EISResource module.

Returns:

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

getType

public String getType()

Gets the type of this resource (EISResource).

Returns:

the type of this resource, represented as a String.

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.

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.