Package com.sun.identity.entitlement

Interface EntitlementConfiguration

  • All Known Implementing Classes:
    EntitlementService
    public interface EntitlementConfiguration
    Entitlement Configuration

    • Method Detail

      • getApplication

        Application getApplication​(String name)
        Returns the application with the specified name.
        Returns:
        The application or null if the application could not be found.

      • getApplications

        Set<Application> getApplications()
        Returns a set of registered applications.
        Returns:
        a set of registered applications.

      • getApplicationTypes

        Set<ApplicationType> getApplicationTypes()
        Returns a set of registered application type.
        Returns:
        A set of registered application type.

      • removeApplicationType

        void removeApplicationType​(String name)
                    throws EntitlementException
        Removes application type.
        Parameters:
        name - name of application type to be removed.
        Throws:
        EntitlementException - if application type cannot be removed.

      • storeApplicationType

        void storeApplicationType​(ApplicationType applicationType)
                   throws EntitlementException
        Stores the application type to data store.
        Parameters:
        applicationType - Application type object.
        Throws:
        EntitlementException - if application type cannot be stored.

      • getConfiguration

        Set<String> getConfiguration​(String attributeName)
        Returns set of attribute values of a given attribute name,
        Parameters:
        attributeName - attribute name.
        Returns:
        set of attribute values of a given attribute name,

      • getSubjectAttributeNames

        Set<String> getSubjectAttributeNames​(String application)
                              throws EntitlementException
        Returns subject attribute names.
        Parameters:
        application - Application name.
        Returns:
        subject attribute names.
        Throws:
        EntitlementException - if subject attribute names cannot be returned.

      • addSubjectAttributeNames

        void addSubjectAttributeNames​(String application,
                              Set<String> names)
                       throws EntitlementException
        Adds subject attribute names.
        Parameters:
        application - Application name.
        names - Set of subject attribute names.
        Throws:
        EntitlementException - if subject attribute names cannot be added.

      • getSubjectAttributesCollectorConfiguration

        Map<String,​Set<String>> getSubjectAttributesCollectorConfiguration​(String name)
                                                                  throws EntitlementException
        Returns subject attributes collector configuration.
        Parameters:
        name - subject attributes collector name
        Returns:
        subject attributes collector configuration.
        Throws:
        EntitlementException - if subject attributes collector configuration cannot be returned.

      • setSubjectAttributesCollectorConfiguration

        void setSubjectAttributesCollectorConfiguration​(String name,
                                                Map<String,​Set<String>> attrMap)
                                         throws EntitlementException
        Sets subject attributes collector configuration.
        Parameters:
        name - subject attributes collector name
        attrMap - subject attributes collector configuration map.
        Throws:
        EntitlementException - if subject attributes collector configuration cannot be set.

      • hasEntitlementDITs

        boolean hasEntitlementDITs()
        Returns true if OpenAM policy data is migrated to a form that entitlements service can operates on them.
        Returns:
        true if OpenAM policy data is migrated to a form that entitlements service can operates on them.

      • networkMonitorEnabled

        boolean networkMonitorEnabled()
        Returns true if the network monitoring for entitlements is enabled
        Returns:
        true if the network monitoring for entitlements is enabled.

      • setNetworkMonitorEnabled

        void setNetworkMonitorEnabled​(boolean enabled)
        Allows the network monitoring to be enabled/disabled
        Parameters:
        enabled - Is the network monitoring enabled

      • xacmlPrivilegeEnabled

        boolean xacmlPrivilegeEnabled()
        Returns true if the system stores privileges in XACML format and supports exporting privileges in XACML format
        Returns:
        true if the system stores privileges in XACML format and supports exporting privileges in XACML format

      • searchApplications

        Set<Application> searchApplications​(Subject subject,
                                    org.forgerock.util.query.QueryFilter<String> queryFilter)
                             throws EntitlementException
        Returns a set of applications for the given search criteria.
        Parameters:
        subject - Admin Subject
        queryFilter - Query filter.
        Returns:
        a set of applications for the given search criteria.
        Throws:
        EntitlementException - if search failed.

      • reindexApplications

        void reindexApplications()
        Reindex Applications.

      • isMonitoringRunning

        boolean isMonitoringRunning()
        For letting us know whether or not the Agent monitoring is enabled in core.
        Returns:
        true if monitoring is enabled, false otherwise

      • getPolicyWindowSize

        int getPolicyWindowSize()
        Informs us of the size of the policy window set in the configurable options.
        Returns:
        the value of the window size as configured.