5 Application Development Framework (ADF)カスタムWLSTコマンド

この後の各項では、Oracle ADFのWLSTカスタム・コマンドおよび変数を詳細に説明します。内容は次のとおりです。

5.1 ADF WLSTコマンド・カテゴリの概要

構成またはランタイムBeanの階層の移動、およびプロンプト表示の制御を行うには、ADFベースのURL接続WLSTコマンドを使用します。getADFMArchiveConfigコマンドを使用して、ADFMArchiveConfigオブジェクトを管理します。

注意:

ADF固有のWLSTコマンドをオンライン、オフライン、またはその両方でWLSTとともに使用することができます。オフラインのWLSTコマンドはMavenからはサポートされません。

5.2 ADF固有のWLSTコマンド

表5-1のコマンドを使用して、URLベースの接続を管理します。

表5-1 WLST構成用の参照コマンド

使用するコマンド	目的	WLSTでの使用
adf_createFileUrlConnection	新しいADFファイル接続を作成します。	オンライン
adf_deleteURLConnection	ADF URL接続を削除します。	オンライン
adf_createHttpUrlConnection	新しいADF URL接続を作成します。	オンライン
adf_setURLConnectionAttributes	新しく作成したADF接続または既存のADF接続の属性を設定および編集します。	オンライン
adf_listUrlConnection	新しいURL接続を一覧表示します。	オンライン
getADFMArchiveConfig	指定したアーカイブの`ADFMArchiveConfig`オブジェクトにハンドルを返します。	オンラインまたはオフライン
exportJarVersions	JARバージョンのCSV形式を現在の`ORACLE_HOME`から指定された場所にエクスポートします。	オフライン
exportApplicationJarVersions	指定されたアプリケーションのランタイムJARバージョンのCSV形式を指定された場所にエクスポートします。	オンライン
exportApplicationSelectedJarVersions	`Versions.xml`ファイルと連携して、選択したJARのJARバージョンのCSV形式を指定された場所にエクスポートします。	オンライン
createWebServiceConnection	ADFアプリケーションのWebサービス接続を作成します。	オンライン
listWebServiceConnection	ADFアプリケーションのWebサービス接続をリストします。	オンライン
deleteWebServiceConnection	ADFアプリケーションのWebサービス接続を削除します。	オンライン
listUpgradeHandlers	アプリケーションのすべてのアップグレード・ハンドラをリストします。	オンライン
upgradeADFMetadataApp	アプリケーションの登録済ADFメタデータをアップグレードします。	オンライン
upgradeADFMetadataAppHandlers	アプリケーションの、選択した登録済ADFメタデータをアップグレードします。	オンライン
upgradeADFMetadata	すべてのアプリケーションのすべての登録済ADFメタデータをアップグレードします。	オンライン
upgradeADFMetadataHandlers	すべてのアプリケーションの、選択した登録済ADFメタデータをアップグレードします。	オンライン

5.2.1 adf_createFileUrlConnection

WLSTでの使用: オンライン。

説明

oracle.adf.model.connection.url.FileURLConnection接続クラスに基づいて新しい接続を作成するには、このコマンドを使用します。

構文

adf_createFileURLConnection(appName, name, URL)

引数	定義
`appName`	接続が作成されるアプリケーション名
`name`	新しい接続の名前
`URL`	この接続に関連するURL

例

adf_createFileURLConnection('myapp','tempDir','/scratch/tmp')

5.2.2 adf_deleteURLConnection

WLSTでの使用: オンライン。

説明

ADF URL接続を削除するには、このコマンドを使用します。

構文

adf_deleteURLConnection(appName, name)

引数	定義
`appName`	接続を削除するアプリケーションの名前。
`name`	削除する接続の名前。

例5-1 例

adf_deleteURLConnection('myApp', 'mycompany')

5.2.3 adf_createHttpUrlConnection

WLSTでの使用: オンライン。

説明

oracle.adf.model.connection.url.HttpURLConnection接続タイプ・クラスに基づいて新しい接続を作成するには、このコマンドを使用します。

構文

