com.citrix.sdx.nitro.service

Class nitro_service

java.lang.Object

com.citrix.sdx.nitro.service.nitro_service

public class nitro_service
extends Object

nitro_service is client interface through which Nitro operations are performed on resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	nitro_service.OnerrorEnum

Constructor Summary

Constructors

Constructor and Description
nitro_service(String ip) nitro_service class constructor specifying ip.
nitro_service(String ip, ipayload_formatter format) nitro_service class constructor specifying ip and format.
nitro_service(String ip, ipayload_formatter format, String protocol) nitro_service class constructor specifying ip, format and protocol.
nitro_service(String ip, String protocol) nitro_service class constructor specifying ip and protocol.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear_session() Use this API to clear the current session.
String	get_ipaddress() Gets the IPaddress of the NetScaler SDX.
String	get_onerror() Gets the onerror status of the MPS Resource.
ipayload_formatter	get_payload_formatter() Returns payload format.
String	get_protocol() Gets the protocol.
String	get_sessionid() Gets the sessionId.
String	get_version() Gets the nitro version.
boolean	isLogin() Checks login status.
login	login() Use this API to login into NetScaler SDX.
login	login(String username, String password) Use this API to login into NetScaler SDX.
login	login(String username, String password, Integer timeout) Use this API to login into NetScaler SDX.
login	logout() Use this API to logout from current session.
login	relogin() Use this to API to re login into NetScaler SDX.
void	set_credential(String username, String password) sets the credentials for the NetScaler SDX.
void	set_onerror(nitro_service.OnerrorEnum val) Sets the onerror status of the MPS Resources.
void	set_protocol(String protocol) Sets the protocol.
void	set_sessionid(String id) sets the session id.
void	set_timeout(int timeout) sets the credentials for the NetScaler SDX.
void	set_timeout(Integer timeout) sets the credentials for the NetScaler SDX.

Methods inherited from class java.lang.Object

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

Constructor Detail

nitro_service

public nitro_service(String ip)
              throws nitro_exception

nitro_service class constructor specifying ip.

Parameters:

ip - IPAddress of the NetScaler SDX on which configuration is to be run.

Throws:

nitro_exception

nitro_service

public nitro_service(String ip,
             String protocol)
              throws nitro_exception

nitro_service class constructor specifying ip and protocol.

Parameters:

ip - IPaddress of the NetScaler SDX on which configuration is to be run.

protocol - Protocol.

Throws:

nitro_exception

nitro_service

public nitro_service(String ip,
             ipayload_formatter format)
              throws nitro_exception

nitro_service class constructor specifying ip and format.

Parameters:

ip - IPAdress of the NetScaler SDX on which configuration is to be run.

format - payload format, eg: Json, XML

Throws:

nitro_exception

nitro_service

public nitro_service(String ip,
             ipayload_formatter format,
             String protocol)
              throws nitro_exception

nitro_service class constructor specifying ip, format and protocol.

Parameters:

ip - IPaddress of the NetScaler SDX on which configuration is to be run.

format - format wire language to be used. eg: Json, XML

protocol - Protocol.

Throws:

nitro_exception

Method Detail

set_sessionid

public void set_sessionid(String id)

sets the session id.

Parameters:

id - session id

set_credential

public void set_credential(String username,
                  String password)

sets the credentials for the NetScaler SDX.

Parameters:

username - Username of the NetScaler SDX

password - Password for the NetScaler SDX.

set_timeout

public void set_timeout(int timeout)

sets the credentials for the NetScaler SDX.

Parameters:

timeout - session timeout of the NetScaler SDX. Default is 30 mins.

set_timeout

public void set_timeout(Integer timeout)

sets the credentials for the NetScaler SDX.

Parameters:

timeout - session timeout of the NetScaler SDX. Default is 30 mins.

isLogin

public boolean isLogin()

Checks login status.

Returns:

true if logged-in else false.

get_ipaddress

public String get_ipaddress()

Gets the IPaddress of the NetScaler SDX.

Returns:

IPaddress.

get_version

public String get_version()

Gets the nitro version.

Returns:

nitro version.

get_sessionid

public String get_sessionid()

Gets the sessionId.

Returns:

sessionId.

get_protocol

public String get_protocol()

Gets the protocol.

Returns:

Returns the protocol.

set_protocol

public void set_protocol(String protocol)
                  throws nitro_exception

Sets the protocol.

Parameters:

protocol - The protocol to be set.

Throws:

nitro_exception

get_onerror

public String get_onerror()

Gets the onerror status of the MPS Resource.

Returns:

onerror status.

set_onerror

public void set_onerror(nitro_service.OnerrorEnum val)

Sets the onerror status of the MPS Resources.

Parameters:

val - This option is applicable for bulk requests. possible values: EXIT, CONTINUE. if set with EXIT: exists on the first encountered error. if set with CONTINUE: executes all the requests irrespective of individual response status.

get_payload_formatter

public ipayload_formatter get_payload_formatter()

Returns payload format.

Returns:

Returns the ijson.

login

public login login()
            throws Exception

 Use this API to login into NetScaler SDX.

Returns:

status of the operation performed.

Throws:

nitro_exception - nitro exception is thrown.

Exception

clear_session

public void clear_session()

Use this API to clear the current session.

relogin

public login relogin()
              throws Exception

Use this to API to re login into NetScaler SDX.

Returns:

status of the operation performed.

Throws:

Exception - nitro exception is thrown.

login

public login login(String username,
          String password)
            throws Exception

Use this API to login into NetScaler SDX.

Parameters:

username - Username

password - Password for the NetScaler SDX.

Returns:

status of the operation performed.

Throws:

Exception - nitro exception is thrown.

login

public login login(String username,
          String password,
          Integer timeout)
            throws Exception

Use this API to login into NetScaler SDX.

Parameters:

username - Username

password - Password for the NetScaler SDX.

timeout - timeout for NetScaler SDX session. Default is 30mins

Returns:

status of the operation performed.

Throws:

Exception - nitro exception is thrown.

logout

public login logout()
             throws Exception

 Use this API to logout from current session.

Returns:

status of the operation performed.

Throws:

Exception