Stay organized with collections
Save and categorize content based on your preferences.
PolicySpi
abstract class 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
| Protected methods |
| open PermissionCollection! |
Return a PermissionCollection object containing the set of permissions granted to the specified CodeSource.
|
| open PermissionCollection! |
Return a PermissionCollection object containing the set of permissions granted to the specified ProtectionDomain.
|
| abstract Boolean |
Check whether the policy has granted a Permission to a ProtectionDomain.
|
| open Unit |
Refreshes/reloads the policy configuration.
|
Public constructors
Protected methods
engineGetPermissions
protected open fun engineGetPermissions(codesource: CodeSource!): PermissionCollection!
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. |
| Return |
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. |
engineGetPermissions
protected open fun engineGetPermissions(domain: ProtectionDomain!): PermissionCollection!
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. |
| Return |
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. |
engineImplies
protected abstract fun engineImplies(
domain: ProtectionDomain!,
permission: Permission!
): Boolean
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. |
| Return |
Boolean |
boolean true if the permission is granted to the domain. |
engineRefresh
protected open fun engineRefresh(): Unit
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.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# PolicySpi\n\nAdded in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nPolicySpi\n=========\n\n```\nabstract class PolicySpi\n```\n\n|---|------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [java.security.PolicySpi](#) |\n\nThis 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.\n\nSubclass 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.\n\nSummary\n-------\n\n| Public constructors ||\n|--------------------------------------|---|\n| [PolicySpi](#PolicySpi())`()` \u003cbr /\u003e |\n\n| Protected methods ||\n|---------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| open [PermissionCollection](/reference/kotlin/java/security/PermissionCollection)! | [engineGetPermissions](#engineGetPermissions(java.security.CodeSource))`(`codesource:` `[CodeSource](/reference/kotlin/java/security/CodeSource)!`)` Return a PermissionCollection object containing the set of permissions granted to the specified CodeSource. |\n| open [PermissionCollection](/reference/kotlin/java/security/PermissionCollection)! | [engineGetPermissions](#engineGetPermissions(java.security.ProtectionDomain))`(`domain:` `[ProtectionDomain](/reference/kotlin/java/security/ProtectionDomain)!`)` Return a PermissionCollection object containing the set of permissions granted to the specified ProtectionDomain. |\n| abstract [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [engineImplies](#engineImplies(java.security.ProtectionDomain,%20java.security.Permission))`(`domain:` `[ProtectionDomain](/reference/kotlin/java/security/ProtectionDomain)!`, `permission:` `[Permission](/reference/kotlin/java/security/Permission)!`)` Check whether the policy has granted a Permission to a ProtectionDomain. |\n| open [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [engineRefresh](#engineRefresh())`()` Refreshes/reloads the policy configuration. |\n\nPublic constructors\n-------------------\n\n### PolicySpi\n\nAdded in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nPolicySpi()\n```\n\nProtected methods\n-----------------\n\n### engineGetPermissions\n\nAdded in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nprotected open fun engineGetPermissions(codesource: CodeSource!): PermissionCollection!\n```\n\nReturn a PermissionCollection object containing the set of permissions granted to the specified CodeSource.\n\nThe 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.\n\n| Parameters ||\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `codesource` | [CodeSource](/reference/kotlin/java/security/CodeSource)!: the CodeSource to which the returned PermissionCollection has been granted. |\n\n| Return ||\n|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [PermissionCollection](/reference/kotlin/java/security/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. |\n\n### engineGetPermissions\n\nAdded in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nprotected open fun engineGetPermissions(domain: ProtectionDomain!): PermissionCollection!\n```\n\nReturn a PermissionCollection object containing the set of permissions granted to the specified ProtectionDomain.\n\nThe 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.\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `domain` | [ProtectionDomain](/reference/kotlin/java/security/ProtectionDomain)!: the ProtectionDomain to which the returned PermissionCollection has been granted. |\n\n| Return ||\n|-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [PermissionCollection](/reference/kotlin/java/security/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. |\n\n### engineImplies\n\nAdded in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nprotected abstract fun engineImplies(\n domain: ProtectionDomain!, \n permission: Permission!\n): Boolean\n```\n\nCheck whether the policy has granted a Permission to a ProtectionDomain.\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------|\n| `domain` | [ProtectionDomain](/reference/kotlin/java/security/ProtectionDomain)!: the ProtectionDomain to check. |\n| `permission` | [Permission](/reference/kotlin/java/security/Permission)!: check whether this permission is granted to the specified domain. |\n\n| Return ||\n|------------------------------------------------------------------------------------|----------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | boolean true if the permission is granted to the domain. |\n\n### engineRefresh\n\nAdded in [API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nprotected open fun engineRefresh(): Unit\n```\n\nRefreshes/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.\n\nThe default implementation of this method does nothing. This method should be overridden if a refresh operation is supported by the policy implementation."]]
