diff options
| author | Brian S. O'Neill <bronee@gmail.com> | 2010-08-03 01:18:59 +0000 |
|---|---|---|
| committer | Brian S. O'Neill <bronee@gmail.com> | 2010-08-03 01:18:59 +0000 |
| commit | 71d4454ac1705ad35e63ab2f5127da22b2900eb7 (patch) | |
| tree | d67548933ece8367a9f04b1e1f7d94c96d5df910 /src/main/java/com/amazon/carbonado/capability/RemoteProcedureCapability.java | |
| parent | 6c764e0d6026dac1b2a1fe0ec088535ac7cc3c7f (diff) | |
Add support for remote procedure calls.
Diffstat (limited to 'src/main/java/com/amazon/carbonado/capability/RemoteProcedureCapability.java')
| -rw-r--r-- | src/main/java/com/amazon/carbonado/capability/RemoteProcedureCapability.java | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/src/main/java/com/amazon/carbonado/capability/RemoteProcedureCapability.java b/src/main/java/com/amazon/carbonado/capability/RemoteProcedureCapability.java new file mode 100644 index 0000000..92e0712 --- /dev/null +++ b/src/main/java/com/amazon/carbonado/capability/RemoteProcedureCapability.java @@ -0,0 +1,52 @@ +/*
+ * Copyright 2010 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.
+ *
+ * <p>Examples:<pre>
+ * RemoteProcedureCapability cap = ...
+ * Cursor<MyRecord> c1 = cap.beginCall(new CustomQuery<MyRecord>(params)).fetchReply();
+ * ...
+ *
+ * Cursor<InputRecord> c2 = ...
+ * cap.beginCall(new Importer<InputRecord>()).sendAll(c2).finish();
+ * </pre>
+ *
+ * @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 <R> reply object type
+ * @param <D> request data object type
+ * @param proc procedure to execute
+ * @return object for defining the call and receiving a reply
+ */
+ <R, D> RemoteProcedure.Call<R, D> beginCall(RemoteProcedure<R, D> proc)
+ throws RepositoryException;
+}
|