HessianService


1   /* ====================================================================
2    * 
3    * The ObjectStyle Group Software License, version 1.1
4    * ObjectStyle Group - http://objectstyle.org/
5    * 
6    * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7    * of the software. All rights reserved.
8    * 
9    * Redistribution and use in source and binary forms, with or without
10   * modification, are permitted provided that the following conditions
11   * are met:
12   * 
13   * 1. Redistributions of source code must retain the above copyright
14   *    notice, this list of conditions and the following disclaimer.
15   * 
16   * 2. Redistributions in binary form must reproduce the above copyright
17   *    notice, this list of conditions and the following disclaimer in
18   *    the documentation and/or other materials provided with the
19   *    distribution.
20   * 
21   * 3. The end-user documentation included with the redistribution, if any,
22   *    must include the following acknowlegement:
23   *    "This product includes software developed by independent contributors
24   *    and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25   *    Alternately, this acknowlegement may appear in the software itself,
26   *    if and wherever such third-party acknowlegements normally appear.
27   * 
28   * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29   *    or promote products derived from this software without prior written
30   *    permission. For written permission, email
31   *    "andrus at objectstyle dot org".
32   * 
33   * 5. Products derived from this software may not be called "ObjectStyle"
34   *    or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35   *    names without prior written permission.
36   * 
37   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40   * DISCLAIMED.  IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48   * SUCH DAMAGE.
49   * ====================================================================
50   * 
51   * This software consists of voluntary contributions made by many
52   * individuals and hosted on ObjectStyle Group web site.  For more
53   * information on the ObjectStyle Group, please see
54   * <http://objectstyle.org/>.
55   */
56  package org.objectstyle.cayenne.distribution;
57  
58  /**
59   * Service interface needed for server-side deployment with HessianConnector. A mapping in
60   * web.xml may look like this:
61   * 
62   * <pre>
63   *      &lt;servlet&gt;
64   *        &lt;servlet-name&gt;cayenne&lt;/servlet-name&gt;
65   *        &lt;servlet-class&gt;com.caucho.hessian.server.HessianServlet&lt;/servlet-class&gt;
66   *        &lt;!-- Cayenne service API --&gt;
67   *        &lt;init-param&gt;
68   *          &lt;param-name&gt;api-class&lt;/param-name&gt;
69   *          &lt;param-value&gt;org.objectstyle.cayenne.distribution.HessianService&lt;/param-value&gt;
70   *        &lt;/init-param&gt;
71   *        &lt;!-- Cayenne service implementation --&gt;
72   *        &lt;init-param&gt;
73   *          &lt;param-name&gt;service-class&lt;/param-name&gt;
74   *          &lt;param-value&gt;org.objectstyle.cayenne.service.HessianServiceHandler&lt;/param-value&gt;
75   *        &lt;/init-param&gt;
76   *      &lt;/servlet&gt;
77   *      &lt;servlet-mapping&gt;
78   *        &lt;servlet-name&gt;cayenne&lt;/servlet-name&gt;
79   *        &lt;url-pattern&gt;/cayenne&lt;/url-pattern&gt;
80   *      &lt;/servlet-mapping&gt;
81   * </pre>
82   * 
83   * @since 1.2
84   * @author Andrus Adamchik
85   */
86  public interface HessianService {
87  
88      /**
89       * Establishes a session with CayenneService. Performs client authentication and
90       * authorization and in case of success returns a new session id.
91       */
92      String   establishSession(String   userName, String   password);
93  
94      /**
95       * Processes message on a remote server, returning the result of such processing.
96       */
97      Object   processMessage(String   sessionId, ClientMessage message) throws Throwable  ;
98  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags