Field Detail

• ADDRESS

  public static final ConfigKey<java.net.InetAddress> ADDRESS

• WINRM_CONFIG_PORT

  public static final ConfigKey<java.lang.Integer> WINRM_CONFIG_PORT

• OPERATION_TIMEOUT

  public static final ConfigKey<java.lang.String> OPERATION_TIMEOUT

• RETRIES_OF_NETWORK_FAILURES

  public static final ConfigKey<java.lang.Integer> RETRIES_OF_NETWORK_FAILURES

• USE_HTTPS_WINRM

  public static final ConfigKey<java.lang.Boolean> USE_HTTPS_WINRM

• USE_NTLM

  public static final ConfigKey<java.lang.Boolean> USE_NTLM

  Flag which tells winrm whether to use Basic Authentication or Negotiate plus NTLM. winrm.useNtlm parameter could be a subject to change. TODO Winrm supports several authentication mechanisms so it would be better to replace it with a prioritised list of authentication mechanisms to try.

• 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

• WINRM_TOOL_CLASS

  public static final ConfigKey<java.lang.String> WINRM_TOOL_CLASS

• WINRM_TOOL_CLASS_PROPERTIES_PREFIX

  public static final java.lang.String WINRM_TOOL_CLASS_PROPERTIES_PREFIX

  Prefix for config key:values to be passed to the winrm tool on construction. For example, one could define the location below. When executing winrm commands, it would instantiate an instance of com.acme.brooklyn.MyCustomWinrmTool, calling its constructor with a Map<String, Object> that contained the configuration. In this case, the map would include: address=1.2.3.4; user=myname; and myparam=myvalue.

   brooklyn.location.named.myLocation = byon:(hosts=1.2.3.4,user=myname)
   brooklyn.location.named.myLocation.winrmToolClass = com.acme.brooklyn.MyCustomWinrmTool
   brooklyn.location.named.myLocation.winrmToolClass.myparam = myvalue
   
   }
   

• EXECUTION_ATTEMPTS

  @Deprecated
  public static final ConfigKey<java.lang.Integer> EXECUTION_ATTEMPTS

  Deprecated. since 0.9.0; config never read; will be removed in future version.

• EXEC_TRIES

  public static final ConfigKey<java.lang.Integer> EXEC_TRIES

• PRIVATE_ADDRESSES

  public static final ConfigKey<java.lang.Iterable<java.lang.String>> PRIVATE_ADDRESSES

• TCP_PORT_MAPPINGS

  public static final ConfigKey<java.util.Map<java.lang.Integer,java.lang.String>> TCP_PORT_MAPPINGS

• ALL_WINRM_CONFIG_KEYS

  public static final java.util.Set<ConfigKey.HasConfigKey<?>> ALL_WINRM_CONFIG_KEYS

• ALL_WINRM_CONFIG_KEY_NAMES

  public static final java.util.Set<java.lang.String> ALL_WINRM_CONFIG_KEY_NAMES

Constructor Detail

• WinRmMachineLocation

  public WinRmMachineLocation()

Method Detail

• 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()

• 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

• getPort

  public int getPort()

• 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

  @Deprecated
  public WinRmToolResponse executeScript(java.lang.String script)

  Deprecated. since 0.9.0; use executeCommand(String)

• executeScript

  @Deprecated
  public WinRmToolResponse executeScript(java.util.List<java.lang.String> script)

  Deprecated. since 0.9.0; use executeCommand(List)

• executeScript

  @Deprecated
  public WinRmToolResponse executeScript(java.util.Map<?,?> props,
                                           java.util.List<java.lang.String> script)

  Deprecated. since 0.9.0; use executeCommand(Map, List)

• executeCommand

  public WinRmToolResponse executeCommand(java.lang.String script)

  Since:

  0.9.0 (previously was executeScript(String)

• executeCommand

  public WinRmToolResponse executeCommand(java.util.List<java.lang.String> script)

  Since:

  0.9.0 (previously was executeScript(List)

• executeCommand

  public WinRmToolResponse executeCommand(java.util.Map<?,?> props,
                                 java.util.List<java.lang.String> script)

  Since:

  0.9.0 (previously was executeScript(Map, List)

• executePsScript

  public WinRmToolResponse executePsScript(java.lang.String psScript)

• executePsScript

  public WinRmToolResponse executePsScript(java.util.List<java.lang.String> psScript)

• executePsScript

  public WinRmToolResponse executePsScript(java.util.Map<?,?> props,
                                  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)

• copyTo

  public int copyTo(java.util.Map<?,?> props,
           java.io.InputStream source,
           java.lang.String destination)

• getDefaultUserMetadataString

  public static java.lang.String getDefaultUserMetadataString(BrooklynObjectInternal.ConfigurationSupportInternal config)