Package com.sun.identity.policy.plugins

Class PrivilegeCondition

java.lang.Object

com.sun.identity.policy.plugins.PrivilegeCondition

All Implemented Interfaces:

Condition, Cloneable

public class PrivilegeCondition
extends Object
implements Condition, Cloneable

A generic condition mapper that maps entitlement conditions to OpenAM conditions.

Field Summary

Fields

Modifier and Type	Field	Description
static String	STATE

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

Constructor Summary

Constructors

Constructor	Description
PrivilegeCondition()

Method Summary

Modifier and Type	Method	Description
Object	clone()	Returns a clone of this object.
ConditionDecision	getConditionDecision(SSOToken token, Map env)	Returns condition decision.
String	getDisplayName(String property, Locale locale)	Returns the display name of a property.
Map	getProperties()	Returns the property values.
List	getPropertyNames()	Returns a list of property names.
Syntax	getPropertySyntax(String property)	Return the syntax for displaying the property value.
Set	getValidValues(String property)	Returns the valid values of a property.
void	setProperties(Map properties)	Sets the property values to this object.

Methods inherited from class java.lang.Object

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

Field Detail

STATE

public static final String STATE

See Also:

Constant Field Values

Constructor Detail

PrivilegeCondition

public PrivilegeCondition()

Method Detail

getPropertyNames

public List getPropertyNames()

Returns a list of property names.

Specified by:

getPropertyNames in interface Condition

Returns:

a list of property names.

getPropertySyntax

public Syntax getPropertySyntax(String property)

Return the syntax for displaying the property value.

Specified by:

getPropertySyntax in interface Condition

Parameters:

property - Property name.

Returns:

syntax for displaying the property value.

See Also:

Syntax

getDisplayName

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

Returns the display name of a property.

Specified by:

getDisplayName in interface Condition

Parameters:

property - Property name.

locale - Locale.

Returns:

the display name of a property.

Throws:

PolicyException - if display name cannot be provided.

getValidValues

public Set getValidValues(String property)
                   throws PolicyException

Returns the valid values of a property.

Specified by:

getValidValues in interface Condition

Parameters:

property - Property Name.

Returns:

valid values of a property.

Throws:

PolicyException - if valid values cannot be provided.

setProperties

public void setProperties(Map properties)
                   throws PolicyException

Sets the property values to this object.

Specified by:

setProperties in interface Condition

Parameters:

properties - Properties to be set.

Throws:

PolicyException - if property cannot be set.

See Also:

ConditionDecision

getProperties

public Map getProperties()

Returns the property values.

Specified by:

getProperties in interface Condition

Returns:

Property values.

See Also:

Condition.setProperties(java.util.Map<java.lang.String, java.util.Set<java.lang.String>>)

getConditionDecision

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

Returns condition decision. Returing false.

Specified by:

getConditionDecision in interface Condition

Parameters:

token - Single sign on token of the subject.

env - Environment map.

Returns:

false.

Throws:

PolicyException - if decision cannot be provided.

SSOException - if single sign on token is invalid or has expired.

See Also:

ConditionDecision

clone

public Object clone()

Returns a clone of this object.

Specified by:

clone in interface Condition

Overrides:

clone in class Object

Returns:

clone of this object.