SshjClientConnection (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

brooklyn.util.internal.ssh
[Java] Class SshjClientConnection

java.lang.Object
  brooklyn.util.internal.ssh.SshjClientConnection

All Implemented Interfaces:: SshAction

public class SshjClientConnection

Licensed to jclouds, Inc. (jclouds) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. jclouds licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Nested Class Summary
`static class`	`SshjClientConnection.Builder`

Method Summary
`static SshjClientConnection.Builder`	`builder()`
`void`	`clear()`
`SSHClient`	`create()`
`boolean`	`equals(java.lang.Object o)`
`int`	`getConnectTimeout()` @return how long to wait for the initial connection to be made
`HostAndPort`	`getHostAndPort()` @return host and port, where port if not present defaults to `22`
`SSHClient`	`getSSHClient()` @return the current ssh or `null` if not connected
`int`	`getSessionTimeout()` @return how long to keep the ssh open, or `0` for indefinitely
`java.lang.String`	`getUsername()` @return username used in this ssh
`int`	`hashCode()`
`boolean`	`isConnected()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()

Method Detail

builder

public static SshjClientConnection.Builder builder()

clear

@Override
public void clear()

create

@Override
public SSHClient create()

equals

@Override
public boolean equals(java.lang.Object o)

getConnectTimeout

public int getConnectTimeout()

Returns:: how long to wait for the initial connection to be made

getHostAndPort

public HostAndPort getHostAndPort()

Returns:: host and port, where port if not present defaults to 22

getSSHClient

public SSHClient getSSHClient()

Returns:: the current ssh or null if not connected

getSessionTimeout

public int getSessionTimeout()

Returns:: how long to keep the ssh open, or 0 for indefinitely

getUsername

public java.lang.String getUsername()

Returns:: username used in this ssh

hashCode

@Override
public int hashCode()

isConnected

public boolean isConnected()

toString

@Override
public java.lang.String toString()

brooklyn.util.internal.ssh [Java] Class SshjClientConnection