Module com.oracle.bedrock.runtime.docker

Package com.oracle.bedrock.runtime.docker.options

Class DockerDefaultBaseImages

java.lang.Object

com.oracle.bedrock.runtime.docker.options.DockerDefaultBaseImages

All Implemented Interfaces:

com.oracle.bedrock.Option

public class DockerDefaultBaseImages
extends Object
implements com.oracle.bedrock.Option

A representation of a class hierarchy that maps Application Classes to Docker base images.

Note: instances of DockerDefaultBaseImages are immutable so calls to the with(Class, String) method return a new instance of DockerDefaultBaseImages that is a copy of the original instance with the addition applied.

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

Author:

Jonathan Knight

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.bedrock.Option

com.oracle.bedrock.Option.Collectable, com.oracle.bedrock.Option.Collector<C extends com.oracle.bedrock.Option.Collectable,T extends com.oracle.bedrock.Option.Collector<C,T>>

Constructor Summary

Constructors

Constructor	Description
DockerDefaultBaseImages(Class<? extends com.oracle.bedrock.runtime.Application> applicationClass, String baseImageName)	Create a DockerDefaultBaseImages with the specified root application class and base image name to be used for that class.

Method Summary

Modifier and Type	Method	Description
static DockerDefaultBaseImages	defaultImages()	Obtain the default DockerDefaultBaseImages that is used to determine the base images for application classes if no specific overrides have been specified.
Class<? extends com.oracle.bedrock.runtime.Application>	getApplicationClass()	Obtain the root application Class for this DockerDefaultBaseImages.
String	getBaseImage(Class<? extends com.oracle.bedrock.runtime.Application> applicationClass)	Obtain the base image to use for the given Class.
DockerDefaultBaseImages	with(Class<? extends com.oracle.bedrock.runtime.Application> applicationClass, String baseImageName)	Add a DockerDefaultBaseImages to this tree.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockerDefaultBaseImages

public DockerDefaultBaseImages(Class<? extends com.oracle.bedrock.runtime.Application> applicationClass,
                               String baseImageName)

Create a DockerDefaultBaseImages with the specified root application class and base image name to be used for that class.

Parameters:

applicationClass - the application class

baseImageName - the base image to use for classes

Method Detail

getApplicationClass

public Class<? extends com.oracle.bedrock.runtime.Application> getApplicationClass()

Obtain the root application Class for this DockerDefaultBaseImages.

Returns:

the root application Class for this DockerDefaultBaseImages

with

public DockerDefaultBaseImages with(Class<? extends com.oracle.bedrock.runtime.Application> applicationClass,
                                    String baseImageName)

Add a DockerDefaultBaseImages to this tree.

The base image being added should have a root class that is a sub-class of this DockerDefaultBaseImages's root class.

Parameters:

applicationClass - the application class

baseImageName - the base image to use for classes

Returns:

a DockerDefaultBaseImages

getBaseImage

public String getBaseImage(Class<? extends com.oracle.bedrock.runtime.Application> applicationClass)

Obtain the base image to use for the given Class.

Parameters:

applicationClass - the Class to find the base image for

Returns:

the base image to use for the specified class or null if the specified class is not the same as or a sub class of the root class of this tree

defaultImages

public static DockerDefaultBaseImages defaultImages()

Obtain the default DockerDefaultBaseImages that is used to determine the base images for application classes if no specific overrides have been specified.

Returns:

the default DockerDefaultBaseImages