public interface PolicyStoreMBean extends PropertiesListerMBean
Provides a set of methods for managing policies in a policy store. An Authorization-provider or Role Mapping-provider MBean can optionally implement this MBean interface. Policies are expressed as XACML 2.0 Policy or PolicySet documents.
Authorization-providers should expect standard Policy
or PolicySet
documents
as described in the XACML 2.0 Core Specification.
Role Mapping-providers should expect Policy
or PolicySet
documents consistent
with role assignment policies described by the Role Based Access Control
Profile, specifically the Target
must contain:
Modifier and Type | Field and Description |
---|---|
static String |
ACTIVE
Indicates active for evaluation status.
|
static String |
BYREFERENCE
Indicates active for evaluation when referenced by active policy set status.
|
static String |
DOCUMENT
Properties key for Policy or PolicySet document.
|
static String |
ID
Properties key for Policy or PolicySet document identifier as java.lang.String.
|
static String |
INACTIVE
Indicates inactive for evaluation status.
|
static String |
STATUS
Properties key for evaluation status as java.lang.String.
|
static String |
VERSION
Properties key for Policy or PolicySet document version as java.lang.String.
|
Modifier and Type | Method and Description |
---|---|
void |
addPolicy(Policy policy)
Adds policy.
|
void |
addPolicy(Policy policy,
String status)
Adds policy
|
void |
addPolicy(String policy)
Adds policy.
|
void |
addPolicy(String policy,
String status)
Adds policy
|
void |
addPolicySet(PolicySet set)
Adds policy set.
|
void |
addPolicySet(PolicySet set,
String status)
Adds policy set.
|
void |
addPolicySet(String set)
Adds policy set.
|
void |
addPolicySet(String set,
String status)
Adds policy set.
|
void |
deletePolicy(String identifier,
String version)
Deletes policy with given identifier and version.
|
void |
deletePolicySet(String identifier,
String version)
Deletes policy set with given identifier and version.
|
String |
getPolicySetStatus(String identifier,
String version)
Returns status for policy set identified by identifier and version
|
String |
getPolicyStatus(String identifier,
String version)
Returns status for policy identified by identifier and version
|
String |
listAllPolicies()
Returns cursor listing all policies
|
String |
listAllPoliciesAsString()
Returns cursor listing all policies.
|
String |
listAllPolicySets()
Returns cursor listing all policy sets
|
String |
listAllPolicySetsAsString()
Returns cursor listing all policy sets.
|
void |
modifyPolicy(Policy policy)
Updates policy.
|
void |
modifyPolicy(Policy policy,
String status)
Updates policy and status.
|
void |
modifyPolicy(String policy)
Updates policy.
|
void |
modifyPolicy(String policy,
String status)
Updates policy and status.
|
void |
modifyPolicySet(PolicySet set)
Updates policy set.
|
void |
modifyPolicySet(PolicySet set,
String status)
Updates policy set and status.
|
void |
modifyPolicySet(String set)
Updates policy set.
|
void |
modifyPolicySet(String set,
String status)
Updates policy set and status.
|
void |
modifyPolicySetStatus(String identifier,
String version,
String status)
Sets status for policy set identified by identifier and version
|
void |
modifyPolicyStatus(String identifier,
String version,
String status)
Sets status for policy identified by identifier and version
|
Policy |
readPolicy(String identifier,
String version)
Reads policy with specified identifier and version
|
String |
readPolicyAsString(String identifier,
String version)
Reads policy with specified identifier and version
|
PolicySet |
readPolicySet(String identifier,
String version)
Reads policy set with specified identifier and version
|
String |
readPolicySetAsString(String identifier,
String version)
Reads policy set with specified identifier and version
|
getCurrentProperties
advance, close, haveCurrent
getName
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
static final String ACTIVE
static final String BYREFERENCE
static final String INACTIVE
static final String DOCUMENT
static final String ID
static final String VERSION
static final String STATUS
String listAllPolicies() throws NotFoundException
NotFoundException
- Thrown if no policies are foundString listAllPoliciesAsString() throws NotFoundException
NotFoundException
- Thrown if no policies are foundString listAllPolicySets() throws NotFoundException
NotFoundException
- Thrown if no policy sets are foundString listAllPolicySetsAsString() throws NotFoundException
NotFoundException
- Thrown if no policy sets are foundPolicy readPolicy(String identifier, String version) throws NotFoundException
identifier
- Policy identifierversion
- Policy versionNotFoundException
- Thrown if matching policy is not foundString readPolicyAsString(String identifier, String version) throws NotFoundException
identifier
- Policy identifierversion
- Policy versionNotFoundException
- Thrown if matching policy is not foundPolicySet readPolicySet(String identifier, String version) throws NotFoundException
identifier
- Policy set identifierversion
- Policy set versionNotFoundException
- Thrown if matching policy set is not foundString readPolicySetAsString(String identifier, String version) throws NotFoundException
identifier
- Policy set identifierversion
- Policy set versionNotFoundException
- Thrown if matching policy set is not foundvoid addPolicy(Policy policy) throws CreateException, AlreadyExistsException
policy
- Policy documentCreateException
- Thrown if policy is invalid or store cannot be updatedAlreadyExistsException
- Thrown if matching policy id and version already present in storevoid addPolicy(String policy) throws CreateException, AlreadyExistsException
policy
- Policy documentCreateException
- Thrown if policy is invalid or store cannot be updatedAlreadyExistsException
- Thrown if matching policy id and version already present in storevoid addPolicy(Policy policy, String status) throws CreateException, AlreadyExistsException
policy
- Policy documentstatus
- Policy statusCreateException
- Thrown if policy is invalid or store cannot be updatedAlreadyExistsException
- Thrown if matching policy id and version already present in storevoid addPolicy(String policy, String status) throws CreateException, AlreadyExistsException
policy
- Policy documentstatus
- Policy statusCreateException
- Thrown if policy is invalid or store cannot be updatedAlreadyExistsException
- Thrown if matching policy id and version already present in storevoid addPolicySet(PolicySet set) throws CreateException, AlreadyExistsException
set
- Policy set documentCreateException
- Thrown if policy set is invalid or store cannot be updatedAlreadyExistsException
- Thrown if matching policy set id and version already present in storevoid addPolicySet(String set) throws CreateException, AlreadyExistsException
set
- Policy set documentCreateException
- Thrown if policy set is invalid or store cannot be updatedAlreadyExistsException
- Thrown if matching policy set id and version already present in storevoid addPolicySet(PolicySet set, String status) throws CreateException, AlreadyExistsException
set
- Policy set documentstatus
- Policy status enumerationCreateException
- Thrown if policy set is invalid or store cannot be updatedAlreadyExistsException
- Thrown if matching policy set id and version already present in storevoid addPolicySet(String set, String status) throws CreateException, AlreadyExistsException
set
- Policy set documentstatus
- Policy status enumerationCreateException
- Thrown if policy set is invalid or store cannot be updatedAlreadyExistsException
- Thrown if matching policy set id and version already present in storevoid modifyPolicy(Policy policy) throws CreateException, NotFoundException
policy
- Policy documentCreateException
- Thrown if policy is invalid or store cannot be updatedNotFoundException
- Thrown if matching policy id and version not present in storevoid modifyPolicy(String policy) throws CreateException, NotFoundException
policy
- Policy documentCreateException
- Thrown if policy is invalid or store cannot be updatedNotFoundException
- Thrown if matching policy id and version not present in storevoid modifyPolicy(Policy policy, String status) throws CreateException, NotFoundException
policy
- Policy documentstatus
- Policy status enumerationCreateException
- Thrown if policy is invalid or store cannot be updatedNotFoundException
- Thrown if matching policy id and version not present in storevoid modifyPolicy(String policy, String status) throws CreateException, NotFoundException
policy
- Policy documentstatus
- Policy status enumerationCreateException
- Thrown if policy is invalid or store cannot be updatedNotFoundException
- Thrown if matching policy id and version not present in storevoid modifyPolicySet(PolicySet set) throws CreateException, NotFoundException
set
- Policy set documentCreateException
- Thrown if policy set is invalid or store cannot be updatedNotFoundException
- Thrown if matching policy set id and version not present in storevoid modifyPolicySet(String set) throws CreateException, NotFoundException
set
- Policy set documentCreateException
- Thrown if policy set is invalid or store cannot be updatedNotFoundException
- Thrown if matching policy set id and version not present in storevoid modifyPolicySet(PolicySet set, String status) throws CreateException, NotFoundException
set
- Policy set documentstatus
- Policy status enumerationCreateException
- Thrown if policy set is invalid or store cannot be updatedNotFoundException
- Thrown if matching policy set id and version not present in storevoid modifyPolicySet(String set, String status) throws CreateException, NotFoundException
set
- Policy set documentstatus
- Policy status enumerationCreateException
- Thrown if policy set is invalid or store cannot be updatedNotFoundException
- Thrown if matching policy set id and version not present in storevoid modifyPolicyStatus(String identifier, String version, String status) throws CreateException, NotFoundException
identifier
- Policy identifierversion
- Policy versionstatus
- Policy status enumerationCreateException
- Thrown if store cannot be updatedNotFoundException
- Thrown if matching policy id and version not present in storeString getPolicyStatus(String identifier, String version) throws NotFoundException
identifier
- Policy identifierversion
- Policy versionNotFoundExeption
- Thrown if matching policy id and version not present in storeNotFoundException
void modifyPolicySetStatus(String identifier, String version, String status) throws CreateException, NotFoundException
identifier
- Policy set identifierversion
- Policy set versionstatus
- Policy status enumerationCreateException
- Thrown if store cannot be updatedNotFoundException
- Thrown if matching policy set id and version not present in storeString getPolicySetStatus(String identifier, String version) throws NotFoundException
identifier
- Policy set identifierversion
- Policy set versionNotFoundExeption
- Thrown if matching policy set id and version not present in storeNotFoundException
void deletePolicy(String identifier, String version) throws NotFoundException, RemoveException
identifier
- Policy identifierversion
- Policy versionNotFoundException
- Thrown if matching policy id and version not present in storeRemoveException
- Thrown if store cannot be updatedvoid deletePolicySet(String identifier, String version) throws NotFoundException, RemoveException
identifier
- Policy set identifierversion
- Policy set versionNotFoundException
- Thrown if matching policy set id and version not present in storeRemoveException
- Thrown if store cannot be updated