org.mule.runtime.deployment.model.api

Interface DeployableArtifact<D extends DeployableArtifactDescriptor>

Type Parameters:

D - The type of the artifact's descriptor

All Superinterfaces:

Artifact<D>

All Known Subinterfaces:

Application, Domain

@NoImplement
public interface DeployableArtifact<D extends DeployableArtifactDescriptor>
extends Artifact<D>

An Artifact is an abstract representation of a deployable unit within the mule container.

Method Summary

Modifier and Type	Method and Description
void	dispose() Dispose the artifact.
List<ArtifactPlugin>	getArtifactPlugins()
org.mule.runtime.api.connectivity.ConnectivityTestingService	getConnectivityTestingService() Do not use this method if the artifact initialization wasn't successful or the artifact has been destroyed.
D	getDescriptor()
File	getLocation()
org.mule.runtime.api.metadata.MetadataService	getMetadataService() Do not use this method if the artifact initialization wasn't successful or the artifact has been destroyed.
org.mule.runtime.api.artifact.Registry	getRegistry() Do not use this method if the artifact initialization wasn't successful or the artifact has been destroyed.
org.mule.runtime.api.value.ValueProviderService	getValueProviderService() Do not use this method if the artifact initialization wasn't successful or the artifact has been destroyed.
void	init() Initialise the artifact resources
void	install() Install the artifact.
void	lazyInit() Initialise the minimal resources required for this artifact to execute components.
void	lazyInit(boolean disableXmlValidations) Initialise the minimal resources required for this artifact to execute components.
void	setMuleContextListener(MuleContextListener muleContextListener) Sets a MuleContextListener.
void	start() Starts the artifact execution
void	stop() Stops the artifact execution

Methods inherited from interface org.mule.runtime.module.artifact.api.Artifact

getArtifactClassLoader, getArtifactId, getArtifactName, getResourceFiles

Method Detail

install

void install()
      throws InstallException

Install the artifact. Most commonly this includes the creation of the class loader and validation of resources.

Throws:

InstallException

init

void init()

Initialise the artifact resources

lazyInit

void lazyInit()

Initialise the minimal resources required for this artifact to execute components. By default XML validations will not be applied when doing lazy initialization. If needed use lazyInit(boolean).

lazyInit

void lazyInit(boolean disableXmlValidations)

Initialise the minimal resources required for this artifact to execute components.

Parameters:

disableXmlValidations - true validations when parsing the XML will happen, otherwise false.

start

void start()
    throws DeploymentStartException

Starts the artifact execution

Throws:

DeploymentStartException

stop

void stop()

Stops the artifact execution

getDescriptor

D getDescriptor()

Specified by:

getDescriptor in interface Artifact<D extends DeployableArtifactDescriptor>

Returns:

the artifact descriptor

dispose

void dispose()

Dispose the artifact. Most commonly this includes the release of the resources held by the artifact

getRegistry

org.mule.runtime.api.artifact.Registry getRegistry()

Do not use this method if the artifact initialization wasn't successful or the artifact has been destroyed.

Returns:

the registry of the artifact.

getLocation

File getLocation()

Returns:

the directory where the artifact content is stored.

getConnectivityTestingService

org.mule.runtime.api.connectivity.ConnectivityTestingService getConnectivityTestingService()

Do not use this method if the artifact initialization wasn't successful or the artifact has been destroyed.

Returns:

a service to test connection over configuration components.

getMetadataService

org.mule.runtime.api.metadata.MetadataService getMetadataService()

Do not use this method if the artifact initialization wasn't successful or the artifact has been destroyed.

Returns:

the MetadataService which can resolve the metadata of the components inside the current DeployableArtifact

See Also:

MetadataService

getValueProviderService

org.mule.runtime.api.value.ValueProviderService getValueProviderService()

Do not use this method if the artifact initialization wasn't successful or the artifact has been destroyed.

Returns:

the ValueProviderService which can resolve possible values for a component configuration.

getArtifactPlugins

List<ArtifactPlugin> getArtifactPlugins()

Returns:

the plugins that are owned by the deployable artifact. Non null

setMuleContextListener

void setMuleContextListener(MuleContextListener muleContextListener)

Sets a MuleContextListener.

Parameters:

muleContextListener - MuleContextListener to be set for this deployable artifact.