org.apache.jackrabbit.api.security.user

Interface User

All Superinterfaces:

Authorizable

public interface User
extends Authorizable

User is a special Authorizable that can be authenticated and impersonated.

See Also:

getCredentials(), getImpersonation()

Method Summary

Modifier and Type	Method and Description
void	changePassword(@Nullable java.lang.String password) Change the password of this user.
void	changePassword(@Nullable java.lang.String password, @NotNull java.lang.String oldPassword) Change the password of this user.
void	disable(@Nullable java.lang.String reason) Disable this user thus preventing future login if the reason is a non-null String. Note however, that this user will still be accessible by UserManager.getAuthorizable(java.lang.String).
@NotNull Credentials	getCredentials() Returns the internal Credentials representation for this user.
@Nullable java.lang.String	getDisabledReason() Returns the String specified upon disabling this user or null if isDisabled() returns false.
@NotNull Impersonation	getImpersonation()
boolean	isAdmin()
boolean	isDisabled() Returns true if this user is disabled, false otherwise.
boolean	isSystemUser()

Methods inherited from interface org.apache.jackrabbit.api.security.user.Authorizable

declaredMemberOf, getID, getPath, getPrincipal, getProperty, getPropertyNames, getPropertyNames, hasProperty, isGroup, memberOf, remove, removeProperty, setProperty, setProperty

Method Detail

isAdmin

boolean isAdmin()

Returns:

true if the current user represents the administrator.

isSystemUser

boolean isSystemUser()

Returns:

true if the current user represents a system user.

getCredentials

@NotNull
@NotNull Credentials getCredentials()
                                      throws RepositoryException

Returns the internal Credentials representation for this user. This method is expected to be used for validation during the login process. However, the return value should neither be usable nor used for Repository.login(javax.jcr.Credentials, java.lang.String).

Returns:

Credentials for this user.

Throws:

RepositoryException - If an error occurs.

getImpersonation

@NotNull
@NotNull Impersonation getImpersonation()
                                          throws RepositoryException

Returns:

Impersonation for this User.

Throws:

RepositoryException - If an error occurs.

changePassword

void changePassword(@Nullable
                    @Nullable java.lang.String password)
             throws RepositoryException

Change the password of this user.

Parameters:

password - The new password.

Throws:

RepositoryException - If an error occurs.

changePassword

void changePassword(@Nullable
                    @Nullable java.lang.String password,
                    @NotNull
                    @NotNull java.lang.String oldPassword)
             throws RepositoryException

Change the password of this user.

Parameters:

password - The new password.

oldPassword - The old password.

Throws:

RepositoryException - If the old password doesn't match or if an error occurs.

disable

void disable(@Nullable
             @Nullable java.lang.String reason)
      throws RepositoryException

Disable this user thus preventing future login if the reason is a non-null String.
Note however, that this user will still be accessible by UserManager.getAuthorizable(java.lang.String).

Parameters:

reason - String describing the reason for disable this user or null if the user account should be enabled again.

Throws:

RepositoryException - If an error occurs.

isDisabled

boolean isDisabled()
            throws RepositoryException

Returns true if this user is disabled, false otherwise.

Returns:

true if this user is disabled, false otherwise.

Throws:

RepositoryException - If an error occurs.

getDisabledReason

@Nullable
@Nullable java.lang.String getDisabledReason()
                                                throws RepositoryException

Returns the String specified upon disabling this user or null if isDisabled() returns false.

Returns:

The reason specified upon disabling this user or null if this user is not disabled.

Throws:

RepositoryException - If an error occurs.