fr.paris.lutece.portal.service.security
Class LuteceUser

java.lang.Object
  extended by fr.paris.lutece.portal.service.security.LuteceUser
All Implemented Interfaces:
java.io.Serializable, java.security.Principal
Direct Known Subclasses:
BasicLuteceUser

public abstract class LuteceUser
extends java.lang.Object
implements java.security.Principal, java.io.Serializable

This Interface defines all methods required for a Lutece user implementation

See Also:
Serialized Form

Field Summary
static java.lang.String ANONYMOUS_USERNAME
           
static java.lang.String BDATE
           
static java.lang.String BUSINESS_INFO_ONLINE_EMAIL
           
static java.lang.String BUSINESS_INFO_ONLINE_URI
           
static java.lang.String BUSINESS_INFO_POSTAL_CITY
           
static java.lang.String BUSINESS_INFO_POSTAL_COUNTRY
           
static java.lang.String BUSINESS_INFO_POSTAL_NAME
           
static java.lang.String BUSINESS_INFO_POSTAL_ORGANIZATION
           
static java.lang.String BUSINESS_INFO_POSTAL_POSTALCODE
           
static java.lang.String BUSINESS_INFO_POSTAL_STATEPROV
           
static java.lang.String BUSINESS_INFO_POSTAL_STREET
           
static java.lang.String BUSINESS_INFO_TELECOM_FAX_COMMENT
           
static java.lang.String BUSINESS_INFO_TELECOM_FAX_EXT
           
static java.lang.String BUSINESS_INFO_TELECOM_FAX_INTCODE
           
static java.lang.String BUSINESS_INFO_TELECOM_FAX_LOCCODE
           
static java.lang.String BUSINESS_INFO_TELECOM_FAX_NUMBER
           
static java.lang.String BUSINESS_INFO_TELECOM_MOBILE_COMMENT
           
static java.lang.String BUSINESS_INFO_TELECOM_MOBILE_EXT
           
static java.lang.String BUSINESS_INFO_TELECOM_MOBILE_INTCODE
           
static java.lang.String BUSINESS_INFO_TELECOM_MOBILE_LOCCODE
           
static java.lang.String BUSINESS_INFO_TELECOM_MOBILE_NUMBER
           
static java.lang.String BUSINESS_INFO_TELECOM_PAGER_COMMENT
           
static java.lang.String BUSINESS_INFO_TELECOM_PAGER_EXT
           
static java.lang.String BUSINESS_INFO_TELECOM_PAGER_INTCODE
           
static java.lang.String BUSINESS_INFO_TELECOM_PAGER_LOCCODE
           
static java.lang.String BUSINESS_INFO_TELECOM_PAGER_NUMBER
           
static java.lang.String BUSINESS_INFO_TELECOM_TELEPHONE_COMMENT
           
static java.lang.String BUSINESS_INFO_TELECOM_TELEPHONE_EXT
           
static java.lang.String BUSINESS_INFO_TELECOM_TELEPHONE_INTCODE
           
static java.lang.String BUSINESS_INFO_TELECOM_TELEPHONE_LOCCODE
           
static java.lang.String BUSINESS_INFO_TELECOM_TELEPHONE_NUMBER
           
static java.lang.String DEPARTMENT
           
static java.lang.String EMPLOYER
           
static java.lang.String GENDER
           
static java.lang.String HOME_INFO_ONLINE_EMAIL
           
static java.lang.String HOME_INFO_ONLINE_URI
           
static java.lang.String HOME_INFO_POSTAL_CITY
           
static java.lang.String HOME_INFO_POSTAL_COUNTRY
           
static java.lang.String HOME_INFO_POSTAL_NAME
           
static java.lang.String HOME_INFO_POSTAL_ORGANIZATION
           
static java.lang.String HOME_INFO_POSTAL_POSTALCODE
           
static java.lang.String HOME_INFO_POSTAL_STATEPROV
           
static java.lang.String HOME_INFO_POSTAL_STREET
           
static java.lang.String HOME_INFO_POSTAL_STREET_NAME
           
static java.lang.String HOME_INFO_POSTAL_STREET_NUMBER
           
static java.lang.String HOME_INFO_POSTAL_STREET_SUFFIX
           
static java.lang.String HOME_INFO_POSTAL_STREET_TYPE
           
static java.lang.String HOME_INFO_POSTAL_STREET_URBAN_DISTRICT
           
static java.lang.String HOME_INFO_TELECOM_FAX_COMMENT
           
static java.lang.String HOME_INFO_TELECOM_FAX_EXT
           
static java.lang.String HOME_INFO_TELECOM_FAX_INT
           
