org.mule.runtime.extension.api.runtime.source

Class Source<Payload,A extends org.mule.runtime.api.message.Attributes>

java.lang.Object

org.mule.runtime.extension.api.runtime.source.Source<Payload,A>

Type Parameters:

Payload - the generic type for the generated message's payload

A - the generic type for the generated message's attributes

public abstract class Source<Payload,A extends org.mule.runtime.api.message.Attributes>
extends Object

Base class to write message sources compliant with a given SourceModel.

This class acts as an adapter between the extensions API representation of a message source and Mule's actual MessageSource concept.

The source is configured through a SourceContext which is set using the setSourceContext(SourceContext) method. Implementations can access the set value through the sourceContext field.

This class relies on generics to specify the payload and attribute types that the source is going to generate. Although the java compiler does allow for raw uses of the class, this API forbids that since those generics are needed for metadata purposes. For the case of Sources which don't generate a response, the Payload is to be assigned to Void.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected SourceContext<Payload,A>	sourceContext The configured SourceContext.

Constructor Summary

Constructors

Constructor and Description
Source()

Method Summary

Modifier and Type	Method and Description
void	setSourceContext(SourceContext<Payload,A> sourceContext) Configures this instances with sourceContext.
abstract void	start()
abstract void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

sourceContext

protected SourceContext<Payload,A extends org.mule.runtime.api.message.Attributes> sourceContext

The configured SourceContext. The platform is to have set this through the setSourceContext(SourceContext) method before start() is to be invoked

Constructor Detail

Source

public Source()

Method Detail

start

public abstract void start()
                    throws Exception

Throws:

Exception

stop

public abstract void stop()
                   throws Exception

Throws:

Exception

setSourceContext

public void setSourceContext(SourceContext<Payload,A> sourceContext)

Configures this instances with sourceContext. This method should only be used by the runtime, which also guarantees to have used it before start() is invoked

Parameters:

sourceContext - a SourceContext