Package com.day.cq.security

Interface User

All Superinterfaces:

Adaptable, Authorizable

public interface User
extends Authorizable

Deprecated.

cq 5.5 Use org.apache.jackrabbit.api.security.user.User instead.

A User is an Authorizable that may Authenticate. This User authenticates by its Password. It therefor extends the Authorizable by a method to save a Password

See Also:

Authorizable

Field Summary

Fields inherited from interface com.day.cq.security.Authorizable

PROPERTY_DESCRIPTION, PROPERTY_EMAIL, PROPERTY_FIRST_NAME, PROPERTY_ID, PROPERTY_IMPERSONATORS, PROPERTY_LAST_NAME, PROPERTY_NAME, PROPERTY_PASSWORD, PROPERTY_PRINCIPAL

Method Summary

Modifier and Type	Method	Description
void	changePassword(java.lang.String password)	Deprecated. changePassword.
void	disable(java.lang.String reason)	Deprecated. disable.
java.lang.String	getDisabledReason()	Deprecated. getDisabledReason.
java.util.Iterator<? extends Authorizable>	getImpersonators()	Deprecated. Access all Authorizables that are allowed to impersonate as this User.
java.util.Iterator<java.lang.String>	getSudoableUsers()	Deprecated. Return the Ids of all Authorizables that this User is allowed to impersonate as
boolean	grantImpersonation(Authorizable authorizable)	Deprecated. Grant an Authorizable the privilege to impersonate as this User. NOTE: you can't grant impersonation from the User to the User itself.
boolean	isDisabled()	Deprecated. isDisabled.
boolean	revokeImpersonation(Authorizable authorizable)	Deprecated. Revoke the given Authorizanle the privilege to impersonate as this User. NOTE: you can't revoke impersonation from the User to the User itself.
void	setPassword(java.lang.String password, java.lang.String digest)	Deprecated.

Methods inherited from interface org.apache.sling.api.adapter.Adaptable

adaptTo

Methods inherited from interface com.day.cq.security.Authorizable

getHomePath, getID, getName, getPrincipal, getPrivilege, getPrivileges, getProfile, getProperty, getPropertyNames, grantPrivilege, hasPermission, hasPermissionOn, isUser, memberOf, remove, removeProperty, revokePrivilege, setProperty

Method Detail

grantImpersonation

boolean grantImpersonation(Authorizable authorizable)
                    throws javax.jcr.AccessDeniedException

Deprecated.

Grant an Authorizable the privilege to impersonate as this User.
NOTE: you can't grant impersonation from the User to the User itself. Implementations have to return false in this case.

Parameters:

authorizable - the Impersonation should be granted

Returns:

true if newly added.

Throws:

javax.jcr.AccessDeniedException - if privileges are not sufficient

revokeImpersonation

boolean revokeImpersonation(Authorizable authorizable)
                     throws javax.jcr.AccessDeniedException

Deprecated.

Revoke the given Authorizanle the privilege to impersonate as this User.
NOTE: you can't revoke impersonation from the User to the User itself.

Parameters:

authorizable - to remove the Privilege

Returns:

true if tha given Authoirzable has had the privilege

Throws:

javax.jcr.AccessDeniedException - in case the caller does not the permission to perform this action

getImpersonators

java.util.Iterator<? extends Authorizable> getImpersonators()

Deprecated.

Access all Authorizables that are allowed to impersonate as this User. The collection will only contain the Authorizables the caller has permissions to read

Returns:

Authorizables allowed to impersonate as this User

getSudoableUsers

java.util.Iterator<java.lang.String> getSudoableUsers()

Deprecated.

Return the Ids of all Authorizables that this User is allowed to impersonate as

Returns:

list of all IDs of User it may be allowed to sudo

setPassword

@Deprecated
void setPassword(java.lang.String password,
                 java.lang.String digest)
          throws java.security.NoSuchAlgorithmException,
                 javax.jcr.AccessDeniedException

Deprecated.

setPassword.

Parameters:

password - considered plain

digest - to use for encryption of the given password.

Throws:

java.security.NoSuchAlgorithmException - if the digest is not registered as a MessageDigest

javax.jcr.AccessDeniedException - In case of missing permissions.

changePassword

void changePassword(java.lang.String password)

Deprecated.

changePassword.

Parameters:

password - considered plain

disable

void disable(java.lang.String reason)
      throws javax.jcr.RepositoryException

Deprecated.

disable.

Parameters:

reason - a String object.

Throws:

javax.jcr.RepositoryException - if any.

Since:

5.4

See Also:

User.disable(String)

isDisabled

boolean isDisabled()
            throws javax.jcr.RepositoryException

Deprecated.

isDisabled.

Returns:

a boolean.

Throws:

javax.jcr.RepositoryException - if any.

Since:

5.4

See Also:

User.isDisabled()

getDisabledReason

java.lang.String getDisabledReason()
                            throws javax.jcr.RepositoryException

Deprecated.

getDisabledReason.

Returns:

a String object.

Throws:

javax.jcr.RepositoryException - if any.

Since:

5.4

See Also:

User.getDisabledReason()