ヘッダーをスキップ
Oracle® Fusion Middleware Oracle WebLogic Serverアプリケーションの開発
12c リリース1 (12.1.1)
B65893-02
  ドキュメント・ライブラリへ移動
ライブラリ
製品リストへ移動
製品
目次へ移動
目次

前
 
次
 

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

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

WebLogic Serverでは、Maven 2.2.xと3.0.xの両方がサポートされています。

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

次の項では、wls-maven-pluginの使用方法を説明します。

WebLogic開発Mavenプラグインの構成

wls-maven-pluginは、MW_HOME/wlserver_12.1/server/libディレクトリにあります。MW_HOMEは、1つのマシン上にインストールされているすべてのFusion Middleware製品の最上位インストール・ディレクトリを表します(例: c:\Oracle\Middleware)。このプラグインは、組込み済JARファイルとそれに付随するpom.xmlファイルとして提供されます。

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

apache-maven-3.0.xの場合:

  1. MW_HOME/wlserver_12.1/server/lib/ディレクトリから、次のコマンドを使用してローカルMavenリポジトリのプラグインをインストールします。

    mvn install -Dfile=wls-maven-plugin.jar -DpomFile=pom.xml
    
  2. 次のコマンドを使用して、//depo/.m2/repository/com/oracle/weblogic/wls-maven-pluginの下のローカルMavenリポジトリのwls-maven-plugin.jarをプロビジョニングします。

    mvn install:install-file 
    -Dfile=wls-maven-plugin.jar -DpomFile=pom.xml
    
  3. デフォルトのpom.xmlファイルには、デフォルトで有効になっているwlsゴール接頭辞を使用するために必要な設定が含まれます。この接頭辞によって、プラグインを簡単に使用できるようになります。

    <build>
        <plugins>
          <plugin>
            <artifactId>maven-plugin-plugin</artifactId>
            <version>2.3</version>
            <configuration>
              <goalPrefix>wls</goalPrefix>
            </configuration>
          </plugin>
        </plugins>
      </build>
    

    ただし、これを行う前に、次のように$MAVEN_HOME/confディレクトリのsettings.xmlファイルを編集する必要があります。次のpluginGroup要素をpluginGroups XMLスタンザに追加します。

    <pluginGroups>
         <pluginGroup>com.oracle.weblogic</pluginGroup>
     </pluginGroups> 
    
  4. 次のようにhelpゴールを使用して、プラグインのインストールが成功したかどうかを検証できます。

    mvn wls:help //for further information on all the goals
    or
    mvn wls:help -Dgoal=GOAL_NAME -Ddetail=true //For example: -Dgoal=start-server
    

    プラグインが正常にインストールされている場合、helpゴールによって、wls-maven-pluginで使用できるゴールのリストが表示されます。

    プラグインのゴールについては、「Mavenプラグインのゴール」を参照してください。

    接頭辞を使用しない場合、または接頭辞が正しく設定されていない場合は、常に完全なコーディネートを使用できます。次に例を示します。

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

apache-maven-2.2.xの場合:

  1. MW_HOME/wlserver_12.1/server/lib/ディレクトリから、次のコマンドを使用してローカルMavenリポジトリのプラグインをインストールします。

    mvn install
    
  2. 次のコマンドを使用して、//depo/.m2/repository/com/oracle/weblogic/wls-maven-pluginの下のローカルMavenリポジトリのwls-maven-plugin.jarをプロビジョニングします。

    mvn install:install-file 
    -Dfile=wls-maven-plugin.jar -DpomFile=pom.xml
    
  3. デフォルトのpom.xmlファイルには、デフォルトで有効になっているwlsゴール接頭辞を使用するために必要な設定が含まれます。この接頭辞によって、プラグインを簡単に使用できるようになります。

    <build>
        <plugins>
          <plugin>
            <artifactId>maven-plugin-plugin</artifactId>
            <version>2.3</version>
            <configuration>
              <goalPrefix>wls</goalPrefix>
            </configuration>
          </plugin>
        </plugins>
      </build>
    

    ただし、これを行う前に、次のように$MAVEN_HOME/confディレクトリにあるMavenのsettings.xmlファイルを編集する必要があります。次のpluginGroup要素をpluginGroups XMLスタンザに追加します。

    <pluginGroups>
         <pluginGroup>com.oracle.weblogic</pluginGroup>
     </pluginGroups> 
    
  4. 次のようにhelpゴールを使用して、プラグインのインストールが成功したかどうかを検証できます。

    mvn wls:help //for further information on all the goals
    or
    mvn wls:help -Dgoal=GOAL_NAME -Ddetail=true //For example: -Dgoal=start-server
    

    プラグインが正常にインストールされている場合、helpゴールによって、wls-maven-pluginで使用できるゴールのリストが表示されます。

    プラグインのゴールについては、「Mavenプラグインのゴール」を参照してください。

    接頭辞を使用しない場合、または接頭辞が正しく設定されていない場合は、常に完全なコーディネートを使用できます。次に例を示します。

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

基本構成POMファイル

例3-1は、wls-maven-pluginの使用を可能にする基本的なJava EE 6 Webアプリケーションpom.xmlファイルを示しています。

例3-1 基本構成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>javax</groupId>
            <artifactId>javaee-web-api</artifactId>
            <version>6.0</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
 
    <build>
        <plugins>
            ...
            ...
 
            <!-- WebLogic Server 12c Maven Plugin -->
            <plugin>
                <groupId>com.oracle.weblogic</groupId>
                <artifactId>wls-maven-plugin</artifactId>
                <version>12.1.1.0</version>
            </plugin>
        </plugins>
    </build>
 
