org.dbflute.hook

クラス CallbackContext

java.lang.Object

org.dbflute.hook.CallbackContext

public class CallbackContext
extends Object

The context of callback in DBFlute deep logic.

作成者:

jflute

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static interface	CallbackContext.CallbackContextHolder The holder of for callback context.
protected static class	CallbackContext.InheritableBehaviorCommandHook
protected static class	CallbackContext.InheritableSqlFireHook

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected BehaviorCommandHook	_behaviorCommandHook
protected static CallbackContext.CallbackContextHolder	_defaultHolder The default holder for callback context, using thread local.
protected static ThreadLocal<CallbackContext>	_defaultThreadLocal The default thread-local for this.
protected static CallbackContext.CallbackContextHolder	_holder The holder for callback context, might be changed.
protected static boolean	_locked Is this static world locked?
protected SqlFireHook	_sqlFireHook
protected SqlLogHandler	_sqlLogHandler
protected SqlResultHandler	_sqlResultHandler
protected SqlStringFilter	_sqlStringFilter

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
CallbackContext()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected static void	assertNotLocked() Assert this is not locked.
static void	clearBehaviorCommandHookOnThread() Clear the hook interface of behavior commands from callback context on thread.
static void	clearCallbackContextOnThread() Clear callback context on thread.
protected static void	clearIfNoInterface(CallbackContext context)
static void	clearSqlFireHookOnThread() Clear the hook interface of behavior commands from callback context on thread.
static void	clearSqlLogHandlerOnThread() Clear the handler of SQL log from callback context on thread.
static void	clearSqlResultHandlerOnThread() Clear the handler of SQL result from callback context on thread.
static void	clearSqlStringFilterOnThread() Clear the filter of SQL string from callback context on thread.
protected CallbackContext.InheritableBehaviorCommandHook	createInheritableBehaviorCommandHook(BehaviorCommandHook behaviorCommandHook)
protected CallbackContext.InheritableSqlFireHook	createInheritableSqlFireHook(SqlFireHook sqlFireHook)
protected static CallbackContext.CallbackContextHolder	getActiveHolder() Get the active holder for callback context.
BehaviorCommandHook	getBehaviorCommandHook()
static CallbackContext	getCallbackContextOnThread() Get callback context on thread.
protected static CallbackContext	getOrCreateContext()
SqlFireHook	getSqlFireHook()
SqlLogHandler	getSqlLogHandler()
SqlResultHandler	getSqlResultHandler()
SqlStringFilter	getSqlStringFilter()
boolean	hasAnyInterface()
static boolean	isExistBehaviorCommandHookOnThread() Is existing the hook interface of behavior commands on thread?
static boolean	isExistCallbackContextOnThread() Is existing callback context on thread?
static boolean	isExistSqlFireHookOnThread() Is existing the hook interface of behavior commands on thread?
static boolean	isExistSqlLogHandlerOnThread() Is existing the handler of SQL log on thread?
static boolean	isExistSqlResultHandlerOnThread() Is existing the handler of SQL result on thread?
static boolean	isExistSqlStringFilterOnThread() Is existing the handler of SQL result on thread?
static boolean	isLocked() Is this static world locked?
static void	lock() Lock this static world, e.g. not to set the holder of thread-local.
void	setBehaviorCommandHook(BehaviorCommandHook behaviorCommandHook) Set the hook interface of behavior commands.
static void	setBehaviorCommandHookOnThread(BehaviorCommandHook behaviorCommandHook) Set the hook interface of behavior commands.
static void	setCallbackContextOnThread(CallbackContext callbackContext) Set callback context on thread.
void	setSqlFireHook(SqlFireHook sqlFireHook) Set the hook interface of SQL fires.
static void	setSqlFireHookOnThread(SqlFireHook sqlFireHook) Set the hook interface of SQL fires.
void	setSqlLogHandler(SqlLogHandler sqlLogHandler) Set the handler of SQL log.
static void	setSqlLogHandlerOnThread(SqlLogHandler sqlLogHandler) Set the handler of SQL log.
void	setSqlResultHandler(SqlResultHandler sqlResultHandler) Set the handler of SQL result.
static void	setSqlResultHandlerOnThread(SqlResultHandler sqlResultHandler) Set the handler of SQL result.
void	setSqlStringFilter(SqlStringFilter sqlStringFilter) Set the filter of SQL string.
static void	setSqlStringFilterOnThread(SqlStringFilter sqlStringFilter) Set the filter of SQL string.
String	toString()
static void	unlock() Unlock this static world, e.g. to set the holder of thread-local.
static void	useSurrogateHolder(CallbackContext.CallbackContextHolder holder) Use the surrogate holder for callback context.

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

