KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cayenne > remote > ClientConnection


1 /*****************************************************************
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  ****************************************************************/
19
20 package org.apache.cayenne.remote;
21
22 import org.apache.cayenne.CayenneRuntimeException;
23 import org.apache.cayenne.event.EventBridge;
24
25 /**
26  * A connection object used to interact with a remote Cayenne server. Connection supports
27  * synchronous interaction via {@link #sendMessage(ClientMessage)} and asynchronous
28  * listening for server events.
29  *
30  * @since 1.2
31  * @author Andrus Adamchik
32  */
33 public interface ClientConnection {
34
35     /**
36      * Returns an EventBridge that receives remote server events. Caller would normally
37      * register returned bridge with a local EventManager, thus allowing local listeners
38      * to receive server events.
39      *
40      * @return An EventBridge or null if server events are not supported.
41      */
42     EventBridge getServerEventBridge() throws CayenneRuntimeException;
43
44     /**
45      * Sends a synchronous ClientMessage to the server, returning a reply.
46      */
47     Object JavaDoc sendMessage(ClientMessage message) throws CayenneRuntimeException;
48 }
49
Popular Tags