hudson.cli
Interface CliEntryPoint

All Known Implementing Classes:

CliManagerImpl

public interface CliEntryPoint

Remotable interface for CLI entry point on the server side.

Author:

Kohsuke Kawaguchi

Field Summary

static int

VERSION

Method Summary

void	authenticate(String protocol, hudson.remoting.Pipe c2s, hudson.remoting.Pipe s2c) Initiates authentication out of band.
boolean	hasCommand(String name) Does the named command exist?
int	main(List<String> args, Locale locale, InputStream stdin, OutputStream stdout, OutputStream stderr) Just like the static main method.
int	protocolVersion() Returns VERSION, so that the client and the server can detect version incompatibility gracefully.

Field Detail

VERSION

static final int VERSION

See Also:

Constant Field Values

Method Detail

main

int main(List<String> args,
         Locale locale,
         InputStream stdin,
         OutputStream stdout,
         OutputStream stderr)

Just like the static main method.

Parameters:

locale - Locale of this client.

hasCommand

boolean hasCommand(String name)

Does the named command exist?

protocolVersion

int protocolVersion()

Returns VERSION, so that the client and the server can detect version incompatibility gracefully.

authenticate

void authenticate(String protocol,
                  hudson.remoting.Pipe c2s,
                  hudson.remoting.Pipe s2c)

Initiates authentication out of band.

This method starts two-way byte channel that allows the client and the server to perform authentication. The current supported implementation is based on SSH public key authentication that mutually authenticates clients and servers.

Parameters:

protocol - Currently only "ssh" is supported.

Throws:

UnsupportedOperationException - If the specified protocol is not supported by the server.