Skip to content

Most visited

Recently visited

navigation
Added in API level 9

PolicySpi

public abstract class PolicySpi
extends Object

java.lang.Object
   ↳ java.security.PolicySpi


This class defines the Service Provider Interface (SPI) for the Policy class. All the abstract methods in this class must be implemented by each service provider who wishes to supply a Policy implementation.

Subclass implementations of this abstract class must provide a public constructor that takes a Policy.Parameters object as an input parameter. This constructor also must throw an IllegalArgumentException if it does not understand the Policy.Parameters input.

Summary

Public constructors

PolicySpi()

Protected methods

PermissionCollection engineGetPermissions(ProtectionDomain domain)

Return a PermissionCollection object containing the set of permissions granted to the specified ProtectionDomain.

PermissionCollection engineGetPermissions(CodeSource codesource)

Return a PermissionCollection object containing the set of permissions granted to the specified CodeSource.

abstract boolean engineImplies(ProtectionDomain domain, Permission permission)

Check whether the policy has granted a Permission to a ProtectionDomain.

void engineRefresh()

Refreshes/reloads the policy configuration.

Inherited methods

From class java.lang.Object

Public constructors

PolicySpi

Added in API level 9
PolicySpi ()

Protected methods

engineGetPermissions

Added in API level 9
PermissionCollection engineGetPermissions (ProtectionDomain domain)

Return a PermissionCollection object containing the set of permissions granted to the specified ProtectionDomain.

The default implementation of this method returns Policy.UNSUPPORTED_EMPTY_COLLECTION object. This method can be overridden if the policy implementation can return a set of permissions granted to a ProtectionDomain.

Parameters
domain ProtectionDomain: the ProtectionDomain to which the returned PermissionCollection has been granted.
Returns
PermissionCollection a set of permissions granted to the specified ProtectionDomain. If this operation is supported, the returned set of permissions must be a new mutable instance and it must support heterogeneous Permission types. If this operation is not supported, Policy.UNSUPPORTED_EMPTY_COLLECTION is returned.

engineGetPermissions

Added in API level 9
PermissionCollection engineGetPermissions (CodeSource codesource)

Return a PermissionCollection object containing the set of permissions granted to the specified CodeSource.

The default implementation of this method returns Policy.UNSUPPORTED_EMPTY_COLLECTION object. This method can be overridden if the policy implementation can return a set of permissions granted to a CodeSource.

Parameters
codesource CodeSource: the CodeSource to which the returned PermissionCollection has been granted.
Returns
PermissionCollection a set of permissions granted to the specified CodeSource. If this operation is supported, the returned set of permissions must be a new mutable instance and it must support heterogeneous Permission types. If this operation is not supported, Policy.UNSUPPORTED_EMPTY_COLLECTION is returned.

engineImplies

Added in API level 9
boolean engineImplies (ProtectionDomain domain, 
                Permission permission)

Check whether the policy has granted a Permission to a ProtectionDomain.

Parameters
domain ProtectionDomain: the ProtectionDomain to check.
permission Permission: check whether this permission is granted to the specified domain.
Returns
boolean boolean true if the permission is granted to the domain.

engineRefresh

Added in API level 9
void engineRefresh ()

Refreshes/reloads the policy configuration. The behavior of this method depends on the implementation. For example, calling refresh on a file-based policy will cause the file to be re-read.

The default implementation of this method does nothing. This method should be overridden if a refresh operation is supported by the policy implementation.

This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.