org.mule.module.http.api.listener

Interface HttpListener

All Superinterfaces:

Disposable, Initialisable, Lifecycle, MessageSource, NonBlockingMessageSource, Startable, Stoppable

All Known Implementing Classes:

DefaultHttpListener

public interface HttpListener
extends NonBlockingMessageSource, Lifecycle

Represents an listener for HTTP requests.

Field Summary

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

PHASE_NAME

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

PHASE_NAME

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

PHASE_NAME

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

PHASE_NAME

Method Summary

Modifier and Type	Method and Description
void	dispose() Get rid of this listener.
String[]	getAllowedMethods()
HttpListenerConfig	getConfig()
String	getPath()
void	start() Starts an stopped listener.
void	stop() Stops this listener.

Methods inherited from interface org.mule.api.source.MessageSource

setListener

Methods inherited from interface org.mule.api.lifecycle.Initialisable

initialise

Method Detail

getConfig

HttpListenerConfig getConfig()

Returns:

the config for this listener.

stop

void stop()
   throws MuleException

Stops this listener. Any subsequent call made to the listener will return org.mule.module.http.internal.listener.ServiceTemporarilyUnavailableListenerRequestHandler#SERVICE_TEMPORARILY_UNAVAILABLE_STATUS_CODE.

Specified by:

stop in interface Stoppable

Throws:

MuleException - if there's was a problem stopping the listener

start

void start()
    throws MuleException

Starts an stopped listener. The listener will start to accept requests again.

Specified by:

start in interface Startable

Throws:

MuleException

dispose

void dispose()

Get rid of this listener. Subsequent call made to the listener will return org.mule.module.http.internal.listener.NoListenerRequestHandler#RESOURCE_NOT_FOUND_STATUS_CODE unless there's another listener which path matches the request criteria.

Specified by:

dispose in interface Disposable

getPath

String getPath()

Returns:

the path in which this listener is listening for incoming requests

getAllowedMethods

String[] getAllowedMethods()

Returns:

the http methods that this listener can process.