com.mulesoft.mule.runtime.module.plugin.api.profiling

Class ProfilingPlugin

java.lang.Object

com.mulesoft.mule.runtime.module.plugin.api.profiling.ProfilingPlugin

All Implemented Interfaces:

DeploymentListenerProvider, MulePlugin, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

@Experimental
public abstract class ProfilingPlugin
extends Object
implements MulePlugin, DeploymentListenerProvider

By extending this class, a set of ProfilingDataConsumer can be registered through a server plugin. The declared data consumers will be discovered and registered by the runtime, and will consume data from all the deployed artifacts, including the ones deployed after its registration.

Since:

4.4.0

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
ProfilingPlugin()

Method Summary

Modifier and Type	Method and Description
void	dispose()
org.mule.runtime.module.deployment.api.DeploymentListener	getDeploymentListener()
abstract Set<org.mule.runtime.api.profiling.ProfilingDataConsumer<?>>	getProfilingDataConsumers() Declares the set of ProfilingDataConsumer that will be registered by the runtime.
void	initialise()
boolean	isDisabledOnEnvironment() Indicates when a plugin is disabled in the current execution environment to avoid being started.
void	setWorkingDirectory(File directory) Sets working directory for the plugin
void	start()
void	stop()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProfilingPlugin

public ProfilingPlugin()

Method Detail

getProfilingDataConsumers

public abstract Set<org.mule.runtime.api.profiling.ProfilingDataConsumer<?>> getProfilingDataConsumers()

Declares the set of ProfilingDataConsumer that will be registered by the runtime.

Returns:

A set of ProfilingDataConsumer

setWorkingDirectory

public void setWorkingDirectory(File directory)

Description copied from interface: MulePlugin

Sets working directory for the plugin

Specified by:

setWorkingDirectory in interface MulePlugin

Parameters:

directory - working directory no shared with other plugins. Not Null.

isDisabledOnEnvironment

public boolean isDisabledOnEnvironment()

Description copied from interface: MulePlugin

Indicates when a plugin is disabled in the current execution environment to avoid being started.

Specified by:

isDisabledOnEnvironment in interface MulePlugin

Returns:

true when disabled, false otherwise

getDeploymentListener

public org.mule.runtime.module.deployment.api.DeploymentListener getDeploymentListener()

Specified by:

getDeploymentListener in interface DeploymentListenerProvider

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Throws:

org.mule.runtime.api.exception.MuleException

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Throws:

org.mule.runtime.api.exception.MuleException