</project>

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

wls-maven-pluginは、Mavenのテーマに従い、構成より規則優先のアプローチを使用しています。したがって、一般的に使用される一連の構成要素については、このプラグインによって、すべてのゴールにわたって使用できる適切な一貫性のある一連のデフォルト値が提供されます。これは、プラグインを使用するために必要な構成の程度を低減し、異なる環境であってもゴールの実行を均一にするために役立ちます。一般的な構成要素およびそれらのデフォルト値は次のとおりです。

これらの構成パラメータにはデフォルト値がありますが、必要に応じて、pom.xmlファイルまたはコマンドラインでそれらをオーバーライドできます。ただし、このデフォルトの値があるため、これらのパラメータを構成スタンザから除外することで、構成スタンザはすべてのゴールで一貫して使用できます。

たとえば、値を繰り返して指定することなく、すべて同じWebLogic Serverインストールおよびドメイン・パラメータを使用する次のコマンドを発行できます。

$ mvn wls:install 
-DartifactLocation=/Users/myUser/Downloads/wls/wls_1211/wls1211_dev.zip
$ mvn wls:create-domain –Duser=weblogic –Dpassword=welcome1
$ mvn wls:start-server

Mavenプラグインのゴール

表3-1に、すべてのwls-maven-pluginゴールをリストします。

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

ゴール名 説明

appc


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

create-domain


デフォルトのドメイン・テンプレートを使用してWebLogic Serverドメインを作成します。より複雑なドメインを作成する場合は、wlstゴールを使用します。

deploy


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

help


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

install


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

list-apps


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

redeploy


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

start-app


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

start-server


WebLogic Serverを起動します。

stop-app


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

stop-server


WebLogic Serverを停止します。

undeploy


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

update-app


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

wlst


Maven用のWLSTラッパー。


appc

完全名

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

短縮名

wls:appc

説明

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

パラメータ

表3-2 appcのパラメータ

名前 タイプ 必須 説明

altappdd

java.lang.String

いいえ

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

altwlsappdd

java.lang.String

いいえ

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

basicClientJar

boolean

いいえ

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

classpath

java.lang.String

いいえ

目的のCLASSPATHを構成するカンマ区切りディレクトリのリストを指定します。JSPファイルに必要なクラスを格納するディレクトリを含める必要があります。

clientJarOutputDir

java.lang.String

いいえ

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

commentary

boolean

いいえ

trueの場合、JSPコンパイラにより、生成されたHTMLページにJSPからのコメントが含められます。それ以外の場合、JSPコメントは生成されたHTMLページに表示されません。
デフォルト値: false

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

いいえ

trueの場合、EJBに対してWLSスタブおよびスケルトンを生成します。
デフォルト値: false

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

いいえ

指定したマニフェスト・ファイルからのマニフェスト情報を含めます。

maxfiles

java.lang.Integer

いいえ

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

middlewareHome

java.lang.String

いいえ

Oracle WebLogic ServerまたはFusion Middlewareインストールのホーム・ディレクトリのパスを指定します。
WebLogic Server Mavenプラグインのinstallゴールによって選択されたデフォルトの場所にWebLogic Serverがインストールされていない場合は必須です。
デフォルト値: ${basedir}/Oracle/Software

noexit

boolean

いいえ

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

normi

boolean

いいえ

trueの場合、Symantecのsjにフラグを渡します。
デフォルト値: false

nowarn

boolean

いいえ

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

nowrite

boolean

いいえ

trueの場合、出力をwriteLicense.txtのかわりにstdoutに送信します。
デフォルト値: false

optimize

boolean

いいえ

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

output

java.io.File

いいえ

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

plan

java.io.File

いいえ

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

quiet

boolean

いいえ

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

runtimeFlags

java.lang.String

いいえ

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

serverClasspath

java.lang.String

いいえ

追加のJARおよびディレクトリをクラスパスに追加し、それらに含まれるリソースおよびクラスをwls-maven-pluginで使用できるようにします。

source

java.io.File

いいえ

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

sourceVersion

java.lang.String

いいえ

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

supressCompiler

boolean

いいえ

CLASSPATHに、コンパイルされた出力のディレクトリを含めるかどうかを指定します。
デフォルト値: true

targetVersion

java.lang.String

いいえ

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

verbose

boolean

いいえ

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

verboseJavac

boolean

いいえ

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

weblogicHome

java.lang.String

いいえ

WebLogic Serverインストールの場所を指定します。middlewareHomeの場所への絶対パスまたは相対パスを指定します。
デフォルトが使用され、weblogicHomemiddlewareHomeの子フォルダである場合は、オプションです。
複数のweblogicHomeがあるか、それがmiddlewareHomeの子フォルダでない場合は必須です。

writeInferredDescriptors

boolean

いいえ

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


使用例

appcゴールは、WebLogic Serverアプリケーション・コンパイラ・ユーティリティを実行し、デプロイメント用のアプリケーションを準備します。このゴールは、構成より規則優先のアプローチのメリットを受けており、プロジェクトのデフォルトを使用して実行できます。例3-2では、典型的なappcゴールの出力を示します。この例では、-verboseオプションを使用して、appcユーティリティが実行するアクティビティを強調表示していますが、通常、これは不要です。

例3-2 appc

