View Javadoc

1   /**********************************************************************
2    * ServerHandler.java
3    * created on 07.08.2004 by netseeker
4    * $Source: /cvsroot/ejoe/EJOE/src/de/netseeker/ejoe/handler/ServerHandler.java,v $
5    * $Date: 2007/11/17 10:57:00 $
6    * $Revision: 1.8 $
7    *
8    * ====================================================================
9    *
10   *  Copyright 2005-2006 netseeker aka Michael Manske
11   *
12   *  Licensed under the Apache License, Version 2.0 (the "License");
13   *  you may not use this file except in compliance with the License.
14   *  You may obtain a copy of the License at
15   *
16   *      http://www.apache.org/licenses/LICENSE-2.0
17   *
18   *  Unless required by applicable law or agreed to in writing, software
19   *  distributed under the License is distributed on an "AS IS" BASIS,
20   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21   *  See the License for the specific language governing permissions and
22   *  limitations under the License.
23   * ====================================================================
24   *
25   * This file is part of the ejoe framework.
26   * For more information on the author, please see
27   * <http://www.manskes.de/>.
28   *
29   *********************************************************************/
30  
31  package de.netseeker.ejoe.handler;
32  
33  import java.io.Serializable;
34  
35  /***
36   * Simple interface defining the entry point for all server handlers. Server handlers are the working horses which the
37   * caller must implement. Server handlers take the transported input objects send by the client application and return
38   * none, one or more return values.
39   * 
40   * @author netseeker aka Michael Manske
41   * @since 0.3.0
42   */
43  public interface ServerHandler extends Serializable
44  {
45      /***
46       * Handles a client request
47       * 
48       * @param obj The input object transported by EJOE
49       * @return null or an valid return value. If you want return custom datatypes, eg. your own beans and don't want (or
50       *         are not able) to deploy the classes of these datatypes on the client you can turn on EJOEs remote
51       *         classloading feature.
52       */
53      public Object handle( Object obj ) throws Exception;
54  }