com.github.dockerunit.core

Class Service

java.lang.Object

com.github.dockerunit.core.Service

public class Service
extends Object

Represents a discoverable container or group of Docker containers. Each container is based on the declared image.

It has at least one instance (container) and it is healthy if and only if all its instances are healthy.

The svc name is used to instruct the DiscoveryProvider and make the svc discoverable by other services.

See Also:

Svc

Constructor Summary

Constructors

Constructor and Description
Service()

Method Summary

Modifier and Type	Method and Description
boolean	checkStatus(ServiceInstance.Status status) Checks whether all the ServiceInstances in this svc are in the specified ServiceInstance.Status.
ServiceDescriptor	getDescriptor()
Set<ServiceInstance>	getInstances()
String	getName()
List<String>	getWarnings()
boolean	isHealthy()

Methods inherited from class java.lang.Object

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

Constructor Detail

Service

public Service()

Method Detail

isHealthy

public boolean isHealthy()

Returns:

true if all the instances have started successfully.

checkStatus

public boolean checkStatus(ServiceInstance.Status status)

Checks whether all the ServiceInstances in this svc are in the specified ServiceInstance.Status.

Parameters:

status - the ServiceInstance.Status to check

Returns:

true if all the ServiceInstances in this svc are in the specified status, false otherwise.

getName

public String getName()

Returns:

the svc name as declared in Svc

getInstances

public Set<ServiceInstance> getInstances()

Returns:

the set of instances (containers) for this svc.

See Also:

ServiceInstance

getDescriptor

public ServiceDescriptor getDescriptor()

Returns:

the descriptor of this svc that provides the runtime representation of the annotation based configuration that has been used.

getWarnings

public List<String> getWarnings()