プライマリ・コンテンツに移動
Oracle® Fusion Middleware Oracle WebLogic Server 12.1.3アプリケーションの開発
12c (12.1.3)
E57574-04
  ドキュメント・ライブラリへ移動
ライブラリ
製品リストへ移動
製品
目次へ移動
目次

前
 
次
 

3 WebLogic Mavenプラグインの使用方法

Apache Mavenは、Javaベース・プロジェクトの構築および管理を行うためのソフトウェア・ツールです。WebLogic Server 12.1.3は、Maven環境内からWebLogic Server上で様々な処理を実行できるようにするプラグインのプロビジョニングによってMavenのサポートを提供しています。

weblogic-maven-pluginは、インストール、サーバーの起動と停止、ドメインの作成、WLSTスクリプトの実行、およびアプリケーションのコンパイルとデプロイのための拡張機能を提供します。weblogic-maven-pluginを使用すると、必要に応じて、ご使用のMaven環境内からWebLogic Serverをインストールし、ローカルWebLogic Server要件を満たすことができます。

次の項では、weblogic-maven-pluginの使用方法について説明します。

追加のMavenのドキュメントについては、『継続的インテグレーションによるアプリケーションの開発』を参照してください。特に、Mavenを使用したWebLogic Server用のJava EEプロジェクトの構築に関する項を参照してください。

Mavenのインストール

weblogic-maven-pluginプラグインを使用するには、その前にまず、機能するMavenインストールとMavenリポジトリを設定する必要があります。WebLogic Serverは、Maven 3.0.4以降をサポートしています。

Maven 3.0.5の配布はWebLogic Serverに付属しており、次の場所にあります。ORACLE_HOME\oracle_common\modules\org.apache.maven_3.0.5これは、変更を含まない、標準のMaven 3.0.5リリースのコピーです。

ORACLE_HOME\wlserver\server\bin\setWLSEnvスクリプトを実行して、Mavenを構成します。

