io.failify.dsl.entities

Class Service.Builder

java.lang.Object

io.failify.dsl.DeploymentEntity.BuilderBase<Service,Deployment.Builder>

io.failify.dsl.entities.Service.Builder

Enclosing class:

Service

public static class Service.Builder
extends DeploymentEntity.BuilderBase<Service,Deployment.Builder>

The builder class to build a service object

Field Summary

Fields inherited from class io.failify.dsl.DeploymentEntity.BuilderBase

name, parentBuilder

Constructor Summary

Constructors

Constructor and Description
Builder(Deployment.Builder parentBuilder, Service instance) Constructor
Builder(Deployment.Builder parentBuilder, String name) Constructor
Builder(Service instance) Constructor
Builder(String name) Constructor

Method Summary

Modifier and Type	Method and Description
Service.Builder	applicationPath(String path, String targetPath, PathAttr... pathAttrs) Adds a local path to the specified absolute target path in the node created out of this service
Service	build() This method should be implemented by all of the builders and should build the object that this builder is responsible for
Service.Builder	dockerFileAddress(String dockerFileAddress, Boolean forceBuild) Sets the Dockerfile address to be used to build the docker image for this service
Service.Builder	dockerImageName(String dockerImage) Sets the docker image name and tag to be used for this service.
Service.Builder	environmentVariable(String name, String value) Adds an environment variable to the service
Service.Builder	initCommand(String initCommand) Sets the init command for the service which will be executed only once
Service.Builder	instrumentablePath(String instrumentablePath) Adds an instrumentable path to the service.
Service.Builder	libraryPath(String path) Marks an absolute target path in container of a node created out of this service as a library path.
Service.Builder	logDirectory(String path) Adds an absolute target path in the container of the node created out of this service to be collected as a log file into the node's local workspace
Service.Builder	logFile(String path) Adds an absolute target path in the container of the node created out of this service to be collected as a log file into the node's local workspace
protected void	returnToParent(Service builtObj) This method should be implemented by all of the builders and should call a method in the parent builder to add the built object to the parent builder
Service.Builder	serviceType(ServiceType serviceType) Sets the programming language of the service to be used by the instrumentation engine
Service.Builder	startCommand(String startCommand) Sets the start command for the service which will be executed only once
Service.Builder	stopCommand(String stopCommand) Sets the stop command for the service which will be executed only once
Service.Builder	tcpPort(Integer... portNumber) Adds a tcp port to be exposed by the container of a node created out of this service
Service.Builder	udpPort(Integer... portNumber) Adds a udp port to be exposed by the container of a node created out of this service

Methods inherited from class io.failify.dsl.DeploymentEntity.BuilderBase

and, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(Deployment.Builder parentBuilder,
               String name)

Constructor

Parameters:

parentBuilder - the parent builder object for this builder

name - the name of the service to be built

Builder

public Builder(String name)

Constructor

Parameters:

name - the name of the service to be built

Builder

public Builder(Deployment.Builder parentBuilder,
               Service instance)

Constructor

Parameters:

parentBuilder - the parent builder object for this builder

instance - a service object instance to be changed

Builder

public Builder(Service instance)

Constructor

Parameters:

instance - a service object instance to be changed

Method Detail

dockerImageName

public Service.Builder dockerImageName(String dockerImage)

Sets the docker image name and tag to be used for this service. If dockerfile address is set for this service, this will be the name of the build docker image out of the dockerfile.

Parameters:

dockerImage - the docker image name and tag

Returns:

the current builder instance

dockerFileAddress

public Service.Builder dockerFileAddress(String dockerFileAddress,
                                         Boolean forceBuild)

Sets the Dockerfile address to be used to build the docker image for this service

Parameters:

dockerFileAddress -

forceBuild -

Returns:

instrumentablePath

public Service.Builder instrumentablePath(String instrumentablePath)

Adds an instrumentable path to the service. Instrumentable paths will be marked as changeable and are the only paths that may be changed by an instrumentor

Parameters:

instrumentablePath - an absolute target path in the container of a node created out of this this service to be marked as instrumentable

Returns:

the current builder instance

startCommand

public Service.Builder startCommand(String startCommand)

Sets the start command for the service which will be executed only once

Parameters:

startCommand - the start command of the service

Returns:

the current builder instance

initCommand

public Service.Builder initCommand(String initCommand)

Sets the init command for the service which will be executed only once

Parameters:

initCommand - the init command of the service

Returns:

the current builder instance

stopCommand

public Service.Builder stopCommand(String stopCommand)

Sets the stop command for the service which will be executed only once

Parameters:

stopCommand - the stop command of the service

Returns:

the current builder instance

serviceType

public Service.Builder serviceType(ServiceType serviceType)

Sets the programming language of the service to be used by the instrumentation engine

Parameters:

serviceType - the programming language of the service

Returns:

the current builder instance

applicationPath

public Service.Builder applicationPath(String path,
                                       String targetPath,
                                       PathAttr... pathAttrs)

Adds a local path to the specified absolute target path in the node created out of this service

Parameters:

path - a local path

targetPath - an absolute target path in the container of the node created out of this service

pathAttrs - the attributes of the path. PathAttr.LIBRARY marks the path as a library to be used by the instrumentation engine. PathAttr.COMPRESSED marks the path as compressed to be decompressed before being added to the node created out of this service. PathAttr.CHANGEABLE marks the path as changeable which results in a separate copy of the path for each node.

Returns:

the current builder instance

libraryPath

public Service.Builder libraryPath(String path)

Marks an absolute target path in container of a node created out of this service as a library path. This is useful when there is an application path which is not a libray path which has a sub-path that is desired to be a library path

Parameters:

path - an absolute or wildcard target path to be marked as a library path

Returns:

logFile

public Service.Builder logFile(String path)

Adds an absolute target path in the container of the node created out of this service to be collected as a log file into the node's local workspace

Parameters:

path - an absolute target log file path to be collected

Returns:

the current builder instance

logDirectory

public Service.Builder logDirectory(String path)

Adds an absolute target path in the container of the node created out of this service to be collected as a log file into the node's local workspace

Parameters:

path - an absolute target log file path to be collected

Returns:

the current builder instance

environmentVariable

public Service.Builder environmentVariable(String name,
                                           String value)

Adds an environment variable to the service

Parameters:

name - the name of the variable

value - the value of the variable

Returns:

the current builder instance

tcpPort

public Service.Builder tcpPort(Integer... portNumber)

Adds a tcp port to be exposed by the container of a node created out of this service

Parameters:

portNumber - the tcp port number to be exposed

Returns:

the current builder instance

udpPort

public Service.Builder udpPort(Integer... portNumber)

Adds a udp port to be exposed by the container of a node created out of this service

Parameters:

portNumber - the udp port number to be exposed

Returns:

the current builder instance

build

public Service build()

Description copied from class: DeploymentEntity.BuilderBase

This method should be implemented by all of the builders and should build the object that this builder is responsible for

Specified by:

build in class DeploymentEntity.BuilderBase<Service,Deployment.Builder>

Returns:

returnToParent

protected void returnToParent(Service builtObj)

Description copied from class: DeploymentEntity.BuilderBase

This method should be implemented by all of the builders and should call a method in the parent builder to add the built object to the parent builder

Specified by:

returnToParent in class DeploymentEntity.BuilderBase<Service,Deployment.Builder>