概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
openGion 5.1.6.0
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## org.opengion.hayabusa.taglib
クラス ShellTag

    java.lang.Object
      javax.servlet.jsp.tagext.TagSupport
          javax.servlet.jsp.tagext.BodyTagSupport
              org.opengion.hayabusa.taglib.CommonTagSupport
                  org.opengion.hayabusa.taglib.ShellTag

すべての実装されたインタフェース:
  Serializable, BodyTag, IterationTag, JspTag, Tag, TryCatchFinally

    public class ShellTag

extends CommonTagSupport

ネイティブなプロセスを作成し、バッチファイルやアプリケーションを起動するタグです。 プロセスの状態に応じて、下記のリターンコードが得られます。 SHELL.RTN_CODE = 0 : 正常 （ページの残りを評価する。） SHELL.RTN_CODE = 1 : 処理中 （ページの残りを評価する。） SHELL.RTN_CODE = 9 : 取消 （ページの残りを評価する。） SHELL.RTN_CODE = -1 : 異常終了（ページの残りの処理を行わない。） 異常終了の場合は、このタグ以降の処理を中止します。 wait 属性を使用して、処理の終了を待たずに、復帰することも出来ます。この場合は、 SHELL.RTN_CODE = 1 となり、そのまま、処理は継続されます。このSHELL.RTN_CODE は、 リクエスト変数にセットされていますので、そのまま、value タグで、取得可能です。 action 属性に指定できるアクション名は、以下のとおりです。 RUN Shellオブジェクトを生成/実行します。（セッションに登録しません。） SET Shellオブジェクトを生成/実行し、セッションに登録します。 すでにセッションに登録済みのShellオブジェクトが実行中の場合は、途中経過を報告します。 GET セッションに登録されている Shellオブジェクトを呼び出します。 セッションに登録されていない場合は、異常終了になります。 REMOVE セッションから、Shellオブジェクトを削除します。 Shellが実行中の場合は強制終了します。

関連項目:
  直列化された形式
機能階層
  その他部品
形式サンプル:

       ●形式：<og:shell program="…" />
       ●body：なし

       ●使用例
          <og:shell
              program  = "プログラム"      dir /S や、abc.bat  など
              action   = "アクション"      [RUN/SET/GET/REMOVE]
              useBatch = "バッチ使用"      バッチ：true/false    (初期値 false)
              wait     = "終了待ち"        処理終了まで待つ:true/待たない:false    (初期値 true)
              stdout   = "標準出力使用"    標準出力使用:true/未使用:false     (初期値 false)
              stderr   = "エラー出力使用"  エラー出力使用:true/未使用:false   (初期値 false)
              info     = "状態表示"        シェルの状態表示:true/未使用:false (初期値 false)
          />

          <og:value command="GET" key="SHELL.RTN_CODE" />

バージョン
  4.0
作成者
  Kazuhiko Hasegawa
導入されたバージョン:
  JDK5.0,

フィールドの概要
`static String` | `ACT_GET` action 引数に渡す事の出来る コマンド 取得 "GET"
`static String` | `ACT_REMOVE` action 引数に渡す事の出来る コマンド 削除 "REMOVE"
`static String` | `ACT_RUN` action 引数に渡す事の出来る コマンド 実行 "RUN"
`static String` | `ACT_SET` action 引数に渡す事の出来る コマンド 登録 "SET"

クラス javax.servlet.jsp.tagext.BodyTagSupport から継承されたフィールド
`bodyContent`

クラス javax.servlet.jsp.tagext.TagSupport から継承されたフィールド
`id, pageContext`

インタフェース javax.servlet.jsp.tagext.BodyTag から継承されたフィールド
`EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

インタフェース javax.servlet.jsp.tagext.IterationTag から継承されたフィールド
`EVAL_BODY_AGAIN`

インタフェース javax.servlet.jsp.tagext.Tag から継承されたフィールド
`EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

コンストラクタの概要
`ShellTag()`

