org.mule.service.http.impl.service.server

Class HttpListenerRegistry.Path

java.lang.Object

org.mule.service.http.impl.service.server.HttpListenerRegistry.Path

Enclosing class:

HttpListenerRegistry

public class HttpListenerRegistry.Path
extends Object

Represents a URI path, which can be a parent to regular sub paths, a catch all sub path (/*) and a URI param path (/{param}). Request handler and matcher pairs (handlers for different methods, for example) can be added and removed from it. If all its handlers and children's handlers' are removed, it will notify its parent the path itself can be removed. This means that the tree-like structure that results from binding paths together changes as handlers are created and disposed so special care needs to be taken regarding available paths.

Constructor Summary

Constructors

Constructor and Description
Path(String name, HttpListenerRegistry.Path parent) Creates a new instance for the given name and with the provided parent.

Method Summary

Modifier and Type	Method and Description
void	addChildPath(String pathName, HttpListenerRegistry.Path path) Adds a new sub or uri param path.
void	addRequestHandlerMatcherPair(HttpListenerRegistry.RequestHandlerMatcherPair requestHandlerMatcherPair) Adds a new request handler and matcher for this path.
void	addWildcardRequestHandler(HttpListenerRegistry.RequestHandlerMatcherPair requestHandlerMatcherPair) Adds a request handler matcher pair for the catch all sub path (/*).
HttpListenerRegistry.Path	getCatchAll()
HttpListenerRegistry.Path	getCatchAllUriParam()
HttpListenerRegistry.Path	getChildPath(String subPath, String nextSubPath)
HttpListenerRegistry.Path	getLastChildPath(String subPath)
List<HttpListenerRegistry.RequestHandlerMatcherPair>	getRequestHandlerMatcherPairs()
Map<String,HttpListenerRegistry.Path>	getSubPaths()
boolean	isEmpty()
void	removeChildPath(String pathName) Removes a sub path and checks whether this path itself should be removed.
boolean	removeRequestHandlerMatcherPair(HttpListenerRegistry.RequestHandlerMatcherPair requestHandlerMatcherPair) Removes a request handler and matcher pair whether it's in a regular sub path, the catch all sub path or a uri param sub path.

Methods inherited from class java.lang.Object

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

Constructor Detail

Path

public Path(String name,
            HttpListenerRegistry.Path parent)

Creates a new instance for the given name and with the provided parent.

Parameters:

name - for this path

parent - of this path

Method Detail

getCatchAll

public HttpListenerRegistry.Path getCatchAll()

Returns:

the catch all path for this one (/*)

getCatchAllUriParam

public HttpListenerRegistry.Path getCatchAllUriParam()

Returns:

the catch all uri param path for this one (/{param})

getChildPath

public HttpListenerRegistry.Path getChildPath(String subPath,
                                              String nextSubPath)

Parameters:

subPath - the sub part of the path to find

nextSubPath - the next sub part of the path. It is useful for deciding between static paths and middle-wildcard paths when they are similar.

Returns:

the node with the existent mappings. null if there's no such node.

getLastChildPath

public HttpListenerRegistry.Path getLastChildPath(String subPath)

Parameters:

subPath - a sub part of the path

Returns:

the node with the existent mappings. null if there's no such node.

addRequestHandlerMatcherPair

public void addRequestHandlerMatcherPair(HttpListenerRegistry.RequestHandlerMatcherPair requestHandlerMatcherPair)

Adds a new request handler and matcher for this path.

Parameters:

requestHandlerMatcherPair - the pair to add

addChildPath

public void addChildPath(String pathName,
                         HttpListenerRegistry.Path path)

Adds a new sub or uri param path.

Parameters:

pathName - the path name

path - the representation of this path

removeChildPath

public void removeChildPath(String pathName)

Removes a sub path and checks whether this path itself should be removed.

Parameters:

pathName - the path name

isEmpty

public boolean isEmpty()

Returns:

whether this path is empty, meaning it has no handlers or sub paths of any kind which are in turn non empty.

getSubPaths

public Map<String,HttpListenerRegistry.Path> getSubPaths()

Returns:

the map of sub paths available

getRequestHandlerMatcherPairs

public List<HttpListenerRegistry.RequestHandlerMatcherPair> getRequestHandlerMatcherPairs()

Returns:

the list of handlers for this path

addWildcardRequestHandler

public void addWildcardRequestHandler(HttpListenerRegistry.RequestHandlerMatcherPair requestHandlerMatcherPair)

Adds a request handler matcher pair for the catch all sub path (/*).

Parameters:

requestHandlerMatcherPair - the pair to add

removeRequestHandlerMatcherPair

public boolean removeRequestHandlerMatcherPair(HttpListenerRegistry.RequestHandlerMatcherPair requestHandlerMatcherPair)

Removes a request handler and matcher pair whether it's in a regular sub path, the catch all sub path or a uri param sub path. The latter two will be removed if empty as will the path it self if now empty.

Parameters:

requestHandlerMatcherPair -

Returns:

whether the removal was successful