ビジネス・ロジックの追加

ビジネス・ロジックは、ホスト画面の認識や HATS アプリケーションの起動などのイベントの発生時に、アクションとして起動されるあらゆる Java™ コードです。ビジネス・ロジックはアプリケーションに固有のものであり、HATS の一部として提供されるものではありません。ユーザーはビジネス・ロジックを使用して、HATS アプリケーションを拡張し、データベースや統合オブジェクトなどの他のデータ・ソースと統合することができます。例えば、ファイルやデータベースの内容を HATS グローバル変数へ読み取ることや、そのグローバル変数を使用して、アプリケーションの GUI ページで使用するドロップダウン・リストやポップアップに入力することができます。

HATS Web プロジェクトに HATS ビジネス・ロジックを組み込む際、HATS によってクラス・ローダー・ポリシーが自動的に更新されます。これにより、HATS アプリケーションのデフォルト WAR クラス・ローダー・ポリシーが、「アプリケーションの単一クラス・ローダー」に更新されます。

ビジネス・ロジックを作成してプロジェクトに追加するには、「ビジネス・ロジックの作成」ウィザードを使用します。このウィザードを起動するには、HATS Toolkit の「HATS プロジェクト」タブを右クリックして、「新規 HATS」>「ビジネス・ロジック」とクリックします。

「ビジネス・ロジックの作成」ウィザードで、ビジネス・ロジックを追加するプロジェクトを指定し、Java クラス名を入力します。デフォルトのパッケージ名は、projectName.businessLogic ですが、これは Studio の「設定」で変更することができます。オプションで、パッケージ名を指定するか、「参照」をクリックして既存の Java パッケージを選択することができます。プロジェクトのグローバル変数に簡単にアクセスするためのメソッドをビジネス・ロジックに組み込むか、または、プロジェクトのグローバル変数を除去する場合は、「グローバル変数ヘルパー・メソッドの作成」チェック・ボックスを選択します。必要な情報を入力したら、「完了」をクリックします。

HATS IBM® ポートレット・プロジェクトには、「ポートレット・サンプル・メソッドの作成」チェック・ボックスも含まれています。認証データへのアクセス、認証データの取得、ポートレット・メッセージング、またはプロパティー・ブローカーの使用などの機能のサンプルをビジネス・ロジックに組み込む場合は、このチェック・ボックスを選択します。これらのサンプルについて詳しくは、HATS ポートレットでのプログラミングを参照してください。

ビジネス・ロジック・クラスの作成後、それを 1 つ以上の画面イベントやアプリケーション・イベントにリンクして、そのイベントの発生時に実行させることができます。リンクの追加先の各イベント (アプリケーション・イベントまたは画面カスタマイズ) を編集します。「アクション」タブの「追加」をクリックして、「ビジネス・ロジックを実行」を選択し、ビジネス・ロジック・クラスの詳細を入力します。画面カスタマイズの編集とイベントの編集のいずれについても、「HATS ユーザーと管理者のガイド」を参照してください。

プロジェクト内のビジネス・ロジック・ファイルを見るには、HATS Toolkit の「HATS プロジェクト表示」タブ上のソース・フォルダーを展開します。ソース・フォルダー内の個々のパッケージ名またはクラス名が表示されます。Java クラス名を見るには、パッケージ名フォルダーを展開します。クラスを編集するには、クラス名をクリックします。 ソース・フォルダーには、HATS プロジェクトにインポートされたその他の Java ファイルも組み込むことができます。

「ビジネス・ロジックの作成」ウィザードを使用してビジネス・ロジックを作成する場合、デフォルトでは、実行アクションによって起動されるメソッドに execute という名前が付けられます。独自のクラスを作成する場合は、メソッドに以下の属性がなければなりません。

メソッドは、次のように上の形式を使用して、この後にユーザー独自のビジネス・ロジック・コードを続ける必要があります。

public static void myMethod (IBusinessLogicInformation businesslogic)

カスタム Java コードに渡される IBusinessLogicInformation オブジェクトにより、HATS プロジェクトの各種オブジェクトおよび設定にアクセスし、それらを使用または変更することができます。この種のオブジェクトや設定には以下のものがあります。

