|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.policy.PolicyManager
public final class PolicyManager
The PolicyManager
class manages policies
for a specific organization, sub organization or a container.
This class is the
starting point for policy management, and provides methods to
create/modify/delete policies.
It is a final class
and hence cannot be further extended. The methods in this class
works directly with the backend datastore (usually a
directory server) to store and manage policies. Hence, user
of this class must have valid SSOToken
and privileges to the backend datastore.
Field Summary | |
---|---|
static String |
ORGANIZATION_NAME
The key for the plugins to get the organization name. |
static String |
POLICY_SERVICE_NAME
The service name for Policy component. |
Constructor Summary | |
---|---|
PolicyManager(SSOToken token)
Constructor for PolicyManager for the
top (or root) organization. |
|
PolicyManager(SSOToken token,
String name)
Constructor for PolicyManager for the
specified organization, sub organization or a container object. |
Method Summary | |
---|---|
void |
addPolicy(Policy policy)
Adds a policy to the data store. |
ConditionTypeManager |
getConditionTypeManager()
Gets the ConditionTypeManager object instance associated
with this PolicyManager object instance |
String |
getOrganizationName()
Gets the organization name for which the policy manager was initialized with. |
Policy |
getPolicy(String policyName)
Gets the policy object given the name of the policy. |
Set |
getPolicyNames()
Gets a set of names of polices defined in the organization for which the policy manager was instantiated. |
Set |
getPolicyNames(String pattern)
Gets a set of selected policy names matching the pattern in the given organization. |
ReferralTypeManager |
getReferralTypeManager()
Returns ReferralTypeManager associated with this
policy manager. |
ResourceManager |
getResourceManager()
Gets the ResourceManager object instance associated
with this PolicyManager object instance |
SubjectTypeManager |
getSubjectTypeManager()
Gets the SubjectTypeManager object instance associated
with this PolicyManager object instance |
void |
removePolicy(String policyName)
Deletes a policy in the organization with the given name. |
void |
replacePolicy(Policy policy)
Replaces a policy object in the data store with the same policy name |
Field Detail |
---|
public static final String POLICY_SERVICE_NAME
public static final String ORGANIZATION_NAME
Constructor Detail |
---|
public PolicyManager(SSOToken token) throws SSOException, PolicyException
PolicyManager
for the
top (or root) organization. It requires a SSOToken
which will be used to perform all data store
operations. If the user does not have sufficient
privileges NoPermissionException
will be thrown.
token
- SSOToken
of the user managing policy
SSOException
- invalid or expired single-sign-on token
PolicyException
- for any other abnormal conditionpublic PolicyManager(SSOToken token, String name) throws SSOException, NameNotFoundException, PolicyException
PolicyManager
for the
specified organization, sub organization or a container object.
The names of the organization, sub organization or the
container object could be either "/" separated (as per SMS)
or could be the complete DN of the object.
For example: /isp/coke, /isp/pepsi/tacobell,
etc., or "ou=tacobell, o=pepsi, o=isp",
"o=coke, o=isp"
, etc.
The constructor also requires a single sign on token.
which will be used to perform all data store
operations. If the user does not have sufficient
privileges NoPermissionException
will be thrown.
- Parameters:
token
- single-sign-on token of the user managing policiesname
- name of the organization, sub organization
or container for which to manage policies.
The name could be either slash (/) separated
or the complete DN.
- Throws:
SSOException
- invalid or expired single-sign-on token
NameNotFoundException
- if the given organization,
sub-organization or container name is not present
PolicyException
- for any other abnormal condition
Method Detail |
---|
public String getOrganizationName()
public Set getPolicyNames() throws SSOException, NoPermissionException, PolicyException
Set
of names of policies defined in the organization
SSOException
- invalid or expired single-sign-on token
NoPermissionException
- user does not have sufficient
privileges to get policy names
PolicyException
- for any other abnormal conditionpublic Set getPolicyNames(String pattern) throws SSOException, NoPermissionException, PolicyException
pattern
- search pattern that will be used to select policy names
Set
of policy names that satisfy the pattern
SSOException
- invalid or expired single-sign-on token
NoPermissionException
- user does not have sufficient
privileges to get policy names
PolicyException
- for any other abnormal conditionpublic Policy getPolicy(String policyName) throws SSOException, NoPermissionException, InvalidFormatException, NameNotFoundException, InvalidNameException, PolicyException
policyName
- name of the policy
SSOException
- if single sign on token associated with the policy
manager is not valid.
NoPermissionException
- if not enough permissions.
InvalidFormatException
- if policyName
has
invalid format.
NameNotFoundException
- if the policy is not found.
InvalidNameException
- if policyName
is invalid.
PolicyException
- for any other abnormal condition.public void addPolicy(Policy policy) throws SSOException, NameAlreadyExistsException, NoPermissionException, InvalidFormatException, PolicyException
policy
- policy object to be added to the organization
SSOException
- invalid or expired single-sign-on token
NoPermissionException
- user does not have sufficient
privileges to add policy
InvalidFormatException
- the data in the policy object
has been corrupted or does not have a valid format
NameAlreadyExistsException
- a policy with the same
name already exists
PolicyException
- for any other abnormal conditionpublic void replacePolicy(Policy policy) throws SSOException, NameNotFoundException, NoPermissionException, InvalidFormatException, PolicyException
policy
- policy object to be added to the organization
SSOException
- invalid or expired single-sign-on token
NoPermissionException
- user does not have sufficient
privileges to replace policy
NameNotFoundException
- policy with the same name does
not exist.
InvalidFormatException
- the provide policy from the
data store has been corrupted or does not have a valid format
PolicyException
- for any other abnormal condition.public void removePolicy(String policyName) throws SSOException, NoPermissionException, PolicyException
policyName
- name of the policy to be deleted
SSOException
- invalid or expired single-sign-on token
NoPermissionException
- user does not have sufficient
privileges to remove policies
PolicyException
- for any other abnormal conditionpublic ResourceManager getResourceManager()
ResourceManager
object instance associated
with this PolicyManager
object instance
ResourceManager
objectpublic SubjectTypeManager getSubjectTypeManager()
SubjectTypeManager
object instance associated
with this PolicyManager
object instance
SubjectTypeManager
objectpublic ConditionTypeManager getConditionTypeManager()
ConditionTypeManager
object instance associated
with this PolicyManager
object instance
ConditionTypeManager
objectpublic ReferralTypeManager getReferralTypeManager()
ReferralTypeManager
associated with this
policy manager.
ReferralTypeManager
associated with this
policy manager.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |