org.jenkinsci.main.modules.sshd

Class SSHD

java.lang.Object

hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

jenkins.model.GlobalConfiguration

org.jenkinsci.main.modules.sshd.SSHD

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<jenkins.model.GlobalConfiguration>, hudson.model.Saveable

@Extension
public class SSHD
extends jenkins.model.GlobalConfiguration

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	IDLE_TIMEOUT_KEY Key used to retrieve the value of idle timeout after which the server will close the connection.

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
SSHD()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
static SSHD	get()
int	getActualPort() Gets the current TCP/IP port that this daemon is running with.
jenkins.model.GlobalConfigurationCategory	getCategory()
int	getPort() Returns the configured port to run SSHD.
static void	init()
void	restart()
void	setPort(int port)
void	start()
void	stop()

Methods inherited from class jenkins.model.GlobalConfiguration

all, getDescriptor, getDisplayName, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IDLE_TIMEOUT_KEY

public static final String IDLE_TIMEOUT_KEY

Key used to retrieve the value of idle timeout after which the server will close the connection. In milliseconds.

See Also:

Constant Field Values

Constructor Detail

SSHD

public SSHD()

Method Detail

getCategory

public jenkins.model.GlobalConfigurationCategory getCategory()

Overrides:

getCategory in class jenkins.model.GlobalConfiguration

getPort

public int getPort()

Returns the configured port to run SSHD.

Returns:

-1 to disable this, 0 to run with a random port, otherwise the port number.

getActualPort

public int getActualPort()

Gets the current TCP/IP port that this daemon is running with.

Returns:

-1 if disabled, but never null.

setPort

public void setPort(int port)

start

public void start()
           throws IOException,
                  InterruptedException

Throws:

IOException

InterruptedException

restart

public void restart()

stop

public void stop()
          throws InterruptedException

Throws:

InterruptedException

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                net.sf.json.JSONObject json)
                  throws hudson.model.Descriptor.FormException

Overrides:

configure in class hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

Throws:

hudson.model.Descriptor.FormException

get

public static SSHD get()

init

@Initializer(after=JOB_LOADED,
             fatal=false)
public static void init()
                 throws IOException,
                        InterruptedException

Throws:

IOException

InterruptedException