adf.createHttpURLConnection (appName, name, [URL], [authenticationType], [realm], [user], [password]

引数	定義
`appName`	接続が作成されるアプリケーション名
`name`	新しい接続の名前
`url`	(オプション)この接続に関連するURL
`authenticationType`	(オプション)デフォルトは「基本」です。
`realm`	(オプション)この接続は、認証のために使用する場合、これを設定する必要があります。デフォルトは「基本」です。
`user`	(オプション)
`password`	(オプション)

例

adf_createHttpURLConnection('myapp','cnn','http://www.cnn.com')

5.2.4 adf_setURLConnectionAttributes

WLSTでの使用: オンライン。

説明

新しく作成したADF接続または既存のADF接続の属性を設定および編集するにはこのコマンドを使用します。

構文

adf_setURLConnectionAttributes(appname, connectionname, attributes)

引数	定義
`appname`	接続が作成されるアプリケーション名
`connectionname`	新しい接続の名前
`attributes`	キーと値のペアに設定する属性を含む配列。

例

adf_setURLConnectionAttributes ('myapp','cnn','ChallengeAuthenticationType:digest',
'AuthenticationRealm:XMLRealm'

5.2.5 adf_listUrlConnection

WLSTでの使用: オンライン。

説明

このコマンドを使用して、アプリケーションの接続を示します。

構文

adf_listURLConnection(appname)

引数	定義
`appname`	アプリケーション名

例

adf_listURLConnection ('myapp')

5.2.6 getADFMArchiveConfig

WLSTでの使用: オンラインまたはオフライン。

説明

指定したアーカイブのADFMArchiveConfigオブジェクトにハンドルを返します。返されるADFMArchiveConfigオブジェクトのメソッドは、アーカイブ内のアプリケーション構成を変更するために使用できます。

ADFMArchiveConfigオブジェクトでは、次のメソッドが提供されます。

setDatabaseJboSQLBuilder([value]) - データベースjbo.SQLBuilder属性を設定します。
getDatabaseJboSQLBuilder() - jbo.SQLBuilder属性の現在の値を返します。
setDatabaseJboSQLBuilderClass([value]) - データベースjbo.SQLBuilderClass属性を設定します。値は、カスタム・ビルダー・クラスのフルネームです。
getDatabaseJboSQLBuilderClass() - jbo.SQLBuilderClass属性の現在の値を返します。
setDefaultRowLimit([value]) - デフォルトrowLimit属性を設定します。値は、行の長さ制限を指定します(デフォルトは-1)。
getDefaultRowLimit() - rowLimit属性の現在の値を返します。
save([toLocation]) - toLocationを指定する場合、変更はターゲット・アーカイブ・ファイルに格納され、元のファイルは変更されないままです。これを指定しない場合、変更は元のファイル自体に保存されます。

構文

archiveConfigObject = ADFMAdmin.getADFMArchiveConfig(fromLocation)

引数	定義
`fromLocation`	完全パスを含むearファイルの名前。

setDatabaseJboSQLBuilder([value])の構文は次のとおりです:

archiveConfigObject.setDatabaseJboSQLBuilder([value])

引数	定義
`value`	`jbo.SQLBuilder`属性の値。有効な値は、Oracle(デフォルト)、OLite、DB2、SQL92、SQLServer、Customです。'Custom'を指定した場合、`jbo.SQLBuilderClass`属性も設定する必要があります。

getDatabaseJboSQLBuilder()の構文は次のとおりです:

archiveConfigObject.getDatabaseJboSQLBuilder()

setDatabaseJboSQLBuilderClass([value])の構文は次のとおりです:

archiveConfigObject.setDatabaseJboSQLBuilderClass([value])

引数	定義
`value`	`jbo.SQLBuilderClass`属性の値。

getDatabaseJboSQLBuilderClass()の構文は次のとおりです:

archiveConfigObject.getDatabaseJboSQLBuilderClass()

setDefaultRowLimit([value])の構文は次のとおりです:

archiveConfigObject.setDefaultRowLimit([value])

引数	定義
`value`	`rowLimit`属性の値。

getDefaultRowLimit()の構文は次のとおりです:

archiveConfigObject.getDefaultRowLimit([value])

save([toLocation])の構文は次のとおりです:

archiveConfigObject.save([toLocation])

引数	定義
`toLocation`	変更が保存先ファイルの絶対パスを含む名前。

例

次の例では、jbo.SQLBuilder属性は、'DB2'に設定されています。

wls:/offline> archive =
               ADFMAdmin.getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wls:/offline> archive.setDatabaseJboSQLBuilder(value='DB2') 
wls:/offline> archive.save()

次の例では、jbo.SQLBuilder属性が削除され、アプリケーション・デフォルトが使用されます。

wls:/offline> archive =
              ADFMAdmin.getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wls:/offline> archive.setDatabaseJboSQLBuilder()
wls:/offline> archive.save(toLocation='/tmp/targetArchive.ear')

次の例では、jbo.SQLBuilder属性が'Custom'に設定され、jbo.SQLBuilderClass属性がクラス'com.example.CustomBuilder'に設定されます。

wls:/offline> archive =
              ADFMAdmin.getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wls:/offline> archive.setDatabaseJboSQLBuilder('Custom') 
wls:/offline> archive.setDatabaseJboSQLBuilderClass('com.example.CustomBuilder') 
wls:/offline> archive.save(toLocation='/tmp/targetArchive.ear')

次の例では、rowLimit属性が100に設定されます。

wls:/offline> archive = getADFMArchiveConfig(fromLocation='/tmp/testArchive.ear')
wls:/offline> archive.setDefaultRowLimit(100)
wls:/offline> archive.save(toLocation='/tmp/targetArchive.ear')

5.2.7 exportJarVersions

WLSTでの使用: オフライン。

説明

JARバージョンのCSV形式を、現在のORACLE_HOMEから指定された場所にエクスポートするために使用します。エクスポートされたJARバージョン情報は、Oracle OpenOfficeまたはMS Excelで開くことができます。

構文

exportJarVersions(path)

引数	定義
path	JARバージョンの抽出場所です。

例

この例は、JARバージョンを/tmp/export-MyApp-Versions.csv にエクスポートする方法を示します。CSVファイルのR/W権限を確認する必要があります。

wls:/offline>exportJarVersions('/tmp/export-MyApp-Versions.csv')

5.2.8 exportApplicationJarVersions

WLSTでの使用: オンライン。

説明

指定されたアプリケーションのランタイムJARバージョンのCSV形式を、指定された場所にエクスポートするために使用します。

構文

exportApplicationJarVersions(applicationName, path)

引数	定義
applicationName	JARバージョンをエクスポートするアプリケーションの名前です。
path	JARバージョンのエクスポート先です。

例

この例では、MyAppランタイムJARバージョンがどのように/tmp/export-MyApp-Versions.csvにエクスポートされるかを示します。CSVファイルのR/W権限を確認する必要があります。

wls:/DefaultDomain/serverConfig>exportApplicationJarVersions('MyApp',
'/tmp/export-MyApp-Versions.csv')

5.2.9 exportApplicationSelectedJarVersions

WLSTでの使用: オンライン。

説明

選択したJARのJARバージョンのCSV形式を、指定された場所にエクスポートするために使用します。　

構文

exportApplicationSelectedJarVersions(applicationName, path, jarsLocation)

引数定義

引数	定義
applicationName	JARバージョンをエクスポートするアプリケーション名。
path	JARバージョンの抽出場所です。
jarsLocation	選択したJARのオプションのリスト。指定しない場合、`%WLSDOMAIN%/config/fmwconfig/Versions.xml`のデフォルトのJARランタイム・バージョンのリストがエクスポートされます。 `Versions.xml`の`selectedJars`プロパティが空の場合は、`adfm.jar`、`adf-richclient-impl-11.jar`、`adf-controller.jar`、`adf-pageflow-impl.jar`、`adf-share-support.jar`および`mdsrt.jar` のバージョン情報がエクスポートされます。

applicationName

JARバージョンをエクスポートするアプリケーション名。

path

JARバージョンの抽出場所です。

jarsLocation

選択したJARのオプションのリスト。指定しない場合、%WLSDOMAIN%/config/fmwconfig/Versions.xmlのデフォルトのJARランタイム・バージョンのリストがエクスポートされます。

Versions.xmlのselectedJarsプロパティが空の場合は、adfm.jar、adf-richclient-impl-11.jar、adf-controller.jar、adf-pageflow-impl.jar、adf-share-support.jarおよびmdsrt.jar のバージョン情報がエクスポートされます。

例

この例は、Versions.xmlファイルのselectedJarsプロパティを使用してJARバージョンを/tmp/export-MyApp-Versions.csvにエクスポートする方法を示します。この例ではjarsLocationパラメータが指定されていないため、Versions.xmlファイルのselectedJarsプロパティにリストされたライブラリがエクスポートされます。CSVファイルのR/W権限を確認する必要があります。

wls:/offline>exportApplicationSelectedJarVersions('MyApp',
'/tmp/export-MyApp-Versions.csv') 

Versions.xml
<Diagnostics xmlns="xmlns.oracle.com/adf/diagnostics">
  <Versions xmlns="xmlns.oracle.com/adf/diagnostics/versions"
    exportVersionsOnApplicationStartup="true" 
    selectedJars="$ORACLE_HOME$/modules/oracle.adf.model_11.1.1/adfm.jar;
      $ORACLE_HOME$/modules/oracle.adf.view_11.1.1/adf-richclient-impl-11.jar;
      $ORACLE_HOME$/modules/oracle.adf.controller_11.1.1/adf-controller.jar;
      $ORACLE_HOME$/modules/oracle.adf.pageflow_11.1.1/adf-pageflow-impl.jar;
      $ORACLE_HOME$/modules/oracle.adf.share_11.1.1/adf-share-support.jar;
      $ORACLE_HOME$/modules/oracle.mds_11.1.1/mdsrt.jar" />
</Diagnostics>

この例は、jarsLocationパラメータを使用してJARバージョンを/tmp/export-MyApp-Versions.csvにエクスポートする方法を示します。この場合、jarsLocationパラメータで明示的に渡されたライブラリがエクスポートされます。CSVファイルのR/W権限を確認する必要があります。

wls:/offline>exportApplicationSelectedJarVersions('MyApp',
'/tmp/export-MyApp-Versions.csv',
'$ORACLE_HOME$/modules/oracle.adf.model_11.1.1/adfm.jar;$ORACLE_HOME$/modules/oracle.adf.view_11.1.1/adf-richclient-impl-11.jar')

5.2.10 createWebServiceConnection

WLSTでの使用: オンライン。

説明

ADFアプリケーションのWebサービス接続を作成するために使用します。

サービス名とポート名のセットを{serviceName: portNameのリスト}の形式で返します。

例: {'PolicyReferenceEchoBeanService': array(java.lang.String,['PolicyReferenceEchoBeanPort'])}

構文

createWebServiceConnection(appName, wsConnName, wsdlUrlStr, readerProps)

引数	定義
appName	Webサービス接続が作成されるADFアプリケーションの名前
wsConnName	新しいWebサービス接続の名前
wsdlUrlStr	サービスWSDLのURL文字列の名前
readerProps	オプションのWSDLリーダー・プロパティ次に例を示します。 '["wsdl.reader.proxy.host=proxy.my.com", "wsdl.reader.proxy.port=80"]'

例

この例では、Webサービス接続mywsconn、およびWSDLのURL文字列http://myserver/myservice?WSDLを使用して、ADFアプリケーションmyappのWebサービス接続を作成する方法を示します。

createWebServiceConnection('myapp','mywsconn','http://myserver/myservice?WSDL')

5.2.11 listWebServiceConnection

WLSTでの使用: オンライン。

説明

ADFアプリケーションに関連するWebサービス接続を一覧表示するために使用します。

構文

listWebServiceConnection(appName)

引数	定義
appName	Webサービス接続が一覧表示されるADFアプリケーションの名前

例

この例では、アプリケーションmyappのWebサービス接続をリストする方法を示します。

listWebServiceConnection('myapp')

5.2.12 deleteWebServiceConnection

WLSTでの使用: オンライン。

説明

ADFアプリケーションに関連するWebサービス接続を削除するために使用します。

構文

listWebServiceConnection(appName, weConnName)

引数	定義
appName	Webサービス接続が削除されるADFアプリケーションの名前
wsConnName	削除されるWebサービス接続の名前

例

この例では、アプリケーションmyappからWebサービス接続mywsconnを削除する方法を示します。

deleteWebServiceConnection('myapp','mywsconn')

5.2.13 listUpgradeHandlers

WLSTでの使用: オンライン。

説明

アプリケーションのすべてのアップグレード・ハンドラをリストするために使用されます。

構文

listUpgradeHandlers(applicationName)

引数	定義
applicationName	アップグレード・ハンドラをリストする対象のアプリケーション名。

例

次の例では、MyAppアップグレード・ハンドラがリストされます。

wls:/DefaultDomain/serverConfig>listUpgradeHandlers('MyApp')

5.2.14 upgradeADFMetadataApp

WLSTでの使用: オンライン。

説明

アプリケーションのすべての登録済ADFメタデータをアップグレードするために使用されます。

構文

upgradeADFMetadataApp(applicationName,siteCC)

引数	定義
applicationName	ハンドラをアップグレードする対象のアプリケーション名。
siteCC	サイト・カスタマイゼーション・クラス名。

例

次の例では、アプリケーションのすべての登録済ADFメタデータがアップグレードされます。

wls:/DefaultDomain/serverConfig>upgradeADFMetadataApp('MyApp','oracle.apps.fnd.applcore.customization.SiteCC')

5.2.15 upgradeADFMetadataAppHandlers

WLSTでの使用: オンライン。

説明

アプリケーションの、選択した登録済ADFメタデータをアップグレードするために使用されます。

構文

upgradeADFMetadataAppHandlers(applicationName,sitecc,handlers)

引数	定義
applicationName	ハンドラをアップグレードする対象のアプリケーション名。
siteCC	サイト・カスタマイゼーション・クラス名。
handlers	更新する登録済ハンドラ。

例

次の例では、アプリケーションの、選択した登録済ADFメタデータがアップグレードされます。

wls:/DefaultDomain/serverConfig>upgradeADFMetadataAppHandlers('MyApp','oracle.apps.fnd.applcore.customization.SiteCC','http://xmlns.oracle.com/adf/metadataUpgrade/bc4j/propertiesUpgrade')

5.2.16 upgradeADFMetadata

WLSTでの使用: オンライン。

説明

すべてのアプリケーションのすべての登録済ADFメタデータをアップグレードするために使用されます。

構文

upgradeADFMetadata(siteCC)

引数	定義
siteCC	サイト・カスタマイゼーション・クラス名。

例

次の例では、すべてのアプリケーションのすべての登録済ADFメタデータがアップグレードされます。

wls:/DefaultDomain/serverConfig>upgradeADFMetadata('oracle.apps.fnd.applcore.customization.SiteCC')

5.2.17 upgradeADFMetadataHandlers

WLSTでの使用: オンライン。

説明

すべてのアプリケーションの、選択した登録済ADFメタデータをアップグレードするために使用されます。

構文

upgradeADFMetadataHandlers(sitecc,handlers)

引数	定義
siteCC	サイト・カスタマイゼーション・クラス名。
handlers	更新する登録済ハンドラ。

例

次の例では、すべてのアプリケーションの、選択した登録済ADFメタデータがアップグレードされます。

wls:/DefaultDomain/serverConfig>upgradeADFMetadataHandlers('oracle.apps.fnd.applcore.customization.SiteCC','http://xmlns.oracle.com/adf/metadataUpgrade/bc4j/propertiesUpgrade')

5.3 MavenによるADF固有のWLSTコマンドの使用

ADF固有のWLSTコマンドは、Mavenとともに使用できます。

一連のADF固有のカスタムWLSTコマンドをロードするには、次に示すように、com.oracle.adf groupIDおよびadf-wlst-dependencies artifactIdをweblogic-maven-pluginのPOMの<build>セクションで指定する必要があります。

<?xml version="1.0" encoding="UTF-8"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.test</groupId>
    <artifactId>wlst-test</artifactId>
    <version>1.0-SNAPSHOT</version>
  <build>
    <plugins>
      <plugin>
        <groupId>com.oracle.weblogic</groupId>
        <artifactId>weblogic-maven-plugin</artifactId>
        <version>12.1.4-0-0</version>
        <executions>
          <execution>
            <phase>compile</phase>
            <goals>
              <goal>wlst-client</goal>
            </goals>
            <configuration>
              <fileName>${project.basedir}/misc/test.py</fileName>
            </configuration>
          </execution>
        </executions>
        <dependencies>
          <dependency>
            <groupId>com.oracle.adf</groupId>
            <artifactId>adf-wlst-dependencies</artifactId>
            <version>12.1.4-0-0</version>
          </dependency>
         </dependencies>
      </plugin>
    </plugins>
  </build>
 
</project>