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

この章では、ADF用のカスタムWLSTコマンド、およびそのコマンド構文、引数、コマンド例を詳細に説明します。

次の項では、WLSTカスタム・コマンドと変数について詳細に説明します。次のトピックがあります。

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

注意:

これらのADFカスタムWLSTコマンドを使用するには、Oracle共通ホームからWLSTスクリプトを起動する必要があります。『Oracle Fusion Middleware管理者ガイド』の「カスタムWLSTコマンドの使用」を参照してください。

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

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

ADF固有のWLSTコマンド

URLベースの接続を管理するには、「表11-1」のコマンドを使用します。

表11-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	選択したJARのJARバージョンのCSV形式を、指定された場所に`Versions.xml`ファイルと一緒にエクスポートします。	オンライン

adf_createFileUrlConnection

WLSTの使用状況:オンラインまたはオフライン

説明

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

構文

adf_createFileURLConnection(appName, name, URL)

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

例

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

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')

adf_setURLConnectionAttributes

WLSTの使用状況:オンラインまたはオフライン

説明

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

構文

adf_setURLConnectionAttributes(appname, connectionname, attributes)

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

例

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

adf_listUrlConnection

WLSTの使用状況:オンラインまたはオフライン

説明

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

構文

adf_listURLConnection(appname)

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

例

adf_listURLConnection ('myapp')

getADFMArchiveConfig

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

説明

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

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

setDatabaseJboSQLBuilder([value]): データベースjbo.SQLBuilder属性を設定します。
getDatabaseJboSQLBuilder(): jbo.SQLBuilder属性の現在の値を返します。
setDatabaseJboSQLBuilderClass([value]): データベースjbo.SQLBuilderClass属性を設定します。値は、カスタム・ビルダー・クラスのフルネームです。
getDatabaseJboSQLBuilderClass(): jbo.SQLBuilderClass属性の現在の値を返します。
setDefaultRowLimit([value]): デフォルトrowLimit属性を設定します。値は、行制限を指定するlongです(デフォルト-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')

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')

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')

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

例

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