Overview | Package | Class | Tree | Index | Help

Oracle® Coherence Java API Reference
v3.5.3
E15583-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.tangosol.net
Class ClusterPermission

    java.lang.Object
      java.security.Permission
          com.tangosol.net.ClusterPermission

All Implemented Interfaces:
  java.io.Serializable, java.security.Guard

    public final class ClusterPermission

extends java.security.Permission
implements java.io.Serializable

This class represents access to a clustered resource such as a Service or NamedCache. A ClusterPermission consists of a target name and a set of actions valid for that target.

Target name is a string containing a list of one or more comma-separated target attributes. The valid target attributes are:

- "service=<service-name>"
- "service=<service-prefix*>"
- "cache=<cache-name>"
- "cache=<cache-prefix*>"
- "*"

If a target string does not contain the "service" attribute, it is equivalent to the "service=*" attribute value. If a target string does not contain the "cache" attribute, it is equivalent to the "cache=*" attribute value or is meant to indicate a service that is not a `CacheService` (e.g. `InvocationService`). A target name string consisting of a single "*" indicates all clustered resources.

The actions to be granted are passed to the constructor in a string containing a list of one or more comma-separated keywords. The possible keywords are: "create", "destroy", "join", "manage", "all". An action string "all" indicates a combination of all valid actions.
Note: the actions string is converted to lowercase before processing.

Since:
  Coherence 2.5
Author:
  gg 2004.05.28

Field Summary
`static int` | `ALL` All actions.
`static int` | `CREATE` Create action.
`static int` | `DESTROY` Create action.
`static int` | `JOIN` Join action.
`static int` | `NONE` No actions.

Constructor Summary
`ClusterPermission(java.lang.String sTarget, java.lang.String sAction)` Construct a ClusterPermission object.

Method Summary
`boolean` | `equals(java.lang.Object obj)` Checks two Permission objects for equality.
`static java.lang.String` | `formatAction(int nAction)` Format the action string.
`java.lang.String` | `getActions()` Return the actions as a String in a canonical form.
`java.lang.String` | `getServiceName()` Return the service name for this permission object or null if the permission applies to any service.
`int` | `hashCode()` Return the hash code value for this ClusterPermission object.
`boolean` | `implies(java.security.Permission permission)` Check if the specified permission's actions are "implied by" this object's actions.
`static void` | `main(java.lang.String[] asArg)` Unit test allows to compare the specified permissions.
`protected void` | `parseAction(java.lang.String sAction)` Parse the action string and set the action flag.
`protected void` | `parseTarget(java.lang.String sTarget)` Parse the target string.

Methods inherited from class java.security.Permission
`checkGuard, getName, newPermissionCollection, toString`

Field Detail

### CREATE

    public static final int CREATE

  Create action.

  See Also:
    Constant Field Values

### DESTROY

    public static final int DESTROY

  Create action.

  See Also:
    Constant Field Values

### JOIN

    public static final int JOIN

  Join action.

  See Also:
    Constant Field Values

### ALL

    public static final int ALL

  All actions.

  See Also:
    Constant Field Values

### NONE

    public static final int NONE

  No actions.

  See Also:
    Constant Field Values

Constructor Detail

### ClusterPermission

    public ClusterPermission(java.lang.String sTarget,
                             java.lang.String sAction)

  Construct a ClusterPermission object.

  Parameters:
    `sTarget` - the clustered resource name; must be specified
    `sAction` - the action(s) name; must be specified

Method Detail

### getActions

    public java.lang.String getActions()

  Return the actions as a String in a canonical form.

  Specified by:
    `getActions` in class `java.security.Permission`
  Returns:
    the actions of this Permission

### implies

    public boolean implies(java.security.Permission permission)

  Check if the specified permission's actions are "implied by" this object's actions.

  There is a slight difference in semantics of the wild card ("*") in "this" and passed-in Permission's target. The specified permission for cache-less services will not contain any "cache=" attribute in the target string, while cache services will always specify a "cache=" attribute.

  Specified by:
    `implies` in class `java.security.Permission`
  Parameters:
    `permission` - the permission to check against
  Returns:
    true if the specified permission is implied by this object, false if not

### equals

    public boolean equals(java.lang.Object obj)

  Checks two Permission objects for equality.

  Specified by:
    `equals` in class `java.security.Permission`
  Parameters:
    `obj` - the object we are testing for equality with this object
  Returns:
    true if both Permission objects are equivalent

### hashCode

    public int hashCode()

  Return the hash code value for this ClusterPermission object.

  Specified by:
    `hashCode` in class `java.security.Permission`
  Returns:
    a hash code value for this object

### getServiceName

    public java.lang.String getServiceName()

  Return the service name for this permission object or null if the permission applies to any service.

  Returns:
    the service name for this permission object

### parseTarget

    protected void parseTarget(java.lang.String sTarget)

  Parse the target string.

  Parameters:
    `sTarget` - the target string

### parseAction

    protected void parseAction(java.lang.String sAction)

  Parse the action string and set the action flag.

  Parameters:
    `sAction` - the action string

### formatAction

    public static java.lang.String formatAction(int nAction)

  Format the action string.

  Parameters:
    `nAction` - the action mask
  Returns:
    the action string

### main

    public static void main(java.lang.String[] asArg)

  Unit test allows to compare the specified permissions.

         java com.tangosol.net.ClusterPermission

Overview | Package | Class | Tree | Index | Help

Oracle® Coherence Java API Reference
v3.5.3
E15583-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000, 2010, Oracle. All rights reserved.