org.apache.airavata.common.registry.api.user
Interface UserManager

public interface UserManager

Field Summary

static int	SEARCH_TYPE_AUTHORIZABLE Filter flag indicating that all Authorizables should be searched.
static int	SEARCH_TYPE_GROUP Filter flag indicating that only Groups should be searched and returned.
static int	SEARCH_TYPE_USER Filter flag indicating that only Users should be searched and returned.

Method Summary

void	autoSave(boolean enable) Changes the auto save behavior of this UserManager.
Group	createGroup(Principal principal) Creates a new Group that is based on the given principal.
Group	createGroup(Principal principal, String intermediatePath) Creates a new Group that is based on the given principal and the specified itermediatePath hint.
User	createUser(String userID, String password) Creates an User for the given userID / password pair; neither of the specified parameters can be null. Same as createUser(String,String,Principal,String) where the specified userID is equal to the principal name and the intermediate path is null.
User	createUser(String userID, String password, Principal principal, String intermediatePath) Creates an User for the given parameters.
Iterator<Authorizable>	findAuthorizables(String propertyName, String value) Returns all Authorizables that have property with the given name and that Property equals the given value.
Iterator<Authorizable>	findAuthorizables(String propertyName, String value, int searchType) Returns all Authorizables that have property with the given name and that Property equals the given value.
Authorizable	getAuthorizable(Principal principal) Get the Authorizable by its main Principal.
Authorizable	getAuthorizable(String id) Get the Authorizable by its id.
JCRRegistry	getRepository()
boolean	isAutoSave() If any write operations executed through the User API are automatically persisted this method returns true.
void	setRepository(JCRRegistry repository)

Field Detail

SEARCH_TYPE_USER

static final int SEARCH_TYPE_USER

Filter flag indicating that only Users should be searched and returned.

See Also:

Constant Field Values

SEARCH_TYPE_GROUP

static final int SEARCH_TYPE_GROUP

Filter flag indicating that only Groups should be searched and returned.

See Also:

Constant Field Values

SEARCH_TYPE_AUTHORIZABLE

static final int SEARCH_TYPE_AUTHORIZABLE

Filter flag indicating that all Authorizables should be searched.

See Also:

Constant Field Values

Method Detail

getAuthorizable

Authorizable getAuthorizable(String id)
                             throws javax.jcr.RepositoryException

Get the Authorizable by its id.

Parameters:

id - The user or group id.

Returns:

Authorizable or null, if not present.

Throws:

javax.jcr.RepositoryException - If an error occurs.

See Also:

Authorizable.getID()

getAuthorizable

Authorizable getAuthorizable(Principal principal)
                             throws javax.jcr.RepositoryException

Get the Authorizable by its main Principal.

Parameters:

principal -

Returns:

Authorizable or null, if not present.

Throws:

javax.jcr.RepositoryException - If an error occurs.

findAuthorizables

Iterator<Authorizable> findAuthorizables(String propertyName,
                                         String value)
                                         throws javax.jcr.RepositoryException

Returns all Authorizables that have property with the given name and that Property equals the given value.

Parameters:

propertyName -

value -

Returns:

All Authorizables that have a property with the given name exactly matching the given value.

Throws:

javax.jcr.RepositoryException - If an error occurs.

See Also:

Authorizable.getProperty(String)

findAuthorizables

Iterator<Authorizable> findAuthorizables(String propertyName,
                                         String value,
                                         int searchType)
                                         throws javax.jcr.RepositoryException

Returns all Authorizables that have property with the given name and that Property equals the given value. In contrast to findAuthorizables(String, String) the type of authorizable is respected while executing the search.

Parameters:

propertyName -

value -

searchType - Any of the following constants:

• SEARCH_TYPE_AUTHORIZABLE
• SEARCH_TYPE_GROUP
• SEARCH_TYPE_USER

Returns:

An iterator of Authorizable.

Throws:

javax.jcr.RepositoryException - If an error occurs.

createUser

User createUser(String userID,
                String password)
                throws AuthorizableExistsException,
                       javax.jcr.RepositoryException

Creates an User for the given userID / password pair; neither of the specified parameters can be null.
Same as createUser(String,String,Principal,String) where the specified userID is equal to the principal name and the intermediate path is null.

Parameters:

userID - The id of the new user.

password - The initial password of this user.

Returns:

The new User.

Throws:

AuthorizableExistsException - in case the given userID is already in use or another Authorizable with the same principal name exists.

javax.jcr.RepositoryException - If another error occurs.

createUser

User createUser(String userID,
                String password,
                Principal principal,
                String intermediatePath)
                throws AuthorizableExistsException,
                       javax.jcr.RepositoryException

Creates an User for the given parameters. If the implementation is not able to deal with the intermediatePath that parameter should be ignored. Except for the intermediatePath, neither of the specified parameters can be null.

Parameters:

userID -

password -

principal -

intermediatePath -

Returns:

The new User.

Throws:

AuthorizableExistsException - in case the given userID is already in use or another Authorizable with the same principal name exists.

javax.jcr.RepositoryException - If the current Session is not allowed to create users or some another error occurs.

createGroup

Group createGroup(Principal principal)
                  throws AuthorizableExistsException,
                         javax.jcr.RepositoryException

Creates a new Group that is based on the given principal. Note that the group's ID is implementation specific. The implementation may take the principal name as ID hint but must in any case assert that it is unique among the IDs known to this manager.

Parameters:

principal - A non-null Principal

Returns:

The new Group.

Throws:

AuthorizableExistsException - in case the given principal is already in use with another Authorizable.

javax.jcr.RepositoryException - If another error occurs.

createGroup

Group createGroup(Principal principal,
                  String intermediatePath)
                  throws AuthorizableExistsException,
                         javax.jcr.RepositoryException

Creates a new Group that is based on the given principal and the specified itermediatePath hint. If the implementation is not able to deal with the itermediatePath this parameter should be ignored.

Parameters:

principal -

intermediatePath -

Returns:

The new Group.

Throws:

AuthorizableExistsException - in case the given principal is already in use with another Authorizable.

javax.jcr.RepositoryException - If another error occurs.

isAutoSave

boolean isAutoSave()
                   throws javax.jcr.RepositoryException

If any write operations executed through the User API are automatically persisted this method returns true. In this case there are no pending transient changes left and there is no need to explicitely call Session.save(). If this method returns false any changes must be completed by an extra save call on the Session associated with this UserManager.

Returns:

true if changes are automatically persisted; false if changes made through this API (including method calls on Authorizable and subclasses are only transient and must be persisted using Session.save().

Throws:

javax.jcr.RepositoryException

See Also:

autoSave(boolean)

autoSave

void autoSave(boolean enable)
              throws javax.jcr.UnsupportedRepositoryOperationException,
                     javax.jcr.RepositoryException

Changes the auto save behavior of this UserManager.

Note, that this shouldn't be allowed in cases where the associated session is different from the original session accessing the user manager.

Parameters:

enable - If true changes made through this API will be automatically saved; otherwise an explict call to Session.save() is required in order to persist changes.

Throws:

javax.jcr.UnsupportedRepositoryOperationException - If the implementation does not allow to change the auto save behavior.

javax.jcr.RepositoryException - If some other error occurs.

setRepository

void setRepository(JCRRegistry repository)

getRepository

JCRRegistry getRepository()