ecologylab.services.authentication.messages
Class Logout

java.lang.Object
  ecologylab.generic.Debug
      ecologylab.xml.ElementState
          ecologylab.services.messages.ServiceMessage
              ecologylab.services.messages.RequestMessage
                  ecologylab.services.authentication.messages.Logout

All Implemented Interfaces:

AuthMessages, AuthServerRegistryObjects, OptimizationTypes, XMLTranslationExceptionTypes, java.lang.Comparable<ServiceMessage>

public class Logout
extends RequestMessage
implements AuthMessages, AuthServerRegistryObjects

A Logout message indicates that the connnected client no longer wants to be connected.

Author:

Zachary O. Toups (toupsz@cs.tamu.edu)

Nested Class Summary

Nested classes/interfaces inherited from class ecologylab.xml.ElementState

ElementState.ClassToCollectionMap, ElementState.DeclarationStyle, ElementState.xml_attribute, ElementState.xml_class, ElementState.xml_classes, ElementState.xml_collection, ElementState.xml_leaf, ElementState.xml_map, ElementState.xml_nested, ElementState.xml_tag

Field Summary

protected AuthenticationListEntry

entry

Fields inherited from class ecologylab.services.messages.ServiceMessage

sender, timeStamp, uid

Fields inherited from class ecologylab.xml.ElementState

CDATA, ESTIMATE_CHARS_PER_FIELD, FLOATING_PRECISION_OFF, MARSHALLING_PARAMS, NORMAL, UTF16, UTF16_LE, UTF8, XML_FILE_HEADER

Fields inherited from interface ecologylab.services.authentication.messages.AuthMessages

LOGIN_FAILED_LOGGEDIN, LOGIN_FAILED_NO_IP_SUPPLIED, LOGIN_FAILED_PASSWORD, LOGIN_SUCCESSFUL, LOGOUT_FAILED_IP_MISMATCH, LOGOUT_FAILED_NOT_LOGGEDIN, LOGOUT_SUCCESSFUL, REQUEST_FAILED_NOT_AUTHENTICATED

Fields inherited from interface ecologylab.services.authentication.registryobjects.AuthServerRegistryObjects

MAIN_AUTHENTICATABLE

Fields inherited from interface ecologylab.xml.OptimizationTypes

BAD_FIELD, COLLECTION_ELEMENT, COLLECTION_SCALAR, IGNORED_ATTRIBUTE, IGNORED_ELEMENT, LEAF_NODE_VALUE, MAP_ELEMENT, MAP_SCALAR, NAME_SPACE_ATTRIBUTE, NAME_SPACE_LEAF_NODE, NAME_SPACE_MASK, NAME_SPACE_NESTED_ELEMENT, NAMESPACE_IGNORED_ELEMENT, NAMESPACE_TRIAL_ELEMENT, OTHER_NESTED_ELEMENT, REGULAR_ATTRIBUTE, REGULAR_NESTED_ELEMENT, ROOT, UNSET_TYPE, XMLNS_ATTRIBUTE, XMLNS_IGNORED

Fields inherited from interface ecologylab.xml.XMLTranslationExceptionTypes

FILE_NOT_FOUND, IO_EXCEPTION, NULL_PURL, UNKNOWN

Constructor Summary

Logout()
Should not normally be used; only for XML translations.

Logout(AuthenticationListEntry entry)
Creates a new Logout object using the given AuthenticationListEntry object, indicating the user that should be logged out of the server.

Method Summary

AuthenticationListEntry	getEntry()
ResponseMessage	performService(Scope objectRegistry, java.lang.String sessionId) Attempts to log the user specified by entry from the system; if they are already logged in; if not, sends a failure response.

Methods inherited from class ecologylab.services.messages.RequestMessage

isDisposable, performService

Methods inherited from class ecologylab.services.messages.ServiceMessage

compareTo, getSender, getTimeStamp, getUid, setSender, setUid, stampTime

Methods inherited from class ecologylab.xml.ElementState

addNestedElement, addNestedElement, appendTextNodeString, buildDOM, buildDOM, buildDOM, buildDOM, buildDOM, buildDOMFromXMLCharSequence, buildDOMFromXMLString, checkAnnotation, convertNameStyles, createChildHook, fieldToXMLOptimizations, floatingPrecision, getCollection, getElementStateById, getMap, getNestedNameSpace, getTextNodeString, leafElementFieldNames, lookupNestedNameSpace, optimizations, parent, postTranslationProcessingHook, preTranslationProcessingHook, recycle, setDeclarationStyle, setFieldUsingTypeRegistry, setFloatingPrecision, setParent, setUseDOMForTranslateTo, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXML, translateFromXMLCharSequence, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOM, translateFromXMLDOMCharSequence, translateFromXMLDOMCharSequence, translateFromXMLRootNode, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateFromXMLSAX, translateToDOM, translateToXML, translateToXML, translateToXML, translateToXML, writePrettyXML, writePrettyXML, writePrettyXML

Methods inherited from class ecologylab.generic.Debug

classSimpleName, closeLoggingFile, debug, debug, debug, debug, debugA, debugA, debugA, debugI, debugI, debugI, error, error, getClassName, getClassName, getInteractive, getPackageName, getPackageName, getPackageName, initialize, level, level, level, logToFile, print, print, println, println, println, println, println, println, printlnA, printlnA, printlnA, printlnI, printlnI, printlnI, printlnI, setLoggingFile, show, show, superString, toggleInteractive, toString, toString, warning, warning, weird, weird

Methods inherited from class java.lang.Object

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

Field Detail

entry

protected AuthenticationListEntry entry

Constructor Detail

Logout

public Logout()

Should not normally be used; only for XML translations.

Logout

public Logout(AuthenticationListEntry entry)

Creates a new Logout object using the given AuthenticationListEntry object, indicating the user that should be logged out of the server.

Parameters:

entry - - the entry to use for this Logout object.

Method Detail

performService

public ResponseMessage performService(Scope objectRegistry,
                                      java.lang.String sessionId)

Attempts to log the user specified by entry from the system; if they are already logged in; if not, sends a failure response.

Specified by:

performService in class RequestMessage

Parameters:

objectRegistry - Context to perform it in/with.

sessionId - TODO

Returns:

Response to pass back to the (remote) caller.

getEntry

public AuthenticationListEntry getEntry()

Returns:

Returns the entry.