org.systinet.wasp.mgmt
Interface ServiceMonitoring

All Known Subinterfaces:

AdminService

public interface ServiceMonitoring

This interface represents component which is able to control of throughput and performance monitoring for specified service endpoint.

Since:

4.5

Component:

Mgmt-Services

Method Summary

ServiceEndpointThroughputLog	dataThroughputControl(ServiceEndpoint serviceEndpoint, int controlOperation) Control service endpoint data throughput monitor.
boolean	debugControl(ServiceEndpoint serviceEndpoint, int controlOperation) Control service endpoint debugging.
ServiceEndpointPerformanceLog	performanceControl(ServiceEndpoint serviceEndpoint, int controlOperation) Control service endpoint performance monitor.

Method Detail

debugControl

public boolean debugControl(ServiceEndpoint serviceEndpoint,
                            int controlOperation)
                     throws AdminServiceException

Control service endpoint debugging.

Activate and deactivate the tracing of incoming and outgoing SOAP messages, per service endpoint. You can also get and clean the log using this method. The tracing log is shared by Web services that come from the same package. Once a Web service's message tracing is enabled, the log is stored in a file named debug.txt in the package root directory. The log may be accessed directly, using this method; from the administration console or by accessing the service endpoint by pointing a web browser to http://yourhost:yourport/waspcontext/yourservice?debug. For an example of this access, point your browser to http://localhost:6060/util/wsdiscovery?debug

Parameters:

serviceEndpoint - target service endpoint.

controlOperation - may be one of the following:

• ENABLE: enable debugging.
  Secure mode: you must have WSMonitoringPermission/enable permission for target service endpoint to perform this operation.
• DISABLE: disable debugging.
  Secure mode: you must have WSMonitoringPermission/disable permission for target service endpoint to perform this operation.
• GET: determine whether endpoint is debugged.
  Secure mode: you must have WSMonitoringPermission/get permission for target service endpoint to perform this operation.
• CLEAN: clean debug log.
  Secure mode: you must have WSMonitoringPermission/clean permission for target service endpoint to perform this operation.

Returns:

true if service endpoint is debugged, else it returns false.

Throws:

AdminServiceException

See Also:

ControlOperations

dataThroughputControl

public ServiceEndpointThroughputLog dataThroughputControl(ServiceEndpoint serviceEndpoint,
                                                          int controlOperation)
                                                   throws AdminServiceException

Control service endpoint data throughput monitor.

Activate and deactivate the data throughput monitor and access the log. The log includes total in/out throughput, last request in/out throughput, average per request in/out throughput and number of hits for a service endpoint.

Changes made using this method are transient. It is lost on server reboot. To make the use of the throughput monitor permanent, you must store the interceptor chain for the service endpoint using the ServiceAdministration.interceptorControl(org.systinet.wasp.admin.ServiceEndpoint, int, org.systinet.wasp.admin.InterceptorInfo) method.

Parameters:

serviceEndpoint - target service endpoint.

controlOperation - may be one of the following:

• RESET: reset values for this service endpoint monitor.
  Secure mode: you must have WSMonitoringPermission/clean permission for target service endpoint to perform this operation.
• GET: get the service endpoint monitor log.
  Secure mode: you must have WSMonitoringPermission/get permission for target service endpoint to perform this operation.
• ADD: install data monitor for this service endpoint.
  Secure mode: you must have WSMonitoringPermission/set permission for target service endpoint to perform this operation.
• REMOVE: remove service endpoint monitor.
  Secure mode: you must have WSMonitoringPermission/set permission for target service endpoint to perform this operation.

Returns:

On GET operation returns log for the service endpoint, else returns null.

Throws:

AdminServiceException

See Also:

ServiceEndpointThroughputLog, ControlOperations

performanceControl

public ServiceEndpointPerformanceLog performanceControl(ServiceEndpoint serviceEndpoint,
                                                        int controlOperation)
                                                 throws AdminServiceException

Control service endpoint performance monitor.

Activate and deactivate the endpoint performance monitor and access the log. The log includes the fastest, slowest, average, last request and total dispatch time as well as the number of requests.

Changes made using this method are transient. To make the use of the throughput monitor permanent, you must store the interceptor chain for the service endpoint using the ServiceAdministration.interceptorControl(org.systinet.wasp.admin.ServiceEndpoint, int, org.systinet.wasp.admin.InterceptorInfo) method.

The monitoring log is not persistently stored. It is lost on server reboot.

If the WSO2 SOA Enablement Server is running in secure mode, then methods provided by this interface are protected by authorization.

Parameters:

serviceEndpoint - target service endpoint.

controlOperation - may be one of the following:

• RESET: reset the values for this service endpoint performance monitor.
  Secure mode: you must have WSMonitoringPermission/clean permission for target service endpoint to perform this operation.
• GET: get the performance monitor log.
  Secure mode: you must have WSMonitoringPermission/get permission for target service endpoint to perform this operation.
• ADD: install the performance monitor for this endpoint.
  Secure mode: you must have WSMonitoringPermission/set permission for target service endpoint to perform this operation.
• REMOVE: remove the performance monitor for this endpoint.
  Secure mode: you must have WSMonitoringPermission/set permission for target service endpoint to perform this operation.

Returns:

On GET operation returns performance log for the service endpoint, else returns null.

Throws:

AdminServiceException

See Also:

ServiceEndpointPerformanceLog, ControlOperations