You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuscany.apache.org by sl...@apache.org on 2007/05/18 12:05:17 UTC
svn commit: r539355 - in
/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca:
core/ event/ invocation/ provider/ runtime/
Author: slaws
Date: Fri May 18 03:05:14 2007
New Revision: 539355
URL: http://svn.apache.org/viewvc?view=rev&rev=539355
Log:
Tidy javadoc comments to remove warnings that appear during javadoc generation
Modified:
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/DefaultExtensionPointRegistry.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/DefaultModelFactoryExtensionPoint.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/ExtensionPointRegistry.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/ModelFactoryExtensionPoint.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/Event.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/EventFilter.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/EventPublisher.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/RuntimeEventListener.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/TrueFilter.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Interceptor.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/InvocationChain.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Invoker.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Message.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/MessageFactory.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/BindingProviderFactory.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/DefaultProviderFactoryExtensionPoint.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ImplementationProvider.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ImplementationProviderFactory.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ProviderFactoryExtensionPoint.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ReferenceBindingProvider.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ServiceBindingProvider.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/DefaultWireProcessorExtensionPoint.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/EndpointReference.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponent.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponentReference.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponentService.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeWire.java
incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeWireProcessorExtensionPoint.java
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/DefaultExtensionPointRegistry.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/DefaultExtensionPointRegistry.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/DefaultExtensionPointRegistry.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/DefaultExtensionPointRegistry.java Fri May 18 03:05:14 2007
@@ -48,9 +48,8 @@
/**
* Get the extension point by the interface that it implements
- * @param <T>
- * @param extensionPointType
- * @return
+ * @param extensionPointType The lookup key (extension point interface)
+ * @return The instance of the extension point
*/
public <T> T getExtensionPoint(Class<T> extensionPointType) {
return extensionPointType.cast(extensionPoints.get(extensionPointType));
@@ -58,7 +57,7 @@
/**
* Remove an extension point based on the interface that it implements
- * @param extensionPoint
+ * @param extensionPoint The extension point to remove
*/
public void removeExtensionPoint(Object extensionPoint) {
Class[] interfaces = extensionPoint.getClass().getInterfaces();
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/DefaultModelFactoryExtensionPoint.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/DefaultModelFactoryExtensionPoint.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/DefaultModelFactoryExtensionPoint.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/DefaultModelFactoryExtensionPoint.java Fri May 18 03:05:14 2007
@@ -30,6 +30,11 @@
private HashMap<Class<?>, Object> factories = new HashMap<Class<?>, Object>();
+ /**
+ * Add a model factory extension.
+ *
+ * @param factory The factory to add
+ */
public void addFactory(Object factory) {
Class[] interfaces = factory.getClass().getInterfaces();
for (int i = 0; i<interfaces.length; i++) {
@@ -37,6 +42,11 @@
}
}
+ /**
+ * Remove a model factory extension.
+ *
+ * @param factory The factory to remove
+ */
public void removeFactory(Object factory) {
Class[] interfaces = factory.getClass().getInterfaces();
for (int i = 0; i<interfaces.length; i++) {
@@ -44,6 +54,11 @@
}
}
+ /**
+ * Get a factory implementing the given interface.
+ * @param factoryInterface The lookup key (factory interface)
+ * @return The factory
+ */
public <T> T getFactory(Class<T> factoryInterface) {
Object factory = factories.get(factoryInterface);
return factoryInterface.cast(factory);
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/ExtensionPointRegistry.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/ExtensionPointRegistry.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/ExtensionPointRegistry.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/ExtensionPointRegistry.java Fri May 18 03:05:14 2007
@@ -37,15 +37,14 @@
/**
* Get the extension point by the interface
- * @param <T>
- * @param extensionPointType
- * @return
+ * @param extensionPointType The lookup key (extension point interface)
+ * @return The instance of the extension point
*/
<T> T getExtensionPoint(Class<T> extensionPointType);
/**
* Remove an extension point
- * @param extensionPoint
+ * @param extensionPoint The extension point to remove
*/
void removeExtensionPoint(Object extensionPoint);
}
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/ModelFactoryExtensionPoint.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/ModelFactoryExtensionPoint.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/ModelFactoryExtensionPoint.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/core/ModelFactoryExtensionPoint.java Fri May 18 03:05:14 2007
@@ -33,21 +33,21 @@
/**
* Add a model factory extension.
*
- * @param factory the factory to add
+ * @param factory The factory to add
*/
void addFactory(Object factory);
/**
* Remove a model factory extension.
*
- * @param factory
+ * @param factory The factory to remove
*/
void removeFactory(Object factory);
/**
* Get a factory implementing the given interface.
- * @param factoryInterface the factory interface
- * @return
+ * @param factoryInterface the lookup key (factory interface)
+ * @return The factory
*/
<T> T getFactory(Class<T> factoryInterface);
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/Event.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/Event.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/Event.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/Event.java Fri May 18 03:05:14 2007
@@ -19,7 +19,7 @@
package org.apache.tuscany.sca.event;
/**
- * Represents an event that is propagated in the runtime
+ * The base interface for events that are propagated in the runtime
*
* @version $$Rev$$ $$Date$$
*/
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/EventFilter.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/EventFilter.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/EventFilter.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/EventFilter.java Fri May 18 03:05:14 2007
@@ -27,6 +27,8 @@
/**
* Performs the actual evaluation on an event
+ * @param event Returns true if the event matches implemented criteria
+ * @return Match result
*/
boolean match(Event event);
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/EventPublisher.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/EventPublisher.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/EventPublisher.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/EventPublisher.java Fri May 18 03:05:14 2007
@@ -19,32 +19,37 @@
package org.apache.tuscany.sca.event;
/**
- * Publishes events in the runtime
+ * Publishes events in the runtime by accepting {@link Event} objects and
+ * forwarding them to all registered {@link RuntimeEventListener} objects.
*
* @version $$Rev$$ $$Date$$
*/
public interface EventPublisher {
/**
- * Publish an event
+ * Publish an event to all regisitered listeners
+ * @param object The event to publich
*/
void publish(Event object);
/**
* Registers a listener to receive notifications for the context
+ * @param listener The listener to add
*/
void addListener(RuntimeEventListener listener);
/**
* Registers a listener to receive notifications for the context
+ * @param filter The filter that will be applied before the lister is called
+ * @param listener The lister to add
*/
void addListener(EventFilter filter, RuntimeEventListener listener);
/**
* Removes a previously registered listener
+ * @param listener The listener to remove
*/
void removeListener(RuntimeEventListener listener);
-
}
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/RuntimeEventListener.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/RuntimeEventListener.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/RuntimeEventListener.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/RuntimeEventListener.java Fri May 18 03:05:14 2007
@@ -27,5 +27,9 @@
*/
public interface RuntimeEventListener extends EventListener {
+ /**
+ * Accepts and event and acts on it
+ * @param event The event to act on
+ */
void onEvent(Event event);
}
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/TrueFilter.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/TrueFilter.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/TrueFilter.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/event/TrueFilter.java Fri May 18 03:05:14 2007
@@ -25,6 +25,12 @@
*/
public class TrueFilter implements EventFilter {
+ /**
+ * Performs the actual evaluation on an event. Always returns true
+ * in this case
+ * @param event The incoming event which is ignored
+ * @return true
+ */
public boolean match(Event event) {
return true;
}
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Interceptor.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Interceptor.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Interceptor.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Interceptor.java Fri May 18 03:05:14 2007
@@ -19,7 +19,7 @@
package org.apache.tuscany.sca.invocation;
/**
- * Synchronous, around-style mediation associated with a client- or target- side wire.
+ * Synchronous mediation associated with a client- or target- side wire.
*
* @version $Rev$ $Date$
*/
@@ -27,11 +27,13 @@
/**
* Sets the next invoker
+ * @param next The next invoker
*/
void setNext(Invoker next);
/**
* Returns the next invoker or null
+ * @return The next Invoker
*/
Invoker getNext();
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/InvocationChain.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/InvocationChain.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/InvocationChain.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/InvocationChain.java Fri May 18 03:05:14 2007
@@ -23,7 +23,7 @@
/**
* A wire consists of 1..n invocation chains associated with the operations of its source service contract.
* <p/>
- * Invocation chains may contain </ode>Interceptors</code> that process invocations in an around-style manner.
+ * Invocation chains may contain </code>Interceptors</code> that process invocations.
* <p/>
* A <code>Message</code> is used to pass data associated with an invocation through the chain.
*
@@ -33,50 +33,50 @@
/**
* Returns the target operation for this invocation chain.
*
- * @return the target operation for this invocation chain
+ * @return The target operation for this invocation chain
*/
Operation getTargetOperation();
/**
* Returns the source operation for this invocation chain.
*
- * @return the source operation for this invocation chain
+ * @return The source operation for this invocation chain
*/
Operation getSourceOperation();
/**
* Adds an interceptor to the chain
*
- * @param interceptor the interceptor to add
+ * @param interceptor The interceptor to add
*/
void addInterceptor(Interceptor interceptor);
/**
* Adds an invoker to the chain
*
- * @param invoker the invoker to add
+ * @param invoker The invoker to add
*/
void addInvoker(Invoker invoker);
/**
* Returns the first invoker in the chain.
*
- * @return the first invoker in the chain
+ * @return The first invoker in the chain
*/
Invoker getHeadInvoker();
/**
* Returns the last invoker in the chain.
*
- * @return the last invoker in the chain
+ * @return The last invoker in the chain
*/
Invoker getTailInvoker();
/**
* Adds an interceptor at the given position in the interceptor stack
*
- * @param index the position in the interceptor stack to add the interceptor
- * @param interceptor the interceptor to add
+ * @param index The position in the interceptor stack to add the interceptor
+ * @param interceptor The interceptor to add
*/
void addInterceptor(int index, Interceptor interceptor);
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Invoker.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Invoker.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Invoker.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Invoker.java Fri May 18 03:05:14 2007
@@ -19,7 +19,7 @@
package org.apache.tuscany.sca.invocation;
/**
- * Synchronous, around-style mediation associated with a client- or target- side wire.
+ * Synchronous mediation associated with a client- or target- side wire.
*
* @version $Rev$ $Date$
*/
@@ -28,8 +28,8 @@
/**
* Process a synchronous wire
*
- * @param msg the request Message for the wire
- * @return the response Message from the wire
+ * @param msg The request Message for the wire
+ * @return The response Message from the wire
*/
Message invoke(Message msg);
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Message.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Message.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Message.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/Message.java Fri May 18 03:05:14 2007
@@ -30,74 +30,81 @@
/**
* Returns the body of the message, which will be the payload or parameters associated with the wire
+ * @return The body of the message
*/
<T> T getBody();
/**
* Sets the body of the message.
+ * @param body The body of the message
*/
<T> void setBody(T body);
/**
* Get the conversation id
- * @return
+ * @return The conversation ID
*/
String getConversationID();
/**
* Set the conversation id
- * @param conversationId
+ * @param conversationId The conversation ID
*/
void setConversationID(String conversationId);
/**
- * Get the URI of the source reference
- * @return
+ * Get the end point reference of the source reference
+ * @return The end point reference of the reference originating the message
*/
EndpointReference getFrom();
/**
- *
- * @param from
+ * Set the end point reference of the reference originating the message
+ * @param from The end point reference of the reference originating the message
*/
void setFrom(EndpointReference from);
/**
- * Get the URI of target service
- * @return
+ * Get the end point reference of target service
+ * @return The end point reference of the service that the message targets
*/
EndpointReference getTo();
/**
- * @param to
+ * Set the end point reference of target service
+ * @param to The end point reference of the service that the message targets
*/
void setTo(EndpointReference to);
/**
* Returns the id of the message
+ * @return The message Id
*/
Object getMessageID();
/**
* Sets the id of the message
+ * @param messageId The message ID
*/
void setMessageID(Object messageId);
/**
* Returns the correlation id of the message or null if one is not available. Correlation ids are used by transports
* for message routing.
+ * @return The correlation Id
*/
Object getCorrelationID();
/**
* Sets the correlation id of the message. Correlation ids are used by transports for message routing.
+ * @param correlationId The correlation Id
*/
void setCorrelationID(Object correlationId);
/**
* Determines if the message represents a fault/exception
*
- * @return true if the message body is a fault object, false if the body is a normal payload
+ * @return true If the message body is a fault object, false if the body is a normal payload
*/
boolean isFault();
@@ -111,14 +118,14 @@
/**
* Returns the conversational sequence the message is associated with, NONE, START, CONTINUE, or END on TargetInvoker}
*
- * @return the conversational sequence the message is associated with
+ * @return The conversational sequence the message is associated with
*/
ConversationSequence getConversationSequence();
/**
* Returns the conversational sequence the message is associated with, NONE, START, CONTINUE, or END
*
- * @param sequence the conversational sequence
+ * @param sequence The conversational sequence
*/
void setConversationSequence(ConversationSequence sequence);
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/MessageFactory.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/MessageFactory.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/MessageFactory.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/invocation/MessageFactory.java Fri May 18 03:05:14 2007
@@ -29,7 +29,7 @@
/**
* Creates a new message.
*
- * @return
+ * @return The new message
*/
Message createMessage();
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/BindingProviderFactory.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/BindingProviderFactory.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/BindingProviderFactory.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/BindingProviderFactory.java Fri May 18 03:05:14 2007
@@ -25,6 +25,8 @@
import org.apache.tuscany.sca.runtime.RuntimeComponentService;
/**
+ * A factory for creating the runtime artifacts that represent bindings.
+ *
* @version $Rev$ $Date$
*/
public interface BindingProviderFactory<M extends Binding> extends ProviderFactory<M> {
@@ -33,10 +35,10 @@
* Creates a new reference binding provider for the given component and
* reference.
*
- * @param component
- * @param reference
- * @param binding
- * @return
+ * @param component The runtime component
+ * @param reference The reference on the runtime component
+ * @param binding The binding assembly model object
+ * @return The binding provider
*/
ReferenceBindingProvider createReferenceBindingProvider(RuntimeComponent component,
RuntimeComponentReference reference,
@@ -46,10 +48,10 @@
* Creates a new service binding provider for the given component and
* service.
*
- * @param component
- * @param service
- * @param binding
- * @return
+ * @param component The runtime component
+ * @param service The service on the runtime component
+ * @param binding The binding assembly model object
+ * @return The binding provider
*/
ServiceBindingProvider createServiceBindingProvider(RuntimeComponent component,
RuntimeComponentService service,
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/DefaultProviderFactoryExtensionPoint.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/DefaultProviderFactoryExtensionPoint.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/DefaultProviderFactoryExtensionPoint.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/DefaultProviderFactoryExtensionPoint.java Fri May 18 03:05:14 2007
@@ -32,17 +32,36 @@
protected final Map<Class<?>, ProviderFactory> providerFactories =
new HashMap<Class<?>, ProviderFactory>();
+ /**
+ * The default constructor. Does nothing.
+ *
+ */
public DefaultProviderFactoryExtensionPoint() {
}
+ /**
+ * Add a provider factory.
+ *
+ * @param providerFactory The provider factory
+ */
public void addProviderFactory(ProviderFactory providerFactory) {
providerFactories.put(providerFactory.getModelType(), providerFactory);
}
+ /**
+ * Remove a provider factory.
+ *
+ * @param providerFactory The provider factory
+ */
public void removeProviderFactory(ProviderFactory providerFactory) {
providerFactories.remove(providerFactory.getModelType());
}
+ /**
+ * Returns the provider factory associated with the given model type.
+ * @param modelType A model type
+ * @return The provider factory associated with the given model type
+ */
public ProviderFactory getProviderFactory(Class<?> modelType) {
Class<?>[] classes = modelType.getInterfaces();
for (Class<?> c : classes) {
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ImplementationProvider.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ImplementationProvider.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ImplementationProvider.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ImplementationProvider.java Fri May 18 03:05:14 2007
@@ -24,8 +24,8 @@
import org.apache.tuscany.sca.runtime.RuntimeComponentService;
/**
- * A component implementation can implement this interface to provide additional logic
- * to the Tuscany runtime
+ * A component implementation can implement this interface in order to tie
+ * into the Tuscany runtime
*
* @version $Rev$ $Date$
*/
@@ -57,7 +57,6 @@
/**
* Create an invoker to call back to the given component
- * @param component The component that receives the callback
* @param operation The operation
* @return An invoker that handles the invocation logic, null should be
* returned if no invoker is required
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ImplementationProviderFactory.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ImplementationProviderFactory.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ImplementationProviderFactory.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ImplementationProviderFactory.java Fri May 18 03:05:14 2007
@@ -23,6 +23,8 @@
import org.apache.tuscany.sca.runtime.RuntimeComponent;
/**
+ * An interface for factories that create implementation providers.
+ *
* @version $Rev$ $Date$
*/
public interface ImplementationProviderFactory<M extends Implementation> extends ProviderFactory<M> {
@@ -31,9 +33,9 @@
* Creates a new implementation provider for the given
* component.
*
- * @param component
- * @param implementation
- * @return
+ * @param component The runtime component
+ * @param Implementation The implementation type
+ * @return The implementation provider
*/
ImplementationProvider createImplementationProvider(RuntimeComponent component, M Implementation);
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ProviderFactoryExtensionPoint.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ProviderFactoryExtensionPoint.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ProviderFactoryExtensionPoint.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ProviderFactoryExtensionPoint.java Fri May 18 03:05:14 2007
@@ -21,7 +21,10 @@
/**
- * An extension point for provider factories.
+ * An extension point for provider factories. Holds all of the provider
+ * factories from loaded extension points. Allows a provider factory
+ * to be located based on a given model type. Hence the runtime can
+ * generate runtime artifacts from the in memory assembly model.
*
* @version $Rev$ $Date$
*/
@@ -31,21 +34,21 @@
/**
* Add a provider factory.
*
- * @param providerFactory the provider factory
+ * @param providerFactory The provider factory
*/
void addProviderFactory(ProviderFactory providerFactory);
/**
* Remove a provider factory.
*
- * @param providerFactory the provider factory
+ * @param providerFactory The provider factory
*/
void removeProviderFactory(ProviderFactory providerFactory);
/**
* Returns the provider factory associated with the given model type.
- * @param modelType a model type
- * @return the provider factory associated with the given model type
+ * @param modelType A model type
+ * @return The provider factory associated with the given model type
*/
ProviderFactory getProviderFactory(Class<?> modelType);
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ReferenceBindingProvider.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ReferenceBindingProvider.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ReferenceBindingProvider.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ReferenceBindingProvider.java Fri May 18 03:05:14 2007
@@ -24,6 +24,9 @@
import org.apache.tuscany.sca.invocation.Invoker;
/**
+ * A reference binding implementation can options implement this
+ * interface to tie into the Tuscany SCA runtime
+ *
* @version $Rev$ $Date$
*/
public interface ReferenceBindingProvider {
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ServiceBindingProvider.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ServiceBindingProvider.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ServiceBindingProvider.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/provider/ServiceBindingProvider.java Fri May 18 03:05:14 2007
@@ -22,7 +22,8 @@
import org.apache.tuscany.sca.interfacedef.InterfaceContract;
/**
- * A service binding can optionally implement this interface
+ * A service binding can optionally implement this interface to tie
+ * into the Tuscany SCA runtime
*
* @version $Rev$ $Date$
*/
@@ -44,7 +45,6 @@
* it will be interface contract introspected from the WSDL portType used by
* the endpoint for a WebService binding.
*
- * @param service The component service that owns the service binding
* @return The effective interface contract, if null is returned, the
* interface contract for the component service will be used
*/
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/DefaultWireProcessorExtensionPoint.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/DefaultWireProcessorExtensionPoint.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/DefaultWireProcessorExtensionPoint.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/DefaultWireProcessorExtensionPoint.java Fri May 18 03:05:14 2007
@@ -29,16 +29,34 @@
*/
public class DefaultWireProcessorExtensionPoint implements RuntimeWireProcessorExtensionPoint {
+ /**
+ * The list of WireProcessors available to the runtime
+ */
private final List<RuntimeWireProcessor> processors = new ArrayList<RuntimeWireProcessor>();
+ /**
+ * Registers a wire-processor in the runtime
+ *
+ * @param processor The processor to register
+ */
public void addWireProcessor(RuntimeWireProcessor processor) {
processors.add(processor);
}
+ /**
+ * De-registers a wire-processor in the runtime
+ *
+ * @param processor The processor to de-register
+ */
public void removeWireProcessor(RuntimeWireProcessor processor) {
processors.remove(processor);
}
+ /**
+ * Returns a list of registered wire-processors.
+ *
+ * @return The list of wire processors
+ */
public List<RuntimeWireProcessor> getWireProcessors() {
return processors;
}
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/EndpointReference.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/EndpointReference.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/EndpointReference.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/EndpointReference.java Fri May 18 03:05:14 2007
@@ -57,7 +57,7 @@
/**
* Get the URI for this endpoint
- * @return
+ * @return The URI of the endpoint
*/
String getURI();
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponent.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponent.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponent.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponent.java Fri May 18 03:05:14 2007
@@ -24,19 +24,22 @@
import org.osoa.sca.ComponentContext;
/**
- * The runtime component
+ * The runtime component interface. Provides the bridge between the
+ * assembly model representation of a component and its runtime
+ * realization.
+ *
* @version $Rev$ $Date$
*/
public interface RuntimeComponent extends Component, ComponentContext {
/**
* Set the implementation-specific configuration for this component
- * @param implementationProvider
+ * @param implementationProvider The object that manages the component implementation
*/
void setImplementationProvider(ImplementationProvider implementationProvider);
/**
* Get the implementation-specific configuation for this component
- * @return
+ * @return The implementation provider for this component
*/
ImplementationProvider getImplementationProvider();
}
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponentReference.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponentReference.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponentReference.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponentReference.java Fri May 18 03:05:14 2007
@@ -28,6 +28,10 @@
import org.apache.tuscany.sca.provider.ReferenceBindingProvider;
/**
+ * The runtime component reference. Provides the bridge between the
+ * assembly model representation of a component reference and its runtime
+ * realization
+ *
* @version $Rev$ $Date$
*/
public interface RuntimeComponentReference extends ComponentReference {
@@ -35,14 +39,14 @@
/**
* Get a list of runtime wires to the reference
*
- * @return
+ * @return The list of wires
*/
List<RuntimeWire> getRuntimeWires();
/**
* Get the runtime wire for the given binding
- * @param binding
- * @return
+ * @param binding The assembly model binding
+ * @return The runtime wire
*/
RuntimeWire getRuntimeWire(Binding binding);
@@ -50,8 +54,8 @@
* Returns the reference binding provider associated with this
* component reference and the given binding.
*
- * @param binding
- * @return
+ * @param binding The assembly model binding
+ * @return The runtime reference binding provider
*/
ReferenceBindingProvider getBindingProvider(Binding binding);
@@ -59,18 +63,17 @@
* Sets the reference binding provider associated with this
* component reference and the given binding.
*
- * @param binding
- * @param bindingProvider
- * @return
+ * @param binding The assembly model binding
+ * @param bindingProvider The runtime reference binding provider
*/
void setBindingProvider(Binding binding, ReferenceBindingProvider bindingProvider);
/**
* Get the invoker for the given binding and operation
- * @param binding
- * @param operation
- * @return
+ * @param binding The assembly model binding
+ * @param operation The assembly model operation
+ * @return The runtime Invoker
*/
Invoker getInvoker(Binding binding, Operation operation);
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponentService.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponentService.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponentService.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeComponentService.java Fri May 18 03:05:14 2007
@@ -28,6 +28,10 @@
import org.apache.tuscany.sca.provider.ServiceBindingProvider;
/**
+ * The runtime component service. Provides the bridge between the
+ * assembly model representation of a component service and its runtime
+ * realization
+ *
* @version $Rev$ $Date$
*/
public interface RuntimeComponentService extends ComponentService {
@@ -35,20 +39,20 @@
/**
* Get a list of runtime wires to the service
*
- * @return
+ * @return The list of wires
*/
List<RuntimeWire> getRuntimeWires();
/**
* Get the runtime wire for the given binding
- * @param binding
- * @return
+ * @param binding The assembly model binding
+ * @return The runtime wire
*/
RuntimeWire getRuntimeWire(Binding binding);
/**
* Get the callback wires assoicated with this service
*
- * @return
+ * @return The list of runtime callback wires
*/
List<RuntimeWire> getCallbackWires();
@@ -56,8 +60,8 @@
* Returns the service binding provider associated with this
* component service and the given binding.
*
- * @param binding
- * @return
+ * @param binding The assembly model binding
+ * @return The runtime service binding provider
*/
ServiceBindingProvider getBindingProvider(Binding binding);
@@ -65,24 +69,24 @@
* Sets the service binding provider associated with this
* component service and the given binding.
*
- * @param binding
- * @param bindingProvider
+ * @param binding The assembly model binding
+ * @param bindingProvider The runtime service binding provider
*/
void setBindingProvider(Binding binding, ServiceBindingProvider bindingProvider);
/**
* Get the invoker for the given binding and operation
- * @param binding
- * @param operation
- * @return
+ * @param binding The assembly model binding
+ * @param operation The assembly model operation
+ * @return The runtime invoker
*/
Invoker getInvoker(Binding binding, Operation operation);
/**
* Get the callback invoker for the given binding and operation
- * @param binding
- * @param operation
- * @return
+ * @param binding The assembly model binding
+ * @param operation The assembly model operation
+ * @return The runtime callback invoker
*/
Invoker getCallbackInvoker(Binding binding, Operation operation);
}
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeWire.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeWire.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeWire.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeWire.java Fri May 18 03:05:14 2007
@@ -24,8 +24,8 @@
import org.apache.tuscany.sca.invocation.InvocationChain;
/**
- * The runtime wire that connects a component reference to a component service
- * (or an external service) over the selected binding
+ * The runtime wire interface that connects a component reference to a
+ * component service (or an external service) over the selected binding
*
* @version $Rev$ $Date$
*/
@@ -33,13 +33,15 @@
/**
* Get the source of the wire
- * @return
+ *
+ * @return The end point reference of the source
*/
EndpointReference getSource();
/**
* Get the target of the wire
- * @return
+ *
+ * @return The end point reference of the target
*/
EndpointReference getTarget();
Modified: incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeWireProcessorExtensionPoint.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeWireProcessorExtensionPoint.java?view=diff&rev=539355&r1=539354&r2=539355
==============================================================================
--- incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeWireProcessorExtensionPoint.java (original)
+++ incubator/tuscany/java/sca/modules/core-spi/src/main/java/org/apache/tuscany/sca/runtime/RuntimeWireProcessorExtensionPoint.java Fri May 18 03:05:14 2007
@@ -22,7 +22,7 @@
/**
* Acts as a delegating <code>WireProcessorExtensionPoint</code>, delegating
- * processing of wires after policies have been applied and source an targets
+ * processing of wires after policies have been applied and source and targets
* have been connected.
*
* @version $Rev$ $Date$
@@ -32,21 +32,21 @@
/**
* Registers a wire-processor in the runtime
*
- * @param processor the processor to register
+ * @param processor The processor to register
*/
void addWireProcessor(RuntimeWireProcessor processor);
/**
* De-registers a wire-processor in the runtime
*
- * @param processor the processor to de-register
+ * @param processor The processor to de-register
*/
void removeWireProcessor(RuntimeWireProcessor processor);
/**
* Returns a list of registered wire-processors.
*
- * @return
+ * @return The list of wire processors
*/
List<RuntimeWireProcessor> getWireProcessors();
---------------------------------------------------------------------
To unsubscribe, e-mail: tuscany-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: tuscany-commits-help@ws.apache.org