com.communote.server.model.user

Class ExternalUserAuthentication

java.lang.Object

com.communote.server.model.user.ExternalUserAuthentication

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ExternalUserAuthenticationImpl

public abstract class ExternalUserAuthentication
extends Object
implements Serializable

This class represents external authentication details to a user. The systemId defines the system this id belongs to.

Author:

Communote GmbH - http://www.communote.com/

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalUserAuthentication.Factory Constructs new instances of ExternalUserAuthentication.

Constructor Summary

Constructors

Constructor and Description
ExternalUserAuthentication()

Method Summary

Modifier and Type	Method and Description
String	attributesToString() Builds a string showing the current attribute values
boolean	equals(Object object) Returns true if the argument is an ExternalUserAuthentication instance and all identifiers for this entity equal the identifiers of the argument entity.
String	getAdditionalProperty() an optional member holding some additional data for the user.
String	getExternalUserId() Contains the user id of a external authentication system.
Long	getId()
String	getPermanentId() optional attribute that represents a unique identifier of the user in the external repository whose value never changes.
String	getSystemId() Identifier of the external system (e.g.
int	hashCode() Returns a hash code based on this entity's identifiers.
void	setAdditionalProperty(String additionalProperty)
void	setExternalUserId(String externalUserId)
void	setId(Long id)
void	setPermanentId(String permanentId)
void	setSystemId(String systemId)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalUserAuthentication

public ExternalUserAuthentication()

Method Detail

attributesToString

public String attributesToString()

Builds a string showing the current attribute values

equals

public boolean equals(Object object)

Returns true if the argument is an ExternalUserAuthentication instance and all identifiers for this entity equal the identifiers of the argument entity. Returns false otherwise.

Overrides:

equals in class Object

getAdditionalProperty

public String getAdditionalProperty()

an optional member holding some additional data for the user. The interpretation depends on the external system. For LDAP it would hold the DN for example.

getExternalUserId

public String getExternalUserId()

Contains the user id of a external authentication system. This is typically the login of the user for the external system.

getId

public Long getId()

getPermanentId

public String getPermanentId()

optional attribute that represents a unique identifier of the user in the external repository whose value never changes. This allows handling a change of the externalUserId. This member can be null because not all external systems provide such an attribute.

getSystemId

public String getSystemId()

Identifier of the external system (e.g. Confluence XYZ).

hashCode

public int hashCode()

Returns a hash code based on this entity's identifiers.

Overrides:

hashCode in class Object

setAdditionalProperty

public void setAdditionalProperty(String additionalProperty)

setExternalUserId

public void setExternalUserId(String externalUserId)

setId

public void setId(Long id)

setPermanentId

public void setPermanentId(String permanentId)

setSystemId

public void setSystemId(String systemId)