Package com.sun.identity.policy.plugins

Class AMIdentitySubject

java.lang.Object

com.sun.identity.policy.plugins.AMIdentitySubject

All Implemented Interfaces:

Subject, Cloneable

@Deprecated
public class AMIdentitySubject
extends Object
implements Subject

Deprecated.

Use IdentitySubject instead.

AMIdentitySubject is a Subject implementation that checks for membership in a set of AMIdentity objects using the underlying Identity repository service.

Constructor Summary

Constructors

Constructor	Description
AMIdentitySubject()	Deprecated. Constructs an AMIdentityObject

Method Summary

Modifier and Type	Method	Description
Object	clone()	Deprecated. Creates and returns a copy of this object.
boolean	equals(Object o)	Deprecated. Indicates whether some other object is "equal to" this one.
String	getDisplayNameForValue(String value, Locale locale)	Deprecated. Returns the display name for the value for the given locale.
ValidValues	getValidValues(SSOToken token)	Deprecated. Returns a list of possible values for the Subject.
ValidValues	getValidValues(SSOToken token, String pattern)	Deprecated. Returns a list of possible values for the Subject that matches the pattern.
Set	getValues()	Deprecated. Returns the values that was set using the method setValues.
Syntax	getValueSyntax(SSOToken token)	Deprecated. Returns the syntax of the values the AMIdentitySubject implementation can have.
int	hashCode()	Deprecated. Return a hash code for this AMIdentitySubject.
void	initialize(Map configParams)	Deprecated. Initialize the AMIdentitySubject object by using the configuration information passed by the Policy Framework.
boolean	isMember(SSOToken token)	Deprecated. Determines if the user is a member of this instance of the Subject object.
void	setValues(Set names)	Deprecated. Sets the values identifying AMIdentity objects on which membership would be checked

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AMIdentitySubject

public AMIdentitySubject()

Deprecated.

Constructs an AMIdentityObject

Method Detail

initialize

public void initialize(Map configParams)
                throws PolicyException

Deprecated.

Initialize the AMIdentitySubject object by using the configuration information passed by the Policy Framework.

This implementation not need anything out of the configParams I/code> so does no operation.

Specified by:

initialize in interface Subject

Parameters:

configParams - configuration parameters as a Map.

Throws:

PolicyException - if an error occured during initialization of Subject instance

getValueSyntax

public Syntax getValueSyntax(SSOToken token)
                      throws SSOException

Deprecated.

Returns the syntax of the values the AMIdentitySubject implementation can have.

Specified by:

getValueSyntax in interface Subject

Parameters:

token - the SSOToken that will be used to determine the syntax

Returns:

Syntax of the values in this plugin. It returns Syntax.MULTIPLE_CHOICE.

Throws:

SSOException - if SSOToken is not valid

See Also:

Syntax

getValidValues

public ValidValues getValidValues(SSOToken token)
                           throws SSOException,
                                  PolicyException

Deprecated.

Returns a list of possible values for the Subject.

Specified by:

getValidValues in interface Subject

Parameters:

token - the SSOToken that will be used to determine the possible values

Returns:

ValidValues object

Throws:

SSOException - if SSOToken is not valid

PolicyException - if unable to get the list of valid names. NOTE: The AMIdentitySubject plugin does not support this functionality and in turn throws unsupported PolicyException

getValidValues

public ValidValues getValidValues(SSOToken token,
                                  String pattern)
                           throws SSOException,
                                  PolicyException

Deprecated.

Returns a list of possible values for the Subject that matches the pattern.

Specified by:

getValidValues in interface Subject

Parameters:

token - the SSOToken that will be used to determine the possible values

pattern - search pattern that will be used to narrow the list of valid names.

Returns:

ValidValues object

Throws:

SSOException - if SSO token is not valid

PolicyException - if unable to get the list of valid names. NOTE: The AMIdentitySubject plugin does not support this functionality and in turn throws unsupported PolicyException

getDisplayNameForValue

public String getDisplayNameForValue(String value,
                                     Locale locale)
                              throws NameNotFoundException

Deprecated.

Returns the display name for the value for the given locale. For all the valid values obtained through the methods getValidValues this method must be called by GUI and CLI to get the corresponding display 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 (most probabily en_US). Alternatively, if the plugin does not have to localize the value, it can just return the value as is.

Specified by:

getDisplayNameForValue in interface Subject

Parameters:

value - one of the valid value for the plugin

locale - locale for which the display name must be customized

Returns:

the display name for the value for the given locale.

Throws:

NameNotFoundException - if the given value is not one of the valid values for the plugin

getValues

public Set getValues()

Deprecated.

Returns the values that was set using the method setValues.

Specified by:

getValues in interface Subject

Returns:

Set

setValues

public void setValues(Set names)
               throws InvalidNameException

Deprecated.

Sets the values identifying AMIdentity objects on which membership would be checked

Specified by:

setValues in interface Subject

Parameters:

names - universalId(s) of AMIdentity objects on which memberships would be checked

Throws:

InvalidNameException - if the given names are not valid

isMember

public boolean isMember(SSOToken token)
                 throws SSOException,
                        PolicyException

Deprecated.

Determines if the user is a member of this instance of the Subject object.

Specified by:

isMember in interface Subject

Parameters:

token - single sign on token of the user

Returns:

true if the user is member of this subject; false otherwise.

Throws:

SSOException - if SSO token is not valid

PolicyException - if an error occured while checking if the user is a member of this subject

hashCode

public int hashCode()

Deprecated.

Return a hash code for this AMIdentitySubject.

Overrides:

hashCode in class Object

Returns:

a hash code for this AMIdentitySubject object.

equals

public boolean equals(Object o)

Deprecated.

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

o - another object that will be compared with this one

Returns:

true if eqaul; false otherwise

clone

public Object clone()

Deprecated.

Creates and returns a copy of this object.

Specified by:

clone in interface Subject

Overrides:

clone in class Object

Returns:

a copy of this object