com.wily.introscope.server.webservicesapi.metricslist
Class MetricsListServiceSoapBindingStub

java.lang.Object
  extended by org.apache.axis.client.Stub
      extended by com.wily.introscope.server.webservicesapi.metricslist.MetricsListServiceSoapBindingStub
All Implemented Interfaces:
IMetricsListService, javax.xml.rpc.Stub

public class MetricsListServiceSoapBindingStub
extends org.apache.axis.client.Stub
implements IMetricsListService


Field Summary
 
Fields inherited from class org.apache.axis.client.Stub
_call, cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service
 
Fields inherited from interface javax.xml.rpc.Stub
ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY
 
Constructor Summary
MetricsListServiceSoapBindingStub()
           
MetricsListServiceSoapBindingStub(javax.xml.rpc.Service service)
           
MetricsListServiceSoapBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service)
           
 
Method Summary
protected  org.apache.axis.client.Call createCall()
           
 java.lang.String[] listAgents(java.lang.String agentRegex)
          Lists names of all agents matching a specified regular expression.
 MetricPath[] listMetricPaths(java.lang.String agentRegex, java.lang.String metricPrefix, boolean recursive)
          Lists all metric paths that are subnodes of a specified metric path prefix, for all matching agents.
 Metric[] listMetrics(java.lang.String agentRegex, java.lang.String metricRegex)
          Lists all metrics that match a regular expression.
 Metric[] listMetricsForMetricPath(java.lang.String agentRegex, java.lang.String metricPath)
          Lists all metrics for a metric path.
 
Methods inherited from class org.apache.axis.client.Stub
_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MetricsListServiceSoapBindingStub

public MetricsListServiceSoapBindingStub()
                                  throws org.apache.axis.AxisFault
Throws:
org.apache.axis.AxisFault

MetricsListServiceSoapBindingStub

public MetricsListServiceSoapBindingStub(java.net.URL endpointURL,
                                         javax.xml.rpc.Service service)
                                  throws org.apache.axis.AxisFault
Throws:
org.apache.axis.AxisFault

MetricsListServiceSoapBindingStub

public MetricsListServiceSoapBindingStub(javax.xml.rpc.Service service)
                                  throws org.apache.axis.AxisFault
Throws:
org.apache.axis.AxisFault
Method Detail

createCall

protected org.apache.axis.client.Call createCall()
                                          throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

listAgents

public java.lang.String[] listAgents(java.lang.String agentRegex)
                              throws java.rmi.RemoteException,
                                     IntroscopeWebServicesException
Description copied from interface: IMetricsListService
Lists names of all agents matching a specified regular expression.

Specified by:
listAgents in interface IMetricsListService
Parameters:
agentRegex - The agent regular expression.
Returns:
Array of Agent Name strings
Throws:
java.rmi.RemoteException
IntroscopeWebServicesException

listMetricPaths

public MetricPath[] listMetricPaths(java.lang.String agentRegex,
                                    java.lang.String metricPrefix,
                                    boolean recursive)
                             throws java.rmi.RemoteException,
                                    IntroscopeWebServicesException
Description copied from interface: IMetricsListService
Lists all metric paths that are subnodes of a specified metric path prefix, for all matching agents. For example, consider the following metric tree segment
      EJB
                Session
                TradingBean
                        Average Response Time (ms)
                        Responses Per Interval
                AccountBean
                        Average Response Time (ms)
                        Responses Per Interval
 

If you query with metric prefic "EJB", the metric path "EJB|Session" will be returned. If you choose the recursive option, metric paths "EJB|Session", "EJB|Session|TradingBean" and "EJB|Session|AccountBean" will be returned.

Note: You have to be careful when using the recursive option. It can cause significant slowdown on the Enterprise Manager and can cause OutOfMemory errors both on the EM and your web services client code.

Specified by:
listMetricPaths in interface IMetricsListService
Parameters:
agentRegex - The agent regular expression. You can also specify the exact name of a single agent here.
metricPrefix - The specified metric path prefix
recursive - Recursive option
Returns:
Array of Metric paths (paired with Agent Names)
Throws:
java.rmi.RemoteException
IntroscopeWebServicesException

listMetricsForMetricPath

public Metric[] listMetricsForMetricPath(java.lang.String agentRegex,
                                         java.lang.String metricPath)
                                  throws java.rmi.RemoteException,
                                         IntroscopeWebServicesException
Description copied from interface: IMetricsListService
Lists all metrics for a metric path. For example, consider the following metric tree segment
     EJB
                Session
                TradingBean
                        Average Response Time (ms)
                        Responses Per Interval
                AccountBean
                        Average Response Time (ms)
                        Responses Per Interval
 

If you query for metric prefix "EJB|Session|TradingBean", metrics "EJB|Session|TradingBean:Average Response Time (ms)" and "EJB|Session|TradingBean:Responses Per Interval" will be returned. If you query for metric prefix "EJB", no metrics will be returned.

Specified by:
listMetricsForMetricPath in interface IMetricsListService
Parameters:
agentRegex - The agent regular expression. You can also specify the exact name of a single agent here.
metricPath - The specified metric path
Returns:
Array of Metrics
Throws:
java.rmi.RemoteException
IntroscopeWebServicesException

listMetrics

public Metric[] listMetrics(java.lang.String agentRegex,
                            java.lang.String metricRegex)
                     throws java.rmi.RemoteException,
                            IntroscopeWebServicesException
Description copied from interface: IMetricsListService
Lists all metrics that match a regular expression.

Note: You have to be careful when specifying a very generic regular expression. It can cause significant slowdown on the Enterprise Manager and can cause OutOfMemory errors both on the EM and your web services client code.

Specified by:
listMetrics in interface IMetricsListService
Parameters:
agentRegex - The agent regular expression.
metricRegex - The metric regular expression.
Returns:
Array of Metrics
Throws:
java.rmi.RemoteException
IntroscopeWebServicesException


Copyright © 2007 CA Inc. All Rights Reserved.