PolicySpi
abstract class PolicySpi
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
| Protected methods | |
|---|---|
| open PermissionCollection! |
engineGetPermissions(codesource: CodeSource!)Return a PermissionCollection object containing the set of permissions granted to the specified CodeSource. |
| open PermissionCollection! |
engineGetPermissions(domain: ProtectionDomain!)Return a PermissionCollection object containing the set of permissions granted to the specified ProtectionDomain. |
| abstract Boolean |
engineImplies(domain: ProtectionDomain!, permission: Permission!)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.