info.magnolia.cms.security.auth
Interface Entity

All Superinterfaces:

java.security.Principal, java.io.Serializable

All Known Implementing Classes:

EntityImpl

public interface Entity
extends java.security.Principal, java.io.Serializable

A user entity. Defines some standard properties as user name or language.

Author:

Sameer Charles $Id: Entity.java 41137 2011-01-06 18:19:25Z gjoseph $

Field Summary

static java.lang.String	ADDRESS_LINE
static java.lang.String	EMAIL
static java.lang.String	FULL_NAME
static java.lang.String	LANGUAGE
static java.lang.String	LOCALE
static java.lang.String	NAME
static java.lang.String	PASSWORD

Method Summary

void	addProperty(java.lang.String key, java.lang.Object value)
java.lang.String	getName()
java.lang.Object	getProperty(java.lang.String key)
void	setName(java.lang.String name) Deprecated. not used - use addProperty(Entity.NAME)

Methods inherited from interface java.security.Principal

equals, hashCode, toString

Field Detail

FULL_NAME

static final java.lang.String FULL_NAME

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

EMAIL

static final java.lang.String EMAIL

See Also:

Constant Field Values

LANGUAGE

static final java.lang.String LANGUAGE

See Also:

Constant Field Values

LOCALE

static final java.lang.String LOCALE

See Also:

Constant Field Values

ADDRESS_LINE

static final java.lang.String ADDRESS_LINE

See Also:

Constant Field Values

PASSWORD

static final java.lang.String PASSWORD

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Specified by:

getName in interface java.security.Principal

Returns:

the name of the entity, or a default value if no name was set.

setName

void setName(java.lang.String name)

Deprecated. not used - use addProperty(Entity.NAME)

addProperty

void addProperty(java.lang.String key,
                 java.lang.Object value)

getProperty

java.lang.Object getProperty(java.lang.String key)

Returns:

the property's value, or null if undefined