org.apache.jackrabbit.api.security.user
Interface Authorizable

All Known Subinterfaces:

Group, User

public interface Authorizable

The Authorizable is the common base interface for User and Group. It provides access to the Principals associated with an Authorizable (see below) and allow to access and modify additional properties such as e.g. full name, e-mail or address.

Please note the difference between Authorizable and Principal:
An Authorizable is repository object that is neither associated with nor depending from a particular Session and thus independant of the login mechanisms creating Sessions.

On the other hand Principals 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 Principals may differ between different login mechanisms.

Consequently an one-to-many relationship exists between Authorizable and Principal (see also 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 Authorizables.

See Also:

User, Group

Method Summary

java.util.Iterator<Group>	declaredMemberOf()
java.lang.String	getID() Return the implementation specific identifer for this Authorizable.
java.security.Principal	getPrincipal()
Value[]	getProperty(java.lang.String name) Returns the values for the properties with the specified name or null.
java.util.Iterator<java.lang.String>	getPropertyNames() Returns the names of properties present with this Authorizable.
boolean	hasProperty(java.lang.String name) Tests if a the property with specified name exists.
boolean	isGroup()
java.util.Iterator<Group>	memberOf()
void	remove() Removes this Authorizable, if the session has sufficient permissions.
boolean	removeProperty(java.lang.String name) Removes the property with the given name.
void	setProperty(java.lang.String name, Value value) Set an arbitrary property to this Authorizable.
void	setProperty(java.lang.String name, Value[] value) Set an arbitrary property to this Authorizable.

Method Detail

getID

java.lang.String getID()
                       throws RepositoryException

Return the implementation specific identifer for this Authorizable. It could e.g. be a UserID or simply the principal name.

Returns:

Name of this Authorizable.

Throws:

RepositoryException - if an error occurs.

isGroup

boolean isGroup()

Returns:

if the current Authorizable is a Group

getPrincipal

java.security.Principal getPrincipal()
                                     throws RepositoryException

Returns:

a representation as Principal.

Throws:

RepositoryException - If an error occurs.

declaredMemberOf

java.util.Iterator<Group> declaredMemberOf()
                                           throws RepositoryException

Returns:

all Groups, this Authorizable is declared member of.

Throws:

RepositoryException - If an error occurs.

memberOf

java.util.Iterator<Group> memberOf()
                                   throws RepositoryException

Returns:

all Groups, this Authorizable is member of included indirect group membership.

Throws:

RepositoryException - If an error occurs.

remove

void remove()
            throws RepositoryException

Removes this 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).

Throws:

RepositoryException - If an error occured and the Authorizable could not be removed.

getPropertyNames

java.util.Iterator<java.lang.String> getPropertyNames()
                                                      throws RepositoryException

Returns the names of properties present with this Authorizable.

Returns:

names of properties.

Throws:

RepositoryException - If an error occurs.

See Also:

getProperty(String), hasProperty(String)

hasProperty

boolean hasProperty(java.lang.String name)
                    throws RepositoryException

Tests if a the property with specified name exists.

Parameters:

name - The name of the property to be tested.

Returns:

true if a property with the given name exists.

Throws:

RepositoryException - If an error occurs.

See Also:

getProperty(String)

setProperty

void setProperty(java.lang.String name,
                 Value value)
                 throws RepositoryException

Set an arbitrary property to this Authorizable.

Parameters:

name - The name of the property to be added or modified.

value - The desired value.

Throws:

RepositoryException - If the specified property could not be set.

setProperty

void setProperty(java.lang.String name,
                 Value[] value)
                 throws RepositoryException

Set an arbitrary property to this Authorizable.

Parameters:

name - The name of the property to be added or modified.

value - The desired property values.

Throws:

RepositoryException - If the specified property could not be set.

getProperty

Value[] getProperty(java.lang.String name)
                    throws RepositoryException

Returns the values for the properties with the specified name or null.

Parameters:

name - The name of the property to be retrieved.

Returns:

value of the property with the given name or null if no such property exists.

Throws:

RepositoryException - If an error occurs.

removeProperty

boolean removeProperty(java.lang.String name)
                       throws RepositoryException

Removes the property with the given name.

Parameters:

name - The name of the property to be removed.

Returns:

true If the property with the specified name was successfully removed; false if no such property was present.

Throws:

RepositoryException - If an error occurs.