Interface Authorizable
-
@ProviderType public interface Authorizable
The Authorizable is the common base interface forUser
andGroup
. It provides access to thePrincipal
s associated with anAuthorizable
(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
andPrincipal
:
AnAuthorizable
is repository object that is neither associated with nor depending from a particularSession
and thus independent of the login mechanisms creatingSession
s.
On the other hand
Principal
s are representations of user identities. In other words: eachPrincipal
within the set associated with the Session's Subject upon login represents an identity for that user. An the set ofPrincipal
s 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:
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NotNull java.util.Iterator<Group>
declaredMemberOf()
@NotNull java.lang.String
getID()
Return the implementation specific identifier for thisAuthorizable
.@NotNull java.lang.String
getPath()
Returns a JCR path if this authorizable instance is associated with an item that can be accessed by the editingSession
.@NotNull java.security.Principal
getPrincipal()
@Nullable Value[]
getProperty(@NotNull java.lang.String relPath)
Returns the values for the properties with the specified name ornull
.@NotNull java.util.Iterator<java.lang.String>
getPropertyNames()
Returns the names of properties present withthis
Authorizable not taking possible relative paths into consideration.@NotNull java.util.Iterator<java.lang.String>
getPropertyNames(@NotNull java.lang.String relPath)
Returns the names of properties present withthis
Authorizable at the specified relative path.boolean
hasProperty(@NotNull java.lang.String relPath)
Tests if a the property with specified name exists.boolean
isGroup()
@NotNull java.util.Iterator<Group>
memberOf()
void
remove()
Removes thisAuthorizable
, if the session has sufficient permissions.boolean
removeProperty(@NotNull java.lang.String relPath)
Removes the property with the given name.void
setProperty(@NotNull java.lang.String relPath, @Nullable Value value)
Set an arbitrary property to thisAuthorizable
.void
setProperty(@NotNull java.lang.String relPath, @Nullable Value[] value)
Set an arbitrary property to thisAuthorizable
.
-
-
-
Method Detail
-
getID
@NotNull @NotNull java.lang.String getID() throws RepositoryException
Return the implementation specific identifier for thisAuthorizable
. 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
@NotNull @NotNull java.security.Principal getPrincipal() throws RepositoryException
- Returns:
- a representation as Principal.
- Throws:
RepositoryException
- If an error occurs.
-
declaredMemberOf
@NotNull @NotNull java.util.Iterator<Group> declaredMemberOf() throws RepositoryException
- Returns:
- all
Group
s, this Authorizable is declared member of. - Throws:
RepositoryException
- If an error occurs.
-
memberOf
@NotNull @NotNull java.util.Iterator<Group> memberOf() throws RepositoryException
- Returns:
- all
Group
s, this Authorizable is member of included indirect group membership. - Throws:
RepositoryException
- If an error occurs.
-
remove
void remove() throws RepositoryException
Removes thisAuthorizable
, if the session has sufficient permissions. Note, that removing anAuthorizable
even if it listed as member of a Group or if still has members (this is a Group itself).- Throws:
RepositoryException
- If an error occurred and theAuthorizable
could not be removed.
-
getPropertyNames
@NotNull @NotNull java.util.Iterator<java.lang.String> getPropertyNames() throws RepositoryException
Returns the names of properties present withthis
Authorizable not taking possible relative paths into consideration. Same asgetPropertyNames(String)
where the specified string is ".".- Returns:
- names of properties.
- Throws:
RepositoryException
- If an error occurs.- See Also:
where the specified relative path is simply an name.
,hasProperty(String)
-
getPropertyNames
@NotNull @NotNull java.util.Iterator<java.lang.String> getPropertyNames(@NotNull @NotNull java.lang.String relPath) throws RepositoryException
Returns the names of properties present withthis
Authorizable at the specified relative path.- Parameters:
relPath
- A relative path.- Returns:
- names of properties.
- Throws:
RepositoryException
- If an error occurs.- See Also:
getProperty(String)
,hasProperty(String)
-
hasProperty
boolean hasProperty(@NotNull @NotNull java.lang.String relPath) throws RepositoryException
Tests if a the property with specified name exists.- Parameters:
relPath
- The relative path to 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(@NotNull @NotNull java.lang.String relPath, @Nullable @Nullable Value value) throws RepositoryException
Set an arbitrary property to thisAuthorizable
.- Parameters:
relPath
- The relative path 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(@NotNull @NotNull java.lang.String relPath, @Nullable @Nullable Value[] value) throws RepositoryException
Set an arbitrary property to thisAuthorizable
.- Parameters:
relPath
- The relative path of the property to be added or modified.value
- The desired property values.- Throws:
RepositoryException
- If the specified property could not be set.
-
getProperty
@Nullable @Nullable Value[] getProperty(@NotNull @NotNull java.lang.String relPath) throws RepositoryException
Returns the values for the properties with the specified name ornull
.- Parameters:
relPath
- Relative path 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(@NotNull @NotNull java.lang.String relPath) throws RepositoryException
Removes the property with the given name.- Parameters:
relPath
- Relative path (or name) of the property to be removed.- Returns:
- true If the property at the specified relPath was successfully removed; false if no such property was present.
- Throws:
RepositoryException
- If an error occurs.
-
getPath
@NotNull @NotNull java.lang.String getPath() throws UnsupportedRepositoryOperationException, RepositoryException
Returns a JCR path if this authorizable instance is associated with an item that can be accessed by the editingSession
.Throws
UnsupportedRepositoryOperationException
if this method is not supported or if there is no item associated with this authorizable that is accessible by the editingSession
.Throws
RepositoryException
if another error occurs while retrieving the path.- Returns:
- the path of the
Item
that corresponds to thisAuthorizable
. - Throws:
UnsupportedRepositoryOperationException
- If this method is not supported or if there exists no accessible item associated with thisAuthorizable
instance.RepositoryException
- If an error occurs while retrieving theItem
path.
-
-