Package de.xima.fc.user_portal.route

Class UserPortalRouter

java.lang.Object

de.xima.fc.user_portal.route.UserPortalRouter

@ApplicationScoped
@Named
public class UserPortalRouter
extends Object

Handles URL routing for user portal pages.

Since:

8.2.0

Constructor Summary

Constructors

Constructor	Description
UserPortalRouter()

Method Summary

Modifier and Type	Method	Description
String	externalPortalUrl(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route, javax.servlet.http.HttpServletRequest request)
String	externalPortalUrlWithContext(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route, javax.servlet.http.HttpServletRequest request)
String	externalPortalUrlWithHost(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route, javax.servlet.http.HttpServletRequest request)
<C extends IRoutingContext> String	externalUrl(IUserPortalRoute<C> route, C routingContext)
<C extends IRoutingContext> String	externalUrlForFormRecord(javax.servlet.http.HttpServletRequest request)
<C extends IRoutingContext> String	externalUrlWithContext(IUserPortalRoute<C> route, C routingContext, javax.servlet.http.HttpServletRequest request)
<C extends IRoutingContext> String	externalUrlWithContext(IUserPortalRoute<C> route, C routingContext, javax.servlet.http.HttpServletRequest request, Map<String,String> parameters)
<C extends IRoutingContext> String	externalUrlWithHost(IUserPortalRoute<C> route, C routingContext, javax.servlet.http.HttpServletRequest request)
<C extends IRoutingContext> void	facesRedirectTo(javax.faces.context.FacesContext facesContext, IUserPortalRoute<C> route, C routingContext)	Redirects an active Faces request to the given user portal view.
<C extends IRoutingContext> void	facesRedirectTo(javax.faces.context.FacesContext facesContext, IUserPortalRoute<C> route, C routingContext, Map<String,String> parameters)
void	facesRedirectToGenericError(javax.faces.context.FacesContext facesContext)	Redirects an active Faces request to the error view.
void	facesRedirectToGenericNotFound(javax.faces.context.FacesContext facesContext)	Redirects an active Faces request to the not found view.
<C extends IRoutingContext> String	internalUrlForChat(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route, javax.servlet.http.HttpServletRequest request, ChatModel chat)
<C extends IRoutingContext> String	internalUrlForFormRecord(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route, javax.servlet.http.HttpServletRequest request, FormRecordModel formRecord)
boolean	isUserPortalRequest(javax.servlet.http.HttpServletRequest request)
IUserPortalRoute<?>	routeByRequest(javax.servlet.http.HttpServletRequest request)
Collection<IUserPortalRoute<?>>	routes()	Returns all known registered routes.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserPortalRouter

public UserPortalRouter()

Method Detail

externalPortalUrl

public String externalPortalUrl(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route,
                                javax.servlet.http.HttpServletRequest request)

externalPortalUrlWithContext

public String externalPortalUrlWithContext(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route,
                                           javax.servlet.http.HttpServletRequest request)

externalPortalUrlWithHost

public String externalPortalUrlWithHost(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route,
                                        javax.servlet.http.HttpServletRequest request)

externalUrl

public <C extends IRoutingContext> String externalUrl(IUserPortalRoute<C> route,
                                                      C routingContext)

externalUrlWithContext

public <C extends IRoutingContext> String externalUrlWithContext(IUserPortalRoute<C> route,
                                                                 C routingContext,
                                                                 javax.servlet.http.HttpServletRequest request)

externalUrlWithContext

public <C extends IRoutingContext> String externalUrlWithContext(IUserPortalRoute<C> route,
                                                                 C routingContext,
                                                                 javax.servlet.http.HttpServletRequest request,
                                                                 @Nullable
                                                                 Map<String,String> parameters)

externalUrlForFormRecord

public <C extends IRoutingContext> String externalUrlForFormRecord(javax.servlet.http.HttpServletRequest request)

externalUrlWithHost

public <C extends IRoutingContext> String externalUrlWithHost(IUserPortalRoute<C> route,
                                                              C routingContext,
                                                              javax.servlet.http.HttpServletRequest request)

internalUrlForChat

public <C extends IRoutingContext> String internalUrlForChat(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route,
                                                             javax.servlet.http.HttpServletRequest request,
                                                             ChatModel chat)

internalUrlForFormRecord

public <C extends IRoutingContext> String internalUrlForFormRecord(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route,
                                                                   javax.servlet.http.HttpServletRequest request,
                                                                   FormRecordModel formRecord)

facesRedirectTo

public <C extends IRoutingContext> void facesRedirectTo(javax.faces.context.FacesContext facesContext,
                                                        IUserPortalRoute<C> route,
                                                        C routingContext)

Redirects an active Faces request to the given user portal view.

Parameters:

facesContext - The currently active Faces context.

route - The route to redirect to.

routingContext - The routing context to use for the redirect.

facesRedirectTo

public <C extends IRoutingContext> void facesRedirectTo(javax.faces.context.FacesContext facesContext,
                                                        IUserPortalRoute<C> route,
                                                        C routingContext,
                                                        @Nullable
                                                        Map<String,String> parameters)

facesRedirectToGenericNotFound

public void facesRedirectToGenericNotFound(javax.faces.context.FacesContext facesContext)

Redirects an active Faces request to the not found view.

Parameters:

facesContext - The currently active Faces context.

facesRedirectToGenericError

public void facesRedirectToGenericError(javax.faces.context.FacesContext facesContext)

Redirects an active Faces request to the error view.

Parameters:

facesContext - The currently active Faces context.

isUserPortalRequest

public boolean isUserPortalRequest(javax.servlet.http.HttpServletRequest request)

routeByRequest

public IUserPortalRoute<?> routeByRequest(javax.servlet.http.HttpServletRequest request)

routes

public Collection<IUserPortalRoute<?>> routes()

Returns all known registered routes.

Returns:

All registered routes.