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

Class smtp_server

java.lang.Object

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

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

public class smtp_server
extends base_resource

Configuration for SMTP 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
smtp_server()

Method Summary

Methods

Modifier and Type	Method and Description
static smtp_server	add(nitro_service client, smtp_server resource) Use this operation to add smtp server.
static smtp_server[]	add(nitro_service client, smtp_server[] resources) Use this operation to add smtp server in bulk.
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of smtp_server resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of smtp_server resources.
static long	count(nitro_service service) Use this API to count the smtp_server resources configured on NetScaler SDX.
static smtp_server	delete(nitro_service client, smtp_server resource) Use this operation to delete smtp server.
static smtp_server[]	delete(nitro_service client, smtp_server[] resources) Use this operation to delete smtp server in bulk.
static smtp_server[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of smtp_server resources.
static smtp_server[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of smtp_server resources.
String	get_id() Id is system generated key for all the smtp server
Boolean	get_is_auth() Is authentication enabled for this smtp server
Boolean	get_is_ssl() Is this smtp server is SSL support configured.
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 for the smtp server
Integer	get_port() SMTP Server port address.
String	get_server_name() SMTP server name
String	get_username() Username for the smtp server
static smtp_server[]	get(nitro_service client) Use this operation to get smtp server details..
static smtp_server	get(nitro_service client, smtp_server resource) Use this operation to get smtp server details..
void	set_id(String id) Id is system generated key for all the smtp server
void	set_is_auth(Boolean is_auth) Is authentication enabled for this smtp server
void	set_is_ssl(Boolean is_ssl) Is this smtp server is SSL support configured.
void	set_password(String password) Password for the smtp server
void	set_port(Integer port) SMTP Server port address.
void	set_server_name(String server_name) SMTP server name
void	set_username(String username) Username for the smtp server
static smtp_server	update(nitro_service client, smtp_server resource) Use this operation to modify smtp server.
static smtp_server[]	update(nitro_service client, smtp_server[] resources) Use this operation to modify smtp 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

smtp_server

public smtp_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_password

public void set_password(String password)

 Password for the smtp server
 

get_password

public String get_password()

 Password for the smtp server
 

set_is_auth

public void set_is_auth(Boolean is_auth)

 Is authentication enabled for this smtp server
 

get_is_auth

public Boolean get_is_auth()

 Is authentication enabled for this smtp server
 

set_id

public void set_id(String id)

 Id is system generated key for all the smtp server
 

get_id

public String get_id()

 Id is system generated key for all the smtp server
 

set_is_ssl

public void set_is_ssl(Boolean is_ssl)

 Is this smtp server is SSL support configured.
 

get_is_ssl

public Boolean get_is_ssl()

 Is this smtp server is SSL support configured.
 

set_port

public void set_port(Integer port)

 SMTP Server port address.
 

get_port

public Integer get_port()

 SMTP Server port address.
 

set_username

public void set_username(String username)

 Username for the smtp server
 

get_username

public String get_username()

 Username for the smtp server
 

set_server_name

public void set_server_name(String server_name)

 SMTP server name
 

get_server_name

public String get_server_name()

 SMTP server name
 

add

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

 Use this operation to add smtp server.
 

Throws:

Exception

add

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

 Use this operation to add smtp server in bulk.
 

Throws:

Exception

delete

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

 Use this operation to delete smtp server.
 

Throws:

Exception

delete

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

 Use this operation to delete smtp server in bulk.
 

Throws:

Exception

get

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

 Use this operation to get smtp server details..
 

Throws:

Exception

get

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

Use this operation to get smtp server details..

Throws:

Exception

update

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

 Use this operation to modify smtp server.
 

Throws:

Exception

update

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

 Use this operation to modify smtp server in bulk.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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