PolicyConfig (OpenAM Project 15.1.7-SNAPSHOT API)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADVICES_HANDLEABLE_BY_AM`
`static String`	`CONTINUE_EVALUATION_ON_DENY_DECISION`
`static String`	`IS_ROLES_BASE_DN`
`static String`	`IS_ROLES_SEARCH_SCOPE`
`static String`	`ISDS_HOST` OpenAM directory host.
`static String`	`LDAP_BASE_DN`
`static String`	`LDAP_BIND_DN`
`static String`	`LDAP_BIND_PASSWORD`
`static String`	`LDAP_CONNECTION_POOL_MAX_SIZE`
`static String`	`LDAP_CONNECTION_POOL_MIN_SIZE`
`static String`	`LDAP_GROUP_SEARCH_ATTRIBUTE`
`static String`	`LDAP_GROUP_SEARCH_FILTER`
`static String`	`LDAP_GROUP_SEARCH_SCOPE`
`static String`	`LDAP_ORG_SEARCH_ATTRIBUTE`
`static String`	`LDAP_ORG_SEARCH_FILTER`
`static String`	`LDAP_ORG_SEARCH_SCOPE`
`static String`	`LDAP_ROLES_SEARCH_ATTRIBUTE`
`static String`	`LDAP_ROLES_SEARCH_FILTER`
`static String`	`LDAP_ROLES_SEARCH_SCOPE`
`static String`	`LDAP_SEARCH_LIMIT`
`static String`	`LDAP_SEARCH_TIME_OUT`
`static String`	`LDAP_SERVER`
`static String`	`LDAP_SSL_ENABLED`
`static String`	`LDAP_USER_SEARCH_ATTRIBUTE`
`static String`	`LDAP_USERS_BASE_DN`
`static String`	`LDAP_USERS_SEARCH_FILTER`
`static String`	`LDAP_USERS_SEARCH_SCOPE`
`static String`	`ORG_ALIAS_MAPPED_RESOURCES_ENABLED`
`static String`	`ORG_DN`
`static String`	`POLICY_CONFIG_SERVICE`
`static String`	`RESOURCE_COMPARATOR`
`static String`	`RESOURCE_COMPARATOR_CASE_SENSITIVE`
`static String`	`RESOURCE_COMPARATOR_CLASS`
`static String`	`RESOURCE_COMPARATOR_DELIMITER`
`static String`	`RESOURCE_COMPARATOR_ONE_LEVEL_WILDCARD`
`static String`	`RESOURCE_COMPARATOR_TYPE`
`static String`	`RESOURCE_COMPARATOR_WILDCARD`
`static String`	`SELECTED_CONDITIONS`
`static String`	`SELECTED_DYNAMIC_ATTRIBUTES`
`static String`	`SELECTED_REFERRALS`
`static String`	`SELECTED_RESPONSE_PROVIDERS`
`static String`	`SELECTED_SUBJECTS`
`static String`	`SUBJECTS_RESULT_TTL` attribute to define value for Subjects result ttl
`static String`	`USER_ALIAS_ENABLED`

Fields inherited from interface com.sun.identity.sm.ServiceListener
ADDED, MODIFIED, REMOVED

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Set`	`getAdvicesHandleableByAM()` Returns names of policy advices that could be handled by OpenSSO Enterprise if PEP redirects the user agent to OpenSSO.
`static Map`	`getPolicyConfig(String org)` this method returns the policy configuration for the given organization.
`static Map`	`getResourceCompareConfig(String service)` Returns the resource comparator configuration for the given service type
`static long`	`getSubjectsResultTtl(Map policyConfig)` Gets subjectsResultTtl - time in milliseconds for which result of subjects evaluation would be cached based, on the policyConfig map passed.
`void`	`globalConfigChanged(String serviceName, String version, String groupName, String serviceComponent, int changeType)` This method will be invoked when a service's global configuation data has been changed.
`void`	`organizationConfigChanged(String serviceName, String version, String orgName, String groupName, String serviceComponent, int changeType)` This method will be invoked when a service's organization configuation data has been changed.
`void`	`schemaChanged(String serviceName, String version)` This method will be invoked when a service's schema has been changed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LDAP_SERVER
```
public static final String LDAP_SERVER
```
    See Also:
    
    Constant Field Values
  - LDAP_BASE_DN
