org.savantbuild.dep.workflow.process

Interface Process

All Known Implementing Classes:

CacheProcess, SCPProcess, SVNProcess, URLProcess

public interface Process

This interface defines a workflow process that can be used for either publishing or for fetching.

Method Summary

Modifier and Type	Method and Description
void	deleteIntegrationBuilds(Artifact artifact) Deletes the integration builds.
java.nio.file.Path	fetch(Artifact artifact, java.lang.String item, PublishWorkflow publishWorkflow) Attempts to fetch the given item.
java.nio.file.Path	publish(Artifact artifact, java.lang.String item, java.nio.file.Path artifactFile) Attempts to publish the given item.

Method Detail

deleteIntegrationBuilds

void deleteIntegrationBuilds(Artifact artifact)
                      throws ProcessFailureException

Deletes the integration builds.

Parameters:

artifact - The artifact. This artifacts version is the next integration build version.

Throws:

ProcessFailureException

fetch

java.nio.file.Path fetch(Artifact artifact,
                         java.lang.String item,
                         PublishWorkflow publishWorkflow)
                  throws ProcessFailureException

Attempts to fetch the given item. The item is normally associated with the artifact, but might be associated with a group or project. This method can use the artifact for logging or other purposes, but should use the item String for fetching only.

If the item is found, it should be published by calling the PublishWorkflow.

Parameters:

artifact - The artifact that the item is associated with.

item - The name of the item being fetched. This item name should NOT include the path information. This will be handled by the processes so that flattened namespacing and other types of handling can be performed. This item should only be the name of the item being fetched. For example, if the artifact MD5 file is being fetched this would look like this: common-collections-2.1.jar.md5.

publishWorkflow - The PublishWorkflow that is used to store the item if it can be found.

Returns:

The Path to the item on the local disk or null if the item does not exist and there were no failures.

Throws:

ProcessFailureException - If the process failed when fetching the artifact.

publish

java.nio.file.Path publish(Artifact artifact,
                           java.lang.String item,
                           java.nio.file.Path artifactFile)
                    throws ProcessFailureException

Attempts to publish the given item. The item is normally associated with the artifact, but might be associated with a group or project. This method can use the artifact for logging or other purposes, but should use the item String for publishing only.

If the item is published in a manner that a file can be returned, that file should be returned as it might be used to create paths or other constructs.

Parameters:

artifact - The artifact that the item might be associated with.

item - The name of the item to publish.

artifactFile - The path to the artifact stored on disk (which could be a temporary file that it was downloaded to).

Returns:

The file if the publish process stored the given file locally (local cache for example). Otherwise, this should return null.

Throws:

ProcessFailureException - If there was any issue publishing.