myuser:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:appc -Dverbose

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building maven-demo 1.0
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- wls-maven-plugin:12.1.1.0:appc (default-cli) @ maven-demo ---
[INFO] ++====================================================================++
[INFO] ++  wls-maven-plugin: appc                                            ++
[INFO] ++====================================================================++
<Nov 23, 2011 4:43:08 PM CST> <Info> <J2EE> <BEA-160230> <Created working directory: /var/folders/cL/cLTyZKXjGgmQhEpoV+U-DE+++TI/-Tmp-/appcgen_1322028788639_maven-demo.war> 
[JspcInvoker]Checking web app for compliance.
[jspc]  -webapp specified, searching . for JSPs
[jspc] Compiling /index.jsp
<Nov 23, 2011 4:43:12 PM CST> <Info> <J2EE> <BEA-160220> <Compilation completed successfully.> 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 5.281s
[INFO] Finished at: Wed Nov 23 16:43:12 CST 2011
[INFO] Final Memory: 16M/81M
[INFO] ------------------------------------------------------------------------

create-domain

完全名

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

短縮名

wls:create-domain

説明

デフォルトのドメイン・テンプレートを使用してWebLogic Serverドメインを作成します。より複雑なドメインを作成する場合は、wlstゴールを使用します。

パラメータ

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

名前 タイプ 必須 説明

domainHome

java.lang.String

いいえ

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

domainTemplate

java.lang.String

いいえ

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

failOnDomainExists

boolean

いいえ

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

middlewareHome

java.lang.String

いいえ

Oracle WebLogic ServerまたはFusion Middlewareインストールのホーム・ディレクトリのパスを指定します。
WebLogic Server Mavenプラグインのinstallゴールによって選択されたデフォルトの場所にWebLogic Serverがインストールされていない場合は必須です。
デフォルト値: ${basedir}/Oracle/Software

password

java.lang.String

true

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

serverClasspath

java.lang.String

いいえ

追加のJARおよびディレクトリをクラスパスに追加し、それらに含まれるリソースおよびクラスをwls-maven-pluginで使用できるようにします。

user

java.lang.String

true

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

weblogicHome

java.lang.String

いいえ

WebLogic Serverインストールの場所を指定します。middlewareHomeの場所への絶対パスまたは相対パスを指定します。
デフォルトが使用され、weblogicHomemiddlewareHomeの子フォルダである場合は、オプションです。
複数のweblogicHomeがあるか、それがmiddlewareHomeの子フォルダでない場合は必須です。


使用例

create-domainゴールを使用して、指定されたWebLogic ServerインストールからWebLogic Serverドメインを作成します。オプションのdomainHome構成パラメータを使用してドメインの場所を指定します。このパラメータは、デフォルトでは、${basedir}/Oracle/Domainsに設定されています。このようにして、ドメインが、Mavenプロジェクト・ルート・ディレクトリのOracle/Domainsサブディレクトリに作成されます。

オプションのmiddlewareHome構成パラメータを使用してWebLogic Serverインストールの場所を指定します。このパラメータは、デフォルトでは、${basedir}/Oracle/Softwareに設定されています。デフォルトの場所を使用してinstallゴールを実行した場合、create-domainゴールでのmiddlewareHomeの指定を省略できます。

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

<!-- WebLogic Server 12c Maven Plugin -->
<plugin>
    <groupId>com.oracle.weblogic</groupId>
    <artifactId>wls-maven-plugin</artifactId>
    <version>12.1.1.0</version>
    <configuration>
        <artifactLocation>
            com.oracle.weblogic:wls-dev:zip:12.1.1.0
        </artifactLocation>
        <user>weblogic</user>
        <password>welcome1</password>
    </configuration>
 </plugin>

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

例3-3 create-domain

myuser:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:create-domain

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building maven-demo 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- wls-maven-plugin:12.1.1.0:create-domain (default-cli) @ maven-demo ---
[INFO] ++====================================================================++
[INFO] ++  wls-maven-plugin: create-domain                                   ++
[INFO] ++====================================================================++
[INFO] Domain creation script: 
readTemplate('/Users/myuser/Projects/Java/wls-maven-doc/maven-demo/Oracle/Software/wlserver/common/templates/domains/wls.jar')
cd('/Security/base_domain/User/weblogic')
set('Name', 'weblogic')
set('Password', '***')
writeDomain('/Users/myuser/Projects/Java/wls-maven-doc/maven-demo/Oracle/Domains/mydomain')
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 39.345s
[INFO] Finished at: Wed Nov 23 16:01:13 CST 2011
[INFO] Final Memory: 24M/81M
[INFO] ------------------------------------------------------------------------

domainHome構成パラメータを指定しないかぎり、ドメインは、次のように、Mavenプロジェクトの${basedir}/Oracle/Domainsディレクトリに作成されます。

myuser:~/Projects/Java/wls-maven-doc/maven-demo $ ls -l Oracle/Domains/mydomain

total 16
drwxr-xr-x   3 myuser  staff  102 23 Nov 16:01 autodeploy
drwxr-xr-x  10 myuser  staff  340 23 Nov 16:01 bin
drwxr-xr-x  10 myuser  staff  340 23 Nov 16:01 config
drwxr-xr-x   3 myuser  staff  102 23 Nov 16:01 console-ext
-rw-r--r--   1 myuser  staff  462 23 Nov 16:01 fileRealm.properties
drwxr-xr-x   7 myuser  staff  238 23 Nov 16:01 init-info
drwxr-xr-x   3 myuser  staff  102 23 Nov 16:01 lib
drwxr-xr-x   6 myuser  staff  204 23 Nov 16:01 security
drwxr-xr-x   3 myuser  staff  102 23 Nov 16:01 servers
-rwxr-x---   1 myuser  staff  293 23 Nov 16:01 startWebLogic.sh

deploy

完全名

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

短縮名

wls:deploy

説明

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

パラメータ

表3-4 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

いいえ

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

middlewareHome

java.lang.String

いいえ

Oracle WebLogic ServerまたはFusion Middlewareインストールのホーム・ディレクトリのパスを指定します。
WebLogic Server Mavenプラグインのinstallゴールによって選択されたデフォルトの場所にWebLogic Serverがインストールされていない場合は必須です。
デフォルト値: ${basedir}/Oracle/Software

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

いいえ

追加のJARおよびディレクトリをクラスパスに追加し、それらに含まれるリソースおよびクラスをwls-maven-pluginで使用できるようにします。

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

いいえ

WebLogic Serverインストールの場所を指定します。middlewareHomeの場所への絶対パスまたは相対パスを指定します。
デフォルトが使用され、weblogicHomemiddlewareHomeの子フォルダである場合は、オプションです。
複数のweblogicHomeがあるか、それがmiddlewareHomeの子フォルダでない場合は必須です。


使用例

このゴールを使用してアプリケーションをデプロイします。構成より規則優先のアプローチを使用することで、次に示すように、デプロイするmiddlewareHomeadminurlおよびsourceファイルに使用可能なデフォルト値で、追加の構成をすることなくdeployゴールを実行できます。

myuser:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:deploy

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building maven-demo 1.0
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- wls-maven-plugin:12.1.1.0:deploy (default-cli) @ maven-demo ---
[INFO] ++====================================================================++
[INFO] ++  wls-maven-plugin: deploy                                          ++
[INFO] ++====================================================================++
weblogic.Deployer invoked with options:  -noexit -user weblogic -deploy -source /Users/myuser/Projects/Java/wls-maven-doc/maven-demo/target/maven-demo.war
<Nov 23, 2011 4:36:51 PM CST> <Info> <J2EE Deployment SPI> <BEA-260121> <Initiating deploy operation for application, maven-demo [archive: 
/Users/myuser/Projects/Java/wls-maven-doc/maven-demo/target/maven-demo.war],
 to configured targets.> 
Task 0 initiated: [Deployer:149026]deploy application maven-demo on AdminServer.
Task 0 completed: [Deployer:149026]deploy application maven-demo on AdminServer.
Target state: deploy completed on Server AdminServer
 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 5.803s
[INFO] Finished at: Wed Nov 23 16:36:52 CST 2011
[INFO] Final Memory: 6M/81M
[INFO] ------------------------------------------------------------------------

help

完全名

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

短縮名

wls:help

説明

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

パラメータ

表3-5 helpのパラメータ

名前 タイプ 必須 説明

detail

boolean

いいえ

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

goal

java.lang.String

いいえ

指定したゴールに関する情報を出力します。指定しない場合は、すべてのゴールに関する情報が表示されます。


install

完全名

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

短縮名

wls:install

説明

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

パラメータ

表3-6 installのパラメータ

名前 タイプ 必須 説明

artifactLocation

java.lang.String

true

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

localRepository

org.apache.maven.artifact.repository.ArtifactRepository

true

ローカルMavenリポジトリの絶対パスを指定します。

domainHome

java.lang.String

いいえ

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

installCommand

java.lang.String

いいえ

実行可能インストーラで製品をインストールします。サポートされているマクロは、@INSTALLER_FILE@ (インストーラ・ファイルのパス)、@JAVA_HOME@ (Javaホームのパス)です。例: @JAVA_HOME@ -Xms512m -Xmx1024m -jar @INSTALLER_FILE@ one two

middlewareHome

java.lang.String

いいえ

Oracle WebLogic ServerまたはFusion Middlewareインストールのホーム・ディレクトリのパスを指定します。
WebLogic Server Mavenプラグインのinstallゴールによって選択されたデフォルトの場所にWebLogic Serverがインストールされていない場合は必須です。
デフォルト値: ${basedir}/Oracle/Software


使用例

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

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

