uCosminexus Portal Framework　ポートレット開発ガイド

[目次][用語][索引][前へ][次へ]

jp.co.hitachi.soft.portal.api.log.PortletLog

機能

ポートレットからログを出力します。

Beanの項目

宣言
<jsp:useBean id="Log" 
class="jp.co.hitachi.soft.portal.api.log.PortletLog" scope="session" />

対象スコープ
session，request
requestは性能が低下するためsessionを推奨します。

メソッドの一覧

戻り値のデータ型 メソッド 説明
void debug(Object obj) デバッグログを出力します。
void error(Object obj) エラーログを出力します。
void error(Object obj, Throwable t) エラーログおよびスタックトレースを出力します。
void note(Object obj) 情報ログを出力します。
void printStackTrace(Throwable t) スタックトレースを出力します。
void setApplication(String appName) アプリケーション名を設定します。必ず最初にこのメソッドを呼び出してください。
void warn(Object obj) 警告ログを出力します。
void warn(Object obj, Throwable t) 警告ログおよびスタックトレースを出力します。

メソッドの説明

debug

形式
public void debug(Object obj)

機能
ログに対してデバッグログとしてobj.toString()の結果を出力します。このメソッドを呼び出す前に，setApplication()メソッドを呼び出す必要があります。setApplication()メソッドを呼び出す前にこのメソッドを呼び出すと，このメソッドは何もしないで戻ります。
ログの出力条件を次に示します。
  • メッセージID：KDPF99990-I
  • ログ出力レベルが30のときに出力
  • 種別：なし

パラメタ
obj - ログに出力する内容

戻り値
なし

例外
なし

error〔obj.toString()の結果をエラーログとして出力〕

形式
public void error(Object obj)

機能
ログに対してエラーログとして，obj.toString()の結果を出力します。このメソッドを呼び出す前に，setApplication()メソッドを呼び出す必要があります。setApplication()メソッドを呼び出す前にこのメソッドを呼び出すと，このメソッドは何もしないで戻ります。
ログの出力条件を次に示します。
  • メッセージID：KDPF99993-E
  • ログ出力レベルが0のときに出力
  • 種別：常に"ER"

パラメタ
obj - ログに出力する内容

戻り値
なし

例外
なし

error〔String.valueOf(obj)の結果をエラーログとして出力〕

形式
public void error(Object obj,
                 Throwable t)

機能
ログに対してエラーログとしてString.valueOf(obj)の結果を出力し，その次の行にスタックトレースを出力します。ただし，tがnullの場合はスタックトレースを出力しません。このメソッドを呼び出す前に，setApplication()メソッドを呼び出す必要があります。setApplication()メソッドを呼び出す前にこのメソッドを呼び出すと，このメソッドは何もしないで戻ります。
ログの出力条件を次に示します。
  • メッセージID：KDPF99993-E
  • ログ出力レベルが0のときに出力
  • 種別：常に"ER"

パラメタ
obj - ログに出力する内容
t - 警告を出力するきっかけとなったThrowable

戻り値
なし

例外
なし

note

形式
public void note(Object obj)

機能
ログに対して情報ログとしてobj.toString()の結果を出力します。このメソッドを呼び出す前に，setApplication()メソッドを呼び出す必要があります。setApplication()メソッドを呼び出す前にこのメソッドを呼び出すと，このメソッドは何もしないで戻ります。
ログの出力条件を次に示します。
  • メッセージID：KDPF99991-I
  • ログ出力レベルが20のときに出力
  • 種別：なし"

パラメタ
obj - ログに出力する内容

戻り値
なし

例外
なし

printStackTrace

形式
public void printStackTrace(Throwable t)

機能
ログに対してデバッグログとしてスタックトレースを出力します。ただし，tがnullの場合は何もしません。このメソッドを呼び出す前に，setApplication()メソッドを呼び出す必要があります。setApplication()メソッドを呼び出す前にこのメソッドを呼び出すと，このメソッドは何もしないで戻ります。
ログの出力条件を次に示します。
  • メッセージID：KDPF99990-I
  • ログ出力レベルが30のときに出力
  • 種別：なし

パラメタ
t - 警告を出力するきっかけとなったThrowable

戻り値
なし

例外
なし

setApplication

形式
public void setApplication(String appName)

機能
ログ出力Beanのアプリケーション名を設定します。このアプリケーション名は，ログ中のアプリケーション名の文字列として表示されます。appNameがnullまたは英数字以外を含む場合，アプリケーション名は設定されません。このとき，setApplication()メソッド後に呼ばれたログ出力メソッドについても何も行われません。このメソッドはインスタンスに対して1回だけ有効で，2回目以降は何もしないで戻ります。

パラメタ
appName - アプリケーション名（NULL以外の英数字）

戻り値
なし

例外
IllegalArgumentException - appNameに英数字以外が渡された場合：詳細メッセージは" There is an illegal letter in appName."
IllegalArgumentException - appNameがnullの場合：詳細メッセージは"appName is null."

warn〔obj.toString()の結果を警告ログとして出力〕

形式
public void warn(Object obj)

機能
ログに対して警告ログとして，obj.toString()の結果を出力します。このメソッドを呼び出す前に，setApplication()メソッドを呼び出す必要があります。setApplication()を呼び出す前にこのメソッドを呼び出すと，このメソッドは何もしないで戻ります。
ログの出力条件を次に示します。
  • メッセージID：KDPF99992-W
  • ログ出力レベルが10のときに出力
  • 種別：なし

パラメタ
obj - ログに出力する内容

戻り値
なし

例外
なし

warn〔String.valueOf(obj)の結果を警告ログとして出力し，次の行にスタックトレースを出力〕

形式
public void warn(Object obj,
                 Throwable t)

機能
ログに対してString.valueOf(obj)の結果を出力し，その次の行にスタックトレースを出力します。ただし，tがnullの場合はスタックトレースを出力しません。このメソッドを呼び出す前に，setApplication()メソッドを呼び出す必要があります。setApplication()を呼び出す前にこのメソッドを呼び出すと，このメソッドは何もしないで戻ります。
ログの出力条件を次に示します。
  • メッセージID：KDPF99992-W
  • ログ出力レベルが10のときに出力
  • 種別：tがnull以外の場合は"EC"，tがnullの場合はなし

パラメタ
obj - ログに出力する内容
t - 警告を出力するきっかけとなったThrowable

戻り値
なし

例外
なし

[目次][前へ][次へ]

[他社商品名称に関する表示]

All Rights Reserved. Copyright (C) 2009, 2013, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2009, 2013, Hitachi INS Software, Ltd.