com.communote.server.core.security

Class FieldUserIdentification

java.lang.Object

com.communote.server.core.security.FieldUserIdentification

All Implemented Interfaces:

UserIdentification

public class FieldUserIdentification
extends Object
implements UserIdentification

A UserIdentification that is map holding some attributes. For now only the alias is supported by the core. However other plugins may store additional attributes that ExternalUserRepos may interpret.

Author:

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

Constructor Summary

Constructors

Constructor and Description
FieldUserIdentification()

Method Summary

Modifier and Type	Method and Description
String	getExternalSystemId()
String	getExternalUserId()
Boolean	getIsSystemUser() States if this identification represents a system user.
ExternalUserVO	getPreviousExternalUser()
Map<String,Object>	getProperties()
String	getUserAlias()
Long	getUserId()
FieldUserIdentification	setExternalSystemId(String externalSystemId)
FieldUserIdentification	setExternalUserId(String externalUserId)
FieldUserIdentification	setIsSystemUser(Boolean isSystemUser)
FieldUserIdentification	setPreviousExternalUser(ExternalUserVO previousExternalUser) Also set the externalUserId if it has not been set before
FieldUserIdentification	setUserAlias(String userAlias)
FieldUserIdentification	setUserId(Long userId)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldUserIdentification

public FieldUserIdentification()

Method Detail

getExternalSystemId

public String getExternalSystemId()

Specified by:

getExternalSystemId in interface UserIdentification

Returns:

the external system id

getExternalUserId

public String getExternalUserId()

Specified by:

getExternalUserId in interface UserIdentification

Returns:

the external user id

getIsSystemUser

public Boolean getIsSystemUser()

States if this identification represents a system user. False means a definite no, true means a definite yes. Null means it cannot be said.

Specified by:

getIsSystemUser in interface UserIdentification

Returns:

True if the identification represents a system user, false if not and null if it can't be told.

getPreviousExternalUser

public ExternalUserVO getPreviousExternalUser()

Specified by:

getPreviousExternalUser in interface UserIdentification

Returns:

an external user with its data that has been authenticated and the data has been already obtained

getProperties

public Map<String,Object> getProperties()

Returns:

some addtional properties

getUserAlias

public String getUserAlias()

Specified by:

getUserAlias in interface UserIdentification

Returns:

the internal user alias

getUserId

public Long getUserId()

Specified by:

getUserId in interface UserIdentification

Returns:

the user id

setExternalSystemId

public FieldUserIdentification setExternalSystemId(String externalSystemId)

Parameters:

externalSystemId - the external system

Returns:

this

setExternalUserId

public FieldUserIdentification setExternalUserId(String externalUserId)

Parameters:

externalUserId - the id of the user in an external system

Returns:

this

setIsSystemUser

public FieldUserIdentification setIsSystemUser(Boolean isSystemUser)

Parameters:

isSystemUser - states if this identification represents a system user. false means a definite no, true means a definite yes. Null means it cannot be said.

Returns:

this

setPreviousExternalUser

public FieldUserIdentification setPreviousExternalUser(ExternalUserVO previousExternalUser)

Also set the externalUserId if it has not been set before

Parameters:

previousExternalUser - user information that have been obtained before

Returns:

this

setUserAlias

public FieldUserIdentification setUserAlias(String userAlias)

Parameters:

userAlias - the internal user alias

Returns:

this

setUserId

public FieldUserIdentification setUserId(Long userId)

Parameters:

userId - the user id

Returns:

this

toString

public String toString()

Overrides:

toString in class Object