別の方法として、Maven Webサイト(http://maven.apache.org)からMavenの独自のコピーをダウンロードしてインストールすることもできます。該当するドキュメントの詳細に従って、必要な変数(M2_HOMEJAVA_HOMEなど)を設定するようにしてください。


注意:

weblogic-maven-pluginは、Javaプロトコル・ハンドラをweblogic.netに設定します。デフォルトのJDKプロトコル・ハンドラを使用するには、Mavenを実行するJVMのシステム・プロパティ-DUseSunHttpHandler=trueを指定します。これを実行するには、mvn.batまたはmvn.shファイル内の環境変数MAVEN_OPTSをオーバーライドして、適切な値を設定します。次に例を示します。set MAVEN_OPTS="-DUseSunHttpHandler=true"

アプリケーションとプロジェクトを構築するためのMavenのインストールと使用方法の詳細は、http://maven.apache.org/users/index.htmlのMavenユーザー・センターに関する項を参照してください。

WebLogic Mavenプラグインの構成

weblogic-maven-pluginプラグインは、組込み済JARファイルとそれに付随するpomファイルとして提供されます。

weblogic-maven-pluginをインストールおよび構成する手順は、次のとおりです。

  1. Oracle Maven同期プラグインをインストールして、pushゴールを実行します。

    1. ディレクトリを、ORACLE_HOME\oracle_common\plugins\maven\com\oracle\maven\oracle-maven-sync\12.1.3に変更します。

    2. mvn install:install-file -DpomFile=oracle-maven-sync-12.1.3.pom -Dfile=oracle-maven-sync-12.1.3.jar.

    3. mvn com.oracle.maven:oracle-maven-sync:push -Doracle-maven-sync.oracleHome=c:\oracle\middleware\oracle_home\.

  2. Maven help:describeゴールを使用して、プラグインのインストールが成功したかどうかを検証できます。詳細は、Apacheヘルプ・プラグインdescribeゴールのドキュメントを参照してください。

    mvn help:describe -DgroupId=com.oracle.weblogic
    -DartifactId=weblogic-maven-plugin -Dversion=12.1.3-0-0
    

WebLogic Mavenプラグインの使用方法

WebLogic Mavenプラグインのゴールを呼び出すには、次の2つの方法があります。

  • MavenプロジェクトPOMから

  • コマンド・ラインから

appc、wsgen、wsimport、ws-jwsc、ws-wsdlcおよびws-clientgenゴールは、POMを必要とします。

他のゴールはいずれの方法でも正常に呼び出せます。たとえば、install、wlst、wlst-client、start-serverまたはstop-serverは、POMからでも、コマンド・ラインからでも呼び出せます。

望ましいお薦めの方法は、Maven POMファイルを使用することです。

POMファイルからWebLogic Mavenプラグイン・ゴールを呼び出すには、次の操作を実行します。

  1. buildセクションが未設定の場合は、POMにbuildセクションを追加します。

  2. WebLogic Mavenプラグインのbuildセクションにplug-inセクションを追加します。

  3. 実行するゴールごとに、WebLogic Mavenプラグインのpluginセクションにexecutionセクションを追加します。このセクションではゴールに必要なパラメータを提供し、Mavenライフサイクルのフェーズにゴールをマップする必要があります。

例3-1は、数個のゴールを含む、必要な追加の例を示しています。このセクションの後半にある各ゴールの詳細な説明は、各ゴールのパラメータと例の詳細を示しています。

同じライフサイクル・フェーズに複数のゴールをマップした場合は、通常、POMでリストした順序で実行されます。

例3-1 POMファイルの変更

<build>
    <plugins>
      <plugin>
        <!-- This is the configuration for the
             weblogic-maven-plugin
        -->
        <groupId>com.oracle.weblogic</groupId>
<artifactId>weblogic-maven-plugin</artifactId>
        <version>12.1.3-0-0</version>
        <configuration>
<middlewareHome>/fmwhome/wls12130</middlewareHome>
        </configuration>
        <executions>
          <!-- Execute the appc goal during the package phase -->
          <execution>
            <id>wls-appc</id>
            <phase>package</phase>
            <goals>
              <goal>appc</goal>
            </goals>
            <configuration>
<source>${project.build.directory}/${project.name}.${project.packaging}</source>
            </configuration>
          </execution>
          <!-- Deploy the application to the WebLogic Server in the
               pre-integration-test phase
          -->
          <execution>
            <id>wls-deploy</id>
            <phase>pre-integration-test</phase>
            <goals>
              <goal>deploy</goal>
            </goals>
            <configuration>
              <!--The admin URL where the app is deployed. 
Here use the plugin's default value t3://localhost:7001-->
<adminurl>t3://127.0.0.1:7001</adminurl>
              <user>weblogic</user>
              <password>password</password>
              <!--The location of the file or directory to be deployed-->
<source>${project.build.directory}/${project.build.finalName}.${project.packaging}</source>
              <!--The target servers where the application is deployed. 
Here use the plugin's default value AdminServer-->
              <targets>AdminServer</targets>
              <verbose>true</verbose>
<name>${project.build.finalName}</name>
            </configuration>
          </execution>
          <!-- Stop the application in the pre-integration-test phase -->
          <execution>
            <id>wls-stop-app</id>
            <phase>pre-integration-test</phase>
            <goals>
              <goal>stop-app</goal>
            </goals>
            <configuration>
<adminurl>t3://127.0.0.1:7001</adminurl>
              <user>weblogic</user>
              <password>password</password>
<name>${project.build.finalName}</name>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build> 

表3-1には、デフォルトのMavenライフサイクルのフェーズがリストされています。

表3-1 Mavenライフサイクルのフェーズ

フェーズ 説明

validate

プロジェクトが正しく、必要なすべての情報が利用可能であることを検証します。

compile

プロジェクトのソース・コードをコンパイルします。

test

フレームワークをテストする適切なユニットを使用して、コンパイルされたソース・コードをテストします。これらのテストで、コードをパッケージ化したりデプロイすることは要求されません。

package

コンパイルされたコードを取得して、JARなどの配布可能なフォーマットでパッケージ化します。

integration-test

パッケージを処理して、必要に応じて統合テストを実行できる環境にデプロイします。

verify

チェックを実行して、パッケージが有効であり、品質基準を満たしていることを確認します。

install

ローカルで他のプロジェクトにおける依存関係として使用するために、パッケージをローカル・リポジトリにインストールします。

deploy

統合またはリリース環境で、他の開発者やプロジェクトと共有するために、最終パッケージをリモート・リポジトリにコピーします。


表3-2は、フェーズに対するゴールの最も一般的なマッピングを示しています。

表3-2 フェーズに対するゴールの一般的なマッピング

フェーズ ゴール

validate

ws-clientgen、ws-wsdlc

compile

ws-jwsc

test

NA

package

appc

pre-integration-test脚注 1 

install、create-domain、start-server、distribute-app、deploy、purge-tasks、redeploy、update-app、start-app、stop-app、wlst、wlst-clientおよびlist-apps

post-integration-test脚注 2 

remove-domain、undeploy、stop-server、uninstall

verify

NA

install

NA

deploy

NA


脚注 1 integration-testフェーズには、統合テストの実際の実行の前にそれぞれ実行される、事前サブフェーズがあります。

脚注 2 integration-testフェーズには、統合テストの実際の実行の後にそれぞれ実行される、事後サブフェーズがあります。

基本構成POMファイル

例3-2は、weblogic-maven-plugin appcゴールの使用をデモする基本的なJava EE 6 Webアプリケーションのpom.xmlファイルを示しています。

例3-2 基本構成pom.xmlファイル

<project xmlns="http://maven.apache.org/POM/4.0.0"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
 
    <groupId>demo.sab</groupId>
    <artifactId>maven-demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>
 
    <name>maven-demo</name>
 
    <properties>
        <endorsed.dir>${project.build.directory}/endorsed</endorsed.dir>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
 
    <dependencies>
      <dependency>
       <groupId>com.oracle.weblogic</groupId>
       <artifactId>weblogic-server-pom</artifactId>
       <version>12.1.3-0-0</version>
       <type>pom</type>
       <scope>provided</scope>
      </dependency>
    </dependencies>
 
    <build>
        <plugins>
            ...
            ...
 
            <!-- WebLogic Server 12c Maven Plugin -->
            <plugin>
                <groupId>com.oracle.weblogic</groupId>
                <artifactId>weblogic-maven-plugin</artifactId>
                <version>12.1.3-0-0</version>
            </plugin>
            <configuration>
             </configuration>
             <executions>
               <execution>
                <id>wls-appc</id>
                <phase>package</phase>
                <goals>
                 <goal>appc</goal>
                </goals>
               <configuration>
                 <source>${project.build.directory}/${project.name}.
                   ${project.packaging}</source>
               </configuration>
              </execution>
             </executions>
         </plugins>
    </build>
 
</project>

Mavenプラグインのゴール

表3-3では、すべてのweblogic-maven-pluginゴールを一覧表示しています。各ゴールの詳細は、後の項で説明します。

表3-3 Mavenプラグインのゴール

ゴール名 説明

appc


EJBおよびJSPをWebLogic Serverにデプロイするために必要なクラスを生成およびコンパイルします。また、個別のモジュール・レベルおよびアプリケーション・レベルの両方で現在の仕様に準拠しているかどうか、デプロイメント記述子を検証します。

create-domain


ドメイン・テンプレートを使用してWebLogic Serverドメインを作成します。このゴールは、ドメイン・ディレクトリ(最後のディレクトリでドメイン名を決定)および管理ユーザー名とパスワードの指定をサポートしています。より複雑なドメインを作成する場合は、wlstゴールを使用します。

deploy


WebLogic Serverアプリケーションおよびモジュールをデプロイします。WAR、JARなどのすべてのデプロイメント・フォーマットをサポートします。

distribute-app


デプロイメント・ファイルをターゲット・サーバーにコピーして検証することで、デプロイメント用に準備します。

help


非推奨。かわりに、標準のMaven helpプラグインを使用します。

install


WebLogic Serverをインストールします。

list-apps


ドメインにデプロイ、配布、またはインストールされているアプリケーションおよびスタンドアロン・モジュールのデプロイメント名をリストします。

purge-tasks


リタイアしたデプロイメント・タスクをフラッシュします。

redeploy


実行中のアプリケーションまたは実行中のアプリケーションの一部を再デプロイします。

remove-domain


ドメイン・ディレクトリを削除します。

start-app


WebLogic Server上にデプロイされたアプリケーションを起動します。

start-server


WebLogic Serverを起動します。このゴールは、ローカル起動スクリプトを実行して、WLSを起動します。ノード・マネージャを使用してリモート・サーバーを起動する場合は、かわりにwlstゴールを使用します。

stop-app


アプリケーションを停止します。

stop-server


WebLogic Serverを停止します。このゴールは、ローカル起動スクリプトを実行して、WLSを停止します。ノード・マネージャを使用してリモート・サーバーを停止する場合は、かわりにwlstゴールを使用します。

undeploy


WebLogic Serverからアプリケーションをアンデプロイします。デプロイメント・ユニットを停止して、ステージングされているファイルをターゲット・サーバーから削除します。

uninstall


WebLogic Serverをアンインストールします。

update-app


プラン・ファイルを再分散して、新しいプランの内容に基づいてアプリケーションを再構成することで、アプリケーションのデプロイメント・プランを更新します。

wlst


Maven用のWLSTラッパー。

wlst-client


ローカル・サーバーのインストールを必要とせずにWLSTオンライン・コマンドを実行するためのWLSTラッパー。

ws-clientgen


WSDLからクライアントWebサービス・アーティファクトを生成します。

wsgen


JAX-WSサービスのエンドポイント実装クラスで、JAX-WS Webサービスで使用されるすべてのポータブル・アーティファクトを生成します。

wsimport


WSDLファイルとバインディング・ファイルを解析し、そのアクセスに必要なJavaコードを生成するMavenゴール。

ws-jwsc


JAX-WS Webサービスを構築します。

ws-wsdlc


WSDLから一連のアーティファクトと、Webサービスの部分的なJava実装を生成します。


appc

完全名

com.oracle.weblogic:weblogic-maven-plugin:appc

説明

EJBおよびJSPをWebLogic Serverにデプロイするために必要なクラスを生成およびコンパイルします。また、個別のモジュール・レベルおよびアプリケーション・レベルの両方で現在の仕様に準拠しているかどうか、デプロイメント記述子を検証します。ローカル・サーバー・インストールを必要としません。

パラメータ

表3-4 appcのパラメータ

名前 タイプ 必須 説明

altappdd

java.lang.String

いいえ

代替Java EEアプリケーション・デプロイメント記述子のパスを指定します。

altwlsappdd

java.lang.String

いいえ

代替WebLogic Serverアプリケーション・デプロイメント記述子のパスを指定します。

basicClientJar

boolean

いいえ

trueの場合、EJB用に生成されたクライアントJARのデプロイメント記述子を含みません。
デフォルト値: false

classpath

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。かわりに標準のMaven依存関係モデルを使用して、ビルド時に有効なCLASSPATHを操作します。

clientJarOutputDir

java.lang.String

いいえ

生成されたクライアントJARが書き込まれるディレクトリを指定します。

commentary

boolean

いいえ

このパラメータはこのリリースでは非推奨となっています。

compiler

java.lang.String

いいえ

生成されたJavaソース・コードからクラス・ファイルをコンパイルするためのJavaコンパイラを指定します。コンパイラの絶対パスを明示的に指定する場合を除いて、Javaコンパイラ・プログラムはPATH内になければなりません。
デフォルト値: javac

compilerClass

java.lang.String

いいえ

このクラスはコンパイラを呼び出します。
デフォルト値: com.sun.tools.javac.Main

continueCompilation

boolean

いいえ

trueの場合、JSPファイルにエラーがある場合でもコンパイルを続行します。
デフォルト値: false

debug

boolean

いいえ

trueの場合、デバッグ情報をクラス・ファイルにコンパイルします。
デフォルト値: false

deprecation

boolean

いいえ

trueの場合、生成されたJavaソース・ファイルをクラス・ファイルにコンパイルしているときに、ソース・ファイル中に非推奨のメソッドが使用されていると警告します。
デフォルト値: false

destdir

java.io.File

いいえ

コンパイルされたクラス・ファイルが書き込まれるディレクトリを指定します。このパラメータは、コンパイルされたクラスを、すでにCLASSPATHに入っているディレクトリに置くために使用します。

enableHotCodeGen

boolean

いいえ

このパラメータはこのリリースでは非推奨となっています。

forceGeneration

boolean

いいえ

trueの場合、EJBおよびJSPクラスを強制的に生成します。それ以外の場合、必要ないと判断されると、クラスは再生成されません。
デフォルト値: false

idl

boolean

いいえ

trueの場合、EJBリモート・インタフェース用のIDLを生成します。
デフォルト値: false

idlDirectory

java.lang.String

いいえ

IDLファイルが書き込まれるディレクトリを指定します。
デフォルト: ターゲット・ディレクトリまたはJAR

idlFactories

boolean

いいえ

trueの場合、値タイプ用にファクトリ・メソッドを生成します。
デフォルト値: false

idlMethodSignatures

java.lang.String

いいえ

IDLコードを生成するトリガーとして使用されるメソッド・シグネチャを指定します。

idlNoAbstractInterfaces

boolean

いいえ

trueの場合、抽象インタフェース、およびそれらを含むメソッドまたは属性を生成しません。
デフォルト値: false

idlNoValueTypes

boolean

いいえ

値タイプ、またはそれらを含むメソッドと属性を生成しません。
デフォルト値: false

idlOrbix

boolean

いいえ

trueの場合、Orbix 2000 2.0 C++と多少の互換性を持つIDLを生成します。
デフォルト値: false

idlOverwrite

boolean

いいえ

trueの場合、既存のIDLファイルを上書きします。
デフォルト値: false

idlVerbose

boolean

いいえ

trueの場合、IDL生成に関する追加のステータス情報を表示します。
デフォルト値: false

idlVisibroker

boolean

いいえ

trueの場合、Visibroker 4.5 C++と多少の互換性を持つIDLを生成します。
デフォルト値: false

ignorePlanValidation

boolean

いいえ

trueの場合、プラン・ファイルが存在しなければそれを無視します。

iiop

boolean

いいえ

trueの場合、EJB用にCORBAのスタブを生成します。
デフォルト値: false

iiopDirectory

java.lang.String

いいえ

IIOPスタブ・ファイルが書き込まれるディレクトリを指定します。
デフォルト: ターゲット・ディレクトリまたはJAR

keepgenerated

boolean

いいえ

trueの場合、生成された.javaファイルを保持します。
デフォルト値: false

libraries

java.lang.String

いいえ

ライブラリのカンマ区切りのリスト。

librarydir

java.io.File

いいえ

指定したディレクトリ内のすべてのファイルをライブラリとして登録します。

lineNumbers

boolean

いいえ

trueの場合、生成されたクラス・ファイルにJSPの行番号を追加し、デバッグを支援します。
デフォルト値: false

manifest

java.io.File

いいえ

このパラメータはこのリリースでは非推奨となっています。標準のMavenメカニズムを使用して、パッケージ化時にマニフェストを指定します。

maxfiles

java.lang.Integer

いいえ

生成されたJavaファイルを一度にコンパイルする最大数を指定します。

middlewareHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

noexit

boolean

いいえ

trueの場合、JSPコンパイル・エラーが発生したときにappcゴールの実行を終了しません。
デフォルト値: true

normi

boolean

いいえ

このパラメータはこのリリースでは非推奨となっています。

nowarn

boolean

いいえ

trueの場合、コンパイラに関する警告を表示しません。
デフォルト値: false

nowrite

boolean

いいえ

このパラメータはこのリリースでは非推奨となっています。

optimize

boolean

いいえ

trueの場合、最適化を有効にしてコンパイルします。
デフォルト値: false

output

java.io.File

いいえ

代替的な出力アーカイブまたはディレクトリを指定します。設定されていないと、出力はソース・アーカイブまたはディレクトリに置かれます。

plan

java.io.File

いいえ

デプロイメント・プラン(オプション)のパスを指定します。

quiet

boolean

いいえ

trueの場合、エラー以外は出力をオフにします。

runtimeFlags

java.lang.String

いいえ

コンパイラにオプションのリストを渡します。

serverClasspath

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。かわりに標準のMaven依存関係モデルを使用して、有効なCLASSPATHを操作します。

source

java.io.File

いいえ

ソース・ファイルのパスを指定します。
デフォルト値: ${project.build.directory}/${project.artifactId}.${project.packaging}

sourceVersion

java.lang.String

いいえ

Javaファイルの互換性を、指定されたJDK以前のバージョンに制限します。例: "1.5"
デフォルト値は、使用するJavaコンパイラのJDKのバージョンです。

supressCompiler

boolean

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。かわりに標準のMaven依存関係モデルを使用して、ビルド時に有効なCLASSPATHにターゲット・クラスを追加します。

targetVersion

java.lang.String

いいえ

コンパイルされたクラス・ファイルの実行に最低限必要なレベルのJVMを指定します。例: "1.5"
デフォルト値は、使用するJavaコンパイラのJDKのバージョンです。

verbose

boolean

いいえ

trueの場合、コンパイル処理中のステータスに関する追加情報を表示します。
デフォルト値: false

verboseJavac

boolean

いいえ

trueの場合、Javaコンパイラからの詳細出力を有効にします。
デフォルト値: false

weblogicHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

writeInferredDescriptors

boolean

いいえ

trueの場合、アノテーションを含む推測情報とともに記述子を出力します。


使用例

appcゴールは、WebLogic Serverアプリケーション・コンパイラ・ユーティリティを実行し、デプロイメント用のアプリケーションを準備します。

<execution>
<id>wls-appc</id>
<phase>package</phase>
<goals>
<goal>appc</goal>
</goals>
<configuration>
<source>${project.build.directory}/${project.name}.${project.packaging}</source>
</configuration>
</execution> 

例3-3では、典型的なappcゴールの出力を示します。

例3-3 appc

$ mvn com.oracle.weblogic:weblogic-maven-plugin:appc
 -Dsource=target/basicWebapp.war -DforceGeneration=true
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building basicWebapp 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:appc (default-cli) @ main-test ---
[INFO] Running weblogic.appc on
/home/oracle/src/tests/main-test/target/basicWebapp.war
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 7.901s
[INFO] Finished at: Wed May 15 10:52:46 EST 2013
[INFO] Final Memory: 26M/692M
[INFO] 

create-domain

完全名

com.oracle.weblogic:weblogic-maven-plugin:create-domain

説明

ドメイン・テンプレートを使用してWebLogic Serverドメインを作成します。このゴールは、ドメイン・ディレクトリ(最後のディレクトリでドメイン名を決定)および管理ユーザー名とパスワードの指定をサポートしています。より複雑なドメインを作成する場合は、wlstゴールを使用します。

パラメータ

表3-5 create-domainのパラメータ

名前 タイプ 必須 説明

domainHome

java.lang.String

true

ドメインの作成に使用するディレクトリを指定します。このゴールは、ドメイン名として指定された最後のサブディレクトリの名前を取得して、新しいドメインの名前をその値に設定します。たとえば、domainHome=/weblogic/domains/MyNewDomainと指定すると、ドメイン名が'MyNewDomain'に設定されます。

domainTemplate

java.lang.String

いいえ

ドメインを作成するために使用するドメイン・テンプレート・ファイルを指定します。このパラメータを指定しない場合、WebLogic Serverに組み込まれているデフォルトのドメイン・テンプレートが使用されます。

failOnDomainExists

boolean

いいえ

trueの場合、作成するドメインがすでに存在すると、ビルドが失敗して例外がスローされます。falseの場合、作成するドメインがすでに存在しても、ビルドは成功し、既存のドメインは上書きされません。ドメインが存在しない場合、このパラメータによる影響はありません。
デフォルト値: false

middlewareHome

java.lang.String

true

Oracle Middlewareインストール・ディレクトリへのパス。

password

java.lang.String

true

管理パスワードを指定します。

serverClasspath

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

user

java.lang.String

true

管理ユーザー名を指定します。

weblogicHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

wlstVersion

java.lang.String

いいえ

${middlewareHome}/wlserver/common/binまたは${middlewareHome}/oracle_common/common/binからwlst.shスクリプトを実行するかどうかを指定します。許容値は、wlsおよびoracle_commonです。デフォルト値は、wlsです。

workingDir

java.lang.String

いいえ

create-domainゴールを実行する現在の作業ディレクトリ。デフォルト値: ${project.build.directory}/weblogic-maven-plugin


使用例

create-domainゴールを使用して、指定されたWebLogic ServerインストールからWebLogic Serverドメインを作成します。domainHome構成パラメータを使用して、ドメインの場所を指定します。

ドメインを作成する場合は、ユーザー名とパスワードが必要です。それらは、POMファイルでuserおよびpassword構成パラメータを使用して指定するか、コマンドラインで指定できます。

ドメイン名は、domainHomeで指定された最後のサブディレクトリから取得されます。

<execution>
<id>wls-create-domain</id>
<phase>pre-integration-test</phase>
<goals>
<goal>create-domain</goal>
</goals>
<configuration>
<middlewareHome>c:/dev/wls12130</middlewareHome>
<domainHome>${project.build.directory}/base_domain</domainHome>
<user>weblogic</user>
<password>password</password>
</configuration>
</execution>

例3-4では、create-domainゴールの実行からの一般的なコマンド出力を示します。

例3-4 create-domain

mvn com.oracle.weblogic:weblogic-maven-plugin:create-domain
-DdomainHome=c:\oracle\middleware\oracle_home\user_projects\domains\maven-domain
-DmiddlewareHome=c:\oracle\middleware\oracle_home -Duser=weblogic -Dpassword=password
[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building WebLogic Server Maven Plugin 12.1.3-0-0
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:create-domain (default-cli) @
 weblogic-maven-plugin ---
[INFO] [create-domain]Domain creation script: 
readTemplate(r'C:/oracle/middleware/oracle_home/wlserver/common/templates/wls/wls.jar')
set('Name', 'maven-domain')
cd('/Security/maven-domain/User/weblogic')
set('Name', 'weblogoc')
set('Password', '***')
writeDomain(r'c:/oracle/middleware/oracle_home/user_
projects/domains/maven-domain')
[INFO] [wlst]script temp file = C:/Users/user/AppData/Local/Temp/test6066166061714573929.py
[INFO] [wlst]Executing: [cmd:[C://windows\\system32\\cmd.exe, /c, 
C:\oracle\middleware\oracle_home\wlserver\common\bin\wlst.cmd 
C:\Users\user\AppData\Local\Temp\test6066166061714573929.py ]]
[INFO] Process being executed, waiting for completion.
[INFO] [exec] 
[INFO] [exec] Initializing WebLogic Scripting Tool (WLST) ...
[INFO] [exec] 
[INFO] [exec] Welcome to WebLogic Server Administration Scripting Shell
[INFO] [exec] 
[INFO] [exec] Type help() for help on available commands
[INFO] [exec] 
[INFO] [wlst][cmd:[C:\\windows\\system32\\cmd.exe, /c, C:\oracle\middleware\oracle_home\wlserver\common\bin\wlst.cmd 
C:\Users\user\AppData\Local\Temp\test6066166061714573929.py ]] exit code=0
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 18.276s
[INFO] Finished at: Wed May 01 13:13:25 EDT 2013
[INFO] Final Memory: 9M/23M
[INFO] ------------------------------------------------------------------------

deploy

完全名

com.oracle.weblogic:weblogic-maven-plugin:deploy

説明

実行中のサーバーにWebLogic Serverアプリケーションおよびモジュールをデプロイします。WAR、JAR、RARなどのすべてのデプロイメント・フォーマットをサポートします。ローカル・サーバー・インストールを必要としません。

パラメータ

表3-6 deployのパラメータ

名前 タイプ 必須 説明

adminurl

java.lang.String

いいえ

管理サーバーのリスニング・アドレスとリスニング・ポートを指定します。
デフォルト値: t3://localhost:7001

advanced

boolean

いいえ

trueの場合、高度な使用オプションを出力します。

debug

boolean

いいえ

trueの場合、デバッグレベル・メッセージを標準出力に表示します。
デフォルト値: false

enableSecurityValidation

boolean

いいえ

trueの場合、セキュリティ・データの検証を有効にします。
デフォルト値: false

examples

boolean

いいえ

trueの場合、このプラグインの使用方法の例を表示します。

external_stage

boolean

いいえ

trueの場合、ユーザーが、サーバーのステージング領域のアプリケーションを外部から、またはサード・パーティ・ツールを使用してコピーすることを示します。指定した場合、WebLogic Serverは、StagingDirectoryName(of target server)/ applicationNameの下でアプリケーションを探します。
デフォルト値: false

failOnError

boolean

いいえ

trueの場合、エラーが発生すると、そのエラーが記録される前に、Mojoによって強制的にビルドが失敗します。
デフォルト値: true

id

java.lang.String

いいえ

ユーザーが指定する一意のデプロイメント・タスク識別子(オプション)を指定します。

libimplver

java.lang.String

いいえ

Java EEライブラリまたはオプション・パッケージの実装のバージョン。このオプションは、ライブラリまたはパッケージのマニフェスト・ファイルに実装のバージョンが含まれていない場合にのみ使用できます。

library

boolean

いいえ

共有Java EEライブラリまたはオプション・パッケージとしてデプロイします。

libspecver

java.lang.String

いいえ

Java EEライブラリまたはオプション・パッケージの仕様のバージョン。このオプションは、ライブラリまたはパッケージのマニフェスト・ファイルに仕様バージョンが含まれていない場合にのみ使用できます。

middlewareHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

name

java.lang.String

いいえ

新規にデプロイされたアプリケーションまたはスタンドアロン・モジュールに割り当てるデプロイメント名を指定します。

nostage

boolean

いいえ

trueの場合、デプロイメント・ファイルをターゲット・サーバーにコピーせず、sourceパラメータで指定された特定の場所に保持します。
デフォルトでは、管理サーバーの場合はnostageがtrue、管理対象サーバー・ターゲットの場合はstageがtrueになります。

noversion

boolean

いいえ

trueの場合、管理サーバー上のバージョン関連のすべてのコード・パスを無視します。
デフォルト値: false

nowait

boolean

いいえ

trueの場合、複数のタスクを開始し、その後は-listアクションを使用してモニターします。
デフォルト値: false

password

java.lang.String

いいえ

管理パスワードを指定します。

plan

java.lang.String

いいえ

デプロイメント・プランのパスを指定します。

remote

boolean

いいえ

trueの場合、管理サーバーと同じマシンでプラグインが実行されていないことを指定します。この場合、sourceパラメータは、uploadパラメータが同時に使用されていない限り、サーバー上のパスを指定します。
デフォルト値: false

retiretimeout

java.lang.Integer

いいえ

WebLogic Serverがこのアプリケーションまたはモジュールの現在実行中のバージョンをアンデプロイし、クライアントが新しいバージョンで開始できるようになるまでの秒数を指定します。指定しない場合、正常なリタイア・ポリシーと見なされます。
デフォルト値: -1

securityModel

java.lang.String

いいえ

このデプロイメントで使用するセキュリティ・モデルを指定し、それをセキュリティ・レルムのデフォルトのセキュリティ・モデルよりも優先的に使用します。可能な値: DDOnlyCustomRolesCustomRolesAndPoliciesおよびAdvanced

serverClasspath

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

source

java.lang.String

いいえ

デプロイするアーカイブ・ファイルまたは展開されたアーカイブ・ディレクトリ。このオプションを省略して、デプロイするファイルまたはディレクトリのみを指定できます。

stage

boolean

いいえ

trueの場合、デプロイメントの前に、アプリケーションをターゲット・サーバー・ステージング領域にコピーする必要があることを示します。
デフォルトでは、管理サーバーの場合はnostageがtrue、管理対象サーバー・ターゲットの場合はstageがtrueになります。

submoduletargets

java.lang.String

いいえ

JMSアプリケーション・モジュール内で定義されているリソースのJMSサーバー・ターゲットを指定します。
可能な値の形式: submod@mod-jms.xml@targetまたはsubmoduleName@target

targets

java.lang.String

いいえ

現在の処理のターゲットのカンマ区切りリストを指定します。デフォルトはAdminServerです。

timeout

java.lang.Integer

いいえ

デプロイメント・タスクの完了までのWebLogic Serverの最長待機秒数を指定します。デフォルト値の-1は、永久に待機することを意味します。
デフォルト値: -1

upload

boolean

いいえ

trueの場合、デプロイメント前に、ソース・ファイルを管理サーバーのアップロード・ディレクトリにコピーします。この設定は、プラグインをリモートで(remoteパラメータを使用して)実行する場合、およびユーザーに管理サーバーのファイル・システムに対する通常アクセス権が付与されていない場合に使用します。
デフォルト値: false

usenonexclusivelock

boolean

いいえ

trueのときは、同じユーザーがドメインですでに取得している既存のロックを、デプロイメント処理で使用することを指定します。複数のデプロイメント・ツールを同時に使用していて、いずれかのツールでドメイン構成のロックをすでに取得している場合に便利。

デフォルト値: false

user

java.lang.String

いいえ

管理ユーザー名を指定します。

userConfigFile

java.lang.String

いいえ

プレーン・テキストでユーザー名とパスワードを直接指定するかわりに、管理ユーザー名とパスワードを取得するために使用するユーザー構成ファイルの場所を指定します。

userKeyFile

java.lang.String

いいえ

ユーザー構成ファイルに格納されたユーザー名とパスワードを暗号化および復号化するために使用するユーザー・キー・ファイルの場所を指定します。

verbose

boolean

いいえ

trueの場合、追加のステータス情報を表示します。
デフォルト値: false

version

boolean

いいえ

trueの場合、バージョン情報を出力します。
デフォルト値: false

weblogicHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。


使用例

このゴールを使用してアプリケーションをデプロイします。

<execution>
<id>wls-deploy</id>
<phase>pre-integration-test</phase>
<goals>
<goal>deploy</goal>
</goals>
<configuration>
<adminurl>t3://127.0.0.1:7001</adminurl>
<user>weblogic</user>
<password>password</password>
<source>${project.build.directory}/${project.build.finalName}
.${project.packaging}</source>
<targets>AdminServer</targets>
<verbose>true</verbose>
<name>${project.build.finalName}</name>
</configuration>
</execution>

例3-5では、典型的なdeployゴールの出力を示します。

例3-5 deploy

mvn com.oracle.weblogic:weblogic-maven-plugin:deploy
-Dsource=C:\webservices\MySimpleEjb.jar
-Dpassword=password -Duser=weblogic
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building WebLogic Server Maven Plugin 12.1.3-0-0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:deploy (default-cli) @ weblogic-mave
n-plugin ---
weblogic.Deployer invoked with options:  -noexit -adminurl t3://localhost:7001 -
deploy -user weblogic -source C:\webservices\MySimpleEjb.jar -targets AdminServe
r
<May 1, 2013 1:41:09 PM EDT> <Info> <J2EE Deployment SPI> <BEA-260121> <Initiati
ng deploy operation for application, MySimpleEjb [archive: C:\webservices\MySimp
leEjb.jar], to AdminServer .>
Task 0 initiated: [Deployer:149026]deploy application MySimpleEjb on AdminServer
.
Task 0 completed: [Deployer:149026]deploy application MySimpleEjb on AdminServer
.
Target state: deploy completed on Server AdminServer
 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 9.042s
[INFO] Finished at: Wed May 01 13:41:11 EDT 2013
[INFO] Final Memory: 10M/25M

distribute-app

完全名

com.oracle.weblogic:weblogic-maven-plugin:distribute-app

説明

デプロイメント・ファイルをターゲット・サーバーにコピーして検証することで、デプロイメント用に準備します。ローカル・サーバー・インストールを必要としません。

パラメータ

表3-7 distribute-appのパラメータ

名前 タイプ 必須 説明

adminurl

java.lang.String

いいえ

管理サーバーのリスニング・アドレスとリスニング・ポートを指定します。
デフォルト値: t3://localhost:7001

advanced

boolean

いいえ

trueの場合、高度な使用オプションを出力します。

debug

boolean

いいえ

trueの場合、デバッグレベル・メッセージを標準出力に表示します。
デフォルト値: false

enableSecurityValidation

boolean

いいえ

trueの場合、セキュリティ・データの検証を有効にします。
デフォルト値: false

examples

boolean

いいえ

trueの場合、このプラグインの使用方法の例を表示します。

external_stage

boolean

いいえ

trueの場合、ユーザーが、サーバーのステージング領域のアプリケーションを外部から、またはサード・パーティ・ツールを使用してコピーすることを示します。指定した場合、WebLogic Serverは、StagingDirectoryName(of target server)/ applicationNameの下でアプリケーションを探します。
デフォルト値: false

failOnError

boolean

いいえ

trueの場合、エラーが発生すると、そのエラーが記録される前に、Mojoによって強制的にビルドが失敗します。
デフォルト値: true

id

java.lang.String

いいえ

ユーザーが指定する一意のデプロイメント・タスク識別子(オプション)を指定します。

middlewareHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

name

java.lang.String

いいえ

新規にデプロイされたアプリケーションまたはスタンドアロン・モジュールに割り当てるデプロイメント名を指定します。

nostage

boolean

いいえ

trueの場合、デプロイメント・ファイルをターゲット・サーバーにコピーせず、sourceパラメータで指定された特定の場所に保持します。
デフォルトでは、管理サーバーの場合はnostageがtrue、管理対象サーバー・ターゲットの場合はstageがtrueになります。

noversion

boolean

いいえ

trueの場合、管理サーバー上のバージョン関連のすべてのコード・パスを無視します。
デフォルト値: false

nowait

boolean

いいえ

trueの場合、複数のタスクを開始し、その後は-listアクションを使用してモニターします。
デフォルト値: false

password

java.lang.String

いいえ

管理パスワードを指定します。

plan

java.lang.String

いいえ

デプロイメント・プランのパスを指定します。

purgetasks

boolean

いいえ

trueの場合、リタイアしたデプロイメント・タスクを削除します。
デフォルト値: false

remote

boolean

いいえ

trueの場合、管理サーバーと同じマシンでプラグインが実行されていないことを指定します。この場合、sourceパラメータは、uploadパラメータが同時に使用されていない限り、サーバー上のパスを指定します。
デフォルト値: false

retiretimeout

java.lang.Integer

いいえ

WebLogic Serverがこのアプリケーションまたはモジュールの現在実行中のバージョンをアンデプロイし、クライアントが新しいバージョンで開始できるようになるまでの秒数を指定します。指定しない場合、正常なリタイア・ポリシーと見なされます。
デフォルト値: -1

securityModel

java.lang.String

いいえ

このデプロイメントで使用するセキュリティ・モデルを指定し、それをセキュリティ・レルムのデフォルトのセキュリティ・モデルよりも優先的に使用します。可能な値: DDOnlyCustomRolesCustomRolesAndPoliciesおよびAdvanced

serverClasspath

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

source

java.lang.String

いいえ

デプロイするアーカイブ・ファイルまたは展開されたアーカイブ・ディレクトリを指定します。これは、ローカル・システム上のファイル、ディレクトリまたは展開されたアーカイブ、またはコロン(:)で区切られたgroupId:artifactID:packaging:classifier:versionの形式のMavenコーディネートのリストのいずれかです。
Mavenコーディネートを使用しない場合、sourceのパスでは、remoteパラメータが使用されていない限り、ローカル・ファイル・システムが参照されます。
デフォルト値: ${project.build.directory}/${project.artifactId}.${project.packaging}

stage

boolean

いいえ

trueの場合、デプロイメントの前に、アプリケーションをターゲット・サーバー・ステージング領域にコピーする必要があることを示します。
デフォルトでは、管理サーバーの場合はnostageがtrue、管理対象サーバー・ターゲットの場合はstageがtrueになります。

submoduletargets

java.lang.String

いいえ

JMSアプリケーション・モジュール内で定義されているリソースのJMSサーバー・ターゲットを指定します。
可能な値の形式: submod@mod-jms.xml@targetまたはsubmoduleName@target

targets

java.lang.String

いいえ

現在の処理のターゲットのカンマ区切りリストを指定します。指定しない場合、構成されているすべてのターゲットが使用されます。新しいアプリケーションの場合、デフォルトのターゲットは管理サーバーです。

timeout

java.lang.Integer

いいえ

デプロイメント・タスクの完了までのWebLogic Serverの最長待機秒数を指定します。デフォルト値の-1は、永久に待機することを意味します。
デフォルト値: -1

upload

boolean

いいえ

trueの場合、デプロイメント前に、ソース・ファイルを管理サーバーのアップロード・ディレクトリにコピーします。この設定は、プラグインをリモートで(remoteパラメータを使用して)実行する場合、およびユーザーに管理サーバーのファイル・システムに対する通常アクセス権が付与されていない場合に使用します。
デフォルト値: false

user

java.lang.String

いいえ

管理ユーザー名を指定します。

userConfigFile

java.lang.String

いいえ

プレーン・テキストでユーザー名とパスワードを直接指定するかわりに、管理ユーザー名とパスワードを取得するために使用するユーザー構成ファイルの場所を指定します。

userKeyFile

java.lang.String

いいえ

ユーザー構成ファイルに格納されたユーザー名とパスワードを暗号化および復号化するために使用するユーザー・キー・ファイルの場所を指定します。

verbose

boolean

いいえ

trueの場合、追加のステータス情報を表示します。
デフォルト値: false

version

boolean

いいえ

trueの場合、バージョン情報を出力します。
デフォルト値: false

weblogicHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。


このゴールを使用して、デプロイメント・ファイルをデプロイする準備をします。

<execution>
<id>wls-distribute-app</id>
<phase>pre-integration-test</phase>
<goals>
<goal>distribute-app</goal>
</goals>
<configuration>
<adminurl>t3://127.0.0.1:7001</adminurl>
<user>weblogic</user>
<password>password</password>
<source>${project.build.directory}/${project.build.finalName}
.${project.packaging}</source>
<targets>cluster1</targets>
<verbose>true</verbose>
<name>${project.build.finalName}</name>
</configuration>
</execution>

例3-6では、典型的なdistribute-appゴールの出力を示します。

例3-6 distribute-app

$ mvn com.oracle.weblogic:weblogic-maven-plugin:distribute-app
 -Dadminurl=t3://localhost:7001 -Dstage=true -DmiddlewareHome=/maven/wls12130
 -Dname=cluster-test -Duser=weblogic -Dpassword=welcome1 -Dtargets=cluster1
 -Dsource=target/cluster-test-1.0-SNAPSHOT.war
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building cluster-test 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:distribute-app (default-cli) @
 cluster-test ---
weblogic.Deployer invoked with options: -noexit -adminurl t3://localhost:7001
 -distribute -user weblogic -name cluster-test -source 
/home/oracle/src/tests/uber-test/cluster-test/
target/cluster-test-1.0-SNAPSHOT.war -targets cluster1 -stage
<May 15, 2013 2:09:58 PM EST> <Info> <J2EE Deployment SPI> <BEA-260121>
 <Initiating distribute operation for application, cluster-test [archive: 
/home/oracle/src/tests/uber-test/cluster-test/
target/cluster-test-1.0-SNAPSHOT.war], to cluster1 .>
Task 0 initiated: [Deployer:149026]distribute application cluster-test on
 cluster1.
Task 0 completed: [Deployer:149026]distribute application cluster-test on
 cluster1.
Target state: distribute completed on Cluster cluster1
 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 6.953s
[INFO] Finished at: Wed May 15 14:10:00 EST 2013
[INFO] Final Memory: 15M/429M
[INFO] ------------------------------------------------------------------------

help

完全名

com.oracle.weblogic:weblogic-maven-plugin:help

説明

非推奨。かわりに、標準のMaven helpプラグインを使用します。

weblogic-maven-pluginによってサポートされているすべてのゴールをリストします。

パラメータ

表3-8 helpのパラメータ

名前 タイプ 必須 説明

detail

boolean

いいえ

trueの場合、ゴールの詳細情報を出力します。
デフォルト値: false


install

完全名

com.oracle.weblogic:weblogic-maven-plugin:install

説明

JARまたはZIPファイルからWebLogic Serverをインストールします。

パラメータ

表3-9 installのパラメータ

名前 タイプ 必須 説明

artifactLocation

java.lang.String

true

インストールのアドレスを指定します。このアドレスは、groupId:artifactId:packaging:classifier:versionの形式のMavenコーディネートのコロン(:)区切りリスト、ローカル・システム上のファイル(/home/myhome/myapps/helloworld.war)、またはリモートHTTP URL (http://foo/a/b.zip)のいずれかでです。

domainHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

installCommand

java.lang.String

いいえ

バイナリ(ZIP)またはJARインストーラを使用して製品をインストールします。次のマクロがサポートされています。

  • @INSTALLER_FILE@ - インストーラ・ファイルへのパス。

  • @JAVA_HOME@ - Javaホームへのパス。

  • @JAVA_TMPDIR@ - Java一時ディレクトリへのパス。

  • @RESPONSE_FILE@ - OUIサイレント・インストーラのレスポンス・ファイルへのパス。

  • @INV_PTR_LOC_FILE@ - OUI invPtrLocファイルへのパス。

例:

 <executions>
 
      <!-- install weblogic -->
      <execution>
        <id>install-wls</id>
        <phase>pre-integration-test</phase>
        <goals>
          <goal>install</goal>
        </goals>
        <configuration>
          <installDir>c:/dev/wlshome</installDir>
          <artifactLocation>c:/dev/wls_121300.jar</artifactLocation>
          <installCommand>@JAVA_HOME@/bin/java
 -Xms512m -Xmx1024m -jar @INSTALLER_FILE@ -silent
 -response ${basedir}/misc/wls_response.txt</installCommand>
        </configuration>
      </execution>

このパラメータは省略可能です。ZIPインストーラでは、このパラメータは無視されます。

installDir

java.lang.String

true

サーバーをインストールする場所。ZIPインストーラの場合、middlewareHomeに相当するのは${installDir}/wls12130です。

invPtrLoc

java.lang.String

いいえ

サイレント・インストーラのインベントリの場所のファイル。これは、バイナリ(ZIP)またはJARインストーラを使用する場合に、UNIXベースのプラットフォームで必要です。

response

java.lang.String

いいえ

サイレント・インストーラのレスポンス・ファイル。これは、バイナリ(ZIP)またはJARインストーラを使用する場合に必要です。

supplementalZipLocation

java.lang.String

いいえ

ZIPインストーラの補助ファイル。


使用例

このゴールを使用して、WebLogic Serverをローカル・ディレクトリにインストールし、それを使用して、他のゴールを実行したり、Mavenプロジェクトとして表されるアプリケーションのデプロイおよびテストのためのWebLogic Serverドメインを作成できます。


注意:

installゴールは、myserverと呼ばれる単一の管理対象サーバーを作成し、ドメインを作成しません。create-domainを含む他のほとんどのゴールは、AdminServerというデフォルトのサーバー名を使用します。したがって、POMでこのAdminServerというデフォルトのサーバー名をオーバーライドする必要があります。

このゴールは、指定されたインストールの配布を使用してWebLogic Serverをインストールします。artifactLocation構成パラメータを使用して配布場所を指定します。このパラメータは、ファイル・システム上のファイル、アクセス可能なHTTP URL、またはMavenリポジトリにインストールされた配布のMavenコーディネートとして配布場所を指定できます。pom.xmlファイルのweblogic-maven-pluginセクションで、またはMavenの起動時に-DartifactLocationプロパティを使用して、artifactLocation構成要素を指定します。

たとえば、WebLogic Server ZIPファイルの配布をインストールする場合、ZIP配布の場所を次のいずれかで指定できます。

  • ローカル・ファイルの参照: ローカル・ファイルの参照の場合、ローカル・ファイル・システム上のパスを指定します。

  • URLの参照。

  • Mavenアーティファクト: この場合、配布はローカルMavenリポジトリ自体から取得されます。つまり、それを事前にローカル・リポジトリにインストールしておくか、リモート・リポジトリから取得しておく必要があります。

    artifactLocationは、URL、ファイル・パス、またはgroupId:artifactId:packaging:versionあるいはgroupId:artifactId:packaging:classifier:versionという形式のMavenコーディネートになります。次に例を示します。com.oracle.weblogic:weblogic-server-installer:zip:12.1.3-0-0

<execution>
<id>wls-install-server</id>
<phase>pre-integration-test</phase>
<goals>
<goal>install</goal>
</goals>
<configuration>
<installDir>c:/dev</installDir>
<artifactLocation>c:/temp/wls1213_dev.zip</artifactLocation>
</configuration>
</execution>

例3-7では、WindowsベースのシステムにZIPファイルからインストールする場合の、典型的なinstallゴールの出力を示します。

例3-7 ZIPファイルからのインストール

mvn com.oracle.weblogic:weblogic-maven-plugin:install
 -DartifactLocation=wls1213.zip -DinstallDir=c:\oracle\middleware
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:install (default-cli) @ standalone-p
om ---
[INFO] Installing wls1213.zip into the location: c:\oracle\middleware
[INFO] Installing the product, this may take some time.
[INFO] [install]installHome = c:\oracle\middleware
[INFO] [install]middlewareHome = c:\oracle\middleware\wls12130
[INFO] Executing: [cmd:[C:\\windows\\system32\\cmd.exe, /c, configure.cmd -silen
t]]
[INFO] Process being executed, waiting for completion.
[INFO] [configure script] exit code: 0
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2:43.223s
[INFO] Finished at: Thu May 09 15:57:22 EDT 2013
[INFO] Final Memory: 6M/17M
[INFO] ------------------------------------------------------------------------

例3-8では、JARファイルを使用してWindowsベースのシステムにWebLogic Serverをインストールする例を示します。

例3-8 JARファイルからのインストール

mvn com.oracle.weblogic:weblogic-maven-plugin:install -Dart
ifactLocation=c:\wls-temp-for-zip\wls_generic.jar -DinstallDir=c:\wls-temp-home
-Dresponse=response-file
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:install (default-cli) @ standalone-p
om ---
[INFO] [install]ORACLE_HOME = C:\wls-temp-home\oracle\middleware\oracle_home
[INFO] Executing:  [cmd:[C:\\Windows\\System32\\cmd.exe, /c, C:\weblogic\dev\src
1213\build\jdk7_15\JDK17~1.0_1\jre\bin\java.exe -Xms1024m -Xmx1024m -XX:PermSize
=128m -XX:MaxPermSize=256m -Djava.io.tmpdir=C:\Users\user\AppData\Local\Temp
\ -jar c:\wls-temp-for-zip\wls_generic.jar -silent -response C:\oracle\middlewar
e\response-file ]][INFO] Process being executed, waiting for completion.
[INFO] [exec] Launcher log file is C:\Users\user\AppData\Local\Temp\OraInsta
ll2013-11-14_10-10-42AM\launcher2013-11-14_10-10-42AM.log.
[INFO] [exec] Extracting files..................................................
................................................................................
.............................[INFO] [exec] Starting Oracle Universal Installer
[INFO] [exec]
[INFO] [exec] Checking if CPU speed is above 300 MHz.   Actual 2491    Passed
[INFO] [exec] Checking swap space: must be greater than 512 MB    Passed
[INFO] [exec] Checking if this platform requires a 64-bit JVM.   Actual 32    Pa
ssed (64-bit not required)
[INFO] [exec]
[INFO] [exec]
[INFO] [exec] Preparing to launch the Oracle Universal Installer from
 C:\Users\user\AppData\Local\Temp\OraInstall2013-11-14_10-10-42AM
[INFO] [exec] Log: C:\Program Files (x86)\Oracle\Inventory\logs\install2013-11-1
4_10-10-42AM.log
[INFO] [exec] Copyright (c) 1996, 2014, Oracle and/or its affiliates. All rights
 reserved.
[INFO] [exec] Reading response file..
[INFO] [exec] Starting check : CertifiedVersions
[INFO] [exec] Expected result: One of 5.1,5.2,6.0,6.1
[INFO] [exec] Actual Result: 6.1
[INFO] [exec] Check complete. The overall result of this check is: Passed
[INFO] [exec] CertifiedVersions Check: Success.
[INFO] [exec] Starting check : CheckJDKVersion
[INFO] [exec] Expected result: 1.7.0_15
[INFO] [exec] Actual Result: 1.7.0_15
[INFO] [exec] Check complete. The overall result of this check is: Passed
[INFO] [exec] CheckJDKVersion Check: Success.
[INFO] [exec] Verifying data......
[INFO] [exec] Copying Files...
[INFO] [exec] -----------20%----------40%----------60%----------80%--------100%
[INFO] [exec]
[INFO] [exec] The installation of Oracle Fusion Middleware 12c WebLogic Server a
nd Coherence 12.1.3.0.0 completed successfully.
[INFO] [exec] Logs successfully copied to C:\Program Files (x86)\Oracle\Inventor
y\logs.
[INFO] Installer exited with code: 0
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 10:23.738s
[INFO] Finished at: Thu Nov 14 10:20:56 EST 2013
[INFO] Final Memory: 7M/22M
[INFO] ------------------------------------------------------------------------

例3-9では、JARファイルとinstallCommandパラメータを使用してWindowsベースのシステムにWebLogic Serverをインストールする例を示します。

例3-9 installCommandを使用したJARファイルからのインストール

mvn com.oracle.weblogic:weblogic-maven-plugin:install 
-DartifactLocation=c:\jrf-temp\wls_generic.jar
-DinstallCommand="@JAVA_HOME@/bin/java -Xms512m
-Xmx1024m -jar @INSTALLER_FILE@ -silent -response c:\jrf-temp\response-file.txt
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:install (default-cli) @ standalone-p
om ---
:
[INFO] [exec] The installation of Oracle Fusion Middleware 12c WebLogic Server a
nd Coherence 12.1.3.0.0 completed successfully.
[INFO] [exec] Logs successfully copied to C:\weblogic\src1213_17015b33_x86_64\be
a\inventory\logs.
[INFO] Installer exited with code: 0
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 13:44.126s
[INFO] Finished at: Tue May 20 14:02:48 EDT 2014
[INFO] Final Memory: 15M/218M
[INFO] ------------------------------------------------------------------------

list-apps

完全名

com.oracle.weblogic:weblogic-maven-plugin:list-apps

説明

ドメインにデプロイ、配布、またはインストールされているアプリケーションおよびスタンドアロン・モジュールのデプロイメント名をリストします。ローカル・サーバー・インストールを必要としません。

パラメータ

表3-10 list-appsのパラメータ

名前 タイプ 必須 説明

adminurl

java.lang.String

いいえ

管理サーバーのリスニング・アドレスとリスニング・ポートを指定します。
デフォルト値: t3://localhost:7001

advanced

boolean

いいえ

trueの場合、高度な使用オプションを出力します。

debug

boolean

いいえ

trueの場合、デバッグレベル・メッセージを標準出力に表示します。
デフォルト値: false

examples

boolean

いいえ

trueの場合、このプラグインの使用方法の例を表示します。

failOnError

boolean

いいえ

trueの場合、エラーが発生すると、そのエラーが記録される前に、Mojoによって強制的にビルドが失敗します。
デフォルト値: true

middlewareHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

noversion

boolean

いいえ

trueの場合、管理サーバー上のバージョン関連のすべてのコード・パスを無視します。
デフォルト値: false

nowait

boolean

いいえ

trueの場合、複数のタスクを開始し、その後は-listアクションを使用してモニターします。

password

java.lang.String

いいえ

管理パスワードを指定します。

purgetasks

boolean

いいえ

trueの場合、リタイアしたデプロイメント・タスクを削除します。

remote

boolean

いいえ

trueの場合、管理サーバーと同じマシンでプラグインが実行されていないことを指定します。この場合、sourceパラメータは、uploadパラメータが同時に使用されていない限り、サーバー上のパスを指定します。

serverClasspath

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

timeout

java.lang.Integer

いいえ

デプロイメント・タスクの完了までのWebLogic Serverの最長待機秒数を指定します。デフォルト値の-1は、永久に待機することを意味します。
デフォルト値: -1

user

java.lang.String

いいえ

管理ユーザー名を指定します。

userConfigFile

java.lang.String

いいえ

プレーン・テキストでユーザー名とパスワードを直接指定するかわりに、管理ユーザー名とパスワードを取得するために使用するユーザー構成ファイルの場所を指定します。

userKeyFile

java.lang.String

いいえ

ユーザー構成ファイルに格納されたユーザー名とパスワードを暗号化および復号化するために使用するユーザー・キー・ファイルの場所を指定します。

verbose

boolean

いいえ

trueの場合、追加のステータス情報を表示します。
デフォルト値: false

version

boolean

いいえ

trueの場合、バージョン情報を出力します。
デフォルト値: false

weblogicHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。


list-appsゴールを使用して、デプロイメント名をリストします。

<execution>
<id>wls-list-apps</id>
<phase>pre-integration-test</phase>
<goals>
<goal>list-apps</goal>
</goals>
<configuration>
<adminurl>t3://127.0.0.1:7001</adminurl>
<user>weblogic</user>
<password>password</password>
</configuration>
</execution>

例3-10では、典型的なlist-appsゴールの出力を示します。

例3-10 list-apps

mvn com.oracle.weblogic:weblogic-maven-plugin:list-apps  
-Duser=weblogic -Dpassword=password
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building WebLogic Server Maven Plugin 12.1.3.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:list-apps (default-cli) @ weblogic-m
aven-plugin ---
weblogic.Deployer invoked with options:  -noexit -adminurl t3://localhost:7001 -
listapps -user weblogic
 SamplesSearchWebApp
 stockBackEnd
 ajaxJSF
 asyncServlet30
 singletonBean
 webFragment
 examplesWebApp
 mainWebApp
 annotation
 MySimpleEjb
 stockFrontEnd
 jsfBeanValidation
 programmaticSecurity
 entityBeanValidation
 faceletsJSF
 bookmarkingJSF
 stockAdapter
 noInterfaceViewInWAR
 jdbcDataSource.war
 asyncMethodOfEJB
 calendarStyledTimer
 cdi
 jaxrs
 criteriaQuery
 portableGlobalJNDIName
 multipartFileHandling
 elementCollection
Number of Applications Found : 27
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 8.656s
[INFO] Finished at: Fri May 03 11:33:51 EDT 2013
[INFO] Final Memory: 11M/28M
[INFO] ------------------------------------------------------------------------
C:\Oracle\Middleware\Oracle_Home\wlserver\server\lib>

purge-tasks

完全名

com.oracle.weblogic:weblogic-maven-plugin:purge-tasks

説明

リタイアしたデプロイメント・タスクをフラッシュします。

パラメータ

表3-11 purge-tasksのパラメータ

名前 タイプ 必須 説明

adminurl

java.lang.String

いいえ

管理サーバーのリスニング・アドレスとリスニング・ポートを指定します。
デフォルト値: t3://localhost:7001

debug

boolean

いいえ

trueの場合、デバッグ情報をクラス・ファイルにコンパイルします。
デフォルト値: false

failOnError

boolean

いいえ

trueの場合、エラーが発生すると、そのエラーが記録される前に、Mojoによって強制的にビルドが失敗します。
デフォルト値: true

password

java.lang.String

いいえ

管理パスワードを指定します。

user

java.lang.String

いいえ

管理ユーザー名を指定します。

userConfigFile

java.lang.String

いいえ

プレーン・テキストでユーザー名とパスワードを直接指定するかわりに、管理ユーザー名とパスワードを取得するために使用するユーザー構成ファイルの場所を指定します。

userKeyFile

java.lang.String

いいえ

ユーザー構成ファイルに格納されたユーザー名とパスワードを暗号化および復号化するために使用するユーザー・キー・ファイルの場所を指定します。

verbose

boolean

いいえ

trueの場合、デプロイメント処理中のステータスに関する追加情報を表示します。
デフォルト値: false


purge-tasksゴールを使用して、リタイアしたデプロイメント・タスクをフラッシュします。

<execution>
<id>wls-purge</id>
<phase>pre-integration-test</phase>
<goals>
<goal>purge-tasks</goal>
</goals>
<configuration>
<adminurl>t3://127.0.0.1:7001</adminurl>
<user>weblogic</user>
<password>password</password>
</configuration>
</execution>

例3-12では、典型的なpurge-tasksゴールの出力を示します。

例3-11 purge-tasks

mvn  com.oracle.weblogic:weblogic-maven-plugin:purge-task
s -Duser=weblogic -Dpassword=password
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:purge-tasks (default-cli) @ standalo
ne-pom ---
weblogic.Deployer invoked with options:  -noexit -purgetasks -user weblogic -adm
inurl t3://localhost:7001
Currently there are no retired tasks.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 13.139s
[INFO] Finished at: Thu Dec 05 13:49:47 EST 2013
[INFO] Final Memory: 8M/24M
[INFO] ------------------------------------------------------------------------

redeploy

完全名

com.oracle.weblogic:weblogic-maven-plugin:redeploy

説明

実行中のアプリケーションまたは実行中のアプリケーションの一部を再デプロイします。ローカル・サーバー・インストールを必要としません。

パラメータ

表3-12 redeployのパラメータ

名前 タイプ 必須 説明

adminurl

java.lang.String

いいえ

管理サーバーのリスニング・アドレスとリスニング・ポートを指定します。
デフォルト値: t3://localhost:7001

appversion

java.lang.String

いいえ

起動するアプリケーションのバージョン。

deleteFiles

java.lang.String

いいえ

このパラメータで指定されているファイルを削除し、アプリケーションをアクティブのままにします。このパラメータは、アーカイブ解除されたデプロイメントにのみ有効です。

examples

boolean

いいえ

trueの場合、このプラグインの使用方法の例を表示します。

failOnError

boolean

いいえ

trueの場合、エラーが発生すると、そのエラーが記録される前に、Mojoによって強制的にビルドが失敗します。
デフォルト値: true

id

java.lang.String

いいえ

ユーザーが指定する一意のデプロイメント・タスク識別子(オプション)を指定します。

libimplver

java.lang.String

いいえ

Java EEライブラリまたはオプション・パッケージの実装のバージョン。このオプションは、ライブラリまたはパッケージのマニフェスト・ファイルに実装のバージョンが含まれていない場合にのみ使用できます。

library

boolean

いいえ

共有Java EEライブラリまたはオプション・パッケージとしてデプロイします。

libspecver

java.lang.String

いいえ

Java EEライブラリまたはオプション・パッケージの仕様のバージョン。このオプションは、ライブラリまたはパッケージのマニフェスト・ファイルに仕様バージョンが含まれていない場合にのみ使用できます。

middlewareHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

name

java.lang.String

いいえ

新規にデプロイされたアプリケーションまたはスタンドアロン・モジュールに割り当てるデプロイメント名を指定します。

password

java.lang.String

いいえ

管理パスワードを指定します。

plan

java.lang.String

いいえ

デプロイメント・プランのパスを指定します。

remote

boolean

いいえ

trueの場合、管理サーバーと同じマシンでプラグインが実行されていないことを指定します。この場合、sourceパラメータは、uploadパラメータが同時に使用されていない限り、サーバー上のパスを指定します。

retiretimeout

java.lang.Integer

いいえ

WebLogic Serverがこのアプリケーションまたはモジュールの現在実行中のバージョンをアンデプロイし、クライアントが新しいバージョンで開始できるようになるまでの秒数を指定します。指定しない場合、正常なリタイア・ポリシーと見なされます。
デフォルト値: -1

rmiGracePeriod

java.lang.Integer

いいえ

正常な停止中のRMIリクエストに対する猶予期間の秒数を指定します。gracefulパラメータがtrueの場合のみ使用できます。デフォルト値の-1は、猶予期間がないことを意味します。
デフォルト値: -1

serverClasspath

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

source

java.lang.String

いいえ

デプロイするアーカイブ・ファイルまたは展開されたアーカイブ・ディレクトリ。このオプションを省略して、デプロイするファイルまたはディレクトリのみを指定できます。

submoduletargets

java.lang.String

いいえ

JMSアプリケーション・モジュール内で定義されているリソースのJMSサーバー・ターゲットを指定します。
可能な値の形式: submod@mod-jms.xml@targetまたはsubmoduleName@target

targets

java.lang.String

いいえ

現在の処理のターゲットのカンマ区切りリストを指定します。デフォルト・ターゲットはAdminServerです。

timeout

java.lang.Integer

いいえ

デプロイメント・タスクの完了までのWebLogic Serverの最長待機秒数を指定します。デフォルト値の-1は、永久に待機することを意味します。
デフォルト値: -1

upload

boolean

いいえ

trueの場合、再デプロイメント前に、指定されたソース・ファイルを管理サーバーのuploadディレクトリにコピーします。この設定は、プラグインをリモートで(remoteパラメータを使用して)実行する場合、およびユーザーに管理サーバーのファイル・システムに対する通常アクセス権が付与されていない場合に使用します。
デフォルト値: false

user

java.lang.String

いいえ

管理ユーザー名を指定します。

userConfigFile

java.lang.String

いいえ

プレーン・テキストでユーザー名とパスワードを直接指定するかわりに、管理ユーザー名とパスワードを取得するために使用するユーザー構成ファイルの場所を指定します。

userKeyFile

java.lang.String

いいえ

ユーザー構成ファイルに格納されたユーザー名とパスワードを暗号化および復号化するために使用するユーザー・キー・ファイルの場所を指定します。

verbose

boolean

いいえ

trueの場合、デプロイメント処理中のステータスに関する追加情報を表示します。
デフォルト値: false

version

boolean

いいえ

trueの場合、バージョン情報を出力します。
デフォルト値: false

weblogicHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。


redeployゴールを使用して、アプリケーションまたはそのアプリケーションの一部を再デプロイします。

<execution>
<id>wls-redeploy</id>
<phase>pre-integration-test</phase>
<goals>
<goal>redeploy</goal>
</goals>
<configuration>
<adminurl>t3://127.0.0.1:7001</adminurl>
<user>weblogic</user>
<password>password</password>
<source>${project.build.directory}/${project.build.finalName}.${project.packaging}</sour
ce>
<name>${project.build.finalName}</name>
</configuration>
</execution>

例3-12では、典型的なredeployゴールの出力を示します。

例3-12 redeploy

mvn com.oracle.weblogic:weblogic-maven-plugin:redeploy -Dsou
rce=C:\Oracle\Middleware\Oracle_Home\wlserver\server\lib\MySimpleEjb.jar  -Duser
=weblogic -Dpassword=password -Dname=ExampleEJB
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building WebLogic Server Maven Plugin 12.1.3.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:redeploy (default-cli) @ weblogic-ma
ven-plugin ---
weblogic.Deployer invoked with options:  -noexit -adminurl t3://localhost:7001 -
redeploy -user weblogic -name ExampleEJB -source C:\Oracle\Middleware\Oracle_Hom
e\wlserver\server\lib\MySimpleEjb.jar -targets AdminServer
<May 3, 2013 12:38:02 PM EDT> <Info> <J2EE Deployment SPI> <BEA-260121> <Initiat
ing redeploy operation for application, ExampleEJB [archive: C:\Oracle\Middlewar
e\Oracle_Home\wlserver\server\lib\MySimpleEjb.jar], to AdminServer .>
Task 3 initiated: [Deployer:149026]deploy application ExampleEJB on AdminServer.
 
Task 3 completed: [Deployer:149026]deploy application ExampleEJB on AdminServer.
 
Target state: redeploy completed on Server AdminServer
 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 6.322s
[INFO] Finished at: Fri May 03 12:38:02 EDT 2013

remove-domain

完全名

com.oracle.weblogic:weblogic-maven-plugin:remove-domain

説明

ドメイン・ディレクトリを削除します。このゴールが成功するには、ドメインが実行中でない必要があります。

パラメータ

表3-13 remove-domainのパラメータ

名前 タイプ 必須 説明

domainHome

java.lang.String

true

ドメイン・ディレクトリへのパス。

workingDir

java.lang.String

いいえ

現在の作業ディレクトリを指定します。

デフォルト値: ${project.build.directory}/weblogic-maven-plugin)


remove-domainゴールを使用して、ドメイン・ディレクトリを削除します。

<execution>
<id>wls-remove-domain</id>
<phase>pre-integration-test</phase>
<goals>
<goal>remove-domain</goal>
</goals>
<configuration>
<domainHome>${project.build.directory}/base_domain</domainHome>
</configuration>
</execution> 

例3-14では、典型的なremove-domainゴールの出力を示します。

例3-13 remove-domain

mvn com.oracle.weblogic:weblogic-maven-plugin:remove-domain
-DdomainHome=C:\Oracle\Middleware\Oracle_Home\user_projects\domains\base_domain
:
[INFO] [remove-domain]Executing: [cmd:[C:\\Windows\\System32\\cmd.exe, /c, rmdir
 /Q /S C:\Oracle\Middleware\Oracle_Home\user_projects\domains\base_domain]]
[INFO] Process being executed, waiting for completion.
[INFO] [remove-domain][cmd:[C:\\Windows\\System32\\cmd.exe, /c, rmdir /Q /S C:\O
racle\Middleware\Oracle_Home\user_projects\domains\base_domain]] exit code=0
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 4:01.074s
[INFO] Finished at: Fri Nov 01 15:17:07 EDT 2013
[INFO] Final Memory: 8M/20M
[INFO] ------------------------------------------------------------------------

start-app

完全名

com.oracle.weblogic:weblogic-maven-plugin:start-app

説明

WebLogic Server上にデプロイされたアプリケーションを起動します。ローカル・サーバー・インストールを必要としません。

パラメータ

表3-14 start-appのパラメータ

名前 タイプ 必須 説明

adminmode

boolean

いいえ

trueの場合、アプリケーションを管理モードに切り替えて、構成済の管理チャネル経由で管理リクエストのみを受け付けます。falseの場合、本番モードと見なされます。
デフォルト値: false

adminurl

java.lang.String

いいえ

管理サーバーのリスニング・アドレスとリスニング・ポートを指定します。
デフォルト値: t3://localhost:7001

advanced

boolean

いいえ

trueの場合、高度な使用オプションを出力します。

appversion

java.lang.String

いいえ

アプリケーションのバージョン識別子を指定します。指定しない場合、アプリケーションの現在アクティブになっているバージョンと見なされます。

debug

boolean

いいえ

trueの場合、デバッグレベル・メッセージを標準出力に表示します。
デフォルト値: false

domainHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

examples

boolean

いいえ

trueの場合、このプラグインの使用方法の例を表示します。

failOnError

boolean

いいえ

trueの場合、エラーが発生すると、そのエラーが記録される前に、Mojoによって強制的にビルドが失敗します。
デフォルト値: true

id

java.lang.String

いいえ

ユーザーが指定する一意のデプロイメント・タスク識別子(オプション)を指定します。

middlewareHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

name

java.lang.String

いいえ

新規にデプロイされたアプリケーションまたはスタンドアロン・モジュールに割り当てるデプロイメント名を指定します。

noversion

boolean

いいえ

trueの場合、管理サーバー上のバージョン関連のすべてのコード・パスを無視します。
デフォルト値: false

nowait

boolean

いいえ

trueの場合、複数のタスクを開始し、その後は-listアクションを使用してモニターします。

password

java.lang.String

いいえ

管理パスワードを指定します。

planversion

java.lang.String

いいえ

デプロイメント・プランのバージョンを指定します。指定しない場合、アプリケーションのデプロイメント・プランの現在アクティブになっているバージョンと見なされます。

purgetasks

boolean

いいえ

trueの場合、リタイアしたデプロイメント・タスクを削除します。
デフォルト値: false

remote

boolean

いいえ

trueの場合、管理サーバーと同じマシンでプラグインが実行されていないことを指定します。この場合、sourceパラメータは、uploadパラメータが同時に使用されていない限り、サーバー上のパスを指定します。
デフォルト値: false

retiretimeout

java.lang.Integer

いいえ

WebLogic Serverがこのアプリケーションまたはモジュールの現在実行中のバージョンをアンデプロイし、クライアントが新しいバージョンで開始できるようになるまでの秒数を指定します。指定しない場合、正常なリタイア・ポリシーと見なされます。
デフォルト値: -1

serverClasspath

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

submoduletargets

java.lang.String

いいえ

JMSアプリケーション・モジュール内で定義されているリソースのJMSサーバー・ターゲットを指定します。
可能な値の形式: submod@mod-jms.xml@targetまたはsubmoduleName@target

targets

java.lang.String

いいえ

現在の処理のターゲットのカンマ区切りリストを指定します。指定しない場合、構成されているすべてのターゲットが使用されます。新しいアプリケーションの場合、デフォルトのターゲットはアプリケーションがデプロイされるすべてのターゲットです。

timeout

java.lang.Integer

いいえ

デプロイメント・タスクの完了までのWebLogic Serverの最長待機秒数を指定します。デフォルト値の-1は、永久に待機することを意味します。
デフォルト値: -1

user

java.lang.String

いいえ

管理ユーザー名を指定します。

userConfigFile

java.lang.String

いいえ

プレーン・テキストでユーザー名とパスワードを直接指定するかわりに、管理ユーザー名とパスワードを取得するために使用するユーザー構成ファイルの場所を指定します。

userKeyFile

java.lang.String

いいえ

ユーザー構成ファイルに格納されたユーザー名とパスワードを暗号化および復号化するために使用するユーザー・キー・ファイルの場所を指定します。

verbose

boolean

いいえ

trueの場合、デプロイメント処理中のステータスに関する追加情報を表示します。
デフォルト値: false

version

boolean

いいえ

trueの場合、バージョン情報を出力します。
デフォルト値: false

weblogicHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。


start-appゴールを使用して、アプリケーションを起動します。

<execution>
<id>wls-start-app</id>
<phase>pre-integration-test</phase>
<goals>
<goal>start-app</goal>
</goals>
<configuration>
<adminurl>t3://localhost:7001</adminurl>
<user>weblogic</user>
<password>password</password>
<name>${project.build.finalName}</name>
</configuration>
</execution> 

例3-14では、典型的なstart-appゴールの出力を示します。

例3-14 start-app

mvn com.oracle.weblogic:weblogic-maven-plugin:start-app  
-Duser=weblogic -Dpassword=password -Dname=ExampleEJB
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building WebLogic Server Maven Plugin 12.1.3.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:start-app (default-cli) @ weblogic-m
aven-plugin ---
weblogic.Deployer invoked with options:  -noexit -adminurl t3://localhost:7001 -
start -user weblogic -name ExampleEJB -retiretimeout -1
<May 3, 2013 12:44:15 PM EDT> <Info> <J2EE Deployment SPI> <BEA-260121> <Initiat
ing start operation for application, ExampleEJB [archive: null], to configured t
argets.>
Task 5 initiated: [Deployer:149026]start application ExampleEJB on AdminServer.
Task 5 completed: [Deployer:149026]start application ExampleEJB on AdminServer.
Target state: start completed on Server AdminServer
 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 6.053s
[INFO] Finished at: Fri May 03 12:44:16 EDT 2013
[INFO] Final Memory: 10M/26M
[INFO] ------------------------------------------------------------------------

start-server

完全名

com.oracle.weblogic:weblogic-maven-plugin:start-server

説明

現在の作業ディレクトリのスクリプトからWebLogic Serverを起動します。

パラメータ

表3-15 start-serverのパラメータ

名前 タイプ 必須 説明

command

java.lang.String[]

いいえ

WebLogic Serverを起動するためのスクリプトを指定します。このパラメータが指定されていない場合、デフォルトでは、プラットフォームに基づいてstartWebLogic.shまたはstartWebLogic.cmdが使用されます。

domainHome

java.lang.String

いいえ

WebLogic Serverドメインのパスを指定します。
デフォルト値: ${basedir}/Oracle/Domains/mydomain

httpPingUrl

java.lang.String

いいえ

pingの実行時にサーバーが実行中であるかどうかを検証するURLを指定します。

middlewareHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

serverClasspath

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

timeoutSecs

java.lang.Integer

いいえ

スクリプトのタイムアウトを秒単位で指定します。waitForExitパラメータがtrueの場合に有効です。ゼロ(0)または負の値はスクリプトがタイムアウトしないことを示します。
デフォルト値: -1

weblogicHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。


使用例

start-serverゴールは、指定されたドメインでstartWebLogicコマンドを実行し、WebLogic Serverインスタンスを起動します。

<execution>
<id>wls-wlst-start-server</id>
<phase>pre-integration-test</phase>
<goals>
<goal>start-server</goal>
</goals>
<configuration>
<domainHome>${project.build.directory}/base_domain</domainHome>
</configuration>
</execution>
 

例3-15では、典型的なstart-serverゴールの出力を示します。

例3-15 start-server

mvn com.oracle.weblogic:weblogic-maven-plugin:start-server
-DdomainHome=c:\oracle\middleware\oracle_home\user_projects\domains\wl_server
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building WebLogic Server Maven Plugin 12.1.3-0-0
[INFO] ------------------------------------------------------------------------[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:start-server (default-cli) 
@ weblogic-maven-plugin ---
.[INFO] Starting server in domain: 
c:\oracle\middleware\oracle_home\user_projects\domains\wl_server
[INFO] Check stdout file for details: 
c:\oracle\middleware\oracle_home\user_projects\domains\wl_server\server-2183114106972126386.out
[INFO] Process being executed, waiting for completion.
.............
[INFO] Server started successful
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 37.725s
[INFO] Finished at: Wed May 01 14:25:45 EDT 2013
[INFO] Final Memory: 8M/23M

stop-app

完全名

com.oracle.weblogic:weblogic-maven-plugin:stop-app

説明

アプリケーションを停止します。ローカル・サーバー・インストールを必要としません。

パラメータ

表3-16 stop-appのパラメータ

名前 タイプ 必須 説明

adminmode

boolean

いいえ

trueの場合、アプリケーションを管理モードに切り替えて、構成済の管理チャネル経由で管理リクエストのみを受け付けます。falseの場合、本番モードと見なされます。
デフォルト値: false

adminurl

java.lang.String

いいえ

管理サーバーのリスニング・アドレスとリスニング・ポートを指定します。
デフォルト値: t3://localhost:7001

advanced

boolean

いいえ

trueの場合、高度な使用オプションを出力します。

appversion

java.lang.String

いいえ

アプリケーションのバージョン識別子を指定します。指定しない場合、アプリケーションの現在アクティブになっているバージョンと見なされます。

debug

boolean

いいえ

trueの場合、デバッグレベル・メッセージを標準出力に表示します。
デフォルト値: false

domainHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

examples

boolean

いいえ

trueの場合、このプラグインの使用方法の例を表示します。

failOnError

boolean

いいえ

trueの場合、エラーが発生すると、そのエラーが記録される前に、Mojoによって強制的にビルドが失敗します。
デフォルト値: true

graceful

boolean

いいえ

trueの場合、既存のHTTPクライアントが作業を完了した後でアプリケーションを停止します。指定しない場合、強制停止と見なされます。

id

java.lang.String

いいえ

ユーザーが指定する一意のデプロイメント・タスク識別子(オプション)を指定します。

ignoresessions

boolean

いいえ

trueの場合、正常な停止時に、保留中のHTTPセッションを無視します。gracefulパラメータがtrueの場合のみ使用できます。
デフォルト値: false

middlewareHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

name

java.lang.String

いいえ

新規にデプロイされたアプリケーションまたはスタンドアロン・モジュールに割り当てるデプロイメント名を指定します。

noversion

boolean

いいえ

trueの場合、管理サーバー上のバージョン関連のすべてのコード・パスを無視します。
デフォルト値: false

nowait

boolean

いいえ

trueの場合、複数のタスクを開始し、その後は-listアクションを使用してモニターします。

password

java.lang.String

いいえ

管理パスワードを指定します。

planversion

java.lang.String

いいえ

デプロイメント・プランのバージョンを指定します。指定しない場合、アプリケーションのデプロイメント・プランの現在アクティブになっているバージョンと見なされます。

purgetasks

boolean

いいえ

trueの場合、リタイアしたデプロイメント・タスクを削除します。

remote

boolean

いいえ

trueの場合、管理サーバーと同じマシンでプラグインが実行されていないことを指定します。この場合、sourceパラメータは、uploadパラメータが同時に使用されていない限り、サーバー上のパスを指定します。
デフォルト値: false

rmiGracePeriod

java.lang.Integer

いいえ

正常な停止中のRMIリクエストに対する猶予期間の秒数を指定します。gracefulパラメータがtrueの場合のみ使用できます。デフォルト値の-1は、猶予期間がないことを意味します。
デフォルト値: -1

serverClasspath

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

submoduletargets

java.lang.String

いいえ

JMSアプリケーション・モジュール内で定義されているリソースのJMSサーバー・ターゲットを指定します。
可能な値の形式: submod@mod-jms.xml@targetまたはsubmoduleName@target

targets

java.lang.String

いいえ

現在の処理のターゲットのカンマ区切りリストを指定します。指定しない場合、構成されているすべてのターゲットが使用されます。

timeout

java.lang.Integer

いいえ

デプロイメント・タスクの完了までのWebLogic Serverの最長待機秒数を指定します。デフォルト値の-1は、永久に待機することを意味します。
デフォルト値: -1

user

java.lang.String

いいえ

管理ユーザー名を指定します。

userConfigFile

java.lang.String

いいえ

プレーン・テキストでユーザー名とパスワードを直接指定するかわりに、管理ユーザー名とパスワードを取得するために使用するユーザー構成ファイルの場所を指定します。

userKeyFile

java.lang.String

いいえ

ユーザー構成ファイルに格納されたユーザー名とパスワードを暗号化および復号化するために使用するユーザー・キー・ファイルの場所を指定します。

verbose

boolean

いいえ

trueの場合、追加のステータス情報を表示します。
デフォルト値: false

version

boolean

いいえ

trueの場合、バージョン情報を出力します。
デフォルト値: false

weblogicHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。


stop-appを使用して、アプリケーションを停止します。

<execution>
<id>wls-start-app</id>
<phase>pre-integration-test</phase>
<goals>
<goal>start-app</goal>
</goals>
<configuration>
<adminurl>t3://localhost:7001</adminurl>
<user>weblogic</user>
<password>password</password>
<name>${project.build.finalName}</name>
</configuration>
</execution> 

例3-16では、典型的なstop-appゴールの出力を示します。

例3-16 stop-app

mvn com.oracle.weblogic:weblogic-maven-plugin:stop-app  -Dus
er=weblogic -Dpassword=password -Dname=ExampleEJB
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building WebLogic Server Maven Plugin 12.1.3.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:stop-app (default-cli) 
@ weblogic-ma
ven-plugin ---
weblogic.Deployer invoked with options:  -noexit 
-adminurl t3://localhost:7001 -
stop -user weblogic -name ExampleEJB
<May 3, 2013 12:46:27 PM EDT> <Info> 
<J2EE Deployment SPI> <BEA-260121> <Initiat
ing stop operation for application, ExampleEJB [archive: null], 
to configured ta
rgets.>
Task 6 initiated: [Deployer:149026]stop application ExampleEJB on 
AdminServer.
Task 6 completed: [Deployer:149026]stop application ExampleEJB on 
AdminServer.
Target state: stop completed on Server AdminServer
 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 6.028s
[INFO] Finished at: Fri May 03 12:46:27 EDT 2013
[INFO] Final Memory: 10M/29M
[INFO] ------------------------------------------------------------------------
C:\Oracle\Middleware\Oracle_Home\wlserver\server\lib>

stop-server

完全名

com.oracle.weblogic:weblogic-maven-plugin:stop-server

説明

現在の作業ディレクトリのスクリプトからWebLogic Serverを停止します。

パラメータ

表3-17 stop-serverのパラメータ

名前 タイプ 必須 説明

adminurl

java.lang.String

いいえ

管理サーバーのリスニング・アドレスとリスニング・ポートを指定します。
デフォルト値: t3://localhost:7001

command

java.lang.String[]

いいえ

WebLogic Serverを停止するためのスクリプトを指定します。プラットフォームに基づいてデフォルトのstopWebLogic.shまたはstopWebLogic.cmdになります。

domainHome

java.lang.String

いいえ

WebLogic Serverドメインのパスを指定します。
デフォルト値: ${basedir}/Oracle/Domains/mydomain

middlewareHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

outputLog

java.lang.String

いいえ

スクリプト出力のリダイレクト先のログ・ファイルを指定します。指定しない場合、デフォルトでstdoutが使用されます。

password

java.lang.String

true

管理パスワードを指定します。

timeoutSecs

java.lang.Integer

いいえ

スクリプトのタイムアウトを秒単位で指定します。waitForExitパラメータがtrueの場合に有効です。ゼロ(0)または負の値はスクリプトがタイムアウトしないことを示します。
デフォルト値: -1

user

java.lang.String

true

管理ユーザー名を指定します。

waitForExit

boolean

いいえ

trueの場合、プラグインはスクリプトが完了するまで待機する必要があります。
デフォルト値: true

weblogicHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

workingDir

java.lang.String

いいえ

スクリプトの作業ディレクトリを指定します。この属性を指定しない場合、デフォルトの現在の作業ディレクトリになります。
デフォルト値: ${project.base.directory}


使用例

stop-serverゴールは、指定したドメインでstopWebLogicスクリプトを使用してサーバー・インスタンスを停止します。

<execution>
<id>wls-wlst-stop-server</id>
<phase>post-integration-test</phase>
<goals>
<goal>stop-server</goal>
</goals>
<configuration>
<domainHome>${project.build.directory}/base_domain</domainHome>
<user>weblogic</user>
<password>password</password>
<adminurl>t3://localhost:7001</adminurl>
</configuration>
</execution>

例3-17では、典型的なstop-serverゴールの出力を示します。

例3-17 stop-server

mvn com.oracle.weblogic:weblogic-maven-plugin:stop-server
 -DdomainHome=c:\oracle\middleware\oracle_home\userprojects\domains\wl_server 
-DworkingDir=c:\oracle\middleware\oracle_home\user_projects\domains\wl_server
-Duser=weblogic -Dpassword=password
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building WebLogic Server Maven Plugin 12.1.3-0-0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:stop-server (default-cli) 
@ weblogic
-maven-plugin ---
[INFO] Stop server in domain: 
c:\oracle\middleware\oracle_home\user_projects\dom
ains\wl_server
[INFO] Process being executed, waiting for completion.
[INFO] [exec] Stopping Weblogic Server...
[INFO] [exec]
[INFO] [exec] Initializing WebLogic Scripting Tool (WLST) ...
[INFO] [exec]
[INFO] [exec] Welcome to WebLogic Server Administration Scripting Shell
[INFO] [exec]
[INFO] [exec] Type help() for help on available commands
[INFO] [exec]
[INFO] [exec] Connecting to t3://localhost:7001 with userid weblogic ...
[INFO] [exec] Successfully connected to Admin Server "AdminServer" that belongs
to domain "wl_server".
[INFO] [exec]
[INFO] [exec] Warning: An insecure protocol was used to connect to the
[INFO] [exec] server. To ensure on-the-wire security, the SSL port or
[INFO] [exec] Admin port should be used instead.
[INFO] [exec]
[INFO] [exec] Shutting down the server AdminServer with force=false while connec
ted to AdminServer ...
[INFO] [exec] WLST lost connection to the WebLogic Server that you were
[INFO] [exec] connected to, this may happen if the server was shutdown or
[INFO] [exec] partitioned. You will have to re-connect to the server once the
[INFO] [exec] server is available.
[INFO] [exec] Disconnected from weblogic server: AdminServer
[INFO] [exec] Disconnected from weblogic server:
[INFO] [exec]
[INFO] [exec]
[INFO] [exec] Exiting WebLogic Scripting Tool.
[INFO] [exec]
[INFO] [exec] Done
[INFO] [exec] Stopping Derby Server...
[INFO] [exec] Derby server stopped.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 23.270s
[INFO] Finished at: Wed May 01 14:33:47 EDT 2013
[INFO] Final Memory: 9M/23M
[INFO] ------------------------------------------------------------------------

undeploy

完全名

com.oracle.weblogic:weblogic-maven-plugin:undeploy

説明

WebLogic Serverからアプリケーションをアンデプロイします。デプロイメント・ユニットを停止して、ステージングされているファイルをターゲット・サーバーから削除します。ローカル・サーバー・インストールを必要としません。

パラメータ

表3-18 undeployのパラメータ

名前 タイプ 必須 説明

adminurl

java.lang.String

いいえ

管理サーバーのリスニング・アドレスとリスニング・ポートを指定します。
デフォルト値: t3://localhost:7001

advanced

boolean

いいえ

trueの場合、高度な使用オプションを出力します。

appversion

java.lang.String

いいえ

アプリケーションのバージョン識別子を指定します。指定しない場合、アプリケーションの現在アクティブになっているバージョンと見なされます。

debug

boolean

いいえ

trueの場合、デバッグレベル・メッセージを標準出力に表示します。
デフォルト値: false

examples

boolean

いいえ

trueの場合、このプラグインの使用方法の例を表示します。

failOnError

boolean

いいえ

trueの場合、エラーが発生すると、そのエラーが記録される前に、Mojoによって強制的にビルドが失敗します。
デフォルト値: true

graceful

boolean

いいえ

trueの場合、既存のHTTPクライアントが作業を完了した後でアプリケーションを停止します。指定しない場合、強制停止と見なされます。

id

java.lang.String

いいえ

ユーザーが指定する一意のデプロイメント・タスク識別子(オプション)を指定します。

ignoresessions

boolean

いいえ

trueの場合、正常な停止時に、保留中のHTTPセッションを無視します。gracefulパラメータがtrueの場合のみ使用できます。
デフォルト値: false

middlewareHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

name

java.lang.String

いいえ

新規にデプロイされたアプリケーションまたはスタンドアロン・モジュールに割り当てるデプロイメント名を指定します。

noversion

boolean

いいえ

trueの場合、管理サーバー上のバージョン関連のすべてのコード・パスを無視します。
デフォルト値: false

nowait

boolean

いいえ

trueの場合、複数のタスクを開始し、その後は-listアクションを使用してモニターします。

password

java.lang.String

いいえ

管理パスワードを指定します。

planversion

java.lang.String

いいえ

デプロイメント・プランのバージョンを指定します。指定しない場合、アプリケーションのデプロイメント・プランの現在アクティブになっているバージョンと見なされます。

remote

boolean

いいえ

trueの場合、管理サーバーと同じマシンでプラグインが実行されていないことを指定します。この場合、sourceパラメータは、uploadパラメータが同時に使用されていない限り、サーバー上のパスを指定します。
デフォルト値: false

rmiGracePeriod

java.lang.Integer

いいえ

正常な停止中のRMIリクエストに対する猶予期間の秒数を指定します。gracefulパラメータがtrueの場合のみ使用できます。デフォルト値の-1は、猶予期間がないことを意味します。
デフォルト値: -1

serverClasspath

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

submoduletargets

java.lang.String

いいえ

JMSアプリケーション・モジュール内で定義されているリソースのJMSサーバー・ターゲットを指定します。
可能な値の形式: submod@mod-jms.xml@targetまたはsubmoduleName@target

targets

java.lang.String

いいえ

現在の処理のターゲットのカンマ区切りリストを指定します。指定しない場合、構成されているすべてのターゲットが使用されます。

timeout

java.lang.Integer

いいえ

デプロイメント・タスクの完了までのWebLogic Serverの最長待機秒数を指定します。デフォルト値の-1は、永久に待機することを意味します。
デフォルト値: -1

user

java.lang.String

いいえ

管理ユーザー名を指定します。

userConfigFile

java.lang.String

いいえ

プレーン・テキストでユーザー名とパスワードを直接指定するかわりに、管理ユーザー名とパスワードを取得するために使用するユーザー構成ファイルの場所を指定します。

userKeyFile

java.lang.String

いいえ

ユーザー構成ファイルに格納されたユーザー名とパスワードを暗号化および復号化するために使用するユーザー・キー・ファイルの場所を指定します。

verbose

boolean

いいえ

trueの場合、デプロイメント処理中のステータスに関する追加情報を表示します。
デフォルト値: false

version

boolean

いいえ

trueの場合、バージョン情報を出力します。
デフォルト値: false

weblogicHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。


undeployゴールを使用して、WebLogic Serverからアプリケーションを再デプロイします。

<execution>
<id>wls-undeploy</id>
<phase>post-integration-test</phase>
<goals>
<goal>undeploy</goal>
</goals>
<configuration>
<adminurl>t3://127.0.0.1:7001</adminurl>
<user>weblogic</user>
<password>password</password>
<name>${project.build.finalName}</name>
</configuration>
</execution>

例3-18では、典型的なundeployゴールの出力を示します。

例3-18 undeploy

mvn com.oracle.weblogic:weblogic-maven-plugin:undeploy 
-Duser=weblogic -Dpassword=password -Dname=ExampleEJB
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building WebLogic Server Maven Plugin 12.1.3.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:undeploy (default-cli) 
@ weblogic-ma
ven-plugin ---
weblogic.Deployer invoked with options:  -noexit 
-adminurl t3://localhost:7001 -
undeploy -user weblogic -name ExampleEJB -targets AdminServer
<May 3, 2013 12:48:15 PM EDT> <Info> <J2EE Deployment SPI> 
<BEA-260121> <Initiat
ing undeploy operation for application, ExampleEJB [archive: null], 
to AdminServ
er .>
Task 7 initiated: [Deployer:149026]remove application ExampleEJB 
on AdminServer.
 
Task 7 completed: [Deployer:149026]remove application ExampleEJB 
on AdminServer.
 
Target state: undeploy completed on Server AdminServer
 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 6.114s
[INFO] Finished at: Fri May 03 12:48:15 EDT 2013
[INFO] Final Memory: 9M/26M
[INFO] ------------------------------------------------------------------------

uninstall

完全名

com.oracle.weblogic:weblogic-maven-plugin:uninstall

説明

JARまたはZIPインストーラを使用して、WebLogic Serverをアンインストールします。

パラメータ

表3-19 uninstallのパラメータ

名前 タイプ 必須 説明

invPtrLoc

java.io.File

true

サイレント・インストーラのインベントリの場所のファイル。これは、バイナリ(ZIP)またはJARインストーラを使用する場合に、UNIXベースのプラットフォームで必要です。

middlewareHome

java.lang.String

true

Oracle Middlewareインストール・ディレクトリ。このパラメータは、ZIPインストーラを使用してインストールされたサーバーをアンインストールする場合に必要です。

response

java.io.File

true

サイレント・アンインストーラのレスポンス・ファイル。これは、バイナリ(ZIP)またはJARアンインストーラを使用する場合に必要です。


uninstallゴールを使用して、WebLogic Serverをアンインストールします。

<execution>
<id>wls-uninstall-server</id>
<phase>post-integration-test</phase>
<goals>
<goal>uninstall</goal>
</goals>
<configuration>
<middlewareHome>c:/dev/wls12130</middlewareHome>
</configuration>
</execution>

例3-19では、ZIPファイル・インストールでの典型的なuninstallゴールの出力を示します。

例3-19 ZIPインストールでのアンインストール

mvn com.oracle.weblogic:weblogic-maven-plugin:uninstall 
-DmiddlewareHome=C:\Oracle\Middleware\Oracle_Home
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building WebLogic Server Maven Plugin 12.1.3.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:uninstall 
(default-cli) @ weblogic-m
aven-plugin ---
[INFO] Attempting to uninstall from : 
C:\Oracle\Middleware\Oracle_Home
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 27.886s

例3-20では、JARファイル・インストールでのWebLogic Serverをアンインストールする例を示しています。

例3-20 JARインストールでのアンインストール

mvn com.oracle.weblogic:weblogic-maven-plugin:uninstall -Dresponse=response
-file
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:uninstall (default-cli) @ standalone
-pom ---
[INFO] [uninstall]ORACLE_HOME = C:\wls-temp-home\oracle\middleware\oracle_home
[INFO] [uninstall]ORACLE_HOME = C:\wls-temp-home\oracle\middleware\oracle_home
[INFO] Executing:  [cmd:[C:\\Windows\\System32\\cmd.exe, /c, C:\wls-temp-home\or
acle\middleware\oracle_home\oui\bin\install.exe -deinstall -silent -response C:\
oracle\middleware\response-file]]
[INFO] Process being executed, waiting for completion.
[INFO] Installer exited with code: 1
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2:05.363s
[INFO] Finished at: Thu Nov 14 10:44:47 EST 2013
[INFO] Final Memory: 7M/22M
[INFO] ------------------------------------------------------------------------

update-app

完全名

com.oracle.weblogic:weblogic-maven-plugin:update-app

説明

プラン・ファイルを再配布して、新しいプランのコンテキストに基づいてアプリケーションを再構成することで、アプリケーションのデプロイメント・プランを更新します。ローカル・サーバー・インストールを必要としません。

パラメータ

表3-20 update-appのパラメータ

名前 タイプ 必須 説明

adminurl

java.lang.String

いいえ

管理サーバーのリスニング・アドレスとリスニング・ポートを指定します。
デフォルト値: t3://localhost:7001

advanced

boolean

いいえ

trueの場合、高度な使用オプションを出力します。

appversion

java.lang.String

いいえ

アプリケーションのバージョン識別子を指定します。指定しない場合、アプリケーションの現在アクティブになっているバージョンと見なされます。

debug

boolean

いいえ

trueの場合、デバッグレベル・メッセージを標準出力に表示します。
デフォルト値: false

domainHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

examples

boolean

いいえ

trueの場合、このプラグインの使用方法の例を表示します。

failOnError

boolean

いいえ

trueの場合、エラーが発生すると、そのエラーが記録される前に、Mojoによって強制的にビルドが失敗します。
デフォルト値: true

id

java.lang.String

いいえ

ユーザーが指定する一意のデプロイメント・タスク識別子(オプション)を指定します。

middlewareHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

name

java.lang.String

いいえ

新規にデプロイされたアプリケーションまたはスタンドアロン・モジュールに割り当てるデプロイメント名を指定します。

noversion

boolean

いいえ

trueの場合、管理サーバー上のバージョン関連のすべてのコード・パスを無視します。
デフォルト値: false

nowait

boolean

いいえ

trueの場合、複数のタスクを開始し、その後は-listアクションを使用してモニターします。

password

java.lang.String

いいえ

管理パスワードを指定します。

plan

java.lang.String

いいえ

デプロイメント・プランの場所を指定します。

planversion

java.lang.String

いいえ

デプロイメント・プランのバージョンを指定します。指定しない場合、アプリケーションのデプロイメント・プランの現在アクティブになっているバージョンと見なされます。

purgetasks

boolean

いいえ

trueの場合、リタイアしたデプロイメント・タスクを削除します。
デフォルト値: false

remote

boolean

いいえ

trueの場合、管理サーバーと同じマシンでプラグインが実行されていないことを指定します。この場合、sourceパラメータは、uploadパラメータが同時に使用されていない限り、サーバー上のパスを指定します。
デフォルト値: false

rmiGracePeriod

java.lang.Integer

いいえ

正常な停止中のRMIリクエストに対する猶予期間の秒数を指定します。gracefulパラメータがtrueの場合のみ使用できます。デフォルト値の-1は、猶予期間がないことを意味します。
デフォルト値: -1

serverClasspath

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

submoduletargets

java.lang.String

いいえ

JMSアプリケーション・モジュール内で定義されているリソースのJMSサーバー・ターゲットを指定します。
可能な値の形式: submod@mod-jms.xml@targetまたはsubmoduleName@target

targets

java.lang.String

いいえ

アプリケーションまたはモジュールを更新するターゲット。この属性では、カンマ区切りリストを使用できます。ターゲットが指定されていない場合は、すべてのターゲットが更新されます。

timeout

java.lang.Integer

いいえ

デプロイメント・タスクの完了までのWebLogic Serverの最長待機秒数を指定します。デフォルト値の-1は、永久に待機することを意味します。
デフォルト値: -1

upload

boolean

いいえ

trueの場合、デプロイメント前に、ソース・ファイルを管理サーバーのアップロード・ディレクトリにコピーします。この設定は、プラグインをリモートで(remoteパラメータを使用して)実行する場合、およびユーザーに管理サーバーのファイル・システムに対する通常アクセス権が付与されていない場合に使用します。
デフォルト値: false

user

java.lang.String

いいえ

管理ユーザー名を指定します。

userConfigFile

java.lang.String

いいえ

プレーン・テキストでユーザー名とパスワードを直接指定するかわりに、管理ユーザー名とパスワードを取得するために使用するユーザー構成ファイルの場所を指定します。

userKeyFile

java.lang.String

いいえ

ユーザー構成ファイルに格納されたユーザー名とパスワードを暗号化および復号化するために使用するユーザー・キー・ファイルの場所を指定します。

verbose

boolean

いいえ

trueの場合、追加のステータス情報を表示します。
デフォルト値: false

version

boolean

いいえ

trueの場合、バージョン情報を出力します。
デフォルト値: false

weblogicHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。


update-appゴールを使用して、アプリケーションのデプロイメント・プランを更新します。

<execution>
<id>wls-update-app</id>
<phase>pre-integration-test</phase>
<goals>
<goal>update-app</goal>
</goals>
<configuration>
<adminurl>t3://127.0.0.1:7001</adminurl>
<user>weblogic</user>
<password>password</password>
<name>${project.build.finalName}</name>
<plan>${basedir}/misc/myplan.xml</plan>
</configuration>
</execution>
 

例3-21では、典型的なwlstゴールの出力を示します。

例3-21 update-app

$ mvn com.oracle.weblogic:weblogic-maven-plugin:update-app -Duser=weblogic
 -Dpassword=password -Dadminurl=t3://localhost:7001 -Dplan=misc/myplan.xml
 -Dname=basicWebapp
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building basicWebapp 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:update-app (default-cli) 
@ main-test ---
weblogic.Deployer invoked with options: -noexit -adminurl 
t3://localhost:7001 -update -user weblogic -plan
 /home/oracle/src/tests/main-test/misc/myplan.xml -name basicWebapp -targets AdminServer
<May 15, 2013 2:30:34 PM EST> <Info> <J2EE Deployment SPI> <BEA-260121>
 <Initiating update operation for application, basicWebapp [archive: null],
 to AdminServer .>
Task 10 initiated: [Deployer:149026]update application basicWebapp on
 AdminServer.
Task 10 completed: [Deployer:149026]update application basicWebapp on
 AdminServer.
Target state: update completed on Server AdminServer
 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 10.651s
[INFO] Finished at: Wed May 15 14:30:34 EST 2013
[INFO] Final Memory: 18M/435M
[INFO] ------------------------------------------------------------------------

wlst

完全名

com.oracle.weblogic:weblogic-maven-plugin:wlst

説明

このゴールは、WLSTスクリプティング・ツールのラッパーです。WLSTオンライン・コマンドを実行するためにはサーバーのインストールが必要です。

パラメータ

表3-21 wlstのパラメータ

名前 タイプ 必須 説明

args

java.lang.String

いいえ

WLST Pythonインタプリタに渡されるコマンドライン引数を含む文字列値を指定します。引数は空白で区切ります。空白を含む引数は、一重引用符またはエスケープされた二重引用符で囲む必要があります。たとえば、2つのパラメータを含む、次のような引数の文字列があります。

"'Thomas Paine' \"Now is the time that tries men's souls.\""

debug

boolean

いいえ

trueの場合、追加のステータス情報を表示します。

デフォルト値: false

executeScriptBeforeFile

boolean

いいえ

trueの場合、スクリプトとファイルが提供されているときに、そのスクリプトをファイルの前と後のどちらで実行するのかを指定します。ファイルまたはスクリプトのいずれかが必要であり、両方使用することもできます。filenameおよびscriptパラメータを参照してください。。

デフォルト値: true

failOnError

boolean

いいえ

trueの場合、wlstゴールが失敗したときに、Mavenのビルドが失敗します。デフォルト値はtrueであり、その結果、どのようなエラー状態でもビルドは失敗します。場合によっては、failOnErrorfalseに設定すると、wlstゴールでエラーを無視できます。

デフォルト値: true

fileName

java.lang.String

いいえ

実行するWLST Pythonスクリプトのファイル・パスを指定します。fileNamescriptのいずれかのパラメータを指定する必要があり、両方指定することもできます。

middlewareHome

java.lang.String

true

Oracle Middlewareインストール・ディレクトリへのパス。

propertiesFile

java.lang.String

いいえ

Javaプロパティ・ファイルのパスを指定します。プロパティ名が、WLST Pythonインタプリタの定義済変数になり、指定した値に初期化されます。たとえば、プロパティ・ファイルに"foobar: Very important stuff"という行が含まれている場合、変数foobarをPython文で"print('foobar has the value: ' + foobar)"という形式で使用できます。

script

java.lang.String

いいえ

インラインWLST Pythonスクリプト、たとえば "print('Hello, world!')"を指定します。

Pythonではネストされたコード・ブロックをインデントで区切るため、複数行からなるスクリプトをPOMで指定する場合は、pom.xml内でインデントを使用せずに行う必要があります(ただし、コード・ブロックの区切りとして必要な場合を除く)。

serverClasspath

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

weblogicHome

java.lang.String

いいえ

このパラメータはこのリリースでは非推奨となっており、無視されます。

wlstVersion

java.lang.String

いいえ

WLSTバージョンを指定します。

  • wls: ゴールでは、WLSTのWLS限定バージョンが使用されます。

  • soa: ゴールでは、WLSTのSOAバージョンが使用されます。

    oracle_common: ゴールでは、WLSTのFMW共通バージョンが使用されます。

デフォルト値はwlsです。


使用例

wlstゴールによってWebLogic Scripting Tool (WLST)を使用して、WebLogic Serverドメインでリソースを構成したり他の操作を実行するスクリプトを実行できます。wlst Mavenゴールは、WebLogic Server WLST標準環境を使用して、それをすべての既存のWLSTスクリプトとともに使用できるようにします。

wlstゴールを使用して、fileName構成パラメータとともに指定した外部WLSTスクリプトを実行できます。または、script構成要素を使用してpom.xmlファイル内で一連のWLSTコマンドを指定できます。

<execution>
<id>wls-wlst-server</id>
<phase>post-integration-test</phase>
<goals>
<goal>wlst</goal>
</goals>
<configuration>
<middlewareHome>c:/dev/wls12130</middlewareHome>
<fileName>${project.basedir}/misc/configure_resources.py</fileName>
<args>t3://localhost:7001 weblogic password AdminServer</args>
<script>
print('This is a WLST inline script\n')
print('Next, we run a WLST script to create JMS resources on the server\n')
</script>
<executeScriptBeforeFile>true</executeScriptBeforeFile>
</configuration>
</execution>

例3-22では、典型的なwlstゴールの出力を示します。

例3-22 wlst

mvn com.oracle.weblogic:weblogic-maven-plugin:wlst
 -DfileName=create-datasource.py 

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building maven-demo 1.0
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:wlst (default-cli) @ maven-demo ---
[INFO] ++====================================================================++
[INFO] ++  weblogic-maven-plugin: wlst                                            ++
[INFO] ++====================================================================++
 
*** Creating DataSource ***
 
Connecting to t3://localhost:7001 with userid weblogic ...
Successfully connected to Admin Server 'AdminServer' that belongs to domain 'mydomain'.
 
Warning: An insecure protocol was used to connect to the 
server. To ensure on-the-wire security, the SSL port or 
Admin port should be used instead.
 
Location changed to edit tree. This is a writable tree with 
DomainMBean as the root. To make changes you will need to start 
an edit session via startEdit(). 
 
For more help, use help(edit)
 
Starting an edit session ...
Started edit session, please be sure to save and activate your 
changes once you are done.
Activating all your changes, this may take a while ... 
The edit lock associated with this edit session is released 
once the activation is completed.
Activation completed
Location changed to serverRuntime tree. This is a read-only tree with ServerRuntimeMBean as the root. 
For more help, use help(serverRuntime)
 
**** DataSource Details ****
 
Name:            cp
Driver Name:     Oracle JDBC driver
DataSource:      oracle.jdbc.xa.client.OracleXADataSource
Properties:      {user=demo}
State:           Running
 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS

デフォルトでは、wlstゴールはpre-integration-testフェーズにバインドされています。ゴールに対するデフォルトのフェーズのバインドをオーバーライドするために、プラグインのゴールを特定のライフサイクル・フェーズに明示的にバインドすることができます。たとえば、次に示すように、post-integration-testフェーズにバインドします。pom.xmlファイルは、wlstゴールをpre-integration-testフェーズとpost-integration-testフェーズの両方にバインドします(デュアル・フェーズ・ターゲット)。例に示すように、デフォルトの設定をオーバーライドして、異なるフェーズで異なるスクリプトを実行し、ニーズに応じて変更を行うことができます。

サンプルpom.xmlファイル

<project>
  ....
 <executions>
   <execution>
     <id>WLS_SETUP_RESOURCES</id>
     <phase>pre-integration-test</phase>
     <goals>
       <goal>wlst</goal>
     </goals>
     <configuration>
       <fileName>src/main/wlst/create-datasource.py</fileName>
     </configuration>
   </execution>
 
   <execution>
     <id>WLS_TEARDOWN_RESOURCES</id>
     <phase>post-integration-test</phase>
     <goals>
       <goal>wlst</goal>
     </goals>
     <configuration>
       <fileName>src/main/wlst/remove-datasource.py</fileName>
     </configuration>
   </execution>
 </executions>
 ....
 </project>

wlst-client

完全名

com.oracle.weblogic:weblogic-maven-plugin:wlst-client

説明

このゴールは、ローカル・サーバーのインストールを必要とせずにWLSTオンライン・コマンドを実行するためのWLSTラッパーです。ローカル・サーバーがインストールされていない場合、このゴールではWLSTオンライン・コマンドのみがサポートされます。

パラメータ

表3-22 wlst-clientのパラメータ

名前 タイプ 必須 説明

args

java.lang.String

いいえ

WLST Pythonインタプリタに渡されるコマンドライン引数を含む文字列値を指定します。引数は空白で区切ります。空白を含む引数は、一重引用符またはエスケープされた二重引用符で囲む必要があります。たとえば、2つのパラメータを含む、次のような引数の文字列があります。

"'Thomas Paine' \"Now is the time that tries men's souls.\""

debug

boolean

いいえ

trueの場合、追加のステータス情報を表示します。

デフォルト値: false

executeScriptBeforeFile

boolean

いいえ

trueの場合、スクリプトとファイルが提供されているときに、そのスクリプトをファイルの前と後のどちらで実行するのかを指定します。ファイルまたはスクリプトのいずれかが必要であり、両方使用することもできます。filenameおよびscriptパラメータを参照してください。。

デフォルト値: true

failOnError

boolean

いいえ

trueの場合、wlstゴールが失敗したときに、Mavenのビルドが失敗します。デフォルト値はtrueであり、その結果、どのようなエラー状態でもビルドは失敗します。場合によっては、failOnErrorfalseに設定すると、wlstゴールでエラーを無視できます。

デフォルト値: true

fileName

java.lang.String

いいえ

実行するWLST Pythonスクリプトのファイル・パスを指定します。fileNamescriptのいずれかのパラメータを指定する必要があり、両方指定することもできます。

middlewareHome

java.lang.String

いいえ

Oracle Middlewareインストール・ディレクトリへのパス。

このパラメータは、すべてのWLSTオフライン・コマンドに必要です。WLSTスクリプトで、有効なミドルウェア・ホームを指定せずにオフライン・コマンドが使用されている場合、このwlst-clientゴールは失敗します。

propertiesFile

java.lang.String

いいえ

Javaプロパティ・ファイルのパスを指定します。プロパティ名が、WLST Pythonインタプリタの定義済変数になり、指定した値に初期化されます。たとえば、プロパティ・ファイルに"foobar: Very important stuff"という行が含まれている場合、変数foobarをPython文で"print('foobar has the value: ' + foobar)"という形式で使用できます。

script

java.lang.String

いいえ

インラインWLST Pythonスクリプト、たとえば "print('Hello, world!')"を指定します。


使用例

wlst-clientゴールによってWebLogic Scripting Tool (WLST)を使用して、WebLogic Serverドメインでリソースを構成したり他の操作を実行するスクリプトを実行できます。wlst-clientゴールでは、WLSTオンライン・コマンドの実行にローカル・サーバーのインストールを必要としません。

wlst-client Mavenゴールは、WebLogic Server WLST標準環境を使用して、それをすべての既存のWLSTスクリプトとともに使用できるようにします。

wlst-clientゴールを使用して、fileName構成パラメータとともに指定した外部WLSTスクリプトを実行するか、script構成要素を使用してpom.xmlファイル内で一連のWLSTコマンドを指定するか、あるいはその両方の方法を使用することができます。

例:

<execution>
<id>wls-wlst-server</id>
<phase>post-integration-test</phase>
<goals>
<goal>wlst-client</goal>
</goals>
<configuration>
<fileName>${project.basedir}/misc/configure_resources.py</fileName>
<args>t3://some-host:7001 weblogic password AdminServer</args>
<script>
print('This is a WLST inline script\n')
print('Next, we run a WLST script to create JMS resources on the server\n')
</script>
<executeScriptBeforeFile>true</executeScriptBeforeFile>
</configuration>
</execution>

例3-22では、典型的なwlst-clientゴールの出力を示します。

例3-23 wlst-client

mvn com.oracle.weblogic:weblogic-maven-plugin:wlst-client
 -DfileName=create-datasource.py 

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building maven-demo 1.0
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:wlst (default-cli) @ maven-demo ---
[INFO] ++====================================================================++
[INFO] ++  weblogic-maven-plugin: wlst                                            ++
[INFO] ++====================================================================++
 
*** Creating DataSource ***
 
Connecting to t3://some-host:7001 with userid weblogic ...
Successfully connected to Admin Server 'AdminServer' that belongs to domain 'mydomain'.
 
Warning: An insecure protocol was used to connect to the 
server. To ensure on-the-wire security, the SSL port or 
Admin port should be used instead.
 
Location changed to edit tree. This is a writable tree with 
DomainMBean as the root. To make changes you will need to start 
an edit session via startEdit(). 
 
For more help, use help(edit)
 
Starting an edit session ...
Started edit session, please be sure to save and activate your 
changes once you are done.
Activating all your changes, this may take a while ... 
The edit lock associated with this edit session is released 
once the activation is completed.
Activation completed
Location changed to serverRuntime tree. This is a read-only tree with ServerRuntimeMBean as the root. 
For more help, use help(serverRuntime)
 
**** DataSource Details ****
 
Name:            cp
Driver Name:     Oracle JDBC driver
DataSource:      oracle.jdbc.xa.client.OracleXADataSource
Properties:      {user=demo}
State:           Running
 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS

別の例として、次の簡単なWLSTスクリプトがあるとします。

try:
  connect('weblogic','password','t3://10.151.69.120:7001')
  listApplications() 
  print('TEST PASS')
except:
  print('TEST FAIL') 

このWLSTスクリプトではfileName構成パラメータを指定できます(例3-24を参照)。

例3-24 wlst-clientスクリプトの例

C:\Oracle\Middleware\Oracle_Home\oracle_common\plugins\maven\com\oracle\maven\or
acle-maven-sync\12.1.3>mvn com.oracle.weblogic:weblogic-maven-plugin:wlst-client
  -DfileName=test.py
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:wlst-client (default-cli) @ standalo
ne-pom ---
[INFO] [wlst-client]No middlewareHome specified.
Connecting to t3://10.151.69.120:7001 with userid weblogic ...
Successfully connected to Admin Server "AdminServer" that belongs to domain "bas
e_domain".
 
Warning: An insecure protocol was used to connect to the
server. To ensure on-the-wire security, the SSL port or
Admin port should be used instead.
 
 jaxwsejb30ws
TEST PASS
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 29.197s
[INFO] Finished at: Tue Nov 05 11:51:32 EST 2013
[INFO] Final Memory: 18M/45M
[INFO] ------------------------------------------------------------------------

デフォルトでは、wlstゴールはpre-integration-testフェーズにバインドされています。ゴールに対するデフォルトのフェーズのバインドをオーバーライドするために、プラグインのゴールを特定のライフサイクル・フェーズに明示的にバインドすることができます。たとえば、次に示すように、post-integration-testフェーズにバインドします。pom.xmlファイルは、wlstゴールをpre-integration-testフェーズとpost-integration-testフェーズの両方にバインドします(デュアル・フェーズ・ターゲット)。例に示すように、デフォルトの設定をオーバーライドして、異なるフェーズで異なるスクリプトを実行し、ニーズに応じて変更を行うことができます。

サンプルpom.xmlファイル

<project>
  ....
 <executions>
   <execution>
     <id>WLS_SETUP_RESOURCES</id>
     <phase>pre-integration-test</phase>
     <goals>
       <goal>wlst</goal>
     </goals>
     <configuration>
       <fileName>src/main/wlst/create-datasource.py</fileName>
     </configuration>
   </execution>
 
   <execution>
     <id>WLS_TEARDOWN_RESOURCES</id>
     <phase>post-integration-test</phase>
     <goals>
       <goal>wlst</goal>
     </goals>
     <configuration>
       <fileName>src/main/wlst/remove-datasource.py</fileName>
     </configuration>
   </execution>
 </executions>
 ....
 </project>

exit()のトラップ

exit()は、WLSTをユーザー・セッションから終了させて、スクリプト・シェルを閉じます。デフォルトでは、WLSTを終了するときに、現在のWLST JVMのSystem.exit(0)が呼び出されます。wlst-clientは、Mavenビルド・プロセスと同じJVM内で実行されるため、Mavenビルド・プロセス全体が終了することになります。これに備えて、Maven実装ではWLST exit()のコールをトラップして、例外をスローします。

WLSTスクリプトからexit()を明示的にコールしないことをお薦めします。

たとえば、前述のWLSTスクリプトの例を変更し、次のようにexit()を追加したとします。

try:
  connect('weblogic','password','t3://10.151.69.120:7001')
  listApplications() 
  exit()
  print('TEST PASS')
except:
  print('TEST FAIL') 

Maven実装がexit()をトラップすると、例外がスローされます。

Warning: An insecure protocol was used to connect to the
server. To ensure on-the-wire security, the SSL port or
Admin port should be used instead.
 
 jaxwsejb30ws
 
 
Exiting WebLogic Scripting Tool.
 
TEST FAIL
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 29.250s
[INFO] Finished at: Tue Nov 05 13:14:18 EST 2013
[INFO] Final Memory: 19M/45M
[INFO] ------------------------------------------------------------------------

ws-clientgen

完全名

com.oracle.weblogic:weblogic-maven-plugin:ws-clientgen

説明

WSDLからJAX-WSクライアントWebサービス・アーティファクトを生成するMavenゴールです。

ws-clientgenゴールは、"clientgen" Antタスク用のMavenラッパーを提供します。これは、『Oracle WebLogic Server WebLogic Webサービス・リファレンス』に説明されています。


注意:

ws-clientgenゴールは、WebLogic固有のアノテーションに関する項に説明されているJAX-RPC-のみのJWSアノテーションとは連携しません。

パラメータ

表3-23に、ws-clientgenのパラメータについて簡単にまとめます。これらのパラメータは、『Oracle WebLogic Server WebLogic Webサービス・リファレンス』の表2-3 「clientgen AntタスクのWebLogic固有の属性」で詳しく説明されています。

表3-23 ws-clientgenのパラメータ

名前 タイプ 必須 説明

binding

bindings

java.lang.String

いいえ

JAX-WSおよびJAXBカスタム・バインディング宣言またはSOAPハンドラ・ファイルを指定する1つ以上のカスタマイズ・ファイルを指定します。バインディング要素が1つしかない場合、<binding>./filename</binding>および<bindings><binding>./filename</binding></bindings>の両方が許可されます。

bindingsパラメータの説明は、表3-24を参照してください。

catalog

java.lang.String

いいえ

外部XMLカタログ・ファイルを指定して、外部エンティティの参照を解決します。

XMLカタログ・ファイルの作成の詳細は、『Oracle WebLogic Server JAX-WS Webサービスの開発』のXMLカタログの使用に関する項を参照してください。

copyWsdl

boolean

いいえ

WSDLをws-clientgenゴールの宛先ディレクトリ内のどこにコピーするかを制御します。

debug

boolean

いいえ

追加のデバッグ出力をオンにします。

debugLevel

boolean

いいえ

Antデバッグレベルを使用します。

destDir

java.io.File

true

ws-clientgenゴールがクライアント・ソース・コード、WSDLファイル、クライアント・デプロイメント記述子ファイルを生成するディレクトリを指定します。

destFileまたはdestDirのいずれかの属性を指定する必要があります(両方は指定できません)。

failOnError

boolean

いいえ

ws-clientgenゴールが、エラー発生時にも実行し続けるかどうかを指定します。デフォルト値はTrueです。

fork

boolean

いいえ

外部でJDKコンパイラを使用してjavacを実行するかどうかを指定します。デフォルト値はfalseです。

genRuntimeCatalog

boolean

いいえ

ws-clientgenゴールがクライアント実行時環境にXMLカタログ・アーティファクトを生成するかどうかを指定します。この値のデフォルトはtrueです。

includeAntRuntime

boolean

いいえ

Antランタイム・ライブラリをクラスパスに含めるかどうかを指定します。

includeJavaRuntime

boolean

いいえ

実行するVMのデフォルトのランタイム・ライブラリをクラスパスに含めるかどうかを指定します。

jmstransportclient

JMSTransportClient

いいえ

JMSトランスポートを使用したWebLogic Webサービスの呼出し

表3-26に、jmstransportclientパラメータのパラメータを示します。

packageName

java.lang.String

いいえ

生成されたクライアント・インタフェースとスタブ・ファイルをパッケージ化するパッケージ名を指定します。

produce

produces

FileSet

List<FileSet>

いいえ

FileSetが1つのみあります。

FileSetが複数あります。

verbose

boolean

いいえ

冗長出力をオンにします

wsdl

java.lang.String

true

クライアント・コンポーネント・ファイルの生成が必要な(WebLogicまたは非WebLogic) Webサービスを記述するWSDLの絶対パス名またはURLを指定します。

wsdlLocation

java.lang.String

いいえ

WebServiceまたはWebServiceProviderアノテーションで生成されるwsdlLocation属性の値を制御します。

xauthfile

java.lang.String

いいえ

認可ファイルを指定します。

xmlCatalog

java.lang.String

いいえ

未使用


表3-24に、bindingsパラメータのパラメータを示します。

表3-24 Bindingのパラメータ

名前 タイプ 必須 説明

file

java.lang.String

いいえ

JAX-WSおよびJAXBカスタム・バインディング宣言またはSOAPハンドラ・ファイルを含むカスタマイズ・ファイルを指定します。


表3-25に、xmlCatalogパラメータのパラメータを示します。

表3-25 xmlCatalogのパラメータ

名前 タイプ 必須 説明

refid

java.lang.String

いいえ

ws-jwscゴールが、コンパイルするJWSファイルを検索するディレクトリ(セミコロン区切り)を指定します。


表3-26に、jmstransportclientパラメータのパラメータを示します。

表3-26 jmstransportclientのパラメータ

名前 タイプ 必須 説明

destinationName

java.lang.String

いいえ

宛先キューまたはトピックのJNDI名。デフォルト値はcom.oracle.webservices.jms.RequestQueueです。

destinationType

java.lang.String

いいえ

有効な値は次のとおりです: QUEUEまたはTOPIC。デフォルト値はQUEUEです。

replyToName

java.lang.String

いいえ

レスポンス・メッセージを送信するJMS宛先のJNDI名。

targetService

java.lang.String

いいえ

Webサービスのポート・コンポーネント名。

jndiInitialContextFactory

java.lang.String

いいえ

JNDIルックアップに使用される初期コンテキスト・ファクトリ・クラスの名前。デフォルト値はweblogic.jndi.WLInitialContextFactoryです。

jndiConnectionFactoryName

java.lang.String


JMS接続を確立するために使用される接続ファクトリのJNDI名。デフォルト値はcom.oracle.webservices.jms.ConnectionFactoryです。

jndiUrl

java.lang.String


JNDIプロバイダのURL。デフォルト値はt3://localhost:7001です。

deliveryMode

java.lang.String


リクエスト・メッセージが永続であるかどうかを示す配信モード。有効な値は、PERSISTENTおよびNON_PERSISTENTです。デフォルト値はPERSISTENTです。

timeToLive

long

いいえ

リクエスト・メッセージの存続期間(ミリ秒単位)。デフォルト値は180000Lです。

priority

int

いいえ

リクエストおよびレスポンス・メッセージに関連付けられたJMSの優先度。デフォルト値は0です。

jndiContextParameter

java.lang.String

いいえ

次のようなフォーマットのJNDIのプロパティ: someParameterName1=someValue1 , someParameterName2=someValue2

bindingVersion

java.lang.String

いいえ

SOAP JMSバインディングのバージョン。デフォルト値は1.0です。

runAsPrincipal

java.lang.String

いいえ

リスニングMDBを実行するために使用されるプリンシパル。

runAsRole

java.lang.String

いいえ

リスニングMDBを実行するために使用されるロール。

messageType

java.lang.String

いいえ

リクエスト・メッセージで使用するメッセージの種類。有効な値は、com.oracle.webservices.api.jms.JMSMessageType.BYTESおよびcom.oracle.webservices.api.jms.JMSMessageType.TEXTです。デフォルト値はBYTESです。

enableHttpWsdlAccess

boolean

いいえ

HTTPを介してWSDLをパブリッシュするかどうかを指定するブール・フラグ。デフォルト値はtrueです。

mdbPerDestination

boolean

いいえ

リクエストされた宛先ごとに1つのリスニング・メッセージドリブンBean (MDB)を作成するかどうかを指定するブール・フラグ。デフォルト値はtrueです。

activationConfig

java.lang.String

いいえ

JMSプロバイダに渡されたアクティブ化構成プロパティ。

contextPath

java.lang.String

いいえ

webサービスのデプロイされたコンテキスト。

serviceUri

java.lang.String

いいえ

URLのWebサービスURI部分。

portName

java.lang.String

いいえ

生成されたWSDLのポートの名前。


使用例

ws-clientgenゴールは、WSDLからクライアントWebサービス・アーティファクトを生成します。

このゴールは、構成より規則優先のアプローチのメリットを受けており、プロジェクトのデフォルトを使用して実行できます。

ws-clientgenゴールを実行するには、次の2つの方法があります。

  • コマンド・ラインからたとえば、別名を定義した後に次のように指定します。

    mvn –DvariableName1=value1  –DvariableName2=value2 com.oracle.weblogic:weblogic-maven-plugin:ws-clientgen
  • Maven generate-resourcesライフサイクル・フェーズを指定することにより。この場合、pom.xmlの同じディレクトリでmvn generate-resourcesを実行します。

    これを実行するには、pom.xmlファイルを変更して、generate-resourcesライフサイクル・フェーズ、ws-clientgenゴールを指定し、設定する必要があるパラメータを含めます。次のケースについて検討します。

    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <project>
      <modelVersion>4.0.0</modelVersion>
      <groupId>maven_plugin.simple</groupId>
      <artifactId>maven_plugin_simple</artifactId>
      <version>1.0</version>
      <build>
        <plugins>
          <plugin>
            <groupId>com.oracle.weblogic</groupId>
            <artifactId>weblogic-maven-plugin</artifactId>
            <version>12.1.3-0-0</version>
            <executions>
              <execution>
                <id>clientgen</id>
                <phase>generate-resources</phase>
                <goals>
                  <goal>ws-clientgen</goal>
                </goals>
                <configuration>
                 <wsdl>${basedir}/AddNumbers.wsdl</wsdl>
                  <dest${project.build.outputDirectory}</destDir>
                  <packageName>maven_plugin.simple.client</packageName>
                </configuration>
              </execution>
            </executions>
          </plugin>
        </plugins>
      </build>
    </project>
    

例3-25では、典型的なws-clientgenゴールの出力を示します。

例3-25 ws-clientgen

mvn -f C:\maven-doc\jwsc-test-2\clientgen_pom.xml generate-resources
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building maven_plugin_simple 1.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:ws-clientgen (clientgen) @ maven_plugin_sim
ple ---
[INFO] Executing standalone...
 
[INFO] Executing Maven goal 'clientgen'...
calling method public static void weblogic.wsee.tools.clientgen.MavenClientGen.e
xecute(org.apache.maven.plugin.logging.Log,java.util.Map) throws java.lang.Throw
able
[INFO] Consider using <depends>/<produces> so that wsimport won't do unnecessary
 compilation
[WARNING] parsing WSDL...
[WARNING]
[WARNING]
[WARNING]
[WARNING] Generating code...
[WARNING]
[WARNING]
[WARNING] Compiling code...
[WARNING]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS

wsgen

完全名

com.oracle.weblogic:weblogic-maven-plugin:wsgen

説明

JAX-WSサービスのエンドポイント実装クラスを読み取り、JAX-WS Webサービスで使用されるすべてのポータブル・アーティファクトを生成するMavenゴール。Javaクラスから起動する場合にwsgenゴールを使用します。

サービス・エンドポイント・インタフェースと実装クラス、値タイプおよび生成されたクラス(存在する場合)をWARファイルにパッケージ化し、そのWARをWebコンテナにデプロイできます。

wsgenゴールは、JAX-WS Maven wsgenプラグインのゴールにラッパーを提供します。

パラメータ

表3-27に、wsgenの各パラメータを示します。

表3-27 wsgenのパラメータ

名前 タイプ 必須 説明

args

java.lang.String

いいえ

コマンドライン・オプション(省略可能)を指定します。複数の要素を指定でき、各トークンは各自のリストに指定されている必要があります。

destDir

java.io.File

いいえ

生成された出力クラスの格納場所のフルパス名を指定します。これを無効にするには、xnocompileを使用します。デフォルトは${project.build.outputDirectory})です。

encoding

java.lang.String

いいえ

デプロイメント記述子またはXMLファイルなどの出力ファイルの文字エンコーディングを指定します。文字エンコーディングの例としては、SHIFT-JISやUTF-8などがあります。デフォルト値はプラットフォームに依存します。

extension

boolean

いいえ

extensionは常にtrueに設定されるので、ユーザーが設定する必要はありません。拡張機能はOracle JAX-WSベンダー拡張に限定されません。

executable

java.lang.String

いいえ

実行可能ファイルの名前。通常はwsgen

genWsdl

boolean

いいえ

WSDLファイルを${resourceDestDir}に生成すべきかどうかを指定します。デフォルトでは、WSDLは生成されません。

inlineSchemas

boolean

いいえ

生成されたWSDLにインライン・スキーマを生成します。デフォルトはfalseです。

genWsdlパラメータはtrueに設定する必要があります。

jmstransportservice

boolean

いいえ

WebサービスにJMSトランスポートを使用します。省略できます。jmstransportserviceパラメータの説明は、表3-35を参照してください。

keep

boolean

いいえ

生成されたファイルを保持するかどうかを指定します。デフォルトはtrueです。

metadata

java.io.File

いいえ

wsgenタスクのメタデータ・ファイル(『JAX-WS Release Documentation』「External Web Service Metadata」を参照)。一致しないファイルは無視されます。

portName

java.lang.String

いいえ

生成されたWSDLで使用するポート名を指定します。genWsdlパラメータはtrueに設定する必要があります。

protocol

java.lang.String

いいえ

genWsdlと組み合せて使用し、wsdl:bindingで使用するプロトコルを指定します。genWsdlパラメータはtrueに設定する必要があります。

有効な値は、soap1.1およびXsoap1.2です。

デフォルトはsoapのsoap1.1です。Xsoap1.2は標準ではないため、extensionオプションと組み合せないと使用できません。

resourceDestDir

java.io.File

いいえ

生成されたWSDLファイルの格納先ディレクトリを指定します。デフォルトは${project.build.directory}/generated-sources/wsdlです。genWsdlパラメータはtrueに設定する必要があります。

sei

java.lang.String

いいえ

サービス・エンドポイント実装クラスの名前を指定します。

servicename

java.lang.String

いいえ

生成されたWSDLで使用するサービス名(wsdl:servicename)を指定します。genWsdlパラメータはtrueに設定する必要があります。

sourceDestDir

java.io.File

いいえ

生成されるソース・ファイルを格納する場所を指定します。このパラメータを使用すると、keepもtrueに設定されます。デフォルトは${project.build.directory}/generated-sources/wsgenです。

verbose

boolean

いいえ

ツールが実行している処理に関するメッセージを出力します。
デフォルト値: false

vmArgs

java.util.List

いいえ

JVMオプション(省略可能)を指定します。複数の要素を指定でき、各トークンは各自のリストに指定されている必要があります。

xdonotoverwrite

boolean

いいえ

説明なし

xnocompile

boolean

いいえ

コード生成後のコンパイルを無効にし、生成されたソースがコンパイル・フェーズ中にMavenによってコンパイルされるようにします。デフォルトはfalseです。

このパラメータを使用すると、keepもtrueに設定されます。


使用例

wsgenゴールは、JAX-WSサービスのエンドポイント実装クラスを読み取り、JAX-WS Webサービスで使用されるすべてのポータブル・アーティファクトを生成します。

Mavenのprocess-classesライフサイクル・フェーズを指定します。その後で、POMファイルと同じディレクトリ内でmvn process-classesを実行します。

これを実行するには、pom.xmlファイルを変更して、process-classesライフサイクル・フェーズ、wsgenゴールを指定し、設定する必要があるパラメータを含めます。次のケースについて検討します。

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>maven_plugin.simple</groupId>
  <artifactId>maven_plugin_simple</artifactId>
  <version>1.0</version>
  <build>
  <sourceDirectory>.</sourceDirectory>
    <plugins>
      <plugin>
        <groupId>com.oracle.weblogic</groupId>
        <artifactId>weblogic-maven-plugin</artifactId>
        <version>12.1.3-0-0</version>
        <executions>
          <execution>
            <id>wsgen</id>
            <phase>process-classes</phase>
            <goals>
              <goal>wsgen</goal>
            </goals>
            <configuration>
              <destDir>${project.build.directory}/wsgenOutput/</destDir>
             <sei>myexample.IPInfo</sei>             
            <verbose>true</verbose>
            <genWsdl>true</genWsdl>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>

例3-26では、典型的なwsgenゴールの出力を示します。

例3-26 wsgen

mvn -Dfile=pom.xml process-classes
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building maven_plugin_simple 1.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-resources-plugin:2.5:resources (default-resources) @ maven_plug
in_simple ---
[debug] execute contextualize
[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources,
i.e. build is platform dependent!
[INFO] skip non existing resourceDirectory C:\Oracle\Middleware\Oracle_Home\orac
le_common\plugins\maven\com\oracle\maven\oracle-maven-sync\12.1.3\src\main\resou
rces
[INFO]
[INFO] --- maven-compiler-plugin:2.3.2:compile (default-compile) @ maven_plugin_
simple ---
[WARNING] File encoding has not been set, using platform encoding Cp1252, i.e. b
uild is platform dependent!
[INFO] Compiling 1 source file to C:\Oracle\Middleware\Oracle_Home\oracle_common
\plugins\maven\com\oracle\maven\oracle-maven-sync\12.1.3\target\classes
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:wsgen (wsgen) @ maven_plugin_simple
---
[INFO] Processing: myexample.IPInfo
[WARNING] Using platform encoding (Cp1252), build is platform dependent!
[INFO] jaxws:wsgen args: [-keep, -s, 'C:\Oracle\Middleware\Oracle_Home\oracle_co
mmon\plugins\maven\com\oracle\maven\oracle-maven-sync\12.1.3\target\generated-so
urces\wsgen', -d, 'C:\Oracle\Middleware\Oracle_Home\oracle_common\plugins\maven\
com\oracle\maven\oracle-maven-sync\12.1.3\target\wsgenOutput', -verbose, -extens
ion, -wsdl, -r, 'C:\Oracle\Middleware\Oracle_Home\oracle_common\plugins\maven\co
m\oracle\maven\oracle-maven-sync\12.1.3\target\generated-sources\wsdl', myexampl
e.IPInfo]
myexample\jaxws\GetIpAddress.java
myexample\jaxws\GetIpAddressResponse.java
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 21.309s
[INFO] Finished at: Mon Nov 11 16:53:07 EST 2013
[INFO] Final Memory: 8M/32M
[INFO] ------------------------------------------------------------------------

この例では、wsgenゴールによって次のファイルが作成されます。

target
  classes
   META-INF
      wsdl
        IPInfoService.wsdl
        IPInfoService_schema1.xsd  
      myexample
        IPInfo.class
  generated-sources
      wsdl 
        IPInfoService.wsdl
        IPInfoService_schema1.xsd
      wsgen
        myexample
          jaxws
            GetIpAddress.java
            GetIpAddressResponse.java
  wsgenoutput
        myexample
          jaxws
            GetIpAddress.class
            GetIpAddressResponse.class

wsimport

完全名

com.oracle.weblogic:weblogic-maven-plugin:wsimport

説明

WSDLファイルとバインディング・ファイルを解析し、そのアクセスに必要なJavaコードを生成するMavenゴール。WSDLから起動する場合にwsimportゴールを使用します。

wsimportゴールは、JAX-WS Maven wsimportゴールにラッパーを提供します。

パラメータ

表3-28に、wsimportの各パラメータを示します。

表3-28 wsimportのパラメータ

名前 タイプ 必須 説明

args

java.lang.String

いいえ

コマンドライン・オプション(省略可能)を指定します。複数の要素を指定でき、各トークンは各自のリストに指定されている必要があります。

bindingDirectory

java.io.File

いいえ

バインディング・ファイルが格納されているディレクトリ。

bindingFiles

java.util.List

いいえ

バインディングで使用するファイルのリスト。指定されていない場合、bindingDirectory内のすべての.xmlファイルが使用されます。

catalog

java.io.File

いいえ

外部エンティティ参照を解決するためのカタログ・ファイルで、TR9401、XCatalog、OASIS XML Catalogの各形式がサポートされています。

destDir

java.io.File

いいえ

生成された出力クラスの格納場所のフルパス名を指定します。これを無効にするには、xnocompileを使用します。デフォルトは${project.build.outputDirectory})です。

encoding

java.lang.String

いいえ

デプロイメント記述子またはXMLファイルなどの出力ファイルの文字エンコーディングを指定します。文字エンコーディングの例としては、SHIFT-JISやUTF-8などがあります。デフォルトはプラットフォームに依存します。

executable

java.lang.String

いいえ

実行可能ファイルの名前。通常はwsimport

extension

boolean

いいえ

extensionは常にtrueに設定されるので、ユーザーが設定する必要はありません。拡張機能はOracle JAX-WSベンダー拡張に限定されません。

genJWS

boolean

いいえ

スタブ化されたJWS実装ファイルを生成します。デフォルトはfalseです。

httpproxy

java.lang.String

いいえ

HTTP/HTTPSプロキシを設定します。形式は[user[:password]@]proxyHost[:proxyPort]です。

implDestDir

java.io.File

いいえ

JWS実装ファイルの生成場所を指定します。

implPortName

java.lang.String

いいえ

生成されたJWS実装のポート名のローカル部分。genJWS=trueを意味します。注意: これはQNameのString表現(形式: "{" + Namespace URI + "}" + ローカル部分)です。

implServiceName

java.lang.String

いいえ

生成されたJWS実装のサービス名のローカル部分。genJWS=trueを意味します。注意: これはQNameのString表現(形式: "{" + Namespace URI + "}" + ローカル部分)です。

jmstransportclient

JMSTransportClient

いいえ

JMSトランスポートを使用したWebLogic Webサービスの呼出し

表3-26に、jmstransportclientパラメータのパラメータを示します。

jmsUri

jmsUri

いいえ

WSDLファイルで定義されているjmsUriをオーバーライドします。extension=trueが必須です。

keep

boolean

いいえ

生成されたファイルを保持するかどうかを指定します。デフォルトはtrueです。

packageName

java.lang.String

いいえ

ソース・ファイルの生成先のパッケージ。

quiet

boolean

いいえ

wsimport出力を抑制します。デフォルトはfalseです。

sourceDestDir

java.io.File

いいえ

生成されるソース・ファイルを格納する場所を指定します。このパラメータを使用すると、keepもtrueに設定されます。デフォルトは${project.build.directory}/generated-sources/wsimportです。

staleFile

java.io.File

いいえ

出力が無効かどうかの判断に使用するフラグ・ファイルが格納されているフォルダ。

フォルダを指定しない場合、デフォルトは${project.build.directory}/jaxws/staleです。

target

java.lang.String

いいえ

指定のJAXWS仕様バージョンに従ってコードを生成します。"2.0"を設定すると、JAX-WSはJAX-WS 2.0ランタイムで実行するアーティファクトを生成します。

verbose

boolean

いいえ

ツールが実行している処理に関するメッセージを出力します。
デフォルト値: false

vmArgs

java.lang.String

いいえ

JVMオプション(省略可能)を指定します。複数の要素を指定でき、各トークンは各自のリストに指定されている必要があります。

wsdlDirectory

java.io.File

いいえ

WSDLファイルが格納されているディレクトリ。

wsdlFiles

java.util.List

いいえ

WSDLで使用するファイルのリスト。指定されていない場合、wsdlDirectory内のすべての.wsdlファイルが使用されます。

wsdlLocation

java.lang.String

いいえ

@WebService.wsdlLocationおよび@WebServiceClient.wsdlLocation値です。

指定したwsdlLocationにWSDLの相対パスが追加される場合は、アスタリスクで終わることができます。

例:

...
 <configuration>
     <wsdlDirectory>src/mywsdls</wsdlDirectory>
     <wsdlFiles>
         <wsdlFile>a.wsdl</wsdlFile>
         <wsdlFile>b/b.wsdl</wsdlFile>
         <wsdlFile>${basedir}/src/mywsdls/c.wsdl</wsdlFile>
     </wsdlFiles>
     <wsdlLocation>http://example.com/mywebservices/*</wsdlLocation>
 </configuration>
 ...

a.wsdlwsdlLocation: http://example.com/mywebservices/a.wsdl

b/b.wsdlwsdlLocation: http://example.com/mywebservices/b/b.wsdl

${basedir}/src/mywsdls/c.wsdlwsdlLocation: file://absolute/path/to/c.wsdl

注意: アスタリスク表記が使用されている場合、外部バインディング・ファイルは使用できません。

wsdlUrls

java.util.List

いいえ

コンパイルされる外部WSDLのURLのリスト。

xadditionalHeaders

boolean

いいえ

リクエストまたはレスポンス・メッセージにバインドされていないヘッダーをJavaメソッド・パラメータにマップします。

xauthFile

java.io.File

いいえ

認証ファイルの場所を指定します。

xdebug

boolean

いいえ

デバッグ・メッセージを有効にします。デフォルトはfalseです。

xdisableAuthenticator

boolean

いいえ

JAX-WS RIが使用するオーセンティケータを無効化します(これを設定すると、xauthfileは無視されます)。

xdisableSSLHostnameVerification

boolean

いいえ

WSDLのフェッチ中のSSLホスト名検証を無効化します。

xjcArgs

java.util.List

いいえ

WsImportコマンドの-Bオプションを使用してxjcに単に渡される、XJC固有のオプション・パラメータを指定します。

複数の要素を指定でき、各トークンは各自のリストに指定されている必要があります。

xnoAddressingDataBinding

boolean

いいえ

W3C EndpointReferenceTypeをJavaにバインドします。デフォルトでは、WsImportは仕様に従ってEndpointReferenceTypeをJavaにバインドせずに、仕様で提供されているW3CEndpointReferenceを使用します。

xnocompile

boolean

いいえ

コード生成後のコンパイルを無効にし、生成されたソースがコンパイル・フェーズ中にMavenによってコンパイルされるようにします。デフォルトはtrueです。

このパラメータを使用すると、keepもtrueに設定されます。

xuseBaseResourceAndURLToLoadWSDL

boolean

いいえ

JAX-WS Maven wsimportによる説明はありません。


使用例

wsimportゴールは、WSDLファイルとバインディング・ファイルを解析し、Webサービスのアクセスに必要なJavaコードを生成します。

wsimportゴールを使用するには、2つの方法があります。

  • クライアント側アーティファクトを生成する方法。この場合は、Webサービスを呼び出すクライアントを実装します。

  • Webサービスの実装を独自に作成する方法。wsimportゴールをgenJWSパラメータとともに使用して、ポータブル・アーティファクトとスタブ化された実装ファイルを生成します。その後で、サービス・エンドポイントを実装します。

Mavenのgenerate-sourcesライフサイクル・フェーズを指定します。その後で、POMファイルと同じディレクトリ内でmvn generate-sourcesを実行します。

たとえば、例3-27で示したWSDLをインポートする必要があるとします。

例3-27 インポートするWSDL

<?xml version='1.0' encoding='UTF-8'?><!-- Published by JAX-WS RI at
 http://jax-ws.dev.java.net. RI's version is JAX-WS RI 2.2.9-b14041
 svn-revision#14041. --><!-- Generated by JAX-WS RI at
 http://jax-ws.dev.java.net. RI's version is JAX-WS RI 2.2.9-b14041
 svn-revision#14041. --><definitions
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-uti
lity-1.0.xsd" xmlns:wsp="http://www.w3.org/ns/ws-policy" xmlns:wsp1_
2="http://schemas.xmlsoap.org/ws/2004/09/policy"
 xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata"
 xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
 xmlns:tns="http://ws.web.wls.my.org/"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns="http://schemas.xmlsoap.org/wsdl/"
 targetNamespace="http://ws.web.wls.my.org/" name="SampleWs">
    <types>
        <xsd:schema>
            <xsd:import namespace="http://ws.web.wls.my.org/" schemaLocation="x.xsd"/>
        </xsd:schema>
    </types>
    <message name="hello">
        <part name="parameters" element="tns:hello"/>
    </message>
    <message name="helloResponse">
        <part name="parameters" element="tns:helloResponse"/>
    </message>
    <portType name="SampleWs">
        <operation name="hello">
            <input wsam:Action="http://ws.web.wls.my.org/SampleWs/helloRequest" message="tns:hello"/>
            <output wsam:Action="http://ws.web.wls.my.org/SampleWs/helloResponse" message="tns:helloResponse"/>
        </operation>
    </portType>
    <binding xmlns:soapjms="http://www.w3.org/2010/soapjms/" name="SampleWsPortBinding" type="tns:SampleWs">
        <soapjms:jndiInitialContextFactory>weblogic.jndi.WLInitialContextFactory</soapjms:jndiInitialContextFactory>
        <soapjms:jndiConnectionFactoryName>com.oracle.webservices.api.jms.ConnectionFactory</soapjms:jndiConnectionFactoryName>
        <soapjms:jndiUrl>t3://localhost:7001</soapjms:jndiUrl>
        <soapjms:bindingVersion>SOAP_JMS_1_0</soapjms:bindingVersion>
        <soapjms:destinationName>com.oracle.webservices.api.jms.RequestQueue</soapjms:destinationName>
        <soapjms:targetService>SampleWs</soapjms:targetService>
        <soapjms:timeToLive>180000</soapjms:timeToLive>
        <soapjms:deliveryMode>PERSISTENT</soapjms:deliveryMode>
        <soapjms:priority>0</soapjms:priority>
        <soapjms:messageType>BYTES</soapjms:messageType>
        <soapjms:destinationType>QUEUE</soapjms:destinationType>
        <soap:binding transport="http://www.w3.org/2010/soapjms/" style="document"/>
        <operation name="hello">
            <soap:operation soapAction=""/>
            <input>
                <soap:body use="literal"/>
            </input>
            <output>
                <soap:body use="literal"/>
            </output>
        </operation>
    </binding>
    <service name="SampleWs">
        <port name="SampleWsPort" binding="tns:SampleWsPortBinding">
            <soap:address location="jms:jndi:com.oracle.webservices.api.jms.RequestQueue?targetService=Sampl
eWs&amp;jndiURL=t3://localhost:7001&amp;messageType=BYTES&amp;deliveryMode=PERSISTENT"/>
        </port>
    </service>
</definitions>

このWSDLをインポートするには、pom.xmlファイルを変更して、generate-sourcesライフサイクル・フェーズ、wsimportゴール、WSDLの場所を指定し、設定する必要があるパラメータを含めます。この例では、説明上、ローカルのWSDLファイルを使用します。

次のケースについて検討します。

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>maven_plugin.simple</groupId>
  <artifactId>maven_plugin_simple</artifactId>
  <version>1.0</version>
  <build>
   <plugins>
      <plugin>
        <groupId>com.oracle.weblogic</groupId>
        <artifactId>weblogic-maven-plugin</artifactId>
        <version>12.1.3-0-0</version>
        <executions>
          <execution>
          <id>wsimport-jmssample</id>
           <goals>
           <goal>wsimport</goal>
           </goals>
            <phase>generate-sources</phase>
            <configuration>
               <wsdlFiles>
                 <wsdlFile>${basedir}/import-example/SampleWs.wsdl</wsdlFile>
               </wsdlFiles>
               <genJWS>true</genJWS>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>

例3-28では、典型的なwsimportゴールの出力を示します。

例3-28 wsimport

mvn -Dfile=pom.xml generate-sources
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building maven_plugin_simple 1.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:wsimport (wsimport-jmssample) @ mave
n_plugin_simple ---
[INFO] Processing: file:/C:/Oracle/Middleware..../import-example/SampleWs.wsdl
[WARNING] Using platform encoding (Cp1252), build is platform dependent!
[INFO] jaxws:wsimport args: [-keep, -s,
'C:\Oracle\Middleware\...\import-example\target\generated-sources\wsimport', -d,
 'C:\Oracle\Middleware...\import-example\target\classes', -extension,
 -Xnocompile, -jms, -jmsuri, jms:jndi:null?targetServi
ce=null, -httpproxy:some-proxy-name, -generateJWS, -implDestDir, 
'C:\Oracle\Middleware...\import-example',
"file:/C:/Oracle/Middleware...import-example/SampleWs.wsdl"]
parsing WSDL...
 
 
 
Generating code...
 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 20.888s
[INFO] Finished at: Wed Nov 13 14:33:39 EST 2013
[INFO] Final Memory: 7M/23M
[INFO] ------------------------------------------------------------------------

この例では、wsimportゴールによって次のファイルが作成されます。

org
  my
   wls
    web
     ws
      SampleWs_SampleWsPortImpl.java
target
  classes
  generated-sources
   wsimport
    org
     my
      wls
       web
        ws
         Hello.java
         HelloResponse.java
         ObjectFactory.java
         package-info.java
         SampleWs.java
         SampleWs_Service.java
  jaxws
   stale
    .2b48c6ef28bc8a45aa2da4246c0c4ac90cf82c57

ws-wsdlc

完全名

com.oracle.weblogic:weblogic-maven-plugin:ws-wsdlc

説明

WSDLから一連のアーティファクトと、Webサービスの部分的なJava実装を生成するMavenゴール。

ws-wsdlcゴールは、"wsdlc" Antタスク用のMavenラッパーを提供します。これは、『Oracle WebLogic Server WebLogic Webサービス・リファレンス』に説明されています。

パラメータ

表3-29に、ws-wsdlcのパラメータについて簡単にまとめます。これらのパラメータは、『Oracle WebLogic Server WebLogic Webサービス・リファレンス』の表2-3 「clientgen AntタスクのWebLogic固有の属性」で詳しく説明されています。

表3-29 ws-wsdlcのパラメータ

名前 タイプ 必須 説明

bindings

java.lang.String

いいえ

JAX-WSおよびJAXBカスタム・バインディング宣言またはSOAPハンドラ・ファイルを指定するカスタマイズ・ファイル。

catalog

java.lang.String

いいえ

外部XMLカタログ・ファイルを指定します。

XMLカタログ・ファイルの作成の詳細は、『Oracle WebLogic Server JAX-WS Webサービスの開発』のXMLカタログの使用に関する項を参照してください。

debug

boolean

いいえ

プロセスをデバッグするときに設定するフラグを指定します。デフォルト値はfalseです。

debugLevel

java.lang.String

いいえ

Antデバッグレベルを使用します。

destImplDir

java.lang.String

いいえ

途中まで作成済のJWS実装ファイルの生成先となるディレクトリを指定します。

destJavadocDir

java.lang.String

いいえ

JWSインタフェースを記述するJavadocの生成先となるディレクトリを指定します。

destJwsDir

java.lang.String

true

JWSインタフェース・ファイルおよびデータ・バインディング・アーティファクトを格納するJARファイルの生成先となるディレクトリを指定します。。

explode

boolean

いいえ

展開された出力を必要とする場合に設定するフラグを指定します。デフォルトはtrueです。

failOnError

boolean

いいえ

ws-clientgenゴールが、エラー発生時にも実行し続けるかどうかを指定します。デフォルト値はtrueです。

fork

boolean

いいえ

外部でJDKコンパイラを使用してjavacを実行するかどうかを指定します。デフォルト値はfalseです。

includeAntRuntime

boolean

いいえ

Antランタイム・ライブラリをクラスパスに含めるかどうかを指定します。デフォルト値はtrueです。

includeJavaRuntime

boolean

いいえ

実行するVMのデフォルトのランタイム・ライブラリをクラスパスに含めるかどうかを指定します。デフォルト値はfalseです。

optimize

boolean

いいえ

最適化を必要とする場合に設定するフラグを指定します。デフォルトはtrueです。

packageName

java.lang.String

いいえ

生成されたJWSインタフェースおよび実装ファイルの生成先となるパッケージを指定します。

srcPortName

java.lang.String

いいえ

JWSインタフェース・ファイルの生成元になるWSDLポートの名前を指定します。このパラメータの値は、JWSインタフェース・ファイルの生成対象のWebサービス・ポートに対応するportパラメータのnameパラメータの値に設定します。

portパラメータは、WSDLファイル内のserviceパラメータの子です。この属性を指定しない場合、ws-wsdlcは、srcServiceNameによって指定されるサービスからJWSインタフェース・ファイルを生成します。

srcServiceName

java.lang.String

いいえ

JWSインタフェース・ファイルの生成元になるWebサービスの名前を指定します。

srcWsdl

java.lang.String

true

JWSインタフェースとデータ・バインディング・アーティファクトを格納するJARファイルの生成に使用するWSDLファイルの名前を指定します。

verbose

boolean

いいえ

冗長出力を必要とする場合に設定するフラグを指定します。デフォルト値はfalseです。


使用例

ws-wsdlcゴールは、WSDLから一連のアーティファクトと、Webサービスの部分的なJava実装を生成します。

このゴールは、構成より規則優先のアプローチのメリットを受けており、プロジェクトのデフォルトを使用して実行できます。

ws-wsdlcゴールを実行するには、次の2つの方法があります。

  • コマンド・ラインからたとえば、別名を定義した後に次のように指定します。

    mvn –DvariableName1=value1  –DvariableName2=value2  com.oracle.weblogic:weblogic-maven-plugin:ws-wsdlc
  • Maven generate-resourcesライフサイクル・フェーズを指定することにより。

    これを実行するには、pom.xmlファイルを変更して、generate-resourcesライフサイクル・フェーズ、ws-wsdlcゴールを指定し、設定する必要があるパラメータを含めます。この場合、pom.xmlの同じディレクトリでmvn generate-resourcesを実行します。

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>maven_plugin.simple</groupId>
  <artifactId>maven_plugin_simple</artifactId>
  <version>1.0</version>
  <build>
    <plugins>
      <plugin>
        <groupId>com.oracle.weblogic</groupId>
        <artifactId>weblogic-maven-plugin</artifactId>
        <version>12.1.3-0-0</version>
        <executions>
          <execution>
            <id>wsdlc</id>
            <phase>generate-resources</phase>
            <goals>
              <goal>ws-wsdlc</goal>
            </goals>
            <configuration>
              <srcWsdl>${basedir}/AddNumbers.wsdl</srcWsdl>
              <destJwsDir>${project.build.directory}/jwsImpl</destJwsDir>
              <destImplDir>${project.build.directory}/output</destImplDir>
              <packageName>maven_plugin.simple</packageName>
              <verbose>true</verbose>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>

例3-29では、典型的なws-wsdlcゴールの出力を示します。

例3-29 ws-wsdlc

mvn -f wsdlc_pom.xml generate-resources
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building maven_plugin_simple 1.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:ws-wsdlc (wsdlc) @ maven_plugin_simple ---
[INFO] Executing standalone...
 
[INFO] Executing Maven goal 'wsdlc'...
calling method public static void weblogic.wsee.tools.wsdlc.MavenWsdlc.execute(o
rg.apache.maven.plugin.logging.Log,java.util.Map) throws java.lang.Throwable
Catalog dir = C:\Users\maven\AppData\Local\Temp\_ckr59b
Download file [AddNumbers.wsdl] to C:\Users\maven\AppData\Local\Temp\_ckr59b
srcWsdl is redefined as [ C:\Users\maven\AppData\Local\Temp\_ckr59b\AddNumber
s.wsdl ]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS

ws-jwsc

完全名

com.oracle.weblogic:weblogic-maven-plugin:ws-jwsc

説明

JAX-WS webサービスを構築するMavenゴール。

ws-jwscゴールは、"jwsc" Antタスク用のMavenラッパーを提供します。これは、『Oracle WebLogic Server WebLogic Webサービス・リファレンス』に説明されています。


注意:

ws-jwscゴールは、WebLogic固有のアノテーションに関する項に説明されているJAX-RPC-のみのJWSアノテーションとは連携しません。

module要素のネストされた設定

ws-jwscゴールは、例3-30の太字で示されているように、ネストされた設定の要素をサポートしています。複数のmoduleを含むMavenプロジェクトの詳細は、POMの概要に関する項を参照してください。

例3-30 ネストされた設定の要素

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.test.ws</groupId>
  <artifactId>test-ws-jwsc1</artifactId>
  <version>1.0</version>
  <build>
    <plugins>
      <plugin>
        <groupId>com.oracle.weblogic</groupId>
        <artifactId>weblogic-maven-plugin</artifactId>
        <version>12.1.3-0-0</version>
        <executions>
          <execution>
            <id>first-jwsc</id>
            <phase>generate-resources</phase>
            <goals>
              <goal>ws-jwsc</goal>
            </goals>
            <configuration>
              <srcDir>${basedir}/src/main/java</srcDir>
            <destDir>${project.build.directory}/jwscOutput
                  /${project.build.finalName}</destDir>
              <listfiles>true</listfiles>
              <debug>true</debug>
              
                <module>
                  <name>pocreate</name>
                  <contextPath>mypub</contextPath>
                  <compiledWsdl>D:\maven-test\order_wsdl.jar</compiledWsdl >
                  
                    <jws>
                      <file>examples/wsee/jwsc/POCreateImpl.java</file>
                       <transportType>
                         <type>WLHttpTransport</type>
                         <serviceUri>POCreate</serviceUri>
                         <portName>POCreatePort</portName>
                       </transportType>
                    </jws>
                    <jws></jws>
                   <descriptors>
                     <descriptor>"resources/web.xml"<descriptor/>
                     <descriptor>"resources/weblogic.xml"<descriptor />
                   </descriptors>
                </module>
                <module></module>
              </modules>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>    
</project>

ws-jwscに対するこれらのネストされた設定の要素には、次の条件があります。

  • 次の要素のうちの少なくとも1つを使用する必要があります: jwsjwsesmodule、またはmodules

  • jwsesmodules要素などのcollection要素は省略できます。

  • collection要素内に子要素が1つのみある場合、そのcollection要素も削除できます。

    たとえば、jws要素が1つのみある場合、jwsを使用します。複数のjws要素がある場合は、jwses要素の下にすべてのjws要素を追加します。

  • JWSCやタスクと同様に、modulejwsの子要素が1つのみある場合、moduleのその他のサブ要素は、jwscjwsc/transportTypeにネストされます。

例3-31は、jwsパラメータがws-jwscの子となっているmodule要素がない例を示しています。

例3-31 ws-jwscゴールの子としてのjws要素

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.test.ws</groupId>
  <artifactId>test-ws-jwsc</artifactId>
  <version>1.0</version>
  <build>
    <plugins>
      <plugin>
        <groupId>com.oracle.weblogic</groupId>
        <artifactId>weblogic-maven-plugin</artifactId>
        <version>12.1.3-0-0</version>
        <executions>
          <execution>
            <id>first-jwsc</id>
            <phase>compile</phase>
            <goals>
              <goal>ws-jwsc</goal>
            </goals>
            <configuration>
              <srcDir>${basedir}/src/main/java</srcDir>
              <destDir>${project.build.directory}/jwscOutput/
                  ${project.build.finalName}</destDir>
              <jws>            <!-- no parent <module> -->
                <file>examples/wsee/jwsc/POCreateImpl.java</file>
                  <compiledWsdl>${project.build.directory}/purchaseorder_wsdl.jar>
                 <transportType>
                   <type>WLHttpTransport</type>
                 </transportType>
              </jws>
            </configuration>
          </execution>       
        </executions>
      </plugin>
    </plugins>
  </build>
</project>

ws-jwscのパラメータ

表3-30に、ws-jwscのパラメータについて簡単にまとめます。これらのパラメータは、『Oracle WebLogic Server WebLogic Webサービス・リファレンス』の表2-3 「clientgen AntタスクのWebLogic固有の属性」で詳しく説明されています。

表3-30 ws-jwscのパラメータ

名前 タイプ 必須 説明

applicationXml

java.lang.String

いいえ

エンタープライズ・アプリケーションのapplication.xmlデプロイメント記述子の完全修飾名およびフルパスを指定します。既存のファイルを指定した場合、ws-jwscゴールは、Webサービス情報を含めるようにそのファイルを更新します。ただし、jwscは、変更されたapplication.xmlファイルをdestDirに自動的にコピーしません。このファイルをdestDIRに手動でコピーする必要があります。ファイルが存在しない場合、jwscはファイルを作成します。

ws-jwscゴールは、対応するweblogic-application.xmlファイルも同じディレクトリで作成または更新します。この属性を指定しなかった場合、jwscは、destDir/META-INF/application.xml (destDirはjwsc属性)ファイルを作成または更新します。

debug

boolean

いいえ

追加のデバッグ出力をオンにします。

destDir

java.lang.String

true

コンパイルしたJWSファイル、XMLスキーマ、WSDL、生成されたデプロイメント記述子ファイルを含む、JARファイルまたはWARファイルにパッケージ化された全ファイルを格納するディレクトリの絶対パス名を指定します。

destEncoding

java.lang.String

いいえ

デプロイメント記述子またはXMLファイルなどの出力ファイルの文字エンコーディングを指定します。文字エンコーディングの例としては、SHIFT-JISやUTF-8などがあります。この属性のデフォルト値はUTF-8です。

jws

Jws

いいえ

<jws>要素が1つのみあります。

jwsパラメータの説明は、表3-31を参照してください。

jwses

Jws

いいえ

< jws>要素が複数含まれます。

keepGenerated

boolean

いいえ

このゴールで生成されたJavaソース・ファイルおよびアーティファクトがすでに存在する場合、それを再生成するかどうかを指定します。

falseを指定すると、新しいJavaソース・ファイルとアーティファクトが常に生成され、既存のアーティファクトがすべて上書きされます。trueを指定すると、ゴールによって、既存のアーティファクトのタイムスタンプに基づき、変更のあったアーティファクトのみが再生成されます。

listfiles

boolean

いいえ

すべてのファイルをリストするかどうかを指定します。

module

Module

いいえ

1つの<module>要素が含まれます。

moduleパラメータの説明は、表3-32を参照してください。

modules

Module

いいえ

<module>要素が複数含まれます。

optimize

boolean

いいえ

最適化が必要な場合に設定するフラグを指定します。デフォルトはtrueです。

sourcepath

java.lang.String

true

パラメータとして使用されるJavaBeanやユーザー定義の例外など、JWSファイルで参照されるJavaファイルを格納する最上位ディレクトリのフルパス名。

srcDir

java.lang.String

true

コンパイルするJWSファイルを含む最上位ディレクトリの絶対パス名を指定します。

srcEncoding

java.lang.String

いいえ

JWSファイルまたは構成XMLファイルなどの入力ファイルの文字エンコーディングを指定します。

文字エンコーディングの例としては、SHIFT-JISやUTF-8などがあります。この属性のデフォルト値は、JVMに対する文字エンコーディング・セットです。

verbose

boolean

いいえ

冗長出力を指定します


jwsのパラメータ

「jws」で説明されているように、jwsパラメータでは、特定のWebサービスを実装するJWSファイルの名前を指定します。ws-jwscゴールは、このWebサービス向けにJavaコードとサポート・アーティファクトを生成し、エンタープライズ・アプリケーション内でデプロイ可能なWARファイルにパッケージ化します。

次の2つの方法でjwsパラメータを指定できます。

  • ws-jwscゴールの直接の子要素。この場合、ws-jwscは各JWSファイルに個別のWARファイルを生成します。一般的に、ws-jwscゴールに対してJWSファイルを1つのみ指定している場合にこの方法を使用します。

  • moduleパラメータの子要素。同様に、ws-jwscゴールの子でもあります。この場合、ws-jwscは、moduleパラメータ内でグループ化されているすべてのJWSファイルの生成されたコードおよびアーティファクトをすべて含むWARファイルを1つ生成します。

    この方法は、共通のJavaデータ型など、サポート・ファイルをすべてのJWSファイルで共有する場合に有効です。

表3-31に、jwsパラメータの子パラメータを示します。この表では、jwsws-jwscの子である場合、moduleの子である場合、またはその両方の場合にパラメータが適用されるかどうかを説明しています。

表3-31 jwsのパラメータ

名前 タイプ 必須 説明 ws-jwsc、module、または両方の子

compiledWsdl

java.lang.String

いいえ

既存のWSDLファイルに基いてws-wsdlcゴールによって生成されるJARファイルの絶対パス名を指定します。

「WSDLから開始する」ケースでのみ必須

両方

contextPath

java.lang.String

いいえ

webサービスのデプロイされたコンテキストを指定します。

ws-jwsc

explode

boolean

いいえ

展開された出力を必要とする場合に設定するフラグを指定します。デフォルトはtrueです。

ws-jwsc

file

java.lang.String

true

コンパイルするJWSファイルの名前。ws-jwscゴールは、srcdirディレクトリにあるファイルを検索します。

両方

generateWsdl

boolean

true

生成されたWARファイルにWEB-INFディレクトリのWSDLファイルを含めるかどうかを指定します。デフォルト値はfalseです。

両方

jmstransportservice

boolean

いいえ

WebサービスにJMSトランスポートを使用します。省略できます。jmstransportserviceパラメータの説明は、表3-35を参照してください。

ws-jwsc

name

java.lang.String

いいえ

生成されたWARファイル(explode属性がtrueに設定されている場合は展開ディレクトリ)で、デプロイ可能なWebサービスを格納しているファイルの名前を指定します。

ws-jwsc

transportType

transportType

いいえ

トランスポート・タイプ要素が1つのみ含まれる場合に使用されます。省略できます。

transportTypeパラメータの説明は、表3-34を参照してください。

両方

transportTypes

transportType

いいえ

トランスポート・タイプ要素が複数含まれる場合に使用されます。省略できます。

transportTypeパラメータの説明は、表3-34を参照してください。

両方

wsdlOnly

boolean

いいえ

このJWSファイルに対してWSDLファイルのみが生成されるように指定します。デフォルト値はfalseです。

ws-jwsc


moduleのパラメータ

「module」で説明されているように、moduleパラメータは1つ以上のjwsパラメータをまとめてグループ化し、それらの生成されたコードまたはアーティファクトを単一のWebアプリケーション(WAR)ファイルにパッケージ化します。moduleパラメータは、ws-jwscゴールの子です。

表3-32に、moduleパラメータのパラメータを示します。

表3-32 moduleのパラメータ

名前 タイプ 必須 説明

clientgen

java.lang.String

いいえ

<clientgen>要素が1つのみあります。省略できます。

clientgens

java.lang.String

いいえ

<clientgen>要素が複数あります。省略できます。

contextPath

java.lang.String

いいえ

Webサービスのデプロイされたコンテキストを指定します。

descriptor

java.lang.String

いいえ

新しいweb.xml記述子を生成しない場合に使用するweb.xml記述子を指定します。パスは完全修飾する必要があります。複数のファイルは", "で区切る必要があります。

ejbWsInWar

boolean

いいえ

EJBベースのWebサービスを、JARファイルではなくWARファイルにパッケージ化するかどうかを指定します。

explode

boolean

いいえ

展開された出力を必要とする場合に設定するフラグを指定します。デフォルトはtrueです。

FileSet

FileSet

いいえ

1つのFileSet要素が含まれる場合に使用されます。省略できます。

FileSets

FileSet

いいえ

FileSet要素が複数含まれる場合に使用されます。省略できます。

generateWsdl

boolean

true

生成されたWARファイルにWEB-INFディレクトリのWSDLファイルを含めるかどうかを指定します。デフォルト値はfalseです。

jws

Jws

いいえ

1つのjws要素が含まれる場合に使用されます。省略できます。

jwses

Jws

いいえ

jws要素が複数含まれる場合に使用されます。省略できます。

name

java.lang.String

いいえ

earファイルを評価するときに使用するWARの名前を指定します。

wsdlOnly

boolean

いいえ

このJWSファイルに対してWSDLファイルのみが生成されるように指定します。デフォルト値はfalseです。

zipfileset

java.lang.String

いいえ

<zipfileset>要素が1つのみあります。


FileSetのパラメータ

「fileset」で説明されているように、FileSetパラメータは、ws-jwscゴールが、コンパイルするJWSファイルを検索する1つ以上のディレクトリを指定します。この場合、ws-jwscが検索するJWSファイルのリストは、各ファイルがmodulejwsパラメータで個別に指定されているように扱われます。

FileSetパラメータは、ws-jwscゴールの子です。

表3-33に、FileSetパラメータのパラメータを示します。

表3-33 FileSetのパラメータ

名前 タイプ 必須 説明

srcDir

java.lang.String

true

ws-jwscゴールが、コンパイルするJWSファイルを検索するディレクトリ(セミコロン区切り)を指定します。

prefix

java.lang.String

いいえ

使用する接頭辞。

sourceIncludes

java.lang.String

いいえ

ファイル・セットに対する明示的なincludes-listを指定します。

sourceExcludes

java.lang.String

いいえ

ファイル・セットに対する明示的なexcludes-listを指定します。


TransportTypeのパラメータ

「WLHttpTransport」、「WLHttpsTransport」および「WLJMSTransport」で説明されているように、トランスポート・パラメータを使用して、生成されたWSDLのポート名に加え、Webサービスを呼び出すために使用するトランスポート・タイプ、コンテキスト・パスおよびURLのサービスURIセクションを指定します。

ws-jwscゴールは、これらのトランスポート・パラメータを1つのTransportTypeに結合します。

表3-33に、transportTypeパラメータのパラメータを示します。

表3-34 transportTypeのパラメータ

名前 タイプ 必須 説明

transportTypeName

java.lang.String

true

値がWLHttpTransport、WLHttpsTransport、またはWLJMSTransportであることを指定します。

デフォルト値はWLHttpTransportです。

serviceUri

java.lang.String

いいえ

URLのWebサービスURI部分を指定します。

contextPath

java.lang.String

いいえ

Webサービスのデプロイされたコンテキストを指定します。

portName

java.lang.String

いいえ

生成されたWSDLのポートの名前を指定します。


表3-35に、jmstransportserviceパラメータのパラメータを示します。

表3-35 jmstransportserviceのパラメータ

名前 タイプ 必須 説明

destinationName

java.lang.String

いいえ

宛先キューまたはトピックのJNDI名。デフォルト値はcom.oracle.webservices.jms.RequestQueueです。

destinationType

java.lang.String

いいえ

有効な値は次のとおりです: QUEUEまたはTOPIC。デフォルト値はQUEUEです。

replyToName

java.lang.String

いいえ

レスポンス・メッセージを送信するJMS宛先のJNDI名。

targetService

java.lang.String

いいえ

Webサービスのポート・コンポーネント名。

jndiInitialContextFactory

java.lang.String

いいえ

JNDIルックアップに使用される初期コンテキスト・ファクトリ・クラスの名前。デフォルト値はweblogic.jndi.WLInitialContextFactoryです。

jndiConnectionFactoryName

java.lang.String


JMS接続を確立するために使用される接続ファクトリのJNDI名。デフォルト値はcom.oracle.webservices.jms.ConnectionFactoryです。

jndiUrl

java.lang.String


JNDIプロバイダのURL。デフォルト値はt3://localhost:7001です。

deliveryMode

java.lang.String


リクエスト・メッセージが永続であるかどうかを示す配信モード。有効な値は、PERSISTENTおよびNON_PERSISTENTです。デフォルト値はPERSISTENTです。

timeToLive

long

いいえ

リクエスト・メッセージの存続期間(ミリ秒単位)。デフォルト値は180000Lです。

priority

int

いいえ

リクエストおよびレスポンス・メッセージに関連付けられたJMSの優先度。デフォルト値は0です。

jndiContextParameter

java.lang.String

いいえ

次のようなフォーマットのJNDIのプロパティ: someParameterName1=someValue1 , someParameterName2=someValue2

bindingVersion

java.lang.String

いいえ

SOAP JMSバインディングのバージョン。デフォルト値は1.0です。

runAsPrincipal

java.lang.String

いいえ

リスニングMDBを実行するために使用されるプリンシパル。

runAsRole

java.lang.String

いいえ

リスニングMDBを実行するために使用されるロール。

messageType

java.lang.String

いいえ

リクエスト・メッセージで使用するメッセージの種類。有効な値は、com.oracle.webservices.api.jms.JMSMessageType.BYTESおよびcom.oracle.webservices.api.jms.JMSMessageType.TEXTです。デフォルト値はBYTESです。

enableHttpWsdlAccess

boolean

いいえ

HTTPを介してWSDLをパブリッシュするかどうかを指定するブール・フラグ。デフォルト値はtrueです。

mdbPerDestination

boolean

いいえ

リクエストされた宛先ごとに1つのリスニング・メッセージドリブンBean (MDB)を作成するかどうかを指定するブール・フラグ。デフォルト値はtrueです。

activationConfig

java.lang.String

いいえ

JMSプロバイダに渡されたアクティブ化構成プロパティ。

contextPath

java.lang.String

いいえ

webサービスのデプロイされたコンテキスト。

serviceUri

java.lang.String

いいえ

URLのWebサービスURI部分。

portName

java.lang.String

いいえ

生成されたWSDLのポートの名前。


使用例

ws-jwscゴールは、JAX-WS webサービスを構築します。

このゴールは、構成より規則優先のアプローチのメリットを受けており、プロジェクトのデフォルトを使用して実行できます。

ws-jwscゴールを実行するには、Maven generate-resourcesフェーズを指定します。

これを実行するには、pom.xmlファイルを変更して、generate-resourcesフェーズ、ws-jwscゴールを指定し、設定する必要があるpaパラメータを含めます。この場合、pom.xmlの同じディレクトリでmvn generate-resourcesを実行します。

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>maven_plugin.simple</groupId>
  <artifactId>maven_plugin_simple</artifactId>
  <version>1.0</version>
  <build>
    <plugins>
      <plugin>
        <groupId>com.oracle.weblogic</groupId>
        <artifactId>weblogic-maven-plugin</artifactId>
        <version>12.1.3-0-0</version>
        <executions>
          <execution>
            <id>jwsc</id>
            <phase>generate-resources</phase>
            <goals>
              <goal>ws-jwsc</goal>
            </goals>
            <configuration>
              <destDir>${project.build.directory}/jwscOutput/
              <listfiles>true</listfiles>
              <debug>true</debug>
              <jws>            <!-- no parent <module> -->
                <file>examples/wsee/jwsc/POCreateImpl.java</file>
                  <compiledWsdl>${project.build.directory}/purchaseorder_wsdl.jar>
                 <transportType>
                   <type>WLHttpTransport</type>
                 </transportType>
</jws>
              <verbose>true</verbose>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>

例3-32では、典型的なws-jwscゴールの出力を示します。

例3-32 ws-jwsc

mvn -f jwsc_pom.xml generate-resources
INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building maven_plugin_simple 1.0
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- weblogic-maven-plugin:12.1.3-0-0:ws-jwsc (jwsc) @ maven_plugin_simple ---
[INFO] Executing standalone...
 
INFO] Executing Maven goal 'jwsc'...
calling method public static void weblogic.wsee.tools.jws.MavenJwsc.execute(org.apache.maven.plugin.logging.Log,
java.util.Map) throws java.lang.Throwable
[EarFile] Application File : C:\maven-doc\jwsc-test-2\output\META-INF\application.xml
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS