ecologylab.services.messages
Class SetPreferences

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

All Implemented Interfaces:

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

Deprecated.

@Deprecated
public class SetPreferences
extends RequestMessage

The message sent by ServicesClientApplet to Java application running ServicesServer at startup to configure preferences.

Author:

blake, andruid

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 PrefSet	preferencesSet Deprecated.
protected java.lang.String	preferencesSetAssetPath Deprecated.

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

SetPreferences()
Deprecated.

SetPreferences(PrefSet preferencesSet)
Deprecated.

SetPreferences(PrefSet preferencesSet, java.lang.String preferencesSetAssetPath)
Deprecated.

SetPreferences(java.lang.String preferencesSetAssetPath, java.lang.String overridePreferencesSetString, TranslationSpace nameSpace)
Deprecated.

SetPreferences(java.lang.String preferencesSetString, TranslationSpace translationSpace)
Deprecated.

Method Summary

protected void	handleAlreadyLoaded(Scope objectRegistry) Deprecated. Method for handling all SetPreferences messages after the first.
protected void	handleErrorWhileLoading(Scope objectRegistry) Deprecated.
ResponseMessage	performService(Scope objectRegistry) Deprecated. Use performService(Scope,String) instead
ResponseMessage	performService(Scope objectRegistry, java.lang.String sessionId) Deprecated. Adds the set of Prefs to the Preferences registry on the host machine.
PrefSet	preferencesSet() Deprecated.
void	setPreferencesSetAssetPath(java.lang.String preferencesSetAssetPath) Deprecated. Set the Asset path used for setPreferences.
protected ResponseMessage	setupApplication(Scope objectRegistry) Deprecated. This is a hook inside the performServices method which should be overridden by any class that extends this object.

Methods inherited from class ecologylab.services.messages.RequestMessage

isDisposable

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

preferencesSet

protected PrefSet preferencesSet

Deprecated.

preferencesSetAssetPath

protected java.lang.String preferencesSetAssetPath

Deprecated.

Constructor Detail

SetPreferences

public SetPreferences()

Deprecated.

SetPreferences

public SetPreferences(PrefSet preferencesSet)

Deprecated.

SetPreferences

public SetPreferences(PrefSet preferencesSet,
                      java.lang.String preferencesSetAssetPath)

Deprecated.

SetPreferences

public SetPreferences(java.lang.String preferencesSetString,
                      TranslationSpace translationSpace)
               throws XMLTranslationException

Deprecated.

Throws:

XMLTranslationException

SetPreferences

public SetPreferences(java.lang.String preferencesSetAssetPath,
                      java.lang.String overridePreferencesSetString,
                      TranslationSpace nameSpace)
               throws XMLTranslationException

Deprecated.

Throws:

XMLTranslationException

Method Detail

performService

public ResponseMessage performService(Scope objectRegistry)

Deprecated. Use performService(Scope,String) instead

Adds the set of Prefs to the Preferences registry on the host machine. This is now generally handled automatically.

Overrides:

performService in class RequestMessage

Parameters:

objectRegistry - Context to perform it in/with.

Returns:

Response to pass back to the (remote) caller.

performService

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

Deprecated.

Adds the set of Prefs to the Preferences registry on the host machine. This is now generally handled automatically.

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.

setupApplication

protected ResponseMessage setupApplication(Scope objectRegistry)

Deprecated.

This is a hook inside the performServices method which should be overridden by any class that extends this object. It defines the steps necessary to setup an application upon receiving and processing a SetPreferences message.

Parameters:

objectRegistry -

setPreferencesSetAssetPath

public void setPreferencesSetAssetPath(java.lang.String preferencesSetAssetPath)

Deprecated.

Set the Asset path used for setPreferences.

Parameters:

preferencesSetAssetPath -

handleAlreadyLoaded

protected void handleAlreadyLoaded(Scope objectRegistry)

Deprecated.

Method for handling all SetPreferences messages after the first. Should be overridden by any class that extends this object to properly handle these situations on message specific basis.

handleErrorWhileLoading

protected void handleErrorWhileLoading(Scope objectRegistry)

Deprecated.

preferencesSet

public PrefSet preferencesSet()

Deprecated.