org.tanukisoftware.wrapper.security

Class WrapperEventPermission

java.lang.Object

java.security.Permission

org.tanukisoftware.wrapper.security.WrapperEventPermission

All Implemented Interfaces:

java.io.Serializable, java.security.Guard

public class WrapperEventPermission
extends java.security.Permission

WrapperEventPermissions are used to grant the right to register to start receiving events from the Wrapper.

Some of these permissions can result in performance degredations if used impropperly.

The following are examples of how to specify the permission within a policy file.

   grant codeBase "file:../lib/-" {
     // Grant various permissions to a specific service.
     permission org.tanukisoftware.wrapper.security.WrapperEventPermission "service";
     permission org.tanukisoftware.wrapper.security.WrapperEventPermission "service, core";
     permission org.tanukisoftware.wrapper.security.WrapperEventPermission "*";
   };
 

Possible eventTypes include the following:

Permission Event Type Name	What the Permission Allows	Risks of Allowing this Permission
service	Register to obtain events whenever the Wrapper service receives any service events.	Malicious code could receive this event and never return and thus cause performance and timeout problems with the Wrapper. Normal use of these events are quite safe however.
control	Register to obtain events whenever the Wrapper receives any system control signals.	Malicious code could trap and consome control events, thus preventing an application from being shut down cleanly.
core	Register to obtain events on the core workings of the Wrapper.	Malicious code or even well meaning code can greatly affect the performance of the Wrapper simply by handling these methods slowly. Some of these events are fired from within the core timing code of the Wrapper. They are useful for testing and performance checks, but in general they should not be used by most applications.

Author:

Tanuki Software Development Team <support@tanukisoftware.com>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENT_TYPE_CONTROL
static java.lang.String	EVENT_TYPE_CORE
static java.lang.String	EVENT_TYPE_REMOTE_CONTROL
static java.lang.String	EVENT_TYPE_SERVICE

Constructor Summary

Constructors

Constructor and Description
WrapperEventPermission(java.lang.String eventTypes) Creates a new WrapperEventPermission for the specified service.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Checks two Permission objects for equality.
java.lang.String	getActions() Return the canonical string representation of the eventTypes.
int	hashCode() Returns the hash code value for this object.
boolean	implies(java.security.Permission p2) Checks if this WrapperEventPermission object "implies" the specified permission.
java.security.PermissionCollection	newPermissionCollection() Returns an custom WECollection implementation of a PermissionCollection.

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

Field Detail

EVENT_TYPE_SERVICE

public static java.lang.String EVENT_TYPE_SERVICE

EVENT_TYPE_CONTROL

public static java.lang.String EVENT_TYPE_CONTROL

EVENT_TYPE_REMOTE_CONTROL

public static java.lang.String EVENT_TYPE_REMOTE_CONTROL

EVENT_TYPE_CORE

public static java.lang.String EVENT_TYPE_CORE

Constructor Detail

WrapperEventPermission

public WrapperEventPermission(java.lang.String eventTypes)

Creates a new WrapperEventPermission for the specified service.

Parameters:

eventTypes - The event type or event types to be registered.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Checks two Permission objects for equality.

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

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.

getActions

public java.lang.String getActions()

Return the canonical string representation of the eventTypes. Always returns present eventTypes in the following order: start, stop, pause, continue, interrogate. userCode.

Specified by:

getActions in class java.security.Permission

Returns:

The canonical string representation of the eventTypes.

implies

public boolean implies(java.security.Permission p2)

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

More specifically, this method returns true if:

• p2 is an instanceof FilePermission,
• p2's eventTypes are a proper subset of this object's eventTypes, and
• p2's service name is implied by this object's service name. For example, "MyApp*" implies "MyApp".

Specified by:

implies in class java.security.Permission

Parameters:

p2 - the permission to check against.

Returns:

true if the specified permission is implied by this object,

newPermissionCollection

public java.security.PermissionCollection newPermissionCollection()

Returns an custom WECollection implementation of a PermissionCollection.

Overrides:

newPermissionCollection in class java.security.Permission

hashCode

public int hashCode()

Returns the hash code value for this object.

Specified by:

hashCode in class java.security.Permission

Returns:

A hash code value for this object.