Package com.atlan.cache

Class RoleCache

java.lang.Object

com.atlan.cache.AbstractMassCache<AtlanRole>

com.atlan.cache.RoleCache

All Implemented Interfaces:

Closeable, AutoCloseable

public class RoleCache
extends AbstractMassCache<AtlanRole>

Lazily-loaded cache for translating Atlan-internal roles into their various IDs.

Field Summary

Fields inherited from class com.atlan.cache.AbstractMassCache

bulkRefresh, client, lastRefresh, lock, needsRefresh, refreshLock

Constructor Summary

Constructors

Constructor	Description
RoleCache(AtlanClient client)

Method Summary

Modifier and Type	Method	Description
Set<String>	getRolesForCurrentUser()	Retrieve the set of roles to which the current user belongs.
protected void	lookupById(String id)	Logic to look up a single object for the cache.
protected void	lookupByName(String name)	Logic to look up a single object for the cache.
protected void	refreshCache()	Logic to refresh a specific cache en-masse (must be implemented).

Methods inherited from class com.atlan.cache.AbstractMassCache

cache, cache, cacheById, cacheByName, cacheBySid, close, entrySet, forceRefresh, getBulkRefresh, getById, getById, getByName, getByName, getBySid, getBySid, getIdForName, getIdForName, getIdForSid, getIdForSid, getIdFromName, getIdFromSid, getNameForId, getNameForId, getNameForSid, getNameForSid, getNameFromId, getNameFromId, getNameFromSid, getObjectById, getSidForName, getSidForName, getSidFromId, getSidFromName, isEmpty, isIdKnown, isNameKnown, lookupBySid, refreshIfNeeded

Methods inherited from class java.lang.Object

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

Constructor Details

RoleCache

public RoleCache(AtlanClient client)

Method Details

refreshCache

protected void refreshCache()
                     throws AtlanException

Logic to refresh a specific cache en-masse (must be implemented).

Specified by:

refreshCache in class AbstractMassCache<AtlanRole>

Throws:

AtlanException - on any error communicating with Atlan to refresh the cache of objects

lookupById

protected void lookupById(String id)
                   throws AtlanException

Logic to look up a single object for the cache.

Specified by:

lookupById in class AbstractMassCache<AtlanRole>

Parameters:

id - unique internal identifier for the object

Throws:

AtlanException - on any error communicating with Atlan

lookupByName

protected void lookupByName(String name)
                     throws AtlanException

Logic to look up a single object for the cache.

Specified by:

lookupByName in class AbstractMassCache<AtlanRole>

Parameters:

name - unique name for the object

Throws:

AtlanException - on any error communicating with Atlan

getRolesForCurrentUser

public Set<String> getRolesForCurrentUser()
                                   throws AtlanException

Retrieve the set of roles to which the current user belongs.

Returns:

internal IDs of all the roles of the current user

Throws:

AtlanException - on any cache refresh issues, if the cache needs to be refreshed