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

Class mpsuser

java.lang.Object

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

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

public class mpsuser
extends base_resource

Configuration for System User resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
mpsuser()

Method Summary

Methods

Modifier and Type	Method and Description
static mpsuser	add(nitro_service client, mpsuser resource) Use this operation to add system user.
static mpsuser[]	add(nitro_service client, mpsuser[] resources) Use this operation to add system user in bulk.
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of mpsuser resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of mpsuser resources.
static long	count(nitro_service service) Use this API to count the mpsuser resources configured on NetScaler SDX.
static mpsuser	delete(nitro_service client, mpsuser resource) Use this operation to delete system user(s).
static mpsuser[]	delete(nitro_service client, mpsuser[] resources) Use this operation to delete system user(s) in bulk.
static mpsuser[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of mpsuser resources.
static mpsuser[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of mpsuser resources.
String	get_id() Id is system generated key for all the system users
String	get_name() User Name
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
String	get_permission() Actions that this user is authorized to perform
static mpsuser[]	get(nitro_service client) Use this operation to get system users.
static mpsuser	get(nitro_service client, mpsuser resource) Use this operation to get system users.
void	set_id(String id) Id is system generated key for all the system users
void	set_name(String name) User Name
void	set_password(String password) Password
void	set_permission(String permission) Actions that this user is authorized to perform
static mpsuser	update(nitro_service client, mpsuser resource) Use this operation to modify system user.
static mpsuser[]	update(nitro_service client, mpsuser[] resources) Use this operation to modify system user 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

mpsuser

public mpsuser()

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_permission

public void set_permission(String permission)

 Actions that this user is authorized to perform
 

get_permission

public String get_permission()

 Actions that this user is authorized to perform
 

set_name

public void set_name(String name)

 User Name
 

get_name

public String get_name()

 User Name
 

set_id

public void set_id(String id)

 Id is system generated key for all the system users
 

get_id

public String get_id()

 Id is system generated key for all the system users
 

add

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

 Use this operation to add system user.
 

Throws:

Exception

add

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

 Use this operation to add system user in bulk.
 

Throws:

Exception

delete

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

 Use this operation to delete system user(s).
 

Throws:

Exception

delete

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

 Use this operation to delete system user(s) in bulk.
 

Throws:

Exception

get

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

 Use this operation to get system users.
 

Throws:

Exception

get

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

Use this operation to get system users.

Throws:

Exception

update

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

 Use this operation to modify system user.
 

Throws:

Exception

update

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

 Use this operation to modify system user in bulk.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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