org.alfresco.web.bean.repository

Class User

java.lang.Object

org.alfresco.web.bean.repository.User

All Implemented Interfaces:

Serializable, SessionUser

public final class User
extends Object
implements SessionUser

Bean that represents the currently logged in user

Author:

gavinc

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
User(String userName, String ticket, org.alfresco.service.cmr.repository.NodeRef person) Constructor

Method Summary

Modifier and Type	Method and Description
String	getCompanyRootId()
String	getFullName(org.alfresco.service.cmr.repository.NodeService service) Return the full name of the Person this User represents
static String	getFullName(org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.cmr.repository.NodeRef user) Returns the full name of the user represented by the given NodeRef
static String	getFullNameAndUserId(org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.cmr.repository.NodeRef user) Returns the full name of the user plus their userid in the form [id]
String	getHomeSpaceId()
org.alfresco.service.cmr.repository.NodeRef	getPerson()
String	getTicket() Return the ticket
String	getUserName() Return the user name
boolean	isAdmin()
void	reset() Forces a clear of any cached or calcluated values
void	setCompanyRootId(String companyRootId)
void	setHomeSpaceId(String homeSpaceId)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User(String userName,
            String ticket,
            org.alfresco.service.cmr.repository.NodeRef person)

Constructor

Parameters:

userName - constructor for the user

Method Detail

reset

public void reset()

Forces a clear of any cached or calcluated values

getUserName

public String getUserName()

Description copied from interface: SessionUser

Return the user name

Specified by:

getUserName in interface SessionUser

Returns:

The user name

getFullName

public String getFullName(org.alfresco.service.cmr.repository.NodeService service)

Return the full name of the Person this User represents

Parameters:

service - NodeService to use

Returns:

The full name

getHomeSpaceId

public String getHomeSpaceId()

Returns:

Retrieves the user's home space (this may be the id of the company home space)

setHomeSpaceId

public void setHomeSpaceId(String homeSpaceId)

Parameters:

homeSpaceId - Sets the id of the users home space

getCompanyRootId

public String getCompanyRootId()

Returns:

Retrieves the company home space

setCompanyRootId

public void setCompanyRootId(String companyRootId)

Parameters:

companyRootId - Sets the id of the company home space

getTicket

public String getTicket()

Description copied from interface: SessionUser

Return the ticket

Specified by:

getTicket in interface SessionUser

Returns:

Returns the ticket.

getPerson

public org.alfresco.service.cmr.repository.NodeRef getPerson()

Returns:

Returns the person NodeRef

isAdmin

public boolean isAdmin()

Returns:

If the current user has Admin Authority

getFullName

public static String getFullName(org.alfresco.service.cmr.repository.NodeService nodeService,
                                 org.alfresco.service.cmr.repository.NodeRef user)

Returns the full name of the user represented by the given NodeRef

Parameters:

nodeService - The node service instance

user - The user to get the full name for

Returns:

The full name

getFullNameAndUserId

public static String getFullNameAndUserId(org.alfresco.service.cmr.repository.NodeService nodeService,
                                          org.alfresco.service.cmr.repository.NodeRef user)

Returns the full name of the user plus their userid in the form [id]

Parameters:

nodeService - The node service instance

user - The user to get the full name for

Returns:

The full name and userid

toString

public String toString()

Overrides:

toString in class Object