com.citrix.netscaler.nitro.resource.stat.gslb.gslbdomain_stats Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nitro Show documentation
The Citrix® NetScaler® NITRO client for Java allows you to configure and monitor the NetScaler appliance programmatically in Java based applications. Source code taken from Build 121 of NetScaler release 10.1
The newest version!
/*
* Copyright (c) 2008-2015 Citrix Systems, Inc.
*
*   Licensed under the Apache License, Version 2.0 (the "License");
*   you may not use this file except in compliance with the License.
*   You may obtain a copy of the License at
*
*       http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*   distributed under the License is distributed on an "AS IS" BASIS,
*   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*   See the License for the specific language governing permissions and
*   limitations under the License.
*/

package com.citrix.netscaler.nitro.resource.stat.gslb;

import com.citrix.netscaler.nitro.resource.base.*;
import com.citrix.netscaler.nitro.service.nitro_service;
import com.citrix.netscaler.nitro.service.options;
import com.citrix.netscaler.nitro.util.*;
import com.citrix.netscaler.nitro.exception.nitro_exception;

class gslbdomain_response extends base_response
{
	public gslbdomain_stats[] gslbdomain;
}
/**
* Statistics for GSLB domain resource.
*/

public class gslbdomain_stats extends base_resource
{
	private String name;
	private String clearstats;
	private Long dnstotalqueries;
	private Long dnsqueriesrate;

	/**
	* 	* Name of the GSLB domain for which to display statistics. If you do not specify a name, statistics are shown for all configured GSLB domains.
	* 
	*/
	public void set_name(String name) throws Exception{
		this.name = name;
	}

	/**
	* 	* Name of the GSLB domain for which to display statistics. If you do not specify a name, statistics are shown for all configured GSLB domains.
 Minimum length =  1
	* 
	*/
	public String get_name() throws Exception {
		return this.name;
	}

	/**
	* 	* Clear the statsistics / counters
	* 
	*/
	public void set_clearstats(String clearstats) throws Exception{
		this.clearstats = clearstats;
	}

	/**
	* 	* Clear the statsistics / counters.
 Possible values = basic, full
	* 
	*/
	public String get_clearstats() throws Exception {
		return this.clearstats;
	}

	/**
	* 	* Rate (/s) counter for dnstotalqueries
	* 
	*/
	public Long get_dnsqueriesrate() throws Exception {
		return this.dnsqueriesrate;
	}

	/**
	* 	* Total number of DNS queries received.
	* 
	*/
	public Long get_dnstotalqueries() throws Exception {
		return this.dnstotalqueries;
	}

	/**
	* 	* converts nitro response into object and returns the object array in case of get request.
	* 
	*/
	protected base_resource[] get_nitro_response(nitro_service service, String response) throws Exception{
		gslbdomain_response result = (gslbdomain_response) service.get_payload_formatter().string_to_resource(gslbdomain_response.class, response);
		if(result.errorcode != 0) {
			if (result.errorcode == 444) {
				service.clear_session();
			}
			if(result.severity != null)
			{
				if (result.severity.equals("ERROR"))
					throw new nitro_exception(result.message,result.errorcode);
			}
			else
			{
				throw new nitro_exception(result.message,result.errorcode);
			}
		}
		return result.gslbdomain;
	}

	/**
	* 	* Returns the value of object identifier argument
	* 
	*/

	protected String get_object_name() {
		return this.name;
	}

	/**
	* Use this API to fetch the statistics of all gslbdomain_stats resources that are configured on netscaler.
	*/
	public static gslbdomain_stats[] get(nitro_service service) throws Exception{
		gslbdomain_stats obj = new gslbdomain_stats();
		gslbdomain_stats[] response = (gslbdomain_stats[])obj.stat_resources(service);
		return response;
	}

	/**
	* Use this API to fetch the statistics of all gslbdomain_stats resources that are configured on netscaler.
	*/
	public static gslbdomain_stats[] get(nitro_service service, options option) throws Exception{
		gslbdomain_stats obj = new gslbdomain_stats();
		gslbdomain_stats[] response = (gslbdomain_stats[])obj.stat_resources(service,option);
		return response;
	}

	/**
	* Use this API to fetch statistics of gslbdomain_stats resource of given name .
	*/
	public static gslbdomain_stats get(nitro_service service, String name) throws Exception{
		gslbdomain_stats obj = new gslbdomain_stats();
		obj.set_name(name);
		gslbdomain_stats response = (gslbdomain_stats) obj.stat_resource(service);
		return response;
	}

	public static class clearstatsEnum {
		public static final String basic = "basic";
		public static final String full = "full";
	}
}