BEA WebLogic Server 9.1 API Reference

weblogic.security.service
Class WorkContextResource

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

All Implemented Interfaces:

Resource, SelfDescribingResource, SelfDescribingResourceV2, Serializable

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

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

WorkContextResource()
Deprecated. As of 04/01/02.

WorkContextResource(String[] path, String actionName)
Constructs a new WorkContextResource with a target name composed from the path, and actionName parameters.

Method Summary

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).
void	initialize(String[] path, String actionName) 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 WorkContextResource.
void	reset() Deprecated. As of 04/01/02.
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

Constructor Detail

WorkContextResource

public WorkContextResource()

Deprecated. As of 04/01/02.

Creates an empty WorkContextResource.

WorkContextResource

public WorkContextResource(String[] path,
                           String actionName)
                    throws InvalidParameterException

Constructs a new WorkContextResource with a target name composed from the path, and actionName parameters.

Throws:

InvalidParameterException - if an empty String is passed as a Path member or an empty String array is passed as the path parameter.

Method Detail

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)

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.

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

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.

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.

getPathName

public String getPathName()

Get the dot-separated WorkContext path of the WorkContextResource.

Returns:

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

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

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

getType

public String getType()

Gets the type of this resource (WorkContextResource).

Returns:

the type of this resource, represented as a String.

initialize

public void initialize(String[] path,
                       String actionName)

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

Replaces path, actionName of the resource with the specified values.

Parameters:

path - a non-empty array of non-empty Strings representing the elements of the path in the WorkContext tree. The order of the elements in the array must match the order of the context branches in the tree, starting with the root and walking out to the leaf level. Pass in a null as the parameter to indicate the root resource.

actionName - a String representing the name of the action being requested on the WorkContext resource. A value of null indicates that the security policy for the resource pertains to all actions that match the other parameters of the resource specification, without consideration for the action name. Valid values for this parameter are restricted to the following:

• create
• delete
• modify
• read

Throws:

InvalidParameterException - if an empty String is passed as a Path member or an empty String array is passed as the path parameter.

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.

reset

public void reset()

Deprecated. As of 04/01/02.

Clears all the values from the WorkContextResource.

Overrides:

reset in class ResourceBase

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.