static java.lang.String HOME_INFO_TELECOM_FAX_LOCCODE
           
static java.lang.String HOME_INFO_TELECOM_FAX_NUMBER
           
static java.lang.String HOME_INFO_TELECOM_MOBILE_COMMENT
           
static java.lang.String HOME_INFO_TELECOM_MOBILE_EXT
           
static java.lang.String HOME_INFO_TELECOM_MOBILE_INTCODE
           
static java.lang.String HOME_INFO_TELECOM_MOBILE_LOCCODE
           
static java.lang.String HOME_INFO_TELECOM_MOBILE_NUMBER
           
static java.lang.String HOME_INFO_TELECOM_PAGER_COMMENT
           
static java.lang.String HOME_INFO_TELECOM_PAGER_EXT
           
static java.lang.String HOME_INFO_TELECOM_PAGER_INTCODE
           
static java.lang.String HOME_INFO_TELECOM_PAGER_LOCCODE
           
static java.lang.String HOME_INFO_TELECOM_PAGER_NUMBER
           
static java.lang.String HOME_INFO_TELECOM_TELEPHONE_COMMENT
           
static java.lang.String HOME_INFO_TELECOM_TELEPHONE_EXT
           
static java.lang.String HOME_INFO_TELECOM_TELEPHONE_INTCODE
           
static java.lang.String HOME_INFO_TELECOM_TELEPHONE_LOCCODE
           
static java.lang.String HOME_INFO_TELECOM_TELEPHONE_NUMBER
           
static java.lang.String JOBTITLE
           
static java.lang.String NAME_CIVILITY
           
static java.lang.String NAME_FAMILY
           
static java.lang.String NAME_GIVEN
           
static java.lang.String NAME_MIDDLE
           
static java.lang.String NAME_NICKNAME
           
static java.lang.String NAME_SUFFIX
           
static java.lang.String PREFIX
           
 
Constructor Summary
LuteceUser(java.lang.String strUserName, LuteceAuthentication authenticationService)
          Constructor
 
Method Summary
 void addGroups(java.util.Collection<java.lang.String> groups)
          add user's groups
 void addRoles(java.util.Collection<java.lang.String> roles)
          add user's roles
 boolean equals(java.lang.Object object)
          equals implementation
 java.lang.String getAuthenticationService()
          Returns the authentification service that had authentified the user
 java.lang.String getAuthenticationType()
          Returns the authentification type that had authentified the user
 java.lang.String[] getGroups()
          Returns user's groups
 LuteceAuthentication getLuteceAuthenticationService()
          "Getter method" for _luteceAuthenticationService
 java.lang.String getName()
          Return the user's name
 java.lang.String[] getRoles()
          Returns user's roles
 java.lang.String getUserInfo(java.lang.String key)
          Gets a user's info
 java.util.Map<java.lang.String,java.lang.String> getUserInfos()
          Gets the user info map
 int hashCode()
          hashCode implementation
 void setAuthenticationService(java.lang.String strAuthenticationService)
          Defines the authentification service that had authentified the user
 void setAuthenticationType(java.lang.String strAuthenticationType)
          Defines the authentification type that had authentified the user
 void setGroups(java.util.Collection<java.lang.String> groups)
          Defines user's groups
 void setLuteceAuthenticationService(LuteceAuthentication authenticationService)
          "Setter method" for _luteceAuthenticationService.
 void setName(java.lang.String strName)
          Sets the user's name
 void setRoles(java.util.Collection<java.lang.String> roles)
          Defines user's roles
 void setUserInfo(java.lang.String key, java.lang.String value)
          Add an user's info
 java.lang.String toString()
          toString implementation
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

BDATE

public static final java.lang.String BDATE
See Also:
Constant Field Values

GENDER

public static final java.lang.String GENDER
See Also:
Constant Field Values

EMPLOYER

public static final java.lang.String EMPLOYER
See Also:
Constant Field Values

DEPARTMENT

public static final java.lang.String DEPARTMENT
See Also:
Constant Field Values

JOBTITLE

public static final java.lang.String JOBTITLE
See Also:
Constant Field Values

PREFIX

public static final java.lang.String PREFIX
See Also:
Constant Field Values

NAME_GIVEN

public static final java.lang.String NAME_GIVEN
See Also:
Constant Field Values

NAME_FAMILY

public static final java.lang.String NAME_FAMILY
See Also:
Constant Field Values

NAME_MIDDLE

public static final java.lang.String NAME_MIDDLE
See Also:
Constant Field Values

NAME_SUFFIX

public static final java.lang.String NAME_SUFFIX
See Also:
Constant Field Values

NAME_NICKNAME

public static final java.lang.String NAME_NICKNAME
See Also:
Constant Field Values

NAME_CIVILITY

public static final java.lang.String NAME_CIVILITY
See Also:
Constant Field Values

HOME_INFO_POSTAL_NAME

public static final java.lang.String HOME_INFO_POSTAL_NAME
See Also:
Constant Field Values

HOME_INFO_POSTAL_STREET

public static final java.lang.String HOME_INFO_POSTAL_STREET
See Also:
Constant Field Values

HOME_INFO_POSTAL_STREET_NUMBER

public static final java.lang.String HOME_INFO_POSTAL_STREET_NUMBER
See Also:
Constant Field Values

HOME_INFO_POSTAL_STREET_SUFFIX

public static final java.lang.String HOME_INFO_POSTAL_STREET_SUFFIX
See Also:
Constant Field Values

HOME_INFO_POSTAL_STREET_NAME

public static final java.lang.String HOME_INFO_POSTAL_STREET_NAME
See Also:
Constant Field Values

HOME_INFO_POSTAL_STREET_TYPE

public static final java.lang.String HOME_INFO_POSTAL_STREET_TYPE
See Also:
Constant Field Values

HOME_INFO_POSTAL_STREET_URBAN_DISTRICT

public static final java.lang.String HOME_INFO_POSTAL_STREET_URBAN_DISTRICT
See Also:
Constant Field Values

HOME_INFO_POSTAL_CITY

public static final java.lang.String HOME_INFO_POSTAL_CITY
See Also:
Constant Field Values

HOME_INFO_POSTAL_STATEPROV

public static final java.lang.String HOME_INFO_POSTAL_STATEPROV
See Also:
Constant Field Values

HOME_INFO_POSTAL_POSTALCODE

public static final java.lang.String HOME_INFO_POSTAL_POSTALCODE
See Also:
Constant Field Values

HOME_INFO_POSTAL_COUNTRY

public static final java.lang.String HOME_INFO_POSTAL_COUNTRY
See Also:
Constant Field Values

HOME_INFO_POSTAL_ORGANIZATION

public static final java.lang.String HOME_INFO_POSTAL_ORGANIZATION
See Also:
Constant Field Values

HOME_INFO_TELECOM_TELEPHONE_INTCODE

public static final java.lang.String HOME_INFO_TELECOM_TELEPHONE_INTCODE
See Also:
Constant Field Values

HOME_INFO_TELECOM_TELEPHONE_LOCCODE

public static final java.lang.String HOME_INFO_TELECOM_TELEPHONE_LOCCODE
See Also:
Constant Field Values

HOME_INFO_TELECOM_TELEPHONE_NUMBER

public static final java.lang.String HOME_INFO_TELECOM_TELEPHONE_NUMBER
See Also:
Constant Field Values

HOME_INFO_TELECOM_TELEPHONE_EXT

public static final java.lang.String HOME_INFO_TELECOM_TELEPHONE_EXT
See Also:
Constant Field Values

HOME_INFO_TELECOM_TELEPHONE_COMMENT

public static final java.lang.String HOME_INFO_TELECOM_TELEPHONE_COMMENT
See Also:
Constant Field Values

HOME_INFO_TELECOM_FAX_INT

public static final java.lang.String HOME_INFO_TELECOM_FAX_INT
See Also:
Constant Field Values

HOME_INFO_TELECOM_FAX_LOCCODE

public static final java.lang.String HOME_INFO_TELECOM_FAX_LOCCODE
See Also:
Constant Field Values

HOME_INFO_TELECOM_FAX_NUMBER

public static final java.lang.String HOME_INFO_TELECOM_FAX_NUMBER
See Also:
Constant Field Values

HOME_INFO_TELECOM_FAX_EXT

public static final java.lang.String HOME_INFO_TELECOM_FAX_EXT
See Also:
Constant Field Values

HOME_INFO_TELECOM_FAX_COMMENT

public static final java.lang.String HOME_INFO_TELECOM_FAX_COMMENT
See Also:
Constant Field Values

HOME_INFO_TELECOM_MOBILE_INTCODE

public static final java.lang.String HOME_INFO_TELECOM_MOBILE_INTCODE
See Also:
Constant Field Values

HOME_INFO_TELECOM_MOBILE_LOCCODE

public static final java.lang.String HOME_INFO_TELECOM_MOBILE_LOCCODE
See Also:
Constant Field Values

HOME_INFO_TELECOM_MOBILE_NUMBER

public static final java.lang.String HOME_INFO_TELECOM_MOBILE_NUMBER
See Also:
Constant Field Values

