weave.servlets

Class WeaveServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

weave.servlets.WeaveServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

AdminService, DataService, RService

public class WeaveServlet
extends javax.servlet.http.HttpServlet

This class provides a servlet interface to a set of functions. The functions may be invoked using URL parameters via HTTP GET using url parameters or via HTTP POST using JSON RPC 2.0 or AMF3-serialized objects. If using URL variables or JSON RPC 2.0, the return value will be provided as a JSON RPC 2.0 response object. If using AMF3, the return value will be provided as compressed AMF3.

Author:

skota, adufilie, skolman

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	WeaveServlet.ServletRequestInfo

Field Summary

Fields

Modifier and Type	Field and Description
static long	debugThreshold
static java.lang.String	JSONRPC_VERSION
protected java.lang.String	METHOD The name of the property which contains the remote method name.
protected java.lang.String	PARAMS The name of the property which contains method parameters.
protected java.lang.String	STREAM_PARAMETER_INDEX The name of the property which specifies the index in the params Array that corresponds to an InputStream.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WeaveServlet(java.lang.Object... serviceObjects)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.Object	cast(java.lang.Object value, java.lang.reflect.Type type) Tries to convert value to the given type.
protected flex.messaging.io.amf.ASObject	deserializeAmf3(java.io.InputStream inputStream)
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
java.util.Map<java.lang.String,java.lang.Object>	getCapabilities() Lists available methods.
protected WeaveServlet.ServletRequestInfo	getServletRequestInfo() This function retrieves the ServletRequestInfo associated with the current thread's doGet() or doPost() call.
void	init(javax.servlet.ServletConfig config)
protected void	initAllMethods(java.lang.Object serviceObject) This function will expose all the declared public methods of a class as servlet methods, except methods that match those declared by WeaveServlet or a superclass of WeaveServlet.
protected void	initMethod(java.lang.Object serviceObject, java.lang.reflect.Method method)
protected java.lang.String	methodToString(java.lang.String name, java.lang.Object[] params)
protected void	serializeCompressedAmf3(java.lang.Object objToSerialize, javax.servlet.ServletOutputStream servletOutputStream)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

debugThreshold

public static long debugThreshold

METHOD

protected final java.lang.String METHOD

The name of the property which contains the remote method name.

See Also:

Constant Field Values

PARAMS

protected final java.lang.String PARAMS

The name of the property which contains method parameters.

See Also:

Constant Field Values

STREAM_PARAMETER_INDEX

protected final java.lang.String STREAM_PARAMETER_INDEX

The name of the property which specifies the index in the params Array that corresponds to an InputStream.

See Also:

Constant Field Values

JSONRPC_VERSION

public static final java.lang.String JSONRPC_VERSION

See Also:

Constant Field Values

Constructor Detail

WeaveServlet

protected WeaveServlet(java.lang.Object... serviceObjects)

Parameters:

serviceObjects - The objects to invoke methods on.

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

initAllMethods

protected void initAllMethods(java.lang.Object serviceObject)

This function will expose all the declared public methods of a class as servlet methods, except methods that match those declared by WeaveServlet or a superclass of WeaveServlet.

Parameters:

serviceObject - The object containing public methods to be exposed by the servlet.

initMethod

protected void initMethod(java.lang.Object serviceObject,
              java.lang.reflect.Method method)

Parameters:

serviceObject - The instance of an object to use in the servlet.

method - The method to expose on serviceObject.

getServletRequestInfo

protected WeaveServlet.ServletRequestInfo getServletRequestInfo()

This function retrieves the ServletRequestInfo associated with the current thread's doGet() or doPost() call. From the ServletRequestInfo object you can get the ServletOutputStream. In a public function with a void return type, you can use the ServletOutputStream for full control over the output.

doPost

protected void doPost(javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response)
               throws javax.servlet.ServletException,
                      java.io.IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
         javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     java.io.IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

cast

protected java.lang.Object cast(java.lang.Object value,
                    java.lang.reflect.Type type)
                         throws java.rmi.RemoteException

Tries to convert value to the given type.

Parameters:

value - The value to cast to a new type.

type - The desired type.

Returns:

The value, which may have been cast as the new type.

Throws:

java.rmi.RemoteException

getCapabilities

public java.util.Map<java.lang.String,java.lang.Object> getCapabilities()

Lists available methods.

serializeCompressedAmf3

protected void serializeCompressedAmf3(java.lang.Object objToSerialize,
                           javax.servlet.ServletOutputStream servletOutputStream)

deserializeAmf3

protected flex.messaging.io.amf.ASObject deserializeAmf3(java.io.InputStream inputStream)
                                                  throws java.lang.ClassNotFoundException,
                                                         java.io.IOException

Throws:

java.lang.ClassNotFoundException

java.io.IOException

methodToString

protected java.lang.String methodToString(java.lang.String name,
                              java.lang.Object[] params)