org.spincast.core.controllers

Class SpincastFrontController<R extends IRequestContext<R>,W extends IWebsocketContext<?>>

java.lang.Object

org.spincast.core.controllers.SpincastFrontController<R,W>

All Implemented Interfaces:

IFrontController

public class SpincastFrontController<R extends IRequestContext<R>,W extends IWebsocketContext<?>>
extends Object
implements IFrontController

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
SpincastFrontController(IRouter<R,W> router, ISpincastConfig spincastConfig, ISpincastDictionary spincastDictionary, IServer server, IRequestContextFactory<R> requestCreationFactory, SpincastRequestScope spincastRequestScope, Type requestContextType, IJsonManager jsonManager, IXmlManager xmlManager) The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addDefaultNotFoundRoute() Add the default Not Found route.
protected void	addDependenciesInCustomRequestScope(R requestContext) Add dependencies to the custom request scope
protected void	addRequestContextInCustomRequestScope(R requestContext) Add the request context object in the cutom request scope
protected void	callRouteHandlers(R requestContext, IRoutingResult<R> routingResult) Call the handlers, in order they are specified.
protected R	createForwardedRequestContext(R context, String fullUrlOrRelativePathAndQueryString)
protected void	customExceptionHandling(Throwable ex, R requestContext, IRoutingResult<R> originalRoutingResult) Custom exception handling.
protected void	defaultExceptionHandling(Object exchange, Throwable ex) Default exception handling.
protected void	defaultPrivateExceptionHandling(Object exchange, Throwable exception) Default exception handling for private exceptions
protected void	defaultPublicExceptionHandling(Object exchange, IPublicException publicException) Default exception handling for exceptions with public information.
protected IRoutingResult<R>	findRouteMatch(R requestContext) Find the route handlers to call.
protected String	getDefaultExceptionHandlingCharset() Charset used by the default exception handling.
protected IHandler<R>	getDefaultNotFoundHandler() Create the default Not Found handler
protected String	getDefaultNotFoundHandlerNotFoundMessage() The message to send for the default Not Found handler.
protected String	getInternalErrorHtmlContent(String errorMessage)
protected String	getInternalErrorJsonContent(String errorMessage)
protected String	getInternalErrorTextContent(String errorMessage)
protected String	getInternalErrorXmlContent(String errorMessage)
protected IJsonManager	getJsonManager()
protected String	getNotFoundHtmlContent(String message)
protected String	getNotFoundJsonContent(String message)
protected String	getNotFoundPlainTextContent(String message)
protected String	getNotFoundXmlContent(String message)
protected IRequestContextFactory<R>	getRequestContextFactory()
protected Type	getRequestContextType()
protected ContentTypeDefaults	getResponseContentTypeToUse(Object exchange)
protected IRouter<R,W>	getRouter()
protected IServer	getServer()
protected ISpincastConfig	getSpincastConfig()
protected ISpincastDictionary	getSpincastDictionary()
protected SpincastRequestScope	getSpincastRequestScope()
protected IXmlManager	getXmlManager()
void	handle(Object exchange) Front controller's handle() method, called by the HTTP server.
protected void	lastResortExceptionHandling(Throwable originalException, Throwable defaultHandlingException) Called when the default exception handler itself throws an exception...
protected void	manageForwardRouteException(ForwardRouteException ex, R context, IRoutingResult<R> originalRoutingResult) Manage a ForwardRouteException exception.
protected void	manageRedirectException(RedirectException ex, R context, IRoutingResult<R> routingResult) Manage a RedirectException exception.
protected IRoutingResult<R>	prepareNotFoundRouting(Object exchange, R requestContext) Prepares a direct Not Found routing.
protected IRoutingResult<R>	prepareNotFoundRouting(Object exchange, R requestContext, boolean alreadyTried) Prepares a direct Not Found routing.
protected void	resetResponse(R requestContext)
protected void	sendErrorUsingBestMatchContentType(Object exchange, String errorMessage, Integer statusCode) Send an error to the client.
protected Object	validateExchange(Object exchange) Validate/modify the exchange before the handling.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

SpincastFrontController

@Inject
public SpincastFrontController(IRouter<R,W> router,
                                        ISpincastConfig spincastConfig,
                                        ISpincastDictionary spincastDictionary,
                                        IServer server,
                                        IRequestContextFactory<R> requestCreationFactory,
                                        SpincastRequestScope spincastRequestScope,
                                        Type requestContextType,
                                        IJsonManager jsonManager,
                                        IXmlManager xmlManager)

The constructor.

Method Detail

getRouter

protected IRouter<R,W> getRouter()

getSpincastConfig

protected ISpincastConfig getSpincastConfig()

getSpincastDictionary

protected ISpincastDictionary getSpincastDictionary()

getServer

protected IServer getServer()

getRequestContextFactory

