AppServerHandler (JKube Kit :: Generator

All Known Implementing Classes:

AbstractAppServerHandler, CustomAppServerHandler, JettyAppSeverHandler, TomcatAppSeverHandler, WildFlyAppSeverHandler
```
public interface AppServerHandler
```
Interface encapsulating a certain application handler

Author:

kameshs

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default List<String>`	`exposedPorts()` A list of ports which are exposed by the base image
`default 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.
`default Map<String,String>`	`getEnv()` A Map containing environment variables to add to the Image.
`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
`default String`	`getUser()` Get the user to use.
`boolean`	`isApplicable()` Return true it the handler thinks it should kick in.
`default List<String>`	`runCmds()` A list of commands to run during image build phase.
`default boolean`	`supportsS2iBuild()` If this handler support S2I source builds.

- Method Detail
  - isApplicable
```
boolean isApplicable()
```
    Return true it the handler thinks it should kick in. Typically check for certain app server specific files and or plugins.
    
    Returns:
    
    true is this handler should run, false otherwise
  - getName
```
String getName()
```
    Name of the server that this appserver handler stands for
    
    Returns:
    
    server name
  - getFrom
```
String getFrom()
```
    Get the base image to use for this specific app server
    
    Returns:
    
    base image name in Docker format.
  - getDeploymentDir
```
String getDeploymentDir()
```
    Get the directory with in the base image where to put the applications into.
    
    Returns:
    
    the deployment directory fitting the the from() image.
  - getCommand
```
String getCommand()
```
    Get the default command to put into the image, which should fit to the image returned from from()
    
    Returns:
    
    the default command.
  - getUser
```
default String getUser()
```
    Get the user to use. Return null if no specific user directive is required
  - exposedPorts
```
default List<String> exposedPorts()
```
    A list of ports which are exposed by the base image
    
    Returns:
    
    list of ports to expos
  - getEnv
```
default Map<String,String> getEnv()
```
    A Map containing environment variables to add to the Image.
    
    Returns:
    
    the Map containing environment variables.
  - getAssemblyName
```
default String getAssemblyName()
```
    The name for the assembly configuration (will also be the name of the directory where artifacts are placed for Dockerfile COPY).
    
    Returns:
    
    the assembly name.
  - runCmds
```
default List<String> runCmds()
```
    A list of commands to run during image build phase.
    
    Returns:
    
    the list of commands to run.
  - supportsS2iBuild
```
default boolean supportsS2iBuild()
```
    If this handler support S2I source builds.
    
    Returns:
    
    true if the handler supports S2I builds, false otherwise.

Interface AppServerHandler

Method Summary

Method Detail

isApplicable

getName

getFrom

getDeploymentDir

getCommand

getUser

exposedPorts

getEnv

getAssemblyName

runCmds

supportsS2iBuild