WebLogic Server 8.1 API Reference

weblogic.security.service
Class ServerResource

java.lang.Object
  |
  +--weblogic.security.service.ResourceBase
        |
        +--weblogic.security.service.ServerResource

public final class ServerResource

extends ResourceBase

The ServerResource class is used by a container to specify the Server 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 Server resource is:
type=<svr>, application=, server=MyServer, action=shutdown

Author:

Copyright © 2004 BEA Systems, Inc. All Rights Reserved.

See Also:

Serialized Form

Fields inherited from class weblogic.security.service.ResourceBase

id, length, NO_PARENT, parent, resStr, SCOPE_RESOURCE_ACTION, values

Constructor Summary

ServerResource(java.lang.String application, java.lang.String server, java.lang.String action)
Constructs a new ServerResource with a target name composed from the application, server, and action parameters.

Method Summary

boolean	equals(java.lang.Object obj) Compares this resource to the resource in the specified object.
java.lang.String	getActionName() Gets the name of the action being requested on the ServerResource.
java.lang.String	getApplicationName() Gets the name of the application associated with the ServerResource.
java.lang.String[]	getKeys() Gets keys for the ServerResource.
int	getRepeatingFieldIndex()
int	getRepeatingFieldTerminatingIndex()
java.lang.String	getServerName() Gets the name of the ServerResource.
java.lang.String	getType() Gets the type of this resource (ServerResource).
void	initialize(java.lang.String application, java.lang.String server, java.lang.String action) 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 ServerResource.
protected void	writeResourceString(java.lang.StringBuffer buf) Writes a string representation of the resource to buffer.

Methods inherited from class weblogic.security.service.ResourceBase

appendArrayValue, appendValue, getFieldType, getID, getParentResource, getValues, hashCode, init, init, reset, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerResource

public ServerResource(java.lang.String application,
                      java.lang.String server,
                      java.lang.String action)

Constructs a new ServerResource with a target name composed from the application, server, and action parameters.

Parameters:

application - a String indicating the name of the application in which the resource is deployed, as it appears in the corresponding <display-name> element. The <display-name> element is associated with an <application> element in the deployment descriptor, in an .ear file. A value of null indicates that the resource is not deployed as part of an application.

server - a String representing the name of the Server resource.

action - a String representing the name of the action being requested on the 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:

• boot
• shutdown
• lock
• unlock

Method Detail

initialize

public void initialize(java.lang.String application,
                       java.lang.String server,
                       java.lang.String action)

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

Replaces application, server, and action parameters of the resource with the specified values.

Parameters:

application - a String indicating the name of the application in which the resource is deployed, as it appears in the corresponding <display-name> element. The <display-name> element is associated with an <application> element in the deployment descriptor, in an .ear file. A value of null indicates that the resource is not deployed as part of an application.

server - a String representing the name of the Server resource.

action - a String representing the name of the action being requested on the 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:

• boot
• shutdown
• lock
• unlock

getType

public java.lang.String getType()

Gets the type of this resource (ServerResource).

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

The parentage hierarchy for the ServerResource is:

type=<svr>, application=, server=MyServer, action=shutdown
type=<svr>, application=, server=MyServer
type=<svr>, action=shutdown
type=<svr>


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

type=<svr>, application=, server=MyServer
, action=shutdown
type=<svr>, application=, server=MyServer
type=<svr>


Returns:

the Resource object of the parent resource.

Overrides:

makeParent in class ResourceBase

getRepeatingFieldIndex

public int getRepeatingFieldIndex()

Overrides:

getRepeatingFieldIndex in class ResourceBase

getRepeatingFieldTerminatingIndex

public int getRepeatingFieldTerminatingIndex()

Overrides:

getRepeatingFieldTerminatingIndex in class ResourceBase

getKeys

public java.lang.String[] getKeys()

Gets keys for the ServerResource.

Returns:

an array of Strings containing the ServerResource's keys.

Overrides:

getKeys in class ResourceBase

getServerName

public java.lang.String getServerName()

Gets the name of the ServerResource.

Returns:

the name of the ServerResource, represented as a String.

getActionName

public java.lang.String getActionName()

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

Returns:

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

getApplicationName

public java.lang.String getApplicationName()

Gets the name of the application associated with the ServerResource.

Returns:

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

writeResourceString

protected void writeResourceString(java.lang.StringBuffer buf)

Writes a string representation of the resource to buffer.

Each type of resource is first printed in angled brackets. Then, each key is printed, in order, along with it's value. The keys are comma-separated. Values that are lists are comma-separated and delineated by open and close curly braces. Each value is printed as is, except that commas (,), open braces ({), close braces (}), and back slashes (\) are each escaped with a backslash.

Note: Because this method produces a result based on the concatenation of strings, it may be expensive in terms of performance.

Parameters:

buf - buffer to write to.

Overrides:

writeResourceString in class ResourceBase

equals

public boolean equals(java.lang.Object obj)

Compares this resource to the resource in the specified object.

Parameters:

obj - the other resource with which to compare this resource.

Returns:

TRUE if the resource passed in matches this resource, and FALSE otherwise.

Overrides:

equals in class ResourceBase

See Also:

Object.equals(Object)