Oracle Entitlements Server Provider SSPI API Reference

weblogic.security.service
Class JMSResource

java.lang.Object
  |
  +--weblogic.security.service.ResourceBase
        |
        +--weblogic.security.service.JMSResource
public final class JMSResource
extends ResourceBase

The JMSResource class is used by a container to specify the JMS 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 JMS resource is:
type=<jms>, application=, destType=queue, resource=myQueue, action=receive

Author:
Copyright © 2004-2008, Oracle and/or its affiliates. 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
JMSResource(java.lang.String application, java.lang.String destType, java.lang.String resource, java.lang.String action)
          Constructs a new JMSResource with a target name composed from the application, destType, resource, 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 JMSResource.
 java.lang.String getApplicationName()
          Gets the name of the application associated with the JMSResource.
 java.lang.String getDestinationType()
          Gets the type of the destination resource.
 java.lang.String[] getKeys()
          Gets keys for the JMSResource.
 int getRepeatingFieldIndex()
           
 int getRepeatingFieldTerminatingIndex()
           
 java.lang.String getResourceName()
          Gets the name of the JMSResource.
 java.lang.String getType()
          Gets the type of this resource (JMSResource).
 void initialize(java.lang.String application, java.lang.String destType, java.lang.String resource, 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 JMSResource.
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

JMSResource

public JMSResource(java.lang.String application,
                   java.lang.String destType,
                   java.lang.String resource,
                   java.lang.String action)
            throws InvalidParameterException
Constructs a new JMSResource with a target name composed from the application, destType, resource, 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.

destType - a String indicating the type of the destination resource. Valid values for this parameter are restricted to the following:
  • topic
  • queue

resource - a String representing the name of the JMS resource. If the value of the destType parameter is topic, then this parameter is the name of the topic. If the value of the destType parameter is queue, then this parameter is the name of the queue. A value of null indicates that the security policy for the resource pertains to all methods that match the other parameters of the resource specification, without consideration of the name of the destination on which they occur.

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:
  • send
  • receive
  • browse

Throws:
InvalidParameterException - if the parameters are not specified.

Method Detail

initialize

public void initialize(java.lang.String application,
                       java.lang.String destType,
                       java.lang.String resource,
                       java.lang.String action)
Deprecated. As of 04/01/02, the constructor should be used instead.

Replaces application, destType, resource, 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.

destType - a String indicating the type of the destination resource. Valid values for this parameter are restricted to the following:
  • topic
  • queue

resource - a String representing the name of the JMS resource. If the value of the destType parameter is topic, then this parameter is the name of the topic. If the value of the destType parameter is queue, then this parameter is the name of the queue. A value of null indicates that the security policy for the resource pertains to all methods that match the other parameters of the resource specification, without consideration of the name of the destination on which they occur.

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:
  • send
  • receive
  • browse

getType

public java.lang.String getType()
Gets the type of this resource (JMSResource).

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

The parentage hierarchy for the JMSResource is:

type=<jms>, application=, destinationType=queue, resource=myQueue, action=
type=<jms>, application=, destinationType=queue, resource=myQueue
type=<jms>, application=, destinationType=queue, action=
type=<jms>, application=, destinationType=queue
type=<jms>, action=
type=<jms>

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

type=<jms>, application=, destinationType=queue, resource=myQueue, action=
type=<jms>, application=, destinationType=queue
type=<jms>

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 JMSResource.

Returns:
an array of Strings containing the JMSResource's keys.

Overrides:
getKeys in class ResourceBase

getDestinationType

public java.lang.String getDestinationType()
Gets the type of the destination resource.

Returns:
the type of the destination resource, represented as a String.

getResourceName

public java.lang.String getResourceName()
Gets the name of the JMSResource.

Returns:
the name of the JMSResource, represented as a String.

getActionName

public java.lang.String getActionName()
Gets the name of the action being requested on the JMSResource.

Returns:
the action being requested on the JMSResource, represented as a String.

getApplicationName

public java.lang.String getApplicationName()
Gets the name of the application associated with the JMSResource.

Returns:
the name of the application associated with the JMSResource, 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)