SimulatedLocation (Apache Brooklyn)

java.lang.Object
- brooklyn.basic.AbstractBrooklynObject
- - brooklyn.location.basic.AbstractLocation
  - - brooklyn.location.basic.SimulatedLocation

All Implemented Interfaces:

BrooklynObject, BrooklynObjectInternal, Rebindable, Configurable, Identifiable, AddressableLocation, LocationInternal, HasHostGeoInfo, Location, MachineLocation, MachineProvisioningLocation<MachineLocation>, PortSupplier, ProvisioningLocation<MachineLocation>, HasNetworkAddresses, java.io.Serializable

Deprecated.
since 0.7.0; will be moved to src/test/java
```
public class SimulatedLocation
extends AbstractLocation
implements MachineProvisioningLocation<MachineLocation>, MachineLocation, PortSupplier
```
Location for use in dev/test, defining custom start/stop support, and/or tweaking the ports which are permitted to be available (using setPermittedPorts(Iterable))

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject
  BrooklynObject.TagSupport
- Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable
  Configurable.ConfigurationSupport
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal
  BrooklynObjectInternal.ConfigurationSupportInternal

Field Summary
- Fields inherited from class brooklyn.location.basic.AbstractLocation
  LOG, PARENT_LOCATION, TEMPORARY_LOCATION
- Fields inherited from interface brooklyn.location.basic.LocationInternal
  FINAL_SPEC, NAMED_SPEC_NAME, ORIGINAL_SPEC

Constructor Summary

Constructors
Constructor and Description

SimulatedLocation()
Deprecated.

SimulatedLocation(java.util.Map<java.lang.String,? extends java.lang.Object> flags)
Deprecated.

Constructors
Constructor and Description
`SimulatedLocation()` Deprecated.
`SimulatedLocation(java.util.Map<java.lang.String,? extends java.lang.Object> flags)` Deprecated.

Method Summary

Methods
Modifier and Type	Method and Description
`java.net.InetAddress`	`getAddress()` Deprecated. Return the single most appropriate address for this location.
`java.lang.String`	`getHostname()` Deprecated. note
`MachineDetails`	`getMachineDetails()` Deprecated.
`OsDetails`	`getOsDetails()` Deprecated.
`java.util.Set<java.lang.String>`	`getPrivateAddresses()` Deprecated. All private IP addresses.
`java.util.Map<java.lang.String,java.lang.Object>`	`getProvisioningFlags(java.util.Collection<java.lang.String> tags)` Deprecated. Gets flags, suitable as an argument to `MachineProvisioningLocation.obtain(Map)`.
`java.util.Set<java.lang.String>`	`getPublicAddresses()` Deprecated. All public IP addresses, potentially including shared ips.
`SimulatedLocation`	`newSubLocation(java.util.Map<?,?> newFlags)` Deprecated. Creates a new location of the same type, but with additional creation instructions in the form of flags, e.g.
`MachineLocation`	`obtain(java.util.Map<?,?> flags)` Deprecated. Obtain a machine in this location.
`int`	`obtainPort(PortRange range)` Deprecated. Reserve a port for your application, with a port number in a specific range.
`boolean`	`obtainSpecificPort(int portNumber)` Deprecated. Reserve a specific port for an application.
`void`	`release(MachineLocation machine)` Deprecated. Release a previously-obtained machine.
`void`	`releasePort(int portNumber)` Deprecated. Release a previously reserved port.
`void`	`setPermittedPorts(java.lang.Iterable<java.lang.Integer> ports)` Deprecated.

Methods inherited from class brooklyn.location.basic.AbstractLocation
addChild, addExtension, config, configure, containsLocation, equals, getAllConfig, getAllConfigBag, getChildren, getConfig, getConfig, getDisplayName, getExtension, getHostGeoInfo, getLocalConfigBag, getParent, getRawLocalConfigBag, getRebindSupport, hasConfig, hasExtension, hashCode, isManaged, onManagementStarted, onManagementStopped, removeChild, setConfig, setDisplayName, setHostGeoInfo, setManagementContext, setName, setParent, setParent, toMetadataRecord, toString, toVerboseString