HOME_INFO_TELECOM_MOBILE_EXT

public static final java.lang.String HOME_INFO_TELECOM_MOBILE_EXT
See Also:
Constant Field Values

HOME_INFO_TELECOM_MOBILE_COMMENT

public static final java.lang.String HOME_INFO_TELECOM_MOBILE_COMMENT
See Also:
Constant Field Values

HOME_INFO_TELECOM_PAGER_INTCODE

public static final java.lang.String HOME_INFO_TELECOM_PAGER_INTCODE
See Also:
Constant Field Values

HOME_INFO_TELECOM_PAGER_LOCCODE

public static final java.lang.String HOME_INFO_TELECOM_PAGER_LOCCODE
See Also:
Constant Field Values

HOME_INFO_TELECOM_PAGER_NUMBER

public static final java.lang.String HOME_INFO_TELECOM_PAGER_NUMBER
See Also:
Constant Field Values

HOME_INFO_TELECOM_PAGER_EXT

public static final java.lang.String HOME_INFO_TELECOM_PAGER_EXT
See Also:
Constant Field Values

HOME_INFO_TELECOM_PAGER_COMMENT

public static final java.lang.String HOME_INFO_TELECOM_PAGER_COMMENT
See Also:
Constant Field Values

HOME_INFO_ONLINE_EMAIL

public static final java.lang.String HOME_INFO_ONLINE_EMAIL
See Also:
Constant Field Values

HOME_INFO_ONLINE_URI

public static final java.lang.String HOME_INFO_ONLINE_URI
See Also:
Constant Field Values

BUSINESS_INFO_POSTAL_NAME

public static final java.lang.String BUSINESS_INFO_POSTAL_NAME
See Also:
Constant Field Values

BUSINESS_INFO_POSTAL_STREET

public static final java.lang.String BUSINESS_INFO_POSTAL_STREET
See Also:
Constant Field Values

BUSINESS_INFO_POSTAL_CITY

public static final java.lang.String BUSINESS_INFO_POSTAL_CITY
See Also:
Constant Field Values

BUSINESS_INFO_POSTAL_STATEPROV

public static final java.lang.String BUSINESS_INFO_POSTAL_STATEPROV
See Also:
Constant Field Values

BUSINESS_INFO_POSTAL_POSTALCODE

public static final java.lang.String BUSINESS_INFO_POSTAL_POSTALCODE
See Also:
Constant Field Values

BUSINESS_INFO_POSTAL_COUNTRY

public static final java.lang.String BUSINESS_INFO_POSTAL_COUNTRY
See Also:
Constant Field Values

BUSINESS_INFO_POSTAL_ORGANIZATION

public static final java.lang.String BUSINESS_INFO_POSTAL_ORGANIZATION
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_TELEPHONE_INTCODE

public static final java.lang.String BUSINESS_INFO_TELECOM_TELEPHONE_INTCODE
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_TELEPHONE_LOCCODE

public static final java.lang.String BUSINESS_INFO_TELECOM_TELEPHONE_LOCCODE
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_TELEPHONE_NUMBER

public static final java.lang.String BUSINESS_INFO_TELECOM_TELEPHONE_NUMBER
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_TELEPHONE_EXT

public static final java.lang.String BUSINESS_INFO_TELECOM_TELEPHONE_EXT
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_TELEPHONE_COMMENT

public static final java.lang.String BUSINESS_INFO_TELECOM_TELEPHONE_COMMENT
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_FAX_INTCODE

public static final java.lang.String BUSINESS_INFO_TELECOM_FAX_INTCODE
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_FAX_LOCCODE

public static final java.lang.String BUSINESS_INFO_TELECOM_FAX_LOCCODE
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_FAX_NUMBER

public static final java.lang.String BUSINESS_INFO_TELECOM_FAX_NUMBER
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_FAX_EXT

public static final java.lang.String BUSINESS_INFO_TELECOM_FAX_EXT
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_FAX_COMMENT

public static final java.lang.String BUSINESS_INFO_TELECOM_FAX_COMMENT
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_MOBILE_INTCODE

public static final java.lang.String BUSINESS_INFO_TELECOM_MOBILE_INTCODE
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_MOBILE_LOCCODE

public static final java.lang.String BUSINESS_INFO_TELECOM_MOBILE_LOCCODE
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_MOBILE_NUMBER

public static final java.lang.String BUSINESS_INFO_TELECOM_MOBILE_NUMBER
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_MOBILE_EXT

public static final java.lang.String BUSINESS_INFO_TELECOM_MOBILE_EXT
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_MOBILE_COMMENT

