com.sun.identity.policy.plugins

Class LDAPUsers

java.lang.Object

com.sun.identity.policy.plugins.LDAPUsers

All Implemented Interfaces:

Subject, Cloneable

public class LDAPUsers
extends Object
implements Subject

This class respresents a group of LDAP users

Constructor Summary

Constructors

Constructor and Description
LDAPUsers() Constructor with no parameter

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates and returns a copy of this object.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
String	getDisplayNameForValue(String value, Locale locale) Returns the display name for the value for the given locale.
ValidValues	getValidEntries(SSOToken token, String pattern, String[] attributeNames) Returns a set of possible values that satisfy the pattern.
ValidValues	getValidValues(SSOToken token) Returns a list of possible values for the LDAPUsers .
ValidValues	getValidValues(SSOToken token, String pattern) Returns a list of possible values for the LDAPUsers that satisfy the given pattern.
Set	getValues() Returns the values that was set using the method setValues.
Syntax	getValueSyntax(SSOToken token) Returns the syntax of the values the LDAPUsers
int	hashCode() Return a hash code for this LDAPUsers.
void	initialize(Map configParams) Initialize the LDAPGroup object by using the configuration information passed by the Policy Framework.
boolean	isMember(SSOToken token) Determines if the user belongs to this instance of the LDAPUsers object.
protected org.forgerock.opendj.ldif.ConnectionEntryReader	search(String searchFilter, org.forgerock.opendj.ldap.Connection ld, String... attributeNames)
void	setValues(Set names) Sets the names for the instance of the LDAPUsers object.

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPUsers

public LDAPUsers()

Constructor with no parameter

Method Detail

initialize

public void initialize(Map configParams)
                throws PolicyException

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

Specified by:

initialize in interface Subject

Parameters:

configParams - the configuration information

Throws:

PolicyException - if an error occured during initialization of the instance

getValueSyntax

public Syntax getValueSyntax(SSOToken token)
                      throws SSOException

Returns the syntax of the values the LDAPUsers

Specified by:

getValueSyntax in interface Subject

Parameters:

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

Returns:

set of of valid names for the user collection.

Throws:

SSOException - if SSOToken is not valid

See Also:

Syntax

getValidValues

public ValidValues getValidValues(SSOToken token)
                           throws SSOException,
                                  PolicyException

Returns a list of possible values for the LDAPUsers .

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.

getValidValues

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

Returns a list of possible values for the LDAPUsers that satisfy the given 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 SSOToken is not valid

PolicyException - if unable to get the list of valid names.

getValidEntries

public ValidValues getValidEntries(SSOToken token,
                                   String pattern,
                                   String[] attributeNames)
                            throws SSOException,
                                   PolicyException

Returns a set of possible values that satisfy the pattern. The returned ValidValues object contains a set of map of user DN to a map of user's attribute name to a string array of attribute values.

Parameters:

token - Single Sign On token for fetching the possible values.

pattern - Search pattern of which possible values are matched to.

attributeNames - Array of attribute names to be to returned.

Returns:

a set of possible values that satify the pattern.

Throws:

SSOException - if SSOToken is invalid.

PolicyException - if there are problems getting these values.

search

protected org.forgerock.opendj.ldif.ConnectionEntryReader search(String searchFilter,
                                                                 org.forgerock.opendj.ldap.Connection ld,
                                                                 String... attributeNames)

getDisplayNameForValue

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

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()

Returns the values that was set using the method setValues.

Specified by:

getValues in interface Subject

Returns:

values that have been set for the user collection

setValues

public void setValues(Set names)
               throws InvalidNameException

Sets the names for the instance of the LDAPUsers object. The names are obtained from the policy object, usually configured when a policy is created.

Specified by:

setValues in interface Subject

Parameters:

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

Throws:

InvalidNameException - if the given names are not valid

isMember

public boolean isMember(SSOToken token)
                 throws SSOException,
                        PolicyException

Determines if the user belongs to this instance of the LDAPUsers object.

Specified by:

isMember in interface Subject

Parameters:

token - single-sign-on token of the user

Returns:

true if the user is memeber of the given 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()

Return a hash code for this LDAPUsers.

Overrides:

hashCode in class Object

Returns:

a hash code for this LDAPUsers object.

equals

public boolean equals(Object o)

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()

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