メソッドの概要
`int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
`protected void` | `release2()` タグリブオブジェクトをリリースします。
`void` | `setAction(String act)` 【TAG】アクション(RUN,SET,GET,REMOVE)をセットします(初期値:RUN)。
`void` | `setDisplay(String flag)` 【TAG】処理結果を画面に表示するかどうか指定します(初期値:true)。
`void` | `setEnvKeys(String keys)` 【TAG】環境変数のキーをＣＳＶ形式で指定します(初期値:現状のJava仮想マシンの環境)。
`void` | `setEnvVals(String vals)` 【TAG】環境変数の値をＣＳＶ形式で指定します(初期値:現状のJava仮想マシンの環境)。
`void` | `setInfo(String flag)` 【TAG】インフォメーション情報を出力するかどうか(true/false)を指定します(初期値:false)。
`void` | `setProgram(String val)` 【TAG】シェルファイルを実行する時に引き渡すコマンド。
`void` | `setStderr(String flag)` 【TAG】実行結果をエラー出力に出力するかどうか(true/false)を指定します(初期値:false)。
`void` | `setStdout(String flag)` 【TAG】実行結果を標準出力に出力するかどうか(true/false)を指定します(初期値:false)。
`void` | `setTimeout(String tout)` 【TAG】プロセスの実行処理のタイムアウトを設定します(初期値:SHELL_TIMEOUT)。
`void` | `setUseBatch(String flag)` 【TAG】BATCHプロセスを実行するのかどうか(true/false)を指定します(初期値:false)。
`void` | `setWait(String flag)` 【TAG】プロセスの終了を待つかどうか(true/false)を指定します(初期値:true[待つ])。
`void` | `setWorkDir(String dir)` 【TAG】作業ディレクトリを指定します(初期値:Java仮想マシンの作業ディレクトリ)。
`String` | `toString()` このオブジェクトの文字列表現を返します。

クラス org.opengion.hayabusa.taglib.CommonTagSupport から継承されたメソッド
`add, add, addEventColumnSQL, check, check, commitTableObject, debugPrint, doAfterBody, doCatch, doFinally, doStartTag, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getLabel, getLabelInterface, getLanguage, getLongLabel, getMsglbl, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getResource, getScope, getSessionAttribute, getTagName, getUser, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setMsglbl, setNoTransitionRequest, setObject, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, setUseValue, startQueryTransaction, sys, sysBool, sysInt, useMainTrans, useQuotCheck, useXssCheck`

クラス javax.servlet.jsp.tagext.BodyTagSupport から継承されたメソッド
`doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

クラス javax.servlet.jsp.tagext.TagSupport から継承されたメソッド
`findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue`

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

インタフェース javax.servlet.jsp.tagext.Tag から継承されたメソッド
`getParent, setPageContext, setParent`

フィールドの詳細

### ACT_RUN

    public static final String ACT_RUN

  action 引数に渡す事の出来る コマンド 実行 "RUN"

  関連項目:
    定数フィールド値

### ACT_SET

    public static final String ACT_SET

  action 引数に渡す事の出来る コマンド 登録 "SET"

  関連項目:
    定数フィールド値

### ACT_GET

    public static final String ACT_GET

  action 引数に渡す事の出来る コマンド 取得 "GET"

  関連項目:
    定数フィールド値

### ACT_REMOVE

    public static final String ACT_REMOVE

  action 引数に渡す事の出来る コマンド 削除 "REMOVE"

  関連項目:
    定数フィールド値

コンストラクタの詳細

### ShellTag

    public ShellTag()

メソッドの詳細

### doEndTag

    public int doEndTag()

  Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。

  定義:
    インタフェース `Tag` 内の `doEndTag`
  オーバーライド:
    クラス `CommonTagSupport` 内の `doEndTag`
  戻り値:
    int
  変更履歴:

    3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
    3.1.9.0 (2003/05/16) Shell への stdout と stderr の取得設定は廃止。ShellTag では、有効。
    3.3.3.0 (2003/07/09) デバッグ時の表示ロジックを追加。

### release2

    protected void release2()

  タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。

  オーバーライド:
    クラス `CommonTagSupport` 内の `release2`
  変更履歴:

    2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
    3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
    3.1.9.0 (2003/05/16) action コマンド追加
    3.3.3.0 (2003/07/09) action コマンドの動きを修正。
    3.6.0.1 (2004/09/29) display 属性を追加
    3.6.1.0 (2005/01/05) timeout 属性を追加

### setProgram

    public void setProgram(String val)

  【TAG】シェルファイルを実行する時に引き渡すコマンド。

  パラメータ:
    `val` - シェルコマンド
  TagLib:

    シェルファイルを実行する時に引き渡すコマンド

### setUseBatch

    public void setUseBatch(String flag)

  【TAG】BATCHプロセスを実行するのかどうか(true/false)を指定します(初期値:false)。

  パラメータ:
    `flag` - BATCHプロセスを実行するのかどうか(true/false)
  TagLib:

    BATCHファイルの実行と、EXEファイルの実行では、cmd.exe 経由するか どうか、判断が必要です。true(BATCHプロセス)では、cmd.exe 経由で実行、 false(EXEファイル)では、直接実行します。 初期値は、false(EXEファイル)です。

### setStdout

    public void setStdout(String flag)

  【TAG】実行結果を標準出力に出力するかどうか(true/false)を指定します(初期値:false)。

  パラメータ:
    `flag` - 実行結果の標準出力 true:出力する/false:しない
  TagLib:

    実行結果の標準出力を出力するかどうか（初期値 false）

### setStderr

    public void setStderr(String flag)

  【TAG】実行結果をエラー出力に出力するかどうか(true/false)を指定します(初期値:false)。

  パラメータ:
    `flag` - 実行結果のエラー出力 true:出力する/false:しない
  TagLib:

    実行結果のエラー出力を出力するかどうか（初期値 false）

