oracle.fatwire.sites.directory.custom

Interface UserDirectory

public interface UserDirectory

Implementations of this interface interacts with user directory like LDAP or a database. Many methods of this interface either accept or return a user id. This is a String that uniquely identifies the user in the directory. The unique id should be in the form of a String serialized CompoundName . Sites must be able to parse the user id based on the configuration settings in properties files. Implementation classes should implement at least a public constructor that has a single ICS argument. This ICS object should only be used for configuration of the class and should NOT store this object for continued use.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATOR_AND It is used to search the list of users that have all the matching criteria passed
static java.lang.String	OPERATOR_OR It is used to search the list of users that have 1 or more the matching criteria passed

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(java.lang.String username, char[] password) Try to authenticate the user with the supplied credentials.
void	deleteSite(java.lang.String site) Notification method that is invoked when Sites deletes a site.
void	flushCache() Invoked when Sites believes that caches need to be flushed.
java.lang.String	getACLsFromId(java.lang.String id) Retrieve the list of ACLs for the user.
java.lang.String	getIdFromUsername(java.lang.String username) Get the sole unique ID for this user identified by the username.
java.util.List<java.lang.String>	listUsers(javax.naming.directory.Attributes matchingAttributes, java.lang.String operator) Return all the users based on the criteria
void	readUser(UserFactory factory, java.lang.String id) Return a user from the user directory.
void	readUsers(UserFactory factory, java.lang.String[] id) Return multiple users from the user directory.
void	readUsers(UserFactory factory, java.lang.String role, java.lang.String... sites) Return the users that have the listed roles in the provided site.

Field Detail

OPERATOR_AND

static final java.lang.String OPERATOR_AND

It is used to search the list of users that have all the matching criteria passed

See Also:

Constant Field Values

OPERATOR_OR

static final java.lang.String OPERATOR_OR

It is used to search the list of users that have 1 or more the matching criteria passed

See Also:

Constant Field Values

Method Detail

authenticate

boolean authenticate(java.lang.String username,
                     char[] password)
              throws java.lang.Exception

Try to authenticate the user with the supplied credentials.

Parameters:

username - username for authentication

password - password for authentication

Returns:

true if the user was correctly authenticated.

Throws:

java.lang.Exception - when an error other than incorrect credentials occurs.

getIdFromUsername

java.lang.String getIdFromUsername(java.lang.String username)
                            throws java.lang.Exception

Get the sole unique ID for this user identified by the username.

Parameters:

username - username

Returns:

the unique user ID, null if no user can be found by the provided username.

Throws:

java.lang.Exception

getACLsFromId

java.lang.String getACLsFromId(java.lang.String id)
                        throws java.lang.Exception

Retrieve the list of ACLs for the user. ACLs in WebCenter Sites are not site specific but generic for the whole installation.

Parameters:

id - user id

Returns:

a comma separated list of ACLs.

Throws:

java.lang.Exception

readUser

void readUser(UserFactory factory,
              java.lang.String id)
       throws java.lang.Exception

Return a user from the user directory. Use the factory to populate the object that is used by Sites internally.

Parameters:

factory - to create and populate the user

id - user id

Throws:

java.lang.Exception

readUsers

void readUsers(UserFactory factory,
               java.lang.String role,
               java.lang.String... sites)
        throws java.lang.Exception

Return the users that have the listed roles in the provided site. The roles are the roles as Sites uses internally. An implementation can make mappings from their internal roles to Sites Roles.

Parameters:

factory - to create and populate the user

role - the role to search for, can be null meaning all roles.

sites - the sites to restrict the search to.

Throws:

java.lang.Exception

readUsers

void readUsers(UserFactory factory,
               java.lang.String[] id)
        throws java.lang.Exception

Return multiple users from the user directory.

Parameters:

factory - to create and populate the user

id - an array of user ids

Throws:

java.lang.Exception

deleteSite

void deleteSite(java.lang.String site)
         throws java.lang.Exception

Notification method that is invoked when Sites deletes a site. This may trigger maintenance operations on the user repository.

Parameters:

site - site name

Throws:

java.lang.Exception

flushCache

void flushCache()
         throws java.lang.Exception

Invoked when Sites believes that caches need to be flushed.

Throws:

java.lang.Exception

listUsers

java.util.List<java.lang.String> listUsers(javax.naming.directory.Attributes matchingAttributes,
                                           java.lang.String operator)
                                    throws java.lang.Exception

Return all the users based on the criteria

Parameters:

matchingAttributes - list of javax.naming.directory.Attribtues

operator - Determines if the matching entries must contain all (UserDirectory.OPERATOR_AND) or one or more (UserDirectory.OPERATOR_OR) of the specified attribute/value pairs.

Returns:

a list of user ids matching the criteria

Throws:

java.lang.Exception