|
CICS® Transaction Gateway Programming Reference v1.1.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.ctg.client.stats.GatewayConnection
public class GatewayConnection
The GatewayConnection is used to retrieve statistical information from a CICS Transaction Gateway instance. Access to the statistics can be gained through the use of the ctgstats.jar package.
The StatsGateway will connect to the CICS Transaction Gateway server on the local machine using the default port (2980), unless set on the constructor.
Constructor Summary | |
---|---|
GatewayConnection()
Constructs a GatewayConnection object and opens a connection to the CICS Transaction Gateway on the default statistics port. |
|
GatewayConnection(int port)
Constructs a GatewayConnection object and opens a connection to the CICS Transaction Gateway using the specified port. |
|
GatewayConnection(java.lang.String address,
int port)
Constructs a GatewayConnection object and opens a connection to the CICS Transaction Gateway using the specified IP address and port. |
Method Summary | |
---|---|
void |
close()
Closes a connection to a Gateway daemon. |
java.lang.String |
getAddress()
Gets the address for the Gateway daemon that this GatewayConnection will associate. |
int |
getPort()
Gets the port that this GatewayConnection is connected to. |
IdResultSet |
getResourceGroupIds()
Returns an IdResultSet of IdData objects representing the set of all the resource group IDs available from the Gateway daemon. |
IdResultSet |
getStatIds()
Returns an IdResultSet containing a set of IdData objects that represent all available statistic IDs. |
IdResultSet |
getStatIds(java.lang.String ids)
Returns an IdResultSet containing a set of IdData objects representing the statistic IDs that match the supplied query string "ids". |
StatResultSet |
getStats()
Returns a StatResultSet containing a set of StatData objects that represents all available statistics. |
StatResultSet |
getStats(java.lang.String ids)
Returns a StatResultSet containing a set of StatData objects representing the statistics that match the supplied query string "ids". |
java.lang.String |
getStatsAPIVersion()
Get the Statistics API version. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GatewayConnection() throws java.io.IOException
java.io.IOException
- If an error occurs when opening the connectionpublic GatewayConnection(int port) throws java.io.IOException
port
- The statistics port to connect to
java.io.IOException
- If an error occurs when opening the connectionpublic GatewayConnection(java.lang.String address, int port) throws java.io.IOException
address
- The hostname or IP address of the Gateway daemonport
- The statistics port to connect to
java.io.IOException
- If an error occurs when opening the connectionMethod Detail |
---|
public IdResultSet getResourceGroupIds() throws java.io.IOException
java.io.IOException
- If an error occurs when using the connectionpublic IdResultSet getStatIds(java.lang.String ids) throws java.io.IOException
ids
- The query string is a colon-separated list of statistics
group IDs (such as resource group IDs). For example, a query string of
"GD:PH" returns the set of all statistic IDs in the Gateway Daemon
(GD) and Protocol Handler (PH) resource groups. If the query string is
the empty string the returned IdResultSet is the same as that for
getStatIds().
java.io.IOException
public IdResultSet getStatIds() throws java.io.IOException
java.io.IOException
public StatResultSet getStats(java.lang.String ids) throws java.io.IOException
ids
- The query string is a colon-separated list of statistics
group IDs (such as resource group IDs) or specific statistic IDs. The
query string might contain both resource group IDs and statistic IDs.
If the query string is the empty string the IdResultSet returned is the
same as that for getStatIds(). For example, a query string of "GD:PH:CS_LLIST"
returns a StatResultSet that contains the set of all statistical
values in the Gateway Daemon (GD), the Protocol Handler (PH) resource
groups, and the CS_LLIST statistic.
java.io.IOException
public StatResultSet getStats() throws java.io.IOException
java.io.IOException
public void close()
java.io.IOException
- If an error occurs when closing the connectionpublic java.lang.String getAddress()
public int getPort()
public java.lang.String getStatsAPIVersion()
|
©Copyright IBM Corp. 1994, 2014 Legal |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |