Package io.github.pod4dev.java.service.impl

Class PlayerImpl

java.lang.Object

io.github.pod4dev.java.service.impl.PlayerImpl

All Implemented Interfaces:

GenericService, Player, AutoCloseable

public class PlayerImpl
extends Object
implements Player

Work with /kube/play API.

Constructor Summary

Constructors

Constructor	Description
PlayerImpl(String yamlPath)
PlayerImpl(URI podmanUri, String yamlPath)

Method Summary

Modifier and Type	Method	Description
PodmanClient	getClient()	Get API client.
Integer	getMappedPort(String serviceName, Integer exposedPort)	Getting mapped port for the given service's name and exposed port.
boolean	isRunning()	Check if service is running.
void	start()	Creates the pod or container and immediately starts it.
void	stop()	Stops the pod or container with clearing created volumes.
PlayerImpl	withCleanup(boolean doCleanup)	Do resources cleanup after stopping.
PlayerImpl	withExposedService(String serviceName, Integer exposedPort)	Specify service and its port for expose.
PlayerImpl	withRemoveVolumes(boolean doRemoveVolumes)	Do volumes cleanup after stopping.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.pod4dev.java.service.GenericService

close, getMappedHost

Constructor Details

PlayerImpl

public PlayerImpl(URI podmanUri,
 String yamlPath)
           throws PodmanException

Throws:

PodmanException

PlayerImpl

public PlayerImpl(String yamlPath)
           throws PodmanException

Throws:

PodmanException

Method Details

getClient

public PodmanClient getClient()

Description copied from interface: GenericService

Get API client.

Specified by:

getClient in interface GenericService

Returns:

API client.

isRunning

public boolean isRunning()

Description copied from interface: GenericService

Check if service is running.

Specified by:

isRunning in interface GenericService

Returns:

check result.

withExposedService

public PlayerImpl withExposedService(String serviceName,
 Integer exposedPort)
                              throws PodmanException

Description copied from interface: Player

Specify service and its port for expose.

Specified by:

withExposedService in interface Player

Parameters:

serviceName - name of service to expose.

exposedPort - port to expose.

Returns:

container with exposed services.

Throws:

PodmanException

withCleanup

public PlayerImpl withCleanup(boolean doCleanup)

Description copied from interface: GenericService

Do resources cleanup after stopping.

Specified by:

withCleanup in interface GenericService

Parameters:

doCleanup - default is true.

Returns:

customised container.

withRemoveVolumes

public PlayerImpl withRemoveVolumes(boolean doRemoveVolumes)

Description copied from interface: GenericService

Do volumes cleanup after stopping.

Specified by:

withRemoveVolumes in interface GenericService

Parameters:

doRemoveVolumes - default is true.

Returns:

customised container.

start

public void start()
           throws PodmanException

Description copied from interface: GenericService

Creates the pod or container and immediately starts it. All created resources will be cleared out when a SIGTERM is received or pods exit.

Specified by:

start in interface GenericService

Throws:

PodmanException

stop

public void stop()
          throws PodmanException

Description copied from interface: GenericService

Stops the pod or container with clearing created volumes.

Specified by:

stop in interface GenericService

Throws:

PodmanException

getMappedPort

public Integer getMappedPort(String serviceName,
 Integer exposedPort)
                      throws PodmanException

Description copied from interface: Player

Getting mapped port for the given service's name and exposed port.

Specified by:

getMappedPort in interface Player

Parameters:

serviceName - the service name.

exposedPort - the exposed port.

Returns:

mapped host.

Throws:

PodmanException