_defaultThreadLocal

protected static final ThreadLocal<CallbackContext> _defaultThreadLocal

The default thread-local for this.

_defaultHolder

protected static final CallbackContext.CallbackContextHolder _defaultHolder

The default holder for callback context, using thread local. (NotNull)

_holder

protected static CallbackContext.CallbackContextHolder _holder

The holder for callback context, might be changed. (NotNull: null setting is not allowed)

_locked

protected static boolean _locked

Is this static world locked? e.g. you should unlock it to set your own provider.

_behaviorCommandHook

protected BehaviorCommandHook _behaviorCommandHook

_sqlFireHook

protected SqlFireHook _sqlFireHook

_sqlLogHandler

protected SqlLogHandler _sqlLogHandler

_sqlResultHandler

protected SqlResultHandler _sqlResultHandler

_sqlStringFilter

protected SqlStringFilter _sqlStringFilter

コンストラクタの詳細

CallbackContext

public CallbackContext()

メソッドの詳細

getCallbackContextOnThread

public static CallbackContext getCallbackContextOnThread()

Get callback context on thread.

戻り値:

The context of callback. (NullAllowed)

setCallbackContextOnThread

public static void setCallbackContextOnThread(CallbackContext callbackContext)

Set callback context on thread.
You can use setting methods per interface instead of this method.

パラメータ:

callbackContext - The context of callback. (NotNull)

isExistCallbackContextOnThread

public static boolean isExistCallbackContextOnThread()

Is existing callback context on thread?
You can use determination methods per interface instead of this method.

戻り値:

The determination, true or false.

clearCallbackContextOnThread

public static void clearCallbackContextOnThread()

Clear callback context on thread.
Basically you should call other clear methods per interfaces, because this clear method clears all interfaces.

getActiveHolder

protected static CallbackContext.CallbackContextHolder getActiveHolder()

Get the active holder for callback context.

戻り値:

The holder instance to handle callback context. (NotNull)

useSurrogateHolder

public static void useSurrogateHolder(CallbackContext.CallbackContextHolder holder)

Use the surrogate holder for callback context. (automatically locked after setting)
You should call this in application initialization if it needs.

パラメータ:

holder - The holder instance. (NullAllowed: if null, use default holder)

isLocked

public static boolean isLocked()

Is this static world locked?

戻り値:

The determination, true or false.

lock

public static void lock()

Lock this static world, e.g. not to set the holder of thread-local.

unlock

public static void unlock()

Unlock this static world, e.g. to set the holder of thread-local.

assertNotLocked

protected static void assertNotLocked()

Assert this is not locked.

setBehaviorCommandHookOnThread

public static void setBehaviorCommandHookOnThread(BehaviorCommandHook behaviorCommandHook)

Set the hook interface of behavior commands.
This hook interface is called back before executing behavior commands and finally.
The hook methods may be called by nested process so you should pay attention to it when you implements this.

 context.setBehaviorCommandHook(new BehaviorCommandHook() {
     public void hookBefore(BehaviorCommandMeta meta) {
         // You can implement your favorite callback here.
     }
     public void hookFinally(BehaviorCommandMeta meta, RuntimeException cause) {
         // You can implement your favorite callback here.
     }
 });
 

パラメータ:

behaviorCommandHook - The hook interface of behavior commands. (NullAllowed)

isExistBehaviorCommandHookOnThread

public static boolean isExistBehaviorCommandHookOnThread()

Is existing the hook interface of behavior commands on thread?

戻り値:

The determination, true or false.

clearBehaviorCommandHookOnThread

public static void clearBehaviorCommandHookOnThread()

Clear the hook interface of behavior commands from callback context on thread.
If the callback context does not have other interfaces, the context is removed from thread.

