Package com.sun.identity.policy

Class PolicyManager

  • @Deprecated
public final class PolicyManager
extends Object
    Deprecated.
    since 12.0.0
    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.

    • Constructor Detail

      • PolicyManager

        public PolicyManager​(SSOToken token)
              throws SSOException,
                     PolicyException
        Deprecated.
        Constructor for 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.
        Parameters:
        token - SSOToken of the user managing policy
        Throws:
        SSOException - invalid or expired single-sign-on token
        PolicyException - for any other abnormal condition

      • PolicyManager

        public PolicyManager​(SSOToken token,
                     String name)
              throws SSOException,
                     NameNotFoundException,
                     PolicyException
        Deprecated.
        Constructor for 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 policies
        name - 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

      • getOrganizationName

        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

      • getPolicyConfig

        public Map getPolicyConfig()
        Deprecated.
        Gets the policy config attribute values defined for this policy manager
        Returns:
        policy config attributes defined for this policy manager. Also, includes the organization distinguished name.

      • getPolicyNames

        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 token
        NoPermissionException - user does not have sufficient privileges to get policy names
        PolicyException - for any other abnormal condition

      • getPolicyNames

        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 token
        NoPermissionException - user does not have sufficient privileges to get policy names
        PolicyException - for any other abnormal condition

      • getResourceManager

        public ResourceManager getResourceManager()
        Deprecated.
        Gets the ResourceManager object instance associated with this PolicyManager object instance
        Returns:
        ResourceManager object

      • getSubjectTypeManager

        public SubjectTypeManager getSubjectTypeManager()
        Deprecated.
        Gets the SubjectTypeManager object instance associated with this PolicyManager object instance
        Returns:
        SubjectTypeManager object

      • getConditionTypeManager

        public ConditionTypeManager getConditionTypeManager()
        Deprecated.
        Gets the ConditionTypeManager object instance associated with this PolicyManager object instance
        Returns:
        ConditionTypeManager object

      • getResponseProviderTypeManager

        public ResponseProviderTypeManager getResponseProviderTypeManager()
        Deprecated.
        Gets the ResponseProviderTypeManager object instance associated with this PolicyManager object instance
        Returns:
        ResponseProviderTypeManager object

      • getReferralTypeManager

        public ReferralTypeManager getReferralTypeManager()
        Deprecated.
        Returns ReferralTypeManager associated with this policy manager.
        Returns:
        ReferralTypeManager associated with this policy manager.

      • getPoliciesUsingRealmSubject

        public Set getPoliciesUsingRealmSubject​(String subjectName)
                                 throws PolicyException,
                                        SSOException
        Deprecated.
        Gets the set of policies that use the realm subject
        Parameters:
        subjectName - name of the realm subject to check for
        Returns:
        a Set of Policy objects that use the realm subject
        Throws:
        PolicyException
        SSOException

      • canCreateNewResource

        public boolean canCreateNewResource​(String svcTypeName)
        Deprecated.

      • initAdminSubject

        public static void initAdminSubject()
        Deprecated.
        To initialise the adminSubject if it was null. This must be non-null for the migratedToEntitlementService to have been calculated correctly