Field Detail

• IGNORE_ENTITY_SSH_FLAGS

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

Constructor Detail

• SshEffectorTasks

  public SshEffectorTasks()

Method Detail

• ssh

  public static SshEffectorTasks.SshEffectorTaskFactory<java.lang.Integer> ssh(java.lang.String... commands)

• ssh

  public static SshEffectorTasks.SshEffectorTaskFactory<java.lang.Integer> ssh(java.util.List<java.lang.String> commands)

• put

  public static SshPutTaskFactory put(java.lang.String remoteFile)

• fetch

  public static SshEffectorTasks.SshFetchEffectorTaskFactory fetch(java.lang.String remoteFile)

• codePidRunning

  public static SshEffectorTasks.SshEffectorTaskFactory<java.lang.Integer> codePidRunning(java.lang.Integer pid)

  task which returns 0 if pid is running

• requirePidRunning

  public static SshEffectorTasks.SshEffectorTaskFactory<?> requirePidRunning(java.lang.Integer pid)

  task which fails if the given PID is not running

• isPidRunning

  public static SshEffectorTasks.SshEffectorTaskFactory<java.lang.Boolean> isPidRunning(java.lang.Integer pid)

  as codePidRunning(Integer) but returning boolean

• codePidFromFileRunning

  public static SshEffectorTasks.SshEffectorTaskFactory<java.lang.Integer> codePidFromFileRunning(java.lang.String pidFile)

  task which returns 0 if pid in the given file is running; method accepts wildcards so long as they match a single file on the remote end

  returns 1 if no matching file, 1 if matching file but no matching process, and 2 if 2+ matching files

• requirePidFromFileRunning

  public static SshEffectorTasks.SshEffectorTaskFactory<?> requirePidFromFileRunning(java.lang.String pidFile)

  task which fails if the pid in the given file is not running (or if there is no such PID file); method accepts wildcards so long as they match a single file on the remote end (fails if 0 or 2+ matching files)

• isPidFromFileRunning

  public static SshEffectorTasks.SshEffectorTaskFactory<java.lang.Boolean> isPidFromFileRunning(java.lang.String pidFile)

  as codePidFromFileRunning(String) but returning boolean

• getSshFlags

  @Beta
  public static java.util.Map<java.lang.String,java.lang.Object> getSshFlags(Entity entity,
                                                                  Location optionalLocation)

  extracts the values for the main brooklyn.ssh.config.* config keys (i.e. those declared in ConfigKeys) as declared on the entity, and inserts them in a map using the unprefixed state, for ssh.

  currently this is computed for each call, which may be wasteful, but it is reliable in the face of config changes. we could cache the Map. note that we do _not_ cache (or even own) the SshTool; the SshTool is created or re-used by the SshMachineLocation making use of these properties