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

Class sms_server

java.lang.Object

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

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

public class sms_server
extends base_resource

Configuration for SMS server properties resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
sms_server()

Method Summary

Methods

Modifier and Type	Method and Description
static sms_server	add(nitro_service client, sms_server resource) Use this operation to add sms server.
static sms_server[]	add(nitro_service client, sms_server[] resources) Use this operation to add sms server in bulk.
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of sms_server resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of sms_server resources.
static long	count(nitro_service service) Use this API to count the sms_server resources configured on NetScaler SDX.
static sms_server	delete(nitro_service client, sms_server resource) Use this operation to delete sms server.
static sms_server[]	delete(nitro_service client, sms_server[] resources) Use this operation to delete sms server in bulk.
String	get_base_url() Base URL for the sms server, without payload
static sms_server[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of sms_server resources.
static sms_server[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of sms_server resources.
String	get_id() Id is system generated key for all the sms server
Boolean	get_is_ssl() Is this sms server is SSL support configured.
String	get_message_key() Message key for the sms server
String	get_message_word_sperater() Message Word Seperater for the sms server
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_optional1_key() Optional1 key for the sms server
String	get_optional1_val() Optional1 Val for the sms server
String	get_optional2_key() Optional2 key for the sms server
String	get_optional2_val1() Optional2 Val for the sms server
String	get_optional3_key() Optional3 key for the sms server
String	get_optional3_val() Optional3 Val for the sms server
String	get_password_key() Password key for the sms server
String	get_password_val() Password Val for the sms server
String	get_server_name() SMS server name
String	get_to_key() To key for the sms server
String	get_to_seperater() To list seperater for the sms server
String	get_type() HTTP type supported for the sms server
String	get_username_key() Username key for the sms server
String	get_username_val() Username val for the sms server
static sms_server[]	get(nitro_service client) Use this operation to get sms server details..
static sms_server	get(nitro_service client, sms_server resource) Use this operation to get sms server details..
void	set_base_url(String base_url) Base URL for the sms server, without payload
void	set_id(String id) Id is system generated key for all the sms server
void	set_is_ssl(Boolean is_ssl) Is this sms server is SSL support configured.
void	set_message_key(String message_key) Message key for the sms server
void	set_message_word_sperater(String message_word_sperater) Message Word Seperater for the sms server
void	set_optional1_key(String optional1_key) Optional1 key for the sms server
void	set_optional1_val(String optional1_val) Optional1 Val for the sms server
void	set_optional2_key(String optional2_key) Optional2 key for the sms server
void	set_optional2_val1(String optional2_val1) Optional2 Val for the sms server
void	set_optional3_key(String optional3_key) Optional3 key for the sms server
void	set_optional3_val(String optional3_val) Optional3 Val for the sms server
void	set_password_key(String password_key) Password key for the sms server
void	set_password_val(String password_val) Password Val for the sms server
void	set_server_name(String server_name) SMS server name
void	set_to_key(String to_key) To key for the sms server
void	set_to_seperater(String to_seperater) To list seperater for the sms server
void	set_type(String type) HTTP type supported for the sms server
void	set_username_key(String username_key) Username key for the sms server
void	set_username_val(String username_val) Username val for the sms server
static sms_server	update(nitro_service client, sms_server resource) Use this operation to modify sms server.
static sms_server[]	update(nitro_service client, sms_server[] resources) Use this operation to modify sms server in bulk.
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

sms_server

public sms_server()

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_optional3_val

public void set_optional3_val(String optional3_val)

 Optional3 Val for the sms server
 

get_optional3_val

public String get_optional3_val()

 Optional3 Val for the sms server
 

set_base_url

public void set_base_url(String base_url)

 Base URL for the sms server, without payload
 

get_base_url

public String get_base_url()

 Base URL for the sms server, without payload
 

set_optional2_val1

public void set_optional2_val1(String optional2_val1)

 Optional2 Val for the sms server
 

get_optional2_val1

public String get_optional2_val1()

 Optional2 Val for the sms server
 

set_optional1_val

public void set_optional1_val(String optional1_val)

 Optional1 Val for the sms server
 

get_optional1_val

public String get_optional1_val()

 Optional1 Val for the sms server
 

set_to_seperater

public void set_to_seperater(String to_seperater)

 To list seperater for the sms server
 

get_to_seperater

public String get_to_seperater()

 To list seperater for the sms server
 

set_username_key

public void set_username_key(String username_key)

 Username key for the sms server
 

get_username_key

public String get_username_key()

 Username key for the sms server
 

set_optional2_key

public void set_optional2_key(String optional2_key)

 Optional2 key for the sms server
 

get_optional2_key

public String get_optional2_key()

 Optional2 key for the sms server
 

set_username_val

public void set_username_val(String username_val)

 Username val for the sms server
 

get_username_val

public String get_username_val()

 Username val for the sms server
 

set_to_key

public void set_to_key(String to_key)

 To key for the sms server
 

get_to_key

public String get_to_key()

 To key for the sms server
 

set_message_key

public void set_message_key(String message_key)

 Message key for the sms server
 

get_message_key

public String get_message_key()

 Message key for the sms server
 

set_optional1_key

public void set_optional1_key(String optional1_key)

 Optional1 key for the sms server
 

get_optional1_key

public String get_optional1_key()

 Optional1 key for the sms server
 

set_message_word_sperater

public void set_message_word_sperater(String message_word_sperater)

 Message Word Seperater for the sms server
 

get_message_word_sperater

public String get_message_word_sperater()

 Message Word Seperater for the sms server
 

set_optional3_key

public void set_optional3_key(String optional3_key)

 Optional3 key for the sms server
 

get_optional3_key

public String get_optional3_key()

 Optional3 key for the sms server
 

set_type

public void set_type(String type)

 HTTP type supported for the sms server
 

get_type

public String get_type()

 HTTP type supported for the sms server
 

set_id

public void set_id(String id)

 Id is system generated key for all the sms server
 

get_id

public String get_id()

 Id is system generated key for all the sms server
 

set_is_ssl

public void set_is_ssl(Boolean is_ssl)

 Is this sms server is SSL support configured.
 

get_is_ssl

public Boolean get_is_ssl()

 Is this sms server is SSL support configured.
 

set_password_val

public void set_password_val(String password_val)

 Password Val for the sms server
 

get_password_val

public String get_password_val()

 Password Val for the sms server
 

set_server_name

public void set_server_name(String server_name)

 SMS server name
 

get_server_name

public String get_server_name()

 SMS server name
 

set_password_key

public void set_password_key(String password_key)

 Password key for the sms server
 

get_password_key

public String get_password_key()

 Password key for the sms server
 

add

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

 Use this operation to add sms server.
 

Throws:

Exception

add

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

 Use this operation to add sms server in bulk.
 

Throws:

Exception

delete

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

 Use this operation to delete sms server.
 

Throws:

Exception

delete

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

 Use this operation to delete sms server in bulk.
 

Throws:

Exception

get

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

 Use this operation to get sms server details..
 

Throws:

Exception

get

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

Use this operation to get sms server details..

Throws:

Exception

update

public static sms_server update(nitro_service client,
                sms_server resource)
                         throws Exception

 Use this operation to modify sms server.
 

Throws:

Exception

update

public static sms_server[] update(nitro_service client,
                  sms_server[] resources)
                           throws Exception

 Use this operation to modify sms server in bulk.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

Use this API to fetch filtered set of sms_server 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 sms_server 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 sms_server 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 sms_server 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