|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserManager
The UserManager
provides access to and means to maintain
authoriable objects
i.e. users
and
groups
. The UserManager
is bound to a particular
Session
.
Field Summary | |
---|---|
static int |
SEARCH_TYPE_AUTHORIZABLE
Filter flag indicating that all Authorizable s should be
searched. |
static int |
SEARCH_TYPE_GROUP
Filter flag indicating that only Group s should be searched
and returned. |
static int |
SEARCH_TYPE_USER
Filter flag indicating that only User s should be searched
and returned. |
Method Summary | |
---|---|
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 userID that authenitcates with the given Credentials and returns the specified
Principal upon Authorizable.getPrincipal() . |
Iterator |
findAuthorizables(String propertyName,
String value)
Returns all Authorizable s that have
property with the given name and
that Property equals the given value. |
Iterator |
findAuthorizables(String propertyName,
String value,
int searchType)
Returns all Authorizable s 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. |
Field Detail |
---|
static final int SEARCH_TYPE_USER
User
s should be searched
and returned.
static final int SEARCH_TYPE_GROUP
Group
s should be searched
and returned.
static final int SEARCH_TYPE_AUTHORIZABLE
Authorizable
s should be
searched.
Method Detail |
---|
Authorizable getAuthorizable(String id) throws RepositoryException
id
-
null
, if not present.
RepositoryException
Authorizable.getID()
Authorizable getAuthorizable(Principal principal) throws RepositoryException
principal
-
null
, if not present.
RepositoryException
Iterator findAuthorizables(String propertyName, String value) throws RepositoryException
Authorizable
s that have
property
with the given name and
that Property equals the given value.
propertyName
- value
-
Authorizable
s that have a property with the given
name exactly matching the given value.
RepositoryException
Authorizable.getProperty(String)
Iterator findAuthorizables(String propertyName, String value, int searchType) throws RepositoryException
Authorizable
s 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.
propertyName
- value
- searchType
- Any of the following constants:
RepositoryException
User createUser(String userID, String password) throws AuthorizableExistsException, RepositoryException
null
.createUser(String,String,Principal,String)
where
the specified userID is equal to the principal name and the intermediate
path is null
.
userID
- password
- The initial password of this user.
User
.
AuthorizableExistsException
- in case the given userID is already
in use or another Authorizable with the same principal name exists.
RepositoryException
- If another error occurs.User createUser(String userID, String password, Principal principal, String intermediatePath) throws AuthorizableExistsException, RepositoryException
Credentials
and returns the specified
Principal upon Authorizable.getPrincipal()
. If the implementation is not
able to deal with the itermediatePath
that parameter should
be ignored.
Except for the itermediatePath
, neither of the specified
parameters can be null
.
userID
- password
- principal
- intermediatePath
-
User
.
AuthorizableExistsException
- in case the given userID is already
in use or another Authorizable with the same principal name exists.
RepositoryException
- If the current Session is
not allowed to create users or some another error occurs.Group createGroup(Principal principal) throws AuthorizableExistsException, RepositoryException
Group
that is based on the given principal.
principal
- A non-null Principal
Group
.
AuthorizableExistsException
- in case the given groupID is already
in use or another Authorizable with the same principal name exists.
RepositoryException
- If another error occurs.Group createGroup(Principal principal, String intermediatePath) throws AuthorizableExistsException, RepositoryException
Group
that is based on the given principal
and the specified itermediatePath
hint. If the implementation is not
able to deal with the itermediatePath
that parameter should
be ignored.
principal
- intermediatePath
-
Group
.
AuthorizableExistsException
- in case the given groupID is already
in use or another Authorizable with the same principal name exists.
RepositoryException
- If another error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |