org.jahia.services.usermanager

Interface JahiaUser

All Superinterfaces:

JahiaPrincipal, Principal, Serializable

All Known Implementing Classes:

BaseJahiaExternalUser, JahiaUserImpl

public interface JahiaUser
extends JahiaPrincipal

A JahiaUser represents a physical person who is defined by a username and a password for authentication purpose. Every other property of a JahiaUser is stored in it's properties list, which hold key-value string pairs. For example email, firstname, lastname, ... information should be stored in this properties list.

Author:

Fulco Houkes, Khue Nguyen

Method Summary

Modifier and Type	Method and Description
String	getLocalPath() Get the path of this user in the local store.
Properties	getProperties() Get user's properties list.
String	getProperty(String key) Retrieve the requested user property.
String	getProviderName() Get the name of the provider of this user.
String	getRealm() Get the realm name this user belongs to.
String	getUserKey() Return the unique String identifier of this user.
String	getUsername() Return the user username.
UserProperties	getUserProperties() Deprecated.
UserProperty	getUserProperty(String key) Deprecated.
boolean	isAccountLocked() Checks if the account is locked
boolean	isAdminMember(int siteID) Deprecated.
boolean	isMemberOfGroup(int siteID, String name) Deprecated.
boolean	isRoot() Test if the user is the root user
boolean	removeProperty(String key) Deprecated.
boolean	setPassword(String password) Deprecated.
boolean	setProperty(String key, String value) Deprecated.
boolean	verifyPassword(String password) Deprecated.

Methods inherited from interface java.security.Principal

equals, getName, hashCode, implies, toString

Method Detail

getUsername

String getUsername()

Return the user username.

Returns:

Return the username.

getUserKey

String getUserKey()

Return the unique String identifier of this user.

Returns:

the unique String identifier of this user.

getProperties

Properties getProperties()

Get user's properties list. The properties here should not be modified, as the modifications will not be serialized. Use the setProperty() method to modify a user's properties.

Returns:

Return a reference on the user's properties list, or null if no property is present.

getUserProperties

UserProperties getUserProperties()

Deprecated.

Returns the users properties format, in which we can test if a property is read-only or not. The properties here should not be modified, as the modifications will not be serialized. Use the setProperty() method to modify a user's properties.

Returns:

UserProperties

getProperty

String getProperty(String key)

Retrieve the requested user property.

Parameters:

key - Property's name.

Returns:

Return the property's value of the specified key, or null if the property does not exist.

getUserProperty

UserProperty getUserProperty(String key)

Deprecated.

Retrieves the user property object, so that we can test is the property is read-only or not.

Parameters:

key - String

Returns:

UserProperty

removeProperty

boolean removeProperty(String key)

Deprecated.

Remove the specified property from the properties list. This method can fail and do no modification if the property we are trying to set is read-only.

Parameters:

key - Property's name.

Returns:

true if everything went well

setProperty

boolean setProperty(String key,
                    String value)

Deprecated.

Add (or update if not already in the property list) a property key-value pair in the user's properties list. This method can fail and do no modification is the property we are trying to set is read-only.

Parameters:

key - Property's name.

value - Property's value.

Returns:

true if everything went well

setPassword

boolean setPassword(String password)

Deprecated.

Change the user's password.

Parameters:

password - New user's password

Returns:

Return true if the password was successfully changed, false otherwise

isMemberOfGroup

boolean isMemberOfGroup(int siteID,
                        String name)

Deprecated.

Test if the user is member of the specified group.

Parameters:

name - Groupname.

siteID - the site id

Returns:

Return true if the user is member of the specified group, or false on any error.

isAdminMember

boolean isAdminMember(int siteID)

Deprecated.

Test if the user is an admin member

Parameters:

siteID - the site id

Returns:

Return true if the user is an admin member false on any error.

isRoot

boolean isRoot()

Test if the user is the root user

Returns:

Return true if the user is the root user false on any error.

verifyPassword

boolean verifyPassword(String password)

Deprecated.

Verify if the passed in password is the same as the encapsulated by this user.

Parameters:

password - String representation of an non-encrypted password.

Returns:

Return true if the passed in password is the same as the encapsulated password in this user, and return false on any error.

getProviderName

String getProviderName()

Get the name of the provider of this user.

Specified by:

getProviderName in interface JahiaPrincipal

Returns:

String representation of the name of the provider of this user

getLocalPath

String getLocalPath()

Get the path of this user in the local store. For examle for LDAP user this will return the path of the user in the JCR with all necessary encoding.

Specified by:

getLocalPath in interface JahiaPrincipal

Returns:

String representation of the name of the provider of this user

isAccountLocked

boolean isAccountLocked()

Checks if the account is locked

Returns:

true if the account is locked

getRealm

String getRealm()

Get the realm name this user belongs to.

Returns: