|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Authorizable
The Authorizable is the common base interface for User
and
Group
. It provides access to the Principal
s associated
with an Authorizable
(see below) and allow to access and
modify additional properties such as e.g. full name, e-mail or address.
Authorizable
and
Principal
:Authorizable
is repository object that is neither associated
with nor depending from a particular Session
and thus independant
of the login mechanisms creating Session
s.Principal
s are representations of user
identities. In other words: each Principal
within the set
associated with the Session's Subject upon login represents an identity for
that user. An the set of Principal
s may differ between different
login mechanisms.getPrincipal()
.
The interfaces derived from Authorizable are defined as follows:
User
: defined to be an authorizable that can be authenticated
(by using Credentials) and impersonated.Group
: defined to be a collection of other
Authorizable
s.
User
,
Group
Method Summary | |
---|---|
Iterator<Group> |
declaredMemberOf()
|
String |
getID()
Return the implementation specific identifer for this Authorizable . |
Principal |
getPrincipal()
|
Value[] |
getProperty(String name)
Returns the values for the properties with the specified name or null . |
Iterator<String> |
getPropertyNames()
Returns the names of properties present with this Authorizable. |
boolean |
hasProperty(String name)
Tests if a the property with specified name exists. |
boolean |
isGroup()
|
Iterator<Group> |
memberOf()
|
void |
remove()
Removes this Authorizable , if the session has sufficient
permissions. |
boolean |
removeProperty(String name)
Removes the property with the given name. |
void |
setProperty(String name,
Value value)
Set an arbitrary property to this Authorizable . |
void |
setProperty(String name,
Value[] value)
Set an arbitrary property to this Authorizable . |
Method Detail |
---|
String getID() throws RepositoryException
Authorizable
. It could e.g. be a UserID or simply the
principal name.
Authorizable
.
RepositoryException
- if an error occurs.boolean isGroup()
Group
Principal getPrincipal() throws RepositoryException
RepositoryException
- If an error occurs.Iterator<Group> declaredMemberOf() throws RepositoryException
Group
s, this Authorizable is declared member of.
RepositoryException
- If an error occurs.Iterator<Group> memberOf() throws RepositoryException
Group
s, this Authorizable is member of included
indirect group membership.
RepositoryException
- If an error occurs.void remove() throws RepositoryException
Authorizable
, if the session has sufficient
permissions. Note, that removing an Authorizable
even
if it listed as member of a Group or if still has members (this is
a Group itself).
RepositoryException
- If an error occured and the
Authorizable
could not be removed.Iterator<String> getPropertyNames() throws RepositoryException
this
Authorizable.
RepositoryException
- If an error occurs.getProperty(String)
,
hasProperty(String)
boolean hasProperty(String name) throws RepositoryException
name
- The name of the property to be tested.
true
if a property with the given name exists.
RepositoryException
- If an error occurs.getProperty(String)
void setProperty(String name, Value value) throws RepositoryException
Authorizable
.
name
- The name of the property to be added or modified.value
- The desired value.
RepositoryException
- If the specified property could not be set.void setProperty(String name, Value[] value) throws RepositoryException
Authorizable
.
name
- The name of the property to be added or modified.value
- The desired property values.
RepositoryException
- If the specified property could not be set.Value[] getProperty(String name) throws RepositoryException
null
.
name
- The name of the property to be retrieved.
null
if no such property exists.
RepositoryException
- If an error occurs.boolean removeProperty(String name) throws RepositoryException
name
- The name of the property to be removed.
RepositoryException
- If an error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |