org.analogweb

Interface ApplicationProcessor

All Superinterfaces:

Module, MultiModule, Precedence

All Known Implementing Classes:

AbstractApplicationProcessor, BindAttributeArgumentPreparator, ConsumesMediaTypeVerifier, ScopedMapArgumentPreparator

public interface ApplicationProcessor
extends MultiModule, Precedence

Applicationを実行する様々なフェーズ(実行前、実行後、例外発生、実行完了後) において、任意の処理を付加するコンポーネント

Author:

snowgoose

Nested Class Summary

Nested classes/interfaces inherited from interface org.analogweb.MultiModule

MultiModule.Filter

Field Summary

Fields

Modifier and Type	Field and Description
static Object	NO_INTERRUPTION ApplicationProcessorの各ライフサイクルにおいて 処理の結果、Application及び、後続のApplicationProcessor の処理を中断しないことを表すフラグメントです。

Fields inherited from interface org.analogweb.Precedence

HIGHEST, LOWEST

Method Summary

Methods

Modifier and Type	Method and Description
void	afterCompletion(RequestContext request, ResponseContext response, Exception e) Application実行後に処理を追加します。 このメソッドはApplicationの実行において例外が発生した場合でも processException(Exception, RequestContext, PreparedInvocationArguments, InvocationMetadata) で結果が買えされない場合実行されます。
void	postInvoke(Object invocationResult, InvocationArguments args, InvocationMetadata metadata, RequestContext context, RequestValueResolvers resolvers) Applicationを正常に実行した場合に、処理を追加します。 通常は、引数に指定されたinvocationResultの値(Application の実行結果)をそのまま返します。それ以外の値を返す(実行結果を挿げ替える) 事も可能です。
Object	preMatching(MutableRequestContext request, RequestPath path) Applicationのルーティング処理前に処理を追加します。 通常は、NO_INTERRUPTIONを返します。それ以外の 値をかえす場合は、処理の結果その戻り値を以って Applicationの処理を終了します。
Object	prepareInvoke(Method method, InvocationArguments args, InvocationMetadata metadata, RequestContext context, TypeMapperContext converters, RequestValueResolvers resolvers) Applicationの実行前に処理を追加します。 通常は、NO_INTERRUPTIONを返します。それ以外の 値をかえす場合は、処理の結果その戻り値を以って Applicationの処理を終了します。
Object	processException(Exception ex, RequestContext request, PreparedInvocationArguments args, InvocationMetadata metadata) Application実行時に例外が発生した場合に、処理を追加します。 通常は、NO_INTERRUPTIONを返します。それ以外の 値をかえす場合は、その戻り値が処理結果となります。

Methods inherited from interface org.analogweb.Precedence

getPrecedence

Field Detail

NO_INTERRUPTION

static final Object NO_INTERRUPTION

ApplicationProcessorの各ライフサイクルにおいて 処理の結果、Application及び、後続のApplicationProcessor の処理を中断しないことを表すフラグメントです。

Method Detail

preMatching

Object preMatching(MutableRequestContext request,
                 RequestPath path)

Applicationのルーティング処理前に処理を追加します。
通常は、NO_INTERRUPTIONを返します。それ以外の 値をかえす場合は、処理の結果その戻り値を以って Applicationの処理を終了します。

Parameters:

request - MutableRequestContext

path - RequestPath

Returns:

実行処理を中断する結果(Renderableなど。)

prepareInvoke

Object prepareInvoke(Method method,
                   InvocationArguments args,
                   InvocationMetadata metadata,
                   RequestContext context,
                   TypeMapperContext converters,
                   RequestValueResolvers resolvers)

Applicationの実行前に処理を追加します。
通常は、NO_INTERRUPTIONを返します。それ以外の 値をかえす場合は、処理の結果その戻り値を以って Applicationの処理を終了します。

Parameters:

method - 実行対象のMethod

args - InvocationArguments

metadata - InvocationMetadata

context - RequestContext

converters - TypeMapperContext

resolvers - RequestValueResolvers

Returns:

実行処理を中断する結果(Renderableなど。)

processException

Object processException(Exception ex,
                      RequestContext request,
                      PreparedInvocationArguments args,
                      InvocationMetadata metadata)

Application実行時に例外が発生した場合に、処理を追加します。
通常は、NO_INTERRUPTIONを返します。それ以外の 値をかえす場合は、その戻り値が処理結果となります。

Parameters:

ex - Application実行時に発生した例外。

request - RequestContext

args - 例外が発生した対象のInvocationArguments

metadata - InvocationMetadata

Returns:

実行処理を中断する結果(Renderableなど。)

postInvoke

void postInvoke(Object invocationResult,
              InvocationArguments args,
              InvocationMetadata metadata,
              RequestContext context,
              RequestValueResolvers resolvers)

Applicationを正常に実行した場合に、処理を追加します。
通常は、引数に指定されたinvocationResultの値(Application の実行結果)をそのまま返します。それ以外の値を返す(実行結果を挿げ替える) 事も可能です。

Parameters:

invocationResult - Applicationの実行結果

args - 例外が発生した対象のInvocationArguments

metadata - InvocationMetadata

context - RequestContext

resolvers - RequestValueResolvers

afterCompletion

void afterCompletion(RequestContext request,
                   ResponseContext response,
                   Exception e)

Application実行後に処理を追加します。
このメソッドはApplicationの実行において例外が発生した場合でも processException(Exception, RequestContext, PreparedInvocationArguments, InvocationMetadata) で結果が買えされない場合実行されます。

Parameters:

request - RequestContext

response - ResponseContext

e - Exception