com.mesosphere.velocity.marathon.interfaces

Class MarathonBuilder

java.lang.Object

com.mesosphere.velocity.marathon.interfaces.MarathonBuilder

Direct Known Subclasses:

MarathonBuilderImpl

public abstract class MarathonBuilder
extends Object

This builds Marathon Clients from Jenkins, file system, and JSON pieces. This allows the construction of the final payload as well as sending it to the target Marathon instance.

Constructor Summary

Constructors

Constructor and Description
MarathonBuilder()

Method Summary

Modifier and Type	Method and Description
abstract MarathonBuilder	build() Compose the builder.
mesosphere.marathon.client.model.v2.App	getApp()
static MarathonBuilder	getBuilder(AppConfig config) Create a new builder instance from config.
abstract net.sf.json.JSONObject	getJson()
String	getURL()
abstract MarathonBuilder	read() Read in default file (marathon.json) as JSON.
abstract MarathonBuilder	read(String filename) Read in filename as JSON.
protected void	setAppFromJson(net.sf.json.JSONObject json) Set Marathon application from JSON object.
abstract MarathonBuilder	setConfig(AppConfig config) Set the Application Configuration to config.
abstract MarathonBuilder	setEnvVars(hudson.EnvVars vars) Set the Jenkins Environment Variables to vars.
abstract MarathonBuilder	setJson(net.sf.json.JSONObject json) Set the JSON for this builder to json.
void	setURL(String url)
abstract MarathonBuilder	setWorkspace(hudson.FilePath ws) Set the Jenkins workspace to ws.
abstract MarathonBuilder	toFile() Write the JSON that will be sent to the target Marathon instance to the default file (marathon-rendered-${BUILD_NUMBER}.json).
abstract MarathonBuilder	toFile(String filename) Write the JSON that will be sent to the target Marathon instance to filename.
abstract MarathonBuilder	update() Update the Marathon application.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarathonBuilder

public MarathonBuilder()

Method Detail

getBuilder

public static MarathonBuilder getBuilder(AppConfig config)

Create a new builder instance from config.

Parameters:

config - Application configuration

Returns:

A new builder

getURL

public String getURL()

setURL

public void setURL(String url)

getApp

public mesosphere.marathon.client.model.v2.App getApp()

setAppFromJson

protected void setAppFromJson(net.sf.json.JSONObject json)
                       throws com.google.gson.JsonSyntaxException

Set Marathon application from JSON object.

Parameters:

json - JSON object to initially build Marathon application from

Throws:

com.google.gson.JsonSyntaxException

update

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

Update the Marathon application.

Returns:

This builder

Throws:

mesosphere.marathon.client.MarathonException - on error talking to Marathon service

AuthenticationException - when authentication with Marathon service fails

read

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

Read in filename as JSON.

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 abstract MarathonBuilder read()
                              throws IOException,
                                     InterruptedException,
                                     MarathonFileMissingException,
                                     MarathonFileInvalidException

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

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:

read(String)

getJson

public abstract net.sf.json.JSONObject getJson()

setJson

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

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

Parameters:

json - The JSON value to use for this builder

Returns:

This builder

setEnvVars

public abstract MarathonBuilder setEnvVars(hudson.EnvVars vars)

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

Parameters:

vars - Jenkins environment variables

Returns:

This builder

setConfig

public abstract MarathonBuilder setConfig(AppConfig config)

Set the Application Configuration to config.

Parameters:

config - application configuration

Returns:

This builder

setWorkspace

public abstract MarathonBuilder setWorkspace(hudson.FilePath ws)

Set the Jenkins workspace to ws.

Parameters:

ws - Jenkins workspace

Returns:

This builder

build

public abstract MarathonBuilder build()

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

Returns:

This builder

See Also:

MarathonClient

toFile

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

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

Parameters:

filename - File to write rendered JSON

Returns:

This builder

Throws:

InterruptedException - when issues encountered with filesystem

MarathonFileInvalidException - when Marathon config file is not a file

IOException - on IO issues

toFile

public abstract MarathonBuilder toFile()
                                throws InterruptedException,
                                       IOException,
                                       MarathonFileInvalidException

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

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:

toFile(String)