com.oracle.bedrock.runtime.virtual.vagrant.options

Class HostOnlyNetwork

java.lang.Object

com.oracle.bedrock.runtime.virtual.vagrant.options.AbstractNetwork

com.oracle.bedrock.runtime.virtual.vagrant.options.HostOnlyNetwork

All Implemented Interfaces:

com.oracle.bedrock.Option, com.oracle.bedrock.Option.Collectable, Network

public class HostOnlyNetwork
extends AbstractNetwork

An Option to specify a HostOnlyNetwork for a VagrantPlatform.

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

Author:

Brian Oliver

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 and Description
HostOnlyNetwork(String id, String macAddress, Iterator<String> addresses) Constructs a HostOnlyNetwork.

Method Summary

Modifier and Type	Method and Description
static HostOnlyNetwork	dhcp() Create a HostOnlyNetwork that will create a Vagrant private network that will use DHCP to obtain an IP address.
static HostOnlyNetwork	from(Iterator<String> addresses) Create a HostOnlyNetwork that will create a Vagrant private network with the specified address.
boolean	isPublic() Determines if the Network is visible outside of the Virtual Machine represented by the VagrantPlatform.
static HostOnlyNetwork	of(String address) Create a HostOnlyNetwork that will create a Vagrant private network with the specified address.
static HostOnlyNetwork	startingAt(String startingAddress) Create a HostOnlyNetwork that will create a Vagrant private network with the specified address.
HostOnlyNetwork	withMacAddress(String macAddress) Obtain a new HostOnlyNetwork option that is a copy of this HostOnlyNetwork with the addition of the specified MAC address.
Optional<com.oracle.bedrock.runtime.remote.options.HostName>	write(PrintWriter writer, String prefix, String padding) Write the configuration of the network to the vagrantFile

Methods inherited from class com.oracle.bedrock.runtime.virtual.vagrant.options.AbstractNetwork

getId, getMacAddress

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.virtual.vagrant.options.Network

getCollectorClass

Constructor Detail

HostOnlyNetwork

public HostOnlyNetwork(String id,
                       String macAddress,
                       Iterator<String> addresses)

Constructs a HostOnlyNetwork.

Parameters:

id - the network identifier

macAddress - the mac address

addresses - the addresses

Method Detail

isPublic

public boolean isPublic()

Description copied from interface: Network

Determines if the Network is visible outside of the Virtual Machine represented by the VagrantPlatform.

Returns:

true if the Network is visible outside fo the VagrantPlatform, false otherwise

withMacAddress

public HostOnlyNetwork withMacAddress(String macAddress)

Obtain a new HostOnlyNetwork option that is a copy of this HostOnlyNetwork with the addition of the specified MAC address.

Parameters:

macAddress - that MAC address to apply.

Returns:

a new HostOnlyNetwork option that is a copy of this HostOnlyNetwork with the addition of the specified MAC address

write

public Optional<com.oracle.bedrock.runtime.remote.options.HostName> write(PrintWriter writer,
                                                                          String prefix,
                                                                          String padding)

Write the configuration of the network to the vagrantFile

Parameters:

writer - the PrintWriter being used to write the vagrantFile

prefix - the prefix of the VM name

padding - the padding to prefix to any lines written to the vagrantFile

Returns:

the HostName of the network interface just created if applicable

dhcp

public static HostOnlyNetwork dhcp()

Create a HostOnlyNetwork that will create a Vagrant private network that will use DHCP to obtain an IP address.

Returns:

a HostOnlyNetwork that will create a Vagrant private network that will use DHCP to obtain an IP address

of

public static HostOnlyNetwork of(String address)

Create a HostOnlyNetwork that will create a Vagrant private network with the specified address.

Parameters:

address - the IP address to use

Returns:

a HostOnlyNetwork that will create a Vagrant private network with the specified address

from

public static HostOnlyNetwork from(Iterator<String> addresses)

Create a HostOnlyNetwork that will create a Vagrant private network with the specified address.

Parameters:

addresses - the Iterator to use to provide IP addresses

Returns:

a HostOnlyNetwork that will create a Vagrant private network with the specified address

startingAt

public static HostOnlyNetwork startingAt(String startingAddress)

Create a HostOnlyNetwork that will create a Vagrant private network with the specified address.

Parameters:

startingAddress - the starting address to use to allocate IP addresses

Returns:

a HostOnlyNetwork that will create a Vagrant private network with the specified address