to top
Android APIs
public abstract class

PolicySpi

extends Object
java.lang.Object
   ↳ java.security.PolicySpi

Class Overview

Represents the Service Provider Interface (SPI) for java.security.Policy class.

If there is any class that wants to provide a Policy implementation, all abstract methods in this SPI should be implemented.

The detailed implementations should offer a public constructor, in which a Policy.Paramters implementation acts as an input parameter.If the Policy.Paramters input cannot by understood by the constructor, an IllegalArgumentException will be thrown.

Summary

Public Constructors
PolicySpi()
Protected Methods
PermissionCollection engineGetPermissions(CodeSource codesource)
Answers a PermissionCollection object containing the set of permissions granted to the specified CodeSource.
PermissionCollection engineGetPermissions(ProtectionDomain domain)
Answers a PermissionCollection object containing the set of permissions granted to the specified ProtectionDomain.
abstract boolean engineImplies(ProtectionDomain domain, Permission permission)
Answers if the policy has granted a Permission to a ProtectionDomain.
void engineRefresh()
Refreshes/reloads the policy configuration.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PolicySpi ()

Since: API Level 9

Protected Methods

protected PermissionCollection engineGetPermissions (CodeSource codesource)

Since: API Level 9

Answers 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 - the CodeSource to which the returned PermissionCollection has been granted.
Returns
  • 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.

protected PermissionCollection engineGetPermissions (ProtectionDomain domain)

Since: API Level 9

Answers 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 - the ProtectionDomain to which the returned PermissionCollection has been granted.
Returns
  • 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.

protected abstract boolean engineImplies (ProtectionDomain domain, Permission permission)

Since: API Level 9

Answers if the policy has granted a Permission to a ProtectionDomain.

Parameters
domain - the domain to check.
permission - check whether this permission is granted to the specified domain.
Returns
  • - true if the permission is granted to the domain.

protected void engineRefresh ()

Since: API Level 9

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.