com.citrix.sdx.nitro.resource.base

Class login

java.lang.Object

com.citrix.sdx.nitro.resource.base.base_resource

com.citrix.sdx.nitro.resource.base.login

public class login
extends base_resource

Configuration for Login/Logout resource

Field Summary

Fields inherited from class com.citrix.sdx.nitro.resource.base.base_resource

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
login()

Method Summary

Methods

Modifier and Type	Method and Description
static login	add(nitro_service client, login resource) Login.
static login[]	add(nitro_service client, login[] resources) Login in bulk.
static login	delete(nitro_service client, login resource) Logout.
static login[]	delete(nitro_service client, login[] resources) Logout in bulk.
protected base_resource[]	get_nitro_bulk_response(nitro_service service, String response) Converts API response of bulk operation into object and returns the object array in case of get request.
protected base_resource[]	get_nitro_response(nitro_service service, String response) Converts API response into object and returns the object array in case of get request.
protected String	get_object_id() Returns the value of object identifier argument.
protected String	get_object_type() Gets the resource type.
String	get_password() Password
Integer	get_session_timeout() Session Timeout in seconds, if no activity is performed for specified time then session will be expired
String	get_sessionid() Session ID would only be set if login was performed successfully
String	get_username() User Name that wants to login
void	set_password(String password) Password
void	set_session_timeout(Integer session_timeout) Session Timeout in seconds, if no activity is performed for specified time then session will be expired
void	set_sessionid(String sessionid) Session ID would only be set if login was performed successfully
void	set_username(String username) User Name that wants to login
protected void	validate(String operationType) Performs generic data validation for the operation to be performed

Methods inherited from class com.citrix.sdx.nitro.resource.base.base_resource

add_resource, add_resource, delete_bulk_request, delete_resource, get_resource, get_resource, get_resources, get_resources, getfiltered, perform_operation_bulk_request, perform_operation, perform_operation, perform_operation, resource_to_string, resource_to_string, update_bulk_request, update_resource, update_resource

Methods inherited from class java.lang.Object

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

Constructor Detail

login

public login()

Method Detail

get_object_type

protected String get_object_type()

Description copied from class: base_resource

Gets the resource type.

Overrides:

get_object_type in class base_resource

Returns:

Resource Type.

get_object_id

protected String get_object_id()

Returns the value of object identifier argument.

Specified by:

get_object_id in class base_resource

set_password

public void set_password(String password)

 Password
 

get_password

public String get_password()

 Password
 

set_session_timeout

public void set_session_timeout(Integer session_timeout)

 Session Timeout in seconds, if no activity is performed for specified time then session will be expired
 

get_session_timeout

public Integer get_session_timeout()

 Session Timeout in seconds, if no activity is performed for specified time then session will be expired
 

set_sessionid

public void set_sessionid(String sessionid)

 Session ID would only be set if login was performed successfully
 

get_sessionid

public String get_sessionid()

 Session ID would only be set if login was performed successfully
 

set_username

public void set_username(String username)

 User Name that wants to login
 

get_username

public String get_username()

 User Name that wants to login
 

add

public static login add(nitro_service client,
        login resource)
                 throws Exception

 Login.
 

Throws:

Exception

add

public static login[] add(nitro_service client,
          login[] resources)
                   throws Exception

 Login in bulk.
 

Throws:

Exception

delete

public static login delete(nitro_service client,
           login resource)
                    throws Exception

 Logout.
 

Throws:

Exception

delete

public static login[] delete(nitro_service client,
             login[] resources)
                      throws Exception

 Logout in bulk.
 

Throws:

Exception

get_nitro_response

protected base_resource[] get_nitro_response(nitro_service service,
                                 String response)
                                      throws Exception

 Converts API response into object and returns the object array in case of get request.
 

Specified by:

get_nitro_response in class base_resource

Throws:

Exception

get_nitro_bulk_response

protected base_resource[] get_nitro_bulk_response(nitro_service service,
                                      String response)
                                           throws Exception

 Converts API response of bulk operation into object and returns the object array in case of get request.
 

Specified by:

get_nitro_bulk_response in class base_resource

Throws:

Exception

validate

protected void validate(String operationType)
                 throws Exception

 Performs generic data validation for the operation to be performed
 

Overrides:

validate in class base_resource

Parameters:

operationType - : add,delete,modify,get etc.

Throws:

Exception