|
Oracle Fusion Middleware Oracle WebLogic Server API Reference 11g Release 1 (10.3.5) Part Number E13941-05 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectweblogic.security.service.ResourceBase
weblogic.security.service.WorkContextResource
public class WorkContextResource
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
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 |
---|
public WorkContextResource(String[] path, String actionName) throws InvalidParameterException
WorkContextResource
with a target name composed
from the path
, and actionName
parameters.
path
- a non-empty array of non-empty Strings representing
the elements of the path to distinquish WorkContext. 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
InvalidParameterException
- if an empty String is passed
as a Path member or an empty
String array is passed as the
path parameter.public WorkContextResource()
WorkContextResource
.
Method Detail |
---|
public void initialize(String[] path, String actionName)
path
, actionName
of the resource with the specified values.
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
InvalidParameterException
- if an empty String is passed
as a Path member or an empty
String array is passed as the
path parameter.public String getType()
WorkContextResource
).
protected Resource makeParent()
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>
makeParent
in class ResourceBase
Resource
object of the parent resource.public String[] getKeys()
WorkContextResource
.
getKeys
in interface Resource
getKeys
in class ResourceBase
WorkContextResource
's keys.public int getFieldType(String fieldName)
SelfDescribingResource
getFieldType
method here.
getFieldType
in interface SelfDescribingResource
getFieldType
in class ResourceBase
fieldName
- the String
name of the field being queried.
int
field type of fieldName
public int getRepeatingFieldIndex()
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.
getRepeatingFieldIndex
in interface SelfDescribingResource
getRepeatingFieldIndex
in class ResourceBase
public int getRepeatingFieldTerminatingIndex()
SelfDescribingResource
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.
getRepeatingFieldTerminatingIndex
in interface SelfDescribingResource
getRepeatingFieldTerminatingIndex
in class ResourceBase
int
describing the terminating index or
getKeys().length
if noneprotected void writeResourceString(StringBuffer buf)
writeResourceString
in class ResourceBase
buf
- buffer to write to.public String getPathName()
WorkContextResource
.
WorkContextResource
, represented as a String.public String getActionName()
WorkContextResource
.
WorkContextResource
,
represented as a String.public String[] getPath()
public void reset()
WorkContextResource
.
reset
in class ResourceBase
public boolean equals(Object obj)
equals
in interface Resource
equals
in class ResourceBase
obj
- the other resource with which to compare this resource.
TRUE
if the resource passed in matches this resource,
and FALSE
otherwise.Object.equals(Object)
|
Copyright 1996, 2011, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Oracle WebLogic Server API Reference 11g Release 1 (10.3.5) Part Number E13941-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |