com.github.dockerunit.core

Class ServiceInstance

java.lang.Object

com.github.dockerunit.core.ServiceInstance

public class ServiceInstance
extends Object

Represents an instance of a discoverable svc and wraps a Docker container.

See Also:

Service, ServiceContext

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceInstance.Status

Constructor Summary

Constructors

Constructor and Description
ServiceInstance()

Method Summary

Modifier and Type	Method and Description
String	getContainerId()
String	getContainerIp()
String	getContainerName()
int	getContainerPort()
String	getGatewayAddress() Provides the ip or host name of the gateway to reach this svc instance.
int	getGatewayPort() Provides the gateway level port this instance is listening on.
String	getIp() Deprecated. use the getGatewayAddress() method instead.
int	getPort() Deprecated. use the getGatewayPort() method instead.
ServiceInstance.Status	getStatus()
String	getStatusDetails()
boolean	hasStatus(ServiceInstance.Status status) Checks whether the instance is in the specified status.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceInstance

public ServiceInstance()

Method Detail

getContainerName

public String getContainerName()

Returns:

the name that has been assigned to the underlying docker container.

getGatewayAddress

public String getGatewayAddress()

Provides the ip or host name of the gateway to reach this svc instance. By default Dockerunit uses 172.17.42.1. You can override this by using the -Ddocker.bridge.ip system property.

 mvn test -Ddocker.bridge.ip=172.17.0.1
 

Returns:

the ip of the gateway to reach the svc instance.

getIp

public String getIp()

Deprecated. use the getGatewayAddress() method instead.

Returns:

the ip of the gateway to reach the svc instance.

getGatewayPort

public int getGatewayPort()

Provides the gateway level port this instance is listening on. If you are running a single instance and you are using PublishPort, then this returns the value of the host property. If you are running multiple instances, then you need to use PublishPorts otherwise Docker will detect a port conflict and fail to start the corresponding container. If neither PublishPort nor PublishPorts has been used, this returns 0.

Returns:

the gateway level port this instance is listening on.

getPort

public int getPort()

Deprecated. use the getGatewayPort() method instead.

Returns:

the gateway level port this instance is listening on.

getContainerId

public String getContainerId()

Returns:

the containerId Docker has assigned to the underlying container.

getContainerIp

public String getContainerIp()

Returns:

the ip of the underlying container

getContainerPort

public int getContainerPort()

Returns:

the exposed port of the underlying container. If the container exposes multiple ports, this returns the one that is used by the health-check definition.

getStatus

public ServiceInstance.Status getStatus()

Returns:

the status

getStatusDetails

public String getStatusDetails()

Returns:

the statusDetails

hasStatus

public boolean hasStatus(ServiceInstance.Status status)

Checks whether the instance is in the specified status.

Parameters:

status - the specified status

Returns:

true if the instance is in the specified status, false otherwise.