Package com.sun.identity.policy
Class PolicyManager
- java.lang.Object
-
- com.sun.identity.policy.PolicyManager
-
@Supported @Deprecated public final class PolicyManager extends Object
Deprecated.As of OpenSSO Express 8.0, usecom.sun.identity.entitlement
instead asEntitlement
has replacedPolicy
.ThePolicyManager
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
Fields Modifier and Type Field Description static String
ORGANIZATION_NAME
Deprecated.The key for the plugins to get the organization name.static String
POLICY_SERVICE_NAME
Deprecated.The service name for Policy component.
-
Constructor Summary
Constructors Constructor Description PolicyManager(SSOToken token)
Deprecated.Constructor forPolicyManager
for the top (or root) organization.PolicyManager(SSOToken token, String name)
Deprecated.Constructor forPolicyManager
for the specified organization, sub organization or a container object.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addPolicy(Policy policy)
Deprecated.Adds a policy to the data store.ConditionTypeManager
getConditionTypeManager()
Deprecated.Gets theConditionTypeManager
object instance associated with thisPolicyManager
object instanceString
getOrganizationName()
Deprecated.Gets the organization name for which the policy manager was initialized with.Policy
getPolicy(String policyName)
Deprecated.Gets the policy object given the name of the policy.Set
getPolicyNames()
Deprecated.Gets a set of names of polices defined in the organization for which the policy manager was instantiated.Set
getPolicyNames(String pattern)
Deprecated.Gets a set of selected policy names matching the pattern in the given organization.ReferralTypeManager
getReferralTypeManager()
Deprecated.ReturnsReferralTypeManager
associated with this policy manager.com.sun.identity.policy.ResourceManager
getResourceManager()
Deprecated.Gets theResourceManager
object instance associated with thisPolicyManager
object instanceSubjectTypeManager
getSubjectTypeManager()
Deprecated.Gets theSubjectTypeManager
object instance associated with thisPolicyManager
object instancevoid
removePolicy(String policyName)
Deprecated.Deletes a policy in the organization with the given name.void
replacePolicy(Policy policy)
Deprecated.Replaces a policy object in the data store with the same policy name
-
-
-
Field Detail
-
POLICY_SERVICE_NAME
@Supported public static final String POLICY_SERVICE_NAME
Deprecated.The service name for Policy component.- See Also:
- Constant Field Values
-
ORGANIZATION_NAME
@Supported public static final String ORGANIZATION_NAME
Deprecated.The key for the plugins to get the organization name.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PolicyManager
@Supported public PolicyManager(SSOToken token) throws SSOException, PolicyException
Deprecated.Constructor forPolicyManager
for the top (or root) organization. It requires aSSOToken
which will be used to perform all data store operations. If the user does not have sufficient privilegesNoPermissionException
will be thrown.- Parameters:
token
-SSOToken
of the user managing policy- Throws:
SSOException
- invalid or expired single-sign-on tokenPolicyException
- for any other abnormal condition
-
PolicyManager
@Supported public PolicyManager(SSOToken token, String name) throws SSOException, NameNotFoundException, PolicyException
Deprecated.Constructor forPolicyManager
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 privilegesNoPermissionException
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 tokenNameNotFoundException
- if the given organization, sub-organization or container name is not presentPolicyException
- for any other abnormal condition
-
-
Method Detail
-
getOrganizationName
@Supported public String getOrganizationName()
Deprecated.Gets the organization name for which the policy manager was initialized with. The organization name could either be slash ("/") separated or could be the distinguished name depending on the manner in which it was initialized.- Returns:
- organization name for which the policy manager was instantiated
-
getPolicyNames
@Supported public Set getPolicyNames() throws SSOException, NoPermissionException, PolicyException
Deprecated.Gets a set of names of polices defined in the organization for which the policy manager was instantiated. If there are no policies defined, this method returns an empty set (not null).- Returns:
Set
of names of policies defined in the organization- Throws:
SSOException
- invalid or expired single-sign-on tokenNoPermissionException
- user does not have sufficient privileges to get policy namesPolicyException
- for any other abnormal condition
-
getPolicyNames
@Supported public Set getPolicyNames(String pattern) throws SSOException, NoPermissionException, PolicyException
Deprecated.Gets a set of selected policy names matching the pattern in the given organization. The pattern accepts "*" as the wild card for searching policy names. For example if the pattern is "co*", it returns policies starting with "co". Similarly, if the pattern is "*net", it returns policies ending with "net". The wildcard can be anywhere in the the string. If there are no policies that match the provided filter, this method returns an empty set (not null).- Parameters:
pattern
- search pattern that will be used to select policy names- Returns:
Set
of policy names that satisfy the pattern- Throws:
SSOException
- invalid or expired single-sign-on tokenNoPermissionException
- user does not have sufficient privileges to get policy namesPolicyException
- for any other abnormal condition
-
getPolicy
@Supported public Policy getPolicy(String policyName) throws SSOException, NoPermissionException, InvalidFormatException, NameNotFoundException, InvalidNameException, PolicyException
Deprecated.Gets the policy object given the name of the policy.- Parameters:
policyName
- name of the policy- Returns:
- policy with the given policy name
- Throws:
SSOException
- if single sign on token associated with the policy manager is not valid.NoPermissionException
- if not enough permissions.InvalidFormatException
- ifpolicyName
has invalid format.NameNotFoundException
- if the policy is not found.InvalidNameException
- ifpolicyName
is invalid.PolicyException
- for any other abnormal condition.
-
addPolicy
@Supported public void addPolicy(Policy policy) throws SSOException, NameAlreadyExistsException, NoPermissionException, InvalidFormatException, PolicyException
Deprecated.Adds a policy to the data store.- Parameters:
policy
- policy object to be added to the organization- Throws:
SSOException
- invalid or expired single-sign-on tokenNoPermissionException
- user does not have sufficient privileges to add policyInvalidFormatException
- the data in the policy object has been corrupted or does not have a valid formatNameAlreadyExistsException
- a policy with the same name already existsPolicyException
- for any other abnormal condition
-
replacePolicy
@Supported public void replacePolicy(Policy policy) throws SSOException, NameNotFoundException, NoPermissionException, InvalidFormatException, PolicyException
Deprecated.Replaces a policy object in the data store with the same policy name- Parameters:
policy
- policy object to be added to the organization- Throws:
SSOException
- invalid or expired single-sign-on tokenNoPermissionException
- user does not have sufficient privileges to replace policyNameNotFoundException
- 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 formatPolicyException
- for any other abnormal condition.
-
removePolicy
@Supported public void removePolicy(String policyName) throws SSOException, NoPermissionException, PolicyException
Deprecated.Deletes a policy in the organization with the given name.- Parameters:
policyName
- name of the policy to be deleted- Throws:
SSOException
- invalid or expired single-sign-on tokenNoPermissionException
- user does not have sufficient privileges to remove policiesPolicyException
- for any other abnormal condition
-
getResourceManager
@Supported public com.sun.identity.policy.ResourceManager getResourceManager()
Deprecated.Gets theResourceManager
object instance associated with thisPolicyManager
object instance- Returns:
ResourceManager
object
-
getSubjectTypeManager
@Supported public SubjectTypeManager getSubjectTypeManager()
Deprecated.Gets theSubjectTypeManager
object instance associated with thisPolicyManager
object instance- Returns:
SubjectTypeManager
object
-
getConditionTypeManager
@Supported public ConditionTypeManager getConditionTypeManager()
Deprecated.Gets theConditionTypeManager
object instance associated with thisPolicyManager
object instance- Returns:
ConditionTypeManager
object
-
getReferralTypeManager
@Supported public ReferralTypeManager getReferralTypeManager()
Deprecated.ReturnsReferralTypeManager
associated with this policy manager.- Returns:
ReferralTypeManager
associated with this policy manager.
-
-