com.oracle.bedrock.runtime.remote.ssh

Class SftpDeployer

java.lang.Object

com.oracle.bedrock.runtime.remote.ssh.SftpDeployer

All Implemented Interfaces:

com.oracle.bedrock.Option, Deployer

public class SftpDeployer
extends Object
implements Deployer

An implementation of a Deployer that uses SFTP to transfer DeploymentArtifacts to a platform.

Copyright (c) 2015. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Jonathan Knight

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

Constructor and Description
SftpDeployer() Create a SftpDeployer.
SftpDeployer(JSchSessionFactory sessionFactory) Create a SftpDeployer that will use the specified JSchSessionFactory.

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.
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

SftpDeployer

public SftpDeployer()

Create a SftpDeployer.

SftpDeployer

public SftpDeployer(JSchSessionFactory sessionFactory)

Create a SftpDeployer that will use the specified JSchSessionFactory.

Parameters:

sessionFactory - the JSchSocketFactory

Method Detail

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