weblogic.security.service
Class JDBCResource

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

All Implemented Interfaces:

Serializable, Resource, SelfDescribingResource, SelfDescribingResourceV2

public final class JDBCResource
extends ResourceBase

The JDBCResource class is used by a container to specify the JDBC 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 a JDBC resource deployed with an application where the module name is specified in the weblogic-application.xml descriptor is:
type=<jdbc>, application=myApp, module=myModule, category=ConnectionPool, resource=myPool, action=admin

The toString format for a JDBC system resource is:
type=<jdbc>, application=mySystemResource, module=, category=ConnectionPool, resource=myPool, action=admin

The toString format for a legacy JDBC system resource is:
type=<jdbc>, application=, module=, category=ConnectionPool, resource=myPool, action=admin

See Also:

Serialized Form

JDBCResource

public JDBCResource(String application,
                    String module,
                    String category,
                    String resource,
                    String action)

Constructs a new JDBCResource with a target name composed from the application, module, category, resource, and action parameters.

Parameters:

application - a String indicating the name of the application in which the resource is deployed or the name of the system resource. A value of null indicates that the resource is a legacy system resource.

module - a String name of the module, as it appears in the corresponding <module> element associated with the weblogic-application.xml deployment descriptor. A value of null indicates that the resource is deployed standalone or that the resource is a legacy system resource.

category - a String indicating the category of the JDBC resource. Valid values for this parameter are restricted to the following:

• ConnectionPool
• MultiPool

resource - a String representing the name of the JDBC resource. If the value of the resourceType parameter is ConnectionPool, then this parameter is the name of the connection pool. A value of null indicates that the security policy for the resource pertains to all resource categories that match the other parameters of the resource specification, without consideration for the resource name.

action - a String representing the name of the action being requested on the resource. Valid values for this parameter are restricted to the following:

• reserve
• admin
• shrink
• reset

initialize

public void initialize(String application,
                       String module,
                       String category,
                       String resource,
                       String action)

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

Replaces application, module, category, resource, and action parameters of the resource with the specified values.

getType

public String getType()

Gets the type of this resource (JDBCResource).

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 JDBCResource. If the resource does not have a parent, the value of null must be returned.

The parentage hierarchy for a system JDBCResource is:

type=<jdbc>, application=mySystemResource, module=, resourceType=ConnectionPool, resource=myPool, action=admin
type=<jdbc>, application=mySystemResource, module=, resourceType=ConnectionPool, resource=myPool
type=<jdbc>, application=mySystemResource, module=, resourceType=ConnectionPool, action=admin
type=<jdbc>, application=mySystemResource, module=, resourceType=ConnectionPool
type=<jdbc>, application=mySystemResource, action=admin
type=<jdbc>, application=mySystemResource
type=<app>, application=mySystemResource
type=<jdbc>, action=admin
type=<jdbc>

Overrides:

makeParent in class ResourceBase

Returns:

the Resource object of the parent resource.

getRepeatingFieldIndex

public int getRepeatingFieldIndex()

Description copied from interface: SelfDescribingResource

getRepeatingFieldIndex returns an index into the array returned by getKeys() that signifies what part of the Resource's fields repeat as the hierarchy is traversed. For example, in the URLResource, the httpMethod is repeated as the hierarchy is walked. A value of -1 indicates that there are no repeating fields.

Specified by:

getRepeatingFieldIndex in interface SelfDescribingResource

Overrides:

getRepeatingFieldIndex in class ResourceBase

Returns:

the index of the repeating fields or -1 if none

getRepeatingFieldTerminatingIndex

public int getRepeatingFieldTerminatingIndex()

Description copied from interface: SelfDescribingResource

The field returned by getRepeatingFieldIndex is repeated as the Resource is shortened up to and including this field index. After this field index the repetition is no longer applied.

Specified by:

getRepeatingFieldTerminatingIndex in interface SelfDescribingResource

Overrides:

getRepeatingFieldTerminatingIndex in class ResourceBase

Returns:

an int describing the terminating index or getKeys().length if none

getKeys

public String[] getKeys()

Gets keys for the JDBCResource.

Specified by:

getKeys in interface Resource

Specified by:

getKeys in class ResourceBase

Returns:

an array of Strings containing the JDBCResource's keys.

getResourceType

public String getResourceType()

Gets the category of the JDBCResource.

Returns:

the category of the JDBCResource, represented as a String.

getResourceName

public String getResourceName()

Gets the name of the JDBCResource.

Returns:

the name of the JDBCResource, represented as a Strong

getActionName

public String getActionName()

Gets the name of the action being requested on the JDBCResource.

Returns:

the action being requested on the JDBCResource, represented as a String

getApplicationName

public String getApplicationName()

Gets the name of the application associated with this JDBCResource.

Returns:

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

getModuleName

public String getModuleName()

Gets the name of the JDBCResource module.

Returns:

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

writeResourceString

protected void writeResourceString(StringBuffer buf)

Writes a string representation of the resource to buffer.

Each type of resource is first printed in angled brackets. Then, each key is printed, in order, along with it's value. The keys are comma-separated. Values that are lists are comma-separated and delineated by open and close curly braces. Each value is printed as is, except that commas (,), open braces ({), close braces (}), and back slashes (\) are each escaped with a backslash.

Note: Because this method produces a result based on the concatenation of strings, it may be expensive in terms of performance.

Overrides:

writeResourceString in class ResourceBase

Parameters:

buf - buffer to write to.

equals

public boolean equals(Object obj)

Compares this resource to the resource in the specified object.

Specified by:

equals in interface Resource

Overrides:

equals in class ResourceBase

Parameters:

obj - the other resource with which to compare this resource.

Returns:

TRUE if the resource passed in matches this resource, and FALSE otherwise.

See Also:

Object.equals(Object)