Represents an authenticates User and contains operations to authorise the user.

Please consult the documentation for a detailed explanation.

  • User
    • Basic
      • Identifiable
      • Object
        • Anything
Initializer
User(User unknown)
Inherited Attributes
Attributes inherited from: Object
hash, string
Methods
clearCacheshared default User clearCache()

The User object will cache any authorities that it knows it has to avoid hitting the underlying auth provider each time. Use this method if you want to clear this cache.

isAuthorisedshared default User isAuthorised(String authority, Anything(Throwable|Boolean) resultHandler)

Is the user authorised to

Parameters:
  • authority

    the authority - what this really means is determined by the specific implementation. It might represent a permission to access a resource e.g. printers:printer34 or it might represent authority to a role in a roles based model, e.g. role:admin.

  • resultHandler

    handler that will be called with an async result containing the value true if the they has the authority or false otherwise.

principalshared default Object principal()

Get the underlying principal for the User. What this actually returns depends on the implementation. For a simple user/password based auth, it's likely to contain a JSON object with the following structure:

   {
     "username", "tim"
   }
 
setAuthProvidershared default void setAuthProvider(AuthProvider authProvider)

Set the auth provider for the User. This is typically used to reattach a detached User with an AuthProvider, e.g. after it has been deserialized.

Parameters:
  • authProvider

    the AuthProvider - this must be the same type of AuthProvider that originally created the User

Inherited Methods
Methods inherited from: Object
equals