/*****************************************************************
 *   Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 ****************************************************************/

package org.apache.cayenne.remote;

import java.rmi.Remote;
import java.rmi.RemoteException;

/**
 * Interface of a Cayenne remote service.
 * 
 * @since 1.2
 * @see org.apache.cayenne.remote.hessian.service.HessianServlet
 * @author Andrus Adamchik
 */
public interface RemoteService extends Remote {

    /**
     * Establishes a dedicated session with Cayenne DataChannel, returning session id.
     */
    RemoteSession establishSession() throws RemoteException;

    /**
     * Creates a new session with the specified or joins an existing one. This method is
     * used to bootstrap collaborating clients of a single "group chat".
     */
    RemoteSession establishSharedSession(String name) throws RemoteException;

    /**
     * Processes message on a remote server, returning the result of such processing.
     */
    Object processMessage(ClientMessage message) throws RemoteException, Throwable;
}
