Package com.orchestranetworks.service

# Class UserReference

java.lang.Object
com.orchestranetworks.service.Profile
com.orchestranetworks.service.UserReference

public class UserReference extends Profile
Identifies a specific user.

See Also:
  - `Profile.forUser(String)`

- ## Field Summary

  ### Fields inherited from class com.orchestranetworks.service.Profile

  `ADMINISTRATOR, EVERYONE, OWNER, READ_ONLY`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Iterator<ServiceKey>`
  `getPrivileges()`
  Returns an iterator over `ServiceKey`s representing the user's privileges.
  `String`
  `getUserId()`
  Returns the identifier of the user (usually the login).
  `boolean`
  `isPrivilegeGranted(ServiceKey aServiceKey)`
  Returns `true` if this reference has been granted the privilege to execute the specified service.

  ### Methods inherited from class com.orchestranetworks.service.Profile

  `equals, forBuiltInRole, format, forSpecificRole, forUser, forUserWithSpecificPrivilege, forUserWithSpecificPrivileges, getLabel, hashCode, isBuiltIn, isBuiltInAdministrator, isBuiltInEveryone, isBuiltInOwner, isBuiltInReadOnly, isSpecificRole, isUserReference, parse, toString`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Method Details

  - ### getUserId

    public String getUserId()
    Returns the identifier of the user (usually the login).
    See Also:
      - `Profile.forUser(String)`

  - ### isPrivilegeGranted

    public boolean isPrivilegeGranted(ServiceKey aServiceKey)
    Returns `true` if this reference has been granted the privilege to execute the specified service.
    See Also:
      - `Profile.forUserWithSpecificPrivilege(String, ServiceKey)`

  - ### getPrivileges

    public Iterator<ServiceKey> getPrivileges()
    Returns an iterator over `ServiceKey`s representing the user's privileges.

    Returns `null` if no privileges have been given.

    See Also:
      - `ServiceKey`