public final class JMSResource extends ResourceBase
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 deployed with an application where the module name is specified
in the weblogic-application.xml
descriptor is:
type=<jms>, application=myApp, module=myModule, destType=queue, resource=myQueue, action=receive
The toString
format for a JMS system resource is:
type=<jms>, application=mySystemResource, destType=queue, resource=myQueue, action=receive
The toString
format for a JMS resource that is part of the interop-jms
resources is:
type=<jms>, application=, destType=queue, resource=myQueue, action=receive
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
action |
private static java.lang.String |
ACTION |
private static java.lang.String[] |
KEYS |
private static java.lang.String |
MODULE |
private static int |
REPEATING_FIELD_INDEX |
private static int |
REPEATING_FIELD_TERMINATING_INDEX |
private boolean |
showAction |
private static Resource |
TOP |
id, length, NO_PARENT, parent, resStr, SCOPE_RESOURCE_ACTION, values
LIST_FIELD_TYPE, NORMAL_FIELD_TYPE, PATH_FIELD_TYPE, UNDEFINED_FIELD_TYPE
Modifier | Constructor and Description |
---|---|
private |
JMSResource(java.lang.String[] values,
int length,
java.lang.String action,
boolean showAction) |
|
JMSResource(java.lang.String application,
java.lang.String module,
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. |
Modifier and Type | Method and Description |
---|---|
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 . |
java.lang.String |
getModule()
Returns the name of the module associated with the
JMSResource . |
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()
Gets the name of the
JMSResource . |
private static long |
getSeed(java.lang.String action,
boolean showAction) |
java.lang.String |
getType()
Gets the type of this resource (
JMSResource ). |
private void |
init(java.lang.String[] values,
int length,
java.lang.String action,
boolean showAction) |
private void |
initialize(java.lang.String application,
java.lang.String module,
java.lang.String destType,
java.lang.String resource,
java.lang.String action) |
boolean |
isTransitiveField(java.lang.String fieldName)
Returns true when the specified field name is a transitive field.
|
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.
|
appendArrayValue, appendValue, getFieldType, getID, getParentResource, getValues, hashCode, init, init, toString
private static final java.lang.String ACTION
private static final java.lang.String MODULE
private static final java.lang.String[] KEYS
private static final int REPEATING_FIELD_INDEX
private static final int REPEATING_FIELD_TERMINATING_INDEX
private static final Resource TOP
private java.lang.String action
private boolean showAction
public JMSResource(java.lang.String application, java.lang.String module, java.lang.String destType, java.lang.String resource, java.lang.String action) throws InvalidParameterException
JMSResource
with a target name composed from
the application
, destType
,
resource
, and action
parameters.application
- a String indicating the name of the application
in which the resource is deployed, or the name
of the system resource.
A value of null
indicates that the
resource is part of the interop-jms
resources.module
- a String indicating the name of the module as it appears
in the corresponding <module>
element
associated with the weblogic-application.xml
deployment descriptor.
A value of null
indicates that the
resource is deployed standalone or that the
resource is part of the interop-jms
resources.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
InvalidParameterException
- if the parameters are not specified.private JMSResource(java.lang.String[] values, int length, java.lang.String action, boolean showAction)
private void initialize(java.lang.String application, java.lang.String module, java.lang.String destType, java.lang.String resource, java.lang.String action)
private void init(java.lang.String[] values, int length, java.lang.String action, boolean showAction)
private static long getSeed(java.lang.String action, boolean showAction)
public java.lang.String getType()
JMSResource
).protected Resource makeParent()
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 a system JMSResource
is:
type=<jms>, application=mySystemResource, destinationType=queue, resource=myQueue, action=send
type=<jms>, application=mySystemResource, destinationType=queue, resource=myQueue
type=<jms>, application=mySystemResource, destinationType=queue, action=send
type=<jms>, application=mySystemResource, destinationType=queue
type=<jms>, application=mySystemResource, action=send
type=<jms>, application=mySystemResource
type=<app>, application=mySystemResource
type=<jms>, action=send
type=<jms>
makeParent
in class ResourceBase
Resource
object of the parent resource.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 nonepublic boolean isTransitiveField(java.lang.String fieldName)
SelfDescribingResourceV2
isTransitiveField
in interface SelfDescribingResourceV2
isTransitiveField
in class ResourceBase
public java.lang.String[] getKeys()
JMSResource
.getKeys
in interface Resource
getKeys
in class ResourceBase
JMSResource
's keys.public java.lang.String getDestinationType()
public java.lang.String getResourceName()
JMSResource
.JMSResource
, represented as a String.public java.lang.String getActionName()
JMSResource
.JMSResource
, represented as a String.public java.lang.String getApplicationName()
JMSResource
.JMSResource
,
represented as a String.public java.lang.String getModule()
JMSResource
.JMSResource
.protected void writeResourceString(java.lang.StringBuffer buf)
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.
writeResourceString
in class ResourceBase
buf
- buffer to write to.public boolean equals(java.lang.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)