sirius.kernel.settings

Class PortMapper

java.lang.Object

sirius.kernel.settings.PortMapper

Direct Known Subclasses:

DockerHelper

public abstract class PortMapper
extends Object

Maps a given destination port to the effective port assigned.

This is mainly used in test environments where we provision external dependencies via docker composer. As docker assigns a more or less random port per test run, we need to determine and assign this.

As we do not want a production dependency against docker, we use this bridge class and provide an appropriate implementation as DockerHelper in the test scope.

Constructor Summary

Constructors

Constructor and Description
PortMapper()

Method Summary

Modifier and Type	Method and Description
protected abstract Tuple<String,Integer>	map(String service, String host, int port) Maps the given port for the given service.
static Tuple<String,Integer>	mapPort(String service, String host, int port) Maps the given port for the given service.
static void	setMapper(PortMapper mapper) Determines which port mapper to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortMapper

public PortMapper()

Method Detail

setMapper

public static void setMapper(PortMapper mapper)

Determines which port mapper to use.

Parameters:

mapper - the mapper to use.

mapPort

public static Tuple<String,Integer> mapPort(String service,
                                            String host,
                                            int port)

Maps the given port for the given service.

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 mapper is present.

map

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

Maps the given port for the given service.

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.