org.tanukisoftware.wrapper.security

Class WrapperUserEventPermission

java.lang.Object

java.security.Permission

java.security.BasicPermission

org.tanukisoftware.wrapper.security.WrapperUserEventPermission

All Implemented Interfaces:

java.io.Serializable, java.security.Guard

public final class WrapperUserEventPermission
extends java.security.BasicPermission

WrapperUserEventPermissions are used to grant the right to send USER_N events to the Wrapper from user code.

The following are examples of how to specify the permission within a policy file. Specific N codes of the USER_N events can be configured, or optionally all can be allowed.

   grant codeBase "file:../lib/-" {
     // Grant the specific USER_N codes which can be set.
     permission org.tanukisoftware.wrapper.security.WrapperUserEventPermission "100";
     permission org.tanukisoftware.wrapper.security.WrapperUserEventPermission "100, 101, 102";
     permission org.tanukisoftware.wrapper.security.WrapperUserEventPermission "100-120";
     permission org.tanukisoftware.wrapper.security.WrapperUserEventPermission "*";
   };
 

Author:

Tanuki Software Development Team <support@tanukisoftware.com>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WrapperUserEventPermission(java.lang.String codes) Creates a new WrapperUserEventPermission for the specified user event(s).
WrapperUserEventPermission(java.lang.String name, java.lang.String codes) Creates a new WrapperUserEventPermission for the specified user event(s).

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActions() Return the canonical string representation of the registered user-event codes.
boolean	implies(java.security.Permission p2) Checks if this WrapperUserEventPermission object "implies" the specified permission.

Methods inherited from class java.security.BasicPermission

equals, hashCode, newPermissionCollection

Methods inherited from class java.security.Permission

checkGuard, getName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WrapperUserEventPermission

public WrapperUserEventPermission(java.lang.String codes)

Creates a new WrapperUserEventPermission for the specified user event(s).

Parameters:

codes - A comma-separated list of user-event codes or code ranges to be registered.

WrapperUserEventPermission

public WrapperUserEventPermission(java.lang.String name,
                                  java.lang.String codes)

Creates a new WrapperUserEventPermission for the specified user event(s).

Parameters:

name - Name of the permission.

codes - A comma-separated list of user-event codes or code ranges to be registered.

Method Detail

getActions

public java.lang.String getActions()

Return the canonical string representation of the registered user-event codes.

Overrides:

getActions in class java.security.BasicPermission

Returns:

The canonical string representation of the registered user-event codes.

implies

public boolean implies(java.security.Permission p2)

Checks if this WrapperUserEventPermission object "implies" the specified permission.

More specifically, this method returns true if:

• p2 is an instance of WrapperUserEventPermission,
• p2 only has a unique code identifying a user event.

Overrides:

implies in class java.security.BasicPermission

Parameters:

p2 - the permission to check against.

Returns:

True if the specified permission is implied by this object.