org.apache.turbine.services.jsonrpc

Interface JsonRpcService

All Superinterfaces:

Initable, Service

All Known Implementing Classes:

TurbineJsonRpcService

public interface JsonRpcService
extends Service

The interface an JsonRpcService implements.

Version:

$Id: JsonRpcService.java 1860619 2019-06-04 14:01:15Z gk $

Author:

Scott Eade

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME TurbineJsonRpcService.

Method Summary

Modifier and Type	Method and Description
void	clearBridge(HttpSession session) Remove the JSONRPCBridge from the session
org.jabsorb.JSONRPCBridge	getBridge(HttpSession session) Get the JSONRPCBridge from the session
Object	processCall(CharArrayWriter cdata, org.jabsorb.JSONRPCBridge json_bridge, HttpServletRequest request) Process a JSON RPC call
void	registerObject(HttpSession session, String key, Object value) Register an object with the JSONRPCBridge in a given session
void	registerObjectGlobal(String key, Object value) Register an object with the JSONRPCBridge globally

Methods inherited from interface org.apache.turbine.services.Service

getConfiguration, getName, getProperties, setName, setServiceBroker

Methods inherited from interface org.apache.turbine.services.Initable

getInit, init, init, setInitableBroker, shutdown

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

TurbineJsonRpcService.

See Also:

Constant Field Values

Method Detail

processCall

Object processCall(CharArrayWriter cdata,
                   org.jabsorb.JSONRPCBridge json_bridge,
                   HttpServletRequest request)

Process a JSON RPC call

Parameters:

cdata - the JSON data

json_bridge - the JSONRPCBridge object

request - the request

Returns:

the return object of the JSON RPC call

registerObject

void registerObject(HttpSession session,
                    String key,
                    Object value)

Register an object with the JSONRPCBridge in a given session

Parameters:

session - the session

key - the name of the object in the session

value - the object to register (not null)

registerObjectGlobal

void registerObjectGlobal(String key,
                          Object value)

Register an object with the JSONRPCBridge globally

Parameters:

key - the name of the object in the session

value - the object to register (not null)

getBridge

org.jabsorb.JSONRPCBridge getBridge(HttpSession session)

Get the JSONRPCBridge from the session

Parameters:

session - the session

Returns:

the JSONRPCBridge instance

clearBridge

void clearBridge(HttpSession session)

Remove the JSONRPCBridge from the session

Parameters:

session - the session