WebGWParamIOクラスは、WebブラウザとWebサーバ間で送受信するデータを保持するためのクラスです。
WebGWParamIO クラスが提供する各メソッドについて、以下に説明します。
|
名称 |
WebGWParamIO−コンストラクタ |
|
形式 |
WebGWParamIO(
String[] io_cl1,
String[] io_cl2,
String[] io_ctl1,
String[] io_ctl2,
String[] i_key,
String[] i_value)
|
|
説明 |
WebGWParamIOクラスのコンストラクタです。本コンストラクタはCORBAインタフェースクラス(WebGWObj等)からのみ呼びます。
io_cl1、io_cl2、io_ctl1、io_ctl2、i_key、i_valueにはビジネスクラスのdoAPメソッドのパラメタを指定してください。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
WebGWParamIO−コンストラクタ |
|
形式 |
WebGWParamIO(
String[] io_cl1,
String[] io_cl2,
String[] io_ctl1,
String[] io_ctl2,
String[] i_key,
String[] i_value,
byte[] i_HTML
)
|
|
説明 |
WebGWParamIOクラスのコンストラクタです。本コンストラクタはCORBAインタフェースクラス(WebGWObj等)からのみ呼びます。
io_cl1、io_cl2、io_ctl1、io_ctl2、i_key、i_valueにはビジネスクラスのdoAPメソッドのパラメタを指定してください。
i_HTMLにはアップロード用データを指定してください。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
addCookie−Cookieを追加する |
|
形式 |
boolean addCookie(
WebGWCookie cookie)
|
|
説明 |
cookie で指定されたWebGWCookieオブジェクトの更新フラグをすべてtrueにし、現在管理しているWebGWCookieオブジェクト配列に追加します。
|
|
戻り値 |
成功ならtrueを返します。失敗ならfalseを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
finishAP−処理対象のCookieを整理する |
|
形式 |
void finishAP()
|
|
説明 |
更新したCookie及び追加したCookieを整理し、Webブラウザに返却するための準備をします。ビジネスロジック処理の戻り値を設定する前に呼び、その後戻り値に値を設定します。
- outCookieList1には変更のあったCookieの項目名の一覧を設定してください。
- outCookieList2にはoutCookieList1の項目に対応する値を設定してください。
- outControl1にはヘッダ情報の項目名の一覧を設定してください。
- outControl2にはoutControl1の項目に対応する値を設定してください。
|
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getCookies−Cookieオブジェクトを取得する |
|
形式 |
WebGWCookie[] getCookies()
|
|
説明 |
現在管理しているすべてのWebGWCookieオブジェクトを戻り値で返却します。 |
|
戻り値 |
WebGWCookie型のCookieオブジェクトの配列を返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getHeader−Webブラウザから受信したヘッダを取得する |
|
形式 |
String getHeader(
String key)
|
|
説明 |
keyで指定された名前に対応するio_ctrl2の値を、戻り値で返却します。
後述のsetHeader(String)メソッドで設定した値ではないことに注意してください。
以下にIISを使用した場合に取得できる値の一覧を示します。他のWebサーバの場合は使用するWebサーバにより、指定する文字列および取得できる情報が異なります。
|
ISAPIを使用した場合に取得できる値 |
|
指定する文字列 |
取得できる情報 |
|
AUTH_TYPE |
ISAPIのCHttpServerContextクラスのGetServerVariable("AUTH_TYPE")で得られる値です。
使用されている認証のタイプ。たとえば Basic の認証が使用されている場合、文字列は"Basic" となります。 |
|
GATEWAY_INTERFACE |
ISAPIのCHttpServerContextクラスのGetServerVariable("GATEWAY_INTERFACE")で得られる値です。
Webサーバが対応している CGI 仕様のリビジョン番号です。 |
|
Content-type |
ISAPIのCHttpServerContextクラスのGetServerVariable("CONTENT_TYPE")で得られる値です。
POST 要求で提供される情報内容の種類です。 |
|
Content-length |
ISAPIのCHttpServerContextクラスのGetServerVariable("CONTENT_LENGTH")で得られる値です。
スクリプトがWebブラウザから受け取る予定のバイト数です。 |
|
COOKIE |
ISAPIのCHttpServerContextクラスのGetServerVariable("HTTP_COOKIE")で得られる値です。
Webブラウザから受信したCookieの内容です。 |
|
HOST |
ISAPIのCHttpServerContextクラスのGetServerVariable("HTTP_HOST")で得られる値です。
URL のホスト名です。 |
|
PATH_TRANSLATED |
ISAPIのCHttpServerContextクラスのGetServerVariable("PATH_TRANSLATED")で得られる値です。
ディレクトリ指定まで拡張された仮想パス名を含んだPATH_INFO の値です。 |
|
QUERY_STRING |
ISAPIのCHttpServerContextクラスのGetServerVariable("QUERY_STRING")で得られる値です。
URL 内で "?" 以降の情報です。 |
|
REFERER |
ISAPIのCHttpServerContextクラスのGetServerVariable("HTTP_REFERER")で得られる値です。
直前に参照したURLです。 |
|
REMOTE_USER |
ISAPIのCHttpServerContextクラスのGetServerVariable("REMOTE_USER")で得られる値です。
Webブラウザが提供し、Webサーバによって認証されたユーザー名が入ります。 |
|
REMOTE_ADDR |
ISAPIのCHttpServerContextクラスのGetServerVariable("REMOTE_ADDR")で得られる値です。
Webブラウザの IP アドレスです。 |
|
REQUEST_METHOD |
ISAPIのCHttpServerContextクラスのGetServerVariable("REQUEST_METHOD")で得られる値です。
HTTP 要求メソッドです。 |
|
SCRIPT_NAME |
ISAPIのCHttpServerContextクラスのGetServerVariable("SCRIPT_NAME")で得られる値です。
実行中の拡張 DLL の名前です。 |
|
SERVER_NAME |
ISAPIのCHttpServerContextクラスのGetServerVariable("SERVER_NAME")で得られる値です。
自己参照 URL に表示されるサーバーのホスト名(または IP アドレス)です。 |
|
SERVER_PROTOCOL |
ISAPIのCHttpServerContextクラスのGetServerVariable("SERVER_PROTOCOL")で得られる値です。
この要求に関連する情報検索プロトコルの名前とバージョンです。 |
|
SERVER_PORT |
ISAPIのCHttpServerContextクラスのGetServerVariable("SERVER_PORT")で得られる値です。
要求を受信した TCP/IP ポートです。 |
|
SERVER_SOFTWARE |
ISAPIのCHttpServerContextクラスのGetServerVariable("SERVER_SOFTWARE")で得られる値です。
ISA または Webサーバ拡張 DLL プログラムが実行される Web サーバの名前とバージョンです。 |
|
USER_AGENT |
ISAPIのCHttpServerContextクラスのGetServerVariable("HTTP_USER_AGENT")で得られる値です。
Webブラウザ情報です。 |
|
ALL_HTTP |
ISAPIのCHttpServerContextクラスのGetServerVariable("ALL_HTTP")で得られる値です。
上記の変数のいずれにも分類されていないすべての HTTP ヘッダです。この変数は HTTP_<header field name> の形式です。 |
|
HTTP_ACCEPT |
ISAPIのCHttpServerContextクラスのGetServerVariable("HTTP_ACCEPT")で得られる値です。
特殊なケースの HTTP ヘッダ。Accept: フィールドの値は "," で区切って結合されます。 |
|
|
戻り値 |
String型のkeyで指定された名前に対応するio_ctrl2の値を返します。
|
|
名称 |
getInputStream−バイナリ入力ストリームオブジェクトを返却する |
|
形式 |
WebGWInputStream getInputStream()
|
|
説明 |
バイナリ入力ストリームオブジェクトを返却します。 |
|
戻り値 |
WebGWInputStream型のバイナリ入力ストリームオブジェクトを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
2.1.8. getMultipartRequest |
|
名称 |
getMultipartRequest−MultipartRequestオブジェクトを返却する |
|
形式 |
MultipartRequest getMultipartRequest()
throws IOException
|
|
説明 |
MultipartRequestオブジェクトを返却します。 |
|
戻り値 |
MultipartRequest型のオブジェクトを返します。 |
|
エラー |
IOExceptionをthrowします。
|
|
関連項目 |
ありません。 |
|
名称 |
getOutputStream−OutputStreamオブジェクトを返却する |
|
形式 |
OutputStream getOutputStream()
throws IOException
|
|
説明 |
OutputStreamオブジェクトを返却する。 |
|
戻り値 |
OutputStream型のバイナリ出力ストリームオブジェクトを返します。 |
|
エラー |
IOExceptionをthrowします。
|
|
関連項目 |
ありません。 |
|
名称 |
getParameter−Webブラウザから受信したパラメタを取得する |
|
形式 |
String getParameter(
String key)
|
|
説明 |
keyで指定された名前(=入力用HTMLのINPUTタグのnameパラメタの値)に対応する値を、戻り値で返却します。 |
|
戻り値 |
String型のnameパラメタで指定された値を返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
2.1.11. getParameterNames |
|
名称 |
getParameterNames−マルチパート形式で指定されたデータのリストを取得する |
|
形式 |
Enumeration getParameterNames()
|
|
説明 |
マルチパート形式で指定されたデータのnameのリストを返却します。 |
|
戻り値 |
Enumeration型のマルチパート形式で指定されたデータのnameのリストを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
2.1.12. getStringEncoding |
|
名称 |
getStringEncoding−setContentType()で設定された、Java Encoding文字列を返却する |
|
形式 |
String getStringEncoding()
|
|
説明 |
setContentType()で設定された、Java Encoding文字列を返却します。これはCORBAインタフェースクラスにて、strHTMLをバイナリ化しなければならない場合に利用します。つまり、doAPdownloadで下記のいずれかを行ったケースです。
- setHTML(String)を行った場合
- getWriter() を、setHTML(byte[])もしくはgetOutputStreamに先立ち実行した場合
|
|
戻り値 |
String型のContentTypeを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getWriter−出力プリントライターオブジェクトを返却する |
|
形式 |
PrintWriter getWriter()
throws IOException
|
|
説明 |
出力プリントライターオブジェクトを返却します。 |
|
戻り値 |
PrintWriter型のオブジェクトを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setContentType−Content-Typeのエントリの値を指定された値に変更する |
|
形式 |
boolean setContentType(
String value)
|
|
説明 |
Content-Typeのエントリの値をvalueで指定された値に変更します。
Content-Typeのエントリの値が存在しない場合は、新しくエントリを作成します。 |
|
戻り値 |
成功ならtrueを返します。失敗ならfalseを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setHeader−io_ctrl1のエントリの値を指定された値に変更する |
|
形式 |
boolean setHeader(
String io_ctrl1,
String io_ctrl2)
|
|
説明 |
io_ctrl1のエントリの値をio_ctrl2で指定された値に変更する。
io_ctrl1のエントリの値が存在しない場合は新しくエントリを作成する。
ここで設定した値はgetHeader(String)メソッドでは取得できないことに注意してください。 |
|
戻り値 |
成功ならtrueを返します。失敗ならfalseを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setParameter−結果表示用のHTML文をWEBサーバに返却する出力パラメタに設定する |
|
形式 |
void setParameter(
byte[] HTML)
|
|
説明 |
結果表示用のHTML文をHTMLに設定します。結果表示用のHTMLはbyte配列です。
doAPdownloadで使用可能です。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setParameter−結果表示用のHTML文をWEBサーバに返却する出力パラメタに設定する |
|
形式 |
void setParameter(
String HTML)
|
|
説明 |
結果表示用のHTML文をHTMLに設定します。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setParameter−結果表示用のHTML文をWEBサーバに返却する出力パラメタに設定する |
|
形式 |
void setParameter(
String[] HTML)
|
|
説明 |
結果表示用のHTML文をHTMLに設定します。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
WebGWCookie クラスは、Cookie情報を管理するクラスです。
WebGWCookie クラスが提供する各メソッドについて、以下に説明します。
|
名称 |
WebGWCookie−コンストラクタ |
|
形式 |
WebGWCookie(
String name,
String nameValue)
|
|
説明 |
WebGWCookieクラスのコンストラクタです。
- nameにはCookieの項目名を設定します。
- nameValueにはCookieの名前を設定します。
|
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
WebGWCookie−コンストラクタ |
|
形式 |
WebGWCookie(
String[] keyWord,
String[] keyValue)
|
|
説明 |
WebGWCookieクラスのコンストラクタです。
- keyWordにはCookieの項目名を設定する。keyWordのとり得る値は"NAME",
"VALUE", "MAXAGE", "COMMENT", "DOMAIN",
"PATH", "SECURE", "VERSION" です。
- keyValueにはkeyWordに対応する値を設定します。
|
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
clone−自分自身のcloneを返す |
|
形式 |
Object clone()
|
|
説明 |
自分自身のcloneを返します。 |
|
戻り値 |
Object型の自分自身を返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getComment−Cookieのコメントを返す |
|
形式 |
String getComment()
|
|
説明 |
Cookieのコメントを返す。 |
|
戻り値 |
String型のCookieのコメントを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getDomain−Cookieを有効にするドメインを返す |
|
形式 |
String getDomain()
|
|
説明 |
Cookieを有効にするドメインを返します。 |
|
戻り値 |
String型のCookieを有効にするドメインを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getMaxAge−Cookieの有効期間を返す |
|
形式 |
int getMaxAge()
|
|
説明 |
Cookieの有効期間を返します。 |
|
戻り値 |
int型のCookieの有効期間を返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getName−Cookieの名前を返す |
|
形式 |
String getName()
|
|
説明 |
Cookieの名前を返します。 |
|
戻り値 |
String型のCookieの名前を返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getPath−Cookieを適用するURIのPATHを返す |
|
形式 |
String getPath()
|
|
説明 |
Cookieを適用するURIのPATHを返します。 |
|
戻り値 |
String型のCookieを適用するURIのPATHを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getSecure−Cookieのセキュリティオプションの値を返す |
|
形式 |
boolean getSecure()
|
|
説明 |
Cookieのセキュリティオプションの値を返します。 |
|
戻り値 |
ONの場合はtrueを返し、OFFの場合はfalseを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getValue−Cookieの値を返す |
|
形式 |
String getValue()
|
|
説明 |
Cookieの値を返します。 |
|
戻り値 |
String型のCookieの値を返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getVersion−Cookieのバージョンを返す |
|
形式 |
int getVersion()
|
|
説明 |
Cookieのバージョンを返します。 |
|
戻り値 |
int型のCookieのバージョンを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setComment−Cookieのコメントを設定する |
|
形式 |
void setComment(
String purpose)
|
|
説明 |
purposeにはCookieのコメントを指定する。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setDomain−Cookieを有効にするドメインを設定する |
|
形式 |
void setDomain(
String pattern)
|
|
説明 |
patternにはCookieを有効にするドメインを指定します。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setMaxAge−Cookieの有効期間を設定する |
|
形式 |
void setMaxAge(
String expiry)
|
|
説明 |
expiryにはCookieの有効期間を指定します。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setPath−Cookieを適用するURIのPATHを設定する |
|
形式 |
void setPath(
String uri)
|
|
説明 |
uriにはCookieを適用するURIのPATHを設定します。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setSecure−Cookieのセキュリティオプションを設定する |
|
形式 |
void setSecure(
boolean flag)
|
|
説明 |
Cookieのセキュリティオプションを設定する。
ONの場合はtrueを、OFFの場合はfalseを指定します。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setValue−Cookieの有効期間を設定する |
|
形式 |
void setValue(
String expiry)
|
|
説明 |
expiryにはCookieの有効期間を設定します。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setVersion−Cookieのバージョンを設定する |
|
形式 |
void setVersion(
int version)
|
|
説明 |
Cookieのバージョンを設定します。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
以下のメソッドは既存のAPとの互換のために存在しますが、推奨しません。上記のgetXXX()、setXXX()を使用してください。
|
名称 |
getValue−name で指定されたエントリの値を戻り値で返却する |
|
形式 |
String getValue(
String name)
|
|
説明 |
name で指定されたエントリの値を戻り値で返却します。
指定されたエントリがない場合は、nullを戻り値で返却します。 |
|
戻り値 |
String型のnameで指定されたエントリの値を返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setAllModified−Cookieのすべての更新フラグをtrueにする |
|
形式 |
boolean setAllModified()
|
|
説明 |
すべての更新フラグをtrueにします。 |
|
戻り値 |
成功ならtrueを返します。失敗ならfalseを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setValue−nameで指定されたエントリの値を変更する |
|
形式 |
boolean setValue(
String name,
String value)
|
|
説明 |
nameで指定されたエントリの値をvalueで指定された値に変更します。
nameで指定されたエントリの値が存在しない場合は、新しくエントリを作成し、更新フラグをtrueにします。
(注:WEBサーバには本メソッドで追加または更新されたname、valueだけが返却される。) |
|
戻り値 |
成功ならtrueを返します。失敗ならfalseを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
WebGWException クラスは、java.lang.Exceptionクラスを継承し、サーバAPの動作に必要な情報を追加した例外処理クラスです。
WebGWException クラスが提供する各メソッドについて、以下に説明します。
|
名称 |
WebGWException−コンストラクタ |
|
形式 |
WebGWException(
String msg)
|
|
説明 |
WebGWException.toString()で返すエラーメッセージを設定するコンストラクタです。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
WebGWException−コンストラクタ |
|
形式 |
WebGWException(
String pStr,
String pStrInterface,
String pStrOpname,
int piStatus,
String pStrDetail)
|
|
説明 |
以下の情報を一度に設定するコンストラクタ です。
- pStrにはWebGWException.toString()で返すメッセージを指定します。
- pStrInterfaceにはインタフェース名を指定する。
- pStrOpnameにはオペレーション名を指定する。
- piStatusにはステータスを指定する。
- pStrDetailにはエラーの詳細情報
|
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getDetail−エラーの詳細情報を戻り値で返却する |
|
形式 |
String getDetail()
|
|
説明 |
エラーの詳細情報を戻り値で返却する。 |
|
戻り値 |
String型のエラーの詳細情報を返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getInterface−インタフェースを戻り値で返却する |
|
形式 |
String getInterface()
|
|
説明 |
インタフェースを戻り値で返却する。 |
|
戻り値 |
String型のインタフェースを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getOpname−オペレーション名を戻り値で返却する |
|
形式 |
String getOpname ()
|
|
説明 |
オペレーション名を戻り値で返却する。 |
|
戻り値 |
String型のオペレーション名を返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getStatus−ステータスを戻り値で返却する |
|
形式 |
String getStatus()
|
|
説明 |
ステータスを戻り値で返却する。 |
|
戻り値 |
String型のステータスを返します。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setDetail−エラーの詳細情報を設定する |
|
形式 |
void setDetail(
String detail)
|
|
説明 |
エラーの詳細情報をdetailで設定する。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setInterface−インタフェース名を設定する |
|
形式 |
void setInterface(
String interface)
|
|
説明 |
インタフェース名をinterfaceで設定する。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setOpname−オペレーション名を設定する |
|
形式 |
void setOpname(
String opname)
|
|
説明 |
オペレーション名をopnameで設定する。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
setStatus−ステータスを設定する |
|
形式 |
void setStatus(
int status)
|
|
説明 |
ステータスをstatusで設定する。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
WebGWDB クラスは、DBの制御を行うクラスです。
WebGWParamIO クラスが提供する各メソッドについて、以下に説明します。
|
2.4.1. OnTPSPUOCreateObject |
|
名称 |
OnTPSPUOCreateObject−データベースとのコネクションを生成する |
|
形式 |
void OnTPSPUOCreateObject(...)
(注)
|
|
説明 |
常駐オブジェクト生成時にWebOTXから呼び出されます。
DBとのコネクションを生成する。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
2.4.2. OnTPSPUOOperationAbnormal |
|
名称 |
OnTPSPUOOperationAbnormal |
|
形式 |
void OnTPSPUOOperationAbnormal(...)
(注)
|
|
説明 |
サーバAPのメソッドが異常終了した場合にAPロジッククラスから呼び出されます。
DBコネクションに対してロールバック処理を行います。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
2.4.3. OnTPSPUOOperationAbort |
|
名称 |
OnTPSPUOOperationAbort |
|
形式 |
void OnTPSPUOOperationAbort(...)
(注)
|
|
説明 |
サーバAPのメソッド内で例外が発生した場合にWebOTXから呼び出されます。DBコネクションに対してロールバック処理を行います。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
2.4.4. OnTPSPUOOperationNormal |
|
名称 |
OnTPSPUOOperationNormal |
|
形式 |
void OnTPSPUOOperationNormal(...)
(注)
|
|
説明 |
サーバAPのメソッドが正常終了した場合にWebOTXから呼び出されます。
DBコネクションに対してコミット処理を行います。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
2.4.5. OnTPSPUOOperationStart |
|
名称 |
OnTPSPUOOperationStart |
|
形式 |
void OnTPSPUOOperationStart(...)
(注)
|
|
説明 |
サーバオブジェクトの生成時にWebOTXから呼び出されます。
DBとのコネクションがない場合はここで再度接続します。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
2.4.6. OnTPSPUOReleaseObject |
|
名称 |
OnTPSPUOReleaseObject |
|
形式 |
void OnTPSPUOReleaseObject(...)
(注)
|
|
説明 |
常駐オブジェクト消滅時にWebOTXから呼び出されます。
DBコネクションを切断します。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
(注)OnTPSPUOxxx に関する説明は、WebOTXのオンラインマニュアルを参照してください
。
APロジッククラスのスーパークラスです。
WebGWApp クラスが提供する各メソッドについて、以下に説明します。
|
名称 |
doMethod−ビジネスロジッククラスのメソッドを呼び出す |
|
形式 |
abstract void doMethod(
WebGWParamIO io)
|
|
説明 |
WebGWAppクラスを継承してビジネスロジッククラスを作成した場合は、各メソッドを呼び出す処理を実装します。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
trace−トレースを出力する |
|
形式 |
protected void trace(
String pMessage)
|
|
説明 |
WebOTXのトレース出力機能を利用してトレースを出力する。トレースレベルはあらかじめiMyTraceLevelに設定しておいてください。
- pMessageには出力するメッセージを設定します。
|
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
trace−出力レベルを指定してトレースを出力する |
|
形式 |
protected void trace(
int pLvl,
String pMessage)
|
|
説明 |
WebOTXのトレース出力機能を利用してトレースを出力します。
- pLvlにはトレースレベルを設定します。
- pMessageには出力するメッセージを設定します。
|
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
init−初期化処理を実行する |
|
形式 |
void init(
WebGWDB dbc,
int SystemTraceLevel)
|
|
説明 |
WebGWAppクラスを継承してビジネスロジッククラスを作成した場合は、ビジネスロジックの初期化処理を実装します。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
WebGWObj クラスは、CORBAとのインタフェース処理を実装しているクラスです。
WebGWObj クラスが提供する各メソッドについて、以下に説明します。
|
名称 |
createErrorHTML−エラー用HTMLを作成する |
|
形式 |
void createErrorHTML(
WebGWException WebGWe)
|
|
説明 |
エラー用のHTMLを出力します。エラー情報はWebGWeから取得します。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
doAP |
|
形式 |
void doAP(
WebGWPackage.stringSeqHolder io_cl1,
WebGWPackage.stringSeqHolder io_cl2,
WebGWPackage.stringSeqHolder io_ctl1,
WebGWPackage.stringSeqHolder io_ctl2,
String[] i_key,
String[] I_value,
org.omg.CORBA.StringHolder o_HTML)
|
|
説明 |
Webサーバから呼び出されて、ビジネスクラスのdoMethod処理を呼び出す。
ビジネスクラス名は io_ctl1[x]=apservid、io_ctl2[x]=ビジネスクラス名 で指定する。
ビジネスクラスはWebGWAppクラスを継承していなければならない |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
doAPdownload |
|
形式 |
void doAPdownload(
WebGWPackage.stringSeqHolder io_cl1,
WebGWPackage.stringSeqHolder io_cl2,
WebGWPackage.stringSeqHolder io_ctl1,
WebGWPackage.stringSeqHolder io_ctl2,
String[] i_key,
String[] i_value,
WebGWPackage.octetSeqHolder o_HTML)
|
|
説明 |
Webサーバから呼び出されて、ビジネスクラスのdoMethod処理を呼び出す。
・ビジネスクラス名は io_ctl1[x]=apservid、io_ctl2[x]=ビジネスクラス名 で指定する。
・ビジネスクラスはWebGWAppクラスを継承していなければならない。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
2.7. WebGWInputStream クラス |
WebGWInputStream は、入力データを管理するクラスです。
WebGWInputStream クラスが提供する各メソッドについて、以下に説明します。
|
名称 |
readLine |
|
形式 |
int readLine(
byte obuf[],
int off,
int maxLen)
|
|
説明 |
javax.servlet.ServletInpuStreamクラスのreadLineと同様に、CRLFまでのバイト配列を読み込む。返却値はCRLFを含む有効バイト長であり、最大maxLenで打ち切る。
入力データがCRで打ち切られたとしても、次回のreadLineではLFのみ1バイトで受信できる。
入力データがEOFとなり、1バイトもreadできない場合には、-1が返却される。 |
|
戻り値 |
int |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
その他、java.io.InputStreamクラスがサポートしているread()等のメソッドをオーバーライドしています。
|
2.8. MultipartRequest クラス |
MultipartRequest クラスは、マルチパートタイプのデータを扱うクラスです。
MultipartRequest クラスが提供する各メソッドについて、以下に説明します。
|
名称 |
MultipartRequest |
|
形式 |
MultipartRequest(
byte buf[],
int start,
int end,
byte boundary[])
|
|
説明 |
マルチパートリクエストクラスのコンストラクタ。
・bufにはWEBサーバから受信したマルチパートの文字列を指定してください。
・startにはbuf内のマルチパートの開始する位置を指定してください。
・endにはbuf内のマルチパートの終了する位置を指定してください。
・boundaryにはマルチパートの区切り文字列を指定してください。 |
|
戻り値 |
ありません。 |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getParameter |
|
形式 |
int getParameter(
String name,
byte b[],
int off,
int len)
throws IOException
|
|
説明 |
nameで指定されたパラメータ名の値に対応する文字列をbyte配列で返却します。 |
|
戻り値 |
int |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getParameter |
|
形式 |
String getParameter(
String name)
throws IOException
|
|
説明 |
nameで指定されたパラメータ名の値に対応する文字列を返却します。 |
|
戻り値 |
String |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getParameterByte |
|
形式 |
byte[] getParameterByte(
String name)
throws IOException
|
|
説明 |
パラメータのバイナリ値を返却します。 |
|
戻り値 |
byte |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getParameterNames |
|
形式 |
Enumeration getParameterNames()
throws IOException
|
|
説明 |
パラメータ名(=マルチパートのname=で指定された文字列)をすべて返却します。 |
|
戻り値 |
Enumeration |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
2.8.6. getUpfileInputStream |
|
名称 |
getUpfileInputStream |
|
形式 |
UpfileInputStream getUpfileInputStream(
String name)
throws IOException
|
|
説明 |
nameで指定されたパラメータ名に対応する文字列のUpfileInputStreamオブジェクトを返却します。 |
|
戻り値 |
UpfileInputStream |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
|
名称 |
getUpfileNames |
|
形式 |
Enumeration getUpfileNames()
throws IOException
|
|
説明 |
アップロードファイル識別名をすべて返却します。 |
|
戻り値 |
Enumeration |
|
エラー |
ありません。 |
|
関連項目 |
ありません。 |
WebGWTransFile クラスは、ファイルのアップロード処理とダウンロード処理を実装しているクラスです。
WebGWTransFile クラスが提供する各メソッドについて、以下に説明します。
|
名称 |
downFile−ファイルのダウンロードを行う |
|
形式 |
void downFile(
WebGWParamIO ioObj,
String SrcFileName)
|
|
説明 |
入力パラメタで指定されたファイルを読み込み、
WebGWParmIO(ioObj)オブジェクトに設定します。
HTTPヘッダ(Content-Type等)は、本メソッドで設定しないので
必要に応じて呼び出し元で設定する必要があります。 |
|
戻り値 |
ありません。 |
|
エラー |
WebGWException を throwします。
|
|
関連項目 |
ありません。 |
|
名称 |
upFile−ファイルのアップロードを行う |
|
形式 |
void upFile(
WebGWParamIO ioObj,
String OutPathName)
|
|
説明 |
入力ストリームを WebGWParmIO(ioObj) オブジェクトから取得し、
<input type=file>タグの nameの値をファイル名にして、
OutPathName で指定されたディレクトリにファイルを書き込みます。
マルチパートリクエストの全てのパートについて処理します。
なお、<input type=file>タグの name が省略されている場合は、正常に動作しません。 |
|
戻り値 |
ありません。 |
|
エラー |
WebGWException を throwします。
|
|
関連項目 |
ありません。 |