com.oracle.bedrock.runtime.remote.options

Class FileShareDeployer

java.lang.Object

com.oracle.bedrock.runtime.remote.options.FileShareDeployer

All Implemented Interfaces:

com.oracle.bedrock.Option, Deployer

Direct Known Subclasses:

JSchFileShareDeployer

public abstract class FileShareDeployer
extends Object
implements Deployer

A FileShareDeployer is a Deployer deploys to a remote platform by copying files via a shared file system location.

Sub-classes of this class will implement the actual remote part of the copy operation, which is specific to the remote platform O/S.

Author:

jk 2015.07.10

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.bedrock.Option

com.oracle.bedrock.Option.Collectable, com.oracle.bedrock.Option.Collector<C extends com.oracle.bedrock.Option.Collectable,T extends com.oracle.bedrock.Option.Collector<C,T>>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileShareDeployer(String localShareName, String remoteShareName, com.oracle.bedrock.Option... options) Create a FileShareDeployer that uses the specified local and remote file share to deploy artifacts.

Method Summary

Modifier and Type	Method and Description
DeployedArtifacts	deploy(List<DeploymentArtifact> artifactsToDeploy, String remoteDirectory, Platform platform, com.oracle.bedrock.Option... deploymentOptions) Deploy the list of DeploymentArtifacts to the specified Platform, returning the DeployedArtifacts representing the actual Files deployed and their location.
String	getLocalShareName()
String	getRemoteShareName()
protected abstract boolean	performRemoteCopy(String source, String destination, Platform platform, com.oracle.bedrock.OptionsByType deploymentOptions) Perform the copy of the DeploymentArtifact from the remote share location to the final target location.
DeployedArtifacts	undeploy(DeployedArtifacts deployedArtifacts, Platform platform, com.oracle.bedrock.Option... deploymentOptions) Undeploy the DeployedArtifacts on the specified Platform, returning the DeployedArtifacts that were not undeployed successfully.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileShareDeployer

protected FileShareDeployer(String localShareName,
                            String remoteShareName,
                            com.oracle.bedrock.Option... options)

Create a FileShareDeployer that uses the specified local and remote file share to deploy artifacts.

Parameters:

localShareName - the name of the file share on the local platform

remoteShareName - the name of the file share eon the remote platform

options - the Options to control the deployer

Method Detail

getLocalShareName

public String getLocalShareName()

getRemoteShareName

public String getRemoteShareName()

deploy

public DeployedArtifacts deploy(List<DeploymentArtifact> artifactsToDeploy,
                                String remoteDirectory,
                                Platform platform,
                                com.oracle.bedrock.Option... deploymentOptions)

Description copied from interface: Deployer

Deploy the list of DeploymentArtifacts to the specified Platform, returning the DeployedArtifacts representing the actual Files deployed and their location.

Specified by:

deploy in interface Deployer

Parameters:

artifactsToDeploy - the DeploymentArtifacts to deploy

remoteDirectory - the target directory to deploy the DeploymentArtifacts to if no destination is specified for a DeploymentArtifact

platform - the target Platform to deploy the DeploymentArtifacts to

deploymentOptions - the Options that can be applied to control the deployment

Returns:

the DeployedArtifacts

undeploy

public DeployedArtifacts undeploy(DeployedArtifacts deployedArtifacts,
                                  Platform platform,
                                  com.oracle.bedrock.Option... deploymentOptions)

Description copied from interface: Deployer

Undeploy the DeployedArtifacts on the specified Platform, returning the DeployedArtifacts that were not undeployed successfully.

Specified by:

undeploy in interface Deployer

Parameters:

deployedArtifacts - the DeployedArtifacts to undeploy

platform - the Platform

deploymentOptions - the Options used for deployment and undeployment

Returns:

the DeployedArtifacts that were failed to undeploy

performRemoteCopy

protected abstract boolean performRemoteCopy(String source,
                                             String destination,
                                             Platform platform,
                                             com.oracle.bedrock.OptionsByType deploymentOptions)
                                      throws IOException

Perform the copy of the DeploymentArtifact from the remote share location to the final target location.

Parameters:

source - the file to copy in the remote share folder

destination - the remote location to copy the artifact to

platform - the Platform to perform the remote copy on

deploymentOptions - the OptionsByTypes to control the deployment

Returns:

true it the file on the remote share was copied and needs to be cleaned up or false if it was moved and no clean-up is required.

Throws:

IOException - when the remote copy fails