Module com.oracle.bedrock.runtime.docker

Package com.oracle.bedrock.runtime.docker

Class DockerImage

java.lang.Object

com.oracle.bedrock.runtime.docker.DockerImage

All Implemented Interfaces:

com.oracle.bedrock.extensible.Feature, com.oracle.bedrock.runtime.ApplicationListener<com.oracle.bedrock.runtime.Application>

public class DockerImage
extends Object
implements com.oracle.bedrock.extensible.Feature, com.oracle.bedrock.runtime.ApplicationListener<com.oracle.bedrock.runtime.Application>

A representation of a Docker image.

Copyright (c) 2016. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Jonathan Knight

Constructor Summary

Constructors

Constructor	Description
DockerImage(List<String> tags, com.oracle.bedrock.OptionsByType optionsByType)	Create a DockerImage.

Method Summary

Modifier and Type	Method	Description
com.oracle.bedrock.runtime.Application	getApplication()
Docker	getDockerEnvironment()	Obtain the Docker environment used to build this DockerImage.
String	getFirstTag()	Obtain the first of the tags used to identify this image.
com.oracle.bedrock.OptionsByType	getOptions()	Obtain the OptionsByType used to build this image.
List<String>	getTags()	Obtain the tags to identify this image.
javax.json.JsonValue	inspect()	Obtain information about this DockerImage as a JsonArray.
void	onAddingTo(com.oracle.bedrock.extensible.Extensible extensible)
void	onClosed(com.oracle.bedrock.runtime.Application application, com.oracle.bedrock.OptionsByType optionsByType)
void	onClosing(com.oracle.bedrock.runtime.Application application, com.oracle.bedrock.OptionsByType optionsByType)
void	onLaunched(com.oracle.bedrock.runtime.Application application)
void	onRemovingFrom(com.oracle.bedrock.extensible.Extensible extensible)
boolean	remove()	Remove this DockerImage.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerImage

public DockerImage(List<String> tags,
                   com.oracle.bedrock.OptionsByType optionsByType)

Create a DockerImage.

Parameters:

tags - the tags to identify this image

optionsByType - the OptionsByType used to build this image

Method Detail

getApplication

public com.oracle.bedrock.runtime.Application getApplication()

getOptions

public com.oracle.bedrock.OptionsByType getOptions()

Obtain the OptionsByType used to build this image.

Returns:

the OptionsByType used to build this image

getTags

public List<String> getTags()

Obtain the tags to identify this image.

Returns:

the tags to identify this image

getFirstTag

public String getFirstTag()

Obtain the first of the tags used to identify this image.

Returns:

the first of the tags used to identify this image

getDockerEnvironment

public Docker getDockerEnvironment()

Obtain the Docker environment used to build this DockerImage.

Returns:

the Docker environment used to build this DockerImage

inspect

public javax.json.JsonValue inspect()

Obtain information about this DockerImage as a JsonArray.

The JsonArray will have a single entry that is the JSON representation of this DockerImage's state.

This equates to running the docker inspect command for this DockerImage.

Returns:

information about this DockerImage as a JsonArray

remove

public boolean remove()

Remove this DockerImage.

This equates to running the docker rmi command for this DockerImage.

Returns:

true if the remove was successful, false otherwise

onAddingTo

public void onAddingTo(com.oracle.bedrock.extensible.Extensible extensible)

Specified by:

onAddingTo in interface com.oracle.bedrock.extensible.Feature

onRemovingFrom

public void onRemovingFrom(com.oracle.bedrock.extensible.Extensible extensible)

Specified by:

onRemovingFrom in interface com.oracle.bedrock.extensible.Feature

onLaunched

public void onLaunched(com.oracle.bedrock.runtime.Application application)

Specified by:

onLaunched in interface com.oracle.bedrock.runtime.ApplicationListener<com.oracle.bedrock.runtime.Application>

onClosing

public void onClosing(com.oracle.bedrock.runtime.Application application,
                      com.oracle.bedrock.OptionsByType optionsByType)

Specified by:

onClosing in interface com.oracle.bedrock.runtime.ApplicationListener<com.oracle.bedrock.runtime.Application>

onClosed

public void onClosed(com.oracle.bedrock.runtime.Application application,
                     com.oracle.bedrock.OptionsByType optionsByType)

Specified by:

onClosed in interface com.oracle.bedrock.runtime.ApplicationListener<com.oracle.bedrock.runtime.Application>