BEA WebLogic Server 9.0 API Reference

weblogic.security.service
Class ControlResource

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

All Implemented Interfaces:

Resource, SelfDescribingResource, SelfDescribingResourceV2, Serializable

public final class ControlResource

extends ResourceBase

The ControlResource class is used by a controls container to specify the Control 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 an Control resource is:
type=<control>, app=myApp, control=myControl, method=myMethod, methodParams={argumentType1, argumentType2}

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

ControlResource(String application, String control, String method, String[] methodParams)
Constructs a new ControlResource with a target name composed from the app, control, method, and methodParams parameters.

Method Summary

String	getApplicationName() Gets the name of the application associated with the ControlResource.
String	getControlName() Gets the name of the Control.
int	getFieldType(String fieldName) Describe getFieldType method here.
String[]	getKeys() Gets keys for the ControlResource.
String	getMethodName() Gets the name of the method on the ControlResource.
String[]	getMethodParams() Gets the parameter signature of the target method.
String	getType() Gets the type of this resource (ControlResource).
protected Resource	makeParent() Gets a Resource object that represents the parent of the current ControlResource.
protected void	writeResourceString(StringBuffer buf) Writes a string representation of the resource to buffer.

Methods inherited from class weblogic.security.service.ResourceBase

appendArrayValue, appendValue, equals, getID, getParentResource, getRepeatingFieldIndex, getRepeatingFieldTerminatingIndex, getValues, hashCode, init, init, isTransitiveField, reset, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlResource

public ControlResource(String application,
                       String control,
                       String method,
                       String[] methodParams)

Constructs a new ControlResource with a target name composed from the app, control, method, and methodParams parameters.

Method Detail

getApplicationName

public String getApplicationName()

Gets the name of the application associated with the ControlResource.

Returns:

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

getControlName

public String getControlName()

Gets the name of the Control.

Returns:

the name of the Control, 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

Parameters:

fieldName - the String name of the field being queried.

Returns:

the int field type of fieldName

getKeys

public String[] getKeys()

Gets keys for the ControlResource.

Specified by:

getKeys in interface Resource

Specified by:

getKeys in class ResourceBase

Returns:

an array of Strings containing the ControlResource's keys.

getMethodName

public String getMethodName()

Gets the name of the method on the ControlResource.

Returns:

the name of the method on the ControlResource, represented as a String.

getMethodParams

public String[] getMethodParams()

Gets the parameter signature of the target method.

Returns:

the parameter signature of the target method, represented as an array of Strings.

getType

public String getType()

Gets the type of this resource (ControlResource).

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

The parentage hierarchy for the ControlResource (that is, the values returned from successive calls to this method) is:

type=<control>, application=myApp, control=myControl, method=myMethod, signature={argumentType1,argumentType2} type=<control>, application=myApp, control=myControl, method=myMethod type=<control>, application=myApp, control=myControl type=<control>, application=myApp type=<app>, application=myApp type=<control>

Overrides:

makeParent in class ResourceBase

Returns:

a Resource object of the parent resource.

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.