Class Security.User
A class which provides a Fabric user information. Use
SecurityManager#lookupUser method to get 'Security.User'
object for the specified user.
Defined in: </home/ubuntu/streamscape/NeeveBuild/stjsapi/src/main/webapp/js/security/User.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
Security.User(fabricConnection)
Creates a new user in Fabric
|
Method Attributes | Method Name and Description |
---|---|
AccessControlList |
Returns the access control list of this user
|
String |
getAlias()
Returns the alias name of this user
|
String |
getAttribute(key)
Returns the value of the specified attribute of this user
|
String |
Returns the description of this user
|
String |
Returns the LDIF record of this user
|
String |
Returns the list of groups, which contain this user as a member
|
String |
getName()
Returns the name of this user
|
String |
Returns the organization of this user
|
String |
getState()
Returns the current state of this user.
|
boolean |
Returns if this user is a member of administrators group
|
boolean |
Returns if this user is an anonymous user
|
boolean |
Returns if this user represents a distinguished entity
|
boolean |
isMemberOf(groupName)
Returns if this user is a member of the specified group
|
boolean |
Returns if this user can do some operations with super-user privileges
|
String |
Returns the sorted list of groups, which contain this user as a member
|
void |
setAccessControlList(accessControlList)
Sets the access control list for this user
|
void |
setAlias(alias)
Sets the alias name for this user
|
void |
setAttribute(key, value)
Sets the specified attribute for this user
|
void |
setDescription(description)
Sets the description for this user
|
void |
setDistinguishedEntity(distinguishedEntity)
Sets if this user represents a distinguished entity
|
void |
setSudoCapable(sudoCapable)
Sets if this user can do some operations with super-user privileges or not
|
Class Detail
Security.User(fabricConnection)
Creates a new user in Fabric
- Parameters:
- {HTTPFabricConnection} fabricConnection
- The fabric connection via which all the methods are invoked
Method Detail
{AccessControlList}
getAccessControlList()
Returns the access control list of this user
- Returns:
- This user access control list
{String}
getAlias()
Returns the alias name of this user
- Returns:
- The alias name of this user
{String}
getAttribute(key)
Returns the value of the specified attribute of this user
- Parameters:
- {String} key
- The name of the attribute to be get
- Returns:
- The value of the specified attribute
{String}
getDescription()
Returns the description of this user
- Returns:
- This user description
{String}
getDNRecord()
Returns the LDIF record of this user
- Returns:
- The LDIF record of this user
{String[]}
getGroups()
Returns the list of groups, which contain this user as a member
- Returns:
- This user's groups list
{String}
getName()
Returns the name of this user
- Returns:
- This user name
{String}
getOrganization()
Returns the organization of this user
- Returns:
- This user organization
{String}
getState()
Returns the current state of this user. It can be: 'ENABLED', 'DISABLED',
'DISABLED_INVALID_ORGANIZATION', 'DISABLED_INVALID_GROUP'.
- Returns:
- The current state of this user
{boolean}
isAdministrator()
Returns if this user is a member of administrators group
- Returns:
- True if this user is a member of administrators group
{boolean}
isAnonymous()
Returns if this user is an anonymous user
- Returns:
- True if this user is an anonymous user
{boolean}
isDistinguishedEntity()
Returns if this user represents a distinguished entity
- Returns:
- True if this user represents a distinguished entity
{boolean}
isMemberOf(groupName)
Returns if this user is a member of the specified group
- Parameters:
- {String} groupName
- The name of the group to be checked
- Returns:
- True if the specified group contains this user
{boolean}
isSudoCapable()
Returns if this user can do some operations with super-user privileges
- Returns:
- True if this user can do operations with super-user privileges
{String[]}
listGroups()
Returns the sorted list of groups, which contain this user as a member
- Returns:
- This user's groups sorted list
setAccessControlList(accessControlList)
Sets the access control list for this user
- Parameters:
- {AccessControlList} accessControlList
- The new access control list to be set for this user
setAlias(alias)
Sets the alias name for this user
- Parameters:
- {String} alias
- The new alias name to be set for this user
setAttribute(key, value)
Sets the specified attribute for this user
- Parameters:
- {String} key
- The name of the attribute to be set
- {String} value
- The value of the attribute to be set
setDescription(description)
Sets the description for this user
- Parameters:
- {String} description
- The new description to be set for this user
setDistinguishedEntity(distinguishedEntity)
Sets if this user represents a distinguished entity
- Parameters:
- {boolean} distinguishedEntity
- If true, then this user represents a distinguished entity
setSudoCapable(sudoCapable)
Sets if this user can do some operations with super-user privileges or not
- Parameters:
- {boolean} sudoCapable
- If true, then this user is allowed to do some operations with super-user privileges