Methods inherited from class brooklyn.basic.AbstractBrooklynObject
getCatalogItemId, getId, getManagementContext, getTagSupport, init, rebind, setCatalogItemId, tags

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface brooklyn.location.Location
containsLocation, getAllConfig, getChildren, getConfig, getConfig, getDisplayName, getExtension, getId, getParent, hasConfig, hasExtension, setParent, toVerboseString

Methods inherited from interface brooklyn.basic.BrooklynObject
getCatalogItemId, getTagSupport, tags

Methods inherited from interface brooklyn.entity.trait.Configurable
config, setConfig

Methods inherited from interface brooklyn.location.basic.LocationInternal
getManagementContext

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal
setCatalogItemId

- Constructor Detail
  - SimulatedLocation
```
public SimulatedLocation()
```
    Deprecated.
  - SimulatedLocation
```
public SimulatedLocation(java.util.Map<java.lang.String,? extends java.lang.Object> flags)
```
    Deprecated.
- Method Detail
  - newSubLocation
```
public SimulatedLocation newSubLocation(java.util.Map<?,?> newFlags)
```
    Deprecated.
    
    Description copied from interface: MachineProvisioningLocation
    
    Creates a new location of the same type, but with additional creation instructions in the form of flags, e.g. for specifying subnets, security groups, etc
    Implementers who wish to subclass this provisioning location for additional functionality in a specific cloud can use the relevant implementation of this method as a guide.
    
    Specified by:
    
    newSubLocation in interface MachineProvisioningLocation<MachineLocation>
  - obtain
```
public MachineLocation obtain(java.util.Map<?,?> flags)
```
    Deprecated.
    
    Description copied from interface: MachineProvisioningLocation
    
    Obtain a machine in this location.
    
    Specified by:
    
    obtain in interface MachineProvisioningLocation<MachineLocation>
    
    Specified by:
    
    obtain in interface ProvisioningLocation<MachineLocation>
    
    Parameters:
    flags - Details of the desired machine (e.g. image, size, open ports, etc; some flag support is limited to selected providers). "callerContext" can be specified to have custom logging and error messages (useful if starting machines in parallel)
    
    Returns:
    a machine that is a child of this location.
  - release
```
public void release(MachineLocation machine)
```
    Deprecated.
    
    Description copied from interface: MachineProvisioningLocation
    
    Release a previously-obtained machine.
    
    Specified by:
    
    release in interface MachineProvisioningLocation<MachineLocation>
    
    Specified by:
    
    release in interface ProvisioningLocation<MachineLocation>
    
    Parameters:
    machine - a MachineLocation previously obtained from a call to #obtain()
  - getProvisioningFlags
```
public java.util.Map<java.lang.String,java.lang.Object> getProvisioningFlags(java.util.Collection<java.lang.String> tags)
```
    Deprecated.
    
    Description copied from interface: MachineProvisioningLocation
    
    Gets flags, suitable as an argument to MachineProvisioningLocation.obtain(Map). The tags provided give hints about the machine required. The provisioning-location could be configured to understand those tags. For example, an AWS-location could be configured to understand that a particular entity type (e.g. "TomcatServer") requires a particular AMI in that region, so would return the required image id.
    
    Specified by:
    
    getProvisioningFlags in interface MachineProvisioningLocation<MachineLocation>
    
    Returns:
  - getAddress
