oracle.bpel.services.workflow.diagnostics
Interface IDiagnosticService

public interface IDiagnosticService

Since:

release specific (what release of product did this appear in)

Nested Class Summary

static class

IDiagnosticService.ServicesEnum Enumeration that lists all the workflow services which getDiagnostics() funtion supports.

Field Summary

static java.lang.String	CALL_FREQUENCY_REPORT_PROPERTY_NAME
static java.lang.String	CLEAR_FULL_SESSION_CACHE
static java.lang.String	HWF_API_REPORT_PROPERTY_NAME
static java.lang.String	PERFORMANCE_COLLECTION_PROPERTY_NAME

Method Summary

HWFServicesDiagnostics

getDiagnostics(IWorkflowContext adminCtx, IDiagnosticService.ServicesEnum svc, DiagnosticParameters diagParams) Diagnostic function checks the health of various workflow services, returns diagnostics in form of HWFServicesDiagnostics objects.

Field Detail

PERFORMANCE_COLLECTION_PROPERTY_NAME

static final java.lang.String PERFORMANCE_COLLECTION_PROPERTY_NAME

See Also:

Constant Field Values

CALL_FREQUENCY_REPORT_PROPERTY_NAME

static final java.lang.String CALL_FREQUENCY_REPORT_PROPERTY_NAME

See Also:

Constant Field Values

HWF_API_REPORT_PROPERTY_NAME

static final java.lang.String HWF_API_REPORT_PROPERTY_NAME

See Also:

Constant Field Values

CLEAR_FULL_SESSION_CACHE

static final java.lang.String CLEAR_FULL_SESSION_CACHE

See Also:

Constant Field Values

Method Detail

getDiagnostics

HWFServicesDiagnostics getDiagnostics(IWorkflowContext adminCtx,
                                      IDiagnosticService.ServicesEnum svc,
                                      DiagnosticParameters diagParams)
                                      throws WorkflowException

Diagnostic function checks the health of various workflow services, returns diagnostics in form of HWFServicesDiagnostics objects.

Parameters:

adminCtx - an authenticated IWorkflowContext. used to determine appropraite Locale for user-readable labels.

svc - is a Enumeration for type of services that need to run Diagnostic function like IDENTITY, NOTIFICATION , ALL etc. The value of the parameter decides getDiagnostics() is called for which particular service. If the value of serviceEnum is ALL getDiagnostics() function is called for all the services in the serviceEnum.

Returns:

HWFServicesDiagnostics object.

Throws:

WorkflowException - if some error condition occurs.