act.handler

Class RequestHandlerBase

java.lang.Object

org.osgl.Lang.FuncBase

org.osgl.Lang.F1<ActionContext,Void>

act.handler.RequestHandlerBase

All Implemented Interfaces:

Destroyable, RequestHandler, org.osgl.Lang.Bijection<ActionContext,Void>, org.osgl.Lang.Func1<ActionContext,Void>, org.osgl.Lang.Function<ActionContext,Void>, org.osgl.Lang.MultiplicableFunction<ActionContext,Void>

Direct Known Subclasses:

DelegateRequestHandler, FastRequestHandler, RequestHandlerProxy, SecureTicketHandler, WebSocketConnectionHandler

public abstract class RequestHandlerBase
extends org.osgl.Lang.F1<ActionContext,Void>
implements RequestHandler

Nested Class Summary

Nested classes/interfaces inherited from interface act.Destroyable

Destroyable.Util

Field Summary

Fields

Modifier and Type	Field and Description
protected org.osgl.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
RequestHandlerBase()

Method Summary

Modifier and Type	Method and Description
Void	apply(ActionContext context)
String	contentSecurityPolicy() Get Content-Security-Policy that applied to this request handler
CORS.Spec	corsSpec() Get CORS specification that specifically applied to this request handler
CSRF.Spec	csrfSpec() Get CSRF specification that applied to this request handler
void	destroy()
boolean	disableContentSecurityPolicy()
boolean	express(ActionContext context) Indicate the handler logic is fast enough to be put into network layer’s io thread and does not require to dispatch to worker thread.
boolean	isDestroyed()
RequestHandlerBase	noContextResoving()
RequestHandler	realHandler()
protected void	releaseResources()
boolean	requireResolveContext() Returns if the handler require framework to resolve context.
Class<? extends Annotation>	scope()
boolean	sessionFree() Returns if the handler is session free or not.
RequestHandlerBase	setExpress()
RequestHandlerBase	setSessionFree()
boolean	skipEvents(ActionContext context) By default an express handler will skip result commit events triggering.
boolean	supportPartialPath() Indicate if this request handler support partial path lookup.
String	toString()
static RequestHandlerBase	wrap(SimpleRequestHandler handler)

Methods inherited from class org.osgl.Lang.F1

andThen, andThen, applyOrElse, compose, compose, compose, compose, compose, compose, curry, invert, lift, orElse, times

Methods inherited from class org.osgl.Lang.FuncBase

breakOut

Methods inherited from class java.lang.Object

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

Methods inherited from interface act.handler.RequestHandler

handle, prepareAuthentication

Field Detail

logger

protected org.osgl.logging.Logger logger

Constructor Detail

RequestHandlerBase

public RequestHandlerBase()

Method Detail

apply

public final Void apply(ActionContext context)
                 throws org.osgl.exception.NotAppliedException,
                        org.osgl.Lang.Break

Specified by:

apply in interface org.osgl.Lang.Function<ActionContext,Void>

Throws:

org.osgl.exception.NotAppliedException

org.osgl.Lang.Break

setExpress

public RequestHandlerBase setExpress()

express

public boolean express(ActionContext context)

Description copied from interface: RequestHandler

Indicate the handler logic is fast enough to be put into network layer’s io thread and does not require to dispatch to worker thread.

Note a handler that implements ExpressHandler should always return true for this method

Specified by:

express in interface RequestHandler

Parameters:

context - the action context

Returns:

true if this handler support direct io thread processing

skipEvents

public boolean skipEvents(ActionContext context)

By default an express handler will skip result commit events triggering.

Specified by:

skipEvents in interface RequestHandler

Parameters:

context - the action context.

Returns:

result of express(ActionContext)

scope

public final Class<? extends Annotation> scope()

Specified by:

scope in interface Destroyable

supportPartialPath

public boolean supportPartialPath()

Description copied from interface: RequestHandler

Indicate if this request handler support partial path lookup. Usually this method should return false. However for certain request handler like FileGetter they need to support partial path lookup. Take the example of the following route mapping:

GET /public staticDir: /public

which map url path /public to a StaticFileGetter with base dir set to /public, it needs to support all path starts with “/public”, like “/public/js/jquery.js” etc.

Specified by:

supportPartialPath in interface RequestHandler

Returns:

true if the request handler support partial path lookup or false otherwise

requireResolveContext

public boolean requireResolveContext()

Description copied from interface: RequestHandler

Returns if the handler require framework to resolve context. Usually it needs to resolve the context so that handler can access request params, session/flash etc. However some static handlers doesn’t require framework to do those things, e.g. FileGetter

Specified by:

requireResolveContext in interface RequestHandler

noContextResoving

public RequestHandlerBase noContextResoving()

realHandler

public RequestHandler realHandler()

setSessionFree

public RequestHandlerBase setSessionFree()

toString

public String toString()

Overrides:

toString in class Object

sessionFree

public boolean sessionFree()

Description copied from interface: RequestHandler

Returns if the handler is session free or not. If a handler is session free then the framework will NOT resolve session

Specified by:

sessionFree in interface RequestHandler

Returns:

true if the handler is session free

corsSpec

public CORS.Spec corsSpec()

Description copied from interface: RequestHandler

Get CORS specification that specifically applied to this request handler

Specified by:

corsSpec in interface RequestHandler

Returns:

the the CORS specification applied to this request handler

csrfSpec

public CSRF.Spec csrfSpec()

Description copied from interface: RequestHandler

Get CSRF specification that applied to this request handler

Specified by:

csrfSpec in interface RequestHandler

Returns:

the CSRF specification applied to this request handler

contentSecurityPolicy

public String contentSecurityPolicy()

Description copied from interface: RequestHandler

Get Content-Security-Policy that applied to this request handler

Specified by:

contentSecurityPolicy in interface RequestHandler

Returns:

Content-Security-Policy that applied to this request handler

disableContentSecurityPolicy

public boolean disableContentSecurityPolicy()

Specified by:

disableContentSecurityPolicy in interface RequestHandler

destroy

public void destroy()

Specified by:

destroy in interface Destroyable

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface Destroyable

releaseResources

protected void releaseResources()

wrap

public static RequestHandlerBase wrap(SimpleRequestHandler handler)