setSqlFireHookOnThread

public static void setSqlFireHookOnThread(SqlFireHook sqlFireHook)

Set the hook interface of SQL fires.
This hook interface is called back before firing SQL and finally.
The hook methods may be called by nested process so you should pay attention to it when you implements this.

 context.setSqlFireHook(new SqlFireHook() {
     public void hookBefore(BehaviorCommandMeta meta, SqlFireReadyInfo fireReadyInfo) {
         // You can implement your favorite callback here.
     }
     public void hookFinally(BehaviorCommandMeta meta, SqlFireResultInfo fireResultInfo) {
         // You can implement your favorite callback here.
     }
 });
 

パラメータ:

sqlFireHook - The hook interface of behavior commands. (NullAllowed)

isExistSqlFireHookOnThread

public static boolean isExistSqlFireHookOnThread()

Is existing the hook interface of behavior commands on thread?

戻り値:

The determination, true or false.

clearSqlFireHookOnThread

public static void clearSqlFireHookOnThread()

Clear the hook interface of behavior commands from callback context on thread.
If the callback context does not have other interfaces, the context is removed from thread.

setSqlLogHandlerOnThread

public static void setSqlLogHandlerOnThread(SqlLogHandler sqlLogHandler)

Set the handler of SQL log.
This handler is called back before executing the SQL.

 context.setSqlLogHandler(new SqlLogHandler() {
     public void handle(SqlLogInfo info) {
         // You can get your SQL string here.
     }
 });
 

パラメータ:

sqlLogHandler - The handler of SQL log. (NullAllowed)

isExistSqlLogHandlerOnThread

public static boolean isExistSqlLogHandlerOnThread()

Is existing the handler of SQL log on thread?

戻り値:

The determination, true or false.

clearSqlLogHandlerOnThread

public static void clearSqlLogHandlerOnThread()

Clear the handler of SQL log from callback context on thread.
If the callback context does not have other interfaces, the context is removed from thread.

setSqlResultHandlerOnThread

public static void setSqlResultHandlerOnThread(SqlResultHandler sqlResultHandler)

Set the handler of SQL result.
This handler is called back before executing the SQL.

 context.setSqlResultHandler(new SqlResultHandler() {
     public void handle(SqlResultInfo info) {
         // You can get your SQL result information here.
     }
 });
 

パラメータ:

sqlResultHandler - The handler of SQL result. (NullAllowed)

isExistSqlResultHandlerOnThread

public static boolean isExistSqlResultHandlerOnThread()

Is existing the handler of SQL result on thread?

戻り値:

The determination, true or false.

clearSqlResultHandlerOnThread

public static void clearSqlResultHandlerOnThread()

Clear the handler of SQL result from callback context on thread.
If the callback context does not have other interfaces, the context is removed from thread.

setSqlStringFilterOnThread

public static void setSqlStringFilterOnThread(SqlStringFilter sqlStringFilter)

Set the filter of SQL string.
This handler is called back before executing the SQL.

 context.setSqlStringFilter(new SqlStringFilter() {
     public String filter(String executedSql) {
         // You can filter your executed SQL string here.
     }
 });
 

パラメータ:

sqlStringFilter - The filter of SQL string. (NullAllowed)

isExistSqlStringFilterOnThread

public static boolean isExistSqlStringFilterOnThread()

Is existing the handler of SQL result on thread?

戻り値:

The determination, true or false.

clearSqlStringFilterOnThread

public static void clearSqlStringFilterOnThread()

Clear the filter of SQL string from callback context on thread.
If the callback context does not have other interfaces, the context is removed from thread.

getOrCreateContext

protected static CallbackContext getOrCreateContext()

clearIfNoInterface

protected static void clearIfNoInterface(CallbackContext context)

hasAnyInterface

public boolean hasAnyInterface()

toString

public String toString()

オーバーライド:

toString クラス内 Object

getBehaviorCommandHook

public BehaviorCommandHook getBehaviorCommandHook()

setBehaviorCommandHook

public void setBehaviorCommandHook(BehaviorCommandHook behaviorCommandHook)