protected IRequestContextFactory<R> getRequestContextFactory()

getSpincastRequestScope

protected SpincastRequestScope getSpincastRequestScope()

getRequestContextType

protected Type getRequestContextType()

getJsonManager

protected IJsonManager getJsonManager()

getXmlManager

protected IXmlManager getXmlManager()

handle

public void handle(Object exchange)

Front controller's handle() method, called by the HTTP server.

Specified by:

handle in interface IFrontController

Parameters:

exchange - an object representing the current request, provided by the HTTP server

prepareNotFoundRouting

protected IRoutingResult<R> prepareNotFoundRouting(Object exchange,
                                                   R requestContext)

Prepares a direct Not Found routing.

prepareNotFoundRouting

protected IRoutingResult<R> prepareNotFoundRouting(Object exchange,
                                                   R requestContext,
                                                   boolean alreadyTried)

Prepares a direct Not Found routing.

addDefaultNotFoundRoute

protected void addDefaultNotFoundRoute()

Add the default Not Found route.

getDefaultNotFoundHandler

protected IHandler<R> getDefaultNotFoundHandler()

Create the default Not Found handler

getNotFoundHtmlContent

protected String getNotFoundHtmlContent(String message)

getNotFoundJsonContent

protected String getNotFoundJsonContent(String message)

getNotFoundXmlContent

protected String getNotFoundXmlContent(String message)

getNotFoundPlainTextContent

protected String getNotFoundPlainTextContent(String message)

getDefaultNotFoundHandlerNotFoundMessage

protected String getDefaultNotFoundHandlerNotFoundMessage()

The message to send for the default Not Found handler.

resetResponse

protected void resetResponse(R requestContext)

customExceptionHandling

protected void customExceptionHandling(Throwable ex,
                                       R requestContext,
                                       IRoutingResult<R> originalRoutingResult)
                                throws Throwable

Custom exception handling.

Throws:

Throwable

addDependenciesInCustomRequestScope

protected void addDependenciesInCustomRequestScope(R requestContext)

Add dependencies to the custom request scope

addRequestContextInCustomRequestScope

protected void addRequestContextInCustomRequestScope(R requestContext)

Add the request context object in the cutom request scope

callRouteHandlers

protected void callRouteHandlers(R requestContext,
                                 IRoutingResult<R> routingResult)
                          throws Exception

Call the handlers, in order they are specified.

Throws:

Exception

manageRedirectException

protected void manageRedirectException(RedirectException ex,
                                       R context,
                                       IRoutingResult<R> routingResult)

Manage a RedirectException exception.

manageForwardRouteException

protected void manageForwardRouteException(ForwardRouteException ex,
                                           R context,
                                           IRoutingResult<R> originalRoutingResult)
                                    throws Exception

Manage a ForwardRouteException exception.

Throws:

Exception

createForwardedRequestContext

protected R createForwardedRequestContext(R context,
                                          String fullUrlOrRelativePathAndQueryString)

validateExchange

protected Object validateExchange(Object exchange)

Validate/modify the exchange before the handling.

findRouteMatch

protected IRoutingResult<R> findRouteMatch(R requestContext)

Find the route handlers to call.

defaultExceptionHandling

protected void defaultExceptionHandling(Object exchange,
                                        Throwable ex)
                                 throws Throwable

Default exception handling.

Throws:

Throwable

defaultPublicExceptionHandling

protected void defaultPublicExceptionHandling(Object exchange,
                                              IPublicException publicException)
                                       throws Throwable

Default exception handling for exceptions with public information.

Throws:

Throwable

defaultPrivateExceptionHandling

protected void defaultPrivateExceptionHandling(Object exchange,
                                               Throwable exception)
                                        throws Throwable

Default exception handling for private exceptions

Throws:

Throwable

sendErrorUsingBestMatchContentType

protected void sendErrorUsingBestMatchContentType(Object exchange,
                                                  String errorMessage,
                                                  Integer statusCode)
                                           throws Throwable

Send an error to the client.

Throws:

Throwable

getDefaultExceptionHandlingCharset

protected String getDefaultExceptionHandlingCharset()

Charset used by the default exception handling.

getInternalErrorJsonContent

protected String getInternalErrorJsonContent(String errorMessage)

getInternalErrorXmlContent

protected String getInternalErrorXmlContent(String errorMessage)

getInternalErrorHtmlContent

protected String getInternalErrorHtmlContent(String errorMessage)

getInternalErrorTextContent

protected String getInternalErrorTextContent(String errorMessage)

getResponseContentTypeToUse

protected ContentTypeDefaults getResponseContentTypeToUse(Object exchange)

lastResortExceptionHandling

protected void lastResortExceptionHandling(Throwable originalException,
                                           Throwable defaultHandlingException)

Called when the default exception handler itself throws an exception... Last resort!