summaryrefslogtreecommitdiffstats
path: root/sandbox/jboynes/sca-client/src/main/java/org/osoa/sca/ComponentContext.java
diff options
context:
space:
mode:
Diffstat (limited to 'sandbox/jboynes/sca-client/src/main/java/org/osoa/sca/ComponentContext.java')
-rw-r--r--sandbox/jboynes/sca-client/src/main/java/org/osoa/sca/ComponentContext.java75
1 files changed, 75 insertions, 0 deletions
diff --git a/sandbox/jboynes/sca-client/src/main/java/org/osoa/sca/ComponentContext.java b/sandbox/jboynes/sca-client/src/main/java/org/osoa/sca/ComponentContext.java
new file mode 100644
index 0000000000..44f2503d05
--- /dev/null
+++ b/sandbox/jboynes/sca-client/src/main/java/org/osoa/sca/ComponentContext.java
@@ -0,0 +1,75 @@
+package org.osoa.sca;
+
+/**
+ * @version $Rev$ $Date$
+ */
+public interface ComponentContext {
+ /**
+ * Returns the absolute URI of the component within the SCA Domain.
+ *
+ * @return the absolute URI of the component
+ */
+ String getURI();
+
+ /**
+ * Cast a type-safe reference to a ServiceReference.
+ * Converts a type-safe reference returned by locateService to an equivalent ServiceReference.
+ *
+ * @param target a reference proxy provided by the SCA runtime
+ * @return a ServiceReference equivalent for the proxy
+ * @throws IllegalArgumentException if the supplied instance is not a reference supplied by the SCA runtime
+ */
+ <B> ServiceReference<B> cast(B target) throws IllegalArgumentException;
+
+ /**
+ * Returns a proxy for a reference defined by this component.
+ *
+ * @param businessInterface the interface that will be used to invoke the service
+ * @param referenceName the name of the reference
+ * @return an object that implements the business interface
+ */
+ <B> B getService(Class<B> businessInterface, String referenceName);
+
+ /**
+ * Returns a ServiceReference for a reference defined by this component.
+ *
+ * @param businessInterface the interface that will be used to invoke the service
+ * @param referenceName the name of the reference
+ * @return a ServiceReference for the designated reference
+ */
+ <B> ServiceReference<B> getServiceReference(Class<B> businessInterface, String referenceName);
+
+ /**
+ * Returns the value of an SCA property defined by this component.
+ *
+ * @param type the Java type to be returned for the property
+ * @param propertyName the name of the property whose value should be returned
+ * @return the property value
+ */
+ <B> B getProperty(Class<B> type, String propertyName);
+
+ /**
+ * Returns a ServiceReference that can be used to invoke this component over the default service.
+ *
+ * @param businessInterface the interface that will be used to invoke the service
+ * @return a ServiceReference that will invoke this component
+ */
+ <B> ServiceReference<B> createSelfReference(Class<B> businessInterface);
+
+ /**
+ * Returns a ServiceReference that can be used to invoke this component over the designated service.
+ *
+ * @param businessInterface the interface that will be used to invoke the service
+ * @param serviceName the name of the service to invoke
+ * @return a ServiceReference that will invoke this component
+ */
+ <B> ServiceReference<B> createSelfReference(Class<B> businessInterface, String serviceName);
+
+ /**
+ * Returns the context for the current SCA service request, or null if there is no current request
+ * or if the context is unavailable.
+ *
+ * @return the SCA request context; may be null
+ */
+ RequestContext getRequestContext();
+}