### setWait

    public void setWait(String flag)

  【TAG】プロセスの終了を待つかどうか(true/false)を指定します(初期値:true[待つ])。

  パラメータ:
    `flag` - プロセスの終了を待つ（true)/待たない(false)
  TagLib:

    プロセスの終了を待つ（true)/待たない(false) （初期値 true）

### setTimeout

    public void setTimeout(String tout)

  【TAG】プロセスの実行処理のタイムアウトを設定します(初期値:SHELL_TIMEOUT)。

  パラメータ:
    `tout` - String タイムアウト時間(秒) ゼロは、無制限
  TagLib:

    ゼロ(0) の場合は、割り込みが入るまで待ちつづけます。 その場合、確実に終了させる手段を用意しておかないと、いつまで待っても以下の処理が 実行されない（デッドロック）状態になってしまいます。

  変更履歴:

    3.6.1.0 (2005/01/05) 新規追加

### setInfo

    public void setInfo(String flag)

  【TAG】インフォメーション情報を出力するかどうか(true/false)を指定します(初期値:false)。

  パラメータ:
    `flag` - インフォメーション情報 true:出力する/false:しない
  TagLib:

    インフォメーション情報を出力するかどうか（初期値 false）

  変更履歴:

    3.1.9.0 (2003/05/16) 新規追加

### setDisplay

    public void setDisplay(String flag)

  【TAG】処理結果を画面に表示するかどうか指定します(初期値:true)。

  パラメータ:
    `flag` - 処理結果を画面に表示するかどうか true:出力する/false:しない
  TagLib:

    処理結果が、異常でない場合のみ、この機能が有効になります。 各種処理を連続で行う場合、最後にエラーが発生したにもかかわらず、 先に正常終了している場合に、不要なメッセージを出すと、紛らわしい為です。

  変更履歴:

    3.6.0.1 (2004/09/29) 新規追加

### setAction

    public void setAction(String act)

  【TAG】アクション(RUN,SET,GET,REMOVE)をセットします(初期値:RUN)。

  パラメータ:
    `act` - アクション(初期値は、RUN です。)
  関連項目:
    アクション定数
  TagLib:

    アクションは,HTMLから（get/post)指定されますので,ACT_xxx で設定される フィールド定数値のいづれかを、指定できます。 RUN Shellオブジェクトを生成/実行します。（セッションに登録しません。） SET Shellオブジェクトを生成/実行し、セッションに登録します。 GET セッションに登録されている Shellオブジェクトを呼び出します。 REMOVE セッションから、Shellオブジェクトを削除します。 Shellが実行中の場合は強制終了します。

  変更履歴:

    3.1.9.0 (2003/05/16) 新規追加
    3.5.6.2 (2004/07/05) 文字列の連結にStringBuilderを使用します。

### setWorkDir

    public void setWorkDir(String dir)

  【TAG】作業ディレクトリを指定します(初期値:Java仮想マシンの作業ディレクトリ)。

  パラメータ:
    `dir` - 作業ディレクトリ
  TagLib:

    シェルを実行する、作業ディレクトリを指定します。 絶対パスで指定することも、相対パスで指定することも出来ます。 相対パスの場合は、ドキュメントベースの物理パスが基準になります。 （そのJSPファイル自身のディレクトリが基準ではありません。） 指定しない場合は、このJava仮想マシンの作業ディレクトリで実行されます。

  変更履歴:

    3.3.3.0 (2003/07/09) 新規追加

### setEnvKeys

    public void setEnvKeys(String keys)

  【TAG】環境変数のキーをＣＳＶ形式で指定します(初期値:現状のJava仮想マシンの環境)。

  パラメータ:
    `keys` - 環境変数のキー
  TagLib:

    シェル実行時の環境変数のキーを、ＣＳＶV形式で指定します。 指定がない場合は、現状のJava仮想マシンの環境が引き継がれます。 envVals と対応していなければなりません。 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。

  変更履歴:

    3.3.3.0 (2003/07/09) 新規追加
    3.5.6.2 (2004/07/05) CommonTagSupport#getCSVParameter を使用

### setEnvVals

    public void setEnvVals(String vals)

  【TAG】環境変数の値をＣＳＶ形式で指定します(初期値:現状のJava仮想マシンの環境)。

  パラメータ:
    `vals` - 環境変数のキー
  TagLib:

    シェル実行時の環境変数の値を、ＣＳＶV形式で指定します。 指定がない場合は、現状のJava仮想マシンの環境が引き継がれます。 envKeys と対応していなければなりません。 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。

  変更履歴:

    3.3.3.0 (2003/07/09) 新規追加
    3.5.6.2 (2004/07/05) CommonTagSupport#getCSVParameter を使用

### toString

    public String toString()

  このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。

  オーバーライド:
    クラス `CommonTagSupport` 内の `toString`
  戻り値:
    このクラスの文字列表現

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| openGion 5.1.6.0
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.