public class BapiController
extends java.lang.Object
implements java.io.Serializable
修飾子とタイプ | フィールドと説明 |
---|---|
static java.lang.String[] |
DEFAULT_IGNORE_ERR_MSG_RETURN_TYPES
エラーメッセージを無視するRETURN-TYPEの設定。
|
コンストラクタと説明 |
---|
BapiController(java.lang.String propertyName)
プロパティファイル名のメンバ変数への設定、プロパティファイルの読込と
各PropertyListの生成処理を行います。
|
BapiController(java.lang.String propertyName,
ConnectionManager connectionManager)
コネクションマネージャのセット、プロパティファイル名のメンバ変数への設定、
プロパティファイルの読込と各PropertyListの生成処理を行います。
ConnectionManager を使用することで、
ConnectionManager からトランザクションを制御でき、
たとえば同一トランザクション内で複数の登録・更新処理を実行することができます。 |
BapiController(java.lang.String propertyName,
SapClient sapClient)
|
修飾子とタイプ | メソッドと説明 |
---|---|
void |
addAutoCommitCondition(java.lang.String autoCommitConditon)
非推奨です。
addIgnoreErrMsgReturnType(java.lang.String) に置き換えられました。 |
void |
addIgnoreErrMsgReturnType(java.lang.String ignoreErrMsgReturnType)
エラーメッセージを無視するRETURN-TYPEを追加します。
|
void |
clear()
セットしたパラメータ、ストラクチャ、テーブル、BAPIの実行結果をクリアします。
|
void |
executeBapi()
BAPIを実行します。
|
java.util.List<java.lang.String> |
getAutoCommitConditions()
非推奨です。
getIgnoreErrMsgReturnTypes() に置き換えられました。 |
java.util.List<BapiHash> |
getBapiHashList()
BapiHashの一覧を取得します。
|
java.util.List<BapiReturn> |
getBapiReturnList()
BapiReturnの一覧を取得します。
|
java.lang.String |
getErrMessage()
BAPIの実行結果のエラーメッセージを取得します。
|
java.util.List<LineProperty> |
getExpExpList()
プロパティ情報(export(Export))の一覧を取得します。
|
java.lang.String |
getExportParam(java.lang.String propKey)
export(Export)情報を返します。
|
java.util.List<LineProperty> |
getExpStrList()
プロパティ情報(structure(Export))の一覧を取得します。
|
java.util.List<LineProperty> |
getExpTblList()
プロパティ情報(table(Export))の一覧を取得します。
|
java.util.List<java.lang.String> |
getIgnoreErrMsgReturnTypes()
エラーメッセージを無視するRETURN-TYPEを取得します。
|
java.util.List<LineProperty> |
getImpImpList()
プロパティ情報(import(Import))の一覧を取得します。
|
java.util.List<LineProperty> |
getImpStrList()
プロパティ情報(structure(Import))一覧を取得します。
|
java.util.List<LineProperty> |
getImpTblList()
プロパティ情報(table(Import))の一覧を取得します。
|
java.lang.String |
getMessage()
設定されたエラーメッセージを無視するRETURN-TYPE情報に一致したメッセージ情報を全て返します。
|
java.lang.String |
getMessage(java.lang.String type)
引数に一致したType情報のメッセージ情報全て取得します。
|
java.util.Properties |
getProperty()
プロパティファイル情報を取得します。
|
java.lang.String |
getPropertyName()
プロパティファイル名を取得します。
|
BapiReturn |
getReturn()
BAPI実行結果を取得します。
|
java.util.Iterator<java.lang.String> |
getReturnCodeTypes()
BapiReturn のType情報を取得します。
|
java.util.Iterator<BapiReturn> |
getReturnList()
BAPI実行結果の一覧を取得します。
|
java.util.Map<java.lang.String,java.lang.String> |
getStructureParam(java.lang.String paramName)
structure(Export)情報を返します。
|
java.util.Iterator<java.util.Map<java.lang.String,java.lang.String>> |
getTableParam(java.lang.String paramName)
table(Export)情報を返します。
|
boolean |
isSuccess()
BAPI実行が正常に行われたか判定します。
BAPI実行結果であるBapiReturndのType情報が 正常(デフォルト値: "S" / "")であった場合"true"をそれ以外は"false"を返します。 正常と判断させる条件はプロパティファイル、 または setIgnoreErrMsgReturnTypes(List) 、
addIgnoreErrMsgReturnType(String) でカスタマイズできます。 |
void |
putImportParam(java.lang.String key,
java.lang.String val)
引数に指定された条件でBapiHashオブジェクト(入力/出力区分="import",
パラメタ属性="import")を生成し、一覧に格納します。
|
void |
putStructParam(java.lang.String key,
java.lang.String val,
java.lang.String structName)
引数に指定された条件でBapiHashオブジェクト(入力/出力区分="import",
パラメタ属性="structure",パラメタ名=第3引数)を生成し、一覧に格納します。
|
void |
putTableParam(java.lang.String key,
java.lang.String val,
java.lang.String tableName,
int recordNo)
引数に指定された条件でBapiHashオブジェクト(入力/出力区分="import",
パラメタ属性="table",パラメタ名=第3引数,レコード番号=第4引数)を生成し、
一覧に格納します。
|
void |
setAutoCommitConditions(java.util.List<java.lang.String> autoCommitConditions)
非推奨です。
setIgnoreErrMsgReturnTypes() に置き換えられました。 |
void |
setBapiHashList(java.util.List<BapiHash> bapiHashList)
BapiHashの一覧を設定します。
|
void |
setBapiReturnList(java.util.List<BapiReturn> bapiReturnList)
BapiReturnの一覧を設定します。
|
void |
setExpExpList(java.util.List<LineProperty> expExpList)
プロパティ情報(export(Export))の一覧を設定します。
|
void |
setExpStrList(java.util.List<LineProperty> expStrList)
プロパティ情報(structure(Export))の一覧を設定します。
|
void |
setExpTblList(java.util.List<LineProperty> expTblList)
プロパティ情報(table(Export))の一覧を設定します。
|
void |
setIgnoreErrMsgReturnTypes(java.util.List<java.lang.String> list)
エラーメッセージを無視するRETURN-TYPEを設定します。
|
void |
setImpImpList(java.util.List<LineProperty> list)
プロパティ情報(import(Import))の一覧を設定します。
|
void |
setImpStrList(java.util.List<LineProperty> impStrList)
プロパティ情報(structure(Import))の一覧を設定します。
|
void |
setImpTblList(java.util.List<LineProperty> impTblList)
プロパティ情報(table(Import))の一覧を設定します。
|
void |
setProperty(java.util.Properties property)
プロパティファイル情報を設定します。
|
void |
setPropertyName(java.lang.String propertyName)
プロパティファイル名を設定します。
|
java.lang.String |
toString()
デバッグ用のメソッドです。
|
public static final java.lang.String[] DEFAULT_IGNORE_ERR_MSG_RETURN_TYPES
public BapiController(java.lang.String propertyName) throws SAPGeneralSystemException, SAPAuthSystemException, SAPGeneralAppException
propertyName
- BAPIコントローラが使用するプロパティファイル名SAPGeneralSystemException
- 汎用系システム例外処理SAPAuthSystemException
- 認証系システム例外処理SAPGeneralAppException
- 汎用系アプリケーション例外public BapiController(java.lang.String propertyName, ConnectionManager connectionManager) throws SAPGeneralSystemException, SAPAuthSystemException, SAPGeneralAppException
ConnectionManager
を使用することで、
ConnectionManager
からトランザクションを制御でき、
たとえば同一トランザクション内で複数の登録・更新処理を実行することができます。executeBapi()
実行後に必ずConnectionManager.commit()
またはConnectionManager.rollback()
を
実行してください。executeBapi()
実行後にここまでの
コネクションマネージャーで実行したすべての処理がcommitまたは
rollbackされます。ConnectionManager.commit()
または
ConnectionManager.rollback()
を実行してください。propertyName
- BAPIコントローラが使用するプロパティファイル名connectionManager
- 生成したConnectionManagerオブジェクトSAPGeneralSystemException
- 汎用系システム例外処理SAPAuthSystemException
- 認証系システム例外処理SAPGeneralAppException
- 汎用系アプリケーション例外public BapiController(java.lang.String propertyName, SapClient sapClient) throws SAPGeneralSystemException, SAPAuthSystemException, SAPGeneralAppException
SapClient
を使用することで、SapClient
にて指定した
SAPアプリケーションサーバ接続が可能となります。propertyName
- BAPIコントローラが使用するプロパティファイル名sapClient
- SAPへの接続情報が格納されたオブジェクトSAPGeneralSystemException
- 汎用系システム例外処理SAPAuthSystemException
- 認証系システム例外処理SAPGeneralAppException
- 汎用系アプリケーション例外public void putImportParam(java.lang.String key, java.lang.String val) throws SAPGeneralSystemException, SAPGeneralAppException
key
- BapiHashに設定するHashMapのキーval
- BapiHashに設定するHashMapの値SAPGeneralSystemException
- 汎用系システム例外処理SAPGeneralAppException
- 汎用系アプリケーション例外処理public void putStructParam(java.lang.String key, java.lang.String val, java.lang.String structName) throws SAPGeneralSystemException, SAPGeneralAppException
key
- BapiHashに設定するHashMapのキーval
- BapiHashに設定するHashMapの値structName
- BapiHashに設定するparamTypeの値SAPGeneralSystemException
- 汎用系システム例外処理SAPGeneralAppException
- 汎用系アプリケーション例外処理public void putTableParam(java.lang.String key, java.lang.String val, java.lang.String tableName, int recordNo) throws SAPGeneralSystemException, SAPGeneralAppException
key
- BapiHashに設定するHashMapのキーval
- BapiHashに設定するHashMapの値tableName
- BapiHashに設定するparamTypeの値recordNo
- BapiHashに設定するrecordNoの値SAPGeneralSystemException
- 汎用系システム例外処理SAPGeneralAppException
- 汎用系アプリケーション例外処理public void executeBapi() throws SAPGeneralSystemException, SAPGeneralAppException, SAPAuthSystemException, SAPAuthAppException
ConnectionManager
を指定した場合、 トランザクション処理は自動的に実行されません。呼び出し側で明示的にConnectionManager.commit()
またはConnectionManager.rollback()
を実行する必要があります。また、SAPとのコネクションも 上記2メソッド内で行われますので、確実に呼び出すように実装しなくてはなりません。 ConnectionManager
を指定した場合の注意点ConnectionManager.commit()
または ConnectionManager.rollback()
を実行してください。SAPGeneralSystemException
- 汎用系システム例外処理SAPAuthSystemException
- 認証系システム例外処理SAPGeneralAppException
- 汎用系アプリケーション例外処理SAPAuthAppException
- 認証系アプリケーション例外処理public boolean isSuccess() throws SAPGeneralSystemException
setIgnoreErrMsgReturnTypes(List)
、
addIgnoreErrMsgReturnType(String)
でカスタマイズできます。SAPGeneralSystemException
- 汎用系システム例外処理public java.lang.String getErrMessage() throws SAPGeneralSystemException
setIgnoreErrMsgReturnTypes(List)
,
addIgnoreErrMsgReturnType(String)
でカスタマイズできます。SAPGeneralSystemException
- 汎用系システム例外処理public java.lang.String getMessage() throws SAPGeneralSystemException
setIgnoreErrMsgReturnTypes(List)
,
addIgnoreErrMsgReturnType(String)
でカスタマイズできます。SAPGeneralSystemException
- 汎用系システム例外処理public java.lang.String getMessage(java.lang.String type) throws SAPGeneralSystemException
MESSAGE1 : メッセージ1 |
MESSAGE2 : メッセージ2 |
: |
type
- エラーコードタイプSAPGeneralSystemException
- 汎用系システム例外処理public java.lang.String getExportParam(java.lang.String propKey) throws SAPGeneralSystemException
propKey
- 検索条件となるPropertyKeySAPGeneralSystemException
- 汎用系システム例外処理public java.util.Map<java.lang.String,java.lang.String> getStructureParam(java.lang.String paramName) throws SAPGeneralSystemException
paramName
- 検索条件となるParamNameSAPGeneralSystemException
- 汎用系システム例外処理public java.util.Iterator<java.util.Map<java.lang.String,java.lang.String>> getTableParam(java.lang.String paramName) throws SAPGeneralSystemException
paramName
- 検索条件となるParamNameSAPGeneralSystemException
- 汎用系システム例外処理public java.util.Iterator<BapiReturn> getReturnList()
public BapiReturn getReturn()
public java.util.List<BapiHash> getBapiHashList()
public java.util.Properties getProperty()
public java.lang.String getPropertyName()
public java.util.List<LineProperty> getImpImpList()
public java.util.List<LineProperty> getImpStrList()
public java.util.List<LineProperty> getImpTblList()
public java.util.List<LineProperty> getExpExpList()
public java.util.List<LineProperty> getExpStrList()
public java.util.List<LineProperty> getExpTblList()
public java.util.List<BapiReturn> getBapiReturnList()
public void setBapiHashList(java.util.List<BapiHash> bapiHashList)
bapiHashList
- BapiHashListpublic void setProperty(java.util.Properties property)
property
- Propertypublic void setPropertyName(java.lang.String propertyName)
propertyName
- propertyNamepublic void setImpImpList(java.util.List<LineProperty> list)
list
- impImpListpublic void setImpStrList(java.util.List<LineProperty> impStrList)
impStrList
- impStrListpublic void setImpTblList(java.util.List<LineProperty> impTblList)
impTblList
- impTblListpublic void setExpExpList(java.util.List<LineProperty> expExpList)
expExpList
- expExpListpublic void setExpStrList(java.util.List<LineProperty> expStrList)
expStrList
- expStrListpublic void setExpTblList(java.util.List<LineProperty> expTblList)
expTblList
- expTblListpublic void setBapiReturnList(java.util.List<BapiReturn> bapiReturnList)
bapiReturnList
- bapiReturnListpublic java.lang.String toString()
toString
クラス内 java.lang.Object
public void clear()
セットしたパラメータ、ストラクチャ、テーブル、BAPIの実行結果をクリアします。
BapiControllerを複数回使用する場合、一度putImportParam()などを実行した後に 同じパラメータをセットする前に実行する必要があります。
実行例は次のようになります。
BapiController bapiController = new BapiController(...); bapiController.putImportParam(...); bapiController.putStructParam(...); ... executeBapi(); //クリア bapiController.clear(); //BapiControllerを再利用する bapiController.putImportParam(...); bapiController.putStructParam(...); ... executeBapi();
public java.util.List<java.lang.String> getAutoCommitConditions()
getIgnoreErrMsgReturnTypes()
に置き換えられました。String
型の要素からなるList
オブジェクト)public void addAutoCommitCondition(java.lang.String autoCommitConditon)
addIgnoreErrMsgReturnType(java.lang.String)
に置き換えられました。autoCommitConditon
- オートコミットさせる条件public void setAutoCommitConditions(java.util.List<java.lang.String> autoCommitConditions) throws SAPGeneralSystemException
setIgnoreErrMsgReturnTypes()
に置き換えられました。List
の要素は文字列 String
で登録します。autoCommitConditions
- オートコミットさせる条件リストSAPGeneralSystemException
- 引数にString
型以外の要素が
含まれている場合にスローされます。public java.util.List<java.lang.String> getIgnoreErrMsgReturnTypes()
public void addIgnoreErrMsgReturnType(java.lang.String ignoreErrMsgReturnType)
ignoreErrMsgReturnType
- エラーメッセージを無視するRETURN-TYPE値public void setIgnoreErrMsgReturnTypes(java.util.List<java.lang.String> list) throws SAPGeneralSystemException
List
の要素は文字列 String
で登録します。list
- エラーメッセージを無視するRETURN-TYPE値のリストSAPGeneralSystemException
- 引数にString
型以外の要素が
含まれている場合にスローされます。public java.util.Iterator<java.lang.String> getReturnCodeTypes()
String
型の要素からなる
Iterator
オブジェクトを取得します。Copyright (c) 2013 NTT DATA INTRAMART CORPORATION.