atg.security
Class ClientUserAuthority

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.nucleus.RegisteredService
              atg.security.GenericUserAuthority
                  atg.security.ClientUserAuthority

All Implemented Interfaces:

NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, AccountTypes, UserAuthority, UserAuthority2, java.util.EventListener

public class ClientUserAuthority
extends GenericUserAuthority
implements UserAuthority, AccountTypes

A client-side object that wraps a remote user authority.

Field Summary

static java.lang.String

CLASS_VERSION

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.security.AccountTypes

ANY_ACCOUNT, GROUP_ACCOUNT, LOGIN_ACCOUNT, PRIVILEGE_ACCOUNT

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

ClientUserAuthority(RemoteUserAuthority pRemoteAuthority)
Wraps a remote user authority with a client-side implementation that provides all the normal UserAuthority services.

ClientUserAuthority(java.lang.String pName, RemoteUserAuthority pRemoteAuthority)
Wraps a remote user authority with a client-side implementation that provides all the normal UserAuthority services.

Method Summary

void	flush() Flush cached persona information.
Persona	getPersona(java.lang.Object pId) Returns the persona associated with a particular user ID.
Persona[]	getPersonae(java.lang.String[] pIds) Given a set of persona IDs, return the set of personae they refer to.
RemoteUserAuthority	getRemoteUserAuthority() Extract the remote user authority that we are encapsulating.
boolean	loadPersonae(int pAccountType) Forces the cache to be loaded with all personae of accounts of the specified type.

Methods inherited from class atg.security.GenericUserAuthority

addAuthenticationFailedListener, addAuthenticationSucceededListener, addSpecialPersona, fireAuthenticationFailedEvent, fireAuthenticationSucceededEvent, getProxyUserAuthorities, getSpecialPersonae, getSupportsEveryone, getUserAuthorityName, removeAuthenticationFailedListener, removeAuthenticationSucceededListener, removeSpecialPersona, setProxyUserAuthorities, setSpecialPersonae, setSupportsEveryone, setUserAuthorityName, userDestroyed

Methods inherited from class atg.nucleus.RegisteredService

addToRegistry, getRegistry, getRegistryName, getServiceName, removeFromRegistry, setRegistryName, setServiceName, startService, stopService

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Methods inherited from interface atg.security.UserAuthority

addAuthenticationFailedListener, addAuthenticationSucceededListener, getUserAuthorityName, removeAuthenticationFailedListener, removeAuthenticationSucceededListener, userDestroyed

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

ClientUserAuthority

public ClientUserAuthority(RemoteUserAuthority pRemoteAuthority)
                    throws java.rmi.RemoteException

Wraps a remote user authority with a client-side implementation that provides all the normal UserAuthority services.

Parameters:

pRemoteAuthority - The remote user authority to wrap.

Throws:

java.rmi.RemoteException

ClientUserAuthority

public ClientUserAuthority(java.lang.String pName,
                           RemoteUserAuthority pRemoteAuthority)

Wraps a remote user authority with a client-side implementation that provides all the normal UserAuthority services.

Parameters:

pName - The name to be given to the client-side user authority.

pRemoteAuthority - The remote user authority to wrap.

Method Detail

flush

public void flush()

Flush cached persona information.

getRemoteUserAuthority

public RemoteUserAuthority getRemoteUserAuthority()

Extract the remote user authority that we are encapsulating.

getPersonae

public Persona[] getPersonae(java.lang.String[] pIds)

Given a set of persona IDs, return the set of personae they refer to. This is intended to be used as a performance enhancer when you need a lot of personae and want to reduce RMI traffic. This can also be used to preload the persona cache with a specific set of accounts.

loadPersonae

public boolean loadPersonae(int pAccountType)

Forces the cache to be loaded with all personae of accounts of the specified type. This is intended to be used as a performance enhancer when you expect to be working with a lot of accounts of a particular type, usually privileges.

This won't do anything if the server-side user authority does not also implement the AccountManager interface.

getPersona

public Persona getPersona(java.lang.Object pId)

Returns the persona associated with a particular user ID.

Specified by:

getPersona in interface UserAuthority

Overrides:

getPersona in class GenericUserAuthority