er.ajax.json

Class JSONRequestHandler

java.lang.Object

com.webobjects.appserver.WORequestHandler

er.ajax.json.JSONRequestHandler

public class JSONRequestHandler
extends WORequestHandler

JSONRequestHandler provides support for JSON RPC services that can be both stateless or stateful (using JSON Components).

Author:

mschrag

Properties

Name	Description
er.ajax.json.globalBacktrackCacheSize	the maximum number of global components that can be in the session (defaults to backtrack cache size)
er.ajax.json.backtrackCacheSize	the maximum number of non-global components that can be in the session (defaults to backtrack cache size)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	JSONRequestHandler.JSONComponentCallback
protected static class	JSONRequestHandler.LRUMap<U,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	RequestHandlerKey

Fields inherited from class com.webobjects.appserver.WORequestHandler

DidHandleRequestNotification

Constructor Summary

Constructors

Constructor and Description
JSONRequestHandler() Creates a new JSONRequestHandler.

Method Summary

Modifier and Type	Method and Description
static String	_jsonUrl(WOContext context, String requestHandlerKey, String componentNameAndInstance, String queryString) Returns a URL pointing to the JSON request handler.
protected static String	componentNameAndInstance(String componentName, String componentInstance)
protected org.jabsorb.JSONRPCBridge	createBridgeForComponent(JSONComponent component, String componentName, String componentInstance, Map<String,org.jabsorb.JSONRPCBridge> componentBridges)
org.jabsorb.JSONRPCBridge	getJSONBridge() Returns the shared JSON Bridge for this request handler.
WOResponse	handleRequest(WORequest request)
static String	jsonUrl(WOContext context, String queryString) Returns a URL pointing to the JSON request handler.
static String	jsonUrl(WOContext context, String requestHandlerKey, String queryString) Returns a URL pointing to the JSON request handler.
static String	jsonUrl(WOContext context, String componentName, String instance, String queryString) Returns a URL pointing to the JSON request handler for a JSON component.
static String	jsonUrl(WOContext context, String requestHandlerKey, String componentName, String componentInstance, String queryString) Returns a URL pointing to the JSON request handler.
static JSONRequestHandler	register() Registers the JSONRequestHandler with your application using the default key.
static void	registerClass(Class clazz) Registers all of the methods of the given class to be available for services to call (see JSONRPCBridge).
static void	registerClass(String name, Class clazz) Registers all of the methods of the given class to be available for services to call (see JSONRPCBridge).
static void	registerSerializer(org.jabsorb.serializer.Serializer serializer) Registers a custom serializer into the global JSON serializers (see JSONRPCBridge).
void	registerService(String name, Object serviceObject) Registers the given object in the shared JSON bridge.

Methods inherited from class com.webobjects.appserver.WORequestHandler

toString

Methods inherited from class java.lang.Object

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

Field Detail

RequestHandlerKey

public static final String RequestHandlerKey

See Also:

Constant Field Values

Constructor Detail

JSONRequestHandler

public JSONRequestHandler()

Creates a new JSONRequestHandler.

Method Detail

register

public static JSONRequestHandler register()

Registers the JSONRequestHandler with your application using the default key.

Returns:

the request handler instance

getJSONBridge

public org.jabsorb.JSONRPCBridge getJSONBridge()

Returns the shared JSON Bridge for this request handler.

Returns:

the shared JSON Bridge for this request handler

registerSerializer

public static void registerSerializer(org.jabsorb.serializer.Serializer serializer)
                               throws Exception

Registers a custom serializer into the global JSON serializers (see JSONRPCBridge).

Parameters:

serializer - the serializer to register

Throws:

Exception - if the registration fails

registerClass

public static void registerClass(Class clazz)
                          throws Exception

Registers all of the methods of the given class to be available for services to call (see JSONRPCBridge).

Parameters:

clazz - the class to register

Throws:

Exception - if the registration fails

registerClass

public static void registerClass(String name,
                                 Class clazz)
                          throws Exception

Registers all of the methods of the given class to be available for services to call (see JSONRPCBridge).

Parameters:

name - the namespace to register the methods under

clazz - the class to register

Throws:

Exception - if the registration fails

registerService

public void registerService(String name,
                            Object serviceObject)

Registers the given object in the shared JSON bridge. The shared JSON bridge is used for stateless JSON services. As an example, if you call registerService("myExampleService", new ExampleService()) you can then call json.myExampleService.someMethodInExampleService from your Javascript. The same instance is shared across all of your service users, so you should not store any state in this class.

Parameters:

name - the name to register the object as

serviceObject - the instance to register

jsonUrl

public static String jsonUrl(WOContext context,
                             String queryString)

Returns a URL pointing to the JSON request handler. This variant should be used for the shared web service endpoint.

Parameters:

context - the current WOContext

queryString - the query string to append

Returns:

a JSON request handler URL

jsonUrl

public static String jsonUrl(WOContext context,
                             String requestHandlerKey,
                             String queryString)

Returns a URL pointing to the JSON request handler. This variant should be used for the shared web service endpoint.

Parameters:

context - the current WOContext

requestHandlerKey - if you registered a custom JSON request handler key

queryString - the query string to append

Returns:

a JSON request handler URL

jsonUrl

public static String jsonUrl(WOContext context,
                             String componentName,
                             String instance,
                             String queryString)

Returns a URL pointing to the JSON request handler for a JSON component.

Parameters:

context - the current WOContext

componentName - the name of the component to lookup

instance - the instance identifier (any value) to create a unique instance (or null for a session-global)

queryString - the query string to append

Returns:

a JSON request handler URL

jsonUrl

public static String jsonUrl(WOContext context,
                             String requestHandlerKey,
                             String componentName,
                             String componentInstance,
                             String queryString)

Returns a URL pointing to the JSON request handler.

Parameters:

context - the current WOContext

requestHandlerKey - if you registered a custom JSON request handler key

componentName - the name of the component to lookup (or null for the shared bridge)

componentInstance - the instance identifier (any value) to create a unique instance (or null for a session-global)

queryString - the query string to append

Returns:

a JSON request handler URL

_jsonUrl

public static String _jsonUrl(WOContext context,
                              String requestHandlerKey,
                              String componentNameAndInstance,
                              String queryString)

Returns a URL pointing to the JSON request handler.

Parameters:

context - the current WOContext

requestHandlerKey - if you registered a custom JSON request handler key

componentNameAndInstance - the name/instance identifier of the component to lookup (or null for the shared bridge)

queryString - the query string to append

Returns:

a JSON request handler URL

handleRequest

public WOResponse handleRequest(WORequest request)

Specified by:

handleRequest in class WORequestHandler

componentNameAndInstance

protected static String componentNameAndInstance(String componentName,
                                                 String componentInstance)

createBridgeForComponent

protected org.jabsorb.JSONRPCBridge createBridgeForComponent(JSONComponent component,
                                                             String componentName,
                                                             String componentInstance,
                                                             Map<String,org.jabsorb.JSONRPCBridge> componentBridges)
                                                      throws Exception

Throws:

Exception