Package com.sun.identity.policy.plugins
Class AMIdentityMembershipCondition
- java.lang.Object
-
- com.sun.identity.policy.plugins.AMIdentityMembershipCondition
-
@Deprecated public class AMIdentityMembershipCondition extends Object implements Condition
Deprecated.UseAMIdentityMembershipConditioninstead.The classAMIdentityMembershipConditionis a plugin implementation ofConditioninterface. This condition is satisifed only if the invocator uuid specified in the environment is a member of at least oneAMIdentityobject specified in the Condition.
-
-
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
-
-
Constructor Summary
Constructors Constructor Description AMIdentityMembershipCondition()Deprecated.No argument constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Objectclone()Deprecated.Returns a copy of this object.ConditionDecisiongetConditionDecision(SSOToken token, Map environment)Deprecated.Gets the decision computed by this condition object.StringgetDisplayName(String property, Locale locale)Deprecated.Gets the display name for the property name.MapgetProperties()Deprecated.Returns properties of this condition.ListgetPropertyNames()Deprecated.Returns a set of property names for the condition.SyntaxgetPropertySyntax(String property)Deprecated.Returns the syntax for a property nameSetgetValidValues(String property)Deprecated.Returns a set of valid values given the property name.voidsetProperties(Map properties)Deprecated.Sets the properties of the condition.
-
-
-
Method Detail
-
getPropertyNames
public List getPropertyNames()
Deprecated.Returns a set of property names for the condition.- Specified by:
getPropertyNamesin interfaceCondition- Returns:
- set of property names
-
getPropertySyntax
public Syntax getPropertySyntax(String property)
Deprecated.Returns the syntax for a property name- Specified by:
getPropertySyntaxin interfaceCondition- Parameters:
property- property name- Returns:
Syntaxfor the property name- See Also:
Syntax
-
getDisplayName
public String getDisplayName(String property, Locale locale) throws PolicyException
Deprecated.Gets the display name for the property name. Thelocalevariable could be used by the plugin to customize the display name for the given locale. Thelocalevariable could benull, in which case the plugin must use the default locale.- Specified by:
getDisplayNamein interfaceCondition- Parameters:
property- property name.locale- locale for which the property name must be customized.- Returns:
- display name for the property name.
- Throws:
PolicyException
-
getValidValues
public Set getValidValues(String property) throws PolicyException
Deprecated.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:
getValidValuesin interfaceCondition- Parameters:
property- property name- Returns:
- Set of valid values for the property.
- Throws:
PolicyException- if unable to get the valid values.
-
setProperties
public void setProperties(Map properties) throws PolicyException
Deprecated.Sets the properties of the condition. Evaluation ofConditionDecisionis influenced by these properties.- Specified by:
setPropertiesin interfaceCondition- Parameters:
properties- the properties of the condition that governs whether a policy applies. The properties should define value for the keyCondition.AM_IDENTITY_NAME. The value should be aSet. Each element of theSetshould be a String, the uuid ofAMIdentity. Please note that properties is not cloned by the method.- Throws:
PolicyException- if properties is null or does not contain value for the keyAM_IDENTITY_NAMEor the value of the key is not aSet- See Also:
ConditionDecision
-
getProperties
public Map getProperties()
Deprecated.Returns properties of this condition.- Specified by:
getPropertiesin interfaceCondition- Returns:
- properties of this condition.
- See Also:
Condition.setProperties(java.util.Map<java.lang.String, java.util.Set<java.lang.String>>)
-
getConditionDecision
public ConditionDecision getConditionDecision(SSOToken token, Map environment) throws SSOException, PolicyException
Deprecated.Gets the decision computed by this condition object. This condition is satisifed only if the invocator uuid specified in the environment is a member of at least oneAMIdentityobject specified in the Condition. Invocator uuid would be specified as the value of keyCondition.INVOCATOR_PRINCIPAL_UUIDin theenvironmentparameter. The value should be aSetofStringobjects.- Specified by:
getConditionDecisionin interfaceCondition- Parameters:
token- single sign on token of the userenvironment- request specific environment map of key/value pairs.- Returns:
- the condition decision.
Policy framework continues evaluating a policy only if it applies
to the request as indicated by the
ConditionDecision. Otherwise, further evaluation of the policy is skipped. - Throws:
SSOException- if the token is invalidPolicyException- for any other abnormal condition- See Also:
ConditionDecision
-
-