com.citrix.sdx.nitro.resource.base

Class base_resource

java.lang.Object

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

Direct Known Subclasses:

activity_status, admin_ns_config, af_config_info, af_persistant_stat_info, audit_log, backup_file, backup_policy, br_adduser, br_app_by_wan_volume, br_broker_snmpmanager, br_broker_upgrade, br_configurealert, br_configurebandwidth5x, br_configurebandwidth6x, br_configuresyslog, br_currentconfig, br_disable, br_enable, br_locallicense, br_remotelicense, br_replicateconfig, br_restart, br_restoreconfig, br_snmpmanager, br_upgrade, current_hostname, current_timezone, device_profile, disk_adapter, event, ftw_events, host_cpu_core, host_interface, hostcpu, inventory, inventory_status, jazz_license, license_file, logical_disk, login, mail_profile, managed_device, mps, mps_doc_image, mps_image, mps_network_config, mps_ssl_certkey, mps_upgrade, mpssession, mpsuser, network_interface, ns_aaasession, ns_cluster, ns_clusternode, ns_command, ns_conf, ns_conf_download_policy, ns_conf_revision_history, ns_conf_upgrade_history, ns_config_diff, ns_configtemplate, ns_detail_vlan, ns_doc_image, ns_image, ns_ns_ip, ns_ns_runningconfig, ns_ns_savedconfig, ns_ns_timeout, ns_save_config, ns_snmp_config, ns_ssl_certkey, ns_ssl_certkey_policy, ns_upgrade, ns_vlan, ns_vpnicaconnection, ns_vserver_appflow_config, ntp_param, ntp_server, ntp_sync, physical_disk, ping, prune_policy, sdx_backup_restore, sdx_license, sdx_network_config, sdxtools_image, sent_mails, sent_sms, sms_profile, sms_server, smtp_server, snmp_alarm_config, snmp_manager, snmp_trap, snmp_user, snmp_view, ssl_cert, ssl_key, syslog_aaa, syslog_generic, syslog_params, syslog_server, syslog_snmp, syslog_sslvpn, syslog_ui_cmd, system_settings, task_command_log, task_device_log, task_log, techsupport, timezone_enum, traceroute, version_matrix_file, version_matrix_status, version_recommendations, vm_template, xen_appcvpx_image, xen_bluecatvpx_image, xen_brvpx_image, xen_health_disk, xen_health_ftw, xen_health_interface, xen_health_monitor, xen_health_resource, xen_health_sr, xen_health_ssl_core, xen_hotfix, xen_image, xen_nsvpx_image, xen_panwvpx_image, xen_sf_storagecentervpx_image, xen_smx_gsbvpx_image, xen_supplemental_pack, xen_trend_microvpx_image, xen_upgrade, xen_websensevpx_image

public abstract class base_resource
extends Object

base_resource is a abstract base class for all the NetScaler SDX resources.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
base_resource()

Method Summary

Methods

Modifier and Type	Method and Description
protected base_resource[]	add_resource(nitro_service service) Use this method to perform a add operation on MPS resource.
protected base_resource[]	add_resource(nitro_service service, options option) Use this method to perform a add operation on MPS resource.
protected static base_resource[]	delete_bulk_request(nitro_service service, base_resource[] resources) Use this method to perform a delete operation on multiple MPS resources.
protected base_resource[]	delete_resource(nitro_service service) Use this method to perform a delete operation on MPS resource.
protected abstract base_resource[]	get_nitro_bulk_response(nitro_service service, String str)
protected abstract base_resource[]	get_nitro_response(nitro_service service, String str)
protected abstract String	get_object_id()
protected String	get_object_type() Gets the resource type.
protected base_resource	get_resource(nitro_service service) Use this method to perform a get operation on MPS resource.
protected base_resource	get_resource(nitro_service service, options option) Use this method to perform a get operation on MPS resource.
protected base_resource[]	get_resources(nitro_service service) Use this method to perform a get operation on MPS resource.
protected base_resource[]	get_resources(nitro_service service, options option) Use this method to perform a get operation on MPS resource.
protected base_resource[]	getfiltered(nitro_service service, options option) Use this method to perform a filtered get operation on MPS resource.
protected static base_resource[]	perform_operation_bulk_request(nitro_service service, base_resource[] resources, String action) Use this method to perform add/reboot/stop/reboot ...etc operation on multiple MPS resources.
base_resource[]	perform_operation(nitro_service service) Use this method to perform a any post operation ...etc operation on MPS resource.
base_resource[]	perform_operation(nitro_service service, options option) Use this method to perform a post operation...etc operation on MPS resource.
base_resource[]	perform_operation(nitro_service service, String action) Use this method to perform a start/stop/reboot/ ...etc operation on MPS resource.
protected String	resource_to_string(nitro_service service) Converts MPS resource to Json string.
protected String	resource_to_string(nitro_service service, options option) Converts MPS resource to Json string.
protected static base_resource[]	update_bulk_request(nitro_service service, base_resource[] resources) Use this method to perform a modify operation on multiple MPS resources.
protected base_resource[]	update_resource(nitro_service service) Use this method to perform a modify operation on MPS resource.
protected base_resource[]	update_resource(nitro_service service, options option) Use this method to perform a modify operation on MPS resource.
protected void	validate(String operationType) This method, performs validation for all data of the resource.

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_NOT_EXISTS

public static final int SESSION_NOT_EXISTS

See Also:

Constant Field Values

Constructor Detail

base_resource

public base_resource()

Method Detail

