weblogic.security.service

Class WorkContextResource

java.lang.Object

weblogic.security.service.ResourceBase

weblogic.security.service.WorkContextResource

All Implemented Interfaces:

Serializable, Resource, SelfDescribingResource, SelfDescribingResourceV2

public class WorkContextResource
extends ResourceBase

The WorkContextResource class is used by a container to specify the WorkContext 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 WorkContext resource is:
type=<workcontext>, path={pathComponent1,pathComponent2}, actionName=modify

See Also:

Serialized Form

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Compares this resource to the resource in the specified object.
String	getActionName() Gets the name of the action being requested on the WorkContextResource.
int	getFieldType(String fieldName) Describe getFieldType method here.
String[]	getKeys() Gets keys for the WorkContextResource.
String[]	getPath() Gets the path in the JNDI tree.
String	getPathName() Get the dot-separated WorkContext path of the WorkContextResource.
int	getRepeatingFieldIndex() 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.
int	getRepeatingFieldTerminatingIndex() The field returned by getRepeatingFieldIndex is repeated as the Resource is shortened up to and including this field index.
String	getType() Gets the type of this resource (WorkContextResource).
protected Resource	makeParent() Gets a Resource object that represents the parent of the current WorkContextResource.
protected void	writeResourceString(StringBuffer buf) Writes a string representation of the resource to buffer.

Methods inherited from class weblogic.security.service.ResourceBase

appendArrayValue, appendValue, getID, getParentResource, getValues, hashCode, init, init, isTransitiveField, toString

Methods inherited from class java.lang.Object

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

Method Detail

getType

public String getType()

Gets the type of this resource (WorkContextResource).

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

The default parentage hierarchy for the WorkContextResource is:

type=<workcontext>, path={pathComponent1,pathComponent2}, action=
type=<workcontext>, path={pathComponent1,pathComponent2}
type=<workcontext>, path={pathComponent1}, action=
type=<workcontext>, path={pathComponent1}
type=<workcontext>, path={}, action=
type=<workcontext>, path={}
type=<workcontext>, action=
type=<workcontext>

The old deprecated parentage hierarchy for the WorkContextResource (with -Dweblogic.security.scopeResourceAction) is:

type=<workcontext>, path={pathComponent1,pathComponent2},action=
type=<workcontext>, path={pathComponent1}
type=<workcontext>, path={}
type=<workcontext>

Overrides:

makeParent in class ResourceBase

Returns:

the Resource object of the parent resource.

getKeys

public String[] getKeys()

Gets keys for the WorkContextResource.

Specified by:

getKeys in interface Resource

Specified by:

getKeys in class ResourceBase

Returns:

an array of Strings containing the WorkContextResource's keys.

getFieldType

public int getFieldType(String fieldName)

Description copied from interface: SelfDescribingResource

Describe getFieldType method here.

Specified by:

getFieldType in interface SelfDescribingResource

Overrides:

getFieldType in class ResourceBase

Parameters:

fieldName - the String name of the field being queried.

Returns:

the int field type of fieldName

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

writeResourceString

protected void writeResourceString(StringBuffer buf)

Writes a string representation of the resource to buffer.

Overrides:

writeResourceString in class ResourceBase

Parameters:

buf - buffer to write to.

getPathName

public String getPathName()

Get the dot-separated WorkContext path of the WorkContextResource.

Returns:

the WorkContext path of the WorkContextResource, represented as a String.

getActionName

public String getActionName()

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

Returns:

the name of the action being requested on the WorkContextResource, represented as a String.

getPath

public String[] getPath()

Gets the path in the JNDI tree.

Returns:

the elements of the path in the WorkContext tree, represented as an array of Strings.

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)