You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuscany.apache.org by lr...@apache.org on 2007/05/19 08:24:09 UTC
svn commit: r539693 - in /incubator/tuscany/java/sca/modules:
contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/impl/
contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/processor/impl/
contribution-impl/src/main/java/...
Author: lresende
Date: Fri May 18 23:24:07 2007
New Revision: 539693
URL: http://svn.apache.org/viewvc?view=rev&rev=539693
Log:
Javadoc review
Modified:
incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/impl/ArtifactImpl.java
incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/impl/ContributionFactoryImpl.java
incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/processor/impl/FolderContributionProcessor.java
incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/processor/impl/JarContributionProcessor.java
incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/resolver/impl/ModelResolverImpl.java
incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/ArtifactTypeDescriberImpl.java
incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/ContributionServiceImpl.java
incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidContributionMetadataException.java
incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidContributionURIException.java
incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidValueException.java
incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/PackageTypeDescriberImpl.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/Artifact.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContentType.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/Contribution.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionExport.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionFactory.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionImport.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/DeployedArtifact.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ArtifactProcessor.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ArtifactProcessorExtensionPoint.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ContributionPostProcessor.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ContributionPostProcessorExtensionPoint.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultArtifactProcessorExtensionPoint.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultPackageProcessorExtensionPoint.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultStAXArtifactProcessorExtensionPoint.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultURLArtifactProcessorExtensionPoint.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ExtensibleStAXArtifactProcessor.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/PackageProcessor.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/PackageProcessorExtensionPoint.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/StAXArtifactProcessor.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/URLArtifactProcessor.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/URLArtifactProcessorExtensionPoint.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/resolver/ClassReference.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/resolver/ModelResolver.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionException.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionMetadataLoader.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionMetadataLoaderException.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionReadException.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionRepository.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionResolveException.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionRuntimeException.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionService.java
incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/TypeDescriber.java
Modified: incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/impl/ArtifactImpl.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/impl/ArtifactImpl.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/impl/ArtifactImpl.java (original)
+++ incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/impl/ArtifactImpl.java Fri May 18 23:24:07 2007
@@ -21,6 +21,12 @@
import org.apache.tuscany.sca.contribution.Artifact;
+
+/**
+ * Base Artifact interface to accomodate common properties between Contribution and Deployed Artifact
+ *
+ * @version $Rev$ $Date$
+ */
public abstract class ArtifactImpl implements Artifact {
private String uri;
private String location;
Modified: incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/impl/ContributionFactoryImpl.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/impl/ContributionFactoryImpl.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/impl/ContributionFactoryImpl.java (original)
+++ incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/impl/ContributionFactoryImpl.java Fri May 18 23:24:07 2007
@@ -25,6 +25,12 @@
import org.apache.tuscany.sca.contribution.ContributionImport;
import org.apache.tuscany.sca.contribution.DeployedArtifact;
+
+/**
+ * Contribution model object factory
+ *
+ * @version $Rev$ $Date$
+ */
public class ContributionFactoryImpl implements ContributionFactory {
public Contribution createContribution() {
Modified: incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/processor/impl/FolderContributionProcessor.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/processor/impl/FolderContributionProcessor.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/processor/impl/FolderContributionProcessor.java (original)
+++ incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/processor/impl/FolderContributionProcessor.java Fri May 18 23:24:07 2007
@@ -34,6 +34,11 @@
import org.apache.tuscany.sca.contribution.service.ContributionException;
import org.apache.tuscany.sca.contribution.service.util.FileHelper;
+/**
+ * Folder contribution package processor
+ *
+ * @version $Rev$ $Date$
+ */
public class FolderContributionProcessor implements PackageProcessor {
/**
* Package-type that this package processor can handle
@@ -72,9 +77,9 @@
}
/**
- * Get a list of files from the directory
+ * Get a list of artifact URI from the folder
*
- * @return
+ * @return The list of artifact URI for the folder
* @throws IOException
*/
public List<URI> getArtifacts(URL packageSourceURL, InputStream inputStream) throws ContributionException,
Modified: incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/processor/impl/JarContributionProcessor.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/processor/impl/JarContributionProcessor.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/processor/impl/JarContributionProcessor.java (original)
+++ incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/processor/impl/JarContributionProcessor.java Fri May 18 23:24:07 2007
@@ -33,6 +33,11 @@
import org.apache.tuscany.sca.contribution.processor.PackageProcessor;
import org.apache.tuscany.sca.contribution.service.ContributionException;
+/**
+ * Jar Contribution package processor
+ *
+ * @version $Rev$ $Date$
+ */
public class JarContributionProcessor implements PackageProcessor {
/**
* Package-type that this package processor can handle
Modified: incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/resolver/impl/ModelResolverImpl.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/resolver/impl/ModelResolverImpl.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/resolver/impl/ModelResolverImpl.java (original)
+++ incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/resolver/impl/ModelResolverImpl.java Fri May 18 23:24:07 2007
@@ -26,7 +26,6 @@
import org.apache.tuscany.sca.contribution.resolver.ClassReference;
import org.apache.tuscany.sca.contribution.resolver.ModelResolver;
-
/**
* A default implementation of an artifact resolver, based on a map.
*
Modified: incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/ArtifactTypeDescriberImpl.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/ArtifactTypeDescriberImpl.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/ArtifactTypeDescriberImpl.java (original)
+++ incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/ArtifactTypeDescriberImpl.java Fri May 18 23:24:07 2007
@@ -31,7 +31,7 @@
import org.apache.tuscany.sca.contribution.service.util.FileHelper;
/**
- * Implementation of the content describer
+ * Implementation of the content describer for files
*
* @version $Rev$ $Date$
*/
@@ -67,9 +67,9 @@
* If not found, we try to check file contentType Or we return
* defaultContentType provided
*
- * @param url
- * @param defaultContentType
- * @return
+ * @param resourceURL The artifact url
+ * @param defaultContentType The default content type if we can't find the correc one
+ * @return The content type
*/
public String getType(URL resourceURL, String defaultContentType) {
URLConnection connection = null;
Modified: incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/ContributionServiceImpl.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/ContributionServiceImpl.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/ContributionServiceImpl.java (original)
+++ incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/ContributionServiceImpl.java Fri May 18 23:24:07 2007
@@ -48,6 +48,8 @@
import org.apache.tuscany.sca.contribution.service.util.IOHelper;
/**
+ * Service interface that manages artifacts contributed to a Tuscany runtime.
+ *
* @version $Rev$ $Date$
*/
public class ContributionServiceImpl implements ContributionService {
Modified: incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidContributionMetadataException.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidContributionMetadataException.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidContributionMetadataException.java (original)
+++ incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidContributionMetadataException.java Fri May 18 23:24:07 2007
@@ -20,7 +20,6 @@
import org.apache.tuscany.sca.contribution.service.ContributionException;
-
/**
* Exception that indicates that the supplied XML Document invalid.
*
Modified: incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidContributionURIException.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidContributionURIException.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidContributionURIException.java (original)
+++ incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidContributionURIException.java Fri May 18 23:24:07 2007
@@ -20,7 +20,6 @@
import org.apache.tuscany.sca.contribution.service.ContributionException;
-
/**
* Exception that indicates that the supplied contribution URI is invalid or inexistent.
*
Modified: incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidValueException.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidValueException.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidValueException.java (original)
+++ incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/InvalidValueException.java Fri May 18 23:24:07 2007
@@ -21,7 +21,11 @@
import org.apache.tuscany.sca.contribution.service.ContributionMetadataLoaderException;
-
+/**
+ * Denotate invalid value found during parsing of the contribution metadata sidefile
+ *
+ * @version $Rev$ $Date$
+ */
public class InvalidValueException extends ContributionMetadataLoaderException {
/**
*
Modified: incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/PackageTypeDescriberImpl.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/PackageTypeDescriberImpl.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/PackageTypeDescriberImpl.java (original)
+++ incubator/tuscany/java/sca/modules/contribution-impl/src/main/java/org/apache/tuscany/sca/contribution/service/impl/PackageTypeDescriberImpl.java Fri May 18 23:24:07 2007
@@ -30,7 +30,7 @@
import org.apache.tuscany.sca.contribution.service.util.FileHelper;
/**
- * Implementation of the content describer
+ * Implementation of the content describer for contribution packages
*
* @version $Rev$ $Date$
*/
@@ -63,9 +63,9 @@
* If not found, we try to check file contentType Or we return
* defaultContentType provided
*
- * @param url
- * @param defaultContentType
- * @return
+ * @param resourceURL The artifact url
+ * @param defaultContentType The default content type if we can't find the correc one
+ * @return The content type
*/
public String getType(URL resourceURL, String defaultContentType) {
URLConnection connection = null;
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/Artifact.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/Artifact.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/Artifact.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/Artifact.java Fri May 18 23:24:07 2007
@@ -23,30 +23,34 @@
/**
* Base Artifact interface to accomodate common properties between Contribution and Deployed Artifact
*
- * @version $Rev: $Date:
+ * @version $Rev$ $Date$
*/
public interface Artifact {
/**
* Get the URI that unique identifies the artifact
- * @return
+ *
+ * @return The artifact uri
*/
String getURI();
/**
* Set the URI that unique identifies the artifact
- * @param uri
+ *
+ * @param uri The artifact uri
*/
void setURI(String uri);
/**
* Get the URL location for the artifact
- * @return
+ *
+ * @return The artifact location
*/
String getLocation();
/**
* Set the URL location for the artifact
- * @param location
+ *
+ * @param location The artifact location
*/
void setLocation(String location);
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContentType.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContentType.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContentType.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContentType.java Fri May 18 23:24:07 2007
@@ -19,24 +19,38 @@
package org.apache.tuscany.sca.contribution;
+/**
+ * Identifies internal content types for contribution package and artifacts
+ *
+ * @version $Rev$ $Date$
+ */
public interface ContentType {
/**
- * Archive specific content types
+ * Java compressed contribution package
*/
String JAR = "application/x-compressed";
+ /**
+ * Filesystem folder contribution package
+ */
String FOLDER = "application/vnd.tuscany.folder";
-
/**
- * Artifact/File specific content types
+ * Contribution metadata file
*/
String CONTRIBUTION_METADATA = "application/vnd.tuscany.contribution.metadata";
+ /**
+ * SCA Composite description file
+ */
String COMPOSITE = "application/vnd.tuscany.composite";
+ /**
+ * WSDL file
+ */
String WSDL = "application/vnd.tuscany.wsdl";
+ /**
+ * Java source/binary file
+ */
String JAVA = "application/java-vm";
-
/**
* Unkown contentType
*/
- String UNKNOWN = "content/unknown";
-
+ String UNKNOWN = "content/unknown";
}
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/Contribution.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/Contribution.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/Contribution.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/Contribution.java Fri May 18 23:24:07 2007
@@ -30,33 +30,45 @@
* @version $Rev$ $Date$
*/
public interface Contribution extends Artifact {
+ /**
+ * Default location of contribution metadata in a contribution package
+ */
String SCA_CONTRIBUTION_META = "META-INF/sca-contribution.xml";
+ /**
+ * default location of a generated contribution metadata in a contribution package
+ */
String SCA_CONTRIBUTION_GENERATED_META = "META-INF/sca-contribution-generated.xml";
+ /**
+ * Default location of deployables in a contribution
+ */
String SCA_CONTRIBUTION_DEPLOYABLES = "META-INF/sca-deployables/";
/**
* Get a list of exports based on the Contribution metadata sidefile
- * @return
+ *
+ * @return The list of exported artifacts from this contribution
*/
List<ContributionExport> getExports();
/**
* Get a list of imports based on the Contribution metadata sidefile
- * @return
+ *
+ * @return The list of imported artifacts on this contribution
*/
List<ContributionImport> getImports();
/**
- * Get a list of deployables for the contribution
- * This is based on the contribution medatata sidefile, or all Composites available on the contribution
- * @return
+ * Get a list of deployables for the contribution based on the contribution metadata sidefile
+ *
+ * @return The list of deployable composites
*/
List<Composite> getDeployables();
/**
* Get a list of artifacts from the contribution
- * @return
+ *
+ * @return The list of deployed artifacts for the contribution
*/
List<DeployedArtifact> getArtifacts();
@@ -64,7 +76,7 @@
* Returns the model resolver for the models representing the artifacts
* visible in the scope of this contribution.
*
- * @return
+ * @return The model resolver
*/
ModelResolver getModelResolver();
@@ -72,7 +84,7 @@
* Sets the model resolver for the models representing the artifacts
* visible in the scope of this contribution.
*
- * @param modelResolver
+ * @param modelResolver The model resolver
*/
void setModelResolver(ModelResolver modelResolver);
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionExport.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionExport.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionExport.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionExport.java Fri May 18 23:24:07 2007
@@ -21,7 +21,6 @@
import org.apache.tuscany.sca.contribution.resolver.ModelResolver;
-
/**
* The representation of an export for the contribution
*
@@ -30,14 +29,16 @@
public interface ContributionExport {
/**
- * Get Namespace that identifies the import
- * @return
+ * Get Namespace that identifies the export
+ *
+ * @return The exported namespace
*/
String getNamespace();
/**
- * Set Namespace that identifies the import
- * @param namespace
+ * Set Namespace that identifies the export
+ *
+ * @param namespace The exported namespace
*/
void setNamespace(String namespace);
@@ -45,7 +46,7 @@
* Returns the model resolver for the models representing artifacts
* made available by this export.
*
- * @return
+ * @return The model resolver
*/
ModelResolver getModelResolver();
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionFactory.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionFactory.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionFactory.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionFactory.java Fri May 18 23:24:07 2007
@@ -19,34 +19,37 @@
package org.apache.tuscany.sca.contribution;
-
/**
+ * Contribution model object factory
*
+ * @version $Rev$ $Date$
*/
public interface ContributionFactory {
-
- /**
- * Create a deployedArtifact model object
- * @return
- */
- DeployedArtifact createDeployedArtifact();
-
/**
* Create a contribution model object
- * @return
+ *
+ * @return The new contribution model object
*/
Contribution createContribution();
+
+ /**
+ * Create a deployedArtifact model object
+ *
+ * @return The new deployedArtifact model object
+ */
+ DeployedArtifact createDeployedArtifact();
/**
* Create a contribution import model
- * @return
+ *
+ * @return The new ContributionImport model object
*/
ContributionImport createContributionImport();
/**
* Create a contribution import model
- * @return
+ *
+ * @return The new ContributoinExport object
*/
ContributionExport createContributionExport();
-
-}
+}
\ No newline at end of file
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionImport.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionImport.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionImport.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/ContributionImport.java Fri May 18 23:24:07 2007
@@ -30,25 +30,30 @@
public interface ContributionImport {
/**
+ * Get the location used to resolve the definitions for this import
*
- * @return
+ * @return The import location
*/
String getLocation();
/**
- * @param location
+ * Set the location used to resolve the definitions for this import
+ *
+ * @param location The import location
*/
void setLocation(String location);
/**
* Get Namespace that identifies the import
- * @return
+ *
+ * @return The namespace
*/
String getNamespace();
/**
* Set Namespace that identifies the import
- * @param namespace
+ *
+ * @param namespace The namespace
*/
void setNamespace(String namespace);
@@ -56,7 +61,7 @@
* Returns the model resolver for the models representing artifacts
* made available by this import.
*
- * @return
+ * @return The model resolver
*/
ModelResolver getModelResolver();
@@ -64,8 +69,7 @@
* Sets the model resolver for the models representing artifacts
* made available by this import.
*
- * @param modelResolver
+ * @param modelResolver The model resolver
*/
- void setModelResolver(ModelResolver modelResolver);
-
-}
+ void setModelResolver(ModelResolver modelResolver);
+}
\ No newline at end of file
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/DeployedArtifact.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/DeployedArtifact.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/DeployedArtifact.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/DeployedArtifact.java Fri May 18 23:24:07 2007
@@ -19,7 +19,6 @@
package org.apache.tuscany.sca.contribution;
-
/**
* Representation of a deployed artifact
*
@@ -28,14 +27,16 @@
public interface DeployedArtifact extends Artifact {
/**
- * Get the model associated with this artifact
- * @return
+ * Get the assembly model associated with this artifact
+ *
+ * @return The assembly model
*/
Object getModel();
/**
- * Set the model associated with this artifact
- * @param modelObject
+ * Set the assembly model associated with this artifact
+ *
+ * @param modelObject The assembly model
*/
void setModel(Object modelObject);
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ArtifactProcessor.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ArtifactProcessor.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ArtifactProcessor.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ArtifactProcessor.java Fri May 18 23:24:07 2007
@@ -21,8 +21,6 @@
import org.apache.tuscany.sca.contribution.resolver.ModelResolver;
import org.apache.tuscany.sca.contribution.service.ContributionResolveException;
-
-
/**
* Interface for extensions that can process contributions.
*
@@ -34,14 +32,16 @@
* Resolve references from this model to other models. For example references
* from a composite to another one, or references from a composite to a WSDL
* model.
- * @param model the model to resolve
- * @param the resolver to use to resolve referenced models
+ *
+ * @param model The model to resolve
+ * @param resolver The resolver to use to resolve referenced models
*/
void resolve(M model, ModelResolver resolver) throws ContributionResolveException;
/**
* Returns the type of model handled by this artifact processor.
- * @return the type of model handled by this artifact processor
+ *
+ * @return The type of model handled by this artifact processor
*/
Class<M> getModelType();
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ArtifactProcessorExtensionPoint.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ArtifactProcessorExtensionPoint.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ArtifactProcessorExtensionPoint.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ArtifactProcessorExtensionPoint.java Fri May 18 23:24:07 2007
@@ -28,28 +28,30 @@
/**
* Add an artifact processor.
*
- * @param artifactProcessor the artifact processor to add
+ * @param artifactProcessor The artifact processor to add
*/
void addArtifactProcessor(P artifactProcessor);
/**
* Remove an artifact processor.
*
- * @param artifactProcessor the artifact processor to remove
+ * @param artifactProcessor The artifact processor to remove
*/
void removeArtifactProcessor(P artifactProcessor);
/**
* Returns the processor associated with the given artifact type.
- * @param artifactType an artifact type
- * @return the processor associated with the given artifact type
+ *
+ * @param artifactType An artifact type
+ * @return The processor associated with the given artifact type
*/
P getProcessor(Object artifactType);
/**
* Returns the processor associated with the given model type.
- * @param modelType a model type
- * @return the processor associated with the given model type
+ *
+ * @param modelType A model type
+ * @return The processor associated with the given model type
*/
P getProcessor(Class<?> modelType);
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ContributionPostProcessor.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ContributionPostProcessor.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ContributionPostProcessor.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ContributionPostProcessor.java Fri May 18 23:24:07 2007
@@ -27,5 +27,11 @@
* @version $Rev$ $Date$
*/
public interface ContributionPostProcessor {
+
+ /**
+ * Visitor pattern to post process the contribution
+ *
+ * @param contribution The contribution to be post processed
+ */
void visit(Contribution contribution);
}
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ContributionPostProcessorExtensionPoint.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ContributionPostProcessorExtensionPoint.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ContributionPostProcessorExtensionPoint.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ContributionPostProcessorExtensionPoint.java Fri May 18 23:24:07 2007
@@ -28,13 +28,15 @@
/**
* Add a ContributionPostProcessor
- * @param processor
+ *
+ * @param processor The post processor
*/
void addPostProcessor(ContributionPostProcessor processor);
/**
* Remove a ContributionPostProcessor
- * @param processor
+ *
+ * @param processor The post processor
*/
void removePostProcessor(ContributionPostProcessor processor);
}
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultArtifactProcessorExtensionPoint.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultArtifactProcessorExtensionPoint.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultArtifactProcessorExtensionPoint.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultArtifactProcessorExtensionPoint.java Fri May 18 23:24:07 2007
@@ -38,8 +38,9 @@
/**
* Returns the processor associated with the given artifact type.
- * @param artifactType an artifact type
- * @return the processor associated with the given artifact type
+ *
+ * @param artifactType An artifact type
+ * @return The processor associated with the given artifact type
*/
public P getProcessor(Object artifactType) {
return processorsByArtifactType.get(artifactType);
@@ -47,8 +48,9 @@
/**
* Returns the processor associated with the given model type.
- * @param modelType a model type
- * @return the processor associated with the given model type
+ *
+ * @param modelType A model type
+ * @return The processor associated with the given model type
*/
public P getProcessor(Class<?> modelType) {
Class<?>[] classes = modelType.getInterfaces();
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultPackageProcessorExtensionPoint.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultPackageProcessorExtensionPoint.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultPackageProcessorExtensionPoint.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultPackageProcessorExtensionPoint.java Fri May 18 23:24:07 2007
@@ -22,7 +22,6 @@
import java.util.HashMap;
import java.util.Map;
-
/**
* Default implementation of ContributionProcessorRegistry
*
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultStAXArtifactProcessorExtensionPoint.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultStAXArtifactProcessorExtensionPoint.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultStAXArtifactProcessorExtensionPoint.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultStAXArtifactProcessorExtensionPoint.java Fri May 18 23:24:07 2007
@@ -18,8 +18,6 @@
*/
package org.apache.tuscany.sca.contribution.processor;
-
-
/**
* The default implementation of an extension point for StAX artifact processors.
*
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultURLArtifactProcessorExtensionPoint.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultURLArtifactProcessorExtensionPoint.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultURLArtifactProcessorExtensionPoint.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/DefaultURLArtifactProcessorExtensionPoint.java Fri May 18 23:24:07 2007
@@ -18,8 +18,6 @@
*/
package org.apache.tuscany.sca.contribution.processor;
-
-
/**
* The default implementation of a StAX artifact processor registry.
*
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ExtensibleStAXArtifactProcessor.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ExtensibleStAXArtifactProcessor.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ExtensibleStAXArtifactProcessor.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/ExtensibleStAXArtifactProcessor.java Fri May 18 23:24:07 2007
@@ -106,9 +106,9 @@
/**
* Read a model from an input stream.
- * @param is
- * @param type
- * @return
+ * @param is The artifact inputstream
+ * @param type Model type
+ * @return The model
* @throws ContributionReadException
*/
public <MO> MO read(InputStream is, Class<MO> type) throws ContributionReadException {
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/PackageProcessor.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/PackageProcessor.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/PackageProcessor.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/PackageProcessor.java Fri May 18 23:24:07 2007
@@ -28,14 +28,15 @@
import org.apache.tuscany.sca.contribution.service.ContributionException;
/**
- * Interface for services that can process contributions.
+ * Contribution package processors
+ * These processors understand the internal format of the contribution and how to process the artifacts
*
* @version $Rev$ $Date$
*/
public interface PackageProcessor {
/**
- * Returns the type of package processed by this package processor.
+ * Returns the type of package supported by this package processor.
*
* @return the package type
*/
@@ -44,20 +45,22 @@
/**
* Retrieve a list of artifacts for the specific package type
*
- * @param packageSourceURL location of the artifact
- * @param inputStream optional content of the package
- * @return
+ * @param packageSourceURL Contribution package location URL
+ * @param inputStream Optional content of the package
+ * @return List of artifact URIs
* @throws ContributionException
* @throws IOException
*/
List<URI> getArtifacts(URL packageSourceURL, InputStream inputStream) throws ContributionException, IOException;
/**
- * Return the URL for an artifact in the package
+ * Return the URL for an artifact in the package.
+ * This is needed in the case of special archives such as jar files that have special
+ * URL structure for internal artifacts
*
- * @param packageSourceURL The package URL
+ * @param packageSourceURL Contribution package location URL
* @param artifact The relative URI for the artifact
- * @return
+ * @return The artifact URL
*/
URL getArtifactURL(URL packageSourceURL, URI artifact) throws MalformedURLException;
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/PackageProcessorExtensionPoint.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/PackageProcessorExtensionPoint.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/PackageProcessorExtensionPoint.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/PackageProcessorExtensionPoint.java Fri May 18 23:24:07 2007
@@ -19,27 +19,31 @@
package org.apache.tuscany.sca.contribution.processor;
/**
+ * An extension point for package processors
+ *
* @version $Rev$ $Date$
*/
public interface PackageProcessorExtensionPoint {
/**
* Register a PackageProcessor using the package type as the key
- * @param processor
+ *
+ * @param processor The package processor
*/
void addPackageProcessor(PackageProcessor processor);
/**
* Unregister a PackageProcessor
- * @param processor
+ *
+ * @param processor The package processor
*/
void removePackageProcessor(PackageProcessor processor);
/**
* Returns the PackageProcessor for the given package type.
*
- * @param packageType
- * @return
+ * @param packageType The package type
+ * @return The package processor
*/
PackageProcessor getPackageProcessor(String packageType);
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/StAXArtifactProcessor.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/StAXArtifactProcessor.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/StAXArtifactProcessor.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/StAXArtifactProcessor.java Fri May 18 23:24:07 2007
@@ -37,23 +37,27 @@
/**
* Reads a model from an input source. Examples of input sources are: a URI, a
* DOM node, an XML reader.
- * @param source
- * @return a model representation of the input.
+ *
+ * @param inputSource The input source
+ * @return A model representation of the input.
*/
M read(XMLStreamReader inputSource) throws ContributionReadException, XMLStreamException;
/**
* Writes a model to an ouput source. Examples of output sources are: a URI, a
* DOM node, an XML writer.
- * @param source
- * @return a model representation of the source.
+ *
+ * @param model A model representing the source
+ * @param outputSource The output source
+ * @throws ContributionWriteException
+ * @throws XMLStreamException
*/
void write(M model, XMLStreamWriter outputSource) throws ContributionWriteException, XMLStreamException;
/**
- * Returns the type of artifact handled by this artifact processor.
- * @return the type of artifact handled by this artifact processor
+ * Returns the type of artifact handled by this artifact processor.
+ *
+ * @return The type of artifact handled by this artifact processor
*/
QName getArtifactType();
-
}
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/URLArtifactProcessor.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/URLArtifactProcessor.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/URLArtifactProcessor.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/URLArtifactProcessor.java Fri May 18 23:24:07 2007
@@ -34,16 +34,18 @@
/**
* Reads a model from an input source. Examples of input
* sources are: a URI, a DOM node, an XML reader.
- * @param contributionURL
- * @param artifactURI
- * @param artifactURL
- * @return a model representation of the input.
+ *
+ * @param contributionURL Contribution location URL
+ * @param artifactURI Artifact URI
+ * @param artifactURL Artifact location URL
+ * @return A model representation of the input.
*/
M read(URL contributionURL, URI artifactURI, URL artifactURL) throws ContributionReadException;
/**
- * Returns the type of artifact handled by this artifact processor.
- * @return the type of artifact handled by this artifact processor
+ * Returns the type of artifact handled by this artifact processor.
+ *
+ * @return The type of artifact handled by this artifact processor
*/
String getArtifactType();
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/URLArtifactProcessorExtensionPoint.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/URLArtifactProcessorExtensionPoint.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/URLArtifactProcessorExtensionPoint.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/processor/URLArtifactProcessorExtensionPoint.java Fri May 18 23:24:07 2007
@@ -18,8 +18,6 @@
*/
package org.apache.tuscany.sca.contribution.processor;
-
-
/**
* A registry for Stream artifact processors.
*
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/resolver/ClassReference.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/resolver/ClassReference.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/resolver/ClassReference.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/resolver/ClassReference.java Fri May 18 23:24:07 2007
@@ -35,7 +35,7 @@
/**
* Constructs a new ClassReference.
*
- * @param clazz
+ * @param clazz The class reference
*/
public ClassReference(Class clazz) {
this.clazz = new WeakReference<Class>(clazz);
@@ -45,7 +45,7 @@
/**
* Constructs a new ClassReference.
*
- * @param className
+ * @param className The class name
*/
public ClassReference(String className) {
this.className = className;
@@ -53,7 +53,8 @@
/**
* Get the referenced class.
- * @return
+ *
+ * @return The referenced class
*/
public Class getJavaClass() {
if (clazz != null) {
@@ -65,7 +66,8 @@
/**
* Get the referenced class name.
- * @return
+ *
+ * @return The class name
*/
public String getClassName() {
return className;
@@ -74,7 +76,7 @@
/**
* Returns true if the class reference is unresolved.
*
- * @return
+ * @return Wether or not the class has been resolved
*/
boolean isUnresolved() {
return clazz == null;
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/resolver/ModelResolver.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/resolver/ModelResolver.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/resolver/ModelResolver.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/resolver/ModelResolver.java Fri May 18 23:24:07 2007
@@ -19,8 +19,6 @@
package org.apache.tuscany.sca.contribution.resolver;
-
-
/**
* SCA Assemblies reference many artifacts of a wide variety of types. These
* include:
@@ -43,6 +41,7 @@
/**
* Resolve the model representing an artifact.
+ *
* @param modelClass the type of artifact
* @param unresolved the unresolved model
* @return the resolved model
@@ -51,14 +50,16 @@
/**
* Add a resolved model.
- * @param resolved
+ *
+ * @param resolved The model
*/
void addModel(Object resolved);
/**
* Remove a resolved model.
+ *
* @param resolved
- * @return the removed model, or null if the model was not removed
+ * @return The removed model, or null if the model was not removed
*/
Object removeModel(Object resolved);
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionException.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionException.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionException.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionException.java Fri May 18 23:24:07 2007
@@ -18,7 +18,6 @@
*/
package org.apache.tuscany.sca.contribution.service;
-
/**
* Base class for exceptions raised by contribution services.
*
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionMetadataLoader.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionMetadataLoader.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionMetadataLoader.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionMetadataLoader.java Fri May 18 23:24:07 2007
@@ -24,12 +24,17 @@
import org.apache.tuscany.sca.contribution.Contribution;
+/**
+ * Loader responsible to process the contribution metadata loader
+ *
+ * @version $Rev$ $Date$
+ */
public interface ContributionMetadataLoader {
/**
* Create the model object for Contribution Service metadata information
- * @param contribution the contribution to load
- * @param reader the XML stream reader positioned on the applicable START_ELEMENT
- * @return
+ *
+ * @param contribution The contribution to populate with the proper values from the side file
+ * @param reader The XML stream reader positioned on the applicable START_ELEMENT
* @throws XMLStreamException
* @throws ContributionMetadataReadException
*/
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionMetadataLoaderException.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionMetadataLoaderException.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionMetadataLoaderException.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionMetadataLoaderException.java Fri May 18 23:24:07 2007
@@ -19,6 +19,11 @@
package org.apache.tuscany.sca.contribution.service;
+/**
+ * Denotes an exception while processing the contribution metadata
+ *
+ * @version $Rev$ $Date$
+ */
public class ContributionMetadataLoaderException extends ContributionException {
private static final long serialVersionUID = 2442537028550702609L;
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionReadException.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionReadException.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionReadException.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionReadException.java Fri May 18 23:24:07 2007
@@ -18,7 +18,6 @@
*/
package org.apache.tuscany.sca.contribution.service;
-
/**
* Denotes an exception while reading artifacts inside an SCA contribution.
*
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionRepository.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionRepository.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionRepository.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionRepository.java Fri May 18 23:24:07 2007
@@ -25,11 +25,16 @@
import java.net.URL;
import java.util.List;
+/**
+ * Contribution repository
+ *
+ * @version $Rev$ $Date$
+ */
public interface ContributionRepository {
/**
* Get the URI of the SCA domain
*
- * @return
+ * @return The domain URI
*/
URI getDomain();
@@ -43,13 +48,21 @@
* provided
* @param contributionStream InputStream with the content of the
* distribution
+ * @return A URL pointing to the content of the contribution in the
+ * repository
+ * @throws IOException
*/
URL store(String contribution, URL sourceURL, InputStream contributionStream) throws IOException;
/**
* Copy a contribution from the source URL to the repository
- * @param contribution
- * @param sourceURL
- * @return
+ *
+ * @param contribution A URl pointing to the contribution being copied to
+ * the repository
+ * @param sourceURL url of the source. this would be used to calculate the right
+ * filename to be stored on the repository when a inputStream is being
+ * provided
+ * @return A URL pointing to the content of the contribution in the
+ * repository
* @throws IOException
*/
URL store(String contribution, URL sourceURL) throws IOException;
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionResolveException.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionResolveException.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionResolveException.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionResolveException.java Fri May 18 23:24:07 2007
@@ -18,7 +18,6 @@
*/
package org.apache.tuscany.sca.contribution.service;
-
/**
* Denotes a problem while resolving models inside an SCA contribution.
*
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionRuntimeException.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionRuntimeException.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionRuntimeException.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionRuntimeException.java Fri May 18 23:24:07 2007
@@ -18,7 +18,6 @@
*/
package org.apache.tuscany.sca.contribution.service;
-
/**
* Base class for runtime exceptions raised by contribution services.
*
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionService.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionService.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionService.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/ContributionService.java Fri May 18 23:24:07 2007
@@ -26,7 +26,6 @@
import org.apache.tuscany.sca.contribution.Contribution;
import org.apache.tuscany.sca.contribution.resolver.ModelResolver;
-
/**
* Service interface that manages artifacts contributed to a Tuscany runtime.
*
@@ -40,12 +39,12 @@
* the URL's path).
*
* @param contributionURI The URI that is used as the contribution unique ID.
- * @param sourceURL the location of the resource containing the artifact
- * @param modelResolver the model resolver to use to resolve models in the
+ * @param sourceURL The location of the resource containing the artifact
+ * @param modelResolver The model resolver to use to resolve models in the
* scope of this contribution
- * @param storeInRepository flag that identifies if you want to copy the
+ * @param storeInRepository Flag that identifies if you want to copy the
* contribution to the repository
- * @return the contribution model representing the contribution
+ * @return The contribution model representing the contribution
* @throws DeploymentException if there was a problem with the contribution
* @throws IOException if there was a problem reading the resource
*/
@@ -56,15 +55,15 @@
* Contribute an artifact to the SCA Domain.
*
* @param contributionURI The URI that is used as the contribution unique ID.
- * @param sourceURL the location of the resource containing the artifact.
+ * @param sourceURL The location of the resource containing the artifact.
* This is used to identify what name should be used when storing
* the contribution on the repository
- * @param modelResolver the model resolver to use to resolve models in the
+ * @param modelResolver The model resolver to use to resolve models in the
* scope of this contribution
- * @param contributionContent a stream containing the resource being
+ * @param contributionContent A stream containing the resource being
* contributed; the stream will not be closed but the read
* position after the call is undefined
- * @return the contribution model representing the contribution
+ * @return The contribution model representing the contribution
* @throws DeploymentException if there was a problem with the contribution
* @throws IOException if there was a problem reading the stream
*/
@@ -87,6 +86,10 @@
* The added or updated deployment composite is given a relative URI that
* matches the "name" attribute of the composite, with a ".composite"
* suffix.
+ *
+ * @param contribution The contribution to where
+ * @param composite
+ * @throws ContributionException
*/
void addDeploymentComposite(Contribution contribution, Composite composite) throws ContributionException;
Modified: incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/TypeDescriber.java
URL: http://svn.apache.org/viewvc/incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/TypeDescriber.java?view=diff&rev=539693&r1=539692&r2=539693
==============================================================================
--- incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/TypeDescriber.java (original)
+++ incubator/tuscany/java/sca/modules/contribution/src/main/java/org/apache/tuscany/sca/contribution/service/TypeDescriber.java Fri May 18 23:24:07 2007
@@ -28,9 +28,11 @@
*/
public interface TypeDescriber {
/**
- * @param resourceURL the resource url
- * @param defaultType the default content type
- * @return the content type
+ * Get the content type for the specified resource
+ *
+ * @param resourceURL The resource url
+ * @param defaultType The default content type
+ * @return The content type
*/
String getType(URL resourceURL, String defaultType);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: tuscany-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: tuscany-commits-help@ws.apache.org