51.2.1.1 ISOPenv()

Interstage Application Server J2EE ユーザーズガイド

目次索引

第7部ツール編

> 第51章 Interstage運用API

> 51.2 Interstage運用APIの詳細

> 51.2.1 環境操作関数

51.2.1.1 ISOPenv()

機能説明

　本関数は、以下の機能を提供します。

Interstage運用API環境初期化

　Interstage運用API環境を初期化します。運用APIの初期化は、アプリケーションで1度だけ発行してください。

Interstage運用API環境回収

　Interstage運用API環境を回収します。運用API環境の回収は、アプリケーションで1度だけ発行してください。

サーブレットAPI環境初期化

　サーブレットAPI環境を初期化します。
　本機能は、以下の方法でInterstageを初期化した場合のみ有効となります。

Interstage動作環境定義のServletサービスの使用（Servlet:ステートメント）に“yes”を設定し、isinitコマンドでInterstageの初期化を行った場合
Interstage運用操作ツールの「カスタムセットアップの運用形態指定」画面の「使用するサービスの選択」で、Servletサービスを“yes”にしてセットアップを行った場合

　本APIは、管理者権限を持つユーザが起動したプロセスから発行してください。

サーブレットAPI環境回収

　サーブレットAPI環境を回収します。

形式

　#include  "ISOP.h"
　void  ISOPenv(char *reqparm)

　引数reqparmは、パラメタ構造体を指すポインタです。パラメタ構造体は使用する機能ごとに、指定された形式の構造体を獲得し、設定してください。
　パラメタ構造体へのポインタをchar*型にキャストして、引数としてください。
　獲得した領域は、あらかじめゼロクリアしてください。

１）Interstage運用API環境初期化

パラメタ構造体

　下記のISOP_CTRL構造体を獲得し、パラメタを設定してください。

typedef struct _isop_ctrl_t {             /* 基本情報制御表定義       */
　　　long              request;          /* 要求コード               */
　　　unsigned long     pktvl;            /* 本制御表のバージョン情報 */
　　　long              result;           /* 実行結果                 */
　　　long              detail;           /* 原因コード               */
　　　char              sysname[12];      /* 操作対象システム（Solaris OEのみ） */
　　　char              rsv[52];          /* リザーブ                 */
} ISOP_CTRL;

設定情報

メンバ名	型	設定値	意味
request	long	ISOP_RINIENV	要求コード： Interstage運用API環境初期化
pktvl	unsigned long	ISOP_006	制御表のバージョン情報
sysname(注)	char	システム名	操作対象とするシステム名

注）
　システム名が省略された場合は、環境変数IS_SYSTEMに設定されているシステム名が有効となります。システム名と環境変数IS_SYSTEMが省略された場合は、デフォルトシステムが有効となります。
　Standard EditionおよびPlusでは、システム名は無視されます。

復帰情報

メンバ名	型	復帰値	意味
pktvl(注1)	unsigned long	ISOP_006	復帰した制御表のバージョン情報
result	long	0	正常終了
result	long	-1	異常終了エラーの詳細はdetailを参照
detail(注2)	long	原因コード	エラーの詳細情報(実行結果詳細値を参照)

注1)
　APIが復帰時に通知する制御表のバージョン情報については、“Interstage運用APIの制御表のバージョン・レベルについて”を参照してください。

注2)
　異常終了した場合はdetailのみ正しい値を設定します。その他の値の内容は不定です。

実行結果詳細値

define値	値	意味
ISOP_EINVAL_REQ	2101	要求コードに誤りがあります。
ISOP_ENOMEM	3002	メモリ不足が発生しました。
ISOP_ESYSERR	4001	システムエラー。
ISOP_ESTPIS	4102	Interstageが起動されていません。
ISOP_ENOSYSTEM	4110	操作対象システムが存在しません。（注）
ISOP_EDIFFSYSTEM	4111	異なるシステムに対して環境初期化APIを発行しました。現在、環境初期化済みのシステムに対して、環境回収APIを発行後、再度発行してください。（注）

注）
　Enterprise Editionで、pktvlがISOP_005以降の場合に有効。

２）Interstage運用API環境回収

パラメタ構造体

　下記のISOP_CTRL構造体を獲得し、パラメタを設定してください。

typedef struct _isop_ctrl_t {                    /* 基本情報制御表定義       */
　　　long               request;                /* 要求コード               */
　　　unsigned long      pktvl;                  /* 本制御表のバージョン情報 */
　　　long               result;                 /* 実行結果                 */
　　　long               detail;                 /* 原因コード               */
　　　char              sysname[12];             /* 操作対象システム（Solaris OEのみ） */
　　　char              rsv[52];                 /* リザーブ                 */
} ISOP_CTRL;

設定情報

メンバ名	型	設定値	意味
request	long	ISOP_RTRMENV	要求コード： Interstage運用API環境回収
pktvl	unsigned long	ISOP_006	制御表のバージョン情報

復帰情報

メンバ名	型	復帰値	意味
pktvl(注1)	unsigned long	ISOP_006	復帰した制御表のバージョン情報
result	long	0	正常終了
result	long	-1	異常終了エラーの詳細はdetailを参照
detail(注2)	long	原因コード	エラーの詳細情報(実行結果詳細値を参照)

注1)
　APIが復帰時に通知する制御表のバージョン情報については、“Interstage運用APIの制御表のバージョン・レベルについて”を参照してください。

注2)
　異常終了した場合はdetailのみ正しい値を設定します。その他の値の内容は不定です。

実行結果詳細値

define値	値	意味
ISOP_ENOINIT	2003	API環境が初期化されていません。
ISOP_EINVAL_REQ	2101	要求コードに誤りがあります。
ISOP_ESYSERR	4001	システムエラー。
ISOP_ESTPIS	4102	Interstageが起動されていません。
ISOP_EINTR	4107	割り込みが発生しました。

３）サーブレットAPI環境初期化

パラメタ構造体

　下記のISOP_CTRL構造体を獲得し、パラメタを設定してください。

typedef struct _isop_ctrl_t {             /* パラメタ設定用制御表定義 */
　　　long            request;            /* 要求コード */
　　　unsigned long   pktvl;              /* 本制御表のバージョン情報 */
　　　long            result;             /* 実行結果 */
　　　long            detail;             /* 原因コード */
　　　char            sysname[12];        /* 操作対象システム（Solaris OEのみ） */
　　　char            rsv[52];            /* リザーブ */
} ISOP_CTRL;

設定情報

メンバ名	型	設定値	意味
request	long	ISOP_RINIJS	要求コード：サーブレットAPI環境初期化
pktvl	unsigned long	ISOP_006	制御表のバージョン情報
sysname	char*	システム名	操作対象とするシステム名（注）

注）システム名が省略された場合は、環境変数IS_SYSTEMに設定されているシステム名が有効となります。システム名と環境変数IS_SYSTEMが省略された場合は、デフォルトシステムが有効となります。Standard EditionおよびPlusでは、システム名は無視されます。

復帰情報

メンバ名	型	復帰値	意味
pktvl	unsigned long	ISOP_006	復帰した制御表のバージョン情報
result	long	0	正常終了
result	long	-1	異常終了エラーの詳細はdetailを参照
detail	long	原因コード	エラーの詳細情報

実行結果詳細値

define値	値	意味
ISOP_ENORIGHTX	2005	本ユーザには実行権がありません
ISOP_EINVAL_REQ	2101	要求コードに誤りがあります
ISOP_ENOMEM	3002	メモリ不足が発生しました
ISOP_ESYSERR	4001	システムエラー
ISOP_ESTPIS	4102	Interstageが起動されていません
ISOP_ENOSYSTEM	4110	操作対象システムが存在しません。（注）
ISOP_EDIFFSYSTEM	4111	異なるシステムに対してAPI環境初期化APIを発行しました。初期化済みシステムに対してAPI環境回収APIを発行後、再度実施してください。（注）
ISOP_ENOINST	4123	Servletが未インストールです

注）Enterprise Editionの場合に有効。

４）サーブレットAPI環境回収

パラメタ構造体

　環境初期化時に獲得したISOP_CTRL構造体のポインタを、パラメタに設定してください。

設定情報

メンバ名	型	設定値	意味
request	long	ISOP_RTRMJS	要求コード：サーブレットAPI環境回収
pktvl	unsigned long	ISOP_006	制御表のバージョン情報

復帰情報

メンバ名	型	復帰値	意味
pktvl	unsigned long	ISOP_006	復帰した制御表のバージョン情報
result	long	0	正常終了
result	long	-1	異常終了エラーの詳細はdetailを参照
detail	long	原因コード	エラーの詳細情報

実行結果詳細値

define値	値	意味
ISOP_ENOINIT	2003	API環境が初期化されていません
ISOP_EINVAL_REQ	2101	要求コードに誤りがあります
ISOP_EAGAIN	3001	システム資源不足が発生しましたしばらくしてから再度実行してください
ISOP_ENOMEM	3002	メモリ不足が発生しました
ISOP_ESYSERR	4001	システムエラー
ISOP_ESTPIS	4102	Interstageが起動されていません
ISOP_EINTR	4107	割り込みが発生しました

注意事項

　本関数を使用するには、isstartコマンドを使用し、Interstageの起動を行う必要があります。各コンポーネントから提供されている起動コマンドは使用しないでください。

Enterprise Editionのみ
　なお、クラスタ構成で運用する場合には、isstartコマンドを使用する必要はありません。

目次索引