com.mesosphere.velocity.marathon.impl

Class MarathonBuilderImpl

java.lang.Object

com.mesosphere.velocity.marathon.interfaces.MarathonBuilder

com.mesosphere.velocity.marathon.impl.MarathonBuilderImpl

public class MarathonBuilderImpl
extends MarathonBuilder

Constructor Summary

Constructors

Constructor and Description
MarathonBuilderImpl()
MarathonBuilderImpl(AppConfig config)

Method Summary

Modifier and Type	Method and Description
MarathonBuilder	build() Compose the builder.
String	getAppid()
String	getDocker()
boolean	getDockerForcePull()
net.sf.json.JSONObject	getJson()
List<MarathonLabel>	getLabels()
List<MarathonUri>	getUris()
MarathonBuilder	read() Read in default file (marathon.json) as JSON.
MarathonBuilder	read(String filename) Read in filename as JSON.
MarathonBuilder	setConfig(AppConfig config) Set the Application Configuration to config.
MarathonBuilder	setEnvVars(hudson.EnvVars vars) Set the Jenkins Environment Variables to vars.
MarathonBuilder	setJson(net.sf.json.JSONObject json) Set the JSON for this builder to json.
MarathonBuilder	setWorkspace(hudson.FilePath ws) Set the Jenkins workspace to ws.
MarathonBuilder	toFile() Write the JSON that will be sent to the target Marathon instance to the default file (marathon-rendered-${BUILD_NUMBER}.json).
MarathonBuilder	toFile(String filename) Write the JSON that will be sent to the target Marathon instance to filename.
MarathonBuilder	update() Perform the actual update call to Marathon.

Methods inherited from class com.mesosphere.velocity.marathon.interfaces.MarathonBuilder

getApp, getBuilder, getURL, setAppFromJson, setURL

Methods inherited from class java.lang.Object

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

Constructor Detail

MarathonBuilderImpl

public MarathonBuilderImpl()

MarathonBuilderImpl

public MarathonBuilderImpl(AppConfig config)

Method Detail

getUris

public List<MarathonUri> getUris()

getLabels

public List<MarathonLabel> getLabels()

getAppid

public String getAppid()

getDocker

public String getDocker()

getDockerForcePull

public boolean getDockerForcePull()

update

public MarathonBuilder update()
                       throws mesosphere.marathon.client.MarathonException,
                              AuthenticationException

Perform the actual update call to Marathon. If a 401 (Unauthenticated) response is received, this will try to retrieve a new token from DC/OS using JWT credentials.

Specified by:

update in class MarathonBuilder

Returns:

this Marathon builder

Throws:

mesosphere.marathon.client.MarathonException - If Marathon does not return a 20x OK response

AuthenticationException - If an authentication provider was used and encountered a problem.

read

public MarathonBuilder read(String filename)
                     throws IOException,
                            InterruptedException,
                            MarathonFileMissingException,
                            MarathonFileInvalidException

Description copied from class: MarathonBuilder

Read in filename as JSON.

Specified by:

read in class MarathonBuilder

Parameters:

filename - Path to the JSON file

Returns:

This builder

Throws:

IOException - on IO issues

InterruptedException - on complications reading file

MarathonFileMissingException - when the Marathon config file is missing

MarathonFileInvalidException - when the Marathon config is not a file

read

public MarathonBuilder read()
                     throws IOException,
                            InterruptedException,
                            MarathonFileMissingException,
                            MarathonFileInvalidException

Description copied from class: MarathonBuilder

Read in default file (marathon.json) as JSON.

Specified by:

read in class MarathonBuilder

Returns:

This builder

Throws:

IOException - on IO issues

InterruptedException - on complications reading file

MarathonFileMissingException - when the Marathon config file is missing

MarathonFileInvalidException - when the Marathon config is not a file

See Also:

MarathonBuilder.read(String)

getJson

public net.sf.json.JSONObject getJson()

Specified by:

getJson in class MarathonBuilder

setJson

public MarathonBuilder setJson(net.sf.json.JSONObject json)

Description copied from class: MarathonBuilder

Set the JSON for this builder to json. This will overwrite the value set by MarathonBuilder.read(String).

Specified by:

setJson in class MarathonBuilder

Parameters:

json - The JSON value to use for this builder

Returns:

This builder

setEnvVars

public MarathonBuilder setEnvVars(hudson.EnvVars vars)

Description copied from class: MarathonBuilder

Set the Jenkins Environment Variables to vars. These are used when building the final Marathon payload to convert Jenkins variables to their values.

Specified by:

setEnvVars in class MarathonBuilder

Parameters:

vars - Jenkins environment variables

Returns:

This builder

setConfig

public MarathonBuilder setConfig(AppConfig config)

Description copied from class: MarathonBuilder

Set the Application Configuration to config.

Specified by:

setConfig in class MarathonBuilder

Parameters:

config - application configuration

Returns:

This builder

setWorkspace

public MarathonBuilder setWorkspace(hudson.FilePath ws)

Description copied from class: MarathonBuilder

Set the Jenkins workspace to ws.

Specified by:

setWorkspace in class MarathonBuilder

Parameters:

ws - Jenkins workspace

Returns:

This builder

build

public MarathonBuilder build()

Description copied from class: MarathonBuilder

Compose the builder. This populates certain fields with the proper Jenkins values and creates a Marathon Client.

Specified by:

build in class MarathonBuilder

Returns:

This builder

See Also:

MarathonClient

toFile

public MarathonBuilder toFile(String filename)
                       throws InterruptedException,
                              IOException,
                              MarathonFileInvalidException

Description copied from class: MarathonBuilder

Write the JSON that will be sent to the target Marathon instance to filename.

Specified by:

toFile in class MarathonBuilder

Parameters:

filename - File to write rendered JSON

Returns:

This builder

Throws:

InterruptedException - when issues encountered with filesystem

IOException - on IO issues

MarathonFileInvalidException - when Marathon config file is not a file

toFile

public MarathonBuilder toFile()
                       throws InterruptedException,
                              IOException,
                              MarathonFileInvalidException

Description copied from class: MarathonBuilder

Write the JSON that will be sent to the target Marathon instance to the default file (marathon-rendered-${BUILD_NUMBER}.json).

Specified by:

toFile in class MarathonBuilder

Returns:

This builder

Throws:

InterruptedException - when issues encountered with filesystem

IOException - on IO issues

MarathonFileInvalidException - when Marathon config file is not a file

See Also:

MarathonBuilder.toFile(String)