org.seasar.mayaa.cycle
インタフェース ServiceCycle

すべてのスーパーインタフェース:

ParameterAware, PositionAware, java.io.Serializable

public interface ServiceCycle
extends ParameterAware, java.io.Serializable

サービスのライフサイクルオブジェクト。HTTPリクエストの期間、 サービスのコンテキストとなる。

フィールドの概要

static java.lang.String	SCOPE_APPLICATION アプリケーションレベルスコープ。
static java.lang.String	SCOPE_PAGE ページレベルスコープ。
static java.lang.String	SCOPE_REQUEST リクエストレベルスコープ。
static java.lang.String	SCOPE_SESSION セッションレベルスコープ。

インタフェース org.seasar.mayaa.ParameterAware から継承されたフィールド

IS_SECURE_WEB

メソッドの概要

void	error(int errorCode) エラーレスポンスを返す。
void	error(int errorCode, java.lang.String message) メッセージありのエラーレスポンスを返す。
void	forward(java.lang.String forwardPath) フォワードを行う。
ApplicationScope	getApplicationScope() アプリケーションスコープオブジェクトの取得。
AttributeScope	getAttributeScope(java.lang.String scopeName) 指定スコープを取得する。
java.lang.Throwable	getHandledError() エラーハンドル時に、発生した例外情報を参照する。
NodeTreeWalker	getInjectedNode() 現在処理中のインジェクションされたノード情報の取得。
NodeTreeWalker	getOriginalNode() 現在処理中のテンプレート上ノード情報の取得。
AttributeScope	getPageScope() 「page」スコープオブジェクトの取得。
ProcessorTreeWalker	getProcessor() 現在処理中のプロセッサの取得。
RequestScope	getRequestScope() リクエストオブジェクトの取得。
Response	getResponse() レスポンスオブジェクトの取得。
SessionScope	getSessionScope() セッションの取得。
boolean	hasAttributeScope(java.lang.String scopeName) 指定スコープを保持しているかをテストする。
boolean	isDebugMode() デバッグモードかどうかを返す。
java.util.Iterator	iterateAttributeScope() スコープをイテレートする。
void	load(java.lang.String systemID) カレントのページスコープにてスクリプトを読み込み、実行する。
void	load(java.lang.String systemID, java.lang.String encoding) カレントのページスコープにてスクリプトを読み込み、実行する。
void	redirect(java.lang.String url) リダイレクトを行う。
void	setHandledError(java.lang.Throwable t) エラーハンドル時に参照する、発生した例外情報の取得。
void	setInjectedNode(NodeTreeWalker node) 現在処理中のインジェクションされたノード情報の設定。
void	setOriginalNode(NodeTreeWalker node) 現在処理中のテンプレート上ノード情報を設定する。
void	setPageScope(AttributeScope page) 「page」スコープオブジェクトの設定。
void	setProcessor(ProcessorTreeWalker processor) 現在処理中のプロセッサの設定。
void	throwJava(java.lang.Throwable t) 例外をthrow。

インタフェース org.seasar.mayaa.ParameterAware から継承されたメソッド

getParameter, iterateParameterNames, setParameter

インタフェース org.seasar.mayaa.PositionAware から継承されたメソッド

getLineNumber, getSystemID, isOnTemplate, setLineNumber, setOnTemplate, setSystemID

フィールドの詳細

SCOPE_APPLICATION

static final java.lang.String SCOPE_APPLICATION

アプリケーションレベルスコープ。

関連項目:

定数フィールド値

SCOPE_SESSION

static final java.lang.String SCOPE_SESSION

セッションレベルスコープ。

関連項目:

定数フィールド値

SCOPE_REQUEST

static final java.lang.String SCOPE_REQUEST

リクエストレベルスコープ。

関連項目:

定数フィールド値

SCOPE_PAGE

static final java.lang.String SCOPE_PAGE

ページレベルスコープ。

関連項目:

定数フィールド値

メソッドの詳細

forward

void forward(java.lang.String forwardPath)

フォワードを行う。

パラメータ:

forwardPath - パス文字列。

