Class UserPortalRouter
java.lang.Object
de.xima.fc.user_portal.route.UserPortalRouter
Handles URL routing for user portal pages.
- Since:
- 8.2.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionexternalPortalUrl(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route, javax.servlet.http.HttpServletRequest request) externalPortalUrlWithContext(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route, javax.servlet.http.HttpServletRequest request) externalPortalUrlWithHost(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route, javax.servlet.http.HttpServletRequest request) <C extends IRoutingContext>
StringexternalUrl(IUserPortalRoute<C> route, C routingContext) <C extends IRoutingContext>
StringexternalUrlForFormRecord(javax.servlet.http.HttpServletRequest request) <C extends IRoutingContext>
StringexternalUrlWithContext(IUserPortalRoute<C> route, C routingContext, javax.servlet.http.HttpServletRequest request) <C extends IRoutingContext>
StringexternalUrlWithContext(IUserPortalRoute<C> route, C routingContext, javax.servlet.http.HttpServletRequest request, Map<String, String> parameters) <C extends IRoutingContext>
StringexternalUrlWithHost(IUserPortalRoute<C> route, C routingContext, javax.servlet.http.HttpServletRequest request) <C extends IRoutingContext>
voidfacesRedirectTo(javax.faces.context.FacesContext facesContext, IUserPortalRoute<C> route, C routingContext) Redirects an active Faces request to the given user portal view.<C extends IRoutingContext>
voidfacesRedirectTo(javax.faces.context.FacesContext facesContext, IUserPortalRoute<C> route, C routingContext, Map<String, String> parameters) voidfacesRedirectToGenericError(javax.faces.context.FacesContext facesContext) Redirects an active Faces request to the error view.voidfacesRedirectToGenericNotFound(javax.faces.context.FacesContext facesContext) Redirects an active Faces request to the not found view.<C extends IRoutingContext>
StringinternalUrlForChat(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route, javax.servlet.http.HttpServletRequest request, ChatModel chat) <C extends IRoutingContext>
StringinternalUrlForFormRecord(IUserPortalRoute<IRoutingContext.IPortalRoutingContext> route, javax.servlet.http.HttpServletRequest request, FormRecordModel formRecord) booleanisUserPortalRequest(javax.servlet.http.HttpServletRequest request) routeByRequest(javax.servlet.http.HttpServletRequest request) routes()Returns all known registered routes.
-
Constructor Details
-
UserPortalRouter
public UserPortalRouter()
-
-
Method Details
-
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
-
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
-
routes
Returns all known registered routes.- Returns:
- All registered routes.
-