get_nitro_response

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

Throws:

Exception

get_nitro_bulk_response

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

Throws:

Exception

get_object_id

protected abstract String get_object_id()

get_object_type

protected String get_object_type()

Gets the resource type.

Returns:

Resource Type.

resource_to_string

protected String resource_to_string(nitro_service service,
                        options option)

Converts MPS resource to Json string.

Parameters:

service - nitro_service object.

option - Options object.

Returns:

string in Json format.

resource_to_string

protected String resource_to_string(nitro_service service)

Converts MPS resource to Json string.

Parameters:

service - nitro_service object

Returns:

string in Json format.

getfiltered

protected base_resource[] getfiltered(nitro_service service,
                          options option)
                               throws Exception

Use this method to perform a filtered get operation on MPS resource.

Parameters:

service - nitro_service object.

option - options class object.

Returns:

Array of API resources of given resource type.

Throws:

Exception - API exception is thrown.

get_resources

protected base_resource[] get_resources(nitro_service service)
                                 throws Exception

Use this method to perform a get operation on MPS resource.

Parameters:

service - nitro_service object.

option - options class object.

Returns:

Array of API resources of specified type.

Throws:

Exception - API exception is thrown.

get_resources

protected base_resource[] get_resources(nitro_service service,
                            options option)
                                 throws Exception

Use this method to perform a get operation on MPS resource.

Parameters:

service - nitro_service object.

option - options class object.

Returns:

Array of API resources of specified type.

Throws:

Exception - API exception is thrown.

get_resource

protected base_resource get_resource(nitro_service service,
                         options option)
                              throws Exception

Use this method to perform a get operation on MPS resource.

Parameters:

service - nitro_service object.

option - options class object.

Returns:

Array of API resources of specified type.

Throws:

Exception - API exception is thrown.

get_resource

protected base_resource get_resource(nitro_service service)
                              throws Exception

Use this method to perform a get operation on MPS resource.

Parameters:

service - nitro_service object.

Returns:

Array of API resources of specified type.

Throws:

Exception - API exception is thrown.

perform_operation

public base_resource[] perform_operation(nitro_service service,
                                String action)
                                  throws Exception

Use this method to perform a start/stop/reboot/ ...etc operation on MPS resource.

Parameters:

service - nitro_service object.

action - action needs to be taken on resource.

Returns:

status of the operation performed.

Throws:

Exception - API exception is thrown.

perform_operation

public base_resource[] perform_operation(nitro_service service)
                                  throws Exception

Use this method to perform a any post operation ...etc operation on MPS resource.

Parameters:

service - nitro_service object.

Returns:

status of the operation performed.

Throws:

Exception - API exception is thrown.

perform_operation

public base_resource[] perform_operation(nitro_service service,
                                options option)
                                  throws Exception

Use this method to perform a post operation...etc operation on MPS resource.

Parameters:

service - nitro_service object.

option - options object with action that is to be performed set.

Returns:

status of the operation performed.

Throws:

Exception - API exception is thrown.

add_resource

protected base_resource[] add_resource(nitro_service service)
                                throws Exception

Use this method to perform a add operation on MPS resource.

Parameters:

service - nitro_service object.

Returns:

status of the operation performed.

Throws:

Exception

add_resource

protected base_resource[] add_resource(nitro_service service,
                           options option)
                                throws Exception

Use this method to perform a add operation on MPS resource.

Parameters:

service - nitro_service object.

option - options class object.

Returns:

status of the operation performed.

Throws:

Exception

update_resource

protected base_resource[] update_resource(nitro_service service)
                                   throws Exception

Use this method to perform a modify operation on MPS resource.

Parameters:

service - nitro_service object.

Returns:

status of the operation performed.

Throws:

Exception

update_resource

protected base_resource[] update_resource(nitro_service service,
                              options option)
                                   throws Exception

Use this method to perform a modify operation on MPS resource.

Parameters:

service - nitro_service object.

option - options class object.

Returns:

status of the operation performed.

Throws:

Exception

delete_resource

protected base_resource[] delete_resource(nitro_service service)
                                   throws Exception

Use this method to perform a delete operation on MPS resource.

Parameters:

service - nitro_service object

Returns:

status of the operation performed.

Throws:

Exception - API exception is thrown.

validate

protected void validate(String operationType)
                 throws Exception

This method, performs validation for all data of the resource.

Parameters:

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

Throws:

Exception

perform_operation_bulk_request

protected static base_resource[] perform_operation_bulk_request(nitro_service service,
                                             base_resource[] resources,
                                             String action)
                                                         throws Exception

Use this method to perform add/reboot/stop/reboot ...etc operation on multiple MPS resources.

Parameters:

service - nitro_service object.

resources - Array of Nitro resources on which the specified action to be performed.

option - options object with action that is to be performed set.

Returns:

array of resources on which operation performed.

Throws:

Exception - Nitro exception is thrown.

update_bulk_request

protected static base_resource[] update_bulk_request(nitro_service service,
                                  base_resource[] resources)
                                              throws Exception

Use this method to perform a modify operation on multiple MPS resources.

Parameters:

service - nitro_service object.

Returns:

status of the operation performed.

Throws:

Exception

delete_bulk_request

protected static base_resource[] delete_bulk_request(nitro_service service,
                                  base_resource[] resources)
                                              throws Exception

Use this method to perform a delete operation on multiple MPS resources.

Parameters:

service - nitro_service object

Returns:

status of the operation performed.

Throws:

Exception - API exception is thrown.