redirect

void redirect(java.lang.String url)

リダイレクトを行う。

パラメータ:

url - リダイレクトを行うURL文字列。

error

void error(int errorCode)

エラーレスポンスを返す。

パラメータ:

errorCode - エラーコード。

error

void error(int errorCode,
           java.lang.String message)

メッセージありのエラーレスポンスを返す。

パラメータ:

errorCode - エラーコード。

message - エラーメッセージ。

load

void load(java.lang.String systemID)

カレントのページスコープにてスクリプトを読み込み、実行する。 ソースエンコーディングはUTF-8とする。

パラメータ:

systemID - スクリプトソースのSystemID。

load

void load(java.lang.String systemID,
          java.lang.String encoding)

カレントのページスコープにてスクリプトを読み込み、実行する。

パラメータ:

systemID - スクリプトソースのSystemID。

encoding - ソースエンコーディング。

throwJava

void throwJava(java.lang.Throwable t)
               throws java.lang.Throwable

例外をthrow。 レンダリング中にJavaの例外をthrowしたい場合に利用する。

パラメータ:

t - 投げる例外。

例外:

java.lang.Throwable

getApplicationScope

ApplicationScope getApplicationScope()

アプリケーションスコープオブジェクトの取得。

戻り値:

アプリケーション。

getRequestScope

RequestScope getRequestScope()

リクエストオブジェクトの取得。

戻り値:

リクエスト。

getSessionScope

SessionScope getSessionScope()

セッションの取得。

戻り値:

セッションオブジェクト。

getResponse

Response getResponse()

レスポンスオブジェクトの取得。

戻り値:

レスポンス。

setPageScope

void setPageScope(AttributeScope page)

「page」スコープオブジェクトの設定。

パラメータ:

page - 「page」スコープ。

getPageScope

AttributeScope getPageScope()

「page」スコープオブジェクトの取得。

戻り値:

「page」スコープ。

hasAttributeScope

boolean hasAttributeScope(java.lang.String scopeName)

指定スコープを保持しているかをテストする。

パラメータ:

scopeName - 指定スコープ名。

戻り値:

テスト結果。指定スコープを保持しているときtrue。

getAttributeScope

AttributeScope getAttributeScope(java.lang.String scopeName)

指定スコープを取得する。

パラメータ:

scopeName - 指定スコープ名。

戻り値:

指定スコープ。スコープが無い場合、例外。

iterateAttributeScope

java.util.Iterator iterateAttributeScope()

スコープをイテレートする。

戻り値:

スコープ（AttributeScope）のイテレータ。

setOriginalNode

void setOriginalNode(NodeTreeWalker node)

現在処理中のテンプレート上ノード情報を設定する。

パラメータ:

node - テンプレートノード。

getOriginalNode

NodeTreeWalker getOriginalNode()

現在処理中のテンプレート上ノード情報の取得。

戻り値:

テンプレートノード。

setInjectedNode

void setInjectedNode(NodeTreeWalker node)

現在処理中のインジェクションされたノード情報の設定。

パラメータ:

node - インジェクトされたノード。

getInjectedNode

NodeTreeWalker getInjectedNode()

現在処理中のインジェクションされたノード情報の取得。

戻り値:

インジェクトされたノード。

setProcessor

void setProcessor(ProcessorTreeWalker processor)

現在処理中のプロセッサの設定。

パラメータ:

processor - 処理中のプロセッサ。

getProcessor

ProcessorTreeWalker getProcessor()

現在処理中のプロセッサの取得。

戻り値:

処理中のプロセッサ。もしくはnull。

setHandledError

void setHandledError(java.lang.Throwable t)

エラーハンドル時に参照する、発生した例外情報の取得。

パラメータ:

t - 発生した例外。

getHandledError

java.lang.Throwable getHandledError()

エラーハンドル時に、発生した例外情報を参照する。

戻り値:

発生した例外。もしくはnull。

isDebugMode

boolean isDebugMode()

デバッグモードかどうかを返す。

戻り値:

デバッグモードならtrue、そうでなければfalse。