使用可能なクラスについて詳しくは、HATS インフォメーション・センター (http://publib.boulder.ibm.com/infocenter/hatshelp/v75/index.jsp) にある HATS API 資料に記載された IBusinessLogicInformation クラスを参照してください。 IBusinessLogicInformation は、IBaseInfo クラスを拡張するため、これらの API のいくつかは IBaseInfo クラスで定義されます。

他のアプリケーションからの Java コードの組み込み

他の既存のアプリケーションから HATS プロジェクトに Java コードを組み込むには、いくつか方法があります。

既存のビジネス・ロジックからソース・コード (.java ファイル) を組み込んで、そのコードを変更できるようにする場合は、既存プロジェクトのソース・フォルダーに .java ファイルをインポートすることができます。「ファイル」>「インポート」>「一般」>「ファイル・システム」をクリックして、「インポート」ウィザードを開きます。「インポート」ウィザードでは、「ソース・ディレクトリー」フィールドでソース・ファイルの場所を選択します。Web プロジェクトの場合は、宛先の「宛先フォルダー」入力フィールドで、プロジェクトの Java ソース・フォルダーを選択します。インポートされたソース .java ファイルは自動的にコンパイルされて、HATS プロジェクトに組み込まれます。Rational® SDP ワークベンチで、ソース・ファイルの編集、ブレークポイント設定、デバッグが可能です。

コンパイル済みの Java ビジネス・ロジックを、Java アーカイブ・ファイル (.jar) に組み込むこともできます。Java アーカイブ全体が追加されます。個々のクラスを選択して追加することはできません。

  1. .jar ファイルを HATS EAR プロジェクトにインポートします。
    1. 「ファイル」>「インポート」>「一般」>「ファイル・システム」をクリックして、「インポート」ウィザードを開きます。
    2. 「ソース・ディレクトリー」フィールドで、インポートする Java アーカイブ (.jar) のソース・ディレクトリーを選択します。
    3. 右側のペインから、.jar ファイルを選択します。
    4. 「宛先フォルダー」フィールドで、使用している HATS EAR プロジェクトを宛先として選択します。
    5. 「完了」をクリックします。
    6. .jar ファイルがインポートされたら、HATS Toolkit の「ナビゲーター」タブをクリックし、HATS ear プロジェクトを展開します。インポートした java アーカイブ・ファイルが表示されます。
  2. java アーカイブをプロジェクトのビルド・パスに追加します。
    1. HATS Toolkit の「ナビゲーター」タブで、ビジネス・ロジックを起動するプロジェクトを選択します。
    2. 上位の HATS プロジェクトを右マウス・ボタンでクリックし、「プロパティー」を選択します。
    3. 「プロパティー」ウィンドウで、左方のテーブルから「Java のビルド・パス」を選択し、右側の「ライブラリー」タブをクリックします。
    4. 「JAR の追加」をクリックして、「JAR の選択」ウィンドウを開きます。
    5. HATS EAR プロジェクトを展開し、新たにインポートした Java アーカイブ・ファイルを選択します。
    6. 「JAR の選択」ウィンドウで「OK」をクリックし、「プロパティー」ウィンドウで「OK」をクリックします。
    7. ビジネス・ロジックを使用するすべての HATS プロジェクトについて、このプロセスを繰り返してください。
  3. ビジネス・ロジックが起動されるプロジェクトを定義します。
    1. HATS Toolkit の「ナビゲーター」タブで、ビジネス・ロジックを起動するプロジェクトを再び選択します。
    2. プロジェクト、「Web コンテンツ」フォルダー、および「META-INF」フォルダーを展開します。
    3. MANIFEST.MF ファイルをダブルクリックして、JAR 依存関係エディターを開きます。プロジェクトのクラスパスに組み込む各 .jar ファイルの横のチェック・ボックスを選択します。

Java アーカイブを HATS プロジェクトにインポートする方法は、他にもあります。HATS プロジェクトは、Rational SDP ワークベンチ内の Web プロジェクトの拡張版です。Web プロジェクトへのファイルのインポートの詳細については、Rational SDP の「ヘルプ」を開き、「Web プロジェクト」を検索してください。

ビジネス・ロジックでのグローバル変数の使用

HATS アプリケーションでグローバル変数を使用して情報を保管している場合は、それらのグローバル変数をビジネス・ロジックで使用できます。

グローバル変数にはローカルと共用の 2 つのタイプがあります。ローカル・グローバル変数は HATS プロジェクト内で作成され、そのプロジェクトに対してのみ可視の変数です。共用グローバル変数は、EAR ファイル内のすべてのアプリケーションに対して可視であり使用可能な変数です。また、HATS グローバル変数には 2 つのリストがあります。1 つはローカル・グローバル変数用で、もう 1 つは共用グローバル変数用です。同じ名前を持つ 2 つのグローバル変数は、1 つがローカルでもう 1 つが共用であれば共存できます。

ビジネス・ロジック・クラスを作成する際は、「ビジネス・ロジックの作成」ウィザードを使用して、「グローバル変数ヘルパー・メソッドの作成」チェック・ボックスを選択します。これによって、ビジネス・ロジックに、ローカル・グローバル変数および共用グローバル変数を取得、設定、および除去するためのメソッドが作成されます。

以下のメソッドが作成されます。

////////////////////////////////////////////////////////////////////////////////
//  This sample is provided AS IS.
//  Permission to use, copy and modify this software for any purpose and
//  without fee is hereby granted. provided that the name of IBM not be used in
//  advertising or publicity pertaining to distribution of the software without
//  specific written permission.
//
//  IBM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SAMPLE, INCLUDING ALL
//  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL IBM
//  BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
//  DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
//  IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
//  OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SAMPLE.
////////////////////////////////////////////////////////////////////////////////
/**
	* Example method that sets a named global variable 
	* from the current session to a value
	* @param blInfo - IBusinessLogicInformation from current session
	* @param name - Name of the global variable
	* @param value - Value of the global variable
	*/
public static void setGlobalVariable(IBusinessLogicInformation blInfo,
					String name,Object value)
{
		IGlobalVariable gv = blInfo.getGlobalVariable(name);
		if ( gv == null )
			{
				gv = new GlobalVariable(name,value);
			}
		else
			{
				gv.set(value); 
			}
		blInfo.getGlobalVariables().put(name,gv);
}

/**
	* Example method that sets a named shared
	* global variable from the current session to a value
	* @param blInfo - IBusinessLogicInformation from current session
	* @param name - Name of the shared global variable
	* @param value - Value of the shared global variable
	*/ 
public static void setSharedGlobalVariable(IBusinessLogicInformation 
		blInfo,String name,Object value)
{
		IGlobalVariable gv = blInfo.getSharedGlobalVariable(name);
		if ( gv == null )
			{
				gv = new GlobalVariable(name,value);
			}
		else
			{
				gv.set(value); 
			}
		blInfo.getSharedGlobalVariables().put(name,gv);
}

/**
	* Example method that removes a named global variable from the current session
	* @param blInfo - IBusinessLogicInformation from current session
	* @param name - Name of the global variable
*/
public static void removeGlobalVariable(IBusinessLogicInformation blInfo, String  name)
{
		IGlobalVariable gv = blInfo.getGlobalVariable(name);
		if ( gv != null )
			{
				blInfo.getGlobalVariables().remove(name);
				gv.clear();
				gv = null;
			}
}
/**
	* Example method that removes a named shared global variable from the current session
	* @param blInfo - IBusinessLogicInformation from current session
	* @param name - Name of the shared global variable
*/
public static void removeSharedGlobalVariable(IBusinessLogicInformation blInfo, String name)
{
		IGlobalVariable gv = blInfo.getSharedGlobalVariable(name);
			if ( gv != null )
				{
					blInfo.getSharedGlobalVariables().remove(name);
					gv.clear();
					gv = null;
				}
}
/**
	* Example method that retrieves a named global variable from the current session
	* @param blInfo - IBusinessLogicInformation from current session
	* @param name - Name of the global variable
	* @return - an instance of the global variable, or null if not found.
	*/
public static IGlobalVariable getGlobalVariable(IBusinessLogicInformation 
		blInfo,String name)
{ 
		IGlobalVariable gv = blInfo.getGlobalVariable(name);
		return gv;
}

/**
	* Example method that retrieves a named shared 
	* global variable from the current session
	* @param blInfo - IBusinessLogicInformation from current session
	* @param name - Name of the shared global variable
	* @return - an instance of the global variable, or null if not found.
	*/
public static IGlobalVariable getSharedGlobalVariable(IBusinessLogicInformation 
		blInfo,String name)
{ 
		IGlobalVariable gv = blInfo.getSharedGlobalVariable(name);
		return gv;
}

コード内の別の部分でローカル・グローバル変数の値が必要になった場合は、このメソッドを呼び出すことができます。

  GlobalVariable gv1 = getGlobalVariable(blInfo,"varname");

共用グローバル変数の値を取得するには、次のメソッドを使用します。

  GlobalVariable gv1 = getSharedGlobalVariable(blInfo,"varname");

ビジネス・ロジックの例

ここでは、ビジネス・ロジックの使用例を示します。各例では、グローバル変数を扱います。それぞれの例で前述のグローバル変数ヘルパー・メソッドを 1 つ以上使用するため、クラスにそれらのメソッドを組み込む必要があります。ここでは、コード例を見やすくするため、スタブが省略されています。

例: 日付変換

この例では、日付を mm/dd/yy の形式から月、日、年の形式に変換します。例えば、6/12/2004 は June 12, 2004 に変換されます。この例では、ビジネス・ロジックが呼び出される前にグローバル変数 theDate が設定されていることを前提としています。この例では、以下のメソッドをどのように使用して入力変数の値を取得しているかに注意してください。

IGlobalVariable inputDate = getGlobalVariable(blInfo, "theDate");

この例では、標準の Java 関数を使用して日付を希望の形式で表示するようにストリングを操作した後で、以下のメソッドを使用して同じグローバル変数に新規ストリングを組み込んでいます。

setGlobalVariable(blInfo, "theDate", formattedDate);

////////////////////////////////////////////////////////////////////////////////
//  This sample is provided AS IS.
//  Permission to use, copy and modify this software for any purpose and
//  without fee is hereby granted. provided that the name of IBM not be used in
//  advertising or publicity pertaining to distribution of the software without
//  specific written permission.
//
//  IBM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SAMPLE, INCLUDING ALL
//  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL IBM
//  BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
//  DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
//  IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
//  OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SAMPLE.
////////////////////////////////////////////////////////////////////////////////
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;

import com.ibm.hats.common.IBusinessLogicInformation;
import com.ibm.hats.common.GlobalVariable;
import com.ibm.hats.common.IGlobalVariable;

public class CustomDateFormatter
{
 		public static void execute(IBusinessLogicInformation blInfo)
			{
				IGlobalVariable inputDate = getGlobalVariable(blInfo, "theDate");
				SimpleDateFormat inputFormat = new SimpleDateFormat("MM/dd/yyyy");
				SimpleDateFormat outputFormat = new SimpleDateFormat("MMMM dd, yyyy");
       		
				try 
					{
						Date tempDate = inputFormat.parse(inputDate.getString().trim()); 
						String formattedDate = outputFormat.format(tempDate); 
						setGlobalVariable(blInfo, "theDate", formattedDate);
					} 
						catch (ParseException ex) 
							{
								ex.printStackTrace();
							}
			}
}

例: 索引付きグローバル変数に含まれている値の追加

この例では、索引付きグローバル変数に含まれている値を追加し、別の索引なしグローバル変数に合計を保管します。これは、数値を表すストリングが索引付きグローバル変数 subtotals に保管されていることを前提としています。

前の例では、入力グローバル変数と出力グローバル変数 (theDate) の名前が set 呼び出しに含まれていました。この例では、入力変数と出力変数の名前をローカル・ストリング変数内に設定し、それらのストリングを呼び出しで使用してグローバル変数値を取得および設定します。グローバル変数の名前は変数として渡されているため、引用符で囲まれていません。

setGlobalVariable(blInfo,gvOutputName, new Float(myTotal));

////////////////////////////////////////////////////////////////////////////////
//  This sample is provided AS IS.
//  Permission to use, copy and modify this software for any purpose and
//  without fee is hereby granted. provided that the name of IBM not be used in
//  advertising or publicity pertaining to distribution of the software without
//  specific written permission.
//
//  IBM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SAMPLE, INCLUDING ALL
//  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL IBM
//  BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
//  DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
//  IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
//  OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SAMPLE.
////////////////////////////////////////////////////////////////////////////////
import com.ibm.hats.common.IBusinessLogicInformation;
import com.ibm.hats.common.GlobalVariable;
import com.ibm.hats.common.IGlobalVariable;

  public static void execute(IBusinessLogicInformation blInfo)
    {
    	// Name of indexed global variable to be read in
        String gvInputName = "subtotals";
        // Name of global variable to be calculated and saved
        String gvOutputName = "total";
        
        // The indexed global variable where each index is a subtotal to be summed
        GlobalVariable gvSubtotals = 
					((GlobalVariable)getGlobalVariable(blInfo, gvInputName));
        
        float myTotal = 0;
        
        // Calculate the total by adding all subtotals
        for (int i = 0; i < gvSubtotals.size(); i++)
        {
        	myTotal = myTotal + Float.valueOf(gvSubtotals.getString(i)).floatValue();
        }
		
        // Save the total as a non-indexed local variable
        setGlobalVariable(blInfo,gvOutputName, new Float(myTotal));
    }

例: ファイルから索引付きグローバル変数へのストリング・リストの読み取り

この例では、ファイル・システムからファイルを読み取り、ファイル内のストリングを索引付きグローバル変数に保管します。こうした技法を使用して、例えば会社の場所のリストを含むファイルを読み取ることができます。グローバル変数にストリングを保管した後、そのグローバル変数を使用してドロップダウン・リストやその他のウィジェットに値を入力し、ユーザーが値のリストから選択できるようにすることができます。適切な入力フィールドがあるところではどこでも、このウィジェットを使用するためのグローバル規則を作成できます。アプリケーションが起動するとすぐにグローバル変数が使用可能になるようにするには、このビジネス・ロジック・クラスの実行アクションを Start イベントに追加します。

注:
テキスト・ファイルが行間に復帰および改行を使用している場合、次の例の StringTokenizer コンストラクターの呼び出しで 2 番目の引数として「¥r¥n」を使用する必要があります。

////////////////////////////////////////////////////////////////////////////////
//  This sample is provided AS IS.
//  Permission to use, copy and modify this software for any purpose and
//  without fee is hereby granted. provided that the name of IBM not be used in
//  advertising or publicity pertaining to distribution of the software without
//  specific written permission.
//
//  IBM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SAMPLE, INCLUDING ALL
//  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL IBM
//  BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
//  DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
//  IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
//  OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SAMPLE.
////////////////////////////////////////////////////////////////////////////////
import com.ibm.ejs.container.util.ByteArray;
import com.ibm.hats.common.IBusinessLogicInformation;
import com.ibm.hats.common.GlobalVariable;
import com.ibm.hats.common.IGlobalVariable;

public class ReadNamesFromFile
{

  public static void execute(IBusinessLogicInformation blInfo)
  {
		// Name of indexed global variable to be saved
		String gvOutputName = "namesFromFile";
		
		// The file containing a list of information (in this case, it contains names)
		java.io.File myFileOfNames = new java.io.File("C:" + java.io.File.separator
						 + "temp" + java.io.File.separator + "names.txt");
    	
    	try
    	{
			// First, read the contents of the file
			
			java.io.FileInputStream fis = new java.io.FileInputStream(myFileOfNames);
			
			int buffersize = (int)myFileOfNames.length(); 
			byte[] contents = new byte[buffersize];; 

			long n = fis.read(contents, 0, buffersize);
			 
			fis.close();
			
			String namesFromFile = new String(contents);
			
			// Next, create an indexed global variable from the file contents
			
			java.util.StringTokenizer stok = 
						new java.util.StringTokenizer(namesFromFile, "¥n", false);
			
			int count = stok.countTokens();
			String[] names = new String[count];
			for (int i = 0; i < count; i++)
			{
				names[i] = stok.nextToken();
			}
			
			IGlobalVariable gv = new GlobalVariable(gvOutputName, names);
			blInfo.getGlobalVariables().put(gvOutputName,gv);			
    	}
    	catch (java.io.FileNotFoundException fnfe)
    	{
    		fnfe.printStackTrace();
    	}
    	catch (java.io.IOException ioe)
    	{
    		ioe.printStackTrace();
    	}
  }
}

例: 統合オブジェクトの呼び出し

この例では、ビジネス・ロジックからの統合オブジェクトの呼び出し例を示します。例では、input というストリングを 1 つの入力パラメーターとして使用し、output というストリングを戻す Iomac という統合オブジェクトがあることを前提としています。

このビジネス・ロジックは、次の手順を実行します。

  1. 統合オブジェクトのインスタンスを生成します。
     IntegrationObject.Iomac io = new IntegrationObject.Iomac();
  2. グローバル変数から入力変数を設定します。
    io.setInput(getGlobalVariable(blInfo,"input").getString());
  3. HATS ラッパー・メソッドからサーブレット要求と応答オブジェクトを取得し、その要求と応答を使用して統合オブジェクトを呼び出します。
    WebRequest webReq = (WebRequest)blInfo.getRequest();
    HttpServletRequest req = webReq.getHttpServletRequest();
    WebResponse webResp = (WebResponse)blInfo.getResponse();
    HttpServletResponse resp = webResp.getHttpServletResponse();
    io.doHPTransaction(req,resp);
  4. 例外を確認します。
  5. 統合オブジェクトが正常に実行されたら、グローバル変数出力を、統合オブジェクトの getOutput() メソッドによって返された値に設定します。
    if (io.getHPubErrorOccurred() == 0)
    			setGlobalVariable(blInfo,"output",io.getOutput());

複数の入力変数を受け入れる統合オブジェクトや複数の変数を戻す統合オブジェクトを起動するには、setter 呼び出しと getter 呼び出しを追加して入力変数を設定してから、統合オブジェクトを起動し、その実行後に出力値を検索します。

////////////////////////////////////////////////////////////////////////////////
//  This sample is provided AS IS.
//  Permission to use, copy and modify this software for any purpose and
//  without fee is hereby granted. provided that the name of IBM not be used in
//  advertising or publicity pertaining to distribution of the software without
//  specific written permission.
//
//  IBM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SAMPLE, INCLUDING ALL
//  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL IBM
//  BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
//  DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
//  IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
//  OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SAMPLE.
////////////////////////////////////////////////////////////////////////////////
import com.ibm.hats.common.IBusinessLogicInformation;
import com.ibm.hats.common.GlobalVariable;
import com.ibm.hats.common.IGlobalVariable;

public class myLogic
{

    public static void execute(IBusinessLogicInformation blInfo)
    {
        //add code here to perform your business logic
        IntegrationObject.Iomac io = new IntegrationObject.Iomac();

		// Set Integration Object's HAOVariable "input" 
		// equal to text from HATS gv "input"
		io.setInput(getGlobalVariable(blInfo,"input").getString());
	
		// Get the request and response objects from the HATS wrapper method and run the hp transaction
		
		try {
			WebRequest webReq = (WebRequest)blInfo.getRequest();
			HttpServletRequest req = webReq.getHttpServletRequest();
			WebResponse webResp = (WebResponse)blInfo.getResponse();
			HttpServletResponse resp = webResp.getHttpServletResponse();
			io.doHPTransaction(req,resp);
		}
		catch (Exception e) { 
			System.out.println("Exception thrown: " + e.toString());
			setGlobalVariable(blInfo,"output",
				"An exception was thrown. Please view the log for more details");
		}
		
		// Retrieve "output" computed through IO transaction 
		// and set it to HATS gv "output"
		
		if (io.getHPubErrorOccurred() == 0) {
			setGlobalVariable(blInfo,"output",io.getOutput());
			System.out.println("Transaction has been completed successfully.");		 
		}
		else {
			setGlobalVariable(blInfo,"output","Transaction has failed unexpectedly. 
					HATS Error message = " + io.getHPubErrorMessage());
			System.out.println("Transaction failed unexpectedly. HATS Error message =
					" + io.getHPubErrorMessage()");		}
    }
}

カスタム画面認識の使用

ビジネス・ロジックを使用して、カスタム画面認識を実行できます。 HATS Toolkit では、画面カスタマイズに画面認識のオプションが多数用意されています。これには、画面上のフィールド数、ストリングの有無、グローバル変数の使用などがあります。これらのオプションについては、「HATS ユーザーと管理者のガイド」を参照してください。しかし、画面カスタマイズ・エディターのオプションでは設定できないような方法で画面を認識したい場合もあるでしょう。そのような場合は、独自のカスタム画面認識論理を追加できます。

注:
ここで説明する情報は、画面カスタマイズだけでなくマクロでの画面認識にも適用できます。

HATS グローバル変数を使用してカスタム画面認識論理を作成する方法については、グローバル変数を使用したカスタム画面認識を参照してください。

すでに ECLCustomRecoListener クラスを拡張してカスタム画面認識論理を作成してある場合は、その論理を HATS 内で使用できます。新規カスタム論理を作成する場合は、次の手順に従ってください。

  1. Java パースペクティブを開きます。
  2. 「ファイル」>「新規」>「クラス」とクリックします。
  3. HATS プロジェクトのソース・ディレクトリーを参照します。
  4. パッケージとクラスの名前を入力します。
  5. スーパークラスの場合は、「参照」をクリックして、com.ibm.hats.common.customlogic.AbstractCustomScreenRecoListener を見つけます。
  6. 「継承された抽象メソッド」チェック・ボックスを選択します。 「完了」をクリックします。これにより、指定したプロジェクトにコード・スケルトンがインポートされます。
  7. isRecognized メソッドに論理を追加します。ブール値が戻されることを確認します。

    public boolean isRecognized(String arg0, IBusinessLogicInformation arg1, ECLPS arg2, ECLScreenDesc arg3)

    このメソッドの詳細については、HATS Information Center で HATS API の資料を参照してください。

  8. メソッドの作成後、画面認識を更新してメソッドを呼び出す必要があります。「HATS プロジェクト」ビューから、プロジェクトと「画面カスタマイズ」フォルダーを展開します。カスタム論理を追加する画面カスタマイズの名前をダブルクリックします。「ソース」タブをクリックして画面カスタマイズのソース・ビューを開きます。
  9. ソース・ビュー内に、<description> タグで始まり </description> タグで終わるブロックが表示されます。このブロックには、画面の認識に使用される情報が含まれています。カスタム論理を起動するには、このブロック内に行を追加します。

    <customreco id="customer.class.package.MyReco::settings" invertmatch="false" optional="false"/>

    ここで、customer.class.package.MyReco はご使用のパッケージとクラス名です。クラスに設定値を渡す場合は、クラス名の後に 2 つのコロンで区切って設定値を追加します。設定値はオプションです。クラスは、渡された値をすべて解析する必要があります。設定値が必要ない場合は、2 つのコロンを省略します。

    説明ブロック内のどこに <customreco> タグを置くかを検討します。他のすべての基準が一致した場合だけカスタム論理を起動するには、ブロックの終わりの </description> タグの直前に <customreco> タグを置きます。画面カスタマイズで画面領域と値を比較する場合、説明ブロックには <block> タグと </block> タグで囲まれた、より小さいブロックが含まれ、画面領域と比較する値が定義されます。このブロック内には customreco タグを置かないでください。

    説明ブロックの例を次に示します。<customreco> タグは </description> タグの直前にあり、<block タグと </block> タグの間にはないことに注意してください。

    <description>
    <oia invertmatch="false" optional="false" status="NOTINHIBITED"/>
    <numfields invertmatch="false" number="61" optional="false"/>
    <numinputfields invertmatch="false" number="16" optional="false"/>
    <block casesense="false" col="2" ecol="14" erow="21" 
    			invertmatch="false" optional="false" row="20">
    <string value="USERID ==="/>
    <string value="PASSWORD ==="/>
    </block>
    <cursor col="16" invertmatch="false" optional="false" row="20"/>
    <customreco id="customer.class.package.MyReco::settings" 
    			invertmatch="false" optional="false"/>
    </description>
  10. HATS プロジェクトをビルドし直すには、ツールバーの「プロジェクト」>「クリーン」をクリックします。
  11. 「サーバーで実行」を使用してプロジェクトをテストします。ClassNotFoundException エラーを受信したら、サーバー上のクラス・ローダー・ポリシーを変更します。詳細については、「HATS スタートアップ・ガイド」を参照してください。

カスタム画面認識の例

以下に、カスタム画面認識を実行するビジネス・ロジックの例を示します。このビジネス・ロジック・クラスは、ブランクで区切られたコード・ページ番号のリストを設定値としてとり、設定値にリストされた値のいずれかとコード・ページが一致した場合に画面を認識します。タグ構文は次のとおりです。

<customreco id="company.project.customlogic.CodePageValidate::[settings]" 

optional="false" invertmatch="false" />

例えば、次のタグを説明ブロックに挿入することができます。

<customreco id="company.project.customlogic.CodePageValidate::037 434 1138" 

optional="false" invertmatch="false" />

この場合は、コード・ページが 037、434、または 1138 であるときに画面が認識されます。

////////////////////////////////////////////////////////////////////////////////
//  This sample is provided AS IS.
//  Permission to use, copy and modify this software for any purpose and
//  without fee is hereby granted. provided that the name of IBM not be used in
//  advertising or publicity pertaining to distribution of the software without
//  specific written permission.
//
//  IBM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SAMPLE, INCLUDING ALL
//  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL IBM
//  BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
//  DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
//  IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
//  OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SAMPLE.
////////////////////////////////////////////////////////////////////////////////
package company.project.customlogic;

import java.util.StringTokenizer;
import java.lang.Integer;
import com.ibm.eNetwork.ECL.ECLPS;
import com.ibm.eNetwork.ECL.ECLScreenDesc;
import com.ibm.hats.common.IBusinessLogicInformation;
import com.ibm.hats.common.HostScreen;
import com.ibm.hats.common.customlogic.AbstractCustomScreenRecoListener;

public class CodePageValidate extends AbstractCustomScreenRecoListener {

/**
 * @see com.ibm.hats.common.customlogic.AbstractCustomScreenRecoListener
 * #isRecognized(java.lang.String, com.ibm.hats.common.IBusinessLogicInformation,
 *       com.ibm.eNetwork.ECL.ECLPS,  com.ibm.eNetwork.ECL.ECLScreenDesc)
	 */
	public boolean isRecognized(
		String settings,
		IBusinessLogicInformation bli,
		ECLPS ps,
		ECLScreenDesc screenDescription) {
		HostScreen hs=bli.getHostScreen();
		int int_codepage=hs.GetCodePage();
		if(settings!=null)
		{
			StringTokenizer tokenizer = new StringTokenizer(settings);
			while( tokenizer.hasMoreTokens() )
			{   
				int int_token= Integer.valueOf(tokenizer.nextToken()).intValue();
				if ( int_token==int_codepage )
				{    
					 return true;
				}
			}
		}
		return false;
	}

}

グローバル変数を使用したカスタム画面認識

HATS Toolkit には、次に示すように、グローバル変数を使用した画面認識オプションがいくつか用意されています。

これらのオプションについては、「HATS ユーザーと管理者のガイド」を参照してください。HATS グローバル変数に基づいて画面認識を実行する場合、「グローバル変数論理 (Global Variable Logic)」パネル内のオプションが要件に合わなければ、1 つ以上のグローバル変数の値または存在に基づいて独自の論理を追加できます。このアプローチでは、Java クラスを作成する必要はありません。代わりに、HATS が提供する GlobalVariableScreenReco クラスを使用します。<customreco> タグで比較を設定値として指定できます。フォーマットは次のいずれかになります。

比較される 2 つの項目それぞれを含む中括弧 {} が使用されます。最初の項目は、name で名前が指定された HATS グローバル変数です。option を使用して、比較で変数の値、長さ、存在を使用することを指定できます。resource と index の設定はオプションです。resource を使用すると、グローバル変数がローカル (これがデフォルトです) か共用かを示すことができます。index を使用すると、索引付きグローバル変数から使用する値を示すことができます。

2 番目の項目は次のいずれかです。

設定で有効な値が 表 1 に表示されます。COMPARE 設定の場合、ストリングの比較に有効な値は、EQUAL と NOTEQUAL のみです。

表 1. 設定の有効値
設定 有効値
type
  • variable
  • integer
  • boolean
  • string
COMPARE
  • EQUAL
  • NOTEQUAL
  • GREATERTHAN
  • GREATERTHANOREQUAL
  • LESS THAN
  • LESSTHANOREQUAL
options
  • exists (ブール値)
  • value (ストリング/整数/ブール値)
  • length (整数)
  • object (オブジェクト)
resource
  • local
  • shared
index 任意の正の整数または 0

次の例では、2 つのローカル・グローバル変数の値を比較します。

<customreco id="com.ibm.hats.common.customlogic.GlobalVariableScreenReco::
		{variable(name=gv1,option=value,resource=local)}EQUAL
		{variable(name=gv2,option=value,resource=local)}" 
		invertmatch="false" optional="false"/>

gv1 と gv2 の値が同じである場合、この式は true と評価されます。

次に、長さのオプションについて考えます。索引のないグローバル変数の場合、長さは変数の値の長さになります。索引付きグローバル変数の場合は、索引を指定すると、長さはグローバル変数のその索引の長さになります。索引を指定しないと、長さはグローバル変数内の索引付きエントリーの数になります。

<customreco id="com.ibm.hats.common.customlogic.GlobalVariableScreenReco::
		{variable(name=gv1,option=length,resource=shared)}LESSTHANOREQUAL
		{variable(name=gv2,option=length,index=4)}" invertmatch="false" optional="false"/>

この式は、gv1 の長さと gv2 の 4 番目の索引の長さを比較します。gv1 の長さが gv2 の 4 番目の索引の長さと等しいかそれより小さい場合、この式は true と評価されます。長さは整数値を戻すので、LESSTHANOREQUAL を使用できます。

この例の gv1 に対する resource=shared の使用は、gv1 が共用グローバル変数であることを示しています。もう 1 つのオプションは、デフォルトの resource=local です。これは、グローバル変数がその他のアプリケーションと共有されないことを意味します。

あるグローバル変数を別のグローバル変数と比較する必要はありません。グローバル変数の長さは固定整数と比較できます。グローバル変数の値は別のストリングと比較できます。例えば、次のように設定されます。

<customreco id="com.ibm.hats.common.customlogic.GlobalVariableScreenReco::
		{variable(name=gv1,option=value)}EQUAL{string(value=mystring)}" 
		invertmatch="false" optional="false"/>

この式は、gv1 の値を mystring に含まれているストリングと比較します。このストリングは、固定されたストリング、変数の値、またはメソッド呼び出しから戻された値です。通常は、グローバル変数の長さまたは値を固定値と比較するためにカスタム論理を使用する必要はありません。これらの比較は、「グローバル変数論理 (Global Variable Logic)」パネルを使用して追加できます。

javax.servlet クラスへのアクセス

Web アプリケーションの開発者およびリッチ・クライアント・アプリケーションの開発者の双方に一貫性のある API セットを提供するため、一部の HATS API は汎用化され、Web 環境とリッチ・クライアント環境のどちらでも動作するようになっています。例えば、HATS 7.0 より前では、BusinessLogicInfo.getRequest() メソッドを使用することで、要求の javax.servlet.HttpServletRequest オブジェクトにアクセスできました。この API は現在でも使用可能ですが (ただし推奨はされません)、新規のビジネス・ロジック・クラスでは、BusinessLogicInfo クラスではなく、新規の IBusinessLogicInformation インターフェースを使用します。

このインターフェースの getRequest() メソッドは、com.ibm.hats.runtime.IRequest オブジェクトを返します。 Web アプリケーションでは、このオブジェクトの型は com.ibm.hats.runtime.WebRequest になります。 WebRequest には HttpServletRequest に似たメソッドがありますが、これは HttpServletRequest を拡張したものではありません。 WebRequest オブジェクトから実際の HttpServletRequest オブジェクトにアクセスするには、getHttpServletRequest() メソッドを呼び出します。

表 2. Javax.servlet クラス、HATS クラス、およびアクセス用メソッド
javax.servlet クラス + ラッパー HATS クラス + アクセス用メソッド
HttpServletRequest com.ibm.hats.runtime.WebRequest WebRequest.getHttpServletRequest()
HttpServletResponse com.ibm.hats.runtime.WebResponse WebResponse.getHttpServletResponse()
ServletContext com.ibm.hats.runtime.WebContext WebContext.getServletContext()
ServletConfig com.ibm.hats.runtime.WebConfig WebConfig.getServletConfig()

詳細およびコード・サンプルについては、IBusinessLogicInformation の Javadoc API を参照してください。