Errai 3.0.1-SNAPSHOT

org.jboss.errai.security.client.local.spi
Interface ActiveUserCache

All Known Implementing Classes:
BasicUserCacheImpl

public interface ActiveUserCache

Provides a cached copy of the actively logged in user.

Author:
Max Barkley

Method Summary
 User getUser()
           
 boolean hasUser()
          When this returns false, calls to getUser() will return User.ANONYMOUS.
 void invalidateCache()
          Invalidate the cached User.
 boolean isValid()
           
 void setUser(User user)
          Set the currently logged in User.
 

Method Detail

hasUser

boolean hasUser()
When this returns false, calls to getUser() will return User.ANONYMOUS.

Returns:
True iff there is a cached User available from a recent login.

getUser

User getUser()
Returns:
The currently logged in User. Never returns null. If no user is logged in, returns User.ANONYMOUS.

setUser

void setUser(User user)
Set the currently logged in User.

Parameters:
user - The User currently logged in.

isValid

boolean isValid()
Returns:
False if the cached User has been invalidated.

invalidateCache

void invalidateCache()
Invalidate the cached User.


Errai 3.0.1-SNAPSHOT

Copyright © 2013-2014 JBoss, a division of Red Hat. All Rights Reserved.