hudson.scm

Class APISession

java.lang.Object

hudson.scm.APISession

public class APISession
extends Object

This class represents an Integration Point to a server. It also contains a Session object

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAJOR_VERSION
static int	MINOR_VERSION
static String	VERSION

Method Summary

Methods

Modifier and Type	Method and Description
static APISession	create(IntegrityConfigurable settings) Creates an authenticated API Session against the Integrity Server
String	getHostName() Returns the Integrity Hostname for this APISession
String	getIPHostName() Returns the Integrity Integration Point Hostname for this APISession
String	getIPPort() Returns the Integrity Integration Point Port for this APISession
String	getPort() Returns the Integrity Port for this APISession
String	getUserName() Returns the Integrity User for this APISession
void	refreshAPISession()
com.mks.api.response.Response	runCommand(com.mks.api.Command cmd) This function executes a generic API/CLI Command
com.mks.api.response.Response	runCommandAs(com.mks.api.Command cmd, String impersonateUser) This function executes a generic API/CLI Command impersonating another user
com.mks.api.response.Response	runCommandWithInterim(com.mks.api.Command cmd) This function executes a generic API/CLI Command with interim
void	Terminate() Terminate the API Session and Integration Point

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

MAJOR_VERSION

public static final int MAJOR_VERSION

See Also:

Constant Field Values

MINOR_VERSION

public static final int MINOR_VERSION

See Also:

Constant Field Values

Method Detail

create

public static APISession create(IntegrityConfigurable settings)

Creates an authenticated API Session against the Integrity Server

Returns:

An authenticated API Session

runCommand

public com.mks.api.response.Response runCommand(com.mks.api.Command cmd)
                                         throws com.mks.api.response.APIException

This function executes a generic API/CLI Command

Parameters:

cmd - Integrity API Command Object representing a CLI command

Returns:

Integrity API Response Object

Throws:

com.mks.api.response.APIException

runCommandWithInterim

public com.mks.api.response.Response runCommandWithInterim(com.mks.api.Command cmd)
                                                    throws com.mks.api.response.APIException

This function executes a generic API/CLI Command with interim

Parameters:

cmd - Integrity API Command Object representing a CLI command

Returns:

Integrity API Response Object

Throws:

com.mks.api.response.APIException

runCommandAs

public com.mks.api.response.Response runCommandAs(com.mks.api.Command cmd,
                                         String impersonateUser)
                                           throws com.mks.api.response.APIException

This function executes a generic API/CLI Command impersonating another user

Parameters:

cmd - Integrity API Command Object representing a CLI command

impersonateUser - The user to impersonate

Returns:

Integrity API Response Object

Throws:

com.mks.api.response.APIException

refreshAPISession

public void refreshAPISession()
                       throws com.mks.api.response.APIException

Throws:

com.mks.api.response.APIException

Terminate

public void Terminate()

Terminate the API Session and Integration Point

getIPHostName

public String getIPHostName()

Returns the Integrity Integration Point Hostname for this APISession

Returns:

getIPPort

public String getIPPort()

Returns the Integrity Integration Point Port for this APISession

Returns:

getHostName

public String getHostName()

Returns the Integrity Hostname for this APISession

Returns:

getPort

public String getPort()

Returns the Integrity Port for this APISession

Returns:

getUserName

public String getUserName()

Returns the Integrity User for this APISession

Returns: