7 ADFアプリケーションのためのWLSTコマンド・リファレンス

この章では、Oracle WebLogic ServerでOracle ADFアプリケーションのデプロイ、管理および構成に使用できるWLSTコマンドについて説明します。

この章の内容は次のとおりです。

第7.1項「Oracle ADFのためのカスタムWSLTコマンドの概要」
第7.2項「ADF固有のWLSTコマンド」

7.1 Oracle ADFのためのカスタムWSLTコマンドの概要

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

Oracle ADFでカスタムWLSTコマンドを使用するには、Oracle共通ホームからWLSTスクリプトを起動する必要があります。カスタムのメタデータ・サービス(MDS)コマンドなど、その他のWLSTコマンドの詳細は、『WebLogic Server WLSTコマンド・リファレンス』を参照してください。

7.2 ADF固有のWLSTコマンド

ADFアプリケーションには表7-1のコマンドを使用します。

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

使用するコマンド	目的	WLSTでの使用
adf_createFileUrlConnection	新しいADFファイル接続を作成します。	オンラインまたはオフライン
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サービス接続の削除。	オンライン

7.2.1 adf_createFileUrlConnection

WLSTとともに、オンラインまたはオフラインで使用します。

7.2.1.1 説明

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

7.2.1.2 構文

adf_createFileURLConnection(appName, name, URL)

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

7.2.1.3 例

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

7.2.2 adf_createHttpUrlConnection

WLSTとともに、オンラインまたはオフラインで使用します。

7.2.2.1 説明

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

7.2.2.2 構文

adf_createHttpURLConnection (appName, name, [URL], [authenticationType], [realm], [user], [password])

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

7.2.2.3 例

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

7.2.3 adf_setURLConnectionAttributes

WLSTとともに、オンラインまたはオフラインで使用します。

7.2.3.1 説明

このコマンドは、新たに作成されたADF接続または既存のADF接続の属性を設定または編集する際に使用します。

7.2.3.2 構文

adf_setURLConnectionAttributes(appname, connectionname, attributes)

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

7.2.3.3 例

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

7.2.4 adf_listUrlConnection

WLSTとともに、オンラインまたはオフラインで使用します。

7.2.4.1 説明

このコマンドは、アプリケーションの接続をリストする際に使用します。

7.2.4.2 構文

adf_listURLConnection(appname)

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

7.2.4.3 例

adf_listURLConnection ('myapp')

7.2.5 getADFMArchiveConfig

WLSTとともに、オンラインまたはオフラインで使用します。

7.2.5.1 説明

指定されたアーカイブの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を指定すると、変更はターゲットのアーカイブ・ファイルに保存され、元のファイルは変更されません。そうしない場合、変更は元のファイル自体に保存されます。

7.2.5.2 構文

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`	変更を保存するファイル名および絶対パス。

7.2.5.3 例

次の例では、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')

7.2.6 exportJarVersions

WLSTとともにオフラインで使用します。

7.2.6.1 説明

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

7.2.6.2 構文

exportJarVersions(path)

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

7.2.6.3 例

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

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

7.2.7 exportApplicationJarVersions

WLSTとともにオンラインで使用します。

7.2.7.1 説明

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

7.2.7.2 構文

exportApplicationJarVersions(applicationName, path)

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

7.2.7.3 例

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

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

7.2.8 exportApplicationSelectedJarVersions

WLSTとともにオンラインで使用します。

7.2.8.1 説明

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

7.2.8.2 構文

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`のバージョン情報がエクスポートされます。

7.2.8.3 例

この例は、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')

7.2.9 createWebServiceConnection

WLSTとともにオンラインで使用します。

7.2.9.1 説明

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

一連のサービス名およびポート名を{serviceName: portNameのリスト}の形式で返します。

たとえば、{'PolicyReferenceEchoBeanService': array(java.lang.String,['PolicyReferenceEchoBeanPort'])}です。

7.2.9.2 構文

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"]'

7.2.9.3 例

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

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

7.2.10 listWebServiceConnection

WLSTとともにオンラインで使用します。

7.2.10.1 説明

ADFアプリケーションと関連付けられているWebサービス接続をリストするために使用します。

7.2.10.2 構文

listWebServiceConnection(appName)

引数	定義
appName	Webサービス接続をリストするADFアプリケーションの名前。

7.2.10.3 例

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

listWebServiceConnection('myapp')

7.2.11 deleteWebServiceConnection

WLSTとともにオンラインで使用します。

7.2.11.1 説明

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

7.2.11.2 構文

listWebServiceConnection(appName, weConnName)

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

7.2.11.3 例

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

deleteWebServiceConnection('myapp','mywsconn')