public static final java.lang.String BUSINESS_INFO_TELECOM_MOBILE_COMMENT
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_PAGER_INTCODE

public static final java.lang.String BUSINESS_INFO_TELECOM_PAGER_INTCODE
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_PAGER_LOCCODE

public static final java.lang.String BUSINESS_INFO_TELECOM_PAGER_LOCCODE
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_PAGER_NUMBER

public static final java.lang.String BUSINESS_INFO_TELECOM_PAGER_NUMBER
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_PAGER_EXT

public static final java.lang.String BUSINESS_INFO_TELECOM_PAGER_EXT
See Also:
Constant Field Values

BUSINESS_INFO_TELECOM_PAGER_COMMENT

public static final java.lang.String BUSINESS_INFO_TELECOM_PAGER_COMMENT
See Also:
Constant Field Values

BUSINESS_INFO_ONLINE_EMAIL

public static final java.lang.String BUSINESS_INFO_ONLINE_EMAIL
See Also:
Constant Field Values

BUSINESS_INFO_ONLINE_URI

public static final java.lang.String BUSINESS_INFO_ONLINE_URI
See Also:
Constant Field Values

ANONYMOUS_USERNAME

public static final java.lang.String ANONYMOUS_USERNAME
See Also:
Constant Field Values
Constructor Detail

LuteceUser

public LuteceUser(java.lang.String strUserName,
                  LuteceAuthentication authenticationService)
Constructor

Parameters:
strUserName - The User Name
authenticationService - The PortalAuthentication object
Method Detail

getUserInfos

public final java.util.Map<java.lang.String,java.lang.String> getUserInfos()
Gets the user info map

Returns:
The user info map

setUserInfo

public final void setUserInfo(java.lang.String key,
                              java.lang.String value)
Add an user's info

Parameters:
key - The info key
value - The info value

getUserInfo

public final java.lang.String getUserInfo(java.lang.String key)
Gets a user's info

Parameters:
key - The info key
Returns:
The info value

equals

public boolean equals(java.lang.Object object)
equals implementation

Specified by:
equals in interface java.security.Principal
Overrides:
equals in class java.lang.Object
Parameters:
object - The object to compare
Returns:
true if equal, otherwise false

toString

public java.lang.String toString()
toString implementation

Specified by:
toString in interface java.security.Principal
Overrides:
toString in class java.lang.Object
Returns:
The username

hashCode

public int hashCode()
hashCode implementation

Specified by:
hashCode in interface java.security.Principal
Overrides:
hashCode in class java.lang.Object
Returns:
The hascode

getName

public java.lang.String getName()
Return the user's name

Specified by:
getName in interface java.security.Principal
Returns:
The username

setName

public void setName(java.lang.String strName)
Sets the user's name

Parameters:
strName - The User name

getRoles

public java.lang.String[] getRoles()
Returns user's roles

Returns:
Returns user's roles

addRoles

public void addRoles(java.util.Collection<java.lang.String> roles)
add user's roles

Parameters:
roles - The User roles

setRoles

public void setRoles(java.util.Collection<java.lang.String> roles)
Defines user's roles

Parameters:
roles - The User roles

getGroups

public java.lang.String[] getGroups()
Returns user's groups

Returns:
Returns user's groups

addGroups

public void addGroups(java.util.Collection<java.lang.String> groups)
add user's groups

Parameters:
groups - The User groups

setGroups

public void setGroups(java.util.Collection<java.lang.String> groups)
Defines user's groups

Parameters:
groups - The User groups

setAuthenticationService

public void setAuthenticationService(java.lang.String strAuthenticationService)
Defines the authentification service that had authentified the user

Parameters:
strAuthenticationService - The authentification service

getAuthenticationService

public java.lang.String getAuthenticationService()
Returns the authentification service that had authentified the user

Returns:
the authentification service that had authentified the user

setAuthenticationType

public void setAuthenticationType(java.lang.String strAuthenticationType)
Defines the authentification type that had authentified the user

Parameters:
strAuthenticationType - The authentification type

getAuthenticationType

public java.lang.String getAuthenticationType()
Returns the authentification type that had authentified the user

Returns:
the authentification type that had authentified the user

getLuteceAuthenticationService

public LuteceAuthentication getLuteceAuthenticationService()
"Getter method" for _luteceAuthenticationService

Returns:
value of _luteceAuthenticationService

setLuteceAuthenticationService

public void setLuteceAuthenticationService(LuteceAuthentication authenticationService)
"Setter method" for _luteceAuthenticationService.

Parameters:
authenticationService - new value of _luteceAuthenticationService


Copyright © 2012 Mairie de Paris. All Rights Reserved.