com.sun.identity.policy.plugins

Class AuthenticatedSharedAgentsCondition

java.lang.Object

com.sun.identity.policy.plugins.AuthenticatedSharedAgentsCondition

All Implemented Interfaces:

Condition, ServiceListener, Cloneable

public class AuthenticatedSharedAgentsCondition
extends Object
implements Condition, ServiceListener

The class AuthenticatedSharedAgentsCondition checks if the authenticated shared agent has the agent name it is trying to read.

Field Summary

Fields inherited from interface com.sun.identity.policy.interfaces.Condition

AM_IDENTITY_NAME, APPLICATION_IDLE_TIMEOUT, APPLICATION_NAME, AUTH_LEVEL, AUTH_LEVEL_CONDITION_ADVICE, AUTH_SCHEME, AUTH_SCHEME_CONDITION_ADVICE, AUTHENTICATE_TO_REALM, AUTHENTICATE_TO_REALM_CONDITION_ADVICE, AUTHENTICATE_TO_SERVICE, AUTHENTICATE_TO_SERVICE_CONDITION_ADVICE, DNS_NAME, END_DATE, END_DAY, END_IP, END_TIME, ENFORCEMENT_TIME_ZONE, INVOCATOR_PRINCIPAL_UUID, LDAP_FILTER, MAX_SESSION_TIME, REQUEST_AUTH_LEVEL, REQUEST_AUTH_SCHEMES, REQUEST_AUTHENTICATED_TO_REALMS, REQUEST_AUTHENTICATED_TO_SERVICES, REQUEST_DNS_NAME, REQUEST_IP, REQUEST_TIME_ZONE, START_DATE, START_DAY, START_IP, START_TIME, TERMINATE_SESSION, VALUE_CASE_INSENSITIVE

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

ADDED, MODIFIED, REMOVED

Constructor Summary

Constructors

Constructor and Description
AuthenticatedSharedAgentsCondition() No argument constructor

Method Summary

Modifier and Type	Method and Description
Object	clone() Returns a copy of this object.
ConditionDecision	getConditionDecision(SSOToken token, Map env) Gets the decision computed by this condition object.
String	getDisplayName(String property, Locale locale) Gets the display name for the property name.
Map	getProperties() Gets the properties of the condition.
List	getPropertyNames() Returns a set of property names for the condition.
Syntax	getPropertySyntax(String property) Returns the syntax for a property name
Set	getValidValues(String property) Returns a set of valid values given the property name.
void	globalConfigChanged(String serviceName, String version, String groupName, String serviceComponent, int type) This method will be invoked when a service's global configuration data has been changed.
void	organizationConfigChanged(String serviceName, String version, String orgName, String groupName, String serviceComponent, int type) This method will be invoked when a service's organization configuration data has been changed.
void	schemaChanged(String serviceName, String version) This method will be invoked when a service's schema has been changed.
void	setProperties(Map properties) Sets the properties of the condition.
String[]	split(String res)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthenticatedSharedAgentsCondition

public AuthenticatedSharedAgentsCondition()

No argument constructor

Method Detail

getPropertyNames

public List getPropertyNames()

Returns a set of property names for the condition.

Specified by:

getPropertyNames in interface Condition

Returns:

set of property names

getPropertySyntax

public Syntax getPropertySyntax(String property)

Returns the syntax for a property name

Specified by:

getPropertySyntax in interface Condition

Parameters:

property - String representing property name

Returns:

Syntax for the property name

See Also:

Syntax

getDisplayName

public String getDisplayName(String property,
                             Locale locale)
                      throws PolicyException

Gets the display name for the property name. The locale variable could be used by the plugin to customize the display name for the given locale. The locale variable could be null, in which case the plugin must use the default locale.

Specified by:

getDisplayName in interface Condition

Parameters:

property - property name.

locale - locale for which the property name must be customized.

Returns:

display name for the property name.

Throws:

PolicyException - if unable to get display name

getValidValues

public Set getValidValues(String property)
                   throws PolicyException

Returns a set of valid values given the property name. This method is called if the property Syntax is either the SINGLE_CHOICE or MULTIPLE_CHOICE.

Specified by:

getValidValues in interface Condition

Parameters:

property - String representing property name

Returns:

Set of valid values for the property.

Throws:

PolicyException - if unable to get the Syntax.

setProperties

public void setProperties(Map properties)
                   throws PolicyException

Sets the properties of the condition. Evaluation of ConditionDecision is influenced by these properties.

Specified by:

setProperties in interface Condition

Parameters:

properties - of the condition that governs whether a policy applies. The only defined property is attributes

Throws:

PolicyException - for any abnormal condition

See Also:

ConditionDecision

getProperties

public Map getProperties()

Gets the properties of the condition.

Specified by:

getProperties in interface Condition

Returns:

map view of properties that govern the evaluation of the condition decision

See Also:

setProperties(Map)

getConditionDecision

public ConditionDecision getConditionDecision(SSOToken token,
                                              Map env)
                                       throws PolicyException,
                                              SSOException

Gets the decision computed by this condition object.

Specified by:

getConditionDecision in interface Condition

Parameters:

token - single sign on token of the user

env - request specific environment map of key/value pairs.

Returns:

the condition decision. The condition decision encapsulates whether a policy applies for the request. Policy framework continues evaluating a policy only if it applies to the request as indicated by the CondtionDecision. Otherwise, further evaluation of the policy is skipped.

Throws:

SSOException - if the token is invalid

PolicyException - if the decision could not be computed

See Also:

ConditionDecision

clone

public Object clone()

Returns a copy of this object.

Specified by:

clone in interface Condition

Overrides:

clone in class Object

Returns:

a copy of this object

globalConfigChanged

public void globalConfigChanged(String serviceName,
                                String version,
                                String groupName,
                                String serviceComponent,
                                int type)

Description copied from interface: ServiceListener

This method will be invoked when a service's global configuration 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 (e.g. /NamedPolicy, /Templates).

Specified by:

globalConfigChanged in interface ServiceListener

Parameters:

serviceName - name of the service.

version - version of the service.

groupName - name of the configuration grouping.

serviceComponent - name of the service components that changed.

type - change type, i.e., ADDED, REMOVED or MODIFIED.

organizationConfigChanged

public void organizationConfigChanged(String serviceName,
                                      String version,
                                      String orgName,
                                      String groupName,
                                      String serviceComponent,
                                      int type)

Description copied from interface: ServiceListener

This method will be invoked when a service's organization configuration 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

orgName - organization name as DN

groupName - name of the configuration grouping

serviceComponent - the name of the service components that changed

type - change type, i.e., ADDED, REMOVED or MODIFIED

schemaChanged

public void schemaChanged(String serviceName,
                          String version)

Description copied from interface: ServiceListener

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

split

public String[] split(String res)