001package org.apache.turbine.services.jsonrpc; 002 003/* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022import java.io.CharArrayWriter; 023 024import javax.servlet.http.HttpServletRequest; 025import javax.servlet.http.HttpSession; 026 027import org.apache.turbine.services.Service; 028import org.jabsorb.JSONRPCBridge; 029 030 031/** 032 * The interface an JsonRpcService implements. 033 * 034 * @author <a href="mailto:seade@backstagetech.com.au">Scott Eade</a> 035 * @version $Id$ 036 */ 037public interface JsonRpcService 038 extends Service 039{ 040 /** TurbineJsonRpcService. */ 041 String SERVICE_NAME = "JsonRpcService"; 042 043 /** 044 * Process a JSON RPC call 045 * @param cdata the JSON data 046 * @param json_bridge the {@link JSONRPCBridge} object 047 * @param request the request 048 * @return the return object of the JSON RPC call 049 */ 050 Object processCall(CharArrayWriter cdata, 051 JSONRPCBridge json_bridge, HttpServletRequest request); 052 053 /** 054 * Register an object with the {@link JSONRPCBridge} in a given session 055 * 056 * @param session the session 057 * @param key the name of the object in the session 058 * @param value the object to register (not null) 059 */ 060 void registerObject(HttpSession session, String key, Object value); 061 062 /** 063 * Register an object with the {@link JSONRPCBridge} globally 064 * 065 * @param key the name of the object in the session 066 * @param value the object to register (not null) 067 */ 068 void registerObjectGlobal(String key, Object value); 069 070 /** 071 * Get the {@link JSONRPCBridge} from the session 072 * 073 * @param session the session 074 * @return the {@link JSONRPCBridge} instance 075 */ 076 JSONRPCBridge getBridge(HttpSession session); 077 078 /** 079 * Remove the {@link JSONRPCBridge} from the session 080 * 081 * @param session the session 082 */ 083 void clearBridge(HttpSession session); 084}