Package org.alfresco.repo.security.authority.script

Class ScriptUser

java.lang.Object

org.alfresco.repo.security.authority.script.ScriptUser

All Implemented Interfaces:

Serializable, Authority

public class ScriptUser
extends Object
implements Authority, Serializable

The Script user is a USER authority exposed to the scripting API

Author:

mrogers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.repo.security.authority.script.Authority

Authority.AuthorityComparator, Authority.ScriptAuthorityType

Constructor Summary

Constructors

Constructor	Description
ScriptUser(String userName, NodeRef personNodeRef, ServiceRegistry serviceRegistry, org.mozilla.javascript.Scriptable scope)	Constructs a scriptable object representing a user.

Method Summary

Modifier and Type	Method	Description
Authority.ScriptAuthorityType	getAuthorityType()
String	getDisplayName()
String	getFullName()
ScriptNode	getPerson()	Return a ScriptNode wrapping the person
NodeRef	getPersonNodeRef()	Return the NodeRef of the person
String	getShortName()
String	getUserName()	Return the User Name, also known as the Authority Full Name
Set<String>	getZones()	Gets all the zones of this user

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptUser

public ScriptUser(String userName,
                  NodeRef personNodeRef,
                  ServiceRegistry serviceRegistry,
                  org.mozilla.javascript.Scriptable scope)

Constructs a scriptable object representing a user.

Parameters:

userName - The username

personNodeRef - The NodeRef

serviceRegistry - A ServiceRegistry instance

scope - Script scope

Since:

4.0

Method Detail

getAuthorityType

public Authority.ScriptAuthorityType getAuthorityType()

Specified by:

getAuthorityType in interface Authority

getShortName

public String getShortName()

Specified by:

getShortName in interface Authority

getFullName

public String getFullName()

Specified by:

getFullName in interface Authority

getUserName

public String getUserName()

Return the User Name, also known as the Authority Full Name

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Authority

getPersonNodeRef

public NodeRef getPersonNodeRef()

Return the NodeRef of the person

Since:

4.0

getPerson

public ScriptNode getPerson()

Return a ScriptNode wrapping the person

Since:

4.0

getZones

public Set<String> getZones()

Gets all the zones of this user

Specified by:

getZones in interface Authority

Returns:

The name of the zones of this user.

Since:

4.1.3