com.webmethods.portal.service.dir

Interface IDirCache

public interface IDirCache

This interface exposes caching services for a specific directory service. Each specific Directory Service may or may not particpate in caching Note, the cache will probably use configuration information from the directory service

Method Summary

Modifier and Type	Method and Description
void	clearCache() Clear the cache type
default void	clearQueryCache() Clear query cache
void	enable(boolean enable) (de)Activate this cache
IDirPrincipal	get(IURI uri) Retrieves a principal by uri
IDirPrincipal	get(String dn) Retrieves a principal by dn
IDirPrincipalList	getList(String query) Retrieves a principal list by query
String	getPasswordHash(IURI uri) Gets password hash from authentication cache
void	invalidatePrincipal(IDirPrincipal dirPrincipal) invalidates based upon the dirPrincipal
void	invalidatePrincipal(IURI uri) invalidates based upon the uri
void	invalidatePrincipal(String dn) invalidates based upon the dn
boolean	isEnabled() Whether this directory cache is active
void	put(IURI uri, IDirPrincipal dirPrincipal) Puts a principal in the cache based on the uri
void	put(String dn, IDirPrincipal dirPrincipal) Puts a principal in the cache based on the dn
void	putList(String query, IDirPrincipalList dirPrincipalList) Puts a principal list in the cache based on the query
void	putPasswordHash(IURI uri, String passwordHash) Puts authentication cache

Method Detail

isEnabled

boolean isEnabled()
           throws PortalException

Whether this directory cache is active

Throws:

PortalException

enable

void enable(boolean enable)
     throws PortalException

(de)Activate this cache

Throws:

PortalException

clearCache

void clearCache()
         throws PortalException

Clear the cache type

Throws:

PortalException

putPasswordHash

void putPasswordHash(IURI uri,
                     String passwordHash)
              throws PortalException

Puts authentication cache

Throws:

PortalException

getPasswordHash

String getPasswordHash(IURI uri)
                throws PortalException

Gets password hash from authentication cache

Throws:

PortalException

put

void put(String dn,
         IDirPrincipal dirPrincipal)
  throws PortalException

Puts a principal in the cache based on the dn

Throws:

PortalException

put

void put(IURI uri,
         IDirPrincipal dirPrincipal)
  throws PortalException

Puts a principal in the cache based on the uri

Throws:

PortalException

putList

void putList(String query,
             IDirPrincipalList dirPrincipalList)
      throws PortalException

Puts a principal list in the cache based on the query

Throws:

PortalException

get

IDirPrincipal get(String dn)
           throws PortalException

Retrieves a principal by dn

Throws:

PortalException

get

IDirPrincipal get(IURI uri)
           throws PortalException

Retrieves a principal by uri

Throws:

PortalException

getList

IDirPrincipalList getList(String query)
                   throws PortalException

Retrieves a principal list by query

Throws:

PortalException

invalidatePrincipal

void invalidatePrincipal(String dn)
                  throws PortalException

invalidates based upon the dn

Throws:

PortalException

invalidatePrincipal

void invalidatePrincipal(IURI uri)
                  throws PortalException

invalidates based upon the uri

Throws:

PortalException

invalidatePrincipal

void invalidatePrincipal(IDirPrincipal dirPrincipal)
                  throws PortalException

invalidates based upon the dirPrincipal

Throws:

PortalException

clearQueryCache

default void clearQueryCache()

Clear query cache