Package weblogic.security.service

Class NoSQLResource

java.lang.Object

weblogic.security.service.ResourceBase

weblogic.security.service.NoSQLResource

All Implemented Interfaces:

java.io.Serializable, Resource, SelfDescribingResource, SelfDescribingResourceV2

public final class NoSQLResource
extends ResourceBase

Represents authorization to access a globally configured NoSQL resource.

The resource hierarchy preserves the requested action while walking from a named resource to the global NoSQL resource:

 type=<nosql>, resource=orders, action=access
 type=<nosql>, resource=orders
 type=<nosql>, action=access
 type=<nosql>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ACCESS_ACTION	The runtime action used to authorize NoSQL access.

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

Constructors

Constructor	Description
NoSQLResource(java.lang.String resource, java.lang.String action)	Constructs a NoSQL security resource.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)	Compares this resource to the resource in the specified object.
java.lang.String	getActionName()
java.lang.String[]	getKeys()	Gets keys for the resource.
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.
java.lang.String	getResourceName()
java.lang.String	getType()	Gets the type of this resource.
java.lang.String[]	getValues()	Returns values aligned with getKeys(), including the separately propagated action value.
protected Resource	makeParent()	Creates a ResourceBase object that represents the parent of the current resource.
protected void	writeResourceString(java.lang.StringBuffer buffer)	Writes a string representation of the resource to buffer.

Methods inherited from class java.lang.Object

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

Methods inherited from class weblogic.security.service.ResourceBase

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

Field Detail

ACCESS_ACTION

public static final java.lang.String ACCESS_ACTION

The runtime action used to authorize NoSQL access.

See Also:

Constant Field Values

Constructor Detail

NoSQLResource

public NoSQLResource(java.lang.String resource,
                     java.lang.String action)

Constructs a NoSQL security resource.

Parameters:

resource - the globally configured NoSQL resource name, or null for all NoSQL resources

action - the requested action, or null for all actions

Method Detail

getType

public java.lang.String getType()

Description copied from interface: Resource

Gets the type of this resource.

Returns:

the NoSQL resource type

makeParent

protected Resource makeParent()

Description copied from class: ResourceBase

Creates a ResourceBase object that represents the parent of the current resource. If the resource does not have a parent, the value of null must be returned.

Subclasses should override this method.

Overrides:

makeParent in class ResourceBase

Returns:

the parent authorization resource, or null at the top

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 action field

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:

the terminating index for action propagation

getKeys

public java.lang.String[] getKeys()

Description copied from class: ResourceBase

Gets keys for the resource.

Specified by:

getKeys in interface Resource

Specified by:

getKeys in class ResourceBase

Returns:

the resource keys

getValues

public java.lang.String[] getValues()

Returns values aligned with getKeys(), including the separately propagated action value.

Specified by:

getValues in interface Resource

Overrides:

getValues in class ResourceBase

Returns:

the resource values

getResourceName

public java.lang.String getResourceName()

Returns:

the globally configured NoSQL resource name

getActionName

public java.lang.String getActionName()

Returns:

the requested action when present

writeResourceString

protected void writeResourceString(java.lang.StringBuffer buffer)

Description copied from class: ResourceBase

Writes a string representation of the resource to buffer.

Subclasses should override this method if their string representation is different.

Overrides:

writeResourceString in class ResourceBase

Parameters:

buffer - buffer to write to.

equals

public boolean equals(java.lang.Object other)

Description copied from class: ResourceBase

Compares this resource to the resource in the specified object.

Specified by:

equals in interface Resource

Overrides:

equals in class ResourceBase

Parameters:

other - 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)