```
public java.net.InetAddress getAddress()
```
    Deprecated.
    
    Description copied from interface: AddressableLocation
    
    Return the single most appropriate address for this location. (An implementation or sub-interface definition may supply more information on the precise semantics of the address.) Should not return null, but in some "special cases" (e.g. CloudFoundryLocation it may return null if the location is not configured correctly). Users should expect a non-null result and treat null as a programming error or misconfiguration. Implementors of this interface should strive to not return null (and then we'll remove this caveat from the javadoc!).
    
    Specified by:
    
    getAddress in interface AddressableLocation
    
    Specified by:
    
    getAddress in interface MachineLocation
    
    Returns:
    the machine's network address.
  - getHostname
```
public java.lang.String getHostname()
```
    Deprecated.
    
    Description copied from interface: HasNetworkAddresses
    
    note
    hostname is something that is set in the operating system. This value may or may not be set in DNS.
    
    Specified by:
    
    getHostname in interface HasNetworkAddresses
    
    Returns:
    hostname of the node, or null if unknown
  - getPublicAddresses
```
public java.util.Set<java.lang.String> getPublicAddresses()
```
    Deprecated.
    
    Description copied from interface: HasNetworkAddresses
    
    All public IP addresses, potentially including shared ips.
    
    Specified by:
    
    getPublicAddresses in interface HasNetworkAddresses
  - getPrivateAddresses
```
public java.util.Set<java.lang.String> getPrivateAddresses()
```
    Deprecated.
    
    Description copied from interface: HasNetworkAddresses
    
    All private IP addresses.
    
    Specified by:
    
    getPrivateAddresses in interface HasNetworkAddresses
  - obtainSpecificPort
```
public boolean obtainSpecificPort(int portNumber)
```
    Deprecated.
    
    Description copied from interface: PortSupplier
    
    Reserve a specific port for an application. If your application requires a specific port - for example, port 80 for a web server - you should reserve this port before starting your application. Using this method, you will be able to detect if another application has already claimed this port number.
    
    Specified by:
    
    obtainSpecificPort in interface PortSupplier
    
    Parameters:
    portNumber - the required port number.
    
    Returns:
    true if the port was successfully reserved; false if it has been previously reserved.
  - obtainPort
```
public int obtainPort(PortRange range)
```
    Deprecated.
    
    Description copied from interface: PortSupplier
    
    Reserve a port for your application, with a port number in a specific range. If your application requires a port, but it does not mind exactly which port number - for example, a port for internal JMX monitoring - call this method.
    
    Specified by:
    
    obtainPort in interface PortSupplier
    
    Parameters:
    range - the range of acceptable port numbers.
    
    Returns:
    the port number that has been reserved, or -1 if there was no available port in the acceptable range.
  - releasePort
```
public void releasePort(int portNumber)
```
    Deprecated.
    
    Description copied from interface: PortSupplier
    
    Release a previously reserved port.
    
    Specified by:
    
    releasePort in interface PortSupplier
    
    Parameters:
    portNumber - the port number from a call to PortSupplier.obtainPort(PortRange) or PortSupplier.obtainSpecificPort(int)
  - setPermittedPorts
```
public void setPermittedPorts(java.lang.Iterable<java.lang.Integer> ports)
```
    Deprecated.
  - getOsDetails
```
public OsDetails getOsDetails()
```
    Deprecated.
    
    Specified by:
    
    getOsDetails in interface MachineLocation
  - getMachineDetails
```
public MachineDetails getMachineDetails()
```
    Deprecated.
    
    Specified by:
    
    getMachineDetails in interface MachineLocation

Class SimulatedLocation

Nested Class Summary

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject

Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal

Field Summary

Fields inherited from class brooklyn.location.basic.AbstractLocation

Fields inherited from interface brooklyn.location.basic.LocationInternal

Constructor Summary

Method Summary

Methods inherited from class brooklyn.location.basic.AbstractLocation

Methods inherited from class brooklyn.basic.AbstractBrooklynObject

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.location.Location

Methods inherited from interface brooklyn.basic.BrooklynObject

Methods inherited from interface brooklyn.entity.trait.Configurable

Methods inherited from interface brooklyn.location.basic.LocationInternal

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal

Constructor Detail

SimulatedLocation

SimulatedLocation

Method Detail

newSubLocation

obtain

release

getProvisioningFlags

getAddress

getHostname

note

getPublicAddresses

getPrivateAddresses

obtainSpecificPort

obtainPort

releasePort

setPermittedPorts

getOsDetails

getMachineDetails