Index (DEVWRT-COL40-UJD API)

A B C D E G H I J M N O P Q R S T V W _
All Classes All Packages

A

AbstractSpawnable - Class in com.santaba.agent.groovyapi.expect.expectj: Base class for spawnables providing an AbstractSpawnable.onClose() method that should be called on close.
AbstractSpawnable() - Constructor for class com.santaba.agent.groovyapi.expect.expectj.AbstractSpawnable
array() - Method in class com.santaba.agent.groovyapi.common.JSONBuilder: Start a new JSONArray & current object is a JSONArray
array(String) - Method in class com.santaba.agent.groovyapi.common.JSONBuilder: Start a new JSONArray
avgRTT() - Method in class com.santaba.agent.groovyapi.ping.Ping.PingResult

B

before() - Method in class com.santaba.agent.groovyapi.expect.Expect: get the output between the current matched expect() and the previous matched expect()
before() - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Returns everything that has been received from the last matched expect to the current matched expect
body(String) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP GET on the provided url and return only the HTTP body
body(String, String, String) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP GET on the provided url and return only the HTTP body
build() - Method in class com.santaba.agent.groovyapi.snmp.Session.Builder

C

checkClientTrusted(X509Certificate[], String) - Method in class com.santaba.agent.groovyapi.http.Client.SBTrustManager
checkServerTrusted(X509Certificate[], String) - Method in class com.santaba.agent.groovyapi.http.Client.SBTrustManager
Client - Class in com.santaba.agent.groovyapi.http: Http client, represents only the most basic contract for HTTP request execution.
Client - Class in com.santaba.agent.groovyapi.jmx: This class provide jmx related functions.
Client(DefaultHttpClient) - Constructor for class com.santaba.agent.groovyapi.http.Client
Client.SBHostVerifier - Class in com.santaba.agent.groovyapi.http
Client.SBTrustManager - Class in com.santaba.agent.groovyapi.http
Client.Session - Class in com.santaba.agent.groovyapi.http
close() - Method in class com.santaba.agent.groovyapi.esx.ESX: close related resource.
close() - Method in class com.santaba.agent.groovyapi.expect.Expect: close this Expect session.
close() - Method in class com.santaba.agent.groovyapi.http.Client: Close the http client
close() - Method in class com.santaba.agent.groovyapi.snmp.Session: Close this session
com.santaba.agent.groovyapi.common - package com.santaba.agent.groovyapi.common
com.santaba.agent.groovyapi.esx - package com.santaba.agent.groovyapi.esx
com.santaba.agent.groovyapi.expect - package com.santaba.agent.groovyapi.expect
com.santaba.agent.groovyapi.expect.expectj - package com.santaba.agent.groovyapi.expect.expectj
com.santaba.agent.groovyapi.http - package com.santaba.agent.groovyapi.http
com.santaba.agent.groovyapi.jmx - package com.santaba.agent.groovyapi.jmx
com.santaba.agent.groovyapi.ping - package com.santaba.agent.groovyapi.ping
com.santaba.agent.groovyapi.snmp - package com.santaba.agent.groovyapi.snmp
com.santaba.agent.groovyapi.win32 - package com.santaba.agent.groovyapi.win32
createMOR(String, String) - Static method in class com.santaba.agent.groovyapi.esx.ESX: here we provide a simple method to create MOR object from a specified value and morType

D

DEFAULT_TLS - Static variable in class com.santaba.agent.groovyapi.http.Client
delete(String, String) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP DELETE to the provided url and return the entire response
delete(String, String, Map) - Method in class com.santaba.agent.groovyapi.http.Client: Get the http response by DELETE http method
delete(String, String, Map) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP DELETE to the provided url and return the entire response
delete(String, Map) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP DELETE to the provided url and return the entire response
DummyExpectedOutputHandler - Class in com.santaba.agent.groovyapi.expect.expectj: A dummy expected target output handler by ignore data read
DummyExpectedOutputHandler(String) - Constructor for class com.santaba.agent.groovyapi.expect.expectj.DummyExpectedOutputHandler: Create new DummyExpectedOutputHandler

E

endArray() - Method in class com.santaba.agent.groovyapi.common.JSONBuilder: mean current JSONArray is ended.
endObject() - Method in class com.santaba.agent.groovyapi.common.JSONBuilder: This should be show up in pair with object() This means
erase(String) - Method in class com.santaba.agent.groovyapi.http.Client.Session
ESX - Class in com.santaba.agent.groovyapi.esx: This class will help to collect esx related performance data.
Example:
ESX() - Constructor for class com.santaba.agent.groovyapi.esx.ESX
exec(String, int, int) - Static method in class com.santaba.agent.groovyapi.ping.Ping: execute a ping operation with hostname, pktsToSend and timeoutInMs provided
exec(InetAddress, int, int) - Static method in class com.santaba.agent.groovyapi.ping.Ping: execute a ping operation with address, pktsToSend and timeoutInMs provided
execute() - Method in interface com.santaba.agent.groovyapi.expect.expectj.Executor: Creates a new process.
Executor - Interface in com.santaba.agent.groovyapi.expect.expectj: This interface exists for people who want control over how processes are launched.
exitValue() - Method in class com.santaba.agent.groovyapi.expect.Expect
expect(String) - Method in class com.santaba.agent.groovyapi.expect.Expect: reads text from the connection until it finds a match in the provided regular expression
expect(String) - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Except pattern string on std out
expect(String[]) - Method in class com.santaba.agent.groovyapi.expect.Expect: reads text from the connection until it finds a match in the provided regular expressionS.
expect(String[]) - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Except pattern string on std out
expect(String[], int) - Method in class com.santaba.agent.groovyapi.expect.Expect: reads text from the connection until it finds a match in the provided regular expressions.
expect(String[], long) - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Except pattern string on std out
expect(String, int) - Method in class com.santaba.agent.groovyapi.expect.Expect: reads text from the connection until it finds a match in the provided regular expression
expect(String, int) - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Except pattern string on std out
expect(String, long) - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Except pattern string on std out
expect(String, long, int) - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Except pattern string on std out
Expect - Class in com.santaba.agent.groovyapi.expect: This class is provided for interaction with remote devices or communication with another process.
expectClose() - Method in class com.santaba.agent.groovyapi.expect.Expect: Wait until close, ignoring any output from stdout or stderr if exists
expectClose(long) - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn
expectClose(ExpectedOutputHandler) - Method in class com.santaba.agent.groovyapi.expect.Expect: Wait until close, ignoring any output from stderr if exists
expectClose(ExpectedOutputHandler, ExpectedOutputHandler) - Method in class com.santaba.agent.groovyapi.expect.Expect: Wait until close
expectClose(ExpectedOutputHandler, ExpectedOutputHandler) - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Wait the default timeout for the spawned process to finish.
expectClose(ExpectedOutputHandler, ExpectedOutputHandler, long) - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Wait for the spawned process to finish.
ExpectedOutputHandler - Interface in com.santaba.agent.groovyapi.expect: The expected target (remote host or executable) may produce output (e.g.
ExpectJ - Class in com.santaba.agent.groovyapi.expect.expectj: This class is the starting point of the ExpectJ Utility.
ExpectJ() - Constructor for class com.santaba.agent.groovyapi.expect.expectj.ExpectJ: Create a new ExpectJ with an infinite timeout.
ExpectJ(long) - Constructor for class com.santaba.agent.groovyapi.expect.expectj.ExpectJ: Create a new ExpectJ with specified timeout setting.
ExpectJException - Exception in com.santaba.agent.groovyapi.expect.expectj: This class extends the Exception class and encapsulates other exceptions.

G

get(String) - Method in class com.santaba.agent.groovyapi.http.Client: Get the http response on uri
get(String) - Method in class com.santaba.agent.groovyapi.http.Client.Session
get(String) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP GET on the provided url and return the entire HTTP response
get(String) - Method in class com.santaba.agent.groovyapi.snmp.Session: Get oid value
get(String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v1/v2c/v3.
the snmp related authentication information will be extracted from hostProps.
This will auto extract the snmp version from hostProps.
get(String, String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v1/v2c/v3.
the snmp related authentication information will be extracted from hostProps.
This will auto extract the snmp version from hostProps.
get(String, String, String) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP GET on the provided url and return the entire HTTP response
get(String, String, String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v1/v2c.
This api CAN'T be used to snmp v3 requests.
get(String, String, String, String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v1/v2c.
get(String, String, String, String, int, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v1/v2c.
get(String, String, String, Map) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP GET on the provided url and return the entire HTTP response
get(String, String, Map<String, String>) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v1/v2c/v3.
This provides another argument params to override the properties in the hostProps.
We will try to extract related informations from params first, if not found, try from hostProps.
This should be used only when the hostProps of the host is wrong.
get(String, String, Map<String, String>, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v1/v2c/v3.
This provides another argument params to override the properties in the hostProps.
We will try to extract related informations from params first, if not found, try from hostProps
This should be used only when the hostProps of the host is wrong.
get(String, Map) - Method in class com.santaba.agent.groovyapi.http.Client: Get the http response on uri with http headers
get(String, Map) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP GET on the provided url and return the entire HTTP response
getAcceptedIssuers() - Method in class com.santaba.agent.groovyapi.http.Client.SBTrustManager
getAllPerfs(ManagedObjectReference, Set<String>) - Method in class com.santaba.agent.groovyapi.esx.ESX: here the main get perf method provided - will get all instances perfs.
getChildren(String) - Method in class com.santaba.agent.groovyapi.jmx.Client: get the childrens under the path
getCounter(String) - Method in class com.santaba.agent.groovyapi.win32.PDHSession: Get a single counter from the given host with default timeout 30 seconds
getCounter(String, long) - Method in class com.santaba.agent.groovyapi.win32.PDHSession: Get a single counter from the given host with timeout
getCounter(String, String) - Static method in class com.santaba.agent.groovyapi.win32.PDH: Get a single counter from the given host
This will only apply to the host which is monitored by current collector.
getCounter(String, String, long) - Static method in class com.santaba.agent.groovyapi.win32.PDH: Get a single counter from the given host with timeout
This will only apply to the host which is monitored by current collector.
getCounters(String, List<String>) - Static method in class com.santaba.agent.groovyapi.win32.PDH: Get values for a list of counters from the given host
This will only apply to the host which is monitored by current collector.
getCounters(String, List<String>, long) - Static method in class com.santaba.agent.groovyapi.win32.PDH: Get values for a list of counters from the given host
This will only apply to the host which is monitored by current collector.
getCounters(List<String>) - Method in class com.santaba.agent.groovyapi.win32.PDHSession: Get values for a list of counters from the given host with default timeout 30 seconds
getCounters(List<String>, long) - Method in class com.santaba.agent.groovyapi.win32.PDHSession: Get values for a list of counters from the given host
getCounterToIdMap() - Method in class com.santaba.agent.groovyapi.esx.ESX: get the counter name to it's id map.
Example output:
mem.granted.average=65541 mem.swaptarget.minimum=65597
getCurrentStandardErrContents() - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Returns everything that has been received on the spawn's stderr during this session.
getCurrentStandardOutContents() - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Returns everything that has been received on the spawn's stdout during this session.
getDefaultClient() - Static method in class com.santaba.agent.groovyapi.http.Client: Create a default http client
getDiscover(String, long) - Method in class com.santaba.agent.groovyapi.win32.PDHSession: Get values for a list of category from the given host
getDiscover(String, String) - Static method in class com.santaba.agent.groovyapi.win32.PDH: Get a single counter from the given host
This will only apply to the host which is monitored by current collector.
getDiscover(String, String, long) - Static method in class com.santaba.agent.groovyapi.win32.PDH: Get a single counter from the given host with timeout
This will only apply to the host which is monitored by current collector.
getEnum(String, long) - Method in class com.santaba.agent.groovyapi.win32.PDHSession: Get values for a list of object from the given host
getEnum(String, String) - Static method in class com.santaba.agent.groovyapi.win32.PDH: Get a object from the given host
This will only apply to the host which is monitored by current collector.
getEnum(String, String, long) - Static method in class com.santaba.agent.groovyapi.win32.PDH: Get a object from the given host with timeout
This will only apply to the host which is monitored by current collector.
getExitValue() - Method in class com.santaba.agent.groovyapi.expect.expectj.ProcessSpawn: If the process representes by this object has already exited, it returns the exit code.
getExitValue() - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Retrieve the exit code of a finished process.
getExitValue() - Method in interface com.santaba.agent.groovyapi.expect.expectj.Spawnable: If the Spawn has exited, its exit code is returned.
getExitValue() - Method in class com.santaba.agent.groovyapi.expect.expectj.SshSpawn: Get exit value
getExitValue() - Method in class com.santaba.agent.groovyapi.expect.expectj.SshSpawn2: Get exit value
getHeader(String) - Method in class com.santaba.agent.groovyapi.http.Client: Get the http header from last http response
getHeaders() - Method in class com.santaba.agent.groovyapi.http.Client: Get the all http headers from last http response
getIdToCounterMap() - Method in class com.santaba.agent.groovyapi.esx.ESX: get the counter id to it's name map.
Example output:
65541=mem.granted.average 65597=mem.swaptarget.minimum
getLastHTTPResponse() - Method in class com.santaba.agent.groovyapi.http.Client: Get the last http response
getPerfs(ManagedObjectReference, Set<String>, String) - Method in class com.santaba.agent.groovyapi.esx.ESX: here the main get perf method provided Example output:
cpu.coreUtilization.maximum=4505.0 cpu.coreUtilization.average=4505.0
getRatioCounter(String) - Method in class com.santaba.agent.groovyapi.win32.PDHSession: Get values for a ratio counter from the given host with default timeout 30 seconds
getRatioCounter(String, long) - Method in class com.santaba.agent.groovyapi.win32.PDHSession: Get values for a list of ratio counters from the given host
getRatioCounter(String, String) - Static method in class com.santaba.agent.groovyapi.win32.PDH: Get a single ratio counter from the given host
This will only apply to the host which is monitored by current collector.
getRatioCounter(String, String, long) - Static method in class com.santaba.agent.groovyapi.win32.PDH: Get a single ratio counter from the given host
This will only apply to the host which is monitored by current collector.
getRatioCounters(String, List<String>) - Static method in class com.santaba.agent.groovyapi.win32.PDH: Get values for a list of ratio counters from the given host
This will only apply to the host which is monitored by current collector.
getRatioCounters(String, List<String>, long) - Static method in class com.santaba.agent.groovyapi.win32.PDH: Get values for a list of ratio counters from the given host
This will only apply to the host which is monitored by current collector.
getRatioCounters(List<String>) - Method in class com.santaba.agent.groovyapi.win32.PDHSession: Get values for a list of ratio counters from the given host with default timeout 30 seconds
getRatioCounters(List<String>, long) - Method in class com.santaba.agent.groovyapi.win32.PDHSession: Get values for a list of ratio counters from the given host
getResponseBody() - Method in class com.santaba.agent.groovyapi.http.Client: Get the http response body from last http response
getServiceInstance() - Method in class com.santaba.agent.groovyapi.esx.ESX: get the service instance object by this way, you can do more things
getStatusCode() - Method in class com.santaba.agent.groovyapi.http.Client: Get the last http response status code
getStderr() - Method in class com.santaba.agent.groovyapi.expect.expectj.ProcessSpawn
getStderr() - Method in interface com.santaba.agent.groovyapi.expect.expectj.Spawnable: Get a stream from which the Spawn's stderr can be read.
getStderr() - Method in class com.santaba.agent.groovyapi.expect.expectj.SshSpawn: Get the standard error input stream
getStderr() - Method in class com.santaba.agent.groovyapi.expect.expectj.SshSpawn2: Get the standard error input stream
getStdin() - Method in class com.santaba.agent.groovyapi.expect.expectj.ProcessSpawn
getStdin() - Method in interface com.santaba.agent.groovyapi.expect.expectj.Spawnable: Get a stream through which the Spawn's stdin can be written to.
getStdin() - Method in class com.santaba.agent.groovyapi.expect.expectj.SshSpawn: Get the standard in output stream
getStdin() - Method in class com.santaba.agent.groovyapi.expect.expectj.SshSpawn2: Get the standard in output stream
getStdout() - Method in class com.santaba.agent.groovyapi.expect.expectj.ProcessSpawn
getStdout() - Method in interface com.santaba.agent.groovyapi.expect.expectj.Spawnable: Get a stream from which the Spawn's stdout can be read.
getStdout() - Method in class com.santaba.agent.groovyapi.expect.expectj.SshSpawn: Get the standard out input stream
getStdout() - Method in class com.santaba.agent.groovyapi.expect.expectj.SshSpawn2: Get the standard out input stream
getTimeStatistics() - Method in class com.santaba.agent.groovyapi.http.Client: Get the connect time and read time
getV3(String, String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v3.
getV3(String, String, String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v3.
getV3(String, String, String, String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v3.
getV3(String, String, String, String, String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v3.
getV3(String, String, String, String, String, String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v3.
getV3(String, String, String, String, String, String, String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v3.
getV3(String, String, String, String, String, String, String, int, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v3.
getV3(String, String, String, String, String, String, String, int, int, String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: get an OID from a host by v3.
getValue(String) - Method in class com.santaba.agent.groovyapi.jmx.Client: get the value for a path

H

handle(ByteBuffer) - Method in interface com.santaba.agent.groovyapi.expect.ExpectedOutputHandler: Handle output
handle(ByteBuffer) - Method in class com.santaba.agent.groovyapi.expect.expectj.DummyExpectedOutputHandler: Handle output
headers(String) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP GET on the provided url and return only the HTTP headers
headers(String, String, String) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP GET on the provided url and return only the HTTP headers
HTTP - Class in com.santaba.agent.groovyapi.http: This class provides functions to do HTTP related operations.
HTTP() - Constructor for class com.santaba.agent.groovyapi.http.HTTP

I

interact() - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Allows the user to interact with the spawned process.
isClosed() - Method in class com.santaba.agent.groovyapi.expect.expectj.ProcessSpawn
isClosed() - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: This method can be use use to check the target process status before invoking Spawn.send(String)
isClosed() - Method in interface com.santaba.agent.groovyapi.expect.expectj.Spawnable: Find out whether the Spawn has finished.
isClosed() - Method in class com.santaba.agent.groovyapi.expect.expectj.SshSpawn: Whether if ssh spawn closed
isClosed() - Method in class com.santaba.agent.groovyapi.expect.expectj.SshSpawn2: Whether if ssh spawn closed
isReleased() - Method in class com.santaba.agent.groovyapi.esx.ESX: closed related resource.
isReleased() - Method in class com.santaba.agent.groovyapi.expect.Expect: Indicate the current object is released or not.
isReleased() - Method in class com.santaba.agent.groovyapi.http.Client: Resource interface
isReleased() - Method in class com.santaba.agent.groovyapi.jmx.Client: indicate the resource is released or not
no need to call manually.
isReleased() - Method in class com.santaba.agent.groovyapi.snmp.Session: Whether if this session is released
isReleased() - Method in class com.santaba.agent.groovyapi.win32.WinResource: Whether if this resource is released

J

JMX - Class in com.santaba.agent.groovyapi.jmx: A helper class to open jmx connections.
JMX() - Constructor for class com.santaba.agent.groovyapi.jmx.JMX
JSONBuilder - Class in com.santaba.agent.groovyapi.common: JSONBuilder for Groovy API
HOW TO USE IT.
1.
JSONBuilder() - Constructor for class com.santaba.agent.groovyapi.common.JSONBuilder: Root JSONObject
JSONBuilder(boolean, JSONBuilder) - Constructor for class com.santaba.agent.groovyapi.common.JSONBuilder
JSONBuilder(JSONBuilder) - Constructor for class com.santaba.agent.groovyapi.common.JSONBuilder: New an JSONObject Builder

M

matched() - Method in class com.santaba.agent.groovyapi.expect.Expect: get the current matched string
matched() - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Returns the current matched string
maxRTT - Variable in class com.santaba.agent.groovyapi.ping.Ping.PingResult
minRTT - Variable in class com.santaba.agent.groovyapi.ping.Ping.PingResult

N

newBuilder() - Static method in class com.santaba.agent.groovyapi.snmp.Session.Builder

O

object() - Method in class com.santaba.agent.groovyapi.common.JSONBuilder: Start new JSONObject in a JSONArray
object(String) - Method in class com.santaba.agent.groovyapi.common.JSONBuilder: Start a new JSONObject,
onClose() - Method in class com.santaba.agent.groovyapi.expect.expectj.AbstractSpawnable: Call the close listener if we have one.
onClose() - Method in interface com.santaba.agent.groovyapi.expect.expectj.Spawnable.CloseListener: Will be called when a Spawnable closes.
open(String) - Static method in class com.santaba.agent.groovyapi.expect.Expect: Start a new external process
open(String) - Static method in class com.santaba.agent.groovyapi.http.Client: Open a default http client to host, and the default port is 80
open(String) - Static method in class com.santaba.agent.groovyapi.http.SSLClient: Get ssl client on DEFAULT_HTTPS_PORT
open(String) - Static method in class com.santaba.agent.groovyapi.jmx.JMX: Deprecated.
open(String) - Static method in class com.santaba.agent.groovyapi.snmp.Session: Open snmp host
open(String) - Static method in class com.santaba.agent.groovyapi.win32.PDH: Deprecated.
open(String) - Static method in class com.santaba.agent.groovyapi.win32.WMI: Open a WMI session for given host.
Will try to extract wmi related credentials from hostProps.
This will only apply to the host which is monitored by current collector.
open(String, int) - Static method in class com.santaba.agent.groovyapi.expect.Expect: Start a new process
open(String, int) - Static method in class com.santaba.agent.groovyapi.http.Client: Open a default http client to host and port
open(String, int) - Static method in class com.santaba.agent.groovyapi.http.HTTP: instantiate a non-ssl HTTP session object for use across multiple HTTP transactions
Will try to extract http credentials from the related hostProps if existed
open(String, int) - Static method in class com.santaba.agent.groovyapi.http.SSLClient: Get ssl client
open(String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Session: Open snmp host
open(String, int, boolean) - Static method in class com.santaba.agent.groovyapi.http.HTTP: instantiate an HTTP session object for use across multiple HTTP transactions
Will try to extract http credentials from the related hostProps if existed
open(String, int, int) - Static method in class com.santaba.agent.groovyapi.expect.Expect: Start a telnet session for remote host
open(String, int, String) - Static method in class com.santaba.agent.groovyapi.http.Client: Open a http client to host and port with specific TLS version
open(String, int, String) - Static method in class com.santaba.agent.groovyapi.http.SSLClient: Get ssl client with specific TLS version
open(String, int, String, String) - Static method in class com.santaba.agent.groovyapi.http.Client: Open a default http client to host with credentials
open(String, int, String, String) - Static method in class com.santaba.agent.groovyapi.http.SSLClient: Get ssl client with credentials
open(String, int, String, String, int, String...) - Static method in class com.santaba.agent.groovyapi.expect.Expect: instantiate an SSH connection object to a remote CLI.
open(String, int, String, String, String) - Static method in class com.santaba.agent.groovyapi.http.Client: Open a http client to host with credentials and specific TLS version
open(String, int, String, String, String) - Static method in class com.santaba.agent.groovyapi.http.SSLClient: Get ssl client with credentials and specific TLS version
open(String, int, String, String, String...) - Static method in class com.santaba.agent.groovyapi.expect.Expect: instantiate an SSH connection object to a remote CLI.
open(String, long) - Static method in class com.santaba.agent.groovyapi.jmx.JMX: connect to a remote host by fully provided url with timeout param
open(String, String, int, String, Map, long) - Static method in class com.santaba.agent.groovyapi.jmx.Client
open(String, String, int, Map, long) - Static method in class com.santaba.agent.groovyapi.jmx.Client: connect to a remote host
open(String, String, int, Map, long) - Static method in class com.santaba.agent.groovyapi.jmx.JMX: connect to a remote host
open(String, String, String) - Method in class com.santaba.agent.groovyapi.esx.ESX: open a connection to a target host, we may provide another method without timeout param (with a default value, eg 10) use a default timeout 10 seconds
open(String, String, String) - Static method in class com.santaba.agent.groovyapi.http.Client: Open a default http client to host with credentials, and the default port is 80
open(String, String, String) - Static method in class com.santaba.agent.groovyapi.http.SSLClient: Get ssl client on DEFAULT_HTTPS_PORT with credentials
open(String, String, String) - Static method in class com.santaba.agent.groovyapi.jmx.JMX: Deprecated.
open(String, String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Session: Open snmp host
open(String, String, String) - Static method in class com.santaba.agent.groovyapi.win32.PDH: open a PDH session with username or password provided
open(String, String, String) - Static method in class com.santaba.agent.groovyapi.win32.WMI: Open a WMI session for given host with username and password provided
open(String, String, String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Session: Open snmp host
open(String, String, String, int, int) - Static method in class com.santaba.agent.groovyapi.snmp.Session: Open snmp host
open(String, String, String, int, String...) - Static method in class com.santaba.agent.groovyapi.expect.Expect: instantiate an SSH connection object to a remote CLI.
open(String, String, String, long) - Method in class com.santaba.agent.groovyapi.esx.ESX: open a connection to a target host, we may provide another method with timeout in seconds
open(String, String, String, long) - Static method in class com.santaba.agent.groovyapi.jmx.Client: connect to a remote host
open(String, String, String, long) - Static method in class com.santaba.agent.groovyapi.jmx.JMX: connect to a remote host with timeout
open(String, String, String, String) - Static method in class com.santaba.agent.groovyapi.win32.WMI: Open a WMI session for given host with username and password provided
open(String, String, String, String...) - Static method in class com.santaba.agent.groovyapi.expect.Expect: instantiate an SSH connection object to a remote CLI.
openV3(String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Session: Snmp v3 support on DEFAULT_TIMEOUT
openV3(String, String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Session: Snmp v3 support
openV3(String, String, String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Session: Snmp v3 support on DEFAULT_TIMEOUT
openV3(String, String, String, String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Session: Snmp v3 support on DEFAULT_TIMEOUT
openV3(String, String, String, String, String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Session: Snmp v3 support on DEFAULT_TIMEOUT
openV3(String, String, String, String, String, String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Session: Snmp v3 support on DEFAULT_SNMP_PORT
openV3(String, String, String, String, String, String, int, int) - Static method in class com.santaba.agent.groovyapi.snmp.Session: Snmp v3 support
openV3(String, String, String, String, String, String, int, int, String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Session

P

PDH - Class in com.santaba.agent.groovyapi.win32: This will provide PDH related operations.
PDH() - Constructor for class com.santaba.agent.groovyapi.win32.PDH
PDHSession - Class in com.santaba.agent.groovyapi.win32: A PDHSession indicates a connection to the remote host.
Ping - Class in com.santaba.agent.groovyapi.ping: A helper class to execute a ping operation.
As the java ping is not non-admin, there will use the sbproxy ping to implement it.
Ping() - Constructor for class com.santaba.agent.groovyapi.ping.Ping
Ping.PingResult - Class in com.santaba.agent.groovyapi.ping
PingResult(int) - Constructor for class com.santaba.agent.groovyapi.ping.Ping.PingResult
post(String, String) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP POST to the provided url and return the entire response
post(String, String, Map) - Method in class com.santaba.agent.groovyapi.http.Client: Get the http response by POST http method
post(String, String, Map) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP POST to the provided url and return the entire response
ProcessSpawn - Class in com.santaba.agent.groovyapi.expect.expectj: This class spawns a process that ExpectJ can control.
put(String) - Method in class com.santaba.agent.groovyapi.common.JSONBuilder: Put an value in a JSONArray
put(String, Object) - Method in class com.santaba.agent.groovyapi.common.JSONBuilder: Put an new key-value in a JSONObjet
put(String, String) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP PUT to the provided url and return the entire response
put(String, String, Map) - Method in class com.santaba.agent.groovyapi.http.Client: Get the http response by PUT http method
put(String, String, Map) - Static method in class com.santaba.agent.groovyapi.http.HTTP: do an HTTP PUT to the provided url and return the entire response

Q

queryAll(String, String) - Static method in class com.santaba.agent.groovyapi.win32.WMI: Query all the object returned by the WQL in CIMv2 namespace with default timeout This will only apply to the host which is monitored by current collector.
queryAll(String, String, long) - Static method in class com.santaba.agent.groovyapi.win32.WMI: Query all the object returned by the WQL in CIMv2 namespace with given timeout in seconds This will only apply to the host which is monitored by current collector.
queryAll(String, String, long) - Method in class com.santaba.agent.groovyapi.win32.WMISession: query all records
queryAll(String, String, String) - Static method in class com.santaba.agent.groovyapi.win32.WMI: Query all the object returned by the WQL in given namespace with default timeout
This will only apply to the host which is monitored by current collector.
queryAll(String, String, String, long) - Static method in class com.santaba.agent.groovyapi.win32.WMI: Query all the object returned by the WQL in given namespace with given timeout in seconds
This will only apply to the host which is monitored by current collector.
queryFirst(String, String) - Static method in class com.santaba.agent.groovyapi.win32.WMI: Query the first object returned by the WQL in CIMv2 namespace with default timeout
This will only apply to the host which is monitored by current collector.
queryFirst(String, String, long) - Static method in class com.santaba.agent.groovyapi.win32.WMI: Query the first object returned by the WQL in CIMv2 namespace with given timeout.
This will only apply to the host which is monitored by current collector.
queryFirst(String, String, long) - Method in class com.santaba.agent.groovyapi.win32.WMISession: query the first record
queryFirst(String, String, String) - Static method in class com.santaba.agent.groovyapi.win32.WMI: Query the first object returned by the WQL with default timeout
This will only apply to the host which is monitored by current collector.
queryFirst(String, String, String, long) - Static method in class com.santaba.agent.groovyapi.win32.WMI: Query the first object returned by the WQL with given timeout
This will only apply to the host which is monitored by current collector.

R

recdPkts - Variable in class com.santaba.agent.groovyapi.ping.Ping.PingResult
release() - Method in class com.santaba.agent.groovyapi.esx.ESX: close related resource.
release() - Method in class com.santaba.agent.groovyapi.expect.Expect: Try to release the resource of current object.
close this Expect session.
release() - Method in class com.santaba.agent.groovyapi.http.Client: Release the http client
release() - Method in class com.santaba.agent.groovyapi.jmx.Client: release related materials.
no need to call manually.
release() - Method in class com.santaba.agent.groovyapi.snmp.Session: Release this session
release() - Method in class com.santaba.agent.groovyapi.win32.WinResource: Release this resource
request(HttpRequestBase, String, String, Map) - Method in class com.santaba.agent.groovyapi.http.Client: Send http request and return the http response
RETRY_INTERVAL - Static variable in class com.santaba.agent.groovyapi.win32.PDHSession
rtts - Variable in class com.santaba.agent.groovyapi.ping.Ping.PingResult

S

SBHostVerifier() - Constructor for class com.santaba.agent.groovyapi.http.Client.SBHostVerifier
SBTrustManager() - Constructor for class com.santaba.agent.groovyapi.http.Client.SBTrustManager
send(String) - Method in class com.santaba.agent.groovyapi.expect.Expect: send a string to the Expect connection
send(String) - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: Writes a string to the standard input of the spawned process.
sendPkts - Variable in class com.santaba.agent.groovyapi.ping.Ping.PingResult
Session - Class in com.santaba.agent.groovyapi.snmp: Snmp session, include function such as: open, walk
Session() - Constructor for class com.santaba.agent.groovyapi.http.Client.Session
Session.Builder - Class in com.santaba.agent.groovyapi.snmp: A helper class to help to build the Session for snmp
set(String, Object) - Method in class com.santaba.agent.groovyapi.http.Client.Session
setAuthentication(String, String) - Method in class com.santaba.agent.groovyapi.http.Client: Set the authentication for get and post method
setCloseListener(Spawnable.CloseListener) - Method in class com.santaba.agent.groovyapi.expect.expectj.AbstractSpawnable: Set close listener
setCloseListener(Spawnable.CloseListener) - Method in interface com.santaba.agent.groovyapi.expect.expectj.Spawnable: Register a listener that will be called when this spawnable closes.
setConnectTimeout(int) - Method in class com.santaba.agent.groovyapi.http.Client: Set the connect timeout
setFollowRedirect(boolean) - Method in class com.santaba.agent.groovyapi.http.Client: Enable or disable to follow redirect
setHTTPProxy(String, int) - Method in class com.santaba.agent.groovyapi.http.Client: Set the http proxy without credentials
setHTTPProxy(String, int, String, String) - Method in class com.santaba.agent.groovyapi.http.Client: Set the http proxy with credentials, only support BASIC authentication method
setReadTimeout(int) - Method in class com.santaba.agent.groovyapi.http.Client: Set the read timeout
Snmp - Class in com.santaba.agent.groovyapi.snmp: This class Snmp is provided for SNMP related operations.
The most common operations are:
get an oid value walk an oid The default time out for the snmp related oprerations is snmp.pdu.timeout from agent.conf
Sometimes, the host related hostProps will be used automatically to extract snmp related properties: property name property note snmp.version indicate the snmp version for this host.
spawn(Channel) - Method in class com.santaba.agent.groovyapi.expect.expectj.ExpectJ: This method creates a spawn that controls an SSH connection.
spawn(Executor) - Method in class com.santaba.agent.groovyapi.expect.expectj.ExpectJ: This method spawns a new process.
spawn(Spawnable) - Method in class com.santaba.agent.groovyapi.expect.expectj.ExpectJ: This method launches a Spawnable.
spawn(String) - Method in class com.santaba.agent.groovyapi.expect.expectj.ExpectJ: This method spawns a new process.
spawn(String, int) - Method in class com.santaba.agent.groovyapi.expect.expectj.ExpectJ: This method spawns a telnet connection to the given host and port number.
spawn(String, int, String, String, String) - Method in class com.santaba.agent.groovyapi.expect.expectj.ExpectJ: This method creates a spawn that controls an SSH connection.
Spawn - Class in com.santaba.agent.groovyapi.expect.expectj: This class is used for talking to processes / ports.
Spawnable - Interface in com.santaba.agent.groovyapi.expect.expectj: Spawn interface, can use this interface manage Spawan object, obtain functions such as: start / stop, get stdout /stdin / stderr stream, and set close listener
Spawnable.CloseListener - Interface in com.santaba.agent.groovyapi.expect.expectj: Will be notified when a Spawnable closes.
SshSpawn - Class in com.santaba.agent.groovyapi.expect.expectj: A Spawnable for controlling an SSH session using ExpectJ/JsCH.
SshSpawn(Channel) - Constructor for class com.santaba.agent.groovyapi.expect.expectj.SshSpawn: Takes control over an existing SSH channel.
SshSpawn(String, int, String, String) - Constructor for class com.santaba.agent.groovyapi.expect.expectj.SshSpawn: Deprecated.
SshSpawn2 - Class in com.santaba.agent.groovyapi.expect.expectj: A Spawnable for controlling an SSH session using ExpectJ/SSHJ.
SshSpawn2(String, int, String, String) - Constructor for class com.santaba.agent.groovyapi.expect.expectj.SshSpawn2: Construct a new SSH spawn.
SSLClient - Class in com.santaba.agent.groovyapi.http: This class provides functions to do HTTPS related operations.
SSLClient(DefaultHttpClient) - Constructor for class com.santaba.agent.groovyapi.http.SSLClient
start() - Method in class com.santaba.agent.groovyapi.expect.expectj.ProcessSpawn: This method executes the given command within the specified time limit.
start() - Method in interface com.santaba.agent.groovyapi.expect.expectj.Spawnable: This method launches the Spawn.
start() - Method in class com.santaba.agent.groovyapi.expect.expectj.SshSpawn: Start ssh spawn
start() - Method in class com.santaba.agent.groovyapi.expect.expectj.SshSpawn2: Start ssh spawn
stderr() - Method in class com.santaba.agent.groovyapi.expect.Expect: get the standard error for current Expect session
stdout() - Method in class com.santaba.agent.groovyapi.expect.Expect: get the standard output for current Expect session
stop() - Method in class com.santaba.agent.groovyapi.expect.expectj.ProcessSpawn: This method stops the spawned process.
stop() - Method in class com.santaba.agent.groovyapi.expect.expectj.Spawn: This method kills the process represented by SpawnedProcess object.
stop() - Method in interface com.santaba.agent.groovyapi.expect.expectj.Spawnable: Stops a running Spawn.
stop() - Method in class com.santaba.agent.groovyapi.expect.expectj.SshSpawn: Stop the ssh spawn
stop() - Method in class com.santaba.agent.groovyapi.expect.expectj.SshSpawn2: Stop the ssh spawn
sumRTT - Variable in class com.santaba.agent.groovyapi.ping.Ping.PingResult

T

TimeoutException - Exception in com.santaba.agent.groovyapi.expect.expectj: Timeout while waiting for a Spawn.
toString() - Method in class com.santaba.agent.groovyapi.common.JSONBuilder
toString() - Method in class com.santaba.agent.groovyapi.expect.Expect
toString() - Method in interface com.santaba.agent.groovyapi.expect.expectj.Executor: Describes what Executor.execute() created.
toString() - Method in class com.santaba.agent.groovyapi.http.Client.SBHostVerifier
toString() - Method in class com.santaba.agent.groovyapi.http.Client
toString() - Method in class com.santaba.agent.groovyapi.http.SSLClient
toString() - Method in class com.santaba.agent.groovyapi.jmx.Client
toString() - Method in class com.santaba.agent.groovyapi.ping.Ping.PingResult
toString() - Method in class com.santaba.agent.groovyapi.snmp.Session
toString(int) - Method in class com.santaba.agent.groovyapi.common.JSONBuilder: Make a prettyprinted JSON text of this JSONArray.

V

verify(String, String[], String[]) - Method in class com.santaba.agent.groovyapi.http.Client.SBHostVerifier
verify(String, X509Certificate) - Method in class com.santaba.agent.groovyapi.http.Client.SBHostVerifier
verify(String, SSLSession) - Method in class com.santaba.agent.groovyapi.http.Client.SBHostVerifier
verify(String, SSLSocket) - Method in class com.santaba.agent.groovyapi.http.Client.SBHostVerifier

W

walk(String) - Method in class com.santaba.agent.groovyapi.snmp.Session: Get oid value list use walk
walk(String, long) - Method in class com.santaba.agent.groovyapi.snmp.Session: Get oid value list use walk
walk(String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v1/v2c/v3.
the snmp related authentication information will be extracted from hostProps.
This will auto extract the snmp version from hostProps.
walk(String, String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v1/v2c/v3.
the snmp related authentication information will be extracted from hostProps.
This will auto extract the snmp version from hostProps.
walk(String, String, String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v1/v2c.
This api CAN'T be used to snmp v3 requests.
walk(String, String, String, String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v1/v2c.
This api CAN'T be used to snmp v3 requests.
walk(String, String, String, String, int, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v1/v2c.
This api CAN'T be used to snmp v3 requests.
walk(String, String, Map<String, String>) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v1/v2c/v3.
This provides another argument params to override the properties in the hostProps.
We will try to extract related informations from params first, if not found, try from hostProps.
This should be used only when the hostProps of the host is wrong.
walk(String, String, Map<String, String>, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v1/v2c/v3.
This provides another argument params to override the properties in the hostProps.
We will try to extract related informations from params first, if not found, try from hostProps.
This should be used only when the hostProps of the host is wrong.
walkAsMap(String) - Method in class com.santaba.agent.groovyapi.snmp.Session: Get oid value map use walk
walkAsMap(String, long) - Method in class com.santaba.agent.groovyapi.snmp.Session: Get oid value map use walk
walkAsMap(String, String, Map<String, String>) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v1/v2c/v3.
This provides another argument params to override the properties in the hostProps.
We will try to extract related informations from params first, if not found, try from hostProps.
This should be used only when the hostProps of the host is wrong.
walkAsMap(String, String, Map<String, String>, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v1/v2c/v3.
This provides another argument params to override the properties in the hostProps.
We will try to extract related informations from params first, if not found, try from hostProps.
This should be used only when the hostProps of the host is wrong.
walkV3(String, String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v3.
The hostProps will NOT be used.
walkV3(String, String, String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v3.
The hostProps will NOT be used.
walkV3(String, String, String, String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v3.
The hostProps will NOT be used.
walkV3(String, String, String, String, String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v3.
The hostProps will NOT be used.
walkV3(String, String, String, String, String, String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v3.
The hostProps will NOT be used.
walkV3(String, String, String, String, String, String, String, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v3.
The hostProps will NOT be used.
walkV3(String, String, String, String, String, String, String, int, int) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v3.
The hostProps will NOT be used.
walkV3(String, String, String, String, String, String, String, int, int, String, String) - Static method in class com.santaba.agent.groovyapi.snmp.Snmp: walk an OID from a host by v3.
The hostProps will NOT be used.
WinResource - Class in com.santaba.agent.groovyapi.win32: Windows WMI resource, obtain function such as: getPDHCredential, getWMICredential User: ning.chen Date: 7/28/15 To change this template use File | Settings | File Templates.
WinResource() - Constructor for class com.santaba.agent.groovyapi.win32.WinResource: Create new WinResource
withAuthProtocol(String) - Method in class com.santaba.agent.groovyapi.snmp.Session.Builder
withAuthToken(String) - Method in class com.santaba.agent.groovyapi.snmp.Session.Builder
withCommunity(String) - Method in class com.santaba.agent.groovyapi.snmp.Session.Builder
withContextEngineId(String) - Method in class com.santaba.agent.groovyapi.snmp.Session.Builder
withContextName(String) - Method in class com.santaba.agent.groovyapi.snmp.Session.Builder
withHost(String) - Method in class com.santaba.agent.groovyapi.snmp.Session.Builder
withPort(int) - Method in class com.santaba.agent.groovyapi.snmp.Session.Builder
withPrivProtocol(String) - Method in class com.santaba.agent.groovyapi.snmp.Session.Builder
withPrivToken(String) - Method in class com.santaba.agent.groovyapi.snmp.Session.Builder
withProps(Map<String, String>) - Method in class com.santaba.agent.groovyapi.snmp.Session.Builder: inject more properties
withSecurity(String) - Method in class com.santaba.agent.groovyapi.snmp.Session.Builder
withTimeoutMills(int) - Method in class com.santaba.agent.groovyapi.snmp.Session.Builder
withVersion(String) - Method in class com.santaba.agent.groovyapi.snmp.Session.Builder
WMI - Class in com.santaba.agent.groovyapi.win32: This class help to collect wmi perf data.
We will try to extract wmi related credentials from the hostProps if existed.
The following properties may be used:
property name property note wmi.user / wmiuser the username for wmi requests wmi.pass / wmipass the password for wmi requests
Example:
WMI() - Constructor for class com.santaba.agent.groovyapi.win32.WMI
WMISession - Class in com.santaba.agent.groovyapi.win32: A WMI session indicates a connection to the remote host.
This object support to get pdh data from hosts which were not monitored by current collector.

_

_createHTTPClient(HttpHost, String) - Static method in class com.santaba.agent.groovyapi.http.Client
_DEFAULT_TIMEOUT - Static variable in class com.santaba.agent.groovyapi.win32.PDHSession

A B C D E G H I J M N O P Q R S T V W _
All Classes All Packages