/* * Copyright 2010-2012 Amazon Technologies, Inc. or its affiliates. * Amazon, Amazon.com and Carbonado are trademarks or registered trademarks * of Amazon Technologies, Inc. or its affiliates. All rights reserved. * * Licensed 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 com.amazon.carbonado.capability; import com.amazon.carbonado.RepositoryException; /** * Capability which allows arbitrary code to run on a remote host and access * its repository. The remote procedure might have security restrictions * applied to it. * *

Examples:

 * RemoteProcedureCapability cap = ...
 * Cursor<MyRecord> c1 = cap.beginCall(new CustomQuery<MyRecord>(params)).fetchReply();
 * ...
 *
 * Cursor<InputRecord> c2 = ...
 * cap.beginCall(new Importer<InputRecord>()).sendAll(c2).finish();
 * 
* * @author Brian S O'Neill * @see RemoteProcedure */ public interface RemoteProcedureCapability extends Capability { /** * Begins a call to execute the given procedure on a remote host. * Execution commences when the Call object is instructed to do so. * * @param reply object type * @param request data object type * @param proc procedure to execute * @return object for defining the call and receiving a reply */ RemoteProcedure.Call beginCall(RemoteProcedure proc) throws RepositoryException; }