インストールのターゲット・ディレクトリを、オプションのmiddlewareHome構成パラメータを使用して指定します。これはデフォルトでは${basedir}/Oracle/Softwareに設定されています。${basedir}は、現在のMavenプロジェクトを含むディレクトリを表す標準Mavenプロジェクト・プロパティです。middlewareHome値を指定することで、指定した場所でインストールが実行されるように指示します。

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

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

    <!-- WebLogic Server 12c Maven Plugin -->
    <plugin>
        <groupId>com.oracle.weblogic</groupId>
        <artifactId>wls-maven-plugin</artifactId>
        <version>12.1.1.0</version>
        <configuration>
            <artifactLocation>
               /Users/myuser/Downloads/wls/wls_1211/wls1211_dev.zip
            </artifactLocation>
        </configuration>
     </plugin>
    

    通常コマンド出力は次のとおりです。

    myuser:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:install
    
    [INFO] Scanning for projects...
    [INFO]                                                                         
    [INFO] ------------------------------------------------------------------------
    [INFO] Building maven-demo 1.0-SNAPSHOT
    [INFO] ------------------------------------------------------------------------
    [INFO] 
    [INFO] --- wls-maven-plugin:12.1.1.0:install (default-cli) @ maven-demo ---
    [INFO] ++====================================================================++
    [INFO] ++  wls-maven-plugin: install                                         ++
    [INFO] ++====================================================================++
    [INFO] Installing /Users/myuser/Downloads/wls/wls_1211/wls1211_dev.zip into 
    /Users/myuser/Projects/Java/wls-maven-doc/maven-demo/Oracle/Software
    [INFO] Installing the product, this may take some time.
    [INFO] Executing: [cmd:[/bin/bash, -c, chmod +x ./configure.sh; ./configure.sh]]
    [INFO] Process being executed, waiting for completion.
    [INFO] [exec] **************************************************
    [INFO] [exec] WebLogic Server 12c (12.1.1.0) Zip Configuration
    [INFO] [exec] 
    [INFO] [exec] MW_HOME:   /Users/myuser/Projects/Java/wls-maven-doc/maven-demo/Oracle/Software
    [INFO] [exec] JAVA_HOME: /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
    [INFO] [exec] **************************************************
    ...
    ...
    ...
    [INFO] [exec] BUILD SUCCESSFUL
    [INFO] [exec] Total time: 0 seconds
    [INFO] [configure script] exit code: 0
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 1:53.210s
    [INFO] Finished at: Wed Nov 23 15:46:53 CST 2011
    [INFO] Final Memory: 3M/81M
    [INFO] ------------------------------------------------------------------------
    
  • URLの参照

    <!-- WebLogic Server 12c Maven Plugin -->
    <plugin>
        <groupId>com.oracle.weblogic</groupId>
        <artifactId>wls-maven-plugin</artifactId>
        <version>12.1.1.0</version>
        <configuration>
            <artifactLocation>
    http://adc2101001.us.oracle.com:7001/bea_wls_internal/wls1211_dev.zip
            </artifactLocation>
        </configuration>
     </plugin>
    

    通常コマンド出力は次のとおりです。

    myuser:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:install
    
    [INFO] Scanning for projects...
    [INFO]                                                                         
    [INFO] ------------------------------------------------------------------------
    [INFO] Building maven-demo 1.0-SNAPSHOT
    [INFO] ------------------------------------------------------------------------
    [INFO] 
    [INFO] --- wls-maven-plugin:12.1.1.0:install (default-cli) @ maven-demo ---
    [INFO] ++====================================================================++
    [INFO] ++  wls-maven-plugin: install                                         ++
    [INFO] ++====================================================================++
    [INFO] Installing http://adc2101001.us.oracle.com:7001/bea_wls_internal/wls1211_dev.zip into 
    /Users/myuser/Projects/Java/wls-maven-doc/maven-demo/Oracle/Software
    [INFO] Attempt to download artifact from maven repo failed - Artifact not found
    [INFO] Attempt to download the weblogic server instance directly from url.
    [INFO] Downloading the file ...
    ...
    ...
    ...
    [INFO] [exec] BUILD SUCCESSFUL
    [INFO] [exec] Total time: 0 seconds
    [INFO] [configure script] exit code: 0
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 4:23.710s
    [INFO] Finished at: Wed Nov 23 15:53:21 CST 2011
    [INFO] Final Memory: 3M/81M
    [INFO] ------------------------------------------------------------------------
    
  • Mavenアーティファクト: この場合、配布はローカルMavenリポジトリ自体から取得されます。つまり、それを事前にローカル・リポジトリにインストールしておくか、リモート・リポジトリから取得しておく必要があります。

    たとえば、wls1211-dev.zipをMavenリポジトリにインストールするには、次のようにコマンドラインを使用します。

    myuser:~ $ mvn install:install-file -Dfile=wls1211_dev.zip 
    -DgroupId=com.oracle.weblogic -DartifactId=wls-dev 
    -Dpackaging=zip -Dversion=12.1.1.0
    

    通常コマンド出力は次のとおりです。

    [INFO] Scanning for projects...
    [INFO]                                                                         
    [INFO] ------------------------------------------------------------------------
    [INFO] Building Maven Stub Project (No POM) 1
    [INFO] ------------------------------------------------------------------------
    [INFO] 
    [INFO] --- maven-install-plugin:2.3.1:install-file (default-cli) @ standalone-pom ---
    [INFO] Installing /Users/myuser/Downloads/wls/wls_1211/wls1211_dev.zip to 
    /Users/myuser/.m2/repository/com/oracle/weblogic/wls-dev/12.1.1.0/wls-dev-12.1.1.0.zip
    [INFO] Installing /var/folders/cL/cLTyZKXjGgmQhEpoV+U-DE+++TI/-Tmp-/mvninstall7575420374983698784.pom to
    /Users/myuser/.m2/repository/com/oracle/weblogic/wls-dev/12.1.1.0/wls-dev-12.1.1.0.pom
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 11.089s
    [INFO] Finished at: Wed Nov 23 15:30:17 CST 2011
    [INFO] Final Memory: 3M/81M
    [INFO] ------------------------------------------------------------------------
    

    このコマンドによって、wls1211-dev.zipが次のコーディネートとともにMavenアーティファクトとしてインストールされました。

    com.oracle.weblogic:wls-dev:zip:12.1.1.0
    

    インストールにこのMavenアーティファクトをWebLogic Serverの配布として使用するには、プラグイン構成は次のようになります。

    <!-- WebLogic Server 12c Maven Plugin -->
    <plugin>
        <groupId>com.oracle.weblogic</groupId>
        <artifactId>wls-maven-plugin</artifactId>
        <version>12.1.1.0</version>
        <configuration>
            <artifactLocation>
                com.oracle.weblogic:wls-dev:zip:12.1.1.0
            </artifactLocation>
        </configuration>
     </plugin>
    

    installゴールの実行からの一般的な出力は次のようになります。

    myuser:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:install
    
    [INFO] Scanning for projects...
    [INFO]                                                                         
    [INFO] ------------------------------------------------------------------------
    [INFO] Building maven-demo 1.0-SNAPSHOT
    [INFO] ------------------------------------------------------------------------
    [INFO] 
    [INFO] --- wls-maven-plugin:12.1.1.0:install (default-cli) @ maven-demo ---
    [INFO] ++====================================================================++
    [INFO] ++  wls-maven-plugin: install                                         ++
    [INFO] ++====================================================================++
    [INFO] Installing com.oracle.weblogic:wls-dev:zip:12.1.1.0 into 
    /Users/myuser/Projects/Java/wls-maven-doc/maven-demo/Oracle/Software
    [INFO] Installing the product, this may take some time.
    [INFO] Executing: [cmd:[/bin/bash, -c, chmod +x ./configure.sh; ./configure.sh]]
    [INFO] Process being executed, waiting for completion.
    [INFO] [exec] **************************************************
    [INFO] [exec] WebLogic Server 12c (12.1.1.0) Zip Configuration
    [INFO] [exec] 
    [INFO] [exec] MW_HOME:   /Users/myuser/Projects/Java/wls-maven-doc/maven-demo/Oracle/Software
    [INFO] [exec] JAVA_HOME: /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
    [INFO] [exec] **************************************************
    [INFO] [exec] 
    ...
    ...
    ...
    [INFO] [exec] 
    [INFO] [exec] Your environment has been set.
    [INFO] [exec] 
    [INFO] [exec] BUILD SUCCESSFUL
    [INFO] [exec] Total time: 0 seconds
    [INFO] [configure script] exit code: 0
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 1:57.549s
    [INFO] Finished at: Wed Nov 23 15:35:32 CST 2011
    [INFO] Final Memory: 4M/81M
    [INFO] ------------------------------------------------------------------------
    

    middlewareHome構成パラメータを指定しないかぎり、インストールはデフォルトの${basedir}/Oracle/Softwareディレクトリで実行されます。

    例:

    myuser:~/Projects/Java/wls-maven-doc/maven-demo $ ls -l
    total 8
    drwxr-xr-x  3 myuser  staff   102 23 Nov 15:44 Oracle
    -rw-r--r--  1 myuser  staff  3597 23 Nov 15:43 pom.xml
    drwxr-xr-x  3 myuser  staff   102 23 Nov 15:03 src
     
    myuser:~/Projects/Java/wls-maven-doc/maven-demo $ ls -l Oracle/Software/
    total 64
    -rw-r--r--    1 myuser  staff   5808 23 Nov 15:45 README.txt
    -rw-r--r--    1 myuser  staff   3064 23 Nov 15:45 configure.cmd
    -rwxr-xr-x    1 myuser  staff   2857 23 Nov 15:45 configure.sh
    -rw-r--r--    1 myuser  staff   3189 23 Nov 15:45 configure.xml
    -rw-r--r--    1 myuser  staff    133 23 Nov 15:45 domain-registry.xml
    drwxr-xr-x  508 myuser  staff  17272 23 Nov 15:46 modules
    -rw-r--r--    1 myuser  staff   1138 23 Nov 15:45 registry.template
    -rw-r--r--    1 myuser  staff   1320 23 Nov 15:46 registry.xml
    drwxr-xr-x    3 myuser  staff    102 23 Nov 15:45 utils
    drwxr-xr-x    7 myuser  staff    238 23 Nov 15:46 wlserver
    

