Package org.directwebremoting.extend

This 'extend' package contains many of the classes that are interesting to very advanced DWR users, and people embedding or extending DWR.

See:
Description

Interface Summary

AccessControl	Control who should be accessing which methods on which classes.
AjaxFilterManager	A class that manages the various AjaxFilters and what classes they are registered against.
Alarm	An alarm is something that goes off at some point in the future.
Builder<T>	Class to enable us to build 'singleton' interface implementations.
CallbackHelper	TODO: can we make this work without a factory?
CallbackHelperFactory.CallbackHelperBuilder	Hack to get around Generics not being implemented by erasure
Compressor	An interface to the various methods of compressing web resources.
Configurator	Provides a way to add bits of configuration to the system.
ContainerAbstraction	We need to keep container specific logic out of BasePollHandler, and other parts of DWR.
Converter	An interface for converting types from a string to some other type.
ConverterManager	A class to manage the converter types and the instantiated class name matches.
Creator	A base class for all AllowedClasses
CreatorManager	A class to manage the types of creators and the instantiated creators.
DebugPageGenerator	The heart of DWR is a system to generate content from some requests.
DownloadManager	A DownloadManager allows you to inject files into the system and then retrieve them via a servlet at some later date.
DwrConstants	Some constants to do with the heart of DWR.
Handler	A handler is a very simple servlet that does not differentiate between GET and POST, or need complex setup beyond what the container can provide
IdGenerator	Id generator for DWR's CSRF protection session cookies and other duties.
InitializingBean	Interface to be implemented by beans that need to react once all their properties have been set by a Container: for example, to perform custom initialization.
Module
ModuleManager
NamedConverter	Additions to Converter that allow objects to have names that are exposed to the browser
OutboundVariable	A simple data container for the strings that comprise information about how a Java object has been converted into Javascript.
PageNormalizer	An interface to resolve the fact that many webservers treat blah/index.html the same as blah/.
Property	Describes some way to get or set a bit of data on an object.
ProtocolConstants	Various constants for type conversion
RealScriptSession	RealScriptSession is the real interface that should be implemented in place of ScriptSession.
RealScriptSession.Script	Interface for queued script info class.
RealWebContext	An interface that extends WebContext with some functions that should not be used by end users, but could be useful to system extenders.
Remoter	The heart of DWR is a system to generate content from some requests.
ScriptConduit	This interface hides the decoration taking place on different poll types.
ScriptSessionManager	A ScriptSessionManager looks after a number of sessions (keyed using a Javascript variable)
ServerLoadMonitor	Polling or Comet style interactive web applications require something to monitor high levels of server load to ensure that
Sleeper	A Sleeper allows the request to halt and cease execution for some time, while still allowing output.
TaskDispatcher	We would like to do some reverse ajax work, but need something to find the ScriptSessions add act on them all.
TaskDispatcherFactory.TaskDispatcherBuilder	Hack to get around Generics not being implemented by erasure
UninitializingBean	Like InitializingBean except that this requests notification when things are shutting down.
WaitController	A WaitController allows the ServerLoadMonitor to know what is waiting and enables it to tell them to stop waiting.

Class Summary

AbstractConverter	A way to migrate from the DWRv2.0 Converter style to something in the future.
AbstractCreator	A simple implementation of the basic parts of Creator
AllScriptSessionFilter	A ScriptSessionFilter that passes everything.
AndScriptSessionFilter	A ScriptSessionFilter that only allows ScriptSessions that match pass both the given ScriptSessionFilters
ArrayOutboundVariable	An OutboundVariable that declares a JavaScript array
Call	Call is a POJO to encapsulate the information required to make a single java call, including the result of the call (either returned data or exception).
CallbackHelperFactory	A class to help with the use of Callbacks
Calls	The request made by the browser which consists of a number of function call requests and some associated information like the request mode (XHR or iframe).
ConstructorProperty
ContainerUtil	An abstraction of all the common servlet operations that are required to host a DWR service that depends on the servlet spec.
ConvertUtil
DataUrlDownloadManager	A download manager that works my returning a data: URL so the data is sent directly without waiting in some store.
DefaultJavascriptFunction	Represents a callback function, passed in from a client for later execution.
DefaultJavascriptObject	Represents a callback function, passed in from a client for later execution.
EnginePrivate	An abstraction of the dwr.engine Javascript class.
ErrorOutboundVariable	An OutboundVariable that can not be recursive.
Factory<T>	Factory is not a user facing object, it is designed for system implementors.
FieldProperty	An implementation of Property that proxies to a Field
FormField	The result of a DWR query is normally a set of name/value pairs unless we are doing file-upload in which case there is more information with each field.
IdScriptSessionFilter	A ScriptSessionFilter that only allows ScriptSessions that match the given session id.
InboundContext	InboundContext is the context for set of inbound conversions.
InboundVariable	A simple struct to hold data about a single converted javascript variable.
InputStreamFactoryOutputStreamLoader	Used when the FileTransfer has a InputStreamFactory, but what it really wants is an OutputStreamLoader
MethodDeclaration	An immutable value object for method declaration information.
NestedOutboundVariable	A helper for implementing OutboundVariable when you have children
NestedProperty
NonNestedOutboundVariable	An OutboundVariable that we know to be unable to recurse
ObjectOutboundVariable	An OutboundVariable that declares a JavaScript object
OutboundContext	We need to keep track of stuff while we are converting on the way out to prevent recursion.
OutputStreamLoaderInputStreamFactory	Used when the FileTransfer has a OutputStreamLoader, but what it really wants is an InputStreamFactory
OverrideProperty	A Property for when we've been given override information in a signatures element.
PageScriptSessionFilter	A ScriptSessionFilter that only allows ScriptSessions that match the given page.
ParameterProperty	An implementation of Property that gets type information from the 'n'th parameter to a method
PlainProperty	An implementation of Property that simply uses stored values.
PropertyDescriptorProperty	An implementation of Property that proxies to a PropertyDescriptor
RealRawData	Sometimes DWR can't know at runtime the type of the inbound data, this class allows us to defer conversion until we know more about the type we should be converting to.
Replies	The request made by the browser which consists of a number of function call requests and some associated information like the request mode (XHR or iframe).
Reply	Reply is a read-only POJO to encapsulate the information required to make a single java call, including the result of the call (either returned data or exception).
ScriptBufferUtil	A simple utility class to extract a String from a ScriptBuffer.
SimpleInputStreamFactory	SimpleInputStreamFactory is just an InputStreamFactory that holds an InputStream and can close it at the right time (if required)
TaskDispatcherFactory	A class to help with the use of Callbacks

Exception Summary

AccessDeniedException	TODO: Work out if this exception actually helps.
ContainerConfigurationException	Something has gone wrong while configuring a Container
JsonModeMarshallException	JsonModeMarshallException is a hint to the conversion process that we are trying to convert in JSON mode, but we've discovered recursive data.
MarshallException	Deprecated. Use ConversionException instead
ServerException	Something has gone wrong when we were doing some conversion.

Package org.directwebremoting.extend Description

This 'extend' package contains many of the classes that are interesting to very advanced DWR users, and people embedding or extending DWR. Files in this package are not subject to the same backwards compatibility ideals as the org.directwebremoting package, however the code could change in a backwards-incompatible way, so these classes should be avoided unless necessary.

Author:

Joe Walker [joe at getahead dot ltd dot uk]