Package dev.galasa.cloud

Interface ICloudContainer

public interface ICloudContainer

Cloud Container

Author:

Michael Baylis

Method Summary

Modifier and Type	Method	Description
InetSocketAddress	getContainerExposedPort(int portNumber)	Retrieve the port number for an exposed port
InetSocketAddress	getContainerExposedPort(String portName)	Retrieve the port number for an exposed port
String	getLog()	Retrieve the stdout/stderr log of the container
String	getPlatform()
String	retrieveFileAsString(String path)	Retrieve the contents of a file within the container
void	start()	Start of the container, depending on the provider, this may result in the container being defined and started
void	stop()	Stop the container, depending on the provider, this may result in the container being deleted.

Method Details

getContainerExposedPort

InetSocketAddress getContainerExposedPort(String portName)
                                   throws CloudManagerException

Retrieve the port number for an exposed port

Parameters:

portName - - The name of the port

Returns:

the hostname/port

Throws:

CloudManagerException

getContainerExposedPort

InetSocketAddress getContainerExposedPort(int portNumber)
                                   throws CloudManagerException

Retrieve the port number for an exposed port

Parameters:

portNumber - - The number of the port

Returns:

the hostname/port

Throws:

CloudManagerException

getLog

String getLog()
       throws CloudManagerException

Retrieve the stdout/stderr log of the container

Returns:

The log

Throws:

CloudManagerException

retrieveFileAsString

String retrieveFileAsString(String path)
                     throws CloudManagerException

Retrieve the contents of a file within the container

Parameters:

path - - The absolute path of the file

Returns:

The contents of the file

Throws:

CloudManagerException

stop

void stop()
   throws CloudManagerException

Stop the container, depending on the provider, this may result in the container being deleted.

Throws:

CloudManagerException

start

void start()
    throws CloudManagerException

Start of the container, depending on the provider, this may result in the container being defined and started

Throws:

CloudManagerException

getPlatform

String getPlatform()

Returns:

The platform the container was provisioned on