org.springframework.richclient.security
Class LogoutCommand

java.lang.Object
  org.springframework.binding.value.support.AbstractPropertyChangePublisher
      org.springframework.richclient.command.AbstractCommand
          org.springframework.richclient.command.ActionCommand
              org.springframework.richclient.command.support.ApplicationWindowAwareCommand
                  org.springframework.richclient.security.LogoutCommand

All Implemented Interfaces:

BeanNameAware, InitializingBean, PropertyChangePublisher, ApplicationWindowAware, ActionCommandExecutor, GuardedActionCommandExecutor, ParameterizableActionCommandExecutor, Authorizable, Guarded, SecurityControllable

public class LogoutCommand
extends ApplicationWindowAwareCommand

Provides a command to log the current user out.

Logout handling is performed by calling ApplicationSecurityManager.doLogout(). See that class for details.

No server-side call will occur to indicate logout. If this is required, you should extend this class and use the onLogout(org.acegisecurity.Authentication) method.

Author:

Ben Alex, Larry Streepy

Field Summary

Fields inherited from class org.springframework.richclient.command.ActionCommand

ACTION_COMMAND_PARAMETER_KEY, ACTION_COMMAND_PROPERTY, ACTION_EVENT_PARAMETER_KEY, MODIFIERS_PARAMETER_KEY

Fields inherited from class org.springframework.richclient.command.AbstractCommand

ENABLED_PROPERTY_NAME, VISIBLE_PROPERTY_NAME

Fields inherited from class org.springframework.binding.value.support.AbstractPropertyChangePublisher

logger

Fields inherited from interface org.springframework.richclient.core.Authorizable

AUTHORIZED_PROPERTY

Constructor Summary

LogoutCommand()

Method Summary

protected void	doExecuteCommand()
void	onLogout(org.acegisecurity.Authentication loggedOut) Can be extended by subclasses to perform additional logout processing, such as notifying a server etc.
void	setDisplaySuccess(boolean displaySuccess) Indicates whether an information message is displayed to the user upon successful logout.

Methods inherited from class org.springframework.richclient.command.support.ApplicationWindowAwareCommand

getApplicationWindow, getParentWindowControl, setApplicationWindow

Methods inherited from class org.springframework.richclient.command.ActionCommand

addCommandInterceptor, addParameter, execute, execute, getActionAdapter, getActionCommand, getModifiers, getParameter, getParameter, getParameters, isDisplaysInputDialog, onButtonAttached, onPostExecute, onPreExecute, removeCommandInterceptor, setActionCommand, setDefaultButton, setDefaultButtonIn, setDisplaysInputDialog

Methods inherited from class org.springframework.richclient.command.AbstractCommand

addEnabledListener, afterPropertiesSet, attach, attach, attach, buttonIterator, createButton, createButton, createButton, createButton, createButton, createButton, createMenuItem, createMenuItem, createMenuItem, createMenuItem, createMenuItem, createMenuItem, defaultButtonIterator, detach, getAccelerator, getButtonFactory, getButtonIn, getCommandServices, getComponentFactory, getDefaultButtonConfigurer, getDefaultFaceDescriptorId, getFaceDescriptor, getFaceDescriptorRegistry, getIcon, getId, getMenuFactory, getMenuItemButtonConfigurer, getMnemonic, getMnemonicIndex, getSecurityControllerId, getText, getToolBarButtonConfigurer, getToolBarButtonFactory, isAnonymous, isAttached, isAuthorized, isEnabled, isFaceConfigured, isVisible, onButtonDetached, removeEnabledListener, requestFocusIn, setAuthorized, setBeanName, setCaption, setCommandServices, setDefaultFaceDescriptorId, setEnabled, setFaceDescriptor, setFaceDescriptor, setFaceDescriptorRegistry, setFaceDescriptors, setIcon, setIconInfo, setId, setLabel, setLabel, setSecurityControllerId, setVisible, toString, updatedEnabledState, updatedVisibleState

Methods inherited from class org.springframework.binding.value.support.AbstractPropertyChangePublisher

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, firePropertiesChanged, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getPropertyChangeListeners, getPropertyChangeListeners, getVetoableChangeListeners, getVetoableChangeListeners, hasChanged, hasChanged, hasChanged, hasChanged, hasChanged, hasChanged, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

LogoutCommand

public LogoutCommand()

Method Detail

setDisplaySuccess

public void setDisplaySuccess(boolean displaySuccess)

Indicates whether an information message is displayed to the user upon successful logout. Defaults to true.

Parameters:

displaySuccess - displays an information message upon successful logout if true, otherwise false

doExecuteCommand

protected void doExecuteCommand()

Specified by:

doExecuteCommand in class ActionCommand

onLogout

public void onLogout(org.acegisecurity.Authentication loggedOut)

Can be extended by subclasses to perform additional logout processing, such as notifying a server etc.