com.citrix.netscaler.nitro.resource.stat.rewrite.rewritepolicy_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.rewrite;

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 rewritepolicy_response extends base_response
{
	public rewritepolicy_stats[] rewritepolicy;
}
/**
* Statistics for rewrite policy resource.
*/

public class rewritepolicy_stats extends base_resource
{
	private String name;
	private String clearstats;
	private Long pipolicyhits;
	private Long pipolicyhitsrate;
	private Long pipolicyundefhits;
	private Long pipolicyundefhitsrate;

	/**
	* 	* Name of the rewrite policy.
	* 
	*/
	public void set_name(String name) throws Exception{
		this.name = name;
	}

	/**
	* 	* Name of the rewrite policy.
 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 pipolicyhits
	* 
	*/
	public Long get_pipolicyhitsrate() throws Exception {
		return this.pipolicyhitsrate;
	}

	/**
	* 	* Rate (/s) counter for pipolicyundefhits
	* 
	*/
	public Long get_pipolicyundefhitsrate() throws Exception {
		return this.pipolicyundefhitsrate;
	}

	/**
	* 	* Number of hits on the policy
	* 
	*/
	public Long get_pipolicyhits() throws Exception {
		return this.pipolicyhits;
	}

	/**
	* 	* Number of undef hits on the policy
	* 
	*/
	public Long get_pipolicyundefhits() throws Exception {
		return this.pipolicyundefhits;
	}

	/**
	* 	* 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{
		rewritepolicy_response result = (rewritepolicy_response) service.get_payload_formatter().string_to_resource(rewritepolicy_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.rewritepolicy;
	}

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

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

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

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

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

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