com.citrix.sdx.nitro.resource.config.mps

Class mpssession

java.lang.Object

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

com.citrix.sdx.nitro.resource.config.mps.mpssession

public class mpssession
extends base_resource

Configuration for Client Session resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
mpssession()

Method Summary

Methods

Modifier and Type	Method and Description
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of mpssession resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of mpssession resources.
static long	count(nitro_service service) Use this API to count the mpssession resources configured on NetScaler SDX.
static mpssession	delete(nitro_service client, mpssession resource) Kill client session by providing id.
static mpssession[]	delete(nitro_service client, mpssession[] resources) Kill client session by providing id in bulk.
Integer	get_expire_after() Session will expire after these many seconds
static mpssession[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of mpssession resources.
static mpssession[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of mpssession resources.
String	get_id() Id is system generated key for all the client sessions
String	get_ip_address() IP Aaddress from where this session was initiated
Boolean	get_is_self() true, if this session is for current logged-in user
Integer	get_last_activity_time() Last Activity Time for this session
Integer	get_login_time() Session was initiated at this time
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.
Integer	get_port() Port from where this session was initiated
Integer	get_session_timeout() Session Timeout set for this session
String	get_sessionid() Session ID for this session
String	get_username() User Name who initiated this session
static mpssession[]	get(nitro_service client) Use this operation to get client sessions.
static mpssession	get(nitro_service client, mpssession resource) Use this operation to get client sessions.
void	set_id(String id) Id is system generated key for all the client sessions
void	set_sessionid(String sessionid) Session ID for this session
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

mpssession

public mpssession()

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

get_expire_after

public Integer get_expire_after()

 Session will expire after these many seconds
 

get_login_time

public Integer get_login_time()

 Session was initiated at this time
 

get_session_timeout

public Integer get_session_timeout()

 Session Timeout set for this session
 

get_port

public Integer get_port()

 Port from where this session was initiated
 

get_username

public String get_username()

 User Name who initiated this session
 

get_last_activity_time

public Integer get_last_activity_time()

 Last Activity Time for this session
 

set_id

public void set_id(String id)

 Id is system generated key for all the client sessions
 

get_id

public String get_id()

 Id is system generated key for all the client sessions
 

get_ip_address

public String get_ip_address()

 IP Aaddress from where this session was initiated
 

set_sessionid

public void set_sessionid(String sessionid)

 Session ID for this session
 

get_sessionid

public String get_sessionid()

 Session ID for this session
 

get_is_self

public Boolean get_is_self()

 true, if this session is for current logged-in user
 

get

public static mpssession[] get(nitro_service client)
                        throws Exception

 Use this operation to get client sessions.
 

Throws:

Exception

get

public static mpssession get(nitro_service client,
             mpssession resource)
                      throws Exception

Use this operation to get client sessions.

Throws:

Exception

delete

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

 Kill client session by providing id.
 

Throws:

Exception

delete

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

 Kill client session by providing id in bulk.
 

Throws:

Exception

get_filtered

public static mpssession[] get_filtered(nitro_service service,
                        String filter)
                                 throws Exception

Use this API to fetch filtered set of mpssession resources. filter string should be in JSON format.eg: "vm_state:DOWN,name:[a-z]+"

Throws:

Exception

get_filtered

public static mpssession[] get_filtered(nitro_service service,
                        filtervalue[] filter)
                                 throws Exception

Use this API to fetch filtered set of mpssession resources. set the filter parameter values in filtervalue object.

Throws:

Exception

count

public static long count(nitro_service service)
                  throws Exception

Use this API to count the mpssession resources configured on NetScaler SDX.

Throws:

Exception

count_filtered

public static long count_filtered(nitro_service service,
                  String filter)
                           throws Exception

Use this API to count the filtered set of mpssession resources. filter string should be in JSON format.eg: "vm_state:DOWN,name:[a-z]+"

Throws:

Exception

count_filtered

public static long count_filtered(nitro_service service,
                  filtervalue[] filter)
                           throws Exception

Use this API to count the filtered set of mpssession resources. set the filter parameter values in filtervalue object.

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