Set the hook interface of behavior commands. (overriding existing hook as default)
This hook interface is called back before executing behavior commands and finally.

 context.setBehaviorCommandHook(new BehaviorCommandHook() {
     public void hookBefore(BehaviorCommandMeta meta) {
         // You can implement your favorite callback here.
     }
     public void hookFinally(BehaviorCommandMeta meta, RuntimeException cause) {
         // You can implement your favorite callback here.
     }
 });
 

The hook methods may be called by nested process so you should pay attention to it when you implements this.

Also you can inherit the existing hook with your hook by overriding inheritsExistingHook().

 context.setBehaviorCommandHook(new BehaviorCommandHook() {
     public void hookBefore(BehaviorCommandMeta meta) {
         ...
     }
     public void hookFinally(BehaviorCommandMeta meta, RuntimeException cause) {
         ...
     }
     public boolean inheritsExistingHook() {
         return true; // also existing hooks will be executed, 
     }
 });
 

パラメータ:

behaviorCommandHook - The hook interface of behavior commands. (NullAllowed)

createInheritableBehaviorCommandHook

protected CallbackContext.InheritableBehaviorCommandHook createInheritableBehaviorCommandHook(BehaviorCommandHook behaviorCommandHook)

getSqlFireHook

public SqlFireHook getSqlFireHook()

setSqlFireHook

public void setSqlFireHook(SqlFireHook sqlFireHook)

Set the hook interface of SQL fires. (overriding existing hook as default)
This hook interface is called back before firing SQL and finally.

 context.setSqlFireHook(new SqlFireHook() {
     public void hookBefore(BehaviorCommandMeta meta, SqlFireReadyInfo fireReadyInfo) {
         // You can implement your favorite callback here.
     }
     public void hookFinally(BehaviorCommandMeta meta, SqlFireResultInfo fireResultInfo) {
         // You can implement your favorite callback here.
     }
 });
 

The hook methods may be called by nested process so you should pay attention to it when you implements this.

Also you can inherit the existing hook with your hook by overriding inheritsExistingHook().

 context.setSqlFireHook(new SqlFireHook() {
     public void hookBefore(BehaviorCommandMeta meta, SqlFireReadyInfo fireReadyInfo) {
         ...
     }
     public void hookFinally(BehaviorCommandMeta meta, SqlFireResultInfo fireResultInfo) {
         ...
     }
     public boolean inheritsExistingHook() {
         return true; // also existing hooks will be executed, 
     }
 });
 

パラメータ:

sqlFireHook - The hook interface of SQL fires. (NullAllowed)

createInheritableSqlFireHook

protected CallbackContext.InheritableSqlFireHook createInheritableSqlFireHook(SqlFireHook sqlFireHook)

getSqlLogHandler

public SqlLogHandler getSqlLogHandler()

setSqlLogHandler

public void setSqlLogHandler(SqlLogHandler sqlLogHandler)

Set the handler of SQL log.
This handler is called back before executing the SQL.

 context.setSqlLogHandler(new SqlLogHandler() {
     public void handle(String executedSql, String displaySql
                      , Object[] args, Class<?>[] argTypes) {
         // You can get your SQL string here.
     }
 });
 

パラメータ:

sqlLogHandler - The handler of SQL log. (NullAllowed)

getSqlResultHandler

public SqlResultHandler getSqlResultHandler()

setSqlResultHandler

public void setSqlResultHandler(SqlResultHandler sqlResultHandler)

Set the handler of SQL result.
This handler is called back before executing the SQL.

 context.setSqlResultHandler(new SqlResultHandler() {
     public void handle(SqlResultInfo info) {
         // You can get your SQL result information here.
     }
 });
 

パラメータ:

sqlResultHandler - The handler of SQL result. (NullAllowed)

getSqlStringFilter

public SqlStringFilter getSqlStringFilter()

setSqlStringFilter

public void setSqlStringFilter(SqlStringFilter sqlStringFilter)

Set the filter of SQL string.
This filter is called back before executing the SQL.

 context.setSqlStringFilter(new SqlStringFilter() {
     public String filterSelectCB(BehaviorCommandMeta meta, String executedSql) {
         // You can filter your SQL string here.
     }
 });
 

パラメータ:

sqlStringFilter - The filter of SQL string. (NullAllowed)