jp.co.cybec.cb3.container.service
クラス CB3Service

java.lang.Object
  上位を拡張 jp.co.cybec.cb3.container.service.CB3Service
すべての実装されたインタフェース:
Service

public abstract class CB3Service
extends Object
implements Service

サービス基底クラス。
サービスのテンプレートを提供します。 サービスクラス作成時は、このクラスを継承します。

作成者:
Naoko Sugimoto

コンストラクタの概要
CB3Service()
           
 
メソッドの概要
 int callService(ServiceParameters serviceParameters, RuntimeParameters runtimeParameters)
          サービスを実行します。
protected abstract  int doService(ServiceParameters serviceParameters, RuntimeParameters runtimeParameters)
          業務処理を記述するメソッドです。
 DataAccessContext getDataAccessContext()
          データアクセスコンテキストを返します。
 void setDataAccessContext(DataAccessContext dataAccessContext)
          データアクセスコンテキストを設定します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

CB3Service

public CB3Service()
メソッドの詳細

setDataAccessContext

public void setDataAccessContext(DataAccessContext dataAccessContext)
データアクセスコンテキストを設定します。

定義:
インタフェース Service 内の setDataAccessContext
パラメータ:
dataAccessContext - データアクセスコンテキスト

getDataAccessContext

public DataAccessContext getDataAccessContext()
データアクセスコンテキストを返します。

定義:
インタフェース Service 内の getDataAccessContext
戻り値:
データアクセスコンテキスト

callService

public int callService(ServiceParameters serviceParameters,
                       RuntimeParameters runtimeParameters)
サービスを実行します。

定義:
インタフェース Service 内の callService
パラメータ:
serviceParameters - サービスパラメータ
runtimeParameters - 起動パラメータ
戻り値:
実行結果

doService

protected abstract int doService(ServiceParameters serviceParameters,
                                 RuntimeParameters runtimeParameters)
                          throws ServiceException
業務処理を記述するメソッドです。
サービスクラスでは、このメソッドをオーバーライドし、業務処理を記述します。
このメソッドには、ServiceParametersRuntimeParametersが引数として渡されます。

・ServiceParametersの使用方法
ServiceParametersは、サービス間のパラメータ受け渡しに使用できます。
ServiceParametersはジョブ内で1つであり、あるサービス内でセットしたパラメータは、 他のサービスに引数として渡されたServiceParametersから取得できます。
ServiceParameters.put(String, Serializable)に指定するサービスパラメータキーは ジョブ内で一意である必要があります。

通常、ServiceParameters.put(String, Serializable)の引数に レコード単位のデータをセットすることは想定されていません。

想定されない使用例:
サービスパラメータキー = ユーザID("0001"など)
サービスパラメータ = ユーザ名("Naoko Sugimoto"など)

ジョブ内で一意性を持てる単位でサービスパラメータキーを定義してください。

使用例:
サービスパラメータキー = テーブル名
サービスパラメータ = テーブルを表現するオブジェクト

・RuntimeParametersの使用方法
RuntimeParametersには、アプリケーション起動時に渡された引数が格納されています。

 例:コンソール>java (略) xxx.ServiceProviderImpl -ServiceName sample -AppParams key1=value1 key2=value2 ...
 
起動時に上記のような引数が指定された場合、-AppParams以降がRuntimeParametersに格納され、 RuntimeParameters.get(String)を使用して取得することができます。
 runtimeParameters.get("key1") → "value1"
 runtimeParameters.get("key2") → "value2"
  …
 

パラメータ:
serviceParameters - サービスパラメータ
runtimeParameters - 起動パラメータ
戻り値:
実行結果
例外:
ServiceException - 業務処理で何らかの例外が発生した場合。


Copyright © 2008 Cyber Beans Corporation. All Rights Reserved.