クラス AbstractTraceInterceptor

メソッドの詳細

• setUseDynamicLogger

  public void setUseDynamicLogger(boolean useDynamicLogger)

  動的ロガーと静的ロガーのどちらを使用するかを設定します。デフォルトは、このトレースインターセプターの静的ロガーです。

  特定のメソッド呼び出しのログメッセージを書き込むために使用する Log インスタンスを決定するために使用されます。Class が呼び出される動的なインスタンス、またはトレースインターセプターの Class が静的なインスタンスです。

  注意 : このプロパティまたは "loggerName" のいずれかを指定します。両方は指定しないでください。

  関連事項:

  • getLoggerForInvocation(org.aopalliance.intercept.MethodInvocation)

• setLoggerName

  public void setLoggerName(StringSE loggerName)

  使用するロガーの名前を設定します。名前は Commons Logging を介して基盤となるロガー実装に渡され、ロガーの構成に従ってログカテゴリとして解釈されます。

  これは、クラスのカテゴリ（このインターセプターのクラスまたは呼び出されるクラスのいずれか）にログインするのではなく、特定の名前付きカテゴリにログインするように指定できます。

  注意 : このプロパティまたは "useDynamicLogger" のいずれかを指定します。両方は指定しないでください。

  関連事項:

  • LogFactory.getLog(String)
  • Logger.getLogger(String)SE

• setHideProxyClassNames

  public void setHideProxyClassNames(boolean hideProxyClassNames)

  "true" に設定すると、dynamic loggers が可能な限りプロキシクラス名を非表示にします。デフォルトは "false" です。

• setLogExceptionStackTrace

  public void setLogExceptionStackTrace(boolean logExceptionStackTrace)

  ロガーに例外を渡すかどうかを設定し、ログにスタックトレースを含めることを提案します。デフォルトは "true" です。これを "false" に設定して、ログ出力をトレースメッセージ（該当する場合は例外クラス名と例外メッセージが含まれる場合があります）だけに減らします。

  導入:

  4.3.10

• invoke

  @Nullable public ObjectSE invoke(MethodInvocation invocation) throws ThrowableSE

  特定の MethodInvocation に対してロギングを有効にするかどうかを決定します。そうでない場合、メソッド呼び出しは通常どおり続行されます。そうでない場合、メソッド呼び出しは処理のために invokeUnderTrace メソッドに渡されます。

  次で指定:

  インターフェース MethodInterceptor の invoke 

  パラメーター:

  invocation - メソッド呼び出しジョインポイント

  戻り値:

  Joinpoint.proceed() の呼び出しの結果。インターセプターによってインターセプトされる可能性があります

  例外:

  ThrowableSE - インターセプターまたはターゲットオブジェクトが例外をスローする場合

  関連事項:

  • invokeUnderTrace(org.aopalliance.intercept.MethodInvocation, org.apache.commons.logging.Log)

• getLoggerForInvocation

  protected Log getLoggerForInvocation(MethodInvocation invocation)

  指定された MethodInvocation に使用する適切な Log インスタンスを返します。useDynamicLogger フラグが設定されている場合、Log インスタンスは MethodInvocation のターゲットクラス用です。それ以外の場合は、Log がデフォルトの静的ロガーになります。

  パラメーター:

  invocation - トレースされる MethodInvocation 

  戻り値:

  使用する Log インスタンス

  関連事項:

  • setUseDynamicLogger(boolean)

• getClassForLogging

  protected ClassSE<?> getClassForLogging(ObjectSE target)

  ロギングの目的で使用するクラスを決定します。

  パラメーター:

  target - イントロスペクトするターゲットオブジェクト

  戻り値:

  指定されたオブジェクトのターゲットクラス

  関連事項:

  • setHideProxyClassNames(boolean)

• isInterceptorEnabled

  protected boolean isInterceptorEnabled(MethodInvocation invocation, Log logger)

  インターセプターを開始するかどうか、つまり invokeUnderTrace メソッドを呼び出す必要があるかどうかを決定します。

  デフォルトの動作は、指定された Log インスタンスが有効かどうかを確認することです。サブクラスはこれをオーバーライドして、他の場合にもインターセプターを適用できます。

  パラメーター:

  invocation - トレースされる MethodInvocation 

  logger - チェックする Log インスタンス

  関連事項:

  • invokeUnderTrace(org.aopalliance.intercept.MethodInvocation, org.apache.commons.logging.Log)
  • isLogEnabled(org.apache.commons.logging.Log)

• isLogEnabled

  protected boolean isLogEnabled(Log logger)

  指定された Log インスタンスが有効かどうかを確認します。

  「トレース」レベルが有効な場合、デフォルトは true です。サブクラスはこれをオーバーライドして、「トレース」が発生するレベルを変更できます。

  パラメーター:

  logger - チェックする Log インスタンス

• writeToLog

  protected void writeToLog(Log logger, StringSE message)

  提供されたトレースメッセージを提供された Log インスタンスに書き込みます。

  Enter/Exit メッセージのために invokeUnderTrace(org.aopalliance.intercept.MethodInvocation, org.apache.commons.logging.Log) によって呼び出されます。

  基になるロガーの呼び出しを制御する究極のデリゲートとして writeToLog(Log, String, Throwable) にデリゲートします。

  導入:

  4.3.10

  関連事項:

  • writeToLog(Log, String, Throwable)

• writeToLog

  protected void writeToLog(Log logger, StringSE message, @Nullable ThrowableSE ex)

  指定されたトレースメッセージと ThrowableSE を指定された Log インスタンスに書き込みます。

  Enter/Exit の結果（例外を含む可能性があります）のために invokeUnderTrace(org.aopalliance.intercept.MethodInvocation, org.apache.commons.logging.Log) によって呼び出されます。setLogExceptionStackTrace(boolean) が "false" の場合、例外のスタックトレースはログに記録されないことに注意してください。

  デフォルトでは、メッセージは TRACE レベルで書き込まれます。サブクラスはこのメソッドをオーバーライドして、メッセージが書き込まれるレベルを制御できます。通常、それに応じて isLogEnabled(org.apache.commons.logging.Log) もオーバーライドされます。

  導入:

  4.3.10

  関連事項:

  • setLogExceptionStackTrace(boolean)
  • isLogEnabled(org.apache.commons.logging.Log)

• invokeUnderTrace

  @Nullable protected abstract ObjectSE invokeUnderTrace(MethodInvocation invocation, Log logger) throws ThrowableSE

  提供された MethodInvocation をトレースするために、サブクラスはこのメソッドをオーバーライドする必要があります。サブクラスは、MethodInvocation.proceed() を呼び出して MethodInvocation が実際に実行されるようにする責任があります。

  デフォルトでは、渡された Log インスタンスでログレベル「トレース」が有効になります。サブクラスは、デフォルトの動作を変更するために isInterceptorEnabled メソッドを上書きし、実際のメッセージを書き込むために writeToLog に委譲しない限り、これを再度チェックする必要はありません。

  パラメーター:

  logger - トレースメッセージを書き込む Log 

  戻り値:

  MethodInvocation.proceed() の呼び出しの結果

  例外:

  ThrowableSE - MethodInvocation.proceed() の呼び出しでエラーが発生した場合

  関連事項:

  • isLogEnabled(org.apache.commons.logging.Log)
  • writeToLog(Log, String)
  • writeToLog(Log, String, Throwable)