org.mule.runtime.module.http.api.listener

Class HttpListenerBuilder

java.lang.Object

org.mule.runtime.module.http.api.listener.HttpListenerBuilder

public class HttpListenerBuilder
extends Object

Builder for creating http listeners pragmatically.

Constructor Summary

Constructors

Constructor and Description
HttpListenerBuilder(MuleContext muleContext)

Method Summary

Modifier and Type	Method and Description
HttpListener	build()
HttpListenerBuilder	setErrorReasonPhrase(String reasonPhrase)
HttpListenerBuilder	setErrorStatusCode(String statusCode)
HttpListenerBuilder	setFlow(Flow flow)
HttpListenerBuilder	setHost(String host)
HttpListenerBuilder	setListenerConfig(HttpListenerConfig httpListenerConfig)
HttpListenerBuilder	setPath(String path)
HttpListenerBuilder	setPort(int port)
HttpListenerBuilder	setSuccessReasonPhrase(String reasonPhrase)
HttpListenerBuilder	setSuccessStatusCode(String statusCode)
HttpListenerBuilder	setTlsContextFactory(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory)
HttpListenerBuilder	setUrl(URL url) Configures the protocol, host, port and path using the provided url.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpListenerBuilder

public HttpListenerBuilder(MuleContext muleContext)

Method Detail

setUrl

public HttpListenerBuilder setUrl(URL url)

Configures the protocol, host, port and path using the provided url.

Parameters:

url - the listener url

Returns:

the builder

Throws:

MalformedURLException

setPort

public HttpListenerBuilder setPort(int port)

Parameters:

port - port to use for the listener

Returns:

the builder

setHost

public HttpListenerBuilder setHost(String host)

Parameters:

host - host to use for the listener

Returns:

the builder

setFlow

public HttpListenerBuilder setFlow(Flow flow)

Parameters:

flow - flow that will be listening handling the requests

Returns:

the builder

setSuccessStatusCode

public HttpListenerBuilder setSuccessStatusCode(String statusCode)

Parameters:

statusCode - sets the status code to use when the request processing was successful. Allows MEL expressions.

Returns:

setSuccessReasonPhrase

public HttpListenerBuilder setSuccessReasonPhrase(String reasonPhrase)

Parameters:

reasonPhrase - sets the reason phrase of the response when the request processing was successful. Allows MEL expressions.

Returns:

setErrorStatusCode

public HttpListenerBuilder setErrorStatusCode(String statusCode)

Parameters:

statusCode - sets the status code to use when the request processing failed. Allows MEL expressions.

Returns:

setErrorReasonPhrase

public HttpListenerBuilder setErrorReasonPhrase(String reasonPhrase)

Parameters:

reasonPhrase - sets the reason phrase of the response when the request processing failed. Allows MEL expressions.

Returns:

setTlsContextFactory

public HttpListenerBuilder setTlsContextFactory(org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory)

Parameters:

tlsContextFactory - TLS configuration to use to set up the listener.

Returns:

the builder.

setPath

public HttpListenerBuilder setPath(String path)

Parameters:

path - sets the path in which the listener will be listening. Follows http:listener path attribute pattern matching.

Returns:

the builder

build

public HttpListener build()
                   throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

setListenerConfig

public HttpListenerBuilder setListenerConfig(HttpListenerConfig httpListenerConfig)