GigaSpaces XAP 8.0 API

Class DebugDynamicPolicyProvider

  extended by
      extended by
          extended by com.sun.jini.tool.DebugDynamicPolicyProvider
All Implemented Interfaces:

public class DebugDynamicPolicyProvider
extends DynamicPolicyProvider

Defines a DynamicPolicy that logs information about missing permissions, and optionally grants all permissions, which is FOR DEBUGGING ONLY. Do not use this security policy provider to grant all permissions in a production environment.

This class is intended to simplify the process of deciding what security permissions to grant to run an application. While it is generally acceptable to grant all permissions to local, trusted code, downloaded code should typically be granted the least permission possible.

The usual approach to choosing which permissions to grant is to start by running the application with a security policy file that grants all permissions to local, trusted code. When the application fails with an exception message that identifies a missing permission, add that permission to the security policy file, and repeat the process. Although straight forward, this process can be time consuming if the application requires many permission grants.

Another approach is to set the value of the "" system property to "access,failure", which produces debugging output that describes permission grants and failures. Unfortunately, this approach produces voluminous output, making it difficult to determine which permission grants are needed.

This security policy provider permits another, hopefully more convenient, approach. When this class is specified as the security policy provider, and granting all permissions is enabled, it uses the standard dynamic security policy to determine what permissions are granted. If a permission is not granted by the standard policy, though, then rather than denying permission, this class logs the missing permission in the form required by the security policy file, and grants the permission, allowing the program to continue. In this way, developers can determine the complete set of security permissions required by the application.

Note that the information printed by this security policy provider may not be in the form you wish to use in your policy file. In particular, using system property substitutions and KeyStore aliases may produce a more portable file than one containing the exact entries logged. Note, too, that the information printed for signedBy fields specifies the principal name for X.509 certificates, rather than the KeyStore alias, which is not a valid security policy file format.

Using this security policy provider without granting all permissions is also useful since it prints information about security exceptions that were caught, but that might have an affect on program behavior.

This class uses uses the Logger named to log information at the following levels:

To use this security policy provider, do the following:

Granting all permissions is disabled by default.

Make sure to specify a security manager, either by setting the system property, or putting the following code in the main method of the application:

 if (System.getSecurityManager() == null) {
     System.setSecurityManager(new SecurityManager());

This provider can be used in conjunction with the provider com.sun.jini.start.AggregatePolicyProvider by setting the com.sun.jini.start.AggregatePolicyProvider.mainPolicyClass system property to the fully qualified name of this class. If this provider is used with the AggregatePolicyProvider, then the JAR file jsk-debug-policy.jar needs to be in the application's class path, and this class needs to be granted all permissions.

Sun Microsystems, Inc.

Nested Class Summary
Nested classes/interfaces inherited from class
Field Summary
Fields inherited from class
Constructor Summary
          Creates an instance of this class that wraps a default underlying policy, as specified by DynamicPolicyProvider().
DebugDynamicPolicyProvider(Policy basePolicy)
          Creates an instance of this class that wraps around the given non-null base policy object.
Method Summary
 void grant(Class cl, Principal[] principals, Permission[] permissions)
          Log calls.
 boolean implies(ProtectionDomain pd, Permission perm)
          Always returns true, but logs unique requests
Methods inherited from class
getGrants, getPermissions, getPermissions, grantSupported, refresh
Methods inherited from class
getInstance, getInstance, getInstance, getParameters, getPolicy, getProvider, getType, setPolicy
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public DebugDynamicPolicyProvider()
                           throws PolicyInitializationException
Creates an instance of this class that wraps a default underlying policy, as specified by DynamicPolicyProvider().

PolicyInitializationException - if unable to construct the base policy
SecurityException - if there is a security manager and the calling context does not have adequate permissions to read the security property, or if the calling context does not have adequate permissions to access the base policy class


public DebugDynamicPolicyProvider(Policy basePolicy)
Creates an instance of this class that wraps around the given non-null base policy object.

basePolicy - base policy object containing information about non-dynamic grants
NullPointerException - if basePolicy is null
Method Detail


public void grant(Class cl,
                  Principal[] principals,
                  Permission[] permissions)
Log calls.

Specified by:
grant in interface DynamicPolicy
grant in class DynamicPolicyProvider
cl - class to grant permissions to the class loader of, or null if granting across all class loaders
principals - if non-null, minimum set of principals to which grants apply
permissions - if non-null, permissions to grant


public boolean implies(ProtectionDomain pd,
                       Permission perm)
Always returns true, but logs unique requests

implies in class DynamicPolicyProvider

GigaSpaces XAP 8.0 API

Copyright © GigaSpaces.