org.jahia.services.usermanager

Class BaseJahiaExternalUser

java.lang.Object

org.jahia.services.usermanager.BaseJahiaExternalUser

All Implemented Interfaces:

Serializable, Principal, JahiaPrincipal, JahiaUser

Deprecated.

@Deprecated
public abstract class BaseJahiaExternalUser
extends Object
implements JahiaUser

Represent a base class for an external user. This class is keep to maintain compatibility with olds users/groups providers

Author:

Sergiy Shyrkov

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected UserProperties	externalProperties Deprecated.
protected String	password Deprecated.
protected String	path Deprecated.
protected UserProperties	properties Deprecated.
protected String	providerKey Deprecated.
protected String	userKey Deprecated.
protected String	username Deprecated.

Constructor Summary

Constructors

Constructor and Description
BaseJahiaExternalUser(String providerKey, String username, String userKey) Deprecated. Initializes an instance of this class.
BaseJahiaExternalUser(String providerKey, String username, String userKey, UserProperties externalProperties) Deprecated. Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object another) Deprecated.
UserProperties	getExternalProperties() Deprecated.
String	getLocalPath() Deprecated. Get the path of this user in the local store.
String	getName() Deprecated.
Properties	getProperties() Deprecated. Get user's properties list.
String	getProperty(String key) Deprecated. Retrieve the requested user property.
protected JahiaUserManagerProvider	getProvider() Deprecated.
String	getProviderName() Deprecated. Get the name of the provider of this user.
String	getRealm() Deprecated. Get the realm name this user belongs to.
String	getUserKey() Deprecated. Return the unique String identifier of this user.
String	getUsername() Deprecated. Return the user username.
UserProperties	getUserProperties() Deprecated. Returns the users properties format, in which we can test if a property is read-only or not.
UserProperty	getUserProperty(String key) Deprecated. Retrieves the user property object, so that we can test is the property is read-only or not.
int	hashCode() Deprecated.
protected UserProperties	initializeMergedProperties() Deprecated.
boolean	isAccountLocked() Deprecated. Checks if the account is locked
boolean	isAdminMember(int siteID) Deprecated. Test if the user is an admin member
boolean	isMemberOfGroup(int siteID, String name) Deprecated. Test if the user is member of the specified group.
boolean	isRoot() Deprecated. Test if the user is the root user
boolean	removeProperty(String key) Deprecated. Remove the specified property from the properties list.
protected abstract boolean	removePropertyExternal(String key) Deprecated.
protected boolean	removePropertyInternal(String key) Deprecated.
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.
protected abstract boolean	setPropertyExternal(String key, String value) Deprecated.
protected boolean	setPropertyInternal(String key, String value) Deprecated.
String	toString() Deprecated.
boolean	verifyPassword(String passwordToVerify) Deprecated. Verify if the passed in password is the same as the encapsulated by this user.
protected boolean	verifyPasswordExternal(String password) Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jahia.services.usermanager.JahiaUser

setPassword

Methods inherited from interface java.security.Principal

implies

Field Detail

externalProperties

protected UserProperties externalProperties

Deprecated.

password

protected String password

Deprecated.

path

protected String path

Deprecated.

properties

protected UserProperties properties

Deprecated.

providerKey

protected String providerKey

Deprecated.

userKey

protected String userKey

Deprecated.

username

protected String username

Deprecated.

Constructor Detail

BaseJahiaExternalUser

public BaseJahiaExternalUser(String providerKey,
                             String username,
                             String userKey)

Deprecated.

Initializes an instance of this class.

Parameters:

providerKey - the corresponding provider key

username - the user name

userKey - the key of this user

BaseJahiaExternalUser

public BaseJahiaExternalUser(String providerKey,
                             String username,
                             String userKey,
                             UserProperties externalProperties)

Deprecated.

Initializes an instance of this class.

Parameters:

providerKey - the corresponding provider key

username - the user name

userKey - the key of this user

externalProperties - the user properties in the external storage system

Method Detail

equals

public boolean equals(Object another)

Deprecated.

Specified by:

equals in interface Principal

Overrides:

equals in class Object

getExternalProperties

public UserProperties getExternalProperties()

Deprecated.

getLocalPath

public String getLocalPath()

Deprecated.

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

getName

public String getName()

Deprecated.

Specified by:

getName in interface Principal

getProperties

public Properties getProperties()

Deprecated.

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.

getProperty

public String getProperty(String key)

Deprecated.

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.

getProvider

protected JahiaUserManagerProvider getProvider()

Deprecated.

getProviderName

public String getProviderName()

Deprecated.

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

getUserKey

public String getUserKey()

Deprecated.

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.

getUsername

public String getUsername()

Deprecated.

Description copied from interface: JahiaUser

Return the user username.

Specified by:

getUsername in interface JahiaUser

Returns:

Return the username.

getUserProperties

public UserProperties getUserProperties()

Deprecated.

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

getUserProperty

public UserProperty getUserProperty(String key)

Deprecated.

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

hashCode

public int hashCode()

Deprecated.

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

initializeMergedProperties

protected UserProperties initializeMergedProperties()

Deprecated.

isAdminMember

public boolean isAdminMember(int siteID)

Deprecated.

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.

isMemberOfGroup

public boolean isMemberOfGroup(int siteID,
                               String name)

Deprecated.

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.

isRoot

public final boolean isRoot()

Deprecated.

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.

removeProperty

public boolean removeProperty(String key)

Deprecated.

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

removePropertyExternal

protected abstract boolean removePropertyExternal(String key)

Deprecated.

removePropertyInternal

protected boolean removePropertyInternal(String key)

Deprecated.

setProperty

public boolean setProperty(String key,
                           String value)

Deprecated.

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

setPropertyExternal

protected abstract boolean setPropertyExternal(String key,
                                               String value)

Deprecated.

setPropertyInternal

@Deprecated
protected boolean setPropertyInternal(String key,
                                                  String value)

Deprecated.

toString

public String toString()

Deprecated.

Specified by:

toString in interface Principal

Overrides:

toString in class Object

verifyPassword

public boolean verifyPassword(String passwordToVerify)

Deprecated.

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:

passwordToVerify - 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.

verifyPasswordExternal

protected boolean verifyPasswordExternal(String password)

Deprecated.

isAccountLocked

public boolean isAccountLocked()

Deprecated.

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()

Deprecated.

Description copied from interface: JahiaUser

Get the realm name this user belongs to.

Specified by:

getRealm in interface JahiaUser

Returns: