org.jahia.services.usermanager

Class JahiaUserImpl

java.lang.Object

org.jahia.services.usermanager.JahiaUserImpl

All Implemented Interfaces:

Serializable, Principal, JahiaPrincipal, JahiaUser

public class JahiaUserImpl
extends Object
implements JahiaUser, Serializable

Represents a user with properties in Jahia.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JahiaUserImpl(String name, String path, Properties properties, boolean isRoot, String providerName) Initializes a global user.
JahiaUserImpl(String name, String path, Properties properties, boolean isRoot, String providerName, String realm) Initializes a realm-specific (site-specific) user.
JahiaUserImpl(String name, String path, Properties properties, String providerName) Initializes a global non-root user.
JahiaUserImpl(String name, String path, Properties properties, String providerName, String realm) Initializes a realm-specific (site-specific) non-root user.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getLocalPath() Get the path of this user in the local store.
String	getName()
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() Returns the users properties format, in which we can test if a property is read-only or not.
UserProperty	getUserProperty(String key) Retrieves the user property object, so that we can test is the property is read-only or not.
int	hashCode()
boolean	isAccountLocked() Checks if the account is locked
boolean	isAdminMember(int siteID) Test if the user is an admin member
boolean	isMemberOfGroup(int siteID, String name) Test if the user is member of the specified group.
boolean	isRoot() Test if the user is the root user
boolean	removeProperty(String key) Remove the specified property from the properties list.
boolean	setPassword(String password) Change the user's password.
boolean	setProperty(String key, String value) Add (or update if not already in the property list) a property key-value pair in the user's properties list.
boolean	verifyPassword(String password) Verify if the passed in password is the same as the encapsulated by this user.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.security.Principal

implies, toString

Constructor Detail

JahiaUserImpl

public JahiaUserImpl(String name,
                     String path,
                     Properties properties,
                     String providerName)

Initializes a global non-root user.

Parameters:

name - the user name

path - the JCR path of the user

properties - user properties

providerName - the name of the provider

JahiaUserImpl

public JahiaUserImpl(String name,
                     String path,
                     Properties properties,
                     boolean isRoot,
                     String providerName)

Initializes a global user.

Parameters:

name - the user name

path - the JCR path of the user

properties - user properties

isRoot - true for root user and false for everyone else

providerName - the name of the provider

JahiaUserImpl

public JahiaUserImpl(String name,
                     String path,
                     Properties properties,
                     String providerName,
                     String realm)

Initializes a realm-specific (site-specific) non-root user.

Parameters:

name - the user name

path - the JCR path of the user

properties - user properties

providerName - the name of the provider

realm - the key of the corresponding user realm (site)

JahiaUserImpl

public JahiaUserImpl(String name,
                     String path,
                     Properties properties,
                     boolean isRoot,
                     String providerName,
                     String realm)

Initializes a realm-specific (site-specific) user.

Parameters:

name - the user name

path - the JCR path of the user

properties - user properties

isRoot - true for root user and false for everyone else

providerName - the name of the provider

realm - the key of the corresponding user realm (site)

Method Detail

getUsername

public String getUsername()

Description copied from interface: JahiaUser

Return the user username.

Specified by:

getUsername in interface JahiaUser

Returns:

Return the username.

getUserKey

public String getUserKey()

Description copied from interface: JahiaUser

Return the unique String identifier of this user.

Specified by:

getUserKey in interface JahiaUser

Returns:

the unique String identifier of this user.

getProperties

public Properties getProperties()

Description copied from interface: JahiaUser

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.

Specified by:

getProperties in interface JahiaUser

Returns:

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

getUserProperties

public UserProperties getUserProperties()

Description copied from interface: JahiaUser

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.

Specified by:

getUserProperties in interface JahiaUser

Returns:

UserProperties

getProperty

public String getProperty(String key)

Description copied from interface: JahiaUser

Retrieve the requested user property.

Specified by:

getProperty in interface JahiaUser

Parameters:

key - Property's name.

Returns:

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

getUserProperty

public UserProperty getUserProperty(String key)

Description copied from interface: JahiaUser

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

Specified by:

getUserProperty in interface JahiaUser

Parameters:

key - String

Returns:

UserProperty

removeProperty

public boolean removeProperty(String key)

Description copied from interface: JahiaUser

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.

Specified by:

removeProperty in interface JahiaUser

Parameters:

key - Property's name.

Returns:

true if everything went well

setProperty

public boolean setProperty(String key,
                           String value)

Description copied from interface: JahiaUser

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.

Specified by:

setProperty in interface JahiaUser

Parameters:

key - Property's name.

value - Property's value.

Returns:

true if everything went well

setPassword

public boolean setPassword(String password)

Description copied from interface: JahiaUser

Change the user's password.

Specified by:

setPassword in interface JahiaUser

Parameters:

password - New user's password

Returns:

Return true if the password was successfully changed, false otherwise

isMemberOfGroup

public boolean isMemberOfGroup(int siteID,
                               String name)

Description copied from interface: JahiaUser

Test if the user is member of the specified group.

Specified by:

isMemberOfGroup in interface JahiaUser

Parameters:

siteID - the site id

name - Groupname.

Returns:

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

isAdminMember

public boolean isAdminMember(int siteID)

Description copied from interface: JahiaUser

Test if the user is an admin member

Specified by:

isAdminMember in interface JahiaUser

Parameters:

siteID - the site id

Returns:

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

isRoot

public boolean isRoot()

Description copied from interface: JahiaUser

Test if the user is the root user

Specified by:

isRoot in interface JahiaUser

Returns:

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

verifyPassword

public boolean verifyPassword(String password)

Description copied from interface: JahiaUser

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

Specified by:

verifyPassword in interface JahiaUser

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

public String getProviderName()

Description copied from interface: JahiaUser

Get the name of the provider of this user.

Specified by:

getProviderName in interface JahiaPrincipal

Specified by:

getProviderName in interface JahiaUser

Returns:

String representation of the name of the provider of this user

getName

public String getName()

Specified by:

getName in interface Principal

getLocalPath

public String getLocalPath()

Description copied from interface: JahiaUser

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

Specified by:

getLocalPath in interface JahiaUser

Returns:

String representation of the name of the provider of this user

isAccountLocked

public boolean isAccountLocked()

Description copied from interface: JahiaUser

Checks if the account is locked

Specified by:

isAccountLocked in interface JahiaUser

Returns:

true if the account is locked

getRealm

public String getRealm()

Description copied from interface: JahiaUser

Get the realm name this user belongs to.

Specified by:

getRealm in interface JahiaUser

Returns:

equals

public boolean equals(Object o)

Specified by:

equals in interface Principal

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object