```
public static final String LDAP_BASE_DN
```
    See Also:
    
    Constant Field Values
  - LDAP_USERS_BASE_DN
```
public static final String LDAP_USERS_BASE_DN
```
    See Also:
    
    Constant Field Values
  - LDAP_BIND_DN
```
public static final String LDAP_BIND_DN
```
    See Also:
    
    Constant Field Values
  - LDAP_BIND_PASSWORD
```
public static final String LDAP_BIND_PASSWORD
```
    See Also:
    
    Constant Field Values
  - LDAP_ORG_SEARCH_FILTER
```
public static final String LDAP_ORG_SEARCH_FILTER
```
    See Also:
    
    Constant Field Values
  - LDAP_ORG_SEARCH_SCOPE
```
public static final String LDAP_ORG_SEARCH_SCOPE
```
    See Also:
    
    Constant Field Values
  - LDAP_GROUP_SEARCH_FILTER
```
public static final String LDAP_GROUP_SEARCH_FILTER
```
    See Also:
    
    Constant Field Values
  - LDAP_GROUP_SEARCH_SCOPE
```
public static final String LDAP_GROUP_SEARCH_SCOPE
```
    See Also:
    
    Constant Field Values
  - LDAP_USERS_SEARCH_FILTER
```
public static final String LDAP_USERS_SEARCH_FILTER
```
    See Also:
    
    Constant Field Values
  - LDAP_USERS_SEARCH_SCOPE
```
public static final String LDAP_USERS_SEARCH_SCOPE
```
    See Also:
    
    Constant Field Values
  - LDAP_ROLES_SEARCH_FILTER
```
public static final String LDAP_ROLES_SEARCH_FILTER
```
    See Also:
    
    Constant Field Values
  - LDAP_ROLES_SEARCH_SCOPE
```
public static final String LDAP_ROLES_SEARCH_SCOPE
```
    See Also:
    
    Constant Field Values
  - LDAP_ORG_SEARCH_ATTRIBUTE
```
public static final String LDAP_ORG_SEARCH_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - LDAP_GROUP_SEARCH_ATTRIBUTE
```
public static final String LDAP_GROUP_SEARCH_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - LDAP_USER_SEARCH_ATTRIBUTE
```
public static final String LDAP_USER_SEARCH_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - LDAP_ROLES_SEARCH_ATTRIBUTE
```
public static final String LDAP_ROLES_SEARCH_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - LDAP_SEARCH_TIME_OUT
```
public static final String LDAP_SEARCH_TIME_OUT
```
    See Also:
    
    Constant Field Values
  - LDAP_SEARCH_LIMIT
```
public static final String LDAP_SEARCH_LIMIT
```
    See Also:
    
    Constant Field Values
  - LDAP_CONNECTION_POOL_MIN_SIZE
```
public static final String LDAP_CONNECTION_POOL_MIN_SIZE
```
    See Also:
    
    Constant Field Values
  - LDAP_CONNECTION_POOL_MAX_SIZE
```
public static final String LDAP_CONNECTION_POOL_MAX_SIZE
```
    See Also:
    
    Constant Field Values
  - LDAP_SSL_ENABLED
```
public static final String LDAP_SSL_ENABLED
```
    See Also:
    
    Constant Field Values
  - IS_ROLES_BASE_DN
```
public static final String IS_ROLES_BASE_DN
```
    See Also:
    
    Constant Field Values
  - IS_ROLES_SEARCH_SCOPE
```
public static final String IS_ROLES_SEARCH_SCOPE
```
    See Also:
    
    Constant Field Values
  - SELECTED_SUBJECTS
```
public static final String SELECTED_SUBJECTS
```
    See Also:
    
    Constant Field Values
  - SELECTED_REFERRALS
```
public static final String SELECTED_REFERRALS
```
    See Also:
    
    Constant Field Values
  - SELECTED_CONDITIONS
```
public static final String SELECTED_CONDITIONS
```
    See Also:
    
    Constant Field Values
  - SELECTED_RESPONSE_PROVIDERS
```
public static final String SELECTED_RESPONSE_PROVIDERS
```
    See Also:
    
    Constant Field Values
  - SELECTED_DYNAMIC_ATTRIBUTES
```
public static final String SELECTED_DYNAMIC_ATTRIBUTES
```
    See Also:
    
    Constant Field Values
  - USER_ALIAS_ENABLED
```
public static final String USER_ALIAS_ENABLED
```
    See Also:
    
    Constant Field Values
  - RESOURCE_COMPARATOR
```
public static final String RESOURCE_COMPARATOR
```
    See Also:
    
    Constant Field Values
  - RESOURCE_COMPARATOR_TYPE
```
public static final String RESOURCE_COMPARATOR_TYPE
```
    See Also:
    
    Constant Field Values
  - RESOURCE_COMPARATOR_CLASS
```
public static final String RESOURCE_COMPARATOR_CLASS
```
    See Also:
    
    Constant Field Values
  - RESOURCE_COMPARATOR_DELIMITER
```
public static final String RESOURCE_COMPARATOR_DELIMITER
```
    See Also:
    
    Constant Field Values
  - RESOURCE_COMPARATOR_WILDCARD
```
public static final String RESOURCE_COMPARATOR_WILDCARD
```
    See Also:
    
    Constant Field Values
  - RESOURCE_COMPARATOR_ONE_LEVEL_WILDCARD
```
public static final String RESOURCE_COMPARATOR_ONE_LEVEL_WILDCARD
```
    See Also:
    
    Constant Field Values
  - RESOURCE_COMPARATOR_CASE_SENSITIVE
```
public static final String RESOURCE_COMPARATOR_CASE_SENSITIVE
```
    See Also:
    
    Constant Field Values
  - CONTINUE_EVALUATION_ON_DENY_DECISION
```
public static final String CONTINUE_EVALUATION_ON_DENY_DECISION
```
    See Also:
    
    Constant Field Values
  - ORG_ALIAS_MAPPED_RESOURCES_ENABLED
```
public static final String ORG_ALIAS_MAPPED_RESOURCES_ENABLED
```
    See Also:
    
    Constant Field Values
  - ADVICES_HANDLEABLE_BY_AM
```
public static final String ADVICES_HANDLEABLE_BY_AM
```
    See Also:
    
    Constant Field Values
  - ORG_DN
```
public static final String ORG_DN
```
    See Also:
    
    Constant Field Values
  - SUBJECTS_RESULT_TTL
```
public static final String SUBJECTS_RESULT_TTL
```
    attribute to define value for Subjects result ttl
    
    See Also:
    
    Constant Field Values
  - POLICY_CONFIG_SERVICE
```
public static final String POLICY_CONFIG_SERVICE
```
    See Also:
    
    Constant Field Values
  - ISDS_HOST
```
public static final String ISDS_HOST
```
    OpenAM directory host.
- Method Detail
  - getResourceCompareConfig
```
public static Map getResourceCompareConfig(String service)
                                    throws PolicyException
```
    Returns the resource comparator configuration for the given service type
    
    Parameters:
    
    service - ServiceType name
    
    Returns:
    
    - Map containing data for RESOURCE_COMPARATOR_CLASS, RESOURCE_COMPARATOR_DELIMITER, RESOURCE_COMPARATOR_WILDCARD, RESOURCE_COMPARATOR_ONE_LEVEL_WILDCARD, RESOURCE_COMPARATOR_CASE_SENSITIVE keys. Note that return value would be null if service name passed in is null or if there is no configuration available for service
    
    Throws:
    
    PolicyException
  - getPolicyConfig
```
public static Map getPolicyConfig(String org)
                           throws PolicyException
```
    this method returns the policy configuration for the given organization.
    
    Parameters:
    
    org - Organization name
    
    Returns:
    
    Map of organization configuration attributes. The possible keys in the map are defined in PolicyConfig
    
    Throws:
    
    PolicyException - if it is not able to get the policy configuration for the given organization.
  - schemaChanged
```
public void schemaChanged(String serviceName,
                          String version)
```
    This method will be invoked when a service's schema has been changed.
    
    Specified by:
    
    schemaChanged in interface ServiceListener
    
    Parameters:
    
    serviceName - name of the service
    
    version - version of the service
  - globalConfigChanged
```
public void globalConfigChanged(String serviceName,
                                String version,
                                String groupName,
                                String serviceComponent,
                                int changeType)
```
    This method will be invoked when a service's global configuation data has been changed. The parameter groupName denote the name of the configuration grouping (e.g. default) and serviceComponent denotes the service's sub-component that changed
    
    Specified by:
    
    globalConfigChanged in interface ServiceListener
    
    Parameters:
    
    serviceName - name of the service
    
    version - version of the service
    
    serviceComponent - name of the service components that changed
    
    groupName - name of the configuration grouping.
    
    changeType - change type, i.e., ADDED, REMOVED or MODIFIED.
  - organizationConfigChanged
