Package dev.galasa.linux

Interface ILinuxImage

All Known Subinterfaces:

ILinuxProvisionedImage

public interface ILinuxImage

Represents a Linux Image .

Use a LinuxImage annotation to populate this field with

Author:

Michael Baylis

Method Summary

Modifier and Type	Method	Description
@NotNull Path	getArchivesDirectory()
@NotNull ICommandShell	getCommandShell()
@NotNull ICredentials	getDefaultCredentials()	Retrieve the default credentials for the Image.
@NotNull Path	getHome()
@NotNull String	getImageID()	Get the name of the Linux Image
@NotNull IIpHost	getIpHost()	Retrieve the IP Network Host details
@NotNull Path	getRoot()
@NotNull Path	getRunDirectory()
@NotNull Path	getTmp()

Method Details

getImageID

@NotNull
@NotNull String getImageID()

Get the name of the Linux Image

Returns:

The image ID, never null

getIpHost

@NotNull
@NotNull IIpHost getIpHost()

Retrieve the IP Network Host details

Returns:

getDefaultCredentials

@NotNull
@NotNull ICredentials getDefaultCredentials()
                                     throws LinuxManagerException

Retrieve the default credentials for the Image.

Returns:

The default credentials - see

invalid @link

dev.galasa.framework.spi.creds.ICredentials

Throws:

LinuxManagerException - if the credentials are missing or there is a problem with the credentials store

getCommandShell

@NotNull
@NotNull ICommandShell getCommandShell()
                                throws LinuxManagerException

Throws:

LinuxManagerException

getRoot

@NotNull
@NotNull Path getRoot()
               throws LinuxManagerException

Throws:

LinuxManagerException

getHome

@NotNull
@NotNull Path getHome()
               throws LinuxManagerException

Throws:

LinuxManagerException

getTmp

@NotNull
@NotNull Path getTmp()
              throws LinuxManagerException

Throws:

LinuxManagerException

getRunDirectory

@NotNull
@NotNull Path getRunDirectory()
                       throws LinuxManagerException

Throws:

LinuxManagerException

getArchivesDirectory

@NotNull
@NotNull Path getArchivesDirectory()
                            throws LinuxManagerException

Throws:

LinuxManagerException