ecologylab.services.authentication.messages
Class LoginStatusResponse

java.lang.Object
  ecologylab.generic.Debug
      ecologylab.xml.ElementState
          ecologylab.services.messages.ServiceMessage
              ecologylab.services.messages.ResponseMessage
                  ecologylab.services.authentication.messages.LoginStatusResponse

All Implemented Interfaces:

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

public class LoginStatusResponse
extends ResponseMessage
implements AuthMessages, AuthClientRegistryObjects

Indicates the response from the server regarding an attempt to log in.

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

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.AuthClientRegistryObjects

LOGIN_STATUS, LOGIN_STATUS_STRING

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

LoginStatusResponse()
No-argument constructor for serialization.

LoginStatusResponse(java.lang.String responseMessage)
Constructs a new LoginStatusResponse with the given responseMessage.

Method Summary

java.lang.String	getResponseMessage()
boolean	isOK() Indicates whether or not the attempt to log in was successful.
void	processResponse(Scope objectRegistry) Sets the LOGIN_STATUS BooleanSlot in the ObjectRegistry for the client, indicating whether or not login was successful.
void	setResponseMessage(java.lang.String responseMessage)

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

Constructor Detail

LoginStatusResponse

public LoginStatusResponse(java.lang.String responseMessage)

Constructs a new LoginStatusResponse with the given responseMessage.

Parameters:

responseMessage - the response from the server regarding the attempt to log in.

LoginStatusResponse

public LoginStatusResponse()

No-argument constructor for serialization.

Method Detail

getResponseMessage

public java.lang.String getResponseMessage()

Returns:

Returns the responseMessage.

isOK

public boolean isOK()

Indicates whether or not the attempt to log in was successful.

Specified by:

isOK in class ResponseMessage

Returns:

true if login was successful, false otherwise.

See Also:

ResponseMessage.isOK()

processResponse

public void processResponse(Scope objectRegistry)

Sets the LOGIN_STATUS BooleanSlot in the ObjectRegistry for the client, indicating whether or not login was successful.

Overrides:

processResponse in class ResponseMessage

Parameters:

objectRegistry - provide a context for response message processing.

See Also:

ResponseMessage.processResponse(ecologylab.appframework.Scope)

setResponseMessage

public void setResponseMessage(java.lang.String responseMessage)

Parameters:

responseMessage - The responseMessage to set.