com.citrix.netscaler.nitro.resource.stat.basic.servicegroupmember_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.basic;
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 servicegroupmember_response extends base_response
{
public servicegroupmember_stats[] servicegroupmember;
}
/**
* Statistics for service group entity resource.
*/
public class servicegroupmember_stats extends base_resource
{
private String servicegroupname;
private String ip;
private String servername;
private Integer port;
private String clearstats;
private Long avgsvrttfb;
private String primaryipaddress;
private Integer primaryport;
private String servicetype;
private String state;
private Long totalrequests;
private Long requestsrate;
private Long totalresponses;
private Long responsesrate;
private Long totalrequestbytes;
private Long requestbytesrate;
private Long totalresponsebytes;
private Long responsebytesrate;
private Long curclntconnections;
private Long surgecount;
private Long cursrvrconnections;
private Long svrestablishedconn;
private Long curreusepool;
private Long maxclients;
/**
*
* Displays statistics for the specified service group.Name of the service group. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters.
CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my servicegroup" or 'my servicegroup').
*
*/
public void set_servicegroupname(String servicegroupname) throws Exception{
this.servicegroupname = servicegroupname;
}
/**
*
* Displays statistics for the specified service group.Name of the service group. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters.
CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my servicegroup" or 'my servicegroup').
Minimum length = 1
*
*/
public String get_servicegroupname() throws Exception {
return this.servicegroupname;
}
/**
*
* IP address of the service group. Mutually exclusive with the server name parameter.
*
*/
public void set_ip(String ip) throws Exception{
this.ip = ip;
}
/**
*
* IP address of the service group. Mutually exclusive with the server name parameter.
*
*/
public String get_ip() throws Exception {
return this.ip;
}
/**
*
* Name of the server. Mutually exclusive with the IP address parameter.
*
*/
public void set_servername(String servername) throws Exception{
this.servername = servername;
}
/**
*
* Name of the server. Mutually exclusive with the IP address parameter.
Minimum length = 1
*
*/
public String get_servername() throws Exception {
return this.servername;
}
/**
*
* Port number of the service group member.
*
*/
public void set_port(int port) throws Exception {
this.port = new Integer(port);
}
/**
*
* Port number of the service group member.
*
*/
public void set_port(Integer port) throws Exception{
this.port = port;
}
/**
*
* Port number of the service group member.
Range 1 - 65535
*
*/
public Integer get_port() throws Exception {
return this.port;
}
/**
*
* 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;
}
/**
*
* Number of server connections in ESTABLISHED state.
*
*/
public Long get_svrestablishedconn() throws Exception {
return this.svrestablishedconn;
}
/**
*
* Number of current client connections.
*
*/
public Long get_curclntconnections() throws Exception {
return this.curclntconnections;
}
/**
*
* The service type of this service.Possible values are ADNS, DNS, MYSQL, RTSP, SSL_DIAMETER, ADNS_TCP, DNS_TCP, NNTP, SIP_UDP, SSL_TCP, ANY, FTP, RADIUS, SNMP, TCP, DHCPRA, HTTP, RDP, SSL, TFTP, DIAMETER, MSSQL, RPCSVR, SSL_BRIDGE, UDP
*
*/
public String get_servicetype() throws Exception {
return this.servicetype;
}
/**
*
* Total number of requests received on this service or virtual server. (This applies to HTTP/SSL services and servers.)
*
*/
public Long get_totalrequests() throws Exception {
return this.totalrequests;
}
/**
*
* Number of requests in the surge queue.
*
*/
public Long get_surgecount() throws Exception {
return this.surgecount;
}
/**
*
* Rate (/s) counter for totalresponsebytes
*
*/
public Long get_responsebytesrate() throws Exception {
return this.responsebytesrate;
}
/**
*
* Number of responses received on this service or virtual server. (This applies to HTTP/SSL services and servers.)
*
*/
public Long get_totalresponses() throws Exception {
return this.totalresponses;
}
/**
*
* Rate (/s) counter for totalrequestbytes
*
*/
public Long get_requestbytesrate() throws Exception {
return this.requestbytesrate;
}
/**
*
* Number of current connections to the actual servers behind the virtual server.
*
*/
public Long get_cursrvrconnections() throws Exception {
return this.cursrvrconnections;
}
/**
*
* The IP address on which the service is running.
*
*/
public String get_primaryipaddress() throws Exception {
return this.primaryipaddress;
}
/**
*
* Rate (/s) counter for totalresponses
*
*/
public Long get_responsesrate() throws Exception {
return this.responsesrate;
}
/**
*
* Maximum open connections allowed on this service.
*
*/
public Long get_maxclients() throws Exception {
return this.maxclients;
}
/**
*
* Average TTFB between the NetScaler appliance and the server.TTFB is the time interval between sending the request packet to a service and receiving the first response from the service
*
*/
public Long get_avgsvrttfb() throws Exception {
return this.avgsvrttfb;
}
/**
*
* Total number of request bytes received on this service or virtual server.
*
*/
public Long get_totalrequestbytes() throws Exception {
return this.totalrequestbytes;
}
/**
*
* Number of requests in the idle queue/reuse pool.
*
*/
public Long get_curreusepool() throws Exception {
return this.curreusepool;
}
/**
*
* Current state of the server. Possible values are UP, DOWN, UNKNOWN, OFS(Out of Service), TROFS(Transition Out of Service), TROFS_DOWN(Down When going Out of Service)
*
*/
public String get_state() throws Exception {
return this.state;
}
/**
*
* Number of response bytes received by this service or virtual server.
*
*/
public Long get_totalresponsebytes() throws Exception {
return this.totalresponsebytes;
}
/**
*
* The port on which the service is running.
*
*/
public Integer get_primaryport() throws Exception {
return this.primaryport;
}
/**
*
* Rate (/s) counter for totalrequests
*
*/
public Long get_requestsrate() throws Exception {
return this.requestsrate;
}
/**
*
* 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{
servicegroupmember_response result = (servicegroupmember_response) service.get_payload_formatter().string_to_resource(servicegroupmember_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.servicegroupmember;
}
/**
*
* Returns the value of object identifier argument
*
*/
protected String get_object_name() {
return this.servicegroupname;
}
/**
* Use this API to fetch statistics of servicegroupmember_stats resource of the given information.
*/
public static servicegroupmember_stats get(nitro_service service, servicegroupmember_stats obj) throws Exception{
options option = new options();
option.set_args(nitro_util.object_to_string_withoutquotes(obj));
servicegroupmember_stats response = (servicegroupmember_stats) obj.stat_resource(service,option);
return response;
}
public static class clearstatsEnum {
public static final String basic = "basic";
public static final String full = "full";
}
}