org.mule.runtime.module.troubleshooting.api

Interface TroubleshootingService

All Known Implementing Classes:

DefaultTroubleshootingService

@NoImplement
 @Experimental
public interface TroubleshootingService

A container level object that can be used to execute troubleshooting related operations.

Since:

4.5

Method Summary

Modifier and Type	Method and Description
Object	executeOperation(String name, Map<String,String> arguments) Invokes an operation with the given parameters.
List<TroubleshootingOperationDefinition>	getAvailableOperations() Gets the available operation definitions.
void	registerOperation(TroubleshootingOperation operation) Registers a new TroubleshootingOperation.
void	unregisterOperation(String name) Unregisters a new TroubleshootingOperation.

Method Detail

getAvailableOperations

List<TroubleshootingOperationDefinition> getAvailableOperations()

Gets the available operation definitions. User should retrieve these definitions to know what are the possible parameters for executeOperation(String, Map).

Returns:

the available operation definitions.

executeOperation

Object executeOperation(String name,
                        Map<String,String> arguments)
                 throws TroubleshootingOperationException

Invokes an operation with the given parameters. User must respect the definitions retrieved with getAvailableOperations()

Parameters:

name - The name of the operation to execute.

arguments - A dictionary with the arguments.

Returns:

the return value of the operation.

Throws:

TroubleshootingOperationException - if it couldn't execute the operation because it wasn't available or there is an error in the arguments.

registerOperation

void registerOperation(TroubleshootingOperation operation)

Registers a new TroubleshootingOperation.

Parameters:

operation - the operation to be registered.

unregisterOperation

void unregisterOperation(String name)

Unregisters a new TroubleshootingOperation.

Parameters:

name - the name of the operation to be registered.