atg.security
Class GenericUserAuthority

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ClientUserAuthority, GenericAccountManager, RepositoryAccountManager, RepositoryApplicationUserAuthority, SerializedProxyUserAuthority, atg.userdirectory.UserDirectoryLoginUserAuthority

public class GenericUserAuthority
extends atg.nucleus.RegisteredService
implements UserAuthority2

This implements a user authority that does nothing -- it's just a handle.

See Also:

UserAuthority, User

Field Summary

static java.lang.String

CLASS_VERSION

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

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

GenericUserAuthority()

GenericUserAuthority(java.lang.String name)

Method Summary

void	addAuthenticationFailedListener(DataListener pListener) Adds a listener for "authentication failed" events.
void	addAuthenticationSucceededListener(DataListener pListener) Adds a listener for "authentication succeeded" events.
void	addSpecialPersona(Persona pPersona) Adds the indicated persona to the special persona list.
protected void	fireAuthenticationFailedEvent(java.lang.String pSource, java.lang.String pLoginName) Fires an "authentication failed" event.
protected void	fireAuthenticationSucceededEvent(java.lang.String pSource, java.lang.String pLoginName) Fires an "authentication succeeded" event.
Persona	getPersona(java.lang.Object id) Returns a persona for the given ID object.
ProxyUserAuthority[]	getProxyUserAuthorities() Returns the set of proxy user authorities associated with this user authority.
Persona[]	getSpecialPersonae() Returns the special personae supported by this user authority.
boolean	getSupportsEveryone() If true, this user authority supports the "EVERYONE" special persona.
java.lang.String	getUserAuthorityName() Returns the name of the user authority.
void	removeAuthenticationFailedListener(DataListener pListener) Removes a listener for "authentication failed" events.
void	removeAuthenticationSucceededListener(DataListener pListener) Removes a listener for "authentication succeeded" events.
void	removeSpecialPersona(Persona pPersona) Removes the indicated persona from the special persona list.
void	setProxyUserAuthorities(ProxyUserAuthority[] pProxies) Sets this user authority up as the real authority for the given set of proxies.
void	setSpecialPersonae(Persona[] pPersonae) Changes the set of special personae supported by this user authority.
void	setSupportsEveryone(boolean pSupported) If set to true, this adds the "EVERYONE" special persona to the list of special personae supported by this user authority.
void	setUserAuthorityName(java.lang.String newName) Changes the name of the user authority.
void	userDestroyed(User user) Called by a User object when it is destroyed.

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, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, 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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

GenericUserAuthority

public GenericUserAuthority()

GenericUserAuthority

public GenericUserAuthority(java.lang.String name)

Method Detail

fireAuthenticationSucceededEvent

protected void fireAuthenticationSucceededEvent(java.lang.String pSource,
                                                java.lang.String pLoginName)

Fires an "authentication succeeded" event.

fireAuthenticationFailedEvent

protected void fireAuthenticationFailedEvent(java.lang.String pSource,
                                             java.lang.String pLoginName)

Fires an "authentication failed" event.

addSpecialPersona

public void addSpecialPersona(Persona pPersona)

Adds the indicated persona to the special persona list.

removeSpecialPersona

public void removeSpecialPersona(Persona pPersona)

Removes the indicated persona from the special persona list.

getSupportsEveryone

public boolean getSupportsEveryone()

If true, this user authority supports the "EVERYONE" special persona.

setSupportsEveryone

public void setSupportsEveryone(boolean pSupported)

If set to true, this adds the "EVERYONE" special persona to the list of special personae supported by this user authority. If set to false, it removes it.

setSpecialPersonae

public void setSpecialPersonae(Persona[] pPersonae)

Changes the set of special personae supported by this user authority.

setUserAuthorityName

public void setUserAuthorityName(java.lang.String newName)

Changes the name of the user authority.

getProxyUserAuthorities

public ProxyUserAuthority[] getProxyUserAuthorities()

Returns the set of proxy user authorities associated with this user authority.

setProxyUserAuthorities

public void setProxyUserAuthorities(ProxyUserAuthority[] pProxies)

Sets this user authority up as the real authority for the given set of proxies.

getUserAuthorityName

public java.lang.String getUserAuthorityName()

Returns the name of the user authority.

Specified by:

getUserAuthorityName in interface UserAuthority

userDestroyed

public void userDestroyed(User user)

Called by a User object when it is destroyed. This can be used to clean up internal references to the user object.

Specified by:

userDestroyed in interface UserAuthority

getPersona

public Persona getPersona(java.lang.Object id)

Returns a persona for the given ID object. This is typically used by an ACL parser, where the ID is usually a string. In this implementation the only IDs that have matching personae are those that were defined as "special" personae.

Specified by:

getPersona in interface UserAuthority

addAuthenticationSucceededListener

public void addAuthenticationSucceededListener(DataListener pListener)

Adds a listener for "authentication succeeded" events.

Specified by:

addAuthenticationSucceededListener in interface UserAuthority

removeAuthenticationSucceededListener

public void removeAuthenticationSucceededListener(DataListener pListener)

Removes a listener for "authentication succeeded" events.

Specified by:

removeAuthenticationSucceededListener in interface UserAuthority

addAuthenticationFailedListener

public void addAuthenticationFailedListener(DataListener pListener)

Adds a listener for "authentication failed" events.

Specified by:

addAuthenticationFailedListener in interface UserAuthority

removeAuthenticationFailedListener

public void removeAuthenticationFailedListener(DataListener pListener)

Removes a listener for "authentication failed" events.

Specified by:

removeAuthenticationFailedListener in interface UserAuthority

getSpecialPersonae

public Persona[] getSpecialPersonae()

Returns the special personae supported by this user authority. These are personae that are supported in ACLs but that are not persisted by the back-end system.

Specified by:

getSpecialPersonae in interface UserAuthority2