```
public void organizationConfigChanged(String serviceName,
                                      String version,
                                      String orgName,
                                      String groupName,
                                      String serviceComponent,
                                      int changeType)
```
    This method will be invoked when a service's organization configuation data has been changed. The parameters orgName, groupName and serviceComponent denotes the organization name, configuration grouping name and service's sub-component that are changed respectively.
    
    Specified by:
    
    organizationConfigChanged in interface ServiceListener
    
    Parameters:
    
    serviceName - name of the service
    
    version - version of the service
    
    groupName -
    
    orgName - organization name as DN
    
    serviceComponent - the name of the service components that changed
    
    changeType - change type, i.e., ADDED, REMOVED or MODIFIED
  - getSubjectsResultTtl
```
public static long getSubjectsResultTtl(Map policyConfig)
```
    Gets subjectsResultTtl - time in milliseconds for which result of subjects evaluation would be cached based, on the policyConfig map passed.
    
    Parameters:
    
    policyConfig - policy config map that is used to compute subjectsResultTtl. Value of key PolicyConfig.SUBJECTS_RESULT_TTL in the map is assumed to be value of subjectsResultTtl in minutes. If the value is not defined in the map or it can not be parsed as int, the value would default to 0
    
    Returns:
    
    subjectsResultTtl
  - getAdvicesHandleableByAM
```
public static Set getAdvicesHandleableByAM()
                                    throws PolicyException
```
    Returns names of policy advices that could be handled by OpenSSO Enterprise if PEP redirects the user agent to OpenSSO.
    
    Returns:
    
    Set representing names of policy advices OpenSSO could handle.
    
    Throws:
    
    PolicyException

Class PolicyConfig

Field Summary

Fields inherited from interface com.sun.identity.sm.ServiceListener

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LDAP_SERVER

LDAP_BASE_DN

LDAP_USERS_BASE_DN

LDAP_BIND_DN

LDAP_BIND_PASSWORD

LDAP_ORG_SEARCH_FILTER

LDAP_ORG_SEARCH_SCOPE

LDAP_GROUP_SEARCH_FILTER

LDAP_GROUP_SEARCH_SCOPE

LDAP_USERS_SEARCH_FILTER

LDAP_USERS_SEARCH_SCOPE

LDAP_ROLES_SEARCH_FILTER

LDAP_ROLES_SEARCH_SCOPE

LDAP_ORG_SEARCH_ATTRIBUTE

LDAP_GROUP_SEARCH_ATTRIBUTE

LDAP_USER_SEARCH_ATTRIBUTE

LDAP_ROLES_SEARCH_ATTRIBUTE

LDAP_SEARCH_TIME_OUT

LDAP_SEARCH_LIMIT

LDAP_CONNECTION_POOL_MIN_SIZE

LDAP_CONNECTION_POOL_MAX_SIZE

LDAP_SSL_ENABLED

IS_ROLES_BASE_DN

IS_ROLES_SEARCH_SCOPE

SELECTED_SUBJECTS

SELECTED_REFERRALS

SELECTED_CONDITIONS

SELECTED_RESPONSE_PROVIDERS

SELECTED_DYNAMIC_ATTRIBUTES

USER_ALIAS_ENABLED

RESOURCE_COMPARATOR

RESOURCE_COMPARATOR_TYPE

RESOURCE_COMPARATOR_CLASS

RESOURCE_COMPARATOR_DELIMITER

RESOURCE_COMPARATOR_WILDCARD

RESOURCE_COMPARATOR_ONE_LEVEL_WILDCARD

RESOURCE_COMPARATOR_CASE_SENSITIVE

CONTINUE_EVALUATION_ON_DENY_DECISION

ORG_ALIAS_MAPPED_RESOURCES_ENABLED

ADVICES_HANDLEABLE_BY_AM

ORG_DN

SUBJECTS_RESULT_TTL

POLICY_CONFIG_SERVICE

ISDS_HOST

Method Detail

getResourceCompareConfig

getPolicyConfig

schemaChanged

globalConfigChanged

organizationConfigChanged

getSubjectsResultTtl

getAdvicesHandleableByAM