list-apps

完全名

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

短縮名

wls:list-apps

説明

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

パラメータ

表3-7 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

いいえ

Oracle WebLogic ServerまたはFusion Middlewareインストールのホーム・ディレクトリのパスを指定します。
WebLogic Server Mavenプラグインのinstallゴールによって選択されたデフォルトの場所にWebLogic Serverがインストールされていない場合は必須です。
デフォルト値: ${basedir}/Oracle/Software

noversion

boolean

いいえ

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

nowait

boolean

いいえ

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

password

java.lang.String

いいえ

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

purgetasks

boolean

いいえ

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

remote

boolean

いいえ

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

serverClasspath

java.lang.String

いいえ

追加のJARおよびディレクトリをクラスパスに追加し、それらに含まれるリソースおよびクラスをwls-maven-pluginで使用できるようにします。

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

いいえ

WebLogic Serverインストールの場所を指定します。middlewareHomeの場所への絶対パスまたは相対パスを指定します。
デフォルトが使用され、weblogicHomemiddlewareHomeの子フォルダである場合は、オプションです。
複数のweblogicHomeがあるか、それがmiddlewareHomeの子フォルダでない場合は必須です。


redeploy

完全名

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

短縮名

wls:redeploy

説明

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

パラメータ

表3-8 redeployのパラメータ

名前 タイプ 必須 説明

adminurl

java.lang.String

いいえ

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

deleteFiles

java.lang.String

いいえ

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

examples

boolean

いいえ

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

failOnError

boolean

いいえ

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

id

java.lang.String

いいえ

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

middlewareHome

java.lang.String

いいえ

Oracle WebLogic ServerまたはFusion Middlewareインストールのホーム・ディレクトリのパスを指定します。
WebLogic Server Mavenプラグインのinstallゴールによって選択されたデフォルトの場所にWebLogic Serverがインストールされていない場合は必須です。
デフォルト値: ${basedir}/Oracle/Software

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

いいえ

追加のJARおよびディレクトリをクラスパスに追加し、それらに含まれるリソースおよびクラスをwls-maven-pluginで使用できるようにします。

source

java.lang.String

いいえ

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

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の場合、再デプロイメント前に、指定されたソース・ファイルを管理サーバーの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

いいえ

WebLogic Serverインストールの場所を指定します。middlewareHomeの場所への絶対パスまたは相対パスを指定します。
デフォルトが使用され、weblogicHomemiddlewareHomeの子フォルダである場合は、オプションです。
複数のweblogicHomeがあるか、それがmiddlewareHomeの子フォルダでない場合は必須です。


start-app

完全名

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

短縮名

wls:start-app

説明

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

パラメータ

表3-9 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

いいえ

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

examples

boolean

いいえ

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

failOnError

boolean

いいえ

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

id

java.lang.String

