com.oracle.bedrock.runtime.remote.http

Class HttpDeployer

java.lang.Object

com.oracle.bedrock.runtime.remote.http.HttpDeployer

All Implemented Interfaces:

com.oracle.bedrock.Option, Deployer

Direct Known Subclasses:

CurlHttpDeployer, WGetHttpDeployer

public abstract class HttpDeployer
extends Object
implements Deployer

A base class for Deployers that use HTTP as a file transfer mechanism.

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

Modifier and Type	Class and Description
static class	HttpDeployer.ArtifactsHandler A HttpHandler implementation that serves a list of DeploymentArtifacts as files.
static class	HttpDeployer.BufferSize An Option for the HttpDeployer.BufferSize.

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
HttpDeployer(com.oracle.bedrock.Option... options) Create a new HttpDeployer.

Method Summary

Modifier and Type	Method and Description
protected ExecutorService	createExecutor() Create the Executor that will be used by the HttpServer that this deployer runs.
protected com.sun.net.httpserver.HttpServer	createServer(ExecutorService executor, Map<String,DeploymentArtifact> artifacts) Start the HTTP server that will be used to serve the artifacts to be deployed.
static HttpDeployer	curl(com.oracle.bedrock.Option... options) A static helper method to return an HttpDeployer that will use wget to retrieve artifacts.
static HttpDeployer	curlAt(String curlLocation, com.oracle.bedrock.Option... options) A static helper method to return an HttpDeployer that will use wget to retrieve artifacts.
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.
protected void	deployAllArtifacts(Map<String,DeploymentArtifact> artifacts, String remoteDirectory, Platform platform, InetSocketAddress httpServerAddress, com.oracle.bedrock.OptionsByType optionsByType, DeployedArtifacts deployedArtifacts) Deploy the all of the specified DeploymentArtifacts.
protected abstract void	deployArtifact(URL sourceURL, String targetFileName, Platform platform) Deploy the specified artifact.
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.
static HttpDeployer	wget(com.oracle.bedrock.Option... options) A static helper method to return an HttpDeployer that will use wget to retrieve artifacts.
static HttpDeployer	wgetAt(String wgetLocation, com.oracle.bedrock.Option... options) A static helper method to return an HttpDeployer that will use wget to retrieve artifacts.
HttpDeployer	withBufferSize(int size) Set the size of the byte buffer that will be used to send the response of a HTTP request.
HttpDeployer	withBufferSizeInKB(int size) Set the size of the byte buffer that will be used to send the response of a HTTP request.
HttpDeployer	withBufferSizeInMB(int size) Set the size of the byte buffer that will be used to send the response of a HTTP request.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpDeployer

public HttpDeployer(com.oracle.bedrock.Option... options)

Create a new HttpDeployer.

Parameters:

options - the Options controlling this HttpDeployer

Method Detail

withBufferSize

public HttpDeployer withBufferSize(int size)

Set the size of the byte buffer that will be used to send the response of a HTTP request.

Parameters:

size - the size of the buffer in bytes

Returns:

this HttpDeployer to allow a fluent method style

withBufferSizeInKB

public HttpDeployer withBufferSizeInKB(int size)

Set the size of the byte buffer that will be used to send the response of a HTTP request.

Parameters:

size - the size of the buffer in kilo-bytes

Returns:

this HttpDeployer to allow a fluent method style

withBufferSizeInMB

public HttpDeployer withBufferSizeInMB(int size)

Set the size of the byte buffer that will be used to send the response of a HTTP request.

Parameters:

size - the size of the buffer in mega-bytes

Returns:

this HttpDeployer to allow a fluent method style

wget

public static HttpDeployer wget(com.oracle.bedrock.Option... options)

A static helper method to return an HttpDeployer that will use wget to retrieve artifacts.

Parameters:

options - the OptionsByType

Returns:

a new HttpDeployer

wgetAt

public static HttpDeployer wgetAt(String wgetLocation,
                                  com.oracle.bedrock.Option... options)

A static helper method to return an HttpDeployer that will use wget to retrieve artifacts.

Parameters:

wgetLocation - the location of the wget executable (for example "/usr/local/bin/wget")

options - the Options controlling the deployer

Returns:

a new HttpDeployer

curl

public static HttpDeployer curl(com.oracle.bedrock.Option... options)

A static helper method to return an HttpDeployer that will use wget to retrieve artifacts.

Parameters:

options - the Options controlling the deployer

Returns:

a new HttpDeployer

curlAt

public static HttpDeployer curlAt(String curlLocation,
                                  com.oracle.bedrock.Option... options)

A static helper method to return an HttpDeployer that will use wget to retrieve artifacts.

Parameters:

curlLocation - the location of the curl executable (for example "/usr/local/bin/curl")

options - the Options controlling the deployer

Returns:

a new HttpDeployer

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

deployAllArtifacts

protected void deployAllArtifacts(Map<String,DeploymentArtifact> artifacts,
                                  String remoteDirectory,
                                  Platform platform,
                                  InetSocketAddress httpServerAddress,
                                  com.oracle.bedrock.OptionsByType optionsByType,
                                  DeployedArtifacts deployedArtifacts)

Deploy the all of the specified DeploymentArtifacts.

Parameters:

artifacts - a Map of DeploymentArtifacts to deploy keyed by the URL path for each artifact

remoteDirectory - the remote directory to deploy to

platform - the remote Platform to deploy to

httpServerAddress - the InetSocketAddress the HTTP server is listening on

optionsByType - the OptionsByTypes to use

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

createExecutor

protected ExecutorService createExecutor()

Create the Executor that will be used by the HttpServer that this deployer runs. If a specific implementation of HttpDeployer will perform parallel HTTP requests then it should use an Executor to provide multiple threads to the HttpServer. If the deployer only deploys artifacts one at a time then it can return null from this method.

Returns:

an Executor to use for parallel deployments or null if performing single threaded deployments.

deployArtifact

protected abstract void deployArtifact(URL sourceURL,
                                       String targetFileName,
                                       Platform platform)

Deploy the specified artifact.

Parameters:

sourceURL - the HTTP URL to download the artifact from

targetFileName - the target file name to download the artifact to

platform - the remote Platform to download the artifact on

createServer

protected com.sun.net.httpserver.HttpServer createServer(ExecutorService executor,
                                                         Map<String,DeploymentArtifact> artifacts)

Start the HTTP server that will be used to serve the artifacts to be deployed.

Parameters:

executor - the Executor to pass to the HttpServer

artifacts - a Map of DeploymentArtifacts to deploy keyed by the URL path for each artifact

Returns:

the HttpServer