Package com.sun.identity.policy.plugins

Class AuthenticatedSharedAgents

java.lang.Object

com.sun.identity.policy.plugins.AuthenticatedSharedAgents

All Implemented Interfaces:

Subject, Cloneable

public class AuthenticatedSharedAgents
extends Object
implements Subject

This subject applies to all users/agents with valid SSOToken.

Constructor Summary

Constructors

Constructor	Description
AuthenticatedSharedAgents()	Default Constructor

Method Summary

Modifier and Type	Method	Description
Object	clone()	Creates and returns a copy of this object.
String	getDisplayNameForValue(String value, Locale locale)	This method does nothing as there are no values to display for this subject.
ValidValues	getValidValues(SSOToken token)	Returns an empty list as possible values.
ValidValues	getValidValues(SSOToken token, String pattern)	Returns an empty list as possible values.
Set	getValues()	Returns an empty collection as value.
Syntax	getValueSyntax(SSOToken token)	Returns the syntax of the subject type.
int	hashCode()	Return a hash code for this AuthenticatedSharedAgents.
void	initialize(Map configParams)	Initialize the subject.
boolean	isMember(SSOToken token)	Determines if the agent belongs to the AuthenticatedSharedAgents object.
protected boolean	isSharedAgent(SSOToken token, String userName, String userDNUnivId, String rlmName)	Checks if distinguished user name is a shared user/agent if returns true if so.
void	setValues(Set names)	This method does nothing for this subject as there are no values to set for this subject.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticatedSharedAgents

public AuthenticatedSharedAgents()

Default Constructor

Method Detail

initialize

public void initialize(Map configParams)

Initialize the subject. No properties are required for this subject.

Specified by:

initialize in interface Subject

Parameters:

configParams - configurational information

getValueSyntax

public Syntax getValueSyntax(SSOToken token)

Returns the syntax of the subject type.

Specified by:

getValueSyntax in interface Subject

Parameters:

token - the SSOToken. Not used for this subject.

Returns:

Syntax for this subject.

See Also:

Syntax

getValidValues

public ValidValues getValidValues(SSOToken token)

Returns an empty list as possible values.

Specified by:

getValidValues in interface Subject

Parameters:

token - the SSOToken

Returns:

ValidValues object with empty list.

getValidValues

public ValidValues getValidValues(SSOToken token,
                                  String pattern)

Returns an empty list as possible values.

Specified by:

getValidValues in interface Subject

Parameters:

token - the SSOToken

pattern - the pattern to match in valid values. Ignored for this subject

Returns:

ValidValues object with empty list.

getDisplayNameForValue

public String getDisplayNameForValue(String value,
                                     Locale locale)

This method does nothing as there are no values to display for this subject.

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.

getValues

public Set getValues()

Returns an empty collection as value.

Specified by:

getValues in interface Subject

Returns:

an empty set

setValues

public void setValues(Set names)

This method does nothing for this subject as there are no values to set for this subject.

Specified by:

setValues in interface Subject

Parameters:

names - names selected for the instance of the user collection object.

isMember

public boolean isMember(SSOToken token)
                 throws SSOException

Determines if the agent belongs to the AuthenticatedSharedAgents object.

Specified by:

isMember in interface Subject

Parameters:

token - SSOToken of the agent

Returns:

true if the agent SSOToken is valid. false otherwise.

Throws:

SSOException - if error occurs while validating the token.

clone

public Object clone()

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

hashCode

public int hashCode()

Return a hash code for this AuthenticatedSharedAgents.

Overrides:

hashCode in class Object

Returns:

a hash code for this AuthenticatedSharedAgents object.

isSharedAgent

protected boolean isSharedAgent(SSOToken token,
                                String userName,
                                String userDNUnivId,
                                String rlmName)

Checks if distinguished user name is a shared user/agent if returns true if so.