com.ibm.websphere.objectgrid.security
Class ServerMapPermission

java.lang.Object
  java.security.Permission
      com.ibm.websphere.objectgrid.security.ServerMapPermission

All Implemented Interfaces:

Serializable, Guard

public final class ServerMapPermission
extends Permission

This class represents permissions to an ObjectMap hosted in a server, that is, a server-side distributed map. It has two following different actions:

• replicate
• dynamicIndex

Please refer to the BackingMap class for the permissions needed for each method.

Since:

WAS XD 6.1

See Also:

Permission, ObjectMap, Serialized Form

Field Summary

static int	ALL All permission constant
static String	ALL_PERMISSION All permissions String
static int	DYNAMIC_INDEX dynamic index permission constant
static int	NUMBER_PERMISSION The total number of possible Permissions
static String[]	PERMISSIONS An array with the string representation of each permission.
static int	REPLICATE replicating server map to client map permission constant.

Constructor Summary

ServerMapPermission(String name, int actions)
Constructs a new ServerMapPermission for the named map with the specified actions.

ServerMapPermission(String name, String actions)
Constructs a new ServerMapPermission for the named map with the specified actions.

ServerMapPermission(String ogName, String mapName, int actions)
Constructs a new MapPermission for the named map with the specified actions.

ServerMapPermission(String ogName, String mapName, String actions)
Constructs a new ServerMapPermission for the named map with the specified actions.

Method Summary

boolean	equals(Object o) Checks two ServerMapPermission objects for equality.
String	getActions() Returns the actions as a String.
static String	getActions(int m) Returns the actions as a String for the specified mask.
int	getActionsInInt() Returns an int mask value which represents the permission's actions.
String[]	getParsedNames() Returns an array which contains the object grid name and map name.
int	hashCode() Returns the hash code value for this ServerMapPermission object.
boolean	implies(Permission permission) Checks if the specified permission is "implied" by this object.

Methods inherited from class java.security.Permission

checkGuard, getName, newPermissionCollection, toString

Methods inherited from class java.lang.Object

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

Field Detail

NUMBER_PERMISSION

public static final int NUMBER_PERMISSION

The total number of possible Permissions

See Also:

Constant Field Values

REPLICATE

public static final int REPLICATE

replicating server map to client map permission constant.

See Also:

Constant Field Values

DYNAMIC_INDEX

public static final int DYNAMIC_INDEX

dynamic index permission constant

See Also:

Constant Field Values

PERMISSIONS

public static final String[] PERMISSIONS

An array with the string representation of each permission.

The indexes to the String representation are the int constants for each permission (i.e. replicate, dynamicIndex)

ALL_PERMISSION

public static final String ALL_PERMISSION

All permissions String

See Also:

Constant Field Values

ALL

public static final int ALL

All permission constant

See Also:

Constant Field Values

Constructor Detail

ServerMapPermission

public ServerMapPermission(String name,
                           String actions)

Constructs a new ServerMapPermission for the named map with the specified actions.

The map name for this permission should be in the format of .

Parameters:

name - the full name of the map. It is also the permission name.

actions - the comma separated list of actions, such as "replicate" and "dynamicIndex".

Throws:

IllegalArgumentException - if name is null or malformed or if actions is null or contains an invalidate action name

ServerMapPermission

public ServerMapPermission(String ogName,
                           String mapName,
                           String actions)

Constructs a new ServerMapPermission for the named map with the specified actions.

This method is used for the ObjectGrid map of which the ObjectGrid name or map name contains a ".". In this case, we pass the ObjectGrid name and map name separately as the parameters.

ObjectGrid uses <ObjectGrid name>.<map name> as the permission name. Therefore, your application still needs to make sure there is no name conflicts for the <ObjectGrid name>.<map name>. For example, you should not have an ObjectGrid with name "og" and one of its maps with name "session.data", and another ObjectGrid with name "og.session" and one of its maps with name "data".

Parameters:

ogName - the ObjectGrid name.

mapName - the map name.

actions - the comma separated list of actions, such as "replicate" and "dynamicIndex".

Throws:

IllegalArgumentException - if ObjectGrid name or map name is null or if actions is null or contains an invalidate action name

Since:

6.1.0.5 FIX2

ServerMapPermission

public ServerMapPermission(String name,
                           int actions)

Constructs a new ServerMapPermission for the named map with the specified actions.

The map name for this permission should be in the format of .

Parameters:

name - the full name of the map. It is also the permission name.

actions - the actions mask. For example, ServerMapPermission.REPLICATION|MapPermission.DYNAMIC_INDEX

Throws:

IllegalArgumentException - if name is null or malformed or if actions is less than 0 or greater than ALL

ServerMapPermission

public ServerMapPermission(String ogName,
                           String mapName,
                           int actions)

Constructs a new MapPermission for the named map with the specified actions.

This method is used for the ObjectGrid map of which the ObjectGrid name or map name contains a ".". In this case, we pass the ObjectGrid name and map name as the parameters.

ObjectGrid uses <ObjectGrid name>.<map name> as the permission name. Therefore, your application still needs to make sure there is no name conflicts for the <ObjectGrid name>.<map name>. For example, you should not have an ObjectGrid with name "og" and one of its maps with name "session.data", and another ObjectGrid with name "og.session" and one of its maps with name "data".

Parameters:

ogName - the ObjectGrid name.

mapName - the map name.

actions - the actions mask. For example, ServerMapPermission.REPLICATION|MapPermission.DYNAMIC_INDEX

Throws:

IllegalArgumentException - if ObjectGrid name or map name is null or if actions is less than 0 or greater than ALL

Since:

6.1.0.5 FIX2

Method Detail

implies

public boolean implies(Permission permission)

Checks if the specified permission is "implied" by this object.

More specifically, this method returns true if:

• permission's class is the same as this object's class, and

• permission's name is equal to or (in the case of wildcards) is implied by this object's name. For example, "a.*" implies "a.b"., and

• permission's actions are equal to or are a subset of this object's actions

Specified by:

implies in class Permission

Parameters:

permission - the permission to check against.

Returns:

true if the passed permission is equal to or implied by this permission, false otherwise.

equals

public boolean equals(Object o)

Checks two ServerMapPermission objects for equality.

Do not use the equals method for making access control decisions; use the implies method.

Specified by:

equals in class Permission

Parameters:

o - the object we are testing for equality with this object.

Returns:

true if both ServerMapPermission objects are equivalent.

hashCode

public int hashCode()

Returns the hash code value for this ServerMapPermission object.

Specified by:

hashCode in class Permission

Returns:

a hash code value for this object.

getActions

public String getActions()

Returns the actions as a String.

Specified by:

getActions in class Permission

Returns:

the actions of this Permission.

getActions

public static String getActions(int m)

Returns the actions as a String for the specified mask.

Parameters:

m - the mask

Returns:

the action string representation for the mask

getParsedNames

public String[] getParsedNames()

Returns an array which contains the object grid name and map name.

Returns:

the parsed name array

getActionsInInt

public int getActionsInInt()

Returns an int mask value which represents the permission's actions.

For example, for a ServerMapPermission which has replicate and dynamicIndex permissions, the returned value will be 5 (ServerMapPermission.REPLICATE|ServerMapPermission.DYNAMIC_INDEX).

Returns:

an int value which represents the permission.