いいえ

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

middlewareHome

java.lang.String

いいえ

Oracle WebLogic ServerまたはFusion Middlewareインストールのホーム・ディレクトリのパスを指定します。
WebLogic Server Mavenプラグインのinstallゴールによって選択されたデフォルトの場所にWebLogic Serverがインストールされていない場合は必須です。
デフォルト値: ${basedir}/Oracle/Software

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

いいえ

追加のJARおよびディレクトリをクラスパスに追加し、それらに含まれるリソースおよびクラスをwls-maven-pluginで使用できるようにします。

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

いいえ

WebLogic Serverインストールの場所を指定します。middlewareHomeの場所への絶対パスまたは相対パスを指定します。
デフォルトが使用され、weblogicHomemiddlewareHomeの子フォルダである場合は、オプションです。
複数のweblogicHomeがあるか、それがmiddlewareHomeの子フォルダでない場合は必須です。


start-server

完全名

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

短縮名

wls:start-server

説明

WebLogic Serverを起動します。

パラメータ

表3-10 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

いいえ

Oracle WebLogic ServerまたはFusion Middlewareインストールのホーム・ディレクトリのパスを指定します。
WebLogic Server Mavenプラグインのinstallゴールによって選択されたデフォルトの場所にWebLogic Serverがインストールされていない場合は必須です。
デフォルト値: ${basedir}/Oracle/Software

serverClasspath

java.lang.String

いいえ

追加のJARおよびディレクトリをクラスパスに追加し、それらに含まれるリソースおよびクラスをwls-maven-pluginで使用できるようにします。

timeoutSecs

java.lang.Integer

いいえ

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

weblogicHome

java.lang.String

いいえ

WebLogic Serverインストールの場所を指定します。middlewareHomeの場所への絶対パスまたは相対パスを指定します。
デフォルトが使用され、weblogicHomemiddlewareHomeの子フォルダである場合は、オプションです。
複数のweblogicHomeがあるか、それがmiddlewareHomeの子フォルダでない場合は必須です。


使用例

start-serverゴールは、指定されたドメインでstartWebLogicコマンドを実行し、WebLogic Serverインスタンスを起動します。このゴールは、middlewareHomeおよびdomainHome構成パラメータを使用して、使用するWebLogic Serverインストールとドメインの場所も指定します。構成より規則優先のアプローチに従い、サーバーをインストールしてドメインを作成するときにデフォルト値を保持した場合、これらの構成パラメータを再度指定する必要はありません。ただし、異なる場所にWebLogic Serverをインストールしたり、ドメインを作成した場合は、その場所をpom.xmlファイルのmiddlewareHomeおよびdomainHome構成要素を使用して指定するか、コマンドラインでパラメータとして指定する必要があります。

構成より規則優先のアプローチを使用すると、次のように、${basedir}/Oracle/SoftwareのWebLogic Serverインストールを使用してデフォルトのドメイン${basedir}/Oracle/Domains/mydomainを起動できます。

myuser:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:start-server

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building maven-demo 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- wls-maven-plugin:12.1.1.0:start-server (default-cli) @ maven-demo ---
[INFO] ++====================================================================++
[INFO] ++  wls-maven-plugin: start-server                                    ++
[INFO] ++====================================================================++
.[INFO] Starting server in domain /Users/myuser/Projects/Java/wls-maven-doc/maven-demo/Oracle/Domains/mydomain
[INFO] Check stdout file for details: /Users/myuser/Projects/Java/wls-maven-doc/maven-demo/Oracle/Domains/mydomain/server-2388282492279558044.out
[INFO] Process being executed, waiting for completion.
.........
[INFO] Server started successful
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 9.137s
[INFO] Finished at: Wed Nov 23 16:23:07 CST 2011
[INFO] Final Memory: 4M/81M
[INFO] ------------------------------------------------------------------------

stop-app

完全名

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

短縮名

wls:stop-app

説明

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

パラメータ

表3-11 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

いいえ

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

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

いいえ

Oracle WebLogic ServerまたはFusion Middlewareインストールのホーム・ディレクトリのパスを指定します。
WebLogic Server Mavenプラグインのinstallゴールによって選択されたデフォルトの場所にWebLogic Serverがインストールされていない場合は必須です。
デフォルト値: ${basedir}/Oracle/Software

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

いいえ

追加のJARおよびディレクトリをクラスパスに追加し、それらに含まれるリソースおよびクラスをwls-maven-pluginで使用できるようにします。

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

いいえ

WebLogic Serverインストールの場所を指定します。middlewareHomeの場所への絶対パスまたは相対パスを指定します。
デフォルトが使用され、weblogicHomemiddlewareHomeの子フォルダである場合は、オプションです。
複数のweblogicHomeがあるか、それがmiddlewareHomeの子フォルダでない場合は必須です。


stop-server

完全名

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

短縮名

wls:stop-server

説明

WebLogic Serverを停止します。

パラメータ

表3-12 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

いいえ

Oracle WebLogic ServerまたはFusion Middlewareインストールのホーム・ディレクトリのパスを指定します。
WebLogic Server Mavenプラグインのinstallゴールによって選択されたデフォルトの場所にWebLogic Serverがインストールされていない場合は必須です。
デフォルト値: ${basedir}/Oracle/Software

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

いいえ

WebLogic Serverインストールの場所を指定します。middlewareHomeの場所への絶対パスまたは相対パスを指定します。
デフォルトが使用され、weblogicHomemiddlewareHomeの子フォルダである場合は、オプションです。
複数のweblogicHomeがあるか、それがmiddlewareHomeの子フォルダでない場合は必須です。

workingDir

java.lang.String

いいえ

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


使用例

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

myuser:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:stop-server
-DmiddlewareHome=$MW_HOME -Duser=weblogic -Dpassword=welcome1 
-DdomainHome=/Users/myuser/Projects/Java/wls-maven-doc/maven-demo/Oracle/Domains/mydomain

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building maven-demo 1.0
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- wls-maven-plugin:12.1.1.0:stop-server (default-cli) @ maven-demo ---
[INFO] ++====================================================================++
[INFO] ++  wls-maven-plugin: stop-server                                     ++
[INFO] ++====================================================================++
[INFO] Stop server in domain: /Users/myuser/Projects/Java/wls-maven-doc/maven-demo/Oracle/Domains/mydomain
[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 'mydomain'.
[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 connected 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] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 8.921s
[INFO] Finished at: Wed Nov 23 16:41:14 CST 2011
[INFO] Final Memory: 4M/81M
[INFO] ------------------------------------------------------------------------

undeploy

完全名

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

短縮名

wls:undeploy

説明

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

パラメータ

表3-13 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

いいえ

Oracle WebLogic ServerまたはFusion Middlewareインストールのホーム・ディレクトリのパスを指定します。
WebLogic Server Mavenプラグインのinstallゴールによって選択されたデフォルトの場所にWebLogic Serverがインストールされていない場合は必須です。
デフォルト値: ${basedir}/Oracle/Software

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

いいえ

追加のJARおよびディレクトリをクラスパスに追加し、それらに含まれるリソースおよびクラスをwls-maven-pluginで使用できるようにします。

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

いいえ

WebLogic Serverインストールの場所を指定します。middlewareHomeの場所への絶対パスまたは相対パスを指定します。
デフォルトが使用され、weblogicHomemiddlewareHomeの子フォルダである場合は、オプションです。
複数のweblogicHomeがあるか、それがmiddlewareHomeの子フォルダでない場合は必須です。


update-app

完全名

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

短縮名

wls:update-app

説明

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

パラメータ

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

名前 タイプ 必須 説明

adminurl

java.lang.String

いいえ

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

advanced

boolean

いいえ

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

appversion

java.lang.String

いいえ

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

debug

boolean

いいえ

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

domainHome

java.lang.String

いいえ

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

examples

boolean

いいえ

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

failOnError

boolean

いいえ

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

id

java.lang.String

いいえ

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

middlewareHome

java.lang.String

いいえ

Oracle WebLogic ServerまたはFusion Middlewareインストールのホーム・ディレクトリのパスを指定します。
WebLogic Server Mavenプラグインのinstallゴールによって選択されたデフォルトの場所にWebLogic Serverがインストールされていない場合は必須です。
デフォルト値: ${basedir}/Oracle/Software

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

いいえ

追加のJARおよびディレクトリをクラスパスに追加し、それらに含まれるリソースおよびクラスをwls-maven-pluginで使用できるようにします。

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

いいえ

WebLogic Serverインストールの場所を指定します。middlewareHomeの場所への絶対パスまたは相対パスを指定します。
デフォルトが使用され、weblogicHomemiddlewareHomeの子フォルダである場合は、オプションです。
複数のweblogicHomeがあるか、それがmiddlewareHomeの子フォルダでない場合は必須です。


wlst

完全名

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

短縮名

wls:wlst

説明

Maven用のWLSTラッパー。

パラメータ

表3-15 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

いいえ

Oracle WebLogic ServerまたはFusion Middlewareインストールのホーム・ディレクトリのパスを指定します。
WebLogic Server Mavenプラグインのinstallゴールによって選択されたデフォルトの場所にWebLogic Serverがインストールされていない場合は必須です。
デフォルト値: ${basedir}/Oracle/Software

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!')"を指定します。

serverClasspath

java.lang.String

いいえ

追加のJARおよびディレクトリをクラスパスに追加し、それらに含まれるリソースおよびクラスをwls-maven-pluginで使用できるようにします。

weblogicHome

java.lang.String

いいえ

WebLogic Serverインストールの場所を指定します。middlewareHomeの場所への絶対パスまたは相対パスを指定します。
デフォルトが使用され、weblogicHomemiddlewareHomeの子フォルダである場合は、オプションです。
複数のweblogicHomeがあるか、それがmiddlewareHomeの子フォルダでない場合は必須です。


使用例

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

繰り返しますが、構成より規則優先のアプローチの利点により、デフォルトの場所を使用する場合、middlewareHomeおよびdomainHomeの場所を指定する必要はありません。

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

<!-- WebLogic Server 12c Maven Plugin -->
<plugin>
    <groupId>com.oracle.weblogic</groupId>
    <artifactId>wls-maven-plugin</artifactId>
    <version>12.1.1.0</version>
    <configuration>
        <artifactLocation>
            com.oracle.weblogic:wls-dev:zip:12.1.1.0
        </artifactLocation>
        <user>weblogic</user>
        <password>welcome1</user>
        <filename>create-datasource.py</fileName>
    </configuration>
 </plugin>

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

例3-4 wlst

myuser:~/Projects/Java/wls-maven-doc/maven-demo $ mvn wls:wlst -DfileName=create-datasource.py 

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building maven-demo 1.0
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] --- wls-maven-plugin:12.1.1.0:wlst (default-cli) @ maven-demo ---
[INFO] ++====================================================================++
[INFO] ++  wls-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
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 10.686s
[INFO] Finished at: Wed Nov 23 16:55:25 CST 2011
[INFO] Final Memory: 13M/81M
[INFO] ------------------------------------------------------------------------

注意:

ビルドをただちに停止する意図がない場合は、WLST exit()コマンドを使用しないでください。