org.systinet.security.perm
Class WSSecurityMechsPermission

java.lang.Object
  extended byjava.security.Permission
      extended byorg.systinet.security.perm.WSManagePermission
          extended byorg.systinet.security.perm.WSSecurityMechsPermission
All Implemented Interfaces:
java.security.Guard, java.io.Serializable

public final class WSSecurityMechsPermission
extends WSManagePermission

This class is for service security mechanism permissions.

You have to specify the name of web service endpoint path. The name is required, but if you set it to "*", it is handled as a permission to all web service endpoints.

The actions to be granted are passed to the constructor in a string containing a list of zero or more comma-separated keywords. The possible keywords are "get", "set". The action string is optional, if it is not present, all actions are granted. Their meaning is defined as follows:

get
allows to get security mechanisms of a web service endpoint
set
allows to set security mechanisms of a web service endpoint

The actions string is converted to lowercase before processing.

Since:
4.0
See Also:
Serialized Form
Component:
Security-Specific

Field Summary
static int ALL
          All actions (get, set).
static int GET
          Enable action.
static int SET
          Disable action.
 
Fields inherited from class org.systinet.security.perm.WSManagePermission
ALL_NAMES
 
Constructor Summary
WSSecurityMechsPermission(java.lang.String name)
          Creates a new WSSecurityMechsPermission object with the specified name.
WSSecurityMechsPermission(java.lang.String name, int actionMask)
          Creates a new WSSecurityMechsPermission object with the specified name.
WSSecurityMechsPermission(java.lang.String name, java.lang.String actions)
          Creates a new WSSecurityMechsPermission object with the specified name.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Checks two WSSecurityMechsPermission objects for equality.
 java.lang.String getActions()
          Returns the "canonical string representation" of the actions.
 int hashCode()
          Returns the hash code value for this object.
 boolean implies(java.security.Permission p)
          Checks if this WSSecurityMechsPermission object "implies" the specified permission.
 java.security.PermissionCollection newPermissionCollection()
          Returns a new PermissionCollection object for storing WSSecurityMechsPermission objects.
 
Methods inherited from class org.systinet.security.perm.WSManagePermission
toString
 
Methods inherited from class java.security.Permission
checkGuard, getName
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

GET

public static final int GET
Enable action.

See Also:
Constant Field Values

SET

public static final int SET
Disable action.

See Also:
Constant Field Values

ALL

public static final int ALL
All actions (get, set).

See Also:
Constant Field Values
Constructor Detail

WSSecurityMechsPermission

public WSSecurityMechsPermission(java.lang.String name)
Creates a new WSSecurityMechsPermission object with the specified name. The name is the name of the web service endpoint, and actions are implicitelly ALL.

Parameters:
name - the name of the WSSecurityMechsPermission (name of the web service endpoint), cannot be null (, but can be WSManagePermission.ALL_NAMES).

WSSecurityMechsPermission

public WSSecurityMechsPermission(java.lang.String name,
                                 java.lang.String actions)
Creates a new WSSecurityMechsPermission object with the specified name. The name is the name of the web service endpoint, and actions contains a comma-separated list of the desired actions granted on management of security mechanisms. Possible actions are "get","set".

Parameters:
name - the name of the WSSecurityMechsPermission (name of the web service endpoint), cannot be null (, but can be WSManagePermission.ALL_NAMES).
actions - the actions string, can be null or empty string , then it means "all actions possible".

WSSecurityMechsPermission

public WSSecurityMechsPermission(java.lang.String name,
                                 int actionMask)
Creates a new WSSecurityMechsPermission object with the specified name. The name is the name of the web service endpoint, and actionsNask is a or-ed flag of public static final int values present herein.

Parameters:
name - the name of the WSSecurityMechsPermission (name of the web service endpoint), cannot be null (, but can be WSManagePermission.ALL_NAMES).
actionMask - composed out of
Method Detail

implies

public boolean implies(java.security.Permission p)
Checks if this WSSecurityMechsPermission object "implies" the specified permission.

More specifically, this method returns true if:

Overrides:
implies in class WSManagePermission
Parameters:
p - 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 WSSecurityMechsPermission objects for equality. Checks that obj is a WSSecurityMechsPermission, and has the same name and actions as this object.

Overrides:
equals in class WSManagePermission
Parameters:
obj - the object we are testing for equality with this object.
Returns:
true if obj is a WSSecurityMechsPermission, and has the same name and actions as this WSSecurityMechsPermission object.

hashCode

public int hashCode()
Returns the hash code value for this object. The hash code used is the hash code of this permissions name, that is, getName().hashCode(), where getName is from the Permission superclass.

Overrides:
hashCode in class WSManagePermission
Returns:
a hash code value for this object.

getActions

public java.lang.String getActions()
Returns the "canonical string representation" of the actions. That is, this method always returns present actions in the following order: get, set. For example, if this WSSecurityMechsPermission object allows both set and get actions, a call to getActions will return the string "get,set".

Overrides:
getActions in class WSManagePermission
Returns:
the canonical string representation of the actions.

newPermissionCollection

public java.security.PermissionCollection newPermissionCollection()
Returns a new PermissionCollection object for storing WSSecurityMechsPermission objects.

Overrides:
newPermissionCollection in class WSManagePermission
Returns:
a new PermissionCollection object suitable for storing WSSecurityMechsPermissions.