com.citrix.netscaler.nitro.resource.stat.appflow.appflow_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
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.appflow;
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 appflow_response extends base_response
{
public appflow_stats appflow;
}
public class appflow_stats extends base_resource
{
private String clearstats;
private Long appflowtotaltxoctets;
private Long appflowtxoctetsrate;
private Long appflowtotalflows;
private Long appflowflowsrate;
private Long appflowtotaltxmessagess;
private Long appflowtxmessagessrate;
private Long appflowtotalignoctets;
private Long appflowignoctetsrate;
private Long appflowtotalignpacketss;
private Long appflowignpacketssrate;
private Long appflowtotalnotxoctets;
private Long appflownotxoctetsrate;
private Long appflowtotalnotxflows;
private Long appflownotxflowsrate;
private Long appflowtotalnotxpackets;
private Long appflownotxpacketsrate;
/**
*
* 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 appflowtotaltxoctets
*
*/
public Long get_appflowtxoctetsrate() throws Exception {
return this.appflowtxoctetsrate;
}
/**
*
* Rate (/s) counter for appflowtotaltxmessagess
*
*/
public Long get_appflowtxmessagessrate() throws Exception {
return this.appflowtxmessagessrate;
}
/**
*
* The total number of AppFlow (IPFIX) octets that the NetScaler has not transmitted.
*
*/
public Long get_appflowtotalnotxoctets() throws Exception {
return this.appflowtotalnotxoctets;
}
/**
*
* The total number of AppFlow (IPFIX) messages that the NetScaler has transmitted.
*
*/
public Long get_appflowtotaltxmessagess() throws Exception {
return this.appflowtotaltxmessagess;
}
/**
*
* The total number of packets that the NetScaler has ignored for AppFlow (IPFIX).
*
*/
public Long get_appflowtotalignpacketss() throws Exception {
return this.appflowtotalignpacketss;
}
/**
*
* The total number of AppFlow (IPFIX) flows that the NetScaler has transmitted.
*
*/
public Long get_appflowtotalflows() throws Exception {
return this.appflowtotalflows;
}
/**
*
* The total number of AppFlow (IPFIX) flows that the NetScaler has not transmitted.
*
*/
public Long get_appflowtotalnotxflows() throws Exception {
return this.appflowtotalnotxflows;
}
/**
*
* Rate (/s) counter for appflowtotalnotxflows
*
*/
public Long get_appflownotxflowsrate() throws Exception {
return this.appflownotxflowsrate;
}
/**
*
* Rate (/s) counter for appflowtotalignoctets
*
*/
public Long get_appflowignoctetsrate() throws Exception {
return this.appflowignoctetsrate;
}
/**
*
* The total number of octets that the NetScaler has ignored for AppFlow (IPFIX).
*
*/
public Long get_appflowtotalignoctets() throws Exception {
return this.appflowtotalignoctets;
}
/**
*
* The total number of AppFlow (IPFIX) octets that the NetScaler has transmitted.
*
*/
public Long get_appflowtotaltxoctets() throws Exception {
return this.appflowtotaltxoctets;
}
/**
*
* The total number of AppFlow (IPFIX) packets that the NetScaler has not transmitted.
*
*/
public Long get_appflowtotalnotxpackets() throws Exception {
return this.appflowtotalnotxpackets;
}
/**
*
* Rate (/s) counter for appflowtotalnotxpackets
*
*/
public Long get_appflownotxpacketsrate() throws Exception {
return this.appflownotxpacketsrate;
}
/**
*
* Rate (/s) counter for appflowtotalflows
*
*/
public Long get_appflowflowsrate() throws Exception {
return this.appflowflowsrate;
}
/**
*
* Rate (/s) counter for appflowtotalnotxoctets
*
*/
public Long get_appflownotxoctetsrate() throws Exception {
return this.appflownotxoctetsrate;
}
/**
*
* Rate (/s) counter for appflowtotalignpacketss
*
*/
public Long get_appflowignpacketssrate() throws Exception {
return this.appflowignpacketssrate;
}
/**
*
* 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 {
appflow_stats[] resources = new appflow_stats[1];
appflow_response result = (appflow_response) service.get_payload_formatter().string_to_resource(appflow_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);
}
}
resources[0] = result.appflow;
return resources;
}
/**
*
* Returns the value of object identifier argument
*
*/
protected String get_object_name() {
return null;
}
/**
* Use this API to fetch the statistics of all appflow_stats resources that are configured on netscaler.
*/
public static appflow_stats get(nitro_service service) throws Exception{
appflow_stats obj = new appflow_stats();
appflow_stats[] response = (appflow_stats[])obj.stat_resources(service);
return response[0];
}
/**
* Use this API to fetch the statistics of all appflow_stats resources that are configured on netscaler.
*/
public static appflow_stats get(nitro_service service, options option) throws Exception{
appflow_stats obj = new appflow_stats();
appflow_stats[] response = (appflow_stats[])obj.stat_resources(service,option);
return response[0];
}
public static class clearstatsEnum {
public static final String basic = "basic";
public static final String full = "full";
}
}