ecologylab.services.authentication.logging
Class AuthenticationOp

java.lang.Object
  ecologylab.generic.Debug
      ecologylab.xml.ElementState
          ecologylab.xml.types.element.ArrayListState
              ecologylab.services.logging.MixedInitiativeOp
                  ecologylab.services.authentication.logging.AuthenticationOp

All Implemented Interfaces:

AuthMessages, OptimizationTypes, XMLTranslationExceptionTypes, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List

public class AuthenticationOp
extends MixedInitiativeOp
implements AuthMessages

Logging operation that indicates when a user logs in or out of the server.

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.logging.MixedInitiativeOp

sessionTime

Fields inherited from class ecologylab.xml.types.element.ArrayListState

set

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

AuthenticationOp()

AuthenticationOp(java.lang.String username, boolean loggingIn, java.lang.String response, java.lang.String ipAddress, int port)
Creates a new AuthenticationOp to indicate that a user logged either in or out of the server.

Method Summary

java.lang.String	getAction()
java.lang.String	getIpAddress()
int	getPort()
java.lang.String	getResponse()
java.lang.String	getUsername()
void	performAction(boolean invert) Perform the op.

Methods inherited from class ecologylab.services.logging.MixedInitiativeOp

getSessionTime, isHuman, preTranslationProcessingHook, recycle

Methods inherited from class ecologylab.xml.types.element.ArrayListState

add, add, addAll, addAll, clear, clone, contains, containsAll, get, getArrayList, getCollection, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, recycle, remove, remove, removeAll, retainAll, set, set, size, subList, toArray, toArray, trimToSize

Methods inherited from class ecologylab.xml.ElementState

addNestedElement, addNestedElement, appendTextNodeString, buildDOM, buildDOM, buildDOM, buildDOM, buildDOM, buildDOMFromXMLCharSequence, buildDOMFromXMLString, checkAnnotation, convertNameStyles, createChildHook, fieldToXMLOptimizations, floatingPrecision, getElementStateById, getMap, getNestedNameSpace, getTextNodeString, leafElementFieldNames, lookupNestedNameSpace, optimizations, parent, postTranslationProcessingHook, 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

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

Methods inherited from interface java.util.List

equals, hashCode

Constructor Detail

AuthenticationOp

public AuthenticationOp()

AuthenticationOp

public AuthenticationOp(java.lang.String username,
                        boolean loggingIn,
                        java.lang.String response,
                        java.lang.String ipAddress,
                        int port)

Creates a new AuthenticationOp to indicate that a user logged either in or out of the server.

Parameters:

username - the username of the user.

loggingIn - true if the user is logging in; false for logging out.

response - the response the server gave to the attempt.

ipAddress - the IP address from which the attempt to log in or out originated.

port - the port on which the attempt to log in or out was made.

Method Detail

getUsername

public java.lang.String getUsername()

Returns:

the username

getAction

public java.lang.String getAction()

Returns:

the action

getResponse

public java.lang.String getResponse()

Returns:

the response

getIpAddress

public java.lang.String getIpAddress()

Returns:

the ipAddress

getPort

public int getPort()

Returns:

the port

performAction

public void performAction(boolean invert)

Description copied from class: MixedInitiativeOp

Perform the op. Perhaps invert it, as for undo.

Specified by:

performAction in class MixedInitiativeOp

See Also:

MixedInitiativeOp.performAction(boolean)