diff options
Diffstat (limited to 'sandbox/jboynes/sca-client/src/main/java/org/osoa/sca/ServiceReference.java')
-rw-r--r-- | sandbox/jboynes/sca-client/src/main/java/org/osoa/sca/ServiceReference.java | 102 |
1 files changed, 102 insertions, 0 deletions
diff --git a/sandbox/jboynes/sca-client/src/main/java/org/osoa/sca/ServiceReference.java b/sandbox/jboynes/sca-client/src/main/java/org/osoa/sca/ServiceReference.java new file mode 100644 index 0000000000..0841b8b2c7 --- /dev/null +++ b/sandbox/jboynes/sca-client/src/main/java/org/osoa/sca/ServiceReference.java @@ -0,0 +1,102 @@ +/* + * 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.osoa.sca; + + +/** + * A ServiceReference represents a client's perspective of a reference to another service. + * + * @version $Rev$ $Date$ + */ +public interface ServiceReference<B> { + /** + * Returns a type-safe reference to the target of this reference. + * The instance returned is guaranteed to implement the business interface for this reference + * but may not be a proxy as defined by java.lang.reflect.Proxy. + * + * @return a proxy to the target that implements the business interface associated with this reference + */ + B getService(); + + /** + * Returns the Java class for the business interface associated with this reference. + * + * @return the Class for the business interface associated with this reference + */ + Class<B> getBusinessInterface(); + + /** + * Returns true if this reference is conversational. + * + * @return true if this reference is conversational + */ + boolean isConversational(); + + /** + * Returns the current conversation associated with this reference. + * + * @return the current conversation associated with this reference; null if there is no active conversation + * @throws IllegalStateException if this reference is not conversational + */ + Conversation getConversation() throws IllegalStateException; + + /** + * Returns the id supplied by the user that will be associated with conversations initiated through this reference. + * + * @return the id to associated with any conversation initiated through this reference + */ + Object getConversationID(); + + /** + * Set the id to associate with any conversation started through this reference. + * If the value supplied is null then the id will be generated by the implementation. + * + * @param conversationId the user-defined id to associated with a conversation + * @throws IllegalStateException if a conversation is currently associated with this reference + */ + void setConversationID(Object conversationId) throws IllegalStateException; + + /** + * Returns the callback ID. + * + * @return the callback ID + */ + Object getCallbackID(); + + /** + * Sets the callback ID. + * + * @param callbackID the callback ID + */ + void setCallbackID(Object callbackID); + + /** + * Returns the callback object. + * + * @return the callback object + */ + Object getCallback(); + + /** + * Sets the callback object. + * + * @param callback the callback object + */ + void setCallback(Object callback); +} |