WinRmMachineLocation (Apache Brooklyn)

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

All Implemented Interfaces:

BrooklynObject, BrooklynObjectInternal, Rebindable, Configurable, Identifiable, AddressableLocation, LocationInternal, HasHostGeoInfo, Location, MachineLocation, HasNetworkAddresses, java.io.Serializable

Direct Known Subclasses:

JcloudsWinRmMachineLocation
```
public class WinRmMachineLocation
extends AbstractLocation
implements MachineLocation
```
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
Modifier and Type	Field and Description
`static ConfigKey<java.net.InetAddress>`	`ADDRESS`
`static ConfigKey<java.lang.Integer>`	`COPY_FILE_CHUNK_SIZE_BYTES`
`static ConfigKey<java.lang.Integer>`	`EXEC_TRIES`
`static ConfigKey<java.lang.Integer>`	`EXECUTION_ATTEMPTS`
`static ConfigKey<java.lang.String>`	`PASSWORD`
`static ConfigKey<java.lang.String>`	`USER`
`static ConfigKey<java.lang.Integer>`	`WINRM_PORT`

Fields inherited from class brooklyn.location.basic.AbstractLocation
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

WinRmMachineLocation()

Constructors
Constructor and Description
`WinRmMachineLocation()`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`copyTo(java.io.File source, java.lang.String destination)`
`int`	`copyTo(java.io.InputStream source, java.lang.String destination)`
`io.cloudsoft.winrm4j.winrm.WinRmToolResponse`	`executePsScript(java.util.List<java.lang.String> psScript)`
`io.cloudsoft.winrm4j.winrm.WinRmToolResponse`	`executePsScript(java.lang.String psScript)`
`io.cloudsoft.winrm4j.winrm.WinRmToolResponse`	`executePsScriptNoRetry(java.util.List<java.lang.String> psScript)`
`io.cloudsoft.winrm4j.winrm.WinRmToolResponse`	`executeScript(java.util.List<java.lang.String> script)`
`io.cloudsoft.winrm4j.winrm.WinRmToolResponse`	`executeScript(java.lang.String script)`
`java.net.InetAddress`	`getAddress()` Return the single most appropriate address for this location.
`static java.lang.String`	`getDefaultUserMetadataString()`
`java.lang.String`	`getHostname()` note
`MachineDetails`	`getMachineDetails()`
`OsDetails`	`getOsDetails()`
`java.util.Set<java.lang.String>`	`getPrivateAddresses()` All private IP addresses.
`java.util.Set<java.lang.String>`	`getPublicAddresses()` All public IP addresses, potentially including shared ips.
`java.lang.String`	`getUser()`
`void`	`init()` Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.

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, 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

- Field Detail
  - WINRM_PORT
```
public static final ConfigKey<java.lang.Integer> WINRM_PORT
```
  - USER
```
public static final ConfigKey<java.lang.String> USER
```
  - PASSWORD
```
public static final ConfigKey<java.lang.String> PASSWORD
```
  - COPY_FILE_CHUNK_SIZE_BYTES
```
public static final ConfigKey<java.lang.Integer> COPY_FILE_CHUNK_SIZE_BYTES
```
  - ADDRESS
```
public static final ConfigKey<java.net.InetAddress> ADDRESS
```
  - EXECUTION_ATTEMPTS
```
public static final ConfigKey<java.lang.Integer> EXECUTION_ATTEMPTS
```
  - EXEC_TRIES
```
public static final ConfigKey<java.lang.Integer> EXEC_TRIES
```
- Constructor Detail
  - WinRmMachineLocation
```
public WinRmMachineLocation()
```
- Method Detail
  - getAddress
```
public java.net.InetAddress getAddress()
```
    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.
  - getOsDetails
```
public OsDetails getOsDetails()
```
    Specified by:
    
    getOsDetails in interface MachineLocation
  - getMachineDetails
```
public MachineDetails getMachineDetails()
```
    Specified by:
    
    getMachineDetails in interface MachineLocation
  - getHostname
```
@Nullable
public java.lang.String getHostname()
```
    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()
```
    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()
```
    Description copied from interface: HasNetworkAddresses
    
    All private IP addresses.
    
    Specified by:
    
    getPrivateAddresses in interface HasNetworkAddresses
  - executeScript
```
public io.cloudsoft.winrm4j.winrm.WinRmToolResponse executeScript(java.lang.String script)
```
  - executeScript
```
public io.cloudsoft.winrm4j.winrm.WinRmToolResponse executeScript(java.util.List<java.lang.String> script)
```
  - executePsScript
```
public io.cloudsoft.winrm4j.winrm.WinRmToolResponse executePsScript(java.lang.String psScript)
```
  - executePsScript
```
public io.cloudsoft.winrm4j.winrm.WinRmToolResponse executePsScript(java.util.List<java.lang.String> psScript)
```
  - executePsScriptNoRetry
```
public io.cloudsoft.winrm4j.winrm.WinRmToolResponse executePsScriptNoRetry(java.util.List<java.lang.String> psScript)
```
  - copyTo
```
public int copyTo(java.io.File source,
         java.lang.String destination)
```
  - copyTo
```
public int copyTo(java.io.InputStream source,
         java.lang.String destination)
```
  - init
```
public void init()
```
    Description copied from class: AbstractBrooklynObject
    Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.
    To preserve backwards compatibility for if the instance is constructed directly, one can call the code below, but that means it will be called after references to this policy have been shared with other entities.
```
 if (isLegacyConstruction()) {
     init();
 }
 
 
```
    Overrides:
    
    init in class AbstractBrooklynObject
  - getUser
```
public java.lang.String getUser()
```
  - getDefaultUserMetadataString
```
public static java.lang.String getDefaultUserMetadataString()
```

Class WinRmMachineLocation

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

Field Detail

WINRM_PORT

USER

PASSWORD

COPY_FILE_CHUNK_SIZE_BYTES

ADDRESS

EXECUTION_ATTEMPTS

EXEC_TRIES

Constructor Detail

WinRmMachineLocation

Method Detail

getAddress

getOsDetails

getMachineDetails

getHostname

note

getPublicAddresses

getPrivateAddresses

executeScript

executeScript

executePsScript

executePsScript

executePsScriptNoRetry

copyTo

copyTo

init

getUser

getDefaultUserMetadataString