sirius.kernel

Class DockerHelper

java.lang.Object

sirius.kernel.settings.PortMapper

sirius.kernel.DockerHelper

All Implemented Interfaces:

Initializable, Priorized, Killable

public class DockerHelper
extends PortMapper
implements Initializable, Killable

Initializes Docker Composer if requested by the framework.

This basically uses docker.file from the system config to determine which compser file to use and start / stops docker for each test run or staging environment.

Also it provides a PortMapper to map the desired production ports to the ones provided by the docker containers.

Field Summary

Fields inherited from interface sirius.kernel.di.std.Priorized

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
DockerHelper()

Method Summary

Modifier and Type	Method and Description
void	awaitTermination() Called after Stoppable.stopped() has been called to wait until all tasks are fully finished.
int	getPriority() Returns the priority of this element.
void	initialize() Invoked by the injector once the system is completely initialized.
protected Tuple<String,Integer>	map(String service, String host, int port) Maps the given port for the given service.

Methods inherited from class sirius.kernel.settings.PortMapper

mapPort, setMapper

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerHelper

public DockerHelper()

Method Detail

getPriority

public int getPriority()

Description copied from interface: Priorized

Returns the priority of this element.

Specified by:

getPriority in interface Priorized

Specified by:

getPriority in interface Killable

Returns:

the priority - lower is better (comes first)

map

protected Tuple<String,Integer> map(String service,
                                    String host,
                                    int port)

Description copied from class: PortMapper

Maps the given port for the given service.

Specified by:

map in class PortMapper

Parameters:

service - the service used to identify to container which provides the service

host - the host to map

port - the port to map

Returns:

the mapped port number or port if no mapping is present.

initialize

public void initialize()
                throws Exception

Description copied from interface: Initializable

Invoked by the injector once the system is completely initialized.

Can be used to perform initial actions where access to dependent parts is required.

Specified by:

initialize in interface Initializable

Throws:

Exception - in case of any error during the initialization.

awaitTermination

public void awaitTermination()

Description copied from interface: Killable

Called after Stoppable.stopped() has been called to wait until all tasks are fully finished.

This method may block for a certain amount of time to permit the subsystem to shut down properly. However, it should not block infinitely...

Specified by:

awaitTermination in interface Killable