com.oracle.bedrock.runtime.virtual.vagrant

Class VagrantPlatform

java.lang.Object

com.oracle.bedrock.extensible.AbstractExtensible

com.oracle.bedrock.runtime.AbstractPlatform

com.oracle.bedrock.runtime.remote.RemotePlatform

com.oracle.bedrock.runtime.virtual.VirtualPlatform

com.oracle.bedrock.runtime.virtual.vagrant.VagrantPlatform

All Implemented Interfaces:

com.oracle.bedrock.extensible.Extensible, com.oracle.bedrock.runtime.Infrastructure, com.oracle.bedrock.runtime.Platform, Closeable, AutoCloseable

public class VagrantPlatform
extends VirtualPlatform

A Platform implementation that represents an O/S running in a virtual machine managed by the Vagrant.

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

Author:

Jonathan Knight

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_VAGRANT_COMMAND The default command used to run the Vagrant command line interface.

Fields inherited from class com.oracle.bedrock.runtime.remote.RemotePlatform

address, authentication, DEFAULT_PORT, port, userName

Constructor Summary

Constructors

Constructor and Description
VagrantPlatform(String name, VagrantFileBuilder builder, int port, com.oracle.bedrock.Option... options) Construct a new VagrantPlatform.
VagrantPlatform(String name, VagrantFileBuilder builder, com.oracle.bedrock.Option... options) Construct a new VagrantPlatform.

Method Summary

Modifier and Type	Method and Description
void	close()
void	close(com.oracle.bedrock.Option... closeOptions)
protected Properties	detectSSH() Detect the SSH settings for the NAT port forwarding that Vagrant has configured on the VM and set them into this VagrantPlatform.
protected void	execute(com.oracle.bedrock.OptionsByType optionsByType) Execute the application defined by the specified OptionsByType.
protected com.oracle.bedrock.OptionsByType	getDefaultOptions() Options the default OptionsByType to use when launching Vagrant.
static String	getDefaultVagrantCommand() Get the default Vagrant command to use to execute the Vagrant CLI commands.
String	getPublicHostName() Obtain the host name of the public network interface on the VM
String	getVagrantCommand() Obtain the command used to run the Vagrant command line interface.
File	getWorkingDirectory() Obtain the location of this VagrantPlatform's VagrantFile.
void	setVagrantCommand(String vagrantCommand) Set the command used to run the Vagrant command line interface.
void	start() Start this VagrantPlatform.

Methods inherited from class com.oracle.bedrock.runtime.remote.RemotePlatform

getAddress, getApplicationLauncher, getAuthentication, getOperatingSystem, getPort, getUserName

Methods inherited from class com.oracle.bedrock.runtime.AbstractPlatform

getName, getOptions, launch

Methods inherited from class com.oracle.bedrock.extensible.AbstractExtensible

add, add, get, getInstancesOf, has, remove, removeAllFeatures

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bedrock.runtime.Platform

any, getPlatform, is, launch, launch, named

Methods inherited from interface com.oracle.bedrock.runtime.Infrastructure

local, of, using

Field Detail

DEFAULT_VAGRANT_COMMAND

public static final String DEFAULT_VAGRANT_COMMAND

The default command used to run the Vagrant command line interface.

See Also:

Constant Field Values

Constructor Detail

VagrantPlatform

public VagrantPlatform(String name,
                       VagrantFileBuilder builder,
                       com.oracle.bedrock.Option... options)

Construct a new VagrantPlatform.

Parameters:

name - the name of this VagrantPlatform

builder - the VagrantFileBuilder to use to build the Vagranfile for the VM

options - the Options for the VagrantPlatform

VagrantPlatform

public VagrantPlatform(String name,
                       VagrantFileBuilder builder,
                       int port,
                       com.oracle.bedrock.Option... options)

Construct a new VagrantPlatform.

Parameters:

name - the name of this VagrantPlatform

builder - the VagrantFileBuilder to use to build the Vagrantfile for the VM

port - the remote port that will be used to SSH into this VirtualPlatform

options - the Options for the VagrantPlatform

Method Detail

getVagrantCommand

public String getVagrantCommand()

Obtain the command used to run the Vagrant command line interface.

Returns:

the command used to run the Vagrant command line interface

setVagrantCommand

public void setVagrantCommand(String vagrantCommand)

Set the command used to run the Vagrant command line interface.

Parameters:

vagrantCommand - the command used to run the Vagrant command line interface

getWorkingDirectory

public File getWorkingDirectory()

Obtain the location of this VagrantPlatform's VagrantFile.

Returns:

the location of this VagrantPlatform's VagrantFile

getPublicHostName

public String getPublicHostName()

Obtain the host name of the public network interface on the VM

Returns:

the host name of the public network interface on the VM

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class VirtualPlatform

Throws:

IOException

close

public void close(com.oracle.bedrock.Option... closeOptions)
           throws IOException

Specified by:

close in class VirtualPlatform

Throws:

IOException

start

public void start()

Start this VagrantPlatform. When this method returns the virtual machine this VagrantPlatform represents will be in a running state.

detectSSH

protected Properties detectSSH()

Detect the SSH settings for the NAT port forwarding that Vagrant has configured on the VM and set them into this VagrantPlatform.

Returns:

the SSH properties configured by Vagrant

execute

protected void execute(com.oracle.bedrock.OptionsByType optionsByType)

Execute the application defined by the specified OptionsByType.

Parameters:

optionsByType - the OptionsByType

getDefaultOptions

protected com.oracle.bedrock.OptionsByType getDefaultOptions()

Options the default OptionsByType to use when launching Vagrant.

Returns:

the default OptionsByType

getDefaultVagrantCommand

public static String getDefaultVagrantCommand()

Get the default Vagrant command to use to execute the Vagrant CLI commands.

Returns:

the default Vagrant command