Package de.xima.fc.security.endpoint

Class WebEndpointManager

java.lang.Object

de.xima.fc.security.endpoint.WebEndpointManager

public final class WebEndpointManager
extends Object

Manager for working with formcycle web endpoints.

Since:

8.0.0

Author:

XIMA Media GmbH

Method Summary

Modifier and Type	Method	Description
static List<org.apache.commons.lang3.tuple.Pair<String,Collection<IPluginMenuEntry>>>	getRegisteredPluginMenuEntries(Mandant client)
static Set<IRewriteUriResolver>	getRewriteUriResolvers()	Returns all registered web endpoints with rewrite uri resolvers.
static IWebEndpoint	getWebEndpoint(javax.servlet.http.HttpServletRequest req)	Get the web endpoint for the given request
static IWebEndpoint	getWebEndpointById(String webEndpointId)	Returns the web endpoint with the given ID if it is registered.
static void	registerPluginMenuEntries(String contextName, IPluginMenuEntries menuEntries, String clientUuid)
static void	unregisterPluginMenuEntries(IPluginMenuEntries menuEntries)

Methods inherited from class java.lang.Object

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

Method Detail

getRegisteredPluginMenuEntries

public static List<org.apache.commons.lang3.tuple.Pair<String,Collection<IPluginMenuEntry>>> getRegisteredPluginMenuEntries(Mandant client)

getRewriteUriResolvers

public static Set<IRewriteUriResolver> getRewriteUriResolvers()

Returns all registered web endpoints with rewrite uri resolvers. Web endpoints with rewrite uri resolvers perform request rewrites using the RewriteFilter.

Returns:

all registered web endpoints with rewrite uri resolvers.

getWebEndpoint

public static IWebEndpoint getWebEndpoint(javax.servlet.http.HttpServletRequest req)

Get the web endpoint for the given request

Parameters:

req - HTTP request from which the web endpoint is extracted.

Returns:

The web endpoint requested by the given HTTP request.

getWebEndpointById

public static IWebEndpoint getWebEndpointById(String webEndpointId)

Returns the web endpoint with the given ID if it is registered.

Parameters:

webEndpointId - ID of the web endpoint to be returned.

Returns:

The web endpoint with the given ID or null if no web endpoint with the given ID is registered.

Throws:

IllegalArgumentException - if no web endpoint ID is given.

registerPluginMenuEntries

public static void registerPluginMenuEntries(String contextName,
                                             IPluginMenuEntries menuEntries,
                                             String clientUuid)

unregisterPluginMenuEntries

public static void unregisterPluginMenuEntries(IPluginMenuEntries menuEntries)