org.eclipse.jkube.generator.webapp.handler

Class CustomAppServerHandler

java.lang.Object

org.eclipse.jkube.generator.webapp.handler.CustomAppServerHandler

All Implemented Interfaces:

AppServerHandler

public class CustomAppServerHandler
extends Object
implements AppServerHandler

A custom app server handler used when use explicitly configures the base image

Author:

roland

Constructor Summary

Constructors

Constructor and Description
CustomAppServerHandler(String from, String deploymentDir, String command, String user, List<String> ports, boolean supportsS2iBuild)

Method Summary

Modifier and Type	Method and Description
List<String>	exposedPorts() A list of ports which are exposed by the base image
String	getAssemblyName() The name for the assembly configuration (will also be the name of the directory where artifacts are placed for Dockerfile COPY).
String	getCommand() Get the default command to put into the image, which should fit to the image returned from from()
String	getDeploymentDir() Get the directory with in the base image where to put the applications into.
String	getFrom() Get the base image to use for this specific app server
String	getName() Name of the server that this appserver handler stands for
String	getUser() Get the user to use.
boolean	isApplicable() Return true it the handler thinks it should kick in.
boolean	supportsS2iBuild() If this handler support S2I source builds.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jkube.generator.webapp.AppServerHandler

getEnv, runCmds

Constructor Detail

CustomAppServerHandler

public CustomAppServerHandler(String from,
                              String deploymentDir,
                              String command,
                              String user,
                              List<String> ports,
                              boolean supportsS2iBuild)

Method Detail

isApplicable

public boolean isApplicable()

Description copied from interface: AppServerHandler

Return true it the handler thinks it should kick in. Typically check for certain app server specific files and or plugins.

Specified by:

isApplicable in interface AppServerHandler

Returns:

true is this handler should run, false otherwise

getName

public String getName()

Description copied from interface: AppServerHandler

Name of the server that this appserver handler stands for

Specified by:

getName in interface AppServerHandler

Returns:

server name

getFrom

public String getFrom()

Description copied from interface: AppServerHandler

Get the base image to use for this specific app server

Specified by:

getFrom in interface AppServerHandler

Returns:

base image name in Docker format.

getAssemblyName

public String getAssemblyName()

Description copied from interface: AppServerHandler

The name for the assembly configuration (will also be the name of the directory where artifacts are placed for Dockerfile COPY).

Specified by:

getAssemblyName in interface AppServerHandler

Returns:

the assembly name.

getDeploymentDir

public String getDeploymentDir()

Description copied from interface: AppServerHandler

Get the directory with in the base image where to put the applications into.

Specified by:

getDeploymentDir in interface AppServerHandler

Returns:

the deployment directory fitting the the from() image.

getCommand

public String getCommand()

Description copied from interface: AppServerHandler

Get the default command to put into the image, which should fit to the image returned from from()

Specified by:

getCommand in interface AppServerHandler

Returns:

the default command.

getUser

public String getUser()

Description copied from interface: AppServerHandler

Get the user to use. Return null if no specific user directive is required

Specified by:

getUser in interface AppServerHandler

exposedPorts

public List<String> exposedPorts()

Description copied from interface: AppServerHandler

A list of ports which are exposed by the base image

Specified by:

exposedPorts in interface AppServerHandler

Returns:

list of ports to expos

supportsS2iBuild

public boolean supportsS2iBuild()

Description copied from interface: AppServerHandler

If this handler support S2I source builds.

Specified by:

supportsS2iBuild in interface AppServerHandler

Returns:

true if the handler supports S2I builds, false otherwise.