Oracle® Fusion Middleware

インフラストラクチャ・コンポーネントWLSTコマンド・リファレンス

12c (12.2.1.2)

E82651-02(原本部品番号:E77585-03)

2016年12月

このドキュメントでは、WebLogic Scripting Tool (WLST)で利用できるすべてのFusion Middlewareインフラストラクチャ・コンポーネントのコマンドについて説明します。

Oracle Fusion Middlewareインフラストラクチャ・コンポーネントWLSTコマンド・リファレンス, 12c (12.2.1.2)

E82651-02

Copyright © 2015, 2016, Oracle and/or its affiliates  All rights reserved.

原本著者: Helen Grembowicz、Annies Ephraim、Krithika Gangadhar

このソフトウェアおよび関連ドキュメントの使用と開示は、ライセンス契約の制約条件に従うものとし、知的財産に関する法律により保護されています。ライセンス契約で明示的に許諾されている場合もしくは法律によって認められている場合を除き、形式、手段に関係なく、いかなる部分も使用、複写、複製、翻訳、放送、修正、ライセンス供与、送信、配布、発表、実行、公開または表示することはできません。このソフトウェアのリバース・エンジニアリング、逆アセンブル、逆コンパイルは互換性のために法律によって規定されている場合を除き、禁止されています。

ここに記載された情報は予告なしに変更される場合があります。また、誤りが無いことの保証はいたしかねます。誤りを見つけた場合は、オラクル社までご連絡ください。

このソフトウェアまたは関連ドキュメントを、米国政府機関もしくは米国政府機関に代わってこのソフトウェアまたは関連ドキュメントをライセンスされた者に提供する場合は、次の通知が適用されます。

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations.As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs.No other rights are granted to the U.S. Government.

このソフトウェアもしくはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアもしくはハードウェアは、危険が伴うアプリケーション(人的傷害を発生させる可能性があるアプリケーションを含む)への用途を目的として開発されていません。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性(redundancy)、その他の対策を講じることは使用者の責任となります。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、オラクル社およびその関連会社は一切の責任を負いかねます。

OracleおよびJavaはOracle Corporationおよびその関連企業の登録商標です。その他の名称は、それぞれの所有者の商標または登録商標です。

Intel、Intel Xeonは、Intel Corporationの商標または登録商標です。すべてのSPARCの商標はライセンスをもとに使用し、SPARC International, Inc.の商標または登録商標です。AMD、Opteron、AMDロゴ、AMD Opteronロゴは、Advanced Micro Devices, Inc.の商標または登録商標です。UNIXは、The Open Groupの登録商標です。

このソフトウェアまたはハードウェア、そしてドキュメントは、第三者のコンテンツ、製品、サービスへのアクセス、あるいはそれらに関する情報を提供することがあります。適用されるお客様とOracle Corporationとの間の契約に別段の定めがある場合を除いて、Oracle Corporationおよびその関連会社は、第三者のコンテンツ、製品、サービスに関して一切の責任を負わず、いかなる保証もいたしません。適用されるお客様とOracle Corporationとの間の契約に定めがある場合を除いて、Oracle Corporationおよびその関連会社は、第三者のコンテンツ、製品、サービスへのアクセスまたは使用によって損失、費用、あるいは損害が発生しても一切の責任を負いかねます。

目次

タイトルおよび著作権情報

はじめに

- 対象読者

- ドキュメントのアクセシビリティについて

- 関連ドキュメント

- 表記規則

このガイドで説明する新機能

- 新機能と変更点 12.2.1.2

- 12c (12.2.1)での新機能および変更された機能

1 Infrastructure WLSTコマンドの概要とロードマップ

- 1.1 マニュアルの範囲および対象読者

- 1.2 関連ドキュメント

- 1.3 WebLogic Scripting Tool (WLST)の呼出し

2 Oracle JRFカスタムWLSTコマンド

- 2.1 Oracle JRFコマンド

- 2.1.1 applyJRF

- 2.1.2 cloneDeployments

3 WebサービスのカスタムWLSTコマンド

- 3.1 WebサービスのWLSTコマンドの概要

- 3.1.1 アプリケーション名、コンポジット名およびサービス名の指定

- 3.1.2 ポリシー・サブジェクトの特定

- 3.1.3 WebサービスのWLSTコマンド・カテゴリ

- 3.2 セッション・コマンド

- 3.2.1 abortWSMSession

- 3.2.2 beginWSMSession

- 3.2.3 commitWSMSession

- 3.2.4 describeWSMSession

- 3.3 ポリシー・サブジェクト・コマンド

- 3.3.1 displayWSMEffectivePolicySet

- 3.3.2 listWSMPolicySubjects

- 3.3.3 listWSMResources

- 3.3.4 previewWSMEffectivePolicySet

- 3.3.5 registerWSMResource

- 3.3.6 selectWSMPolicySubject

- 3.3.7 selectWSMResource

- 3.4 構成コマンド

- 3.4.1 configureWSMKeystore

- 3.4.2 displayWSMConfiguration

- 3.4.3 setWSMConfiguration

- 3.4.4 setWSMResourceField

- 3.5 診断コマンド

- 3.5.1 checkWSMStatus

- 3.6 Webサービスおよびクライアント管理コマンド

- 3.6.1 listWebServiceClientPorts

- 3.6.2 listWebServiceClients

- 3.6.3 listWebServiceClientStubProperties

- 3.6.4 listWebServicePorts

- 3.6.5 listWebServices

- 3.6.6 setWebServiceClientStubProperties

- 3.6.7 setWebServiceClientStubProperty

- 3.7 ポリシー管理コマンド

- 3.7.1 attachWebServiceClientPolicies

- 3.7.2 attachWebServiceClientPolicy

- 3.7.3 attachWebServicePolicies

- 3.7.4 attachWebServicePolicy

- 3.7.5 attachWSMPolicies

- 3.7.6 attachWSMPolicy

- 3.7.7 detachWebServiceClientPolicies

- 3.7.8 detachWebServiceClientPolicy

- 3.7.9 detachWebServicePolicies

- 3.7.10 detachWebServicePolicy

- 3.7.11 detachWSMPolicies

- 3.7.12 detachWSMPolicy

- 3.7.13 enableWebServiceClientPolicies

- 3.7.14 enableWebServiceClientPolicy

- 3.7.15 enableWebServicePolicies

- 3.7.16 enableWebServicePolicy

- 3.7.17 enableWSMPolicies

- 3.7.18 enableWSMPolicy

- 3.7.19 listAvailableWebServicePolicies

- 3.7.20 listWebServiceClientPolicies

- 3.7.21 listWebServicePolicies

- 3.7.22 setWebServicePolicyOverride

- 3.7.23 setWSMPolicyOverride

- 3.8 ポリシー・セット管理コマンド

- 3.8.1 abortRepositorySession

- 3.8.2 attachPolicySet

- 3.8.3 attachPolicySetPolicy

- 3.8.4 beginRepositorySession

- 3.8.5 clonePolicySet

- 3.8.6 cloneWSMPolicySet

- 3.8.7 commitRepositorySession

- 3.8.8 createPolicySet

- 3.8.9 createWSMPolicySet

- 3.8.10 deleteAllPolicySets

- 3.8.11 deleteWSMAllPolicySets

- 3.8.12 deletePolicySet

- 3.8.13 deleteWSMPolicySet

- 3.8.14 describeRepositorySession

- 3.8.15 detachPolicySetPolicy

- 3.8.16 displayPolicySet

- 3.8.17 displayWSMResource

- 3.8.18 displayWSMPolicySet

- 3.8.19 enablePolicySet

- 3.8.20 enablePolicySetPolicy

- 3.8.21 enableWSMPolicySet

- 3.8.22 listPolicySets

- 3.8.23 listWSMPolicySets

- 3.8.24 migrateAttachments

- 3.8.25 modifyPolicySet

- 3.8.26 selectWSMPolicySet

- 3.8.27 setPolicySetConstraint

- 3.8.28 setPolicySetDescription

- 3.8.29 setPolicySetPolicyOverride

- 3.8.30 setWSMPolicySetConstraint

- 3.8.31 setWSMPolicySetDescription

- 3.8.32 setWSMPolicySetOverride

- 3.8.33 setWSMPolicySetScope

- 3.8.34 unregisterWSMResource

- 3.8.35 validatePolicySet

- 3.8.36 validateWSMPolicySet

- 3.9 OWSMリポジトリ管理コマンド

- 3.9.1 exportRepository

- 3.9.2 exportWSMAppMetadata

- 3.9.3 exportWSMRepository

- 3.9.4 importRepository

- 3.9.5 importWSMArchive

- 3.9.6 migrateWSMPMRoles

- 3.9.7 migrateWSMAttachments

- 3.9.8 resetWSMPolicyRepository

- 3.9.9 resetWSMRepository

- 3.9.10 upgradeWSMPolicyRepository

- 3.9.11 upgradeWSMRepository

- 3.10 トークン発行者信頼構成コマンド

- 3.10.1 createWSMTokenIssuerTrustDocument

- 3.10.2 deleteWSMTokenIssuerTrust

- 3.10.3 deleteWSMTokenIssuerTrustAttributeRule

- 3.10.4 deleteWSMTokenIssuerTrustDocument

- 3.10.5 displayWSMTokenIssuerTrust

- 3.10.6 exportWSMTokenIssuerTrustMetadata

- 3.10.7 importWSMTokenIssuerTrustMetadata

- 3.10.8 listWSMTokenIssuerTrustDocuments

- 3.10.9 revokeWSMTokenIssuerTrust

- 3.10.10 selectWSMTokenIssuerTrustDocument

- 3.10.11 setWSMTokenIssuerTrust

- 3.10.12 setWSMTokenIssuerTrustAttributeFilter

- 3.10.13 setWSMTokenIssuerTrustAttributeMapping

- 3.10.14 setWSMTokenIssuerTrustDisplayName

- 3.11 安全な会話セッション管理コマンド

- 3.11.1 getWebServiceSessionInfo

- 3.11.2 listWebServiceSessionNames

- 3.11.3 listWebServiceSessionNamesForKey

- 3.11.4 removeWebServiceSession

- 3.12 JKSキーストア構成コマンド

- 3.12.1 deleteWSMKeyStoreEntry

- 3.12.2 deleteWSMKeyStoreEntries

- 3.12.3 displayWSMCertificate

- 3.12.4 exportWSMCertificate

- 3.12.5 importWSMCertificate

- 3.12.6 listWSMKeystoreAliases

4 Metadata Services (MDS)のカスタムWLSTコマンド

- 4.1 共通名のパターン形式

- 4.2 リポジトリ管理コマンド

- 4.2.1 createMetadataPartition

- 4.2.2 deleteMetadataPartition

- 4.2.3 deregisterMetadataDBRepository

- 4.2.4 registerMetadataDBRepository

- 4.3 アプリケーション・メタデータ管理コマンド

- 4.3.1 deleteMetadata

- 4.3.2 exportMetadata

- 4.3.3 importMetadata

- 4.3.4 purgeMetadata

- 4.4 サンドボックス・メタデータ管理コマンド

- 4.4.1 destroyMDSSandbox

- 4.4.2 exportSandboxMetadata

- 4.4.3 importSandboxMetadata

- 4.4.4 listMDSSandboxes

- 4.5 アプリケーション・ラベル管理コマンド

- 4.5.1 createMetadataLabel

- 4.5.2 deleteMetadataLabel

- 4.5.3 listMetadataLabels

- 4.5.4 promoteMetadataLabel

- 4.5.5 purgeMetadataLabels

- 4.6 アプリケーション・デプロイメント管理コマンド

- 4.6.1 getMDSArchiveConfig

- 4.6.2 importMAR

- 4.7 マルチテナンシ管理コマンド

- 4.7.1 deprovisionTenant

- 4.7.2 listTenants

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

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

- 5.2 ADF固有のWLSTコマンド

- 5.2.1 adf_createFileUrlConnection

- 5.2.2 adf_deleteURLConnection

- 5.2.3 adf_createHttpUrlConnection

- 5.2.4 adf_setURLConnectionAttributes

- 5.2.5 adf_listUrlConnection

- 5.2.6 getADFMArchiveConfig

- 5.2.7 exportJarVersions

- 5.2.8 exportApplicationJarVersions

- 5.2.9 exportApplicationSelectedJarVersions

- 5.2.10 createWebServiceConnection

- 5.2.11 listWebServiceConnection

- 5.2.12 deleteWebServiceConnection

- 5.2.13 listUpgradeHandlers

- 5.2.14 upgradeADFMetadataApp

- 5.2.15 upgradeADFMetadataAppHandlers

- 5.2.16 upgradeADFMetadata

- 5.2.17 upgradeADFMetadataHandlers

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

6 DMSのカスタムWLSTコマンド

- 6.1 DMSの構成コマンド

- 6.1.1 listDMSConfigurationParameters

- 6.1.2 setDMSConfigurationParameter

- 6.2 DMSメトリック・コマンド

- 6.2.1 displayMetricTableNames

- 6.2.2 displayMetricTables

- 6.2.3 dumpMetrics

- 6.2.4 reloadMetricRules

- 6.3 DMSパラメータ・スコープ・メトリック・ルール・コマンド

- 6.3.1 createDMSScopedMetricsParameterConstraint

- 6.3.2 deleteDMSParameterScopedMetricsRules

- 6.3.3 dumpParameterScopedMetrics

- 6.3.4 listDMSContextParameters

- 6.3.5 listDMSParameterScopedMetricsRules

- 6.3.6 resetDMSParameterScopedMetrics

- 6.3.7 sampleDMSContextParameterValues

- 6.3.8 setDMSParameterScopedMetricsRule

- 6.4 DMSイベント・トレース・コマンド

- 6.4.1 addDMSEventDestination

- 6.4.2 addDMSEventFilter

- 6.4.3 addDMSEventRoute

- 6.4.4 enableDMSEventTrace

- 6.4.5 listDMSEventConfiguration

- 6.4.6 listDMSEventDestination

- 6.4.7 listDMSEventFilter

- 6.4.8 listDMSEventRoutes

- 6.4.9 removeDMSEventDestination

- 6.4.10 removeDMSEventFilter

- 6.4.11 removeDMSEventRoute

- 6.4.12 updateDMSEventDestination

- 6.4.13 updateDMSEventFilter

- 6.4.14 updateDMSEventRoute

7 ロギングのカスタムWLSTコマンド

- 7.1 ログの構成コマンド

- 7.1.1 configureLogHandler

- 7.1.2 getLogLevel

- 7.1.3 listLoggers

- 7.1.4 listLogHandlers

- 7.1.5 setLogLevel

- 7.2 検索および表示コマンド

- 7.2.1 displayLogs

- 7.2.2 listLogs

- 7.3 選択的トレース・コマンド

- 7.3.1 configureTraceProvider

- 7.3.2 configureTracingLoggers

- 7.3.3 listActiveTraces

- 7.3.4 listTraceProviders

- 7.3.5 listTracingLoggers

- 7.3.6 startTracing

- 7.3.7 stopTracing

8 診断フレームワークのカスタムWLSTコマンド

- 8.1 インシデント・コマンド

- 8.1.1 createAggregatedIncident

- 8.1.2 createIncident

- 8.1.3 getIncidentFile

- 8.1.4 listADRHomes

- 8.1.5 listIncidents

- 8.1.6 listProblems

- 8.1.7 queryIncidents

- 8.1.8 reloadCustomRules

- 8.1.9 showIncident

- 8.2 診断ダンプ・コマンド

- 8.2.1 describeDump

- 8.2.2 executeDump

- 8.2.3 listDumps

- 8.3 ダンプ・サンプリング・コマンド

- 8.3.1 addDumpSample

- 8.3.2 enableDumpSampling

- 8.3.3 getSamplingArchives

- 8.3.4 isDumpSamplingEnabled

- 8.3.5 listDumpSamples

- 8.3.6 removeDumpSample

- 8.3.7 updateDumpSample

9 User Messaging Service (UMS)のカスタムWLSTコマンド

- 9.1 UMS WLSTコマンド・グループ

- 9.1.1 configUserMessagingDriver

- 9.1.2 configUserMessagingServer

- 9.1.3 manageUserCommunicationPrefs

はじめに

このガイドでは、WebLogic Scripting Tool (WLST)で利用できるFusion Middlewareインフラストラクチャのコマンドについて説明します。

対象読者

このドキュメントは、Oracle Fusion Middlewareを構成またはアプリケーションを開発し、Oracle Fusion Middlewareインフラストラクチャ・コンポーネントでWLSTコマンドを使用する管理者および開発者を対象としています。

ドキュメントのアクセシビリティについて

Oracleのアクセシビリティについての詳細情報は、Oracle Accessibility ProgramのWebサイト(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc)を参照してください。

Oracle Supportへのアクセス

サポートをご購入のOracleのお客様は、My Oracle Supportにアクセスして電子サポートを受けることができます。詳細情報は(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info)か、聴覚に障害のあるお客様は(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs)を参照してください。

関連ドキュメント

いくつかのガイドで、WLSTに関する関連ドキュメントが提供されています。

WebLogic Scripting Toolの使用方法については、『Oracle Fusion Middleware WebLogic Scripting Toolの理解』を参照してください。

その他のWLSTコマンドおよびその他のWebLogic Server管理インタフェースについては、次を参照してください。

- 『Oracle Fusion Middleware WebLogic Server WLSTコマンド・リファレンス』では、WebLogic ServerのWLSTコマンドについて説明しています。

- Oracle Fusion Middlewareインフラストラクチャ・セキュリティWLSTコマンド・リファレンスでは、Auditing、SSL、Oracle Identity Federation、Directory Integration Platform、Oracle Access Management (OAM)、Oracle Security Token ServiceおよびOracle Keystore Serviceなど、Oracle Fusion Middlewareインフラストラクチャ・セキュリティ・コンポーネントで使用可能なWLSTコマンドについて説明しています。

- 『Oracle Fusion Middleware SOA Suite WLSTコマンド・リファレンス』では、Oracle SOA SuiteおよびOracle Business Process Management (BPM)で使用可能なWLSTコマンドについて説明しています。

- 『Oracle Fusion Middleware WebCenter WLSTコマンド・リファレンス』 では、WebCenter Portal、WebCenter Content、WebCenter Information Rights Management (IRM)、WebCenter Imaging Process Management (IPM)などのWebCenterコンポーネントに使用可能なWLSTコマンドについて説明しています。

- 『Oracle Fusion Middleware Oracle HTTP Serverの管理』の「Oracle HTTP Server WLSTカスタム・コマンド」。

- Oracle Fusion Middleware Oracle Traffic Director WebLogic Scripting Toolコマンド・リファレンスでは、Oracle Traffic Directorで使用できるWLSTコマンドについて説明しています。

- 『Oracle Fusion Middleware Oracle WebLogic Serverアプリケーションの開発』の「Antタスクを使用したWebLogic Serverドメインの構成と使用」。WebLogic Serverインスタンスの起動と停止およびWebLogicドメインの構成のための、WebLogic Antタスクの使用について説明します。

- 『Oracle Fusion Middleware Oracle WebLogic Serverへのアプリケーションのデプロイ』の「デプロイメント・ツール」。アプリケーションやスタンドアロン・モジュールのデプロイ用にWebLogic Serverに用意されているいくつかのツールについて説明します。

- 『Oracle Fusion Middleware Oracle WebLogic Server管理コンソール・オンライン・ヘルプ』では、WebLogicドメインを管理およびモニターするためのWebベースのグラフィカル・ユーザー・インタフェースについて説明しています。

- 『Oracle Fusion Middleware構成ウィザードによるWebLogicドメインの作成』では、グラフィカル・ユーザー・インタフェースを使用したWebLogicドメインの作成または既存ドメインの拡張について説明しています。

- 『Oracle Fusion Middleware packおよびunpackコマンドを使用したテンプレートとドメインの作成』。既存のWebLogicドメインをすばやく簡単に再作成するコマンドについて説明します。

- 『Oracle Fusion Middleware Oracle WebLogic Server JMXによるカスタム管理ユーティリティの開発』。Java Management Extensions (JMX) APIを使用してWebLogic Serverリソースをモニターおよび変更する方法について説明します。

- 『Oracle Fusion Middleware SNMPによるOracle WebLogic Serverのモニタリング』では、Simple Network Management Protocol (SNMP)を使用してWebLogicドメインをモニターする方法について説明します。

表記規則

このマニュアルでは次の表記規則を使用します。

表記規則

意味

boldface

太字は、操作に関連するGraphical User Interface要素、または本文中で定義されている用語および用語集に記載されている用語を示します。

italic

イタリックは、ユーザーが特定の値を指定するプレースホルダ変数を示します。

monospace

固定幅フォントは、段落内のコマンド、URL、サンプル内のコード、画面に表示されるテキスト、または入力するテキストを示します。

このガイドで説明する新機能

次の各項目では、Oracle Fusion Middlewareインフラストラクチャ・コンポーネントのカスタムWLSTコマンドの新機能または変更された機能を紹介します。

- 新機能と変更点 12.2.1.2

- 12c (12.2.1)の新機能と変更された機能

新機能と変更点 12.2.1.2

次の各項目では、12.2.1.2での新機能および変更された機能を紹介します。

- Oracle Health Checker Utilityが更新されました。結果として、checkWSMStatusコマンドで新しいコンポーネントおよび属性がサポートされるようになりました。

12c (12.2.1)での新機能と変更された機能

次の各項目では、12.2.1での新機能および変更された機能を紹介します。

- WebサービスのWLSTコマンドに対する変更を次にまとめます。

- すべてのWebサービス・スタック間で一貫性を提供するために、WebサービスのWLSTフレームワークを再設計しました。その結果、多数の新規および非推奨になったOracle Infrastructure WebサービスのWLSTコマンドがあります。非推奨となったコマンドは、このドキュメント全体で特定されています。非推奨のコマンドおよび12cでの相当するコマンドをすべて示すリストは、『Oracle Fusion Middleware Oracle Fusion Middleware Infrastructureリリース・ノート』の非推奨となったOracle Infrastructure Webサービスのコマンドに関する項を参照してください。

- 新しいWebサービスのWLSTコマンド・カテゴリは、次のとおりです。

- セッションを管理するためのセッション・コマンド。

- Webサービスおよびクライアント・ポリシー・サブジェクトを表示および管理するためのポリシー・サブジェクト・コマンド。

- OWSMドメイン構成を表示および管理するための構成コマンド。

詳細は、「WebサービスのWLSTコマンド・カテゴリ」を参照してください。

- ポリシー・サブジェクトを特定するために使用するコマンド構文が変更されました。詳細は、「アプリケーション名、コンポジット名およびサービス名の指定」および「ポリシー・サブジェクトの特定」を参照してください。

- アプリケーション・メタデータのエクスポート、ポリシー・アタッチメントおよびロールの移行およびOWSMリポジトリのアップグレードのためのOWSMリポジトリの新しいWLSTコマンドが提供されています。詳細は、「OWSMリポジトリ管理コマンド」を参照してください。

- 「トークン発行者信頼構成コマンド」に記載されているとおり、Webサービスのトークン発行者信頼ドキュメントを管理するための新しいWLSTコマンドが提供されています。

- Oracle HTTP ServerのWLSTコマンドは、『Oracle Fusion Middleware Oracle HTTP Serverの管理』のOracle HTTP Server WLSTカスタム・コマンドに関する項にあります。

- DMSパラメータ・スコープ・メトリック・ルール用の新しいカスタムWLSTコマンド。詳細は、「DMSパラメータ・スコープ・メトリック・ルール・コマンド」を参照してください。

- Java EE Webサービスでグローバルにアタッチされたポリシーがサポートされるようになりました。この結果、グローバルにアタッチされたポリシーがJava EE Webサービスでサポートされていないことを伝える多数の注記が削除されました。さらに、「ポリシー・サブジェクト・コマンド」の下の多数のセクションが、この新しいサポートを反映して更新されました。

- ADFアプリケーションのWebサービス接続を作成、リスト、削除する新しいカスタムWLSTコマンド。詳細は、「createWebServiceConnection」を参照してください。

1 Infrastructure WLSTコマンドの概要とロードマップ

ADFアプリケーションのデプロイ、ログ・ファイルと診断データの管理、およびMDSリポジトリの管理には、Infrastructure WLSTコマンドを使用します。

トピック:

- ドキュメントのスコープと対象読者

- 関連ドキュメント

- WebLogic Scripting Tool (WLST)の呼出し

1.1 ドキュメントのスコープと対象読者

Oracle Fusion Middleware Infrastructureのコンポーネントおよびサービスを管理するには、WLST Infrastructureコマンドを使用します。

それらのコンポーネントおよびサービスを次に示します。

- ダイナミック・モニタリング・サービス(DMS)

- Logging

- Oracle Application Development Framework (ADF)

- Oracle Fusion Middleware診断フレームワーク

- Oracle JRF

- Oracle Infrastructure Webサービス

- Oracle Metadata Service (MDS)

- Oracle User Messaging Service。

注意:

指定されたOracle Fusion MiddlewareコンポーネントのカスタムWLSTコマンドは、そのコンポーネントがインストールされている場合のみ使用できます。

このドキュメントは、OracleのJava Platform, Enterprise Edition (Java EE)を使用してJava EEアプリケーションをデプロイする、Oracle Fusion Middleware管理者を対象としています。読者は、WebテクノロジおよびWebLogic Server製品およびFusion Middleware製品がインストールされているオペレーティング・システムとプラットフォームに精通していることを前提としています。

1.2 関連ドキュメント

いくつかのガイドで、WLSTに関する関連ドキュメントが提供されています。

WebLogic Scripting Toolの使用方法については、『Oracle Fusion Middleware WebLogic Scripting Toolの理解』を参照してください。

その他のWLSTコマンドおよびその他のWebLogic Server管理インタフェースについては、次を参照してください。

- 『Oracle Fusion Middleware WebLogic Server WLSTコマンド・リファレンス』では、WebLogic ServerのWLSTコマンドについて説明しています。

- Oracle Fusion Middlewareインフラストラクチャ・セキュリティWLSTコマンド・リファレンスでは、Auditing、SSL、Oracle Identity Federation、Directory Integration Platform、Oracle Access Management (OAM)、Oracle Security Token ServiceおよびOracle Keystore Serviceなど、Oracle Fusion Middlewareインフラストラクチャ・セキュリティ・コンポーネントで使用可能なWLSTコマンドについて説明しています。

- 『Oracle Fusion Middleware SOA Suite WLSTコマンド・リファレンス』では、Oracle SOA SuiteおよびOracle Business Process Management (BPM)で使用可能なWLSTコマンドについて説明しています。

- 『Oracle Fusion Middleware WebCenter WLSTコマンド・リファレンス』 では、WebCenter Portal、WebCenter Content、WebCenter Information Rights Management (IRM)、WebCenter Imaging Process Management (IPM)などのWebCenterコンポーネントに使用可能なWLSTコマンドについて説明しています。

- 『Oracle Fusion Middleware Oracle HTTP Serverの管理』の「Oracle HTTP Server WLSTカスタム・コマンド」。

- Oracle Fusion Middleware Oracle Traffic Director WebLogic Scripting Toolコマンド・リファレンスでは、Oracle Traffic Directorで使用できるWLSTコマンドについて説明しています。

- 『Oracle Fusion Middleware Oracle WebLogic Serverアプリケーションの開発』の「Antタスクを使用したWebLogic Serverドメインの構成と使用」。WebLogic Serverインスタンスの起動と停止およびWebLogicドメインの構成のための、WebLogic Antタスクの使用について説明します。

- 『Oracle Fusion Middleware Oracle WebLogic Serverへのアプリケーションのデプロイ』の「デプロイメント・ツール」。アプリケーションやスタンドアロン・モジュールのデプロイ用にWebLogic Serverに用意されているいくつかのツールについて説明します。

- 『Oracle Fusion Middleware Oracle WebLogic Server管理コンソール・オンライン・ヘルプ』では、WebLogicドメインを管理およびモニターするためのWebベースのグラフィカル・ユーザー・インタフェースについて説明しています。

- 『Oracle Fusion Middleware構成ウィザードによるWebLogicドメインの作成』では、グラフィカル・ユーザー・インタフェースを使用したWebLogicドメインの作成または既存ドメインの拡張について説明しています。

- 『Oracle Fusion Middleware packおよびunpackコマンドを使用したテンプレートとドメインの作成』。既存のWebLogicドメインをすばやく簡単に再作成するコマンドについて説明します。

- 『Oracle Fusion Middleware Oracle WebLogic Server JMXによるカスタム管理ユーティリティの開発』。Java Management Extensions (JMX) APIを使用してWebLogic Serverリソースをモニターおよび変更する方法について説明します。

- 『Oracle Fusion Middleware SNMPによるOracle WebLogic Serverのモニタリング』では、Simple Network Management Protocol (SNMP)を使用してWebLogicドメインをモニターする方法について説明します。

1.3 WebLogic Scripting Tool (WLST)の呼出し

WLSTは、Oracleホームのサブディレクトリにあります。

次の場所からWLSTを起動します。

(UNIX) ORACLE_HOME/oracle_common/common/bin/wlst.sh
(Windows) ORACLE_HOME\oracle_common\common\bin\wlst.cmd

2 Oracle JRFカスタムWLSTコマンド

Oracle JRF (Java Required Files)は、Oracleビジネス・アプリケーションおよびアプリケーション・フレームワークに共通の機能を提供するWebLogic Serverインストールに含まれていないコンポーネントで構成されています。

この章では、コマンド構文、引数、コマンド例などのOracle JRFのカスタムWLSTコマンドについて詳細に説明します。

Oracle JRFは、共通の場所にデプロイされている個別に開発したライブラリおよびアプリケーションで構成されています。Oracle JRFの一部とみなされるコンポーネントには、Oracle Application Development Framework、Oracle Fusion Middleware監査フレームワーク、ダイナミック・モニタリング・サービス、Fabric Common、HTTPクライアント、インフラストラクチャ・セキュリティ、Javaオブジェクト・キャッシュ、JMXフレームワーク、JPS、ロギング、MDS、OJSP.Next、Oracle Webサービス、Oracle Web Services Manager、Oracle TopLink、UCP、XDKなどがあります。

2.1 Oracle JRFコマンド

WLST JRFコマンドでは、Oracle JRFアプリケーションおよびサービスで管理対象サーバーまたはクラスタを構成することや、ある管理対象サーバーまたはクラスタからアプリケーションおよびサービスをコピーして別の管理対象サーバーまたはクラスタに適用することができます。

Oracle JRFアプリケーションで管理対象サーバーを構成するには、表2-1のコマンドを使用します。WLST列で使用する場合は、オンラインとは、コマンドが実行中のサーバーに接続されている場合のみに使用されることを意味します。オフラインとは、コマンドが実行中のサーバーに接続されてない場合のみに使用されることを意味します。オンラインまたはオフラインとは、コマンドは両方の状況に使用できることを意味します。

表2-1 JRFコマンド

使用するコマンド

目的

WLSTでの使用

applyJRF

Oracle JRFのアプリケーションおよびサービスで管理対象サーバーまたはクラスタを構成します。

オンラインまたはオフライン

cloneDeployments

管理対象サーバーまたはクラスタからアプリケーションまたはサービスをコピーして別の管理対象サーバーまたはクラスタに適用します。

オンラインまたはオフライン

2.1.1 applyJRF

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

説明

Oracle JRFで管理対象サーバーまたはクラスタを構成します。テンプレート拡張プロセス中に製品テンプレートにより追加した管理対象サーバーは、このコマンドを使用してJRFで明示的に構成する必要はありません。

製品テンプレートで初期拡張した後、追加の管理対象サーバーまたはクラスタがドメインに追加している場合は、applyJRFコマンドを使用します。JRF専用ドメインに管理対象サーバーを追加するときおよび他のOracle製品を含まれているドメインにJRFに対して構成されている管理対象サーバーを追加した場合は、applyJRFコマンドが必要です。

構文

applyJRF(target, [domainDir], [shouldUpdateDomain])

引数

定義

target

JRFアプリケーションまたはサービスで構成する管理サーバーまたはクラスタの名前。

対象のためのアスタリスク(*)の値は、すべてのクラスタおよびスタンドアロンの管理対象サーバーがJRFによって構成されている必要であることを示します。

domainDir

WebLogic Serverドメインの絶対パス。

shouldUpdateDomain

ドメインの更新を実行する方法を管理するブール型フラグ(オプション)。「true」に設定すると(デフォルト)、関数は次のオフライン・コマンドを暗黙的に呼び出します。readDomain()およびupdateDomain()、またはオンライン・コマンドのedit()、startEdit()、save()、およびactivate()

「false」に設定すると、ドメインを更新するには、WLSTコマンドを呼び出す必要があります。

例

次の例では、JRFと管理対象サーバーserver1を構成します。

wls:/offline> applyJRF('server1', '/my_path/user_templates/domains/my_domain')

2.1.2 cloneDeployments

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

説明

特定の管理対象サーバーまたは第2管理対象サーバーのクラスタを対象指定できるすべてのデプロイメントをレプリケートします。このコマンドは、既存の管理対象サーバーまたはクラスタと同じデプロイメントがあるように、新しい管理対象サーバーまたはクラスタを構成する便利なコマンドとして提供されます。

cloneDeploymentsコマンドは、新しい管理サーバーは作成しません。また、対象の管理対象サーバーにデプロイメント情報以外のプロパティはコピーされません。

構文

cloneDeployments(domain, source, target, [shouldUpdateDomain])

引数

定義

domain

WebLogic Serverドメインの絶対パス。ドメインを読み終わった場合またはオンライン・モードで接続した場合は、無視されます。

source

デプロイメントをクローンする管理対象サーバーまたはクラスタの名。これは、有効な管理対象サーバーまたはクラスタの名前にする必要があります。

target

ソース・サーバーのアプリケーションおよびサービスを受け取る対象の管理対象サーバーまたはクラスタ。対象の管理対象サーバーはすでに存在する必要があります。

shouldUpdateDomain

ドメインの更新を実行する方法を管理するブール型フラグ(オプション)。「true」に設定すると(デフォルト)、関数は次のオフライン・コマンドを呼び出します。readDomain()およびupdateDomain()、またはオンライン・コマンドのedit()、startEdit()、save()、およびactivate()。「false」に設定すると、ドメインを更新するには、WLSTコマンドを呼び出す必要があります。

例

次の例では、sourceServerからdestinationServerまでデプロイメントをレプリケートします。

wls:/offline> cloneDeployments( '/my_path/user_templates/domains/my_domain',
'sourceServer','destinationServer', 'false')

3 Webサービス・カスタムWLSTコマンド

この章では、Oracle Infrastructure Webサービス(SOAコンポジット、ADF Business Component、およびWebCenterサービスを含む)、Java EE WebサービスおよびRESTful WebサービスのWebLogic Scripting Tool (WLST)コマンドについて説明します。これらのコマンドを使用して、コマンドラインからWebサービスを管理できます。

注意:

この章で説明するカスタムWLSTコマンドのサブセットのみがJava EE Webサービスでサポートされます。

Oracle Infrastructure WebサービスおよびクライアントのWLSTコマンドのサブセットは非推奨になりました。非推奨コマンドをすべて示すリストは、『Oracle Fusion Middleware Oracle Fusion Middleware Infrastructureリリース・ノート』の非推奨となったOracle Infrastructure Webサービスのコマンドに関する項を参照してください。

WebサービスでのこれらのWLSTコマンドの使用方法の詳細は、次の各ドキュメントを参照してください。

- Oracle Fusion Middleware Webサービスの管理

- Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理

注意:

Webサービス・カスタムWLSTコマンドを使用するには、Oracle共通ホーム・ディレクトリからWLSTを起動する必要があります。『Oracle Fusion Middleware Oracle Fusion Middlewareの管理』のカスタムWLSTコマンドの使用に関する項を参照してください。

Webサービスおよびクライアント管理およびJava EE Webサービスのポリシー管理コマンドのヘルプを表示するには、サーバーの実行中のインスタンスに接続して、help('WebServices')と入力します。

その他のコマンドのヘルプを表示するには、サーバーの実行中のインスタンスに接続し、help('wsmManage')と入力します。

この章のトピックは、次のとおりです:

- WebサービスWLSTコマンドの概要

- セッション・コマンド

- ポリシー・サブジェクト・コマンド

- 構成コマンド

- 診断コマンド

- Webサービスおよびクライアント管理のコマンド

- ポリシー管理コマンド

- ポリシー・セット管理のコマンド

- OWSMリポジトリ管理コマンド

- トークン発行者信頼構成のコマンド

- 安全な会話セッション管理コマンド

- JKSキーストア構成コマンド

3.1 WebサービスWLSTコマンドの概要

次の操作を行うには、WebサービスのWLSTコマンドをオンライン・モードで使用できます。

- Webサービスの構成およびOWSMポリシー管理タスの実行

- OWSMリポジトリの管理

- OWSMコンポーネントのステータスをチェックします。

- SAML署名証明書に対する信頼できる発行者およびDNリストを表示および定義します。

注意:

実行するWLST操作に応じた適切なOWSM論理ロールがユーザーにマップされていることを確認してください。詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のユーザーのグループまたはロールの変更に関する項を参照してください。

WebサービスのWLST構成およびポリシー管理コマンドでは、Fusion Middleware Controlを使用して完了できる、デプロイ済、アクティブな、実行中のWebサービス・アプリケーションの管理などの多数の同様の管理機能を実行します。それらは、WLSTオンライン・モードでどの場所でも実行できます。例:

wls:/domain/serverConfig
wls:/domain/domainRuntime

次の各項では、WLSTコマンドの使用について詳しく説明します。

- アプリケーション、コンポジット、およびサービス名の指定

- ポリシー・サブジェクトの特定

- WebサービスWLSTコマンド・カテゴリ

3.1.1 アプリケーション、コンポジット、およびサービス名の指定

WebサービスのWLSTコマンドでは、特定のアプリケーションに対するWebサービスを構成します。したがって、アプリケーション・パス名は、アプリケーション、およびそれがデプロイされているサーバー・インスタンスを一意に識別する必要があります。

次の各項では、Webサービスを一意に特定するための、アプリケーション名およびサービス名の指定方法を説明します。

- Webサービスアプリケーション名の指定

- サービス名の指定

Webサービス・アプリケーション名の指定

WLSTコマンドでWebアービス・アプリケーションを指定するには、次の書式を使用します。

[/domain/server/]application[#version_number]

角カッコ[]内に示すパラメータはオプションです。次の例に、Webサービス・のアプリケーション名のサンプル書式を示します。

/base_domain/AdminServer/HelloWorld#1_0
/base_domain/server1/HelloWorld#1_0

1つのドメイン内にアプリケーションのデプロイ済インスタンスが1つのみある場合は、次の例に示すようにdomain/serverパラメータを省略できます。

HelloWorld#1_0

他のすべての場合は、domain/serverパラメータが必要です。指定されない場合およびWLSTでドメイン内に異なるサーバー上で同じアプリケーションの1つ以上のデプロイが検出された場合は、ドメインおよびサーバー名を指定するようにプロンプトが表示されます。

WebサービスおよびWebサービスのクライアント・アプリケーションは、WebLogic Serverのサーバー・インスタンスに直接デプロイされます。それぞれのアプリケーションは別々に管理されます。たとえば、アプリケーションmyappが、ドメインmydomainのAdminServerとserver1の両方のインスタンスにデプロイされている場合、適切なアプリケーション・パス名を使用して各サーバーに構成コマンドを発行する必要があります。

/mydomain/AdminServer/myapp#1_0
/mydomain/server1/myapp#1_0

サービス名の指定

Web ServiceおよびWeb Serviceクライアントに複数のバージョン(ネームスペース)のWebサービス名がある場合、ネームスペースおよびサービス名を次の書式で指定する必要があります。

{http://namespace/}serviceName

次の点に注意してください。

- Webサービスおよびクライアント管理コマンド、およびポリシー管理コマンドの場合、サービス名が1つのみに限定されている場合は、ネームスペースを入力する必要はありません。そのサービスのバージョンが複数あり、サービス名とともにネームスペースを指定しない場合、例外がスローされます。

- SOAコンポジットにはネームスペース({http://namespace/})を含めないでください。

- ポリシー・セット管理コマンドの場合、WebサービスおよびWebサービス・クライアント(ws-serviceおよびws-client)リソース・タイプに対して、ネームスペースとサービス名の両方を指定する必要があります。

詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のWeb Serviceのネームスペースの決定に関する項を参照してください。

3.1.2 ポリシー・サブジェクトの特定

Fusion Middleware ControlまたはWSM-Consoleを参照することなく、WLSTのポリシー・サブジェクトに移動できます。selectWSMPolicySubjectコマンドを使用することによって、ナビゲーション・モデルの理解とともに、階層ツリーを下に移動することでアプリケーション、アセンブリおよびサブジェクト名を検出できます。アセンブリはアプリケーション内のモジュールを一意に特定します(.warファイルなど)。

アプリケーションの選択

アプリケーション名が提供されている場合、変更する特定のアプリケーションを選択できます。

アプリケーション名の一部のみがわかっている場合、ワイルドカード文字を含むパターンを引数に指定できます。この場合、そのパターンに一致するすべてのアプリケーションがリストされます。次に、そのアプリケーションを選択して続行できます。引数を指定しない場合は、すべてのアプリケーション名がリストされます。

アプリケーション名がわかっている場合

アプリケーション名がわかっている場合、selectWSMPolicySubjectコマンドの引数としてそれを入力します。WLSTは、アプリケーションに含まれているアセンブリの名前を返します。

次の例では、jaxwsejb30wsをアプリケーションの名前として入力します。WLSTは、アプリケーションに含まれているアセンブリの名前である#jaxwsejbを返します。

wls:/base_domain/serverConfig> selectWSMPolicySubject('jaxwsejb30ws')

#jaxwsejb

Select any of the assembly name to proceed.

アプリケーション名の一部のみがわかっている場合

アプリケーション名の一部のみがわかっている場合、ワイルドカード文字を使用したパターンを入力できます。次の例では、selectWSMPolicySubjectコマンドに、jax*をアプリケーションの名前として入力します。WLSTは、文字列に一致するアプリケーションのリストを返します。

wls:/base_domain/serverConfig> selectWSMPolicySubject('jax*')

jaxws_provider
jaxwsejb30ws

Select any of the application name to proceed.

wls:/jrfServer_domain/serverConfig> selectWSMPolicySubject('jaxwsejb30ws')

#jaxws3jb
Select any of the assembly name to proceed

アプリケーション名がわからない場合

アプリケーション名がわからない場合、引数を指定せずにselectWSMPolicySubjectコマンドを入力します。WLSTは、システムが認識しているすべてのアプリケーションの名前を返します。次の例では、selectWSMPolicySubjectコマンドを引数なしで入力します。WLSTは、システムが認識しているすべてのアプリケーションの名前を返します。

wls:/base_domain/serverConfig> selectWSMPolicySubject()

SimpleRestApp
jaxws_provider
jaxwsejb30ws
wsm-pm

Select any of the application name to proceed.

wls:/jrfServer_domain/serverConfig> selectWSMPolicySubject('jaxwsejb30ws')
#jaxws3jb
Select any of the assembly name to proceed

アセンブリの選択

アプリケーション名およびアセンブリ名が提供されている場合、変更する特定のアセンブリを選択できます。

アセンブリ名の一部のみがわかっている場合、ワイルドカード文字を含むパターンを引数に指定できます。この場合、そのパターンに一致するすべてのアセンブリがリストされます。次に、そのアセンブリを選択して続行できます。引数を指定しない場合は、すべてのアセンブリ名がリストされます。

注意:

ws-connectionタイプのポリシー・サブジェクトでは、アセンブリ名に空の文字列''を使用します。

アセンブリ名がわかっている場合

アセンブリ名がわかっている場合、selectWSMPolicySubjectコマンドの引数としてアプリケーション名とともにアセンブリ名を入力します。WLSTは、アセンブリに含まれているサブジェクトの名前を返します。次の例では、jaxwsejb30wsをアプリケーションの名前として入力し、#jaxwsejbをアセンブリの名前として入力します。WLSTは、アセンブリに含まれているすべてのサブジェクトのリストを返します。

wls:/base_domain/serverConfig> selectWSMPolicySubject ('jaxwsejb30ws','#jaxwsejb')

WS-SERVICE({http://mycompany.com/targetNamespace}EchoEJBService#EchoEJBServicePort)
WS-SERVICE({http://mycompany.com/jaxws/tests/concrete}WsdlConcreteService#WsdlConcretePort)
WS-SERVICE({http://mycompany.com/jaxws/tests}CalculatorService#CalculatorPort)

WS-SERVICE({http://soapinterop.org/DoclitWrapperWTJ}DoclitWrapperWTJService#DoclitWrapperWTJPort)

WS-SERVICE({http://j2ee.tests.ejb.impl/}JaxwsWithHandlerChainBeanService#JaxwsWithHandlerChainBeanPort)

Select any of the subject name to proceed.

アセンブリ名の一部のみがわかっている場合

アセンブリ名の一部のみがわかっている場合、ワイルドカード文字を使用したパターンを入力できます。次の例では、selectWSMPolicySubjectコマンドに、#jaxws*をアセンブリの名前の一部として入力し、jaxwsejb30wsをアプリケーションの名前として入力します。WLSTは、アプリケーションに含まれているアセンブリの名前である#jaxwsejbを返します。

wls:/base_domain/serverConfig> selectWSMPolicySubject('jaxwsejb30ws','#jaxws*')

#jaxwsejb
Select any of the assembly name to proceed.

wls:/base_domain/serverConfig> selectWSMPolicySubject ('jaxwsejb30ws','#jaxwsejb')

WS-SERVICE({http://mycompany.com/targetNamespace}EchoEJBService#EchoEJBServicePort)
WS-SERVICE({http://mycompany.com/jaxws/tests/concrete}WsdlConcreteService#WsdlConcretePort)
WS-SERVICE({http://mycompany.com/jaxws/tests}CalculatorService#CalculatorPort)

WS-SERVICE({http://soapinterop.org/DoclitWrapperWTJ}DoclitWrapperWTJService#DoclitWrapperWTJPort)

WS-SERVICE({http://j2ee.tests.ejb.impl/}JaxwsWithHandlerChainBeanService#JaxwsWithHandlerChainBeanPort)

Select any of the subject name to proceed.

アセンブリ名がわからない場合

アセンブリ名がわからない場合、selectWSMPolicySubjectの引数としてアプリケーション名のみを入力します。WLSTは、システムが認識しているすべてのアセンブリの名前を返します。次の例では、selectWSMPolicySubjectコマンドの引数として、jaxwsejb30wsをアプリケーションの名前として入力します。WLSTは、システムが認識しているすべてのアセンブリの名前を返します。

wls:/base_domain/serverConfig> selectWSMPolicySubject('jaxwsejb30ws')

#jaxwsejb

Select any of the assembly name to proceed.

サブジェクトの選択

アプリケーション名、アセンブリ名およびポリシー・サブジェクト名が提供されている場合、変更する特定のポリシー・サブジェクトを選択できます。

ポリシー・サブジェクト名の一部のみがわかっている場合、ワイルドカード文字を含むパターンを引数に指定できます。この場合、そのパターンに一致するすべてのポリシー・サブジェクトがリストされます。次に、そのポリシー・サブジェクトを選択して続行できます。引数を指定しない場合は、すべてのポリシー・サブジェクト名がリストされます。

ポリシー・サブジェクト名がわかっている場合

ポリシー・サブジェクト名がわかっている場合、selectWSMPolicySubjectコマンドの引数として、アプリケーション名およびアセンブリ名とともにポリシー・サブジェクト名を入力します。WLSTは指定されたポリシー・サブジェクトを選択します。次の例では、jaxwsejb30wsをアプリケーションの名前として入力し、#jaxwsejbをアセンブリの名前として入力し、WS-SERVICE({http://mycompany.com/jaxws/tests/concrete}WsdlConcreteService#WsdlConcretePort)をポリシー・サブジェクトの名前として入力します。WLSTは、変更のために選択されたポリシー・サブジェクトを返します。

wls:/base_domain/serverConfig> selectWSMPolicySubject ('jaxwsejb30ws','#jaxwsejb','WS-SERVICE({http://mycompany.com/jaxws/tests/concrete}WsdlConcreteService#WsdlConcretePort)')

The policy subject is selected for modification.

ポリシー・サブジェクト名の一部のみがわかっている場合

ポリシー・サブジェクト名の一部のみがわかっている場合、ワイルドカード文字を使用したパターンを入力できます。次の例では、selectWSMPolicySubjectコマンドに、jaxwsejb30wsをアプリケーションの名前として入力し、#jaxwsejbをアセンブリの名前として入力し、ws-service(*)をポリシー・サブジェクトの名前として入力します。WLSTは、アセンブリに含まれているポリシー・サブジェクトの名前を返します。

wls:/base_domain/serverConfig>  selectWSMPolicySubject ('jaxwsejb30ws','#jaxwsejb', 'ws-service(*)')

WS-SERVICE({http://mycompany.com/targetNamespace}EchoEJBService#EchoEJBServicePort)
WS-SERVICE({http://mycompany.com/jaxws/tests/concrete}WsdlConcreteService#WsdlConcretePort)
WS-SERVICE({http://mycompany.com/jaxws/tests}CalculatorService#CalculatorPort)

WS-SERVICE({http://soapinterop.org/DoclitWrapperWTJ}DoclitWrapperWTJService#DoclitWrapperWTJPort)

WS-SERVICE({http://j2ee.tests.ejb.impl/}JaxwsWithHandlerChainBeanService#JaxwsWithHandlerChainBeanPort)

Select any of the subject name to proceed.

ポリシー・サブジェクト名がわからない場合

ポリシー・サブジェクト名がわからない場合、selectWSMPolicySubjectコマンドの引数としてアプリケーション名およびアセンブリ名を入力します。WLSTは、アセンブリに含まれているすべてのポリシー・サブジェクトの名前を返します。次の例では、selectWSMPolicySubjectコマンドの引数として、jaxwsejb30wsをアプリケーションの名前として、#jaxwsejbをアセンブリの名前として、Noneをポリシー・サブジェクトの名前として入力します。WLSTは、アセンブリに含まれているすべてのポリシー・サブジェクトの名前を返します。

wls:/base_domain/serverConfig> selectWSMPolicySubject ('jaxwsejb30ws','#jaxwsejb')

WS-SERVICE({http://mycompany.com/targetNamespace}EchoEJBService#EchoEJBServicePort)
WS-SERVICE({http://mycompany.com/jaxws/tests/concrete}WsdlConcreteService#WsdlConcretePort)
WS-SERVICE({http://mycompany.com/jaxws/tests}CalculatorService#CalculatorPort)

WS-SERVICE({http://soapinterop.org/DoclitWrapperWTJ}DoclitWrapperWTJService#DoclitWrapperWTJPort)

WS-SERVICE({http://j2ee.tests.ejb.impl/}JaxwsWithHandlerChainBeanService#JaxwsWithHandlerChainBeanPort)

Select any of the subject name to proceed.

3.1.3 WebサービスWLSTコマンド・カテゴリ

WebサービスのWLSTコマンドは、表3-1に説明するカテゴリに分かれています。

表3-1 WebサービスのWLSTコマンド・カテゴリ

コマンド・カテゴリ

定義

セッション・コマンド

セッションを管理し、セッションのコンテキスト内で実行する必要のある、リポジトリ・ドキュメントおよびポリシー・サブジェクト・コマンドの変更などの一部のWebサービスのWLSTコマンドで必要となります。

ポリシー・サブジェクト・コマンド

WebサービスおよびWebサービスのクライアント・ポリシー・サブジェクトを表示および管理します。

構成コマンド

OWSMドメイン構成情報を表示および管理します。

診断コマンド

製品が適切に機能するために必要なWSMコンポーネントのステータスをチェックします。

Webサービスおよびクライアント管理のコマンド

サービスおよびクライアントのWebサービスを表示および管理します。

ポリシー管理コマンド

サービスおよびクライアントのポリシー・アタッチメントを表示および管理します。これらのコマンドは、ポリシー・セット内の直接ポリシー・アタッチメントとグローバル・ポリシー・アタッチメントの両方を管理します。

ポリシー・セット管理のコマンド

セッション内のグローバルで使用可能なポリシー・セットを表示および管理します。

OWSMリポジトリ管理コマンド

ソフトウェアの最新インストールで提供される新しい事前定義ポリシーでOWSMを管理し、さらに、リポジトリに対してドキュメントをインポートおよびエクスポートします。

トークン発行者信頼構成のコマンド

SAML署名証明書の信頼できる発行者、信頼できる識別名(DN)リストおよびトークン属性ルール・フィルタを表示および定義します。

JKSキーストア構成コマンド

JKSキーストアの資格証明と証明書を表示および管理します。

3.2 セッション・コマンド

リポジトリ・ドキュメントおよびポリシー・サブジェクト・コマンドの変更などの一部のWebサービスのWLSTコマンドは、セッションのコンテキスト内で実行する必要があります。表3-2にリストされているWLSTコマンドを使用して、セッションを管理します。

表3-2 セッション管理WLSTコマンド

使用するコマンド

目的

WLSTでの使用

abortWSMSession

現在の変更セッションを中止し、セッション中に行われたすべての変更を破棄します。

オンライン

beginWSMSession

ポリシー・サブジェクトまたはOWSMリポジトリ・ドキュメントを変更するためのセッションを開始します。

オンライン

commitWSMSession

現在のセッションの内容をOWSMリポジトリに書き込みます。

オンライン

describeWSMSession

現在のセッションのコンテンツを記述します。これは、セッションが空であることを示すか、更新対象のドキュメントの名前を更新のタイプ(作成、変更または削除)とともにリストするかのいずれかです。

オンライン

3.2.1 abortWSMSession

コマンド・カテゴリ: セッション

WLSTでの使用: オンライン

説明

現在の変更セッションを中止し、セッション中に行われたすべての変更を破棄します。中止した内容を説明するメッセージが表示されます。現在のセッションがない場合は、エラーが表示されます。

構文

abortWSMSession()

例

次の例では、現在のOWSMセッションを中止します。

wls:/wls-domain/serverConfig>abortWSMSession()

3.2.2 beginWSMSession

コマンド・カテゴリ: セッション

WLSTでの使用: オンライン

説明

ポリシー・セット、Fusion Middleware Webサービス・エンドポイントなどのポリシー・サブジェクトを変更するためのセッションを開始します。セッションは、単一のポリシー・サブジェクトに対してのみ操作できます。セッションがすでに進行中の場合は、エラーが表示されます。

構文

beginWSMSession()

例

次の例では、OWSMセッションを開始します。

wls:/wls-domain/serverConfig>beginWSMSession()

3.2.3 commitWSMSession

コマンド・カテゴリ: セッション

WLSTでの使用: オンライン

説明

現在のセッション内で行われた変更を保持します。何がコミットされたのかを示すメッセージが表示されます。現在のセッションがない場合、エラーが表示されます。

構文

commitWSMSession()

例

次の例では、現在のリポジトリの変更セッションをコミットします。

wls:/wls-domain/serverConfig>commitWSMSession()

3.2.4 describeWSMSession

コマンド・カテゴリ: セッション

WLSTでの使用: オンライン

説明

現在のセッションを説明します。リポジトリ操作では、セッションでアクションが実行されていないことを示すか、更新対象のドキュメントの名前を更新のタイプ(作成、変更または削除)とともにリストするかのいずれかです。ポリシー・サブジェクト操作では、サブジェクト識別子がリストされます。

現在のセッションがない場合は、次のエラーが表示されます。

No actions in session.

構文

describeWSMSession()

例

次の例では、現在のセッションを説明します。

wls:/wls-domain/serverConfig>describeWSMSession()

3.3 ポリシー・サブジェクト・コマンド

表3-3にリストされているWLSTコマンドを使用して、WebサービスおよびWebサービスのクライアント・ポリシー・サブジェクトを表示および管理します。ポリシー・サブジェクトの詳細は、『Oracle Fusion Middleware Oracle Web Services Managerの理解』のポリシー・サブジェクトの理解に関する項を参照してください。

注意:

Java EE Webサービスでは、情報は表示されません。Java EE Webサービスのポリシー・アタッチメントの表示および変更の詳細は、表3-7を参照してください。

表3-3 ポリシー・サブジェクトWLSTコマンド

使用するコマンド

目的

WLSTでの使用

displayWSMEffectivePolicySet

ポリシー・サブジェクト対応する有効なポリシー・セットの構成を表示します。

オンライン

listWSMPolicySubjects

指定したアプリケーション、アセンブリおよびサブジェクト・パターンと一致するポリシー・サブジェクトをリストします。

オンライン

previewWSMEffectivePolicySet

ポリシー・サブジェクト対応する有効なポリシー・セットの構成を表示します。表示には、有効なポリシー・セットの生成時に現在のセッション内で行われたすべての変更も含まれます。

オンライン

listWSMResources

リポジトリに登録されているリソースをリストします。

オンライン

registerWSMResource

セッション内の物理リソースを記述する新規リソース・インスタンスを登録または作成します。

オンライン

selectWSMPolicySubject

変更のためにアプリケーション、アセンブリおよびサブジェクトによって一意に識別されるサブジェクトを選択します。

オンライン

selectWSMResource

変更のためにリソース、アセンブリおよびサブジェクトによって一意に識別されるサブジェクトをサードパーティ・アプリケーション環境で選択します。

オンライン

3.3.1 displayWSMEffectivePolicySet

コマンド・カテゴリ: ポリシー・サブジェクト

WLSTでの使用: オンライン

注意:

このコマンドは、Oracle Infrastructure Webサービスおよびクライアントのみに有効です。Java EE Webサービスでは、情報は表示されません。Java EE Webサービスのポリシー・アタッチメントの表示および変更の詳細は、表3-7を参照してください。

説明

実際のランタイム・ポリシー・セットおよびポリシー強制時に使用されるグローバル・ポリシー・アタッチメント情報の構成が表示されます。このポリシー・セットとグローバル・ポリシー・アタッチメント情報は、ポリシー・サブジェクト内に格納されます。

コマンドを開始する前に、セッションを開始してポリシー・サブジェクトを選択(selectWSMPolicySubjectを使用して)する必要があります。現在のセッションがなく、ポリシー・サブジェクトが選択されていない場合は、エラーが表示されます。

このコマンドを、選択したグローバル・ポリシー・セットまたは選択したローカル・ポリシー・セットのみを表示する「displayWSMPolicySet」コマンド、または現在のセッション内で実際のランタイム・ポリシー・セットに対して行われた変更を含む有効なポリシー・セットを表示する「previewWSMEffectivePolicySet」コマンドを比較します。

構文

displayWSMEffectivePolicySet()

例

次のOracle Infrastructure Webサービスの例では、強制時に有効なポリシー(oracle/wss_username_token_service_policyおよびoracle/log_policy)をリストします。

wls:/jrfServer_domain/serverConfig> selectWSMPolicySubject('/weblogic/jrfServer_domain/jaxws-sut','#jaxws-sut-service','WS-SERVICE({http://service.jaxws.wsm.oracle/}TestService#TestPort)')

The policy subject is selected for modification.

wls:/jrfServer_domain/serverConfig> displayWSMEffectivePolicySet()

URI="oracle/http_basic_auth_over_ssl_service_policy", category=security, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true

The policy subject is secure in this context.

3.3.2 listWSMPolicySubjects

コマンド・カテゴリ: ポリシー・サブジェクト

WLSTでの使用: オンライン

説明

指定したアプリケーション、アセンブリおよびサブジェクト・パターンと一致するポリシー・サブジェクトをリストします。オプションのdetail引数を使用して、有効なポリシー・セットの情報を出力に含むことができます。このコマンドではセッションを開始する必要はありません。

サブジェクトの特定に使用するパターンの詳細は、「ポリシー・サブジェクトの特定」を参照してください

構文

listWSMPolicySubjects([application=None],[assembly=None],[subject=None],[detail='false'])

引数

定義

application

省略可能。アプリケーションを特定するパターン。

assembly

省略可能。アセンブリを特定するパターン。

subject

省略可能。サブジェクトを特定するパターン。

detail

省略可能。出力に有効なポリシー・セットの情報を含むかどうかを指定します。デフォルト値はfalseです。

直接アタッチされたポリシーごとに、アタッチメントのソースを識別するlocal.policy.reference.source構成プロパティが提供されています。詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のポリシー・アタッチメントのソースの特定に関する項を参照してください。

特定のサブジェクトの検索を簡易化するために、application、assemblyまたはsubject引数にワイルドカード文字(*)を含むパターンを指定できます。この場合、そのパターンに一致するすべてのサブジェクトがリストされます。

例

detail='true'を指定した次のlistWSMPolicySubjectsコマンドの呼出しでは、ドメイン全体で管理されているすべてのサブジェクトのアプリケーション、アセンブリおよびサブジェクト情報が返されます。

直接アタッチされたポリシーには、そのソースをLOCAL_ATTACHMENTとして識別するlocal.policy.reference.source構成プロパティが提供されており、Fusion Middleware ControlまたはWLSTを使用してアタッチされたことを示します。local.policy.reference.source構成プロパティの詳細および有効な値のリストは、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のポリシー・アタッチメントのソースの特定に関する項を参照してください。

wls:/base_domain/serverConfig> listWSMPolicySubjects(detail='true')
Application: /weblogic/base_domain/jaxwsejb30ws
Assembly: #jaxwsejb
Subject: WS-SERVICE({http://mycompany.com/targetNamespace}EchoEJBService#EchoEJBServicePort)

Context : no constraint
URI="oracle/wss_username_token_service_policy", category=security,
policy-status=enabled; source=global policy set "username", scope="DOMAIN('*')"; reference-status=enabled; effective=true
URI="oracle/mex_request_processing_service_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
URI="oracle/mtom_encode_fault_service_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
URI="oracle/max_request_size_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
Property name="max.request.size", value="-1"
URI="oracle/request_processing_service_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
URI="oracle/soap_request_processing_service_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
URI="oracle/ws_logging_level_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="logging.level", value=""
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
URI="oracle/test_page_processing_service_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
URI="oracle/wsdl_request_processing_service_policy", category=wsconfig, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"

The policy subject is secure in this context.

...

('jax*')を引数として指定したlistWSMPolicySubjectsコマンドの呼出しでは、jaxで始まるアプリケーションのすべてのサブジェクト(この例ではjaxwsejb30wsアプリケーションに属しているすべてのサブジェクト)が返されます。

wls:/base_domain/serverConfig> listWSMPolicySubjects('jax*')

Application: /weblogic/base_domain/jaxwsejb30ws
Assembly: #jaxwsejb
Subject: WS-SERVICE({http://mycompany.com/targetNamespace}EchoEJBService#EchoEJBServicePort)

Subject: WS-SERVICE({http://mycompany.com/jaxws/tests/concrete}WsdlConcreteService#WsdlConcretePort)

Subject: WS-SERVICE({http://mycompany.com/jaxws/tests}CalculatorService#CalculatorPort)

次のコマンドは、すべてのアプリケーション内のすべてのRESTfulリソース・サブジェクトを返します。アプリケーションにRESTfulリソースがない場合、次のメッセージが返されます: Subject: No matching subject found for "REST*"

wls:/base_domain/serverConfig> listWSMPolicySubjects(subject='REST*')

Application: /weblogic/base_domain/jaxrs_pack1

Assembly: #jaxrs_pack1.war

Subject: REST-Resource(Jersey)

Application: /weblogic/base_domain/jaxwsejb30ws

Assembly: #jaxwsejb

Subject: No matching subject found for "REST*".

Application: /weblogic/base_domain/soa-infra

Assembly: #integration/services/RuntimeConfigService

Subject: REST-Resource(oracle.bpm.rest.webapp.BPMApplication)

3.3.3 listWSMResources

コマンド・カテゴリ: リポジトリ

WLSTでの使用: オンライン

説明

リポジトリに登録されているリソースをリストします。このコマンドによって、現在のセッション内で作成、変更または削除されるリソースも表示されます。すべてのリソースをリストすることも、オプションの引数を使用して表示を制限することもできます。

構文

listWSMResources([resourceType=None],[resourceName=None],[platFormType=None],[domainName=None])

引数

定義

resourceType

省略可能。リソースのタイプを指定します。値が指定されない場合、リポジトリに保存されているすべてのリソース・インスタンスがリストされます。

resourceName

省略可能。リソースの名前。この値を省略してすべてのリソースをリストすることも、ワイルドカードを使用してリソース一致を制限することもできます。

platformType

省略可能。リソースが存在するプラットフォームのタイプです。この値に次のいずれかの値を指定してリソース一致を制限することも、省略してすべてのプラットフォーム・タイプに存在するリソースをリストすることもできます。

- was - WebSphereプラットフォーム

- jboss - JBOSSプラットフォーム

domainName

省略可能。リソースが存在する管理ドメイン(つまり、WebSphereプラットフォームのセル)の名前です。この値を省略してすべてのリソースをリストすることも、ワイルドカードを使用してリソース一致を制限することもできます。

前述の表にリストされているいずれの値にも次のワイルドカード文字を使用して複数一致を指定できます。

文字

説明

%

パーセント文字は、値の中で任意の数の文字に一致させるのに使用できます。

_

アンダースコア文字は、値の中で単一の文字に一致させるのに使用できます。

\

バックスラッシュ文字は、値の中でワイルドカード文字をエスケープするのに使用できます。

ワールドカードを使用したlistWSMResourcesコマンドの例を次に示します。

listWSMResources('application','%App%','was','myDomain')
listWSMResources('platform','my_%')
listWSMResources()

例

次の例は、ドメインmyDomainのWebSphereアプリケーション・サーバーにある、文字列Appを含むアプリケーション・リソースを返します。

listWSMResources('application','%App%','was','myDomain')

3.3.4 previewWSMEffectivePolicySet

コマンド・カテゴリ: ポリシー・サブジェクト

WLSTでの使用: オンライン

説明

ポリシー・サブジェクト対応する有効なポリシー・セットの構成を表示します。表示には、有効なポリシー・セットの生成時に現在のセッション内で行われたすべての変更も含まれます。

コマンドを開始する前に、セッションを開始してポリシー・サブジェクトを選択(selectWSMPolicySubjectを使用して)する必要があります。ポリシー・サブジェクトが選択されていない場合は、エラーが表示されます。

強制時に使用される実際のポリシー・セットを表示する「displayWSMEffectivePolicySet」(ただし、現在のセッション中に行われたポリシー・セットに対するすべての変更は表示されません)も参照してください。

構文

previewWSMEffectivePolicySet()

例

wls:/wls-domain/serverConfig>previewWSMEffectivePolicySet()

3.3.5 registerWSMResource

コマンド・カテゴリ: リポジトリ

WLSTでの使用: オンライン

説明

セッション内で、アプリケーション・サーバーなどの物理リソースを記述する新規リソース・インスタンスを登録または作成する、あるいは作成されたリソース・インスタンス内にサブリソースを登録します。リソース・インタンスは、リソースの論理構造を記述する情報を保存するのに使用されます。サブリソースにはリソース・インスタンスのクライアント・ポートおよびサービス・ポートについての情報が保持されます。セッション外でこのコマンドを発行するとエラーになります。

構文

registerWSMResource(resource, [assembly=None], [subject=None])

引数

説明

resource

既存のリソース・インスタンスの名前です。これはスラッシュで区切られた、プラットフォーム名、ドメイン名および論理名の組合せです。

assembly

リソース・インスタンス内のサブリソースを識別するのに使用されるアセンブリ名です。これはハッシュ記号で区切られた、モジュール・タイプおよびモジュール名の組合せです。

subject

サブリソースを識別するサブジェクトの名前です。これはサブリソース・タイプの組合せ、つまりハッシュ記号で区切られた、"server"または"client"およびサービス、または参照名およびポート名のいずれかです。

例

次の例は、IBM WebSphereプラットフォーム・アプリケーションWAS/base_cell/myApplicationを登録します。

wls:/jrfServer_domain/serverConfig> registerWSMResource (‘WAS/base_cell/myApplication')

次の例は、IBM WebSphereプラットフォーム・ドメインWAS/base_cellを登録します。

wls:/jrfServer_domain/serverConfig> registerWSMResource ('WAS/base_cell')

次の例は、アプリケーション/WAS/base_cell/myApplicationの、IBM WebSphereプラットフォームにあるStockQuoteServicePortエンドポイントを登録します。

wls:/jrfServer_domain/serverConfig> registerWSMResource (‘/WAS/base_cell/myApplication', ‘web# myModule', ‘service(StockQuoteService# StockQuoteServicePort)')

3.3.6 selectWSMPolicySubject

コマンド・カテゴリ: ポリシー・サブジェクト

WLSTでの使用: オンライン

説明

セッション内で、変更するポリシー・サブジェクトを選択します。アプリケーション、アセンブリおよびポリシー・サブジェクト名でポリシー・サブジェクトを一意に指定します。選択後、ポリシー管理コマンドを使用して、そのポリシー・サブジェクトに直接アタッチされているポリシー・セットを変更できます。

ポリシー管理の編集またはポリシー・セットのトランザクションを実行する前に、セッションを開始(beginWSMSession)する必要があります。また、ポリシー管理コマンドを発行する前に、変更するポリシー・サブジェクトを選択する必要もあります。現在のセッションがないか、既存の変更プロセスがすでに存在する場合は、エラーが表示されます。

コマンドの使用方法の詳細は、『Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のポリシーサブジェクトの特定に関する項およびWLSTを使用したポリシー・サブジェクトの特定および選択に関する項を参照してください。

構文

selectWSMPolicySubject([application=None],[assembly=None],[subject=None])

引数

説明

application

アプリケーションの名前。

assembly

アセンブリの名前。アプリケーション内のモジュールを一意に特定します。

subject

ポリシー・サブジェクトの名前。

注意:

3つの引数のいずれにも、ワイルドカード文字「*」を含むパターンを指定できます。この場合、そのパターンに一致するすべての名前がリストされます。サブジェクトを一意に特定する名前を選択する必要があります。パターンは、最後の不明エンティティにのみ指定できます。

例

次の例では、jaxws-sutアプリケーションに属しているjaxws-sut-serviceモジュール(アセンブリ)のTestService#TestPortポートを選択します。

wls:/jrfServer_domain/serverConfig> selectWSMPolicySubject('/weblogic/jrfServer_domain/jaxws-sut','#jaxws-sut-service','WS-SERVICE({http://service.jaxws.wsm.oracle/}TestService#TestPort)')

The policy subject is selected for modification.

次の例では、helloworldアプリケーションに属する#restserviceモジュール(アセンブリ)のjersey RESTfulリソースを選択します。

wls:/jrfServer_domain/serverConfig> selectWSMPolicySubject('helloworld','#restservice','REST-Resource(Jersey)')

The policy subject is selected for modification.

その他の例については、「ポリシー・サブジェクトの特定」を参照してください。

3.3.7 selectWSMResource

コマンド・カテゴリ: リポジトリ

WLSTでの使用: オンライン

説明

セッション内で、サードパーティ・アプリケーション・サーバーなどの物理リソースを記述するリソース・インスタンスを変更のために選択します。このコマンドは、リソース・インスタンス内に含まれる特定のサブリソースを変更のために選択するのにも使用できます。リソース・インスタンスが選択されると、その中のサブリソースを追加、削除または変更できます。セッション外でこのコマンドを発行するとエラーになります。

ポリシー管理の編集またはポリシー・セットのトランザクションを実行する前に、セッションを開始(beginWSMSession)する必要があります。また、ポリシー管理コマンドを発行する前に、変更するリソース・サブジェクトを選択する必要もあります。

構文

selectWSMResource([resource=None], [assembly=None], [subject=None])

引数

説明

resource

既存のリソース・インスタンスの名前です。これはスラッシュで区切られた、リソース・インスタンスのプラットフォーム名、ドメイン名および論理名の組合せです。

assembly

リソース・インスタンス内のサブリソースを識別するのに使用されるアセンブリ名です。これはハッシュ記号で区切られた、モジュール・タイプおよびモジュール名の組合せです。

subject

サブリソースを識別するサブジェクトの名前です。これはサブリソース・タイプの組合せです。たとえば、ハッシュ記号で区切られた、"server"または"client"およびサービス、または参照名およびポート名のいずれかです。

注意:

3つの引数のいずれにも、ワイルドカード文字「*」を含むパターンを指定できます。この場合、そのパターンに一致するすべての名前がリストされます。したがって、サブジェクトを一意に特定する名前を選択する必要があります。パターンは、最後の不明エンティティにのみ指定できます。

例

次の例は、*ワイルドカードを使用して、IBM WebSphereアプリケーション・サーバー上のbase_domainにあるすべてのアプリケーションを選択します。

wls:/jrfServer_domain/serverConfig> selectWSMResource('/WAS/base_cell/*Application')

次の例は、アプリケーション/WAS/base_cell/myApplicationの、IBM WebSphereプラットフォームにあるWEBモジュールのすべてのサブモジュールを*ワイルドカードを使用して指定します。

wls:/jrfServer_domain/serverConfig> selectWSMResource('/WAS/base_cell/myApplication','WEB#*Mod')

次の例は、アプリケーション/WAS/base_cell/myApplicationの、IBM WebSphereプラットフォームにあるWEB/myModサブリソースに接続されているすべてのサービス・ポートを*ワイルドカードを使用して指定します。

wls:/jrfServer_domain/serverConfig> selectWSMResource('/WAS/base_cell/myApplication','WEB#myMod', 'service(*Service#*Port)')

次の例は、アプリケーション/WAS/base_cell/myApplicationの、IBM WebSphereプラットフォームにあるWEB/myModサブリソースに接続されているStockQuoteServicePortエンドポイント選択します。

wls:/jrfServer_domain/serverConfig> selectWSMResource (‘/WAS/base_cell/myApplication', ‘WEB#myModule', ‘service(StockQuoteService# StockQuoteServicePort)')

3.4 構成コマンド

表3-4にリストされているWLSTコマンドを使用して、OWSMドメインを表示および構成します。

注意:

setConfigurationコマンドは非推奨になりました。「setWSMConfiguration」に記載されているsetWSMConfigurationコマンドを使用することをお薦めします。

表3-4 OWSM環境WLSTコマンド

使用するコマンド

目的

WLSTでの使用

configureWSMKeystore

キーストア構成のプロパティを設定します。

オンライン

displayWSMConfiguration

指定した製品の完全な構成プロパティとその値およびグループを表示します。

オンライン

setWSMConfiguration

指定した製品の構成プロパティを設定します。

オンライン

setWSMResourceField

リソースまたはその構成コンポーネントのフィールドの値を設定します。

オンライン

3.4.1 configureWSMKeystore

コマンド・カテゴリ: 構成

WLSTでの使用: オンライン

説明

OWSMキーストアの構成プロパティを設定します。

詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のWLSTを使用したOWSMキーストアの構成に関する項を参照してください。

注意:

キーストア構成に対する変更をドメイン・レベルで行う場合、サーバーの再起動が必要になります。

構文

configureWSMKeystore(context, keystoreType, location, keystorePassword, signAlias, signAliasPassword, cryptAlias, cryptAliasPassword)

引数

説明

context

省略可能。変更が実行される構成ドキュメントのコンテキスト。

keystoreType

省略可能。プロパティのキーストア・タイプ・カテゴリ。有効なキーストア・タイプは、JKS、KSS、PKCS11およびLUNAです。

location

省略可能。JKSの場合、キーストアの絶対位置またはfmwconfigディレクトリに対する相対位置です。KSSでは、位置の書式はkss://stripeName/keystoreNameである必要があり、デフォルトはkss://owsm/keystoreです。

keystorePassword

省略可能。構成されるキーストアのキーストア・パスワード。JKSおよびPKCS11には必須です。

signAlias

省略可能。署名鍵の別名。JKSおよびPKCS11には必須です。

signAliasPassword

省略可能。署名鍵の別名のパスワード。JKSおよびPKCS11には必須です。

cryptAlias

省略可能。暗号化鍵の別名。JKSおよびPKCS11には必須です。

cryptAliasPassword

省略可能。暗号化鍵の別名のパスワード。JKSおよびPKCS11には必須です。

例

次の例では、JKSキーストアdefault-keystore.jksをドメインmyDomainに構成します。キーストア・パスワードにoratest123、署名の別名にoraAlias、署名の別名パスワードにora234、暗号化の別名にoraCryptAlias、暗号化の別名パスワードにora123を指定します。

wls:/jrfServer_domain/serverConfig> configureWSMKeystore ('/WLS/myDomain','JKS', './default-keystore.jks','oratest123', 'oraAlias','ora234','oraCryptAlias', 'ora123')

次の例では、KSSキーストアをドメインmyDomainのkss://owsm/keystoreに構成します。署名の別名にoraAlias、および暗号化の別名にoraCryptAliasを指定します。

wls:/jrfServer_domain/serverConfig> configureWSMKeystore ('/WLS/myDomain',keystoreType='KSS', location='kss://owsm/keystore', signAlias='oraAlias', cryptAlias='encAlias')

3.4.2 displayWSMConfiguration

コマンド・カテゴリ: 構成

WLSTでの使用: オンライン

説明

コンテキスト内で指定した製品の構成プロパティの完全なセット、およびその値とグループを表示します。コンテキストに関連付けられている構成ドキュメントでプロパティが定義されていない場合、その製品に定義されているデフォルトの値が表示されます。コンテキストが指定されない場合は、現在のコンテキストに一致するプロパティのセットが表示されます。

詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のWLSTを使用したOWSMドメイン構成の管理に関する項を参照してください。

構文

displayWSMConfiguration([context=None])

引数

説明

context

省略可能。プロパティ値を表示する構成ドキュメントのコンテキスト。contextが指定されない場合は、現在のコンテキストに一致するプロパティのセットが表示されます。

プロパティのデフォルトのセットをその値とともに表示するには、コンテキスト値として「/」を使用します。

例

次の例では、リポジトリ内の構成ドキュメントに含まれる構成を表示します。

wls:/jrfServer_domain/serverConfig> displayWSMConfiguration()

次の例では、base_domainドメインの構成を表示します。

wls:/jrfServer_domain/serverConfig> displayWSMConfiguration('/WLS/base_domain')

3.4.3 setWSMConfiguration

コマンド・カテゴリ: 構成

WLSTでの使用: オンライン

説明

ドメインの構成プロパティを設定します。プロパティは、そのドメインの構成ドキュメントに格納されます。構成ドキュメントが存在しない場合は、新しいドキュメントが作成されます。

値をおよび値のグループ(あるいはその両方)を指定した新しいプロパティは、構成ドキュメント内に追加できます。許容されるプロパティのセットは、その製品でサポートされるプロパティのデフォルト・セットによって決定されます。特定のプロパティ値または値のグループを、構成ドキュメントから削除できます。構成ドキュメント内にプロパティが存在しない場合は、構成ドキュメント自体が削除されます。

詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のWLSTを使用したOWSMドメイン構成の管理に関する項を参照してください。

構文

setWSMConfiguration(context, category, name, [group=None], [values=None])

引数

説明

context

省略可能。変更される構成ドキュメントのコンテキスト。コンテキストが指定されなかった場合またはNoneに設定された場合、現在接続しているドメインに関連する構成ドキュメントが使用されます。たとえば、/WLS/base_domainです。

category

プロパティのカテゴリ。これは、コンテキストで受け入れられることを確認するために、プロパティのデフォルト・セットに対して検証されます。

displayWSMConfigurationコマンドを使用して、各プロパティに関連付けられているカテゴリ名を確認します。

name

プロパティの名前これは、コンテキストで受け入れられることを確認するために、プロパティのデフォルト・セットに対して検証されます。

group

省略可能。構成ドキュメントに追加する値のセットが含まれているグループ。グループが存在し、この値がNoneに設定される場合、グループは削除されます。

values

省略可能。構成ドキュメント内のプロパティまたはグループに設定する値の配列。

例

次の例では、ドメインmyDomainの構成全体をデフォルト値にリセットします。

wls:/jrfServer_domain/serverConfig> setWSMConfiguration('/WLS/myDomain')

次のコマンドでは、myDomainドメイン内のclock.skewプロパティの値を500にリセットします。

wls:/jrfServer_domain/serverConfig> setWSMConfiguration('/WLS/myDomain','Agent','clock.skew',None, ['500'])

次のコマンドでは、myDomain内のclock.skewプロパティの値をデフォルト値にリセットします。

wls:/jrfServer_domain/serverConfig> setWSMConfiguration('/WLS/myDomain','Agent','clock.skew',None,None)

3.4.4 setWSMResourceField

コマンド・カテゴリ: リソース

WLSTでの使用: オンライン

説明

リソースまたはその構成コンポーネントのフィールドの値を指定します。このコマンドは、リクエストされたフィールドをリソースに設定する、または既存のフィールドの値を削除するのに使用できます。作成中または変更中のリソースが含まれるセッション外でこのコマンドを発行するとエラーになります。

構文

setWSMResourceField(fieldName, [fieldValue=None])

引数

定義

fieldName

設定するフィールドの名前。変更のために値を設定できるフィールドは次のとおりです。

- server—サーバー名。このフィールドは、アプリケーション・リソースにおいてのみ設定できます。

- wsdl—WSDLの場所。このフィールドは、クライアント・ポート・リソースにおいてのみ設定できます。

fieldValue

省略可能。フィールドに設定する値、またはフィールドを削除する場合は値を省略します。

例

次の例は、クライアント・ポートのwsdlフィールドの場所をStockService?wsdlに設定します。

wls:/wls-domain/serverConfig> setWSMResourceField('wsdl',['http://localhost/StockService?wsdl'])

次の例は、アプリケーション・リソースのserverフィールドをserver1およびserver2に設定します。

wls:/wls-domain/serverConfig> setWSMResourceField('server',['server1','server2'])

3.5 診断コマンド

この項のWLSTコマンドを使用して、製品が適切に機能するために必要なWSMコンポーネントのステータスをチェックします。

3.5.1 checkWSMStatus

コマンド・カテゴリ: 診断

WLSTでの使用: オンライン

説明

製品が適切に機能するために必要なOWSMコンポーネントのステータスをチェックします。コンポーネントのステータスは、まとめて確認することも、個別に確認することもできます。チェックされるOWSMコンポーネントは、次のとおりです。

- ポリシー・マネージャ(wsm-pm)

- エージェント(agent)

- 資格証明ストアおよびキーストアの構成(credstore)

- Oauth2の構成(oauth2)

- ポリシー・マネージャの履歴(pmHistory)

構文

checkWSMStatus([component=None],[address=None],[verbose=true],[days=None],[target=None],[outfile=None])

引数

説明

component

省略可能。値を指定しないと、すべてのチェックが実行されます。有効なオプションは次のとおりです。

- credstore: 資格証明ストア。キーストア内のキーストア・パスワード、署名および暗号化証明書に対して資格証明が構成されているかどうかをチェックします。

- wsm-pm: ポリシー・マネージャ。ポリシー・マネージャ・コンポーネントの構成状態をチェックします。

- agent: 強制エージェント。wsmエージェント・コンポーネントによるエンドツーエンドのサービス側強制のステータスをチェックします。強制チェックは、コマンドが実行される環境に固有のものです。

- pmHistory: ポリシー・マネージャ接続の失敗履歴。PM通信における過去の失敗に関する情報が表示されます。

- oauth2: RESTfulクライアント、SOAPクライアント、SOA SOAPクライアントおよびSOA RESTクライアントなどの様々なクライアント・タイプについてDOMAINスコープGPA上のoauth2構成をスキャンし、検証します。oauth2クライアント・ポリシー施行もチェックします。

address

省略可能。wsm-pmアプリケーションを実行しているホストのHTTP URL。この値は、たとえばエージェント・コンポーネントによる強制をチェックします。

checkWSMStatus('agent', 'http://localhost:7001')

自動検出が設定されているWebLogic Serverドメインではアドレスは必要ありません。

verbose

省略可能。詳細なメッセージ(存在する場合はスタック・トレースを含む)を表示するには、値をtrueに設定します。デフォルト値はfalseです。

days

省略可能。この属性は、pmHistoryコンポーネントで使用されます。値を、過去のポリシー・マネージャ通信失敗記録を表示する必要がある日数に設定します。デフォルト値は5です。

target

省略可能。チェックを実行する必要があるターゲット・サーバーの名前。特定のサーバーに対してチェックを実行する必要がある場合は、この値を設定します。値を指定しないと、チェックは、使用可能なすべてのサーバーに対して実行されます。

outfile

省略可能。Noneでない場合、出力は、outfileで特定されているファイルにもリダイレクトされます。

例

次の例では、checkWSMStatusコマンドは引数なしで実行されています。資格証明ストア、ポリシー・マネージャおよび強制エージェントのステータスが返されます。

wls:/base_domain/serverConfig> checkWSMStatus()
Health check status on server EXAMPLESERVER1 is PASSED.

Health check status on server EXAMPLESERVER2 is PASSED.

Health check status for system is PASSED.

次の例では、verboseを指定してcheckWSMStatusコマンドが実行されています。そのため、詳細な出力が表示されます。資格証明ストア、ポリシー・マネージャおよび強制エージェントのステータスが返されます。

wls:/base_domain/serverConfig> checkWSMStatus(verbose='true')
Health check for server "EXAMPLESERVER":

Credential Store Configuration:

PASSED.
Message(s):
keystore.pass.csf.key : Property is configured and its value is "keystore-csf-key".
Description: The "keystore.pass.csf.key" property points to the CSF alias that is mapped to the username and password of the keystore. Only the password is used; username is redundant in the case of the keystore.
keystore-csf-key : Credentials configured.
keystore.sig.csf.key : Property is configured and its value is "sign-csf-key".
Description: The "keystore.sig.csf.key" property points to the CSF alias that is mapped to the username and password of the private key that is used for signing.
sign-csf-key : Credentials configured.
Sign Key : Key configured.
Alias - orakey
Sign Certificate : Certificate configured.
Alias - CN=weblogic, OU=Orakey Test Encryption Purposes Only, O=Oracle, C=US
Expiry - June 28, 2020 11:17:12 AM PDT
keystore.enc.csf.key : Property is configured and its value is "enc-csf-key".
Description: The "keystore.enc.csf.key" property points to the CSF alias that is mapped to the username and password of the private key that is used for decryption.
enc-csf-key : Credentials configured.
Encrypt Key : Key configured.
Alias - orakey
Encrypt Certificate : Certificate configured.
Alias - CN=weblogic, OU=Orakey Test Encryption Purposes Only, O=Oracle, C=US
Expiry - June 28, 2020 11:17:12 AM PDT

Policy Manager:

PASSED.
Message(s):
OWSM Policy Manager connection state is OK.
OWSM Policy Manager connection URL is "host.example.com:1234".

Enforcement Agent:

PASSED.
Message(s):
Enforcement is successful.
Service URL: http://host:port/Diagnostic/DiagnosticService?wsdl

Health check status on server EXAMPLESERVER is PASSED.

Health check status for system is PASSED.

次の例では、checkWSMStatusコマンドにより、ドメイン内の単一サーバー上のwsm-pm構成が確認されます。verbose値をtrueに設定すると、outfile属性で定義したファイルに詳細な出力が送信されます。

wls:/base_domain/serverConfig>checkWSMStatus('wsm-pm', target='EXAMPLESERVER',verbose='true',outfile='example.txt')

Health check for server "EXAMPLESERVER":

Policy Manager:

PASSED.
Message(s):
OWSM Policy Manager connection URL is "t3://slc05njx:8741".
OWSM Policy Manager connection state is OK.

Health check status on server EXAMPLESERVER is PASSED.

Health check status for system is PASSED.

次の例では、資格証明ストア・キーkeystore-csf-keyが構成されておらず、資格証明ストアcredstoreに対してcheckWSMStatusコマンドが再実行されています。CSFキーkeystore-csf-keyが資格証明ストアに存在しないため、ステータス・チェックが失敗します。

wls:/base_domain/serverConfig> checkWSMStatus('credstore',target='EXAMPLESERVER')

Health check for server "EXAMPLESERVER":

Credential Store Configuration:

FAILED.
Message(s):
keystore.pass.csf.key : Property is configured and its value is "keystore-csf-key".
Description: The "keystore.pass.csf.key" property points to the CSF alias that is mapped to the username and password of the keystore. Only the password is used; username is redundant in the case of the keystore.
keystore-csf-key : Credentials configured.
keystore.sig.csf.key : Property is configured and its value is "sign-csf-key".
Description: The "keystore.sig.csf.key" property points to the CSF alias that is mapped to the username and password of the private key that is used for signing.
sign-csf-key : Credentials configured.
Sign Key : Key not configured.
oracle.wsm.security.SecurityException: WSM-00111 : Keystore is not properly configured. Check your keystore configurations.
Credential Store Diagnostic Messages:
Message(s):
The alias orakey is either not present in the keystore or is configured incorrectly. Check the contents of the keystore and the password for the alias "orakey". The password of the alias "orakey" should be the same as the password stored in the csf key=sign-csf-key

NOTE:- All the above commands are based on the Domain level configurations. The actual alias may have been  overridden at runtime due to configuration override.

Health check status on server EXAMPLESERVER is FAILED.

Health check status for system is FAILED.

次の例では、csf-key keystore-csf-keyが構成され、checkWSMStatusコマンドが再実行されています。構成チェックが成功します。

wls:/base_domain/serverConfig> createCred(map="oracle.wsm.security", key="keystore-csf-key", user="keystore-csf-key", password="welcome1", desc="Keystore Password CSF Key")
Already in Domain Runtime Tree

wls:/base_domain/serverConfig> checkWSMStatus('credstore',target='EXAMPLESERVER')

Health check status on server EXAMPLESERVER is PASSED.

Health check status for system is PASSED.

次の例では、ドメイン内のすべてのサーバーでのエージェント・コンポーネントの強制ステータスをチェックします。

wls:/test_domain1/serverConfig> checkWSMStatus('agent')

Health check status on server EXAMPLESERVER1 is PASSED.

Health check status on server EXAMPLESERVER2 is PASSED.

Health check status for system is PASSED.

次の例では、ドメイン内のすべてのサーバー上の、アドレスが無効なエージェントに対してチェックが実行されます。ヘルス・チェックは失敗し、診断による詳細な出力が自動的にログ記録されます。

wls:/test_domain1/serverConfig>checkWSMStatus(component='agent', address='invalidAddress')

Health check for server "EXAMPLESERVER1":

Note: Enforcement might succeed if OWSM Policy Manager is down due to policy caching. For such scenarios wsm-pm test must be run prior to this test.

FAILED.
Message(s):
The protocol used in the URL "invalidAddress/wsm-pm-diagnostic/DiagnosticService?wsdl" is not supported.
Enforcement Agent Diagnostic Messages:
Message(s):
Service URL: invalidAddress/wsm-pm-diagnostic/DiagnosticService?wsdl
Make sure that the URL of the host running wsm-pm application is specified and valid. The only supported protocol is "http".

Health check status on server EXAMPLESERVER1 is FAILED.

Health check for server "EXAMPLESERVER2":

Note: Enforcement might succeed if OWSM Policy Manager is down due to policy caching. For such scenarios wsm-pm test must be run prior to this test.

FAILED.
Message(s):
The protocol used in the URL "invalidAddress/wsm-pm-diagnostic/DiagnosticService?wsdl" is not supported.
Enforcement Agent Diagnostic Messages:
Message(s):
Service URL: invalidAddress/wsm-pm-diagnostic/DiagnosticService?wsdl
Make sure that the URL of the host running wsm-pm application is specified and valid. The only supported protocol is "http".

Health check status on server EXAMPLESERVER2 is FAILED.

Health check status for system is FAILED.

次の例では、checkWSMStatusコマンドにより、サーバーEXAMPLESERVERでの過去200日間のpm通信失敗履歴の取得がチェックされ、出力がhistory.txtにもリダイレクトされます。

wls:/test_domain1/serverConfig>checkWSMStatus(component='pmHistory', days='200 days', target='EXAMPLESERVER', outfile='history.txt')

Health check for server "EXAMPLESERVER":

Policy Manager Connection Failure History:

Message(s):
[Tracking Id: 42c2e21a-9744-4071-920f-00099560a8b9-000003c2,0#1459247224547] [Failure Timestamp: 2016-03-29T03:27:04.598-07:00] [Recovery Timestamp: 2016-03-29T03:34:15.970-07:00] [Diagnosis: wsm-pm:PASSED;agent:FAILED:[Unable to proceed with the test as host url is not specified or is invalid.];credstore:PASSED;]
[Tracking Id: 42c2e21a-9744-4071-920f-00099560a8b9-0000032a,0#1459160635500] [Failure Timestamp: 2016-03-28T03:23:55.500-07:00] [Recovery Timestamp: 2016-03-28T03:24:55.627-07:00] [Diagnosis: wsm-pm:PASSED;agent:FAILED:[Enforcement has failed., Service URL: http://slc05njx.us.oracle.com:12164/wsm-pm-diagnostic/DiagnosticService?WSDL, Could not determine wsdl ports. WSDLException: faultCode=OTHER_ERROR: Failed to read WSDL from http://slc05njx.us.oracle.com:12164/wsm-pm-diagnostic/DiagnosticService?WSDL: HTTP connection error code is 503];credstore:PASSED;]
[Tracking Id: 42c2e21a-9744-4071-920f-00099560a8b9-000002a6,0#1459073942154] [Failure Timestamp: 2016-03-27T03:19:02.154-07:00] [Recovery Timestamp: 2016-03-27T03:22:05.444-07:00] [Diagnosis: wsm-pm:FAILED:[OWSM Policy Manager connection URL is "t3://slc05njx:12164"., oracle.wsm.policymanager.PolicyManagerException: WSM-02054 : Failure in looking up EJB component. The EJB JNDI name is "DocumentManager#oracle.wsm.policymanager.bean.ejb.IRemoteDocumentManager", the provider URL is "t3://slc05njx:12164"., Policy Manager Url Configuration:, java.sql.SQLNonTransientConnectionException: Insufficient data while reading from the network - expected a minimum of 6 bytes and received only 0 bytes.  The connection has been terminated., Policy Manager User Configuration:,  PM user - "OracleSystemUser" configurations are valid.];agent:FAILED:[Unable to proceed with the test as host url is not specified or is invalid.];credstore:PASSED;]
[Tracking Id: 42c2e21a-9744-4071-920f-00099560a8b9-00000291,0#1458987480506] [Failure Timestamp: 2016-03-26T03:18:00.506-07:00] [Recovery Timestamp: 2016-03-26T03:19:00.879-07:00] [Diagnosis: wsm-pm:PASSED;agent:FAILED:[Enforcement has failed., Service URL: http://slc05njx.us.oracle.com:12164/wsm-pm-diagnostic/DiagnosticService?WSDL, Could not determine wsdl ports. WSDLException: faultCode=OTHER_ERROR: Failed to read WSDL from http://slc05njx.us.oracle.com:12164/wsm-pm-diagnostic/DiagnosticService?WSDL: HTTP connection error code is 503];credstore:PASSED;]

Health check status on server EXAMPLESERVER is PASSED.

Health check status for system is PASSED.

次の例では、OAuth2グローバル・ポリシー・セットは構成されません。

wls:/test_domain1/serverConfig>checkWSMStatus('oauth2')

OAuth2 Client Configuration Status:

Message(s):

No OAuth2 client policy (oauth2_config_client_policy or oauth token policy) attached in the domain for client type(s): REST_CLIENT, WS_CLIENT, SCA_REST_REFERENCE, SCA_REFERENCE
Health check for server "jrfServer_admin":

Health check status on server jrfServer_admin is FAILED.

Health check status for system is FAILED.

次の例では、OAuth2グローバル・ポリシー・セットは、ws-client (SOAPクライアント)サブジェクト・タイプに構成されます。このコマンドで、ドメイン・レベルでアタッチされたGPA内のOAuth2関連構成がチェックされた後、GPAを作成する手順も示されます。

beginWSMSession();
createWSMPolicySet('oauthTestPolicySet','ws-client','Domain("jrfServer_domain")');
attachWSMPolicy('oracle/http_oauth2_token_client_policy');
attachWSMPolicy('oracle/oauth2_config_client_policy');
setWSMPolicyOverride('oracle/oauth2_config_client_policy','token.uri','http://slc07ehc.us.oracle.com:14100/ms_oauth/oauth2/endpoints/oauthservice/tokens');
setWSMPolicyOverride('oracle/http_oauth2_token_client_policy','oauth2.client.csf.key','basic.client.credentials');
validateWSMPolicySet();
commitWSMSession()

wls:/test_domain1/serverConfig>checkWSMStatus('oauth2')

OAuth2 Client Configuration Status:

Message(s):
OAuth2 Client Configuration Checks for type SOAP Client: PASSED
Successful OAuth Configurations for Client Type(s): WS_CLIENT
Health check status on server jrfServer_admin is PASSED.
Health check status for system is PASSED.

次の例では、OAuth2グローバル・ポリシー・セットは、ws-client (SOAPクライアント)サブジェクト・タイプおよびverboseフラグtrueに構成されます。このコマンドで、ドメイン・レベルでアタッチされたGPA内のOAuth2関連構成がチェックされた後、GPAを作成する手順も示されます。

beginWSMSession();
createWSMPolicySet('oauthTestPolicySet','ws-client','Domain("jrfServer_domain")');
attachWSMPolicy('oracle/http_oauth2_token_client_policy');
attachWSMPolicy('oracle/oauth2_config_client_policy');
setWSMPolicyOverride('oracle/oauth2_config_client_policy','token.uri','http://slc07ehc.us.oracle.com:14100/ms_oauth/oauth2/endpoints/oauthservice/tokens');
setWSMPolicyOverride('oracle/http_oauth2_token_client_policy','oauth2.client.csf.key','basic.client.credentials');
validateWSMPolicySet();
commitWSMSession()

wls:/test_domain1/serverConfig>checkWSMStatus('oauth2', verbose='true')

OAuth2 Client Configuration Status:

Message(s):
OAuth2 Client Configuration Checks for type SOAP Client: PASSED
OAuth2 Server hostname slc07ehc.us.oracle.com is valid
OAuth2 Server token URL http://slc07ehc.us.oracle.com:14100/ms_oauth/oauth2/endpoints/oauthservice/tokens is valid
OAuth2 Client CSF key basic.client.credentials which stores the OAuth Client Credentials is configured.
Client ID: OWSMClientId
Client credentials configured as 'oauth2.client.csf.key' config override property in oauth2 client policies are also registered with OAuth2 server
OAuth2 user tenant name configured  as 'user.tenant.name' config override property in oauth2 client policies is valid
keystore.pass.csf.key : Property is configured and its value is "keystore-csf-key".
Description: The "keystore.pass.csf.key" property points to the CSF alias that is mapped to the username and password of the keystore. Only the password is used; username is redundant in the case of the keystore.
keystore-csf-key : Credentials configured.
keystore.sig.csf.key : Property is configured and its value is "sign-csf-key".
Description: The "keystore.sig.csf.key" property points to the CSF alias that is mapped to the username and password of the private key that is used for signing.
sign-csf-key : Credentials configured.
Sign Key : Key configured.
Alias - orakey
Sign Certificate : Certificate configured.
Alias - CN=weblogic, OU=Orakey Test Encryption Purposes Only, O=Oracle, C=US
Expiry - June 28, 2020 11:17:12 AM PDT

Successful OAuth Configurations for Client Type(s): WS_CLIENT

Health check for server "jrfServer_admin":

Health check status on server jrfServer_admin is PASSED.

Health check status for system is PASSED.

次の例では、OAuth2 GPAにおいて、無効なtoken.uriが構成されます。このコマンドで、ドメイン・レベルでアタッチされたGPA内のOAuth2関連構成がチェックされた後、GPAを作成する手順も示されます。

beginWSMSession();
createWSMPolicySet('oauthTestPolicySet','ws-client','Domain("jrfServer_domain")');
attachWSMPolicy('oracle/http_oauth2_token_client_policy');
attachWSMPolicy('oracle/oauth2_config_client_policy');
setWSMPolicyOverride('oracle/oauth2_config_client_policy','token.uri','http://slc07ehc.us.oracle.com:14100/test/tokens');
setWSMPolicyOverride('oracle/http_oauth2_token_client_policy','oauth2.client.csf.key','basic.client.credentials');
validateWSMPolicySet();
commitWSMSession()

wls:/test_domain1/serverConfig>checkWSMStatus('oauth2')

OAuth2 Client Configuration Status:

Message(s):
OAuth2 Client Configuration Checks for type SOAP Client: FAILED

Message(s):

Diagnosis messages for client type SOAP Client :

Make sure that OAuth2 token endpoint configured as 'token.uri' config override in 'oracle/oauth2_config_client_policy' is valid

OAuth2 client policies (oracle/oauth2_config_client_policy and oauth2 token policy) can also be configured for client type(s): REST_CLIENT, SCA_REST_REFERENCE, SCA_REFERENCE
Health check for server "jrfServer_admin":

Health check status on server jrfServer_admin is FAILED.

次の例では、OAuth2 GPAにおいてOauth2構成ポリシーは構成されません。このコマンドで、ドメイン・レベルでアタッチされたGPA内のOAuth2関連構成がチェックされた後、GPAを作成する手順も示されます。

beginWSMSession();
createWSMPolicySet('oauthTestPolicySet','ws-client','Domain("jrfServer_domain")');
attachWSMPolicy('oracle/http_oauth2_token_client_policy');
setWSMPolicyOverride('oracle/http_oauth2_token_client_policy','oauth2.client.csf.key','basic.client.credentials');
validateWSMPolicySet();
commitWSMSession()

wls:/test_domain1/serverConfig>checkWSMStatus('oauth2')

OAuth2 Client Configuration Status:

Message(s):
OAuth2 Client Configuration Checks for type SOAP Client: FAILED
Policy Attachment Check Messages:
oracle/oauth2_config_client_policy is not present in any policy set configured for domain

Message(s):

OAuth2 client policies (oracle/oauth2_config_client_policy and oauth2 token policy) can also be configured for client type(s): REST_CLIENT, SCA_REST_REFERENCE, SCA_REFERENCE
Health check for server "jrfServer_admin":

Health check status on server jrfServer_admin is FAILED.

Health check status for system is FAILED.

Health check status for system is FAILED.

次の例では、OAuth2 GPAにおいてOauth2クライアント・ポリシーは構成されません。このコマンドで、ドメイン・レベルでアタッチされたGPA内のOAuth2関連構成がチェックされた後、GPAを作成する手順も示されます。

beginWSMSession();
createWSMPolicySet('oauthTestPolicySet','ws-client','Domain("jrfServer_domain")');
attachWSMPolicy('oracle/oauth2_config_client_policy');
setWSMPolicyOverride('oracle/oauth2_config_client_policy','token.uri','http://slc07ehc.us.oracle.com:14100/ms_oauth/oauth2/endpoints/oauthservice/tokens');
validateWSMPolicySet();
commitWSMSession()

wls:/test_domain1/serverConfig>checkWSMStatus('oauth2')

OAuth2 Client Configuration Status:

Message(s):
OAuth2 Client Configuration Checks for type SOAP Client: FAILED
Policy Attachment Check Messages:
OAuth2 Client Policy (For Ex: oracle/http_oauth2_token_client_policy) is not present in any policy set configured for domain

Message(s):

OAuth2 client policies (oracle/oauth2_config_client_policy and oauth2 token policy) can also be configured for client type(s): REST_CLIENT, SCA_REST_REFERENCE, SCA_REFERENCE
Health check for server "jrfServer_admin":

Health check status on server jrfServer_admin is FAILED.

Health check status for system is FAILED.

次の例では、Oauth2 GPAにおいてkeystore.sig.csf.keyは無効です。このコマンドで、ドメイン・レベルでアタッチされたGPA内のOAuth2関連構成がチェックされた後、GPAを作成する手順も示されます。

beginWSMSession();
createWSMPolicySet('oauthTestPolicySet','rest-client','Domain("jrfServer_domain")');
attachWSMPolicy('oracle/oauth2_config_client_policy');
setWSMPolicyOverride('oracle/oauth2_config_client_policy','oauth2.client.csf.key','basic.client.credentials');
attachWSMPolicy('oracle/http_oauth2_token_client_policy');
setWSMPolicyOverride('oracle/http_oauth2_token_client_policy','keystore.sig.csf.key','custom-sign-csf-key');
setWSMPolicyOverride('oracle/oauth2_config_client_policy','token.uri','http://slc07ehc.us.oracle.com:14100/ms_oauth/oauth2/endpoints/oauthservice/tokens');
validateWSMPolicySet();
commitWSMSession()

wls:/test_domain1/serverConfig>checkWSMStatus('oauth2')

OAuth2 Client Configuration Status:

Message(s):
OAuth2 Client Configuration Checks for type REST Client: FAILED

Message(s):

Diagnosis messages for client type REST Client :

Make sure the property keystore.sig.csf.key configured in the OAuth2 client policies keystore-csf-key is also present in the credential store.
Please follow the steps to add a credential to the Credential Store:
1. connect()
2. createCred(map="oracle.wsm.security", key="custom-sign-csf-key", user="<sign-key-alias>", password="<sign-key-password>", desc="Sign CSF Key")

OAuth2 client policies (oracle/oauth2_config_client_policy and oauth2 token policy) can also be configured for client type(s): WS_CLIENT, SCA_REST_REFERENCE, SCA_REFERENCE
Health check for server "jrfServer_admin":

Health check status on server jrfServer_admin is FAILED.

Health check status for system is FAILED.

3.6 Webサービスおよびクライアント管理のコマンド

表3-5にリストされているWLSTコマンドを使用して、デプロイ済、アクティブおよび実行中のWebサービス・アプリケーションのWebサービスを表示および管理します。

注意:

表3-5にリストされているコマンドは、application引数を使用します。

マルチテナント環境で、テナントのパーティション内に特定のアプリケーション・インスタンスをターゲット指定する場合、次に示すようにアプリケーションの一部としてパーティション名を含める必要があります。

/domain/server/application#version$partition

ただし、ドメイン・スコープ・アプリケーションをターゲット指定する場合、パーティション名を含める必要はありません。次に示すように、application引数を使用できます。

/domain/server/application#version

表3-5 Webサービスおよびクライアント管理WLSTコマンド

使用するコマンド

目的

WLSTでの使用

listWebServiceClientPorts

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポート情報をリストします。

オンライン

listWebServiceClients

アプリケーション、SOAコンポジットまたはドメインのWebサービス・クライアント情報をリストします。

オンライン

listWebServiceClientStubProperties

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートのスタブ・プロパティをリストします。

オンライン

listWebServicePorts

Webサービス・アプリケーションまたはSOAコンポジットのWebサービス・ポートをリストします。

オンライン

listWebServices

アプリケーション、コンポジットまたはドメインのWebサービス情報をリストします。

オンライン

setWebServiceClientStubProperties

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートの一連のスタブ・プロパティを構成します。

オンライン

setWebServiceClientStubProperty

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートの1つのスタブ・プロパティを設定、変更または削除します。

オンライン

3.6.1 listWebServiceClientPorts

コマンド・カテゴリ: Webサービスおよびクライアント管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・クライアントのWebサービス・ポート名とエンドポイントURLをリストします。

出力には、Webサービスのクライアントまたは参照ポートが表示されます。次に例を示します。

AppModuleServiceSoapHttpPort

構文

listWebServiceClientPorts(application,moduleOrCompName,moduleType,serviceRefName)

引数

定義

application

Webサービスのポート情報をリストするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

アプリケーションのクライアント・ポート情報を一覧表示するには、この引数が必要です。

moduleOrCompName

Webサービス・クライアント・ポート情報をリストするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのクライアント・ポート情報をリストするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

- wsconn—ADF DC Webサービス・クライアント、ADF JAX-WS Indirection Proxy、WebCenterクライアントなどの接続ベースのWebサービス・クライアントとともに使用します。

serviceRefName

Webサービス・クライアント・ポート情報をリストするアプリケーションまたはSOAコンポジットのサービス参照名。

クライアントが非同期Webサービス・コールバック・クライアントの場合は、serviceRefName引数をcallbackに設定する必要があります。

例

次の例では、/base_domain/server1/jwsclient_1#1.1.0アプリケーションのWssUsernameClient Webモジュールのクライアント・ポートをリストします。moduleTypeがwsconnに設定されており、serviceRefNameがWssUsernameClientに設定されていることに注意してください。

wls:/base_domain/serverConfig> listWebServiceClientPorts
('/base_domain/server1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient')

次の例では、default/HelloWorld[1.0] SOAコンポジットのクライアント・ポートを一覧表示します。moduleTypeがsoaに設定されており、serviceRefNameがclientに設定されていることに注意してください。

wls:/base_domain/serverConfig> listWebServiceClientPorts(None, 'default/HelloWorld[1.0]','soa','client')

3.6.2 listWebServiceClients

コマンド・カテゴリ: Webサービスおよびクライアント管理

WLSTでの使用: オンライン

説明

アプリケーション、SOAコンポジットまたはドメインのWebサービス・クライアント情報をリストします。アプリケーションもコンポジットも指定しない場合、このコマンドでは、ドメイン内のすべてのサーバー・インスタンスのすべてのアプリケーションおよびコンポジットのすべてのWebサービス・クライアントに関するコマンド・リスト情報が一覧表示されます。 アプリケーションが指定されない場合、ドメイン内のサーバー・インスタンスごとに、すべてのアプリケーション内のすべてのWebサービス・クライアントに関する情報がコマンドによってリストされます。

detail引数を使用すると、出力に表示される情報の量を指定できます。指定した場合、ドメイン内のクライアントのエンドポイント(ポート)およびポリシーの詳細、エンドポイントのセキュア・ステータス、すべての構成オーバーライドと制約およびエンドポイントに有効な構成があるかどうかが出力に表示されます。サブジェクトは、(直接またはグローバルに)アタッチされたポリシーで認証、認可またはメッセージ保護操作が強制される場合に、セキュアであると判断されます。直接またはグローバルにアタッチされているポリシーの優先順位を(reference.priority構成オーバーライドを使用して)指定できるため、effectiveフィールドによって、直接アタッチされているポリシーがそのエンドポイントに対して有効かどうかが示されます。

直接アタッチされたポリシーごとに、アタッチメントのソースを識別するlocal.policy.reference.source構成プロパティが提供されています。local.policy.reference.source構成プロパティの詳細および有効な値のリストは、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のポリシー・アタッチメントのソースの特定に関する項を参照してください。

エンドポイントの管理を簡単にするため、直接アタッチされているポリシーは、それが有効化どうかに関係なくすべて出力に表示されます。対照的に、グローバルにアタッチされているポリシーは、そのエンドポイントに対して有効なもののみが表示されます。詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』の効果的なポリシー・セットの計算方法に関する項を参照してください。

次の例に示すように、出力は、デプロイされているアプリケーションごとに一覧表示されます。

この例では、unsecuredエンドポイントの出力を示します。

wls:/jrfServer_domain/serverConfig> listWebServiceClients(detail=true)

/jrfServer_domain/jrfServer_admin/ADFDCDecoupling_Project1_ADFDCDecoupling :
moduleName=testadfbc, moduleType=wsconn, serviceRefName=AppModuleService
AppModuleServiceSoapHttpPort

The policy subject is not secure in this context.

/soa_domain/soa_server1/soa-infra :        compositeName=default/Basic_SOA_Client[1.0], moduleType=soa, serviceRefName=Service1
Basic_soa_service_pt    serviceWSDLURI=http://host.example.com:1234/soa-infra/services/default/Basic_SOA_service/Basic_soa_service.wsdl
oracle.webservices.contentTransferEncoding=base64
oracle.webservices.charsetEncoding=UTF-8
oracle.webservices.operationStyleProperty=document
wsat.flowOption=WSDLDriven
oracle.webservices.soapVersion=soap1.1
oracle.webservices.chunkSize=4096
oracle.webservices.session.maintain=false
oracle.webservices.preemptiveBasicAuth=false
oracle.webservices.encodingStyleProperty=http://schemas.xmlsoap.org/soap/encoding/
oracle.webservices.donotChunk=true
No attached policies found; endpoint is not secure.

この例は、セキュアなエンドポイントの出力を示します。直接アタッチされたポリシーには、そのソースをLOCAL_ATTACHMENTとして識別するlocal.policy.reference.source構成プロパティが提供されており、Fusion Middleware ControlまたはWLSTを使用してアタッチされたことを示します。local.policy.reference.source構成プロパティの詳細および有効な値のリストは、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のポリシー・アタッチメントのソースの特定に関する項を参照してください。

wls:/jrfServer_domain/serverConfig> listWebServiceClients(detail=true)

/jrfServer_domain/jrfServer_admin/ADFDCDecoupling_Project1_ADFDCDecoupling :
moduleName=testadfbc, moduleType=wsconn, serviceRefName=AppModuleService
AppModuleServiceSoapHttpPort serviceWSDLURI=http://host.example.com:1234/ADFBCDecoupling-ADFBCDecoupling-context-root/AppModuleService?wsdl
URI="oracle/wss10_saml_token_with_message_protection_client_policy", category=security, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="LOCAL_ATTACHMENT"

The policy subject is secure in this context.

構文

listWebServiceClients(application,composite,[detail])

引数

定義

application

Webサービス・クライアントをリストするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

指定した場合、アプリケーション内のすべてのWebサービス・クライアントがリストされます。

composite

Webサービス・クライアントをリストするSOAコンポジットの名前。たとえば、default/HelloWorld[1.0]です。

指定した場合、コンポジット内のすべてのWebサービス・クライアントが一覧表示されます。

detail

省略可能。Webサービス・クライアントのポートおよびポリシーの詳細をリストするかどうかを指定します。

直接アタッチされたポリシーごとに、アタッチメントのソースを識別するlocal.policy.reference.source構成プロパティが提供されています。詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のポリシー・アタッチメントのソースの特定に関する項を参照してください。

有効な値は次のとおりです。

- true - 出力には、クライアント、ポート、ポリシー、およびエンドポイントがセキュアであるかないかに関する詳細が含まれます。

- false - 出力にはクライアントのみが一覧表示されます。デフォルトはfalseです。

例

次の例では、ドメイン内のすべてのWebサービス・クライアントの情報をリストします。

wls:/wls-domain/serverConfig>listWebServiceClients()

次の例では、ドメインbase_domain内のサーバーserver1のアプリケーションjwsclient_1#1.10のWebサービス・クライアントをリストします。

wls:/wls-domain/serverConfig>listWebServiceClients('base_domain/server1/jwsclient_1#1.10')

次の例では、SOAコンポジットdefault/HelloWorld[1.0]のWebサービス・クライアントを一覧表示します。

wls:/wls-domain/serverConfig>listWebServiceClients(None,'default/HelloWorld[1.0]')

次の例では、ドメイン内のすべてのWebサービス・クライアントの詳細をリストします。

wls:/wls-domain/serverConfig>listWebServiceClients(None,None,true)

3.6.3 listWebServiceClientStubProperties

注意:

このコマンドは、Oracle Infrastructure Webサービス・クライアントにのみ適用されます。

コマンド・カテゴリ: Webサービスおよびクライアント管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートのスタブ・プロパティをリストします。

構文

listWebServiceClientStubProperties(application, moduleOrCompName, moduleType,
serviceRefName, portInfoName)

引数

定義

application

Webサービス・クライアント・ポートのスタブ・プロパティをリストするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

アプリケーションのクライアント・ポート・スタブ・プロパティ情報を一覧表示するには、この引数が必要です。

moduleOrCompName

Webサービス・クライアント・ポートのスタブ・プロパティをリストするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのクライアント・ポートのスタブ・プロパティ情報をリストするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wsconn—ADF DC Webサービス・クライアント、ADF JAX-WS Indirection Proxy、WebCenterクライアントなどの接続ベースのWebサービス・クライアントとともに使用します。

serviceRefName

Webサービス・クライアント・ポートのスタブ・プロパティをリストするアプリケーションまたはSOAコンポジットのサービス参照名。

portInfoName

スタブ・プロパティを一覧表示するクライアント・ポートの名前。

例

次の例では、/base_domain/server1/jwsclient_1#1.1.0アプリケーションのWssUsernameClient WebモジュールのJRFWssUsernamePortポートのクライアント・ポートのスタブ・プロパティをリストします。moduleTypeがwsconnに設定されており、serviceRefNameがWssUsernameClientに設定されていることに注意してください。

wls:/base_domain/serverConfig>listWebServiceClientStubProperties
('/base_domain/server1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort')

3.6.4 listWebServicePorts

コマンド・カテゴリ: Webサービスおよびクライアント管理

WLSTでの使用: オンライン

説明

Webサービス・アプリケーションまたはSOAコンポジットのWebサービス・ポート名とエンドポイントURLをリストします。

出力には、Webサービス・ポートのポート名およびエンドポイントURLが表示されます。次に例を示します。

JRFWssUsernamePort         http://localhost:7001/j2wbasicPolicy/WssUsername

構文

listWebServicePorts(application,moduleOrCompName,moduleType,serviceName)

引数

定義

application

Webサービスのポート情報をリストするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

アプリケーションのポート情報を一覧表示するには、この引数が必要です。

moduleOrCompName

Webサービス・ポート情報をリストするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのポート情報をリストするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

serviceName

ポート情報をリストするアプリケーションまたはSOAコンポジットのWebサービス名。たとえば、SOAコンポジットに{http://namespace/}serviceName. Note that the namespace ({http://namespace/})を含めることはできません。

例

次の例では、base_domain/AdminServer/HelloWorld#1_0アプリケーション内のOracle Infrastructure Webサービスのj2wbasicPolicyサービスのWebサービス・ポートおよびエンドポイントURLをリストします。WssUsernameServiceモジュール名が指定されており、moduleTypeがwebに設定されていることに注意してください。

wls:/base_domain/serverConfig> listWebServicePorts
( '/base_domain/AdminServer/HelloWorld#1_0',
'WssUsernameService','web','{http://namespace/}j2wbasicPolicy')

JRFWssUsernamePort      http://localhost:7001/j2wbasicPolicy/WssUsername

次の例では、wls-domain/AdminServer/helloWorldJaxwsアプリケーション内のJava EE WebサービスのhelloWorldJaxwsのWebサービス・ポートおよびエンドポイントURLをリストします。moduleTypeはwlsに設定されていることに注意してください。

wls:/wls-domain/serverConfig> listWebServicePorts ('/wls-domain/AdminServer/helloWorldJaxws','helloWorldJaxws#1!helloWorldJaxws', 'wls','helloWorldJaxws')

helloWorldJaxwsSoapHttpPort

3.6.5 listWebServices

コマンド・カテゴリ: Webサービスおよびクライアント管理

WLSTでの使用: オンライン

説明

アプリケーション、SOAコンポジットまたはドメインのWebサービス情報をリストします。Webサービス・アプリケーションまたはSOAコンポジットを指定しない場合、コマンドはドメイン内のサーバー・インスタンスごとに、すべてのアプリケーション内のすべてのサービスとコンポジットをリストします。

detail引数を使用すると、出力に表示される情報の量を指定できます。有効になっている場合、ドメイン内のすべてのアプリケーションとコンポジットのエンドポイント(ポート)およびポリシーの詳細、エンドポイントのセキュア・ステータス、すべての構成オーバーライドと制約およびエンドポイントに有効な構成があるかどうかが出力に表示されます。さらに、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のポリシー・アタッチメントのソースの特定に関する項に説明されているように、直接アタッチされたポリシーごとに、アタッチメントのソースを識別するlocal.policy.reference.source構成プロパティが提供されています。

サブジェクトは、(直接またはグローバルに)アタッチされたポリシーで認証、認可またはメッセージ保護操作が強制される場合に、セキュアであると判断されます。直接またはグローバルにアタッチされているポリシーの優先順位を(reference.priority構成オーバーライドを使用して)指定できるため、effectiveフィールドによって、直接アタッチされているポリシーがそのエンドポイントに対して有効かどうかが示されます。

エンドポイントの管理を簡単にするため、直接アタッチされているポリシーは、それが有効化どうかに関係なくすべて出力に表示されます。対照的に、グローバルにアタッチされているポリシーは、そのエンドポイントに対して有効なもののみが表示されます。詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』の効果的なポリシー・セットの計算方法に関する項を参照してください。

次の例に示すように、出力は、デプロイされているアプリケーションごとに一覧表示されます。

/domain/server/application#version_number:
moduleName=helloModule, moduleType=web, serviceName={http://namespace/}service

/base_domain/AdminServer/soa-infra:

compositeName=default/HelloWorld[1.0],  moduleType=soa, serviceName=service

注意:

listWebServicesコマンドの出力には、ポリシー・アタッチメントなどSOAコンポーネントの詳細は含まれません。

11gリリース1 (11.1.1.6)より前にアセンブルされたアプリケーションでは、出力のserviceNameにネームスペースが表示されません。

構文

listWebServices (application,composite,[detail])

引数

定義

application

Webサービスをリストするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

指定した場合、アプリケーション内のすべてのWebサービスがリストされます。

composite

WebサービスをリストするSOAコンポジットの名前。たとえば、default/HelloWorld[1.0]です。

指定した場合、コンポジット内のすべてのWebサービスが一覧表示されます。

detail

省略可能。Webサービスのポートおよびポリシーの詳細をリストするかどうかを指定します。

直接アタッチされたポリシーごとに、アタッチメントのソースを識別するlocal.policy.reference.source構成プロパティが提供されています。詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のポリシー・アタッチメントのソースの特定に関する項を参照してください。

有効な値は次のとおりです。

- true - 出力には、サービス、ポートおよびポリシーに関する詳細が含まれます。

- false - 出力にはサービスのみが一覧表示されます。デフォルトは、falseです。

例

次のOracle Infrastructure Webサービスの例では、ドメイン内のすべてのアプリケーションとコンポジットのすべてのWebサービスがリストされます。サンプル出力をこの例に示します。

wls:/base_domain/serverConfig> listWebServices()

/base_domain/AdminServer/soa-infra :

compositeName=default/HelloWorld[1.0], moduleType=soa, serviceName=service

compositeName=default/Project1[1.0], moduleType=soa, serviceName=bpelprocess1_client_ep

/base_domain/AdminServer/jaxwsejb30ws :
moduleName=jaxwsejb, moduleType=web, serviceName=JaxwsWithHandlerChainBeanService
moduleName=jaxwsejb, moduleType=web, serviceName=WsdlConcreteService
moduleName=jaxwsejb, moduleType=web, serviceName=EchoEJBService
moduleName=jaxwsejb, moduleType=web, serviceName=CalculatorService
moduleName=jaxwsejb, moduleType=web, serviceName=DoclitWrapperWTJService

次のOracle Infrastructure Webサービスの例では、detail引数をtrueに設定しています。サンプル出力をこの例に示します。セキュリティ・ポリシーは太字のテキストで示しています。

グローバルにアタッチされたポリシーの参照優先度が10に設定され、直接アタッチされたポリシーは、アプリケーションjaxwsejb30ws内のエンドポイントCalculatorPortでは有効でないことに注意してください。

また、直接アタッチされたポリシーごとに、アタッチメントのソースを識別するlocal.policy.reference.source構成プロパティが提供されています。local.policy.reference.source構成プロパティの詳細および有効な値のリストは、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のポリシー・アタッチメントのソースの特定に関する項を参照してください。

wls:/base_domain/serverConfig> listWebServices(detail='true')

/base_domain/AdminServer/jaxwsejb30ws :
moduleName=jaxwsejb, moduleType=web, serviceName=CalculatorService
CalculatorPort  http://host.example.com:1234/jaxwsejb/Calculator
URI="oracle/wss10_saml20_token_with_message_protection_service_policy",
category=security, policy-status=enabled; source=global policy set "
MyPolicySet1", scope="DOMAIN('*')"; reference-status=enabled; effective=true
Property name="reference.priority", value="10"
URI="oracle/mex_request_processing_service_policy",
category=wsconfig, policy-status=enabled; source=local policy set;
reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
URI="oracle/mtom_encode_fault_service_policy", category=wsconfig,
policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
URI="oracle/max_request_size_policy", category=wsconfig,
policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
Property name="max.request.size", value="-1"
URI="oracle/request_processing_service_policy", category=wsconfig,
policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
URI="oracle/soap_request_processing_service_policy", category=wsconfig,
policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
URI="oracle/ws_logging_level_policy", category=wsconfig,
policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="logging.level", value=""
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
URI="oracle/test_page_processing_service_policy", category=wsconfig,
policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
URI="oracle/wsdl_request_processing_service_policy", category=wsconfig,
policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="IMPLIED_FEATURE"
URI="oracle/http_saml20_token_bearer_service_policy", category=security,
policy-status=enabled; source=local policy set; reference-status=enabled;  reference-status=enabled; effective=false
Property name="local.policy.reference.source", value="ANNOTATION"

The policy subject is secure in this context.

次のJava EE Webサービスの例では、detail引数をtrueに設定しています。サンプル出力をこの例に示します。出力には、ドメイン内のすべてのアプリケーションとコンポジットのすべてのWebサービスがリストされます。

/base_domain/AdminServer/SimpleJAXWS :
moduleName=SimpleJAXWS#1!SimpleEjbService, moduleType=wls, serviceName=SimpleEjbService
SimplePort
URI="oracle/http_basic_auth_over_ssl_service_policy", category=security, policy-status=enabled; source=local policy set; reference-status=enabled; effective=true
Property name="local.policy.reference.source", value="LOCAL_ATTACHMENT"

The policy subject is secure in this context.

moduleName=SimpleJAXWS#1!SimpleImplService, moduleType=wls, serviceName=SimpleImplService
SimplePort
has Operation level ws-policy
Attached policy or policies are valid; endpoint is not secure.

3.6.6 setWebServiceClientStubProperties

注意:

このコマンドは、Oracle Infrastructure Webサービス・クライアントにのみ適用されます。

コマンド・カテゴリ: Webサービスおよびクライアント管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートの一連のスタブ・プロパティを構成します。

このコマンドは、クライアントにアタッチされたOWSMクライアント・セキュリティ・ポリシーのすべてのスタブ・プロパティを構成またはリセットします。このコマンドで一覧表示する各プロパティが、指定した値に設定されます。前に設定したプロパティが、このコマンドに明示的に指定されていない場合、それはそのプロパティのデフォルトにリセットされます。デフォルトが存在しない場合、そのプロパティは削除されます。

構文

setWebServiceClientStubProperties(application, moduleOrCompName, moduleType,
serviceRefName, portInfoName, properties)

引数

定義

application

Webサービス・クライアント・ポートのスタブ・プロパティをリセットするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

アプリケーションのクライアント・ポート・スタブ・プロパティを構成またはリセットするには、この引数が必要です。

moduleOrCompName

Webサービス・クライアント・ポートのスタブ・プロパティをリセットするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのクライアント・ポートのスタブ・プロパティを構成またはリセットするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wsconn—ADF DC Webサービス・クライアント、ADF JAX-WS Indirection Proxy、WebCenterクライアントなどの接続ベースのWebサービス・クライアントとともに使用します。

serviceRefName

Webサービス・クライアント・ポートのスタブ・プロパティをリセットするアプリケーションまたはSOAコンポジットのサービス参照名。

portInfoName

スタブ・プロパティをリセットするクライアント・ポートの名前。

properties

設定または変更するプロパティのリスト。次の形式を使用してプロパティを指定する必要があります。

("property","value")

次に例を示します。

[("keystore.recipient.alias","oracle"), ("csf-key","oracle")]

プロパティを削除するか、それに割り当てられた値をクリアするには、空白""値を指定します。次に例を示します。

[("csf-key","")]

クライアント・ポートのすべてのプロパティを削除するには、この引数をNoneに設定します。

クライアント・ポート・スタブ・プロパティの例は、次のとおりです:

- oracle.webservices.auth.username

- oracle.webservices.auth.password

- keystore.recipient.alias

- csf-key

- saml.issuer.name

- javax.xml.ws.session.maintain

- wsat.Version - SOA参照のみ

- wsat.flowOption - SOA参照のみ

例

次の例では、クライアント・ポートのスタブ・プロパティROLEおよびkeystore.recipient.aliasをADMINおよびorakeyにそれぞれリセットします。このクライアント・ポートに以前に設定されていたその他すべてのプロパティは、デフォルトにリセットされるか削除されます。クライアント・ポートは、/base_domain/server1/jwsclient_1#1.1.0アプリケーション内のWssUsernameClient WebモジュールのJRFWssUsernamePortです。moduleTypeがwsconnに設定されており、serviceRefNameがWssUsernameClientに設定されていることに注意してください。

wls:/base_domain/serverConfig>setWebServiceClientStubProperties('/base_domain/server1/jwsclient_1#1.1.0',
'WssUsernameClient','wsconn','WssUsernameClient','JRFWssUsernamePort',
[("ROLE","ADMIN"),("keystore.recipient.alias","orakey")] )

3.6.7 setWebServiceClientStubProperty

コマンド・カテゴリ: Webサービスおよびクライアント管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートの1つのスタブ・プロパティを設定、変更または削除します。

構文

setWebServiceClientStubProperty(application, moduleOrCompName, moduleType,
serviceRefName,portInfoName,propName,[propValue])

引数

定義

application

Webサービス・クライアント・ポートのスタブ・プロパティを設定するアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

アプリケーションのクライアント・ポート・スタブ・プロパティを設定するには、この引数が必要です。

moduleOrCompName

Webサービス・クライアント・ポートのスタブ・プロパティを設定するWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのクライアント・ポートのスタブ・プロパティを設定するには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

- wsconn—ADF DC Webサービス・クライアント、ADF JAX-WS Indirection Proxy、WebCenterクライアントなどの接続ベースのWebサービス・クライアントとともに使用します。

serviceRefName

Webサービス・クライアント・ポートのスタブ・プロパティを設定するアプリケーションまたはSOAコンポジットのサービス参照名。

portInfoName

スタブ・プロパティを設定するクライアント・ポートの名前。

propName

設定、変更または削除するスタブ・プロパティ名。たとえば、'keystore.recipient.alias'です。

propValue

省略可能。スタブ・プロパティ値で、たとえば、'orakey'です。

プロパティを削除するには、空白""値を指定します。

例

次の例では、クライアント・ポートのスタブ・プロパティkeystore.recipient.aliasをクライアント・ポートJRFWssUsernamePortの値orakeyに設定します。ポートは、/base_domain/server1/jwsclient_1#1.1.0アプリケーション内のWssUsernameClient Webモジュールのクライアント・ポートです。moduleTypeがwsconnに設定されており、serviceRefNameがWssUsernameClientに設定されていることに注意してください。

wls:/base_domain/serverConfig>setWebServiceClientStubProperty
('/base_domain/server1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort','keystore.recipient.alias','orakey')

3.7 ポリシー管理コマンド

注意:

表3-7にリストされているJava EE Webサービス(またはクライアント)のポリシー管理コマンドは、Oracle Infrastructure Webサービスのこのリリースで非推奨になりました。

Oracle Infrastructure Webサービスでは、リリース12cでOWSMの直接アタッチされたポリシーを管理するには、表3-6にリストされているWLSTの新しいコマンドを使用することをお薦めします。非推奨コマンドをすべて示すリストは、『Oracle Fusion Middleware Oracle Fusion Middleware Infrastructureリリース・ノート』の非推奨となったOracle Infrastructure Webサービスのコマンドに関する項を参照してください。

表3-6にリストされているWLSTコマンドを使用して、Oracle InfrastructureおよびRESTful Webサービスの直接ポリシーおよびグローバル・ポリシーのアタッチメントを管理します。

表3-6 Oracle InfrastructureおよびRESTful Webサービスおよびクライアント - 直接ポリシー・アタッチメントのWLSTコマンド

使用するコマンド

目的

WLSTでの使用

attachWSMPolicy

セッション内の選択したポリシー・サブジェクトまたはポリシー・セット・ドキュメントにポリシーをアタッチします。

オンライン

attachWSMPolicies

セッション内の選択したポリシー・サブジェクトまたはポリシー・セット・ドキュメントに複数のポリシーをアタッチします。

オンライン

detachWSMPolicy

セッション内の選択したポリシー・サブジェクトまたはポリシー・セット・ドキュメントからポリシーをデタッチします。

オンライン

detachWSMPolicies

セッション内の選択したポリシー・サブジェクトまたはポリシー・セット・ドキュメントから複数のポリシーをデタッチします。

オンライン

enableWSMPolicies

セッション内の選択したポリシー・サブジェクトまたはポリシー・セット・ドキュメントにアタッチされている複数のポリシーを有効化または無効化します。

オンライン

enableWSMPolicy

セッション内の選択したポリシー・サブジェクトまたはポリシー・セット・ドキュメントにアタッチされているポリシーを有効化または無効化します。

オンライン

listAvailableWebServicePolicies

使用可能なすべてのOWSMポリシーのリストをカテゴリまたはサブジェクト・タイプごとに表示します。

オンライン

listWebServiceClientPolicies

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートのポリシー情報をリストします。

オンライン

listWebServicePolicies

アプリケーションまたはSOAコンポジットのWebサービスのWebサービス・ポートのポリシー情報をリストします。

オンライン

setWSMPolicyOverride

セッション内の選択したポリシー・サブジェクトまたはポリシー・セット・ドキュメントにアタッチされているポリシーのオーバーライド・プロパティを構成します。

オンライン

表3-7にリストされているWLSTコマンドを使用して、Java EE Webサービス(またはクライアント)の直接アタッチされたポリシーを管理します。

注意:

表3-7にリストされているコマンドは、application引数を使用します。

マルチテナント環境で、テナントのパーティション内に特定のアプリケーション・インスタンスをターゲット指定する場合、次に示すようにアプリケーションの一部としてパーティション名を含める必要があります。

/domain/server/application#version$partition

ただし、ドメイン・スコープ・アプリケーションをターゲット指定する場合、パーティション名を含める必要はありません。次に示すように、application引数を使用できます。

/domain/server/application#version

表3-7 Java EE Webサービス(またはクライアント) - 直接ポリシー・アタッチメントのWLSTコマンド

使用するコマンド

目的

WLSTでの使用

attachWebServiceClientPolicies

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートに複数のポリシーをアタッチします。

オンライン

attachWebServiceClientPolicy

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートにOWSMポリシーをアタッチします。

オンライン

attachWebServicePolicies

アプリケーションまたはSOAコンポジットのWebサービス・ポートに複数のポリシーをアタッチします。

オンライン

attachWebServicePolicy

アプリケーションまたはSOAコンポジットのWebサービス・ポートにポリシーをアタッチします。

オンライン

detachWebServiceClientPolicies

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートから複数のポリシーをデタッチします。

オンライン

detachWebServiceClientPolicy

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートからポリシーをデタッチします。

オンライン

detachWebServicePolicies

アプリケーションまたはSOAコンポジットのWebサービス・ポートから複数のOWSMポリシーをデタッチします。

オンライン

detachWebServicePolicy

アプリケーションまたはSOAコンポジットのWebサービス・ポートからOWSMポリシーをデタッチします。

オンライン

enableWebServiceClientPolicies

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートの複数のポリシーを有効または無効にします。

オンライン

enableWebServiceClientPolicy

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートのポリシーを有効または無効にします。

オンライン

enableWebServicePolicies

Webサービス・アプリケーションまたはSOAコンポジットのポートにアタッチされている複数のポリシーを有効または無効にします。

オンライン

enableWebServicePolicy

Webサービス・アプリケーションまたはSOAコンポジットのポートにアタッチされているポリシーを有効または無効にします。

オンライン

listAvailableWebServicePolicies

使用可能なすべてのOWSMポリシーのリストをカテゴリまたはサブジェクト・タイプごとに表示します。

オンライン

listWebServiceClientPolicies

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートのポリシー情報をリストします。

オンライン

listWebServicePolicies

アプリケーションまたはSOAコンポジットのWebサービスのWebサービス・ポートのポリシー情報をリストします。

オンライン

3.7.1 attachWebServiceClientPolicies

注意:

このコマンドは、Java EE Webサービス(またはクライアント)のみに使用します。Oracle Infrastructure Webサービスでは非推奨になりました。

Oracle Infrastructure Webサービスでは、このコマンドは非推奨になりました。「attachWSMPolicies」に記載されているとおり、attachWSMPoliciesコマンドを使用することをお薦めします。次の例に、attachWSMPoliciesコマンドを使用するための移行方法を示します。

11gリリース:

wls:/wls-domain/serverConfig>attachWebServiceClientPolicies
('/base_domain/server1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort',["oracle/wss_username_token_client_policy","oracle/log_policy"])

12cリリース:

wls:/wls-domain/serverConfig>attachWSMPolicies(["oracle/wss_username_token_client_policy","oracle/log_policy"])

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートに複数のポリシーをアタッチします。

wsm-pmアプリケーションがWebLogic Serverにインストールされていて使用可能は場合は、policyURIはOWSM Policy Manager APIによって検証されます。

Java EE (wls)モジュール・タイプのみ: このコマンドで指定したポリシーがすでにアタッチされているか存在する場合は、このコマンドでそのアタッチ済ポリシーが有効になり(無効な場合)、存在しているポリシーはアタッチされます。

wsm-pmアプリケーションがインストールされていないか使用可能でない場合は、このコマンドは実行されません。

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。

構文

attachWebServiceClientPolicies(application,moduleOrCompName,moduleType,
serviceRefName,portInfoName,policyURIs,[subjectType=None] )

引数

定義

application

Webサービスのクライアント・ポートにOWSMクライアント・ポリシーをアタッチするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのクライアント・ポートにポリシーをアタッチするには、この引数は必須です。

moduleOrCompName

クライアント・ポートにポリシーをアタッチするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのクライアント・ポートにポリシーをアタッチするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

- wsconn—ADF DC Webサービス・クライアント、ADF JAX-WS Indirection Proxy、WebCenterクライアントなどの接続ベースのWebサービス・クライアントとともに使用します。

注意: webおよびwsconnモジュール・タイプはこのリリースでは非推奨です。

serviceRefName

アプリケーションまたはコンポジットのサービス参照名。

portInfoName

OWSMクライアント・ポリシーをアタッチするクライアント・ポート。

policyURI

OWSMポリシー名のURIで、たとえば、["oracle/log_policy","oracle/wss_username_token_client_policy"]です。

このコマンドで指定するポリシーが、すでにアタッチされているか存在している場合、このコマンドによって、すでにアタッチされているポリシーが有効化され(そのポリシーが無効化されている場合)、その他のものはアタッチされます。

subjectType

省略可能。ポリシー・サブジェクト・タイプ。有効なオプションは次のとおりです。

- P - ポート。デフォルトはPです。

- O - このリリースではサポートされていません。

例

次の例では、ポリシーoracle/log_policyを、SOAコンポジットdefault/HelloWorld[1.0]のクライアント・ポートHelloWorld_ptにアタッチします。

wls:/wls-domain/serverConfig>attachWebServiceClientPolicies
(None, 'default/HelloWorld[1.0]','soa','client','HelloWorld_pt',["oracle/wss_username_token_client_policy","oracle/log_policy"])

次の例では、Java EE Webモジュールowsm_mbean.resouce_pattern.web.ClientJWS/sei2のクライアント・ポートUpperCaseImplPortにポリシーoracle/wss10_saml20_token_client_policyおよびoracle/wss11_message_protection_client_policyをアタッチします。

wls:/wls-domain/serverConfig>attachWebServiceClientPolicies
('/wls-domain/AdminServer/ClientJWS','owsm_mbean.resouce_pattern.web.ClientJWS/sei2','wls','owsm_mbean.resouce_pattern.web.ClientJWS/sei2','UpperCaseImplPort',["oracle/wss10_saml20_token_client_policy","oracle/wss11_message_protection_client_policy"])

3.7.2 attachWebServiceClientPolicy

注意:

このコマンドは、Java EE Webサービス(またはクライアント)のみに使用します。Oracle Infrastructure Webサービスでは非推奨になりました。

Oracle Infrastructure Webサービスでは、「attachWSMPolicy」に記載されているとおり、attachWSMPolicyコマンドを使用することをお薦めします。次の例に、attachWSMPolicyコマンドを使用するための移行方法を示します。

11gリリース:

wls:/wls-domain/serverConfig>attachWebServiceClientPolicy
('/base_domain/server1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort',"oracle/wss_username_token_client_policy")

12c:

wls:/wls-domain/serverConfig>attachWSMPolicy("oracle/wss_username_token_client_policy")

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートにOWSMポリシーをアタッチします。

wsm-pmアプリケーションがWebLogic Serverにインストールされていて使用可能は場合は、policyURIはOWSM Policy Manager APIによって検証されます。

Java EE (wls)モジュール・タイプのみ: このコマンドで指定したPolicyURIがすでにアタッチされているか存在する場合は、このコマンドでそのポリシーが有効になります(無効な場合)。

wsm-pmアプリケーションがインストールされていないか使用可能でない場合は、このコマンドは実行されません。

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。

構文

attachWebServiceClientPolicy(application,moduleOrCompName,moduleType,
serviceRefName, portInfoName, policyURI, [subjectType=None] )

引数

定義

application

Webサービスのクライアント・ポートにポリシーをアタッチするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのクライアント・ポートにポリシーをアタッチするには、この引数は必須です。

moduleOrCompName

クライアント・ポートにポリシーをアタッチするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのクライアント・ポートにポリシーをアタッチするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

- wsconn—ADF DC Webサービス・クライアント、ADF JAX-WS Indirection Proxy、WebCenterクライアントなどの接続ベースのWebサービス・クライアントとともに使用します。

注意: webおよびwsconnモジュール・タイプはこのリリースでは非推奨です。

serviceRefName

アプリケーションまたはコンポジットのサービス参照名。

portInfoName

OWSMクライアント・ポリシーをアタッチするクライアント・ポート。

policyURI

OWSMポリシー名のURIで、たとえば、oracle/wss_username_token_client_policy"です。

指定するポリシーが、すでにアタッチされているか存在している場合、そのポリシーが無効化されていると、このコマンドによってそれが有効化されます。

subjectType

省略可能。ポリシー・サブジェクト・タイプ。有効なオプションは次のとおりです。

- P - ポート。デフォルトはPです。

- O - このリリースではサポートされていません。

例

次の例では、クライアント・ポリシーoracle/log_policyを、SOAコンポジットdefault/HelloWorld[1.0]のクライアント・ポートHelloWorld_ptにアタッチします。

wls:/wls-domain/serverConfig>attachWebServiceClientPolicy
(None, 'default/HelloWorld[1.0]','soa','client','HelloWorld_pt','oracle/log_policy')

次の例では、oracle/wss_username_token_client_policyクライアント・ポリシーをWebモジュールowsm_mbean.resouce_pattern.web.ClientJWS/sei2のJava EE Webサービスのクライアント・ポートUpperCaseImplPortにアタッチします。Webサービスは、アプリケーションClientJWSの一部です。

wls:/wls-domain/serverConfig> attachWebServiceClientPolicy ('/wls-domain/AdminServer/ClientJWS','owsm_mbean.resouce_pattern.web.ClientJWS/sei2', 'wls','owsm_mbean.resouce_pattern.web.ClientJWS/sei2', 'UpperCaseImplPort', "oracle/wss_username_token_client_policy")

3.7.3 attachWebServicePolicies

注意:

このコマンドは、Java EE Webサービス(またはクライアント)のみに使用します。Oracle Infrastructure Webサービスでは非推奨になりました。

Oracle Infrastructure Webサービスでは、「attachWSMPolicies」に記載されているとおり、attachWSMPoliciesコマンドを使用することをお薦めします。次の例に、attachWSMPoliciesコマンドを使用するための移行方法を示します。

11gリリース:

wls:/wls-domain/serverConfig> attachWebServicePolicies
('/base_domain/server1/HelloWorld#1_0','j2wbasicPolicy','web',
'{http://namespace/}WssUsernameService','JRFWssUsernamePort',
["oracle/log_policy", "oracle/wss_username_token_service_policy"])

12cリリース:

wls:/wls-domain/serverConfig> attachWSMPolicies["oracle/log_policy", "oracle/wss_username_token_service_policy"])

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・ポートに複数のポリシーをアタッチします。

wsm-pmアプリケーションがWebLogic Serverにインストールされていて使用可能は場合は、policyURIはOWSM Policy Manager APIによって検証されます。

Java EE (wls)モジュール・タイプのみ: このコマンドで指定したポリシーのいずれかがすでにアタッチされているか存在する場合は、このコマンドでそのアタッチ済ポリシーが有効になり(無効な場合)、存在しているポリシーはアタッチされます。

wsm-pmアプリケーションがインストールされていないか使用可能でない場合は、このコマンドは実行されません。

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。

構文

attachWebServicePolicies(application, moduleOrCompName, moduleType, serviceName,
subjectName,policyURIs,[subjectType=None])

引数

定義

application

Webサービス・ポリシーをアタッチするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのポートにポリシーをアタッチするには、この引数は必須です。

moduleOrCompName

Webサービス・ポリシーをアタッチするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのポートにポリシーをアタッチするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

注意: webモジュール・タイプはこのリリースでは非推奨です。

serviceName

アプリケーションまたはSOAコンポジット内のWebサービスの名前。たとえば、{http://namespace/}serviceNameです。SOAコンポジットにはネームスペース({http://namespace/})を含めないでください。

subjectName

ポリシー・サブジェクト、ポートまたは操作の名前。

policyURIs

OWSMポリシー名のURIのリストで、たとえば、["oracle/log_policy","oracle/wss_username_token_service_policy"]です。

指定するポリシーのいずれかが、すでにアタッチされているか存在している場合、このコマンドによって、すでにアタッチされているポリシーが有効化され(そのポリシーが無効化されている場合)、その他のものはアタッチされます。

subjectType

省略可能。ポリシー・サブジェクト・タイプ。有効なオプションは次のとおりです。

- P - ポート。デフォルトはPです。

- O - このリリースではサポートされていません。

例

次の例では、ポリシー'oracle/binding_authorization_denyall_policy'および'oracle/wss_username_token_service_policy'をWebモジュールhelloWorldJaxwsのポートhelloWorldJaxwsSoapHttpPortにアタッチします。Java EE Webサービスは、ドメインwls-domain内のサーバーAdminServerのアプリケーションhelloWorldJaxwsの一部です。

wls:wls-domain/ServerConfig>attachWebServicePolicies ('/wls-domain/AdminServer/helloWorldJaxws','helloWorldJaxws#1!helloWorldJaxws', 'wls','helloWorldJaxws', 'helloWorldJaxwsSoapHttpPort, ['oracle/binding_authorization_denyall_policy', 'oracle/wss_username_token_service_policy'])

3.7.4 attachWebServicePolicy

注意:

このコマンドは、Java EE Webサービス(またはクライアント)のみに使用します。Oracle Infrastructure Webサービスでは非推奨になりました。

Oracle Infrastructure Webサービスでは、「attachWSMPolicy」に記載されているとおり、attachWSMPolicyコマンドを使用することをお薦めします。次の例に、attachWSMPolicyコマンドを使用するための移行方法を示します。

11gリリース:

wls:/wls-domain/serverConfig> attachWebServicePolicy
('/base_domain/server1/HelloWorld#1_0','j2wbasicPolicy','web',
'{http://namespace/}WssUsernameService','JRFWssUsernamePort','oracle/wss_username_token_service_policy')

12cリリース:

wls:/wls-domain/serverConfig> attachWSMPolicy('oracle/wss_username_token_service_policy')

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・ポートにポリシーをアタッチします。

wsm-pmアプリケーションがWebLogic Serverにインストールされていて使用可能は場合は、policyURIはOWSM Policy Manager APIによって検証されます。

Java EE (wls)モジュール・タイプのみ: このコマンドで指定したPolicyURIがすでにアタッチされているか存在する場合は、このコマンドでそのポリシーが有効になります(無効な場合)。

wsm-pmアプリケーションがインストールされていないか使用可能でない場合は、このコマンドは実行されません。

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。

構文

attachWebServicePolicy(application, moduleOrCompName, moduleType, serviceName,
subjectName, policyURI, [subjectType=None])

引数

定義

application

Webサービス・ポリシーをアタッチするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのポートにポリシーをアタッチするには、この引数は必須です。

moduleOrCompName

Webサービス・ポリシーをアタッチするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのポートにポリシーをアタッチするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

注意: webモジュール・タイプはこのリリースでは非推奨です。

serviceName

アプリケーションまたはSOAコンポジット内のWebサービスの名前。たとえば、{http://namespace/}serviceNameです。SOAコンポジットにはネームスペース({http://namespace/})を含めないでください。

subjectName

ポリシー・サブジェクト、ポートまたは操作の名前。

policyURI

OWSMポリシー名のURIで、たとえば、'oracle/log_policy'です。

subjectType

省略可能。ポリシー・サブジェクト・タイプ。有効なオプションは次のとおりです。

- P - ポート。デフォルトはPです。

- O - このリリースではサポートされていません。

例

次の例では、ポリシーoracle/log_policyを、SOAコンポジットdefault/HelloWorld[1.0]のサービスHelloServiceのポートHelloWorld_ptにアタッチします。SOAコンポジットにはネームスペース({http://namespace/})を含めないでください。

wls:/wls-domain/serverConfig>attachWebServicePolicy(None, 'default/HelloWorld[1.0]','soa','HelloService','HelloWorld_pt','oracle/log_policy')

次の例では、ポリシーoracle/wss_username_token_service_policyをJava EE WebサービスhelloWorldJaxwsのポートhelloWorldJaxwsSoapHttpPortにアタッチします。

wls:wls-domain/serverConfig> attachWebServicePolicy ('/wls-domain/AdminServer/helloWorldJaxws','helloWorldJaxws#1!helloWorldJaxws', 'wls','helloWorldJaxws', 'helloWorldJaxwsSoapHttpPort', 'oracle/wss_username_token_service_policy')

Webサービスには、WebLogic Webサービス・ポリシーおよびOracle Webサービス・ポリシーの両方を含めることはできません。WebサービスにWebLogic Webサービス・ポリシーが含まれている場合、それをデタッチしてからOracle Webサービス・ポリシーをアタッチする必要があります。次の例では、WebLogic Webサービス・ポリシーWssp1.2-2007-Saml2.0-SenderVouches-Wss1.1.xmlをJava EE WebサービスSimpleEjbServiceのポートSimplePortからデタッチし、その後Oracle Webサービス・ポリシーoracle/wss_username_token_service_policyをアタッチします。

wls:wls-domain/serverConfig>detachWebServicePolicy('/wls-domain/AdminServer/SimpleJAXWS','SimpleJAXWS#1!SimpleEjbService', 'wls','SimpleEjbService', 'SimplePort','policy:Wssp1.2-2007-Saml2.0-SenderVouches-Wss1.1.xml')

wls:wls-domain/serverConfig>attachWebServicePolicy('/wls-domain/AdminServer/SimpleJAXWS','SimpleJAXWS#1!SimpleEjbService', 'wls','SimpleEjbService', 'SimplePort', 'oracle/wss_username_token_service_policy')

注意:

detachWebServicePolicy WLSTコマンドを使用すると、WebサービスからWebLogic Webサービス・ポリシーをデタッチできます。ただし、attachWebServicePolicy WLSTコマンドを使用してWebLogic Webサービス・ポリシーはアタッチできません。WebLogic Webサービス・ポリシーをWebサービスにアタッチするには、WebLogic管理コンソールを使用する必要があります。

3.7.5 attachWSMPolicies

注意:

このコマンドは、Oracle InfrastructureおよびRESTful Webサービスに適用されます。このリリースのJava EE Webサービスには適用されません。

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

セッション内で、指定したURIで特定される複数のポリシーを、選択されているポリシー・サブジェクトにアタッチします。

コマンドを開始する前に、セッションを開始してポリシー・セット(selectWSMPolicySet)またはポリシー・サブジェクト(selectWSMPolicySubject)を選択する必要があります。ただし、ポリシー・セットの作成またはクローニング時にattachWSMPoliciesが発行されている場合は、すでに選択されているためポリシー・セットを選択する必要はありません。現在のセッションがなく、ポリシー・サブジェクトが選択されていない場合は、エラーが表示されます。

構文

attachWSMPolicies(uris)

要素

説明

uris

OWSMポリシー名のURIのリストで、たとえば、["oracle/log_policy","oracle/wss_username_token_service_policy"]です。

例

次の例では、ポリシーoracle/log_policyおよびoracle/wss_username_token_service_policyをアタッチします。すでにポリシー・サブジェクトが選択されていることを想定しています。

wls:/wls-domain/serverConfig>attachWSMPolicies(["oracle/log_policy", "oracle/wss_username_token_service_policy"])

3.7.6 attachWSMPolicy

注意:

このコマンドは、Oracle InfrastructureおよびRESTful Webサービスに適用されます。このリリースのJava EE Webサービスには適用されません。

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

セッション内で、指定したURIで特定されるポリシーを、選択されているポリシー・サブジェクトまたはポリシー・セットにアタッチします。

コマンドを開始する前に、セッションを開始してポリシー・セット(selectWSMPolicySet)またはポリシー・サブジェクト(selectWSMPolicySubject)を選択する必要があります。ただし、ポリシー・セットの作成またはクローニング時にattachWSMPolicyが発行されている場合は、すでに選択されているためポリシー・セットを選択する必要はありません。現在のセッションがなく、ポリシー・サブジェクトが選択されていない場合は、エラーが表示されます。

構文

attachWSMPolicy(uri)

引数

定義

uri

OWSMポリシー名のURIで、たとえば、'oracle/log_policy'です。

例

次の例では、ポリシーoracle/wss_username_token_service_policyをアタッチします。すでにWebサービス・ポート、Webサービス・クライアント・ポートまたは現在のポリシー・セットが選択されていることを前提としています。

wls:/wls-domain/serverConfig>attachWSMPolicy('oracle/wss_username_token_service_policy')

3.7.7 detachWebServiceClientPolicies

注意:

このコマンドは、Java EE Webサービス(またはクライアント)のみに使用します。Oracle Infrastructure Webサービスでは非推奨になりました。

Oracle Infrastructure Webサービスでは、「detachWSMPolicies」に記載されているとおり、detachWSMPoliciesコマンドを使用することをお薦めします。次の例に、detachWSMPoliciesコマンドを使用するための移行方法を示します。

11gリリース:

wls:/wls-domain/serverConfig>detachWebServiceClientPolicies
('/base_domain/server1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort',
["oracle/log_policy","oracle/wss_username_token_client_policy"])

12cリリース:

wls:/wls-domain/serverConfig>detachWSMPolicies(["oracle/log_policy","oracle/wss_username_token_client_policy"])

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートから複数のポリシーをデタッチします。

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。

構文

detachWebServiceClientPolicies(application,moduleOrCompName,moduleType,
serviceRefName,portInfoName,policyURIs,[subjectType=None] )

引数

定義

application

Webサービスのクライアント・ポートから複数のポリシーをデタッチするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのクライアント・ポートから複数のポリシーをデタッチするには、この引数は必須です。

moduleOrCompName

クライアント・ポートから複数のポリシーをデタッチするWebモジュールまたはSOAコンポジット(HelloWorld[1.0]など)の名前。

SOAコンポジットのクライアント・ポートから複数のポリシーをデタッチするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

- wsconn—ADF DC Webサービス・クライアント、ADF JAX-WS Indirection Proxy、WebCenterクライアントなどの接続ベースのWebサービス・クライアントとともに使用します。

注意: webおよびwsconnモジュール・タイプはこのリリースでは非推奨です。

serviceRefName

アプリケーションまたはコンポジットのサービス参照名。

portInfoName

OWSMクライアント・ポリシーをデタッチするクライアント・ポート。

policyURI

OWSMポリシー名のURIで、たとえば、oracle/wss_username_token_client_policy"です。

指定するポリシーがアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

subjectType

省略可能。ポリシー・サブジェクト・タイプ。有効なオプションは次のとおりです。

- P - ポート。デフォルトはPです。

- O - このリリースではサポートされていません。

例

次の例では、Java EE Webサービス・モジュールowsm_mbean.resouce_pattern.web.ClientJWS/sei2のポートUpperCaseImplPortのクライアント・ポリシーoracle/wss10_saml20_token_client_policyおよびoracle/wss11_message_protection_client_policyをデタッチします。

wls:/wls-domain/serverConfig>detachWebServiceClientPolicies('/wls-domain/AdminServer/ClientJWS','owsm_mbean.resouce_pattern.web.ClientJWS/sei2','wls','owsm_mbean.resouce_pattern.web.ClientJWS/sei2','UpperCaseImplPort',["oracle/wss10_saml20_token_client_policy","oracle/wss11_message_protection_client_policy"])

3.7.8 detachWebServiceClientPolicy

注意:

このコマンドは、Java EE Webサービス(またはクライアント)のみに使用します。Oracle Infrastructure Webサービスでは非推奨になりました。

Oracle Infrastructure Webサービスでは、「detachWSMPolicy」に記載されているとおり、detachWSMPolicyコマンドを使用することをお薦めします。次の例に、detachWSMPolicyコマンドを使用するための移行方法を示します。

11gリリース:

wls:/wls-domain/serverConfig>detachWebServiceClientPolicy
('/base_domain/server1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort','oracle/wss_username_token_client_policy')

12cリリース:

wls:/wls-domain/serverConfig>detachWSMPolicy('oracle/wss_username_token_client_policy')

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートからポリシーをデタッチします。

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。

構文

detachWebServiceClientPolicy(application,moduleOrCompName,moduleType,
serviceRefName, portInfoName, policyURI, [subjectType=None] )

引数

定義

application

Webサービスのクライアント・ポートからポリシーをデタッチするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのクライアント・ポートからポリシーをデタッチするには、この引数は必須です。

moduleOrCompName

クライアント・ポートからポリシーをデタッチするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのクライアント・ポートからポリシーをデタッチするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

- wsconn—ADF DC Webサービス・クライアント、ADF JAX-WS Indirection Proxy、WebCenterクライアントなどの接続ベースのWebサービス・クライアントとともに使用します。

注意: webおよびwsconnモジュール・タイプはこのリリースでは非推奨です。

serviceRefName

アプリケーションまたはコンポジットのサービス参照名。

portInfoName

OWSMクライアント・ポリシーをデタッチするクライアント・ポート。

policyURI

OWSMポリシー名のURIで、たとえば、oracle/wss_username_token_client_policy"です。

指定するポリシーがアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

subjectType

省略可能。ポリシー・サブジェクト・タイプ。有効なオプションは次のとおりです。

- P - ポート。デフォルトはPです。

- O - このリリースではサポートされていません。

例

次の例では、SOAコンポジットdefault/HelloWorld[1.0]のクライアント・ポートHelloWorld_ptからクライアント・ポリシーoracle/log_policyをデタッチします。

wls:/wls-domain/serverConfig>detachWebServiceClientPolicy(None,
'default/HelloWorld[1.0]','soa','client','HelloWorld_pt','oracle/log_policy' )

次のコマンドは、Java EEクライアント・モジュールwsm_mbean.resouce_pattern.web.ClientJWS/sei2のクライアント・ポートUpperCaseImplPortからクライアント・ポリシーoracle/wss_username_token_client_policyをデタッチします。

wls:/wls-domain/serverConfig>  detachWebServiceClientPolicy('/wls-domain/AdminServer/ClientJWS', 'owsm_mbean.resouce_pattern.web.ClientJWS/sei2', 'wls', 'owsm_mbean.resouce_pattern.web.ClientJWS/sei2', 'UpperCaseImplPort', "oracle/wss_username_token_client_policy")

3.7.9 detachWebServicePolicies

注意:

このコマンドは、Java EE Webサービス(またはクライアント)のみに使用します。Oracle Infrastructure Webサービスでは非推奨になりました。

Oracle Infrastructure Webサービスでは、「detachWSMPolicies」に記載されているとおり、detachWSMPoliciesコマンドを使用することをお薦めします。次の例に、detachWSMPoliciesコマンドを使用するための移行方法を示します。

11gリリース:

wls:/wls-domain/serverConfig>detachWebServicePolicies
('/base_domain/server1/HelloWorld#1_0','j2wbasicPolicy','web',
'{http://namespace/}WssUsernameService','JRFWssUsernamePort',
["oracle/log_policy","oracle/wss_username_token_service_policy"])

12cリリース:

wls:/wls-domain/serverConfig>detachWSMPolicies(["oracle/log_policy","oracle/wss_username_token_service_policy"])

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・ポートから複数のOWSMポリシーをデタッチします。

wsm-pmアプリケーションがインストールされていないか使用可能でない場合は、このコマンドは実行されません。

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。

構文

detachWebServicePolicies(application, moduleOrCompName, moduleType, serviceName,
subjectName, policyURIs,[subjectType=None])

引数

定義

application

Webサービス・ポリシーをデタッチするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのポートからポリシーをデタッチするには、この引数は必須です。

moduleOrCompName

Webサービス・ポリシーをデタッチするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのポートからポリシーをデタッチするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

注意: webモジュール・タイプはこのリリースでは非推奨です。

serviceName

アプリケーションまたはSOAコンポジット内のWebサービスの名前。たとえば、{http://namespace/}serviceNameです。SOAコンポジットにはネームスペース({http://namespace/})を含めないでください。

subjectName

ポリシー・サブジェクト、ポートまたは操作の名前。

policyURIs

OWSMポリシー名のURIのリストで、たとえば、["oracle/log_policy","oracle/wss_username_token_service_policy"]です。

指定するpolicyURIがアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

subjectType

省略可能。ポリシー・サブジェクト・タイプ。有効なオプションは次のとおりです。

- P - ポート。デフォルトはPです。

- O - このリリースではサポートされていません。

例

次の例では、Java EE WebモジュールhelloWorldJaxwsのポートhelloWorldJaxwsSoapHttpPortからポリシー"oracle/binding_authorization_denyall_policy", "oracle/wss_username_token_service_policy"をデタッチします。Webサービスは、ドメインwls-domain内のサーバーAdminServerのアプリケーションhelloWorldJaxwsの一部です。

wls:/wls-domain/serverConfig>detachWebServicePolicies ('/wls-domain/AdminServer/helloWorldJaxws','helloWorldJaxws#1!helloWorldJaxws', 'wls','helloWorldJaxws', 'helloWorldJaxwsSoapHttpPort', ["oracle/binding_authorization_denyall_policy", "oracle/wss_username_token_service_policy"])

3.7.10 detachWebServicePolicy

注意:

このコマンドは、Java EE Webサービス(またはクライアント)のみに使用します。Oracle Infrastructure Webサービスでは非推奨になりました。

Oracle Infrastructure Webサービスでは、「detachWSMPolicy」に記載されているとおり、detachWSMPolicyコマンドを使用することをお薦めします。次の例に、detachWSMPolicyコマンドを使用するための移行方法を示します。

11gリリース:

wls:/wls-domain/serverConfig>detachWebServicePolicy('/base_domain/server1/HelloWorld#1_0','j2wbasicPolicy','web','{http://namespace/}WssUsernameService','JRFWssUsernamePort','oracle/wss_username_token_service_policy')

12cリリース:

wls:/wls-domain/serverConfig>detachWSMPolicy('oracle/wss_username_token_service_policy')

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・ポートからOWSMポリシーをデタッチします。

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。

構文

detachWebServicePolicy(application, moduleOrCompName, moduleType, serviceName,
subjectName, policyURI, [subjectType=None])

引数

定義

application

Webサービス・ポリシーをデタッチするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのポートからポリシーをデタッチするには、この引数は必須です。

moduleOrCompName

Webサービス・ポリシーをデタッチするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのポートからポリシーをデタッチするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

注意: webモジュール・タイプはこのリリースでは非推奨です。

serviceName

アプリケーションまたはSOAコンポジット内のWebサービスの名前。たとえば、{http://namespace/}serviceNameです。SOAコンポジットにはネームスペース({http://namespace/})を含めないでください。

subjectName

ポリシー・サブジェクト、ポートまたは操作の名前。

policyURI

OWSMポリシー名のURIで、たとえば、'oracle/log_policy'です。

指定するポリシーがアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

subjectType

省略可能。ポリシー・サブジェクト・タイプ。有効なオプションは次のとおりです。

- P - ポート。デフォルトはPです。

- O - このリリースではサポートされていません。

例

次の例では、ポリシーoracle/log_policyを、SOAコンポジットdefault/HelloWorld[1.0]のサービスHelloServiceのポートHelloWorld_ptからデタッチします。SOAコンポジットにはネームスペース({http://namespace/})を含めないでください。

wls:/wls-domain/serverConfig>detachWebServicePolicy(None, 'default/HelloWorld[1.0]', 'soa','HelloService','HelloWorld_pt','oracle/log_policy')

次の例では、Java EE Webサービスwls-domain/AdminServer/helloWorldJaxwsのサービスhelloWorldJaxwsのポートhelloWorldJaxwsSoapHttpPortからポリシーoracle/wss_username_token_service_policyをデタッチします。

wls:/wls-domain/serverConfig>detachWebServicePolicy
('/wls-domain/AdminServer/helloWorldJaxws','helloWorldJaxws#1!helloWorldJaxws', 'wls','helloWorldJaxws', 'helloWorldJaxwsSoapHttpPort', 'oracle/wss_username_token_service_policy')

3.7.11 detachWSMPolicies

注意:

このコマンドは、Oracle InfrastructureおよびRESTful Webサービスに適用されます。このリリースのJava EE Webサービスには適用されません。

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

セッション内で、URIまたは索引値の配列で特定される複数のポリシーを、選択されているポリシー・サブジェクトからデタッチします。

コマンドを開始する前に、セッションを開始してポリシー・セット(selectWSMPolicySet)またはポリシー・サブジェクト(selectWSMPolicySubject)を選択する必要があります。現在のセッションがなく、ポリシー・サブジェクトが選択されていない場合は、エラーが表示されます。

構文

detachWSMPolicies(uris)

引数

定義

uris

ポリシー・サブジェクトからデタッチするポリシーを指定するURIまたは索引値の配列。たとえば、["oracle/log_policy","oracle/wss_username_token_service_policy"]です。

指定したポリシーのURIがアタッチされていない場合は、エラーメッセージが表示されるか例外がスローされます(あるいはその両方)。

例

次の例では、OWSMロギング・ポリシーおよびユーザー名トークン・サービス・ポリシーを現在のポリシー・サブジェクトからデタッチします。

wls:/wls-domain/serverConfig>detachWSMPolicies(["oracle/log_policy","oracle/wss_username_token_service_policy"])

次の例では、OWSMロギング・ポリシーの索引値およびユーザー名トークン・サービスURIを使用して、現在のポリシー・サブジェクトからそれらをデタッチします。

wls:/wls-domain/serverConfig>detachWSMPolicies('1','3')

3.7.12 detachWSMPolicy

注意:

このコマンドは、Oracle InfrastructureおよびRESTful Webサービスに適用されます。このリリースのJava EE Webサービスには適用されません。

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

セッション内で、指定したURIまたは索引値で特定されるポリシーを、選択されているポリシー・サブジェクトからデタッチします。

コマンドを開始する前に、セッションを開始してポリシー・セット(selectWSMPolicySet)またはポリシー・サブジェクト(selectWSMPolicySubject)を選択する必要があります。現在のセッションがなく、ポリシー・サブジェクトが選択されていない場合は、エラーが表示されます。

作成中または変更中のポリシー・サブジェクトが含まれるセッション外でこのコマンドを発行するとエラーになります。

構文

detachWSMPolicy(uri)

引数

定義

uri

ポリシー・サブジェクトからデタッチするポリシーを指定するURIまたは索引値。たとえば、'oracle/log_policy'です。

指定したポリシーのURIがアタッチされていない場合は、エラーメッセージが表示されるか例外がスローされます(あるいはその両方)。

例

次の例では、OWSMロギング・ポリシーを現在のポリシー・サブジェクトからデタッチします。

wls:/wls-domain/serverConfig>detachWSMPolicy('oracle/log_policy')

次の例では、OWSMロギング・ポリシーのURIの索引値を使用して、現在のポリシー・サブジェクトからデタッチします。

wls:/wls-domain/serverConfig>detachWSMPolicy('1')

3.7.13 enableWebServiceClientPolicies

注意:

このコマンドは、Java EE Webサービス(またはクライアント)のみに使用します。Oracle Infrastructure Webサービスでは非推奨になりました。

Oracle Infrastructure Webサービスでは、「enableWSMPolicies」に記載されているとおり、enableWSMPoliciesコマンドを使用することをお薦めします。次の例に、enableWSMPoliciesコマンドを使用するための移行方法を示します。

11gリリース:

wls:/wls-domain/serverConfig>enableWebServiceClientPolicies
('/base_domain/server1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort',
["oracle/log_policy", "oracle/wss_username_token_client_policy"], true )

12cリリース:

wls:/wls-domain/serverConfig>enableWSMPolicies(["oracle/log_policy", "oracle/wss_username_token_client_policy"], true )

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートの複数のポリシーを有効または無効にします。

注意:

このWLSTコマンドを使用して行われたポリシー変更は、アプリケーションの再起動後にのみ有効になります。

構文

enableWebServiceClientPolicies(application,moduleOrCompName,moduleType,
serviceRefName,portInfoName,policyURIs,[enable],[subjectType=None] )

引数

定義

application

Webサービスのクライアント・ポートの複数のポリシーを有効化または無効化するアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのクライアント・ポートの複数のポリシーを有効化または無効化するには、この引数は必須です。

moduleOrCompName

クライアント・ポートの複数のポリシーを有効または無効にするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのクライアント・ポートの複数のポリシーを有効または無効にするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

- wsconn—ADF DC Webサービス・クライアント、ADF JAX-WS Indirection Proxy、WebCenterクライアントなどの接続ベースのWebサービス・クライアントとともに使用します。

注意: webおよびwsconnモジュール・タイプはこのリリースでは非推奨です。

serviceRefName

アプリケーションまたはコンポジットのサービス参照名。

portInfoName

OWSMクライアント・ポリシーをアタッチするクライアント・ポートの名前。

policyURIs

OWSMポリシー名のURIのリストで、たとえば、["oracle/log_policy","oracle/wss_username_token_client_policy"]です。

enable

省略可能。ポリシーを有効化するのか無効化するのかを指定します。有効なオプションは次のとおりです。

- true - ポリシーを有効化します。デフォルトはtrueです。

- false - ポリシーを無効化します。

この引数を省略した場合、ポリシーが有効化されます。

subjectType

省略可能。ポリシー・サブジェクト・タイプ。有効なオプションは次のとおりです。

- P - ポート。デフォルトはPです。

- O - このリリースではサポートされていません。

例

次の例では、Java EE Webサービス・モジュールowsm_mbean.resouce_pattern.web.ClientJWS/sei2のポートUpperCaseImplPortのクライアント・ポリシーoracle/wss10_saml20_token_client_policyおよびoracle/wss11_message_protection_client_policyを有効化します。

wls:/wls-domain/serverConfig>enableWebServiceClientPolicies('/wls-domain/AdminServer/ClientJWS','owsm_mbean.resouce_pattern.web.ClientJWS/sei2','wls','owsm_mbean.resouce_pattern.web.ClientJWS/sei2','UpperCaseImplPort',["oracle/wss10_saml20_token_client_policy","oracle/wss11_message_protection_client_policy"], true)

3.7.14 enableWebServiceClientPolicy

注意:

このコマンドは、Java EE Webサービス(またはクライアント)のみに使用します。Oracle Infrastructure Webサービスでは非推奨になりました。

Oracle Infrastructure Webサービスでは、「enableWSMPolicy」に記載されているとおり、enableWSMPolicyコマンドを使用することをお薦めします。次の例に、enableWSMPolicyコマンドを使用するための移行方法を示します。

11gリリース:

wls:/wls-domain/serverConfig>enableWebServiceClientPolicy
('/base_domain/server1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort', "oracle/wss_username_token_client_policy",true)

12cリリース:

wls:/wls-domain/serverConfig>enableWSMPolicy("oracle/wss_username_token_client_policy",true)

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートのポリシーを有効または無効にします。

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。

構文

enableWebServiceClientPolicy(application,moduleOrCompName,moduleType,
serviceRefName,portInfoName,policyURI,[enable],[subjectType=None] )

引数

定義

application

Webサービスのクライアント・ポートのポリシーを有効化または無効化するアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのクライアント・ポートのポリシーを有効化または無効化するには、この引数は必須です。

moduleOrCompName

クライアント・ポートのポリシーを有効または無効にするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのクライアント・ポートのポリシーを有効または無効にするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

- wsconn—ADF DC Webサービス・クライアント、ADF JAX-WS Indirection Proxy、WebCenterクライアントなどの接続ベースのWebサービス・クライアントとともに使用します。

注意: webおよびwsconnモジュール・タイプはこのリリースでは非推奨です。

serviceRefName

アプリケーションまたはコンポジットのサービス参照名。

portInfoName

OWSMクライアント・ポリシーをアタッチするクライアント・ポートの名前。

policyURI

OWSMポリシー名のURIで、たとえば、oracle/wss_username_token_client_policy"です。

enable

省略可能。ポリシーを有効化するのか無効化するのかを指定します。有効なオプションは次のとおりです。

- true - ポリシーを有効化します。デフォルトはtrueです。

- false - ポリシーを無効化します。

この引数を省略した場合、ポリシーが有効化されます。

subjectType

省略可能。ポリシー・サブジェクト・タイプ。有効なオプションは次のとおりです。

- P - ポート。デフォルトはPです。

- O - このリリースではサポートされていません。

例

次の例では、SOAコンポジットdefault/HelloWorld[1.0]のクライアント・ポートHelloWorld_ptのクライアント・ポリシーoracle/log_policyを有効化します。

wls:/wls-domain/serverConfig>enableWebServiceClientPolicy(None,
'default/HelloWorld[1.0]','soa','client','HelloWorld_pt','oracle/log_policy')

次の例では、SOAコンポジットdefault/HelloWorld[1.0]のクライアント・ポートHelloWorld_ptのクライアント・ポリシーoracle/log_policyを無効化します。

wls:/wls-domain/serverConfig>enableWebServiceClientPolicy(None,
'default/HelloWorld[1.0]','soa','client','HelloWorld_pt','oracle/log_policy', false )

次の例では、Java EE Webモジュールowsm_mbean.resouce_pattern.web.ClientJWS/sei2のクライアント・ポートUpperCaseImplPortのクライアント・ポリシーoracle/wss_username_token_client_policyを無効化します。

wls:/wls-domain/serverConfig>enableWebServiceClientPolicy('/wls-domain/AdminServer/ClientJWS', 'owsm_mbean.resouce_pattern.web.ClientJWS/sei2', 'wls', 'owsm_mbean.resouce_pattern.web.ClientJWS/sei2', 'UpperCaseImplPort', "oracle/wss_username_token_client_policy", false)

3.7.15 enableWebServicePolicies

注意:

このコマンドは、Java EE Webサービス(またはクライアント)のみに使用します。Oracle Infrastructure Webサービスでは非推奨になりました。

Oracle Infrastructure Webサービスでは、「enableWSMPolicies」に記載されているとおり、enableWSMPoliciesコマンドを使用することをお薦めします。次の例に、enableWSMPoliciesコマンドを使用するための移行方法を示します。

11gリリース:

wls:/wls-domain/serverConfig> enableWebServicePolicies
('/base_domain/server1/HelloWorld#1_0','j2wbasicPolicy','web',
'{http://namespace/}WssUsernameService','JRFWssUsernamePort',["oracle/log_policy", "oracle/wss_username_token_service_policy"],true)

12cリリース:

wls:/wls-domain/serverConfig> enableWSMPolicies(["oracle/log_policy","oracle/wss_username_token_service_policy"],true)

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

Webサービス・アプリケーションまたはSOAコンポジットのポートにアタッチされている複数のポリシーを有効または無効にします。

このコマンドで指定したpolicyURIsがポートにアタッチされていない場合は、エラーメッセージが表示されるか例外がスローされます(あるいはその両方)。

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。

構文

enableWebServicePolicies(application, moduleOrCompName, moduleType, serviceName,
subjectName, policyURIs,[enable],[subjectType=None] ))

引数

定義

application

Webサービス・ポリシーを有効化するアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのポートにアタッチされているポリシーを有効化するには、この引数は必須です。

moduleOrCompName

Webサービス・ポリシーを有効にするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのポートにアタッチされているポリシーを有効にするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

注意: webモジュール・タイプはこのリリースでは非推奨です。

serviceName

アプリケーションまたはSOAコンポジットのWebサービスの名前。たとえば、{http://namespace/}serviceNameです。SOAコンポジットにはネームスペース({http://namespace/})を含めないでください。

subjectName

ポリシー・サブジェクト、ポートまたは操作の名前。

policyURIs

OWSMポリシー名のURIのリストで、たとえば、["oracle/log_policy","oracle/wss_username_token_service_policy"]です。

指定したpolicyURIsがアタッチされていない場合は、エラーメッセージが表示されるか例外がスローされます(あるいはその両方)。

enable

省略可能。ポリシーを有効化するのか無効化するのかを指定します。有効なオプションは次のとおりです。

- true - ポリシーを有効化します。デフォルトはtrueです。

- false - ポリシーを無効化します。

この引数を省略した場合、ポリシーが有効化されます。

subjectType

省略可能。ポリシー・サブジェクト・タイプ。有効なオプションは次のとおりです。

- P - ポート。デフォルトはPです。

- O - このリリースではサポートされていません。

例

次の例では、WebモジュールhelloWorldJaxws#1!helloWorldJaxwsのポートhelloWorldJaxwsSoapHttpPortにアタッチされているポリシー"oracle/binding_authorization_denyall_policy", "oracle/wss_username_token_service_policy"を無効化します。Webサービスは、ドメインwls-domain内のサーバーAdminServerのアプリケーションhelloWorldJaxwsの一部です。

wls:/wls-domain/serverConfig>enableWebServicePolicies ('/wls-domain/AdminServer/helloWorldJaxws','helloWorldJaxws#1!helloWorldJaxws', 'wls','helloWorldJaxws', 'helloWorldJaxwsSoapHttpPort', ["oracle/binding_authorization_denyall_policy", "oracle/wss_username_token_service_policy"], false)

3.7.16 enableWebServicePolicy

注意:

このコマンドは、Java EE Webサービス(またはクライアント)のみに使用します。Oracle Infrastructure Webサービスでは非推奨になりました。

Oracle Infrastructure Webサービスでは、「enableWSMPolicy」に記載されているとおり、enableWSMPolicyコマンドを使用することをお薦めします。次の例に、enableWSMPolicyコマンドを使用するための移行方法を示します。

11gリリース:

wls:/wls-domain/serverConfig>enableWebServicePolicy
('/base_domain/server1/HelloWorld#1_0','j2wbasicPolicy','web',
'{http://namespace/}WssUsernameService','JRFWssUsernamePort',"oracle/wss_username_token_service_policy",true)

12cリリース:

wls:/wls-domain/serverConfig>enableWSMPolicy("oracle/wss_username_token_service_policy",true)

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

Webサービス・アプリケーションまたはSOAコンポジットのポートにアタッチされているポリシーを有効化または無効化します。

このコマンドで指定するポリシーがポートにアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。

構文

enableWebServicePolicy(application, moduleOrCompName, moduleType, serviceName,
subjectName, policyURI, [enable], [subjectType=None] ))

引数

定義

application

Webサービス・ポリシーを有効化するアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのポートにアタッチされているポリシーを有効化するには、この引数は必須です。

moduleOrCompName

Webサービス・ポリシーを有効にするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのポートにアタッチされているポリシーを有効にするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

注意: webモジュール・タイプはこのリリースでは非推奨です。

serviceName

アプリケーションまたはSOAコンポジット内のWebサービスの名前。たとえば、{http://namespace/}serviceNameです。SOAコンポジットにはネームスペース({http://namespace/})を含めないでください。

subjectName

ポリシー・サブジェクト、ポートまたは操作の名前。

policyURI

OWSMポリシー名のURIで、たとえば、'oracle/log_policy'です。

指定するポリシーがアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

enable

省略可能。ポリシーを有効化するのか無効化するのかを指定します。有効なオプションは次のとおりです。

- true - ポリシーを有効化します。デフォルトはtrueです。

- false - ポリシーを無効化します。

この引数を省略した場合、ポリシーが有効化されます。

subjectType

省略可能。ポリシー・サブジェクト・タイプ。有効なオプションは次のとおりです。

- P - ポート。デフォルトはPです。

- O - このリリースではサポートされていません。

例

次の例では、SOAコンポジットdefault/HelloWorld[1.0]のサービスHelloServiceのポートHelloWorld_ptにアタッチされているポリシーoracle/log_policyを有効化します。SOAコンポジットにはネームスペース({http://namespace/})を含めないでください。

wls:/wls-domain/serverConfig>enableWebServicePolicy(None, 'default/HelloWorld[1.0]', 'soa','HelloService','HelloWorld_pt','oracle/log_policy')

次の例では、SOAコンポジットdefault/HelloWorld[1.0]のサービスHelloServiceのポートHelloWorld_ptにアタッチされているポリシーoracle/log_policyを無効化します。SOAコンポジットにはネームスペース({http://namespace/})を含めないでください。

wls:/wls-domain/serverConfig>enableWebServicePolicy(None, 'default/HelloWorld[1.0]', 'soa','HelloService','HelloWorld_pt','oracle/log_policy',false)

次の例では、Java EE Webサービスwls-domain/AdminServer/helloWorldJaxwsのサービスhelloWorldJaxwsのポートhelloWorldJaxwsSoapHttpPortにアタッチされているポリシーoracle/wss_username_token_service_policyを無効化します。

wls:/wls-domain/domainRuntime> enableWebServicePolicy ('/wls-domain/AdminServer/helloWorldJaxws','helloWorldJaxws#1!helloWorldJaxws', 'wls','helloWorldJaxws', 'helloWorldJaxwsSoapHttpPort', 'oracle/wss_username_token_service_policy', false)

3.7.17 enableWSMPolicies

注意:

このコマンドは、Oracle InfrastructureおよびRESTful Webサービスに適用されます。このリリースのJava EE Webサービスには適用されません。

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

セッション内で、指定したURIで特定され、ポリシー・サブジェクトにアタッチされている複数のポリシー・アタッチメントを有効化または無効化します。

コマンドを開始する前に、セッションを開始してポリシー・セット(selectWSMPolicySet)またはポリシー・サブジェクト(selectWSMPolicySubject)を選択する必要があります。ただし、ポリシー・セットの作成またはクローニング時にenableWSMPoliciesが発行されている場合は、すでに選択されているためポリシー・セットを選択する必要はありません。

オプションのenable引数が指定されていない場合、このコマンドによってポリシー・アタッチメントがデフォルトで有効化されます。このコマンドで指定したポリシーのURIがポートにアタッチされていない場合は、エラーメッセージが表示されるか例外がスローされます(あるいはその両方)。

構文

enableWSMPolicies(uris,[enable=true]))

引数

定義

uris

OWSMポリシー名のURIのリストで、たとえば、["oracle/log_policy","oracle/wss_username_token_service_policy"]です。

指定したpolicyURIsがアタッチされていない場合は、エラーメッセージが表示されるか例外がスローされます(あるいはその両方)。

enable

省略可能。ポリシー・アタッチメントを有効化するか無効化するかを指定します。有効なオプションは次のとおりです。

- true—指定したポリシー・アタッチメントを有効化します。デフォルトはtrueです。

- false—指定したポリシー・アタッチメントを無効化します。

この引数を省略した場合、ポリシーが有効化されます。

例

次の例では、WebモジュールWssUsernameServiceのポートJRFWssUsernamePortにアタッチされているポリシー["oracle/log_policy","oracle/wss_username_token_service_policy"]を有効化します。Webサービスは、ドメインbase_domain内のサーバーserver1のアプリケーションHelloWorld#1_0の一部です。

wls:/wls-domain/serverConfig>enableWSMPolicies(["oracle/log_policy","oracle/wss_username_token_service_policy"],true)

3.7.18 enableWSMPolicy

注意:

このコマンドは、Oracle InfrastructureおよびRESTful Webサービスに適用されます。このリリースのJava EE Webサービスには適用されません。

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

セッション内で、指定したURIで特定され、ポリシー・サブジェクトにアタッチされているポリシー・アタッチメントを有効化または無効化します。

コマンドを開始する前に、セッションを開始してポリシー・セット(selectWSMPolicySet)またはポリシー・サブジェクト(selectWSMPolicySubject)を選択する必要があります。ただし、ポリシー・セットの作成またはクローニング時にenableWSMPolicyが発行されている場合は、すでに選択されているためポリシー・セットを選択する必要はありません。

オプションのenable引数が指定されていない場合、このコマンドによってポリシー・アタッチメントがデフォルトで有効化されます。このコマンドで指定したpolicyURIがポートにアタッチされていない場合は、エラーメッセージが表示されるか例外がスローされます(あるいはその両方)。

構文

enableWSMPolicy(uri,[enable=true])

引数

定義

uri

ポリシー・セット内のポリシー・アタッチメントを指定するURI。

enable

省略可能。ポリシー・セット内のURIで指定されるポリシー・アタッチメントを有効化するか無効化するかを指定します。有効なオプションは次のとおりです。

- true - ポリシー・セット内の指定したポリシー・アタッチメントを有効化します。デフォルトはtrueです。

- false - ポリシー・セット内の指定したポリシー・アタッチメントを無効化します。

この引数を省略した場合、ポリシー・セット・アタッチメントが有効になります。

例

次の例では、WebモジュールWssUsernameServiceのポートJRFWssUsernamePortにアタッチされているポリシーoracle/wss_username_token_service_policyを有効化します。Webサービスは、ドメインbase_domain内のサーバーserver1のアプリケーションHelloWorld#1_0の一部です。

wls:/wls-domain/serverConfig>enableWSMPolicy("oracle/wss_username_token_service_policy",true)

次の例では、SOAコンポジットdefault/HelloWorld[1.0]のサービスHelloServiceのポートHelloWorld_ptにアタッチされているポリシーoracle/log_policyを有効化します。

wls:/wls-domain/serverConfig>enableWSMPolicy('oracle/log_policy')

次の例では、SOAコンポジットdefault/HelloWorld[1.0]のサービスHelloServiceのポートHelloWorld_ptにアタッチされているポリシーoracle/log_policyを無効化します。

wls:/wls-domain/serverConfig>enableWSMPolicy('oracle/log_policy',false)

3.7.19 listAvailableWebServicePolicies

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

使用可能なすべてのOWSMポリシーのリストをカテゴリまたはサブジェクト・タイプごとに表示します。

構文

listAvailableWebServicePolicies([category],[subject])

引数

定義

category

省略可能。ポリシー・カテゴリで、たとえば、'security'、'management'です。

subject

省略可能。ポリシー・サブジェクト・タイプで、たとえば、'server'または'client'です。

例

次の例では、ドメイン内の使用可能なすべてのOWSMサーバー・セキュリティ・ポリシーをリストします。

wls:/wls-domain/serverConfig>listAvailableWebServicePolicies('security','server')

3.7.20 listWebServiceClientPolicies

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・クライアント・ポートのポリシー情報をリストします。

出力には、Webサービス・クライアントまたは参照ポート名、それにアタッチされているOWSMポリシーおよびポリシー・カテゴリ、ステータス、ポリシー・アタッチメントのソース、すべてのポリシー・オーバーライド・プロパティ(該当する場合)、ポリシーがサブジェクトに対して有効かどうかなどの各アタッチメントの詳細が表示されます。また、ポリシー・サブジェクトがセキュアかどうかも表示されます。次に例を示します。

test-port:
URI=oracle/wss_username_token_client_policy, category=security, policy-status=enabled
source=local policy set; reference-status=enabled; effective=true
The policy subject is secure in this context.

構文

listWebServiceClientPolicies(application, moduleOrCompName, moduleType,
serviceRefName,portInfoName)

引数

定義

application

Webサービス・クライアント・ポートのポリシー情報をリストするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのクライアント・ポートのポリシー情報をリストするには、この引数は必須です。

moduleOrCompName

Webサービス・ポートのポリシー情報をリストするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのクライアント・ポートのポリシー情報をリストするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

- wsconn—ADF DC Webサービス・クライアント、ADF JAX-WS Indirection Proxy、WebCenterクライアントなどの接続ベースのWebサービス・クライアントとともに使用します。

serviceRefName

アプリケーションまたはコンポジットのサービス参照名。

portInfoName

クライアント・ポート名。

例

次の例では、ドメインbase_domain内のサーバーserver1のアプリケーションjwsclient_1#1.1.0のWebサービス・クライアント・ポートのポリシー情報をリストします。この例では、Webモジュール名はWssUsernameClientであり、モジュール・タイプはwsconnであり、サービス参照名はWssUsernameClientであり、クライアント・ポート名はJRFWssUsernamePortです。

wls:/wls-domain/serverConfig>listWebServiceClientPolicies
('/base_domain/server1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort')

3.7.21 listWebServicePolicies

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジットのWebサービス・ポートのWebサービス・ポリシー情報をリストします。

出力には、Webサービス・ポート名、それにアタッチされているOWSMポリシーおよびポリシー・カテゴリ、ステータス、ポリシー・アタッチメントのソース、すべてのポリシー・オーバーライド・プロパティ(該当する場合)、ポリシーがサブジェクトに対して有効かどうかなどの各アタッチメントの詳細が表示されます。また、ポリシー・サブジェクトがセキュアかどうかも表示されます。次に例を示します。

CalculatorPort:
URI="oracle/wss_username_token_service_policy", category=security, policy-status=enabled;
source=local policy set; reference-status=enabled; effective=true
The policy subject is secure in this context.

構文

listWebServicePolicies(application,moduleOrCompName,moduleType,serviceName,subjectName)

引数

定義

application

Webサービス・ポートのポリシー情報をリストするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのポートのポリシー情報をリストするには、この引数は必須です。

moduleOrCompName

Webサービス・ポートのポリシー情報をリストするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットのポート・ポリシー情報をリストするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは次のとおりです。

- soa—SOAコンポジット。

- web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)。

- wls—Java EE Webサービス。

serviceName

ポート・ポリシー情報をリストするアプリケーションまたはSOAコンポジットのWebサービス名。たとえば、{http://namespace/}serviceNameです。SOAコンポジットにはネームスペース({http://namespace/})を含めないでください。

subjectName

ポリシー・サブジェクト、ポートまたは操作名。

例

次の例では、アプリケーションjaxwsejb30ws内のポートCalculatorPortのWebサービスのポリシー情報をリストします。この例で、Webモジュール名はjaxwsejb、およびサービス名はCalculatorServiceです。

wls:/wls-domain/serverConfig>listWebServicePolicies ('/base_domain/AdminServer/jaxwsejb30ws','jaxwsejb','web', '{http://namespace/}CalculatorService', 'CalculatorPort')

次の例では、SOAコンポジットdefault/HelloWorld[1.0]のポート・ポリシー情報を一覧表示します。moduleTypeがSOAに設定されており、サービス名がHelloServiceであり、サブジェクトがHelloWorld_ptというポートであることに注意してください。SOAコンポジットにはネームスペース({http://namespace/})を含めないでください。

wls:/wls-domain/serverConfig>listWebServicePolicies (None, 'default/HelloWorld[1.0]', 'soa', 'HelloService', 'HelloWorld_pt')

3.7.22 setWebServicePolicyOverride

注意:

このコマンドは、Oracle Infrastructure Webサービスでは非推奨になりました。「setWSMPolicyOverride」に記載されているとおり、setWSMPolicyOverrideコマンドを使用することをお薦めします。

このコマンドは、Java EE Webサービスには適用されません。

次の例に、setWSMPolicyOverrideコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> setWebServicePolicyOverride ('/base_domain/server1/HelloWorld#1_0','j2wbasicPolicy', 'web', '{http://namespace/}WssUsernameService','JRFWssUsernamePort', 'oracle/wss_username_token_service_policy', 'reference.priority', '10')

12cリリース(リポジトリおよびポリシー・サブジェクトの操作)の場合:

wls:/jrfServer_domain/serverConfig> setWSMPolicyOverride ('oracle/wss_username_token_service_policy', 'reference.priority', '10')

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

アプリケーションまたはSOAコンポジット内のWebサービス・ポートのポリシー・オーバーライド・プロパティを構成します。

構文

setWebServicePolicyOverride(application,moduleOrCompName,moduleType, serviceName,
portName,policyURI,properties)

引数

定義

application

Webサービス・ポートのポリシーをオーバーライドするアプリケーションの名前およびパス。たとえば、/domain/server/application#version_numberです。

Webサービス・アプリケーションのポートにアタッチされているポリシー上のプロパティをオーバーライドするには、この引数は必須です。

moduleOrCompName

Webサービス・ポート・ポリシーをオーバーライドするWebモジュールまたはSOAコンポジットの名前(HelloWorld[1.0]など)。

SOAコンポジットにアタッチされたポリシーのプロパティをオーバーライドするには、コンポジット名(default/HelloWorld[1.0]など)が必須であり、またmoduleType引数をsoaに設定する必要があります。

moduleType

モジュール・タイプ。有効なオプションは、web—Webモジュールとしてパッケージ化されたOracle Infrastructure Webサービス(EJBを含む)です。

注意: モジュール・タイプwlsはサポートされていません。

serviceName

アプリケーションまたはSOAコンポジット内のWebサービスの名前。たとえば、{http://namespace/}serviceNameです。SOAコンポジットにはネームスペース({http://namespace/})を含めないでください。

subjectName

ポリシー・サブジェクト、ポートまたは操作の名前。

policyURI

OWSMポリシー名のURIで、たとえば、オーバーライド・プロパティが適用される'oracle/log_policy'です。

指定するポリシーがアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

properties

ポリシー・オーバーライド・プロパティ。次の形式を使用してプロパティを指定する必要があります。

[("name","value")]

例: [("myprop","myval")]

この引数をNoneに設定すると、すべてのポリシー・オーバーライドが削除されます。

例

次の例では、WebモジュールWssUsernameServiceのポートJRFWssUsernamePortのポリシーoracle/wss10_message_protection_service_policyのオーバーライド・プロパティを構成します。Webサービスは、ドメインbase_domain内のサーバーserver1のアプリケーションHelloWorld#1_0の一部です。

wls:/wls-domain/serverConfig>setWebServicePolicyOverride ('/base_domain/server1/HelloWorld#1_0','j2wbasicPolicy', 'web', '{http://namespace/}WssUsernameService','JRFWssUsernamePort', "oracle/wss10_message_protection_service_policy", [("keystore.sig.csf.key","sigkey")])

3.7.23 setWSMPolicyOverride

注意:

直接ポリシー・アタッチメントの場合、このコマンドはOracle InfrastructureおよびRESTful Webサービスにのみ適用されます。ポリシー・セット内のポリシー参照での構成オーバーライドの場合、このコマンドはJava EE Webサービスにも適用されます。ポリシー・セットでの構成オーバーライドの詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のWLSTを使用したグローバルにアタッチされたポリシーの構成プロパティのオーバーライドに関する項を参照してください。

local.policy.reference.sourceプロパティは直接ポリシー・アタッチメントのソースを識別するための情報提供のみを目的としており、オーバーライドできません。詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のポリシー・アタッチメントのソースの特定に関する項を参照してください。

コマンド・カテゴリ: ポリシー管理

WLSTでの使用: オンライン

説明

セッション内で、nameとvalueのペアで記述される構成オーバーライドを、指定したURIで特定され、ポリシー・セット・ドキュメントまたはポリシー・サブジェクトにアタッチされているポリシーに追加します。value引数はオプションです。value引数を省略した場合、name引数で指定されたプロパティがポリシー・サブジェクトから削除されます。name引数で指定されたプロパティがすでに存在していて、value引数が指定されている場合は、現在の値が新しい値で上書きされます。

コマンドを開始する前に、セッションを開始してポリシー・セット(selectWSMPolicySet)またはポリシー・サブジェクト(selectWSMPolicySubject)を選択する必要があります。現在のセッションがなく、ポリシー・サブジェクトが選択されていない場合は、エラーが表示されます。

構文

setWSMPolicyOverride(uri, name, value)

引数

説明

uri

ポリシーURIを表す文字列。たとえば、オーバーライド・プロパティが適用される'oracle/wss10_saml_token_service_policy'です。

name

オーバーライド・プロパティの名前を表す文字列。例: ['reference.priority']

value

省略可能。プロパティの値を表す文字列。この引数を指定しない場合、name引数で指定されているプロパティがあると、それが削除されます。

例

次の例では、oracle/wss10_saml_token_service_policyのreference.priorityプロパティの構成オーバーライドを1の値に指定します。

wls:/wls-domain/serverConfig> setWSMPolicyOverride('oracle/wss10_saml_token_service_policy', 'reference.priority','1')

次の例では、ポリシー・セットのoracle/wss10_saml_token_service_policyからプロパティreference.priorityを削除します。

wls:/wls-domain/serverConfig> setWSMPolicyOverride('oracle/wss10_saml_token_service_policy', 'reference.priority')

3.8 ポリシー・セット管理のコマンド

ポリシー・セットは、1つ以上のポリシーをサブジェクト・タイプにグローバルにアタッチするメカニズムを提供することで、エンタープライズのセキュリティおよび管理性を向上します。ポリシー・セットを使用すると、管理者は、何も直接アタッチすることなく、強制するポリシーのデフォルト・セットを指定できます。ポリシー・セットをアタッチできるリソースのタイプおよびスコープの決定の詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のグローバルにアタッチされたポリシーのリソースのタイプおよびスコープの決定に関する項を参照してください。

ポリシー・セットの作成、変更または削除コマンドはすべて、セッションのコンテキストで実行する必要があります。セッションは、単一のポリシー・セットに対してのみ操作できます。

注意:

この項で説明するWLSTコマンドのヘルプを表示するには、実行中のサーバー・インスタンスに接続し、help('wsmManage')と入力します。

表3-9にリストされているポリシー・セットの管理コマンドは、このリリースでOracle Infrastructure Webサービスについては非推奨になりました。

Oracle Infrastructure Webサービスでは、リリース12cのOWSMポリシー・セットを管理するには、表3-8にリストされているWLSTの新しいコマンドを使用することをお薦めします。これらのコマンドは、「セッション・コマンド」の説明に従って、セッション・コマンドを使用してセッションのコンテキスト内で実行する必要があります

非推奨コマンドをすべて示すリストは、『Oracle Fusion Middleware Oracle Fusion Middleware Infrastructureリリース・ノート』の非推奨となったOracle Infrastructure Webサービスのコマンドに関する項を参照してください。

表3-6にリストされているWLSTコマンドを使用して、グローバルで使用可能なポリシー・セットを管理します。

表3-8 Webサービスのグローバル・ポリシー・セット管理WLSTコマンド

使用するコマンド

目的

WLSTでの使用

cloneWSMPolicySet

セッション内で、既存のポリシー・セットから新しいポリシー・セットをクローニングします。

オンライン

createWSMPolicySet

セッション内に、新しい、空のポリシー・セットを作成します。

オンライン

deleteWSMAllPolicySets

すべてまたは選択したポリシー・セットをOWSMリポジトリ内から削除します。

オンライン

deleteWSMPolicySet

セッション内で、指定したポリシー・セットを削除します。

オンライン

displayWSMPolicySet

指定したポリシー・セットの構成を表示します。

オンライン

enableWSMPolicySet

セッション内で、現在のポリシー・セットを有効化または無効化します。

オンライン

listWSMPolicySets

リポジトリ内のポリシー・セットをリストします。このコマンドでは、現在のセッションで作成中、変更中または削除中のポリシー・セットも表示します。

オンライン

selectWSMPolicySet

セッション内で変更するポリシー・セットを指定します。

オンライン

setWSMPolicySetConstraint

セッション内で選択されたポリシー・セットのための実行時制約値を指定します。

オンライン

setWSMPolicySetOverride

ポリシー・セットに対するオーバーライド・プロパティを構成します。

オンライン

setWSMPolicySetDescription

セッション内で選択されたポリシー・セットのための説明を指定します。

オンライン

setWSMPolicySetScope

指定したリソース・スコープにポリシー・セットをアタッチする式を設定します。

オンライン

unregisterWSMResource

セッション内の登録済物理リソースを記述するリソース・インスタンスを登録解除または削除します。

オンライン

validateWSMPolicySet

既存のポリシー・セットを検証します。

オンライン

表3-9に、このリリースで非推奨になったOracle Infrastructure Webサービスのグローバル・ポリシー・セットを管理するためWLSTコマンドをリストします。

表3-9 非推奨のグローバル・ポリシー・セット管理用のWLSTコマンド

使用するコマンド

目的

WLSTでの使用

abortRepositorySession

現在のOWSMリポジトリ変更セッションを中止し、セッション中にリポジトリに対して行われたすべての変更を破棄します。

オンライン

attachPolicySet

指定されたリソース範囲にポリシー・セットをアタッチします。

オンライン

attachPolicySetPolicy

ポリシーのURIを使用してポリシー・セットにポリシーをアタッチします。

オンライン

beginRepositorySession

OWSMリポジトリを変更するセッションを開始します。

オンライン

clonePolicySet

既存のポリシー・セットから新しいポリシー・セットをクローニングします。

オンライン

commitRepositorySession

現在のセッションの内容をOWSMリポジトリに書き込みます。

オンライン

createPolicySet

新しい空のポリシー・セットを作成します。

オンライン

deleteAllPolicySets

すべてまたは選択したポリシー・セットをOWSMリポジトリ内から削除します。

オンライン

deletePolicySet

指定したポリシー・セットを削除します。

オンライン

describeRepositorySession

現在のセッションのコンテンツを記述します。

オンライン

detachPolicySetPolicy

ポリシーのURIを使用してポリシー・セットからポリシーをデタッチします。

オンライン

displayPolicySet

指定したポリシー・セットの構成を表示します。

オンライン

enablePolicySet

ポリシー・セットを有効化または無効化します。

オンライン

enablePolicySetPolicy

ポリシーのURIを使用してポリシー・セットのポリシー・アタッチメントを有効化または無効化します。

オンライン

listPolicySets

リポジトリ内のポリシー・セットを一覧表示します。

オンライン

migrateAttachments

直接ポリシー・アタッチメントをグローバル・ポリシー・アタッチメントに(それらが同一である場合)移行します。

オンライン

modifyPolicySet

現在のセッションで変更する既存のポリシー・セットを指定します。

オンライン

setPolicySetConstraint

セッション内で選択されたポリシー・セットのための実行時制約値を指定します。

オンライン

setPolicySetDescription

セッション内で選択されたポリシー・セットのための説明を指定します。

オンライン

setPolicySetPolicyOverride

現在のポリシー・セットのポリシー参照に構成オーバーライドを追加します。

オンライン

validatePolicySet

リポジトリ内またはセッション内の既存のポリシー・セットを検証します。

オンライン

3.8.1 abortRepositorySession

注意:

このコマンドは非推奨になりました。「abortWSMSession」に記載されているとおり、abortWSMSessionコマンドを使用することをお薦めします。

次の例に、abortWSMSessionコマンドを使用するための移行方法を示します。

11gリリース(リポジトリ操作)の場合:

wls:/jrfServer_domain/serverConfig> abortRepositorySession()

12cリリース(リポジトリ操作とポリシー・サブジェクト操作の両方)の場合:

wls:/jrfServer_domain/serverConfig> abortWSMSession()

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

現在の変更セッションを中止し、セッション中にリポジトリに対して行われたすべての変更を破棄します。

構文

abortRepositorySession()

例

次の例では、現在のOWSMセッションを中止します。

wls:/wls-domain/serverConfig>abortRepositorySession()

3.8.2 attachPolicySet

注意:

このコマンドは非推奨になりました。「setWSMPolicySetScope」に記載されているとおり、setWSMPolicySetScopeコマンドを使用することをお薦めします。

次の例に、setWSMPolicySetScopeコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> attachPolicySet ('Domain("base_domain")')

12cリリース:

wls:/jrfServer_domain/serverConfig> setWSMPolicySetScope ('Domain("base_domain")')

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、指定したリソース・スコープにポリシー・セットをアタッチする式を設定します。この式は、サポートされる形式で有効なリソース・スコープを定義する必要があります。

作成中または変更中のポリシー・セットが含まれるセッション外でこのコマンドを発行するとエラーになります。

構文

attachPolicySet(expression)

引数

定義

expression

指定されたリソース・スコープにポリシー・セットをアタッチする式。

リソース・スコープの式の指定の詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のリソース・スコープの定義に関する項を参照してください。

例

次の例では、指定したbase_domainリソースにポリシー・セットをアタッチします。

wls:/wls-domain/serverConfig>attachPolicySet('Domain("base_domain")')

この例では、指定したbase_domainおよびmanaged_serverリソースにポリシー・セットをアタッチします。

wls:/wls-domain/serverConfig>attachPolicySet('Domain("base_domain") and Server("managed_server")')

3.8.3 attachPolicySetPolicy

注意:

Oracle Infrastructure Webサービスでは、「attachWSMPolicy」に記載されているとおり、attachWSMPolicyコマンドを使用することをお薦めします。次の例に、attachWSMPolicyコマンドを使用するための移行方法を示します。

11gリリース(ポリシー・セットでのリポジトリ操作とポリシー・サブジェクト操作の両方)の場合:

wls:/jrfServer_domain/serverConfig> attachPolicySetPolicy ('oracle/wss_username_token_service_policy')

12cリリース:

wls:/jrfServer_domain/serverConfig> attachWSMPolicy('oracle/wss_username_token_service_policy')

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、指定したURIで特定されるポリシーを、現在のポリシー・セットにアタッチします。

作成中または変更中のポリシー・セットが含まれるセッション外でこのコマンドを発行するとエラーになります。

構文

attachPolicySetPolicy(uri)

引数

定義

uri

現在のポリシー・セットにアタッチするポリシーを指定するURI。たとえば、'oracle/log_policy'です。

例

次の例では、OWSMロギング・ポリシーを現在のポリシー・セットにアタッチします。

wls:/wls-domain/serverConfig>attachPolicySetPolicy('oracle/log_policy')

3.8.4 beginRepositorySession

注意:

このコマンドは非推奨になりました。「beginWSMSession」に記載されているとおり、beginWSMSessionコマンドを使用することをお薦めします。

次の例に、beginWSMSessionコマンドを使用するための移行方法を示します。

11gリリース(リポジトリ操作)の場合:

wls:/jrfServer_domain/serverConfig> beginRepositorySession()

12cリリース(リポジトリ操作とポリシー・サブジェクト操作の両方)の場合:

wls:/jrfServer_domain/serverConfig> beginWSMSession()

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

OWSMリポジトリを変更するためのセッションを開始します。セッションは、ポリシー・セット、Fusion Middleware Webサービス・エンドポイントなどの単一のポリシー・サブジェクトに対してのみ操作できます。すでに現在のセッションがある場合、エラーが表示されます。

構文

beginRepositorySession()

例

次の例では、OWSMリポジトリ変更セッションを開始します。

wls:/wls-domain/serverConfig>beginRepositorySession()

3.8.5 clonePolicySet

注意:

Oracle Infrastructure Webサービスでは、「cloneWSMPolicySet」に記載されているとおり、cloneWSMPolicySetコマンドを使用することをお薦めします。次の例に、cloneWSMPolicySetコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> clonePolicySet ('myNewPolicySet', 'myPolicySet')

12cリリース:

wls:/jrfServer_domain/serverConfig> cloneWSMPolicySet ('myNewPolicySet', 'myPolicySet')

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、既存のポリシー・セットから新しいポリシー・セットをクローニングします。既存のポリシー・セットをクローニングする際には、ソース・ポリシー・セットのすべての値とアタッチメントが新規ポリシー・セットにコピーされます。ただし、リソース・スコープを指定する別の式を指定することもできます。この式は、サポートされる形式で有効なリソース・スコープを定義する必要があります。

セッション外でこのコマンドを発行するとエラーになります。

構文

clonePolicySet(name, source,[attachTo=None],[description=None],[enable='true'])

引数

定義

name

新規ポリシー・セットのクローンの名前。

source

クローニングされるソース・ポリシー・セットの名前。

attachTo=None

省略可能。指定されたリソース・スコープにポリシー・セットをアタッチする式。リソース・スコープの式の指定の詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のリソース・スコープの定義に関する項を参照してください。

この引数をNoneに設定すると、リソース・スコープを指定するためにソース・ポリシー・セットで使用されている式が保持されます。

description=None

省略可能。新規ポリシー・セットの説明。

この引数をNoneに設定すると、ソース・ポリシー・セットで使用されている説明が保持されます。

enable='true'

省略可能。ポリシー・セットを有効にするか無効にするかを指定します。有効なオプションは次のとおりです。

- true - ポリシー・セットを有効にします。デフォルトはtrueです。

- false - ポリシー・セットを無効にします。

この引数を省略した場合、ポリシー・セットが有効になります。

例

最初の例では、既存のmyPolicySetポリシー・セットをクローニングして新しいmynewPolicySetを作成することで、ポリシーセットを作成します。2番目の例でもポリシー・セットを作成しますが、リソース・スコープをドメイン内の指定されたjaxwsejb30wsアプリケーションのポリシー・サブジェクトに絞り込みます。

wls:/wls-domain/serverConfig>clonePolicySet('myNewPolicySet','myPolicySet')
wls:/wls-domain/serverConfig>clonePolicySet('myNewPolicySet','myPolicySet','Application("jaxwsejb30ws")')

3.8.6 cloneWSMPolicySet

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、既存のポリシー・セットから新しいポリシー・セットをクローニングします。既存のポリシー・セットをクローニングする際には、ソース・ポリシー・セットのすべての値とアタッチメントが新規ポリシー・セットにコピーされます。ただし、リソース・スコープを指定する別の式を指定することもできます。この式は、サポートされる形式で有効なリソース・スコープを定義する必要があります。

セッション外でこのコマンドを発行するとエラーになります。

構文

cloneWSMPolicySet(name,source,[scope=None],[description=None],[enable='true'])

引数

定義

name

新規ポリシー・セットのクローンの名前。

source

クローニングされるソース・ポリシー・セットの名前。

scope=None

省略可能。指定されたリソース・スコープにポリシー・セットをアタッチする式。リソース・スコープの式の指定の詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のリソース・スコープの定義に関する項を参照してください。

この引数を指定しない場合、リソース・スコープの識別のためにソース・ポリシー・セットで使用されている式が保持されます。

description=None

省略可能。新規ポリシー・セットの説明。

この引数が指定されない場合、ソース・ポリシー・セットで使用されている説明が保持されます。

enable='true'

省略可能。ポリシー・セットを有効にするか無効にするかを指定します。この引数を省略した場合、ポリシー・セットは有効化されます。有効なオプションは次のとおりです。

- true - ポリシー・セットを有効にします。デフォルトはtrueです。

- false - ポリシー・セットを無効にします。

この引数を省略した場合、ポリシー・セットが有効になります。

例

最初の例では、既存のmyPolicySetポリシー・セットをクローニングして新しいmynewPolicySetを作成することで、ポリシーセットを作成します。2番目の例でもポリシー・セットを作成しますが、リソース・スコープをドメイン内の指定されたjaxwsejb30wsアプリケーションのポリシー・サブジェクトに絞り込みます。

wls:/wls-domain/serverConfig>cloneWSMPolicySet('myNewPolicySet','myPolicySet')
wls:/wls-domain/serverConfig>cloneWSMPolicySet('myNewPolicySet','myPolicySet','Application("jaxwsejb30ws")')

3.8.7 commitRepositorySession

注意:

このコマンドは非推奨になりました。「commitWSMSession」に記載されているとおり、commitWSMSessionコマンドを使用することをお薦めします。

次の例に、commitWSMSessionコマンドを使用するための移行方法を示します。

11gリリース(リポジトリ操作)の場合:

wls:/jrfServer_domain/serverConfig> commitRepositorySession()

12cリリース(リポジトリ操作とポリシー・サブジェクト操作の両方)の場合:

wls:/jrfServer_domain/serverConfig> commitWSMSession()

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

現在のセッションの内容をOWSMリポジトリに書き込みます。何がコミットされたのかを示すメッセージが表示されます。現在のセッションがない場合、エラーが表示されます。

構文

commitRepositorySession()

例

次の例では、現在のリポジトリの変更セッションをコミットします。

wls:/wls-domain/serverConfig>commitRepositorySession()

3.8.8 createPolicySet

注意:

Oracle Infrastructure Webサービスでは、「createWSMPolicySet」に記載されているとおり、createWSMPolicySetコマンドを使用することをお薦めします。次の例に、createWSMPolicySetコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> createPolicySet('myPolicySet', 'ws-service', 'Domain("base_domain")')

12cリリース:

wls:/jrfServer_domain/serverConfig> createWSMPolicySet ('myPolicySet', 'ws-service', 'Domain("base_domain")')

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内に、新しい、空のポリシー・セットを作成します。新規ポリシー・セットを作成する際には、ポリシー・セットの適用先のポリシー・サブジェクトのタイプを指定して、サポートされる形式で有効なリソース・スコープを定義するサポートされる式を指定する必要があります。

セッション外でこのコマンドを発行するとエラーになります。

構文

createPolicySet(name,type,attachTo,[description=None],[enable='true'])

引数

定義

name

新規の空のポリシー・セットの名前。

type

新規ポリシー・セットが適用されるポリシー・サブジェクトのタイプ。ポリシー・サブジェクトのタイプは、『Oracle Fusion Middleware Oracle Web Services Managerの理解』のポリシー・サブジェクトの理解に関する項に記載されているポリシー・サブジェクトのいずれかである必要があります。

attachTo

指定されたリソース・スコープにポリシー・セットをアタッチする式。リソース・スコープの式の指定の詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のリソース・スコープの定義に関する項を参照してください。

description

省略可能。新しいポリシー・セットの説明。説明が指定されない場合、新しいポリシー・セットの説明は、<type>のグローバル・ポリシー・アタッチメントになり、ここで、<type>はサブジェクト・タイプです。

enable

省略可能。新規ポリシー・セットを有効にするか無効にするかを指定します。有効なオプションは次のとおりです。

- true - 新規ポリシー・セットを有効にします。デフォルトはtrueです。

- false - 新規ポリシー・セットを無効にします。

この引数を省略した場合、ポリシー・セットが有効になります。

例

最初の例では、新規ポリシー・セットを作成し、リソース・スコープをbase_domainドメインのws-serviceタイプ(Webサービス・エンドポイント)のみに指定します。2つめの例では、新しいポリシー・セットを作成しますが、リソース・スコープをドメイン内のsoa_server1サーバーのsca-serviceタイプのみ(SOAサービス)に絞ります。

wls:/wls-domain/serverConfig>createPolicySet('myPolicySet','ws-service','Domain("base_domain")')

wls:/wls-domain/serverConfig>createPolicySet('myPolicySet','sca-service','Server("soa_server1")','My policySet')

3.8.9 createWSMPolicySet

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、新しい、空のポリシー・セットを作成します。新しいポリシー・セットを作成する際に、ポリシー・セットが適用されるポリシー・サブジェクトのタイプを指定して、サポートされる形式で有効なリソース・スコープを定義するサポートされる式を指定する必要があります。

セッション外でこのコマンドを発行するとエラーになります。

構文

createWSMPolicySet(name,type,scope,[description=None],[enable='true'])

引数

定義

name

新規の空のポリシー・セットの名前。

type

新しいポリシー・セットが適用されるポリシー・サブジェクトのタイプ。ポリシー・サブジェクトのタイプは、『Oracle Fusion Middleware Oracle Web Services Managerの理解』のポリシー・サブジェクトの理解に関する項に記載されているポリシー・サブジェクトのいずれかである必要があります。

scope

省略可能。指定されたリソース・スコープにポリシー・セットをアタッチする式。リソース・スコープの式の指定の詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のリソース・スコープの定義に関する項を参照してください。

この引数を指定しない場合、リソース・スコープの識別のためにソース・ポリシー・セットで使用されている式が保持されます。

description=None

省略可能。新しいポリシー・セットの説明。説明が指定されない場合、新しいポリシー・セットの説明は、<type>のグローバル・ポリシー・アタッチメントになり、ここで、<type>はサブジェクト・タイプです。

enable='true'

省略可能。新規ポリシー・セットを有効にするか無効にするかを指定します。有効なオプションは次のとおりです。

- true - 新規ポリシー・セットを有効にします。デフォルトはtrueです。

- false - 新規ポリシー・セットを無効にします。

この引数を省略した場合、ポリシー・セットが有効になります。

例

次の例では、新しいポリシー・セットを作成し、リソース・スコープをbase_domainドメインのws-serviceタイプ(Webサービス・エンドポイント)のみに指定します。

wls:/wls-domain/serverConfig>createWSMPolicySet('myPolicySet','ws-service','Domain("base_domain")')

次の例では、新しいポリシー・セットを作成しますが、リソース・スコープをドメイン内のsoa_server1サーバーのsca-serviceタイプのみ(SOAサービス)に絞ります。

wls:/wls-domain/serverConfig>createWSMPolicySet('myPolicySet','sca-service','Server("soa_server1")','My policySet')

次の例では、新しいポリシー・セットを作成し、リソース・スコープをbase_domainドメインのsca-rest-referenceタイプ(SOA RESTful参照)のみに絞ります。

wls:/wls-domain/serverConfig>createWSMPolicySet('myPolicySet','sca-rest-reference','Domain("base_domain")','My policySet')

次の例では、新しいポリシー・セットを作成し、リソース・スコープをbase_domainドメインのsca-rest-referenceタイプ(OSB RESTfulビジネス・サービス)のみに絞ります。

wls:/wls-domain/serverConfig>createWSMPolicySet('myPolicySet','biz-rest-service','Domain("base_domain")','My policySet')

3.8.10 deleteAllPolicySets

注意:

Oracle Infrastructure Webサービスでは、「deleteWSMAllPolicySets」に記載されているとおり、deleteWSMAllPolicySetsコマンドを使用することをお薦めします。次の例に、deleteWSMAllPolicySetsコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> deleteAllPolicySets()

12cリリース:

wls:/jrfServer_domain/serverConfig> deleteWSMAllPolicySets()

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

すべてまたは選択したポリシー・セットをOWSMリポジトリ内から削除します。すべてのポリシー・セットを強制的に削除するか、削除するポリシー・セットを個別に選択するようプロンプト表示するかを指定できます。いずれかのポリシー・セットの削除が失敗すると、この操作で例外がスローされます。いずれのポリシー・セットも削除されません。

構文

deleteAllPolicySets([mode])

引数

定義

mode

省略可能。ポリシー・セット削除を行うために実行されるアクション。有効なオプションは次のとおりです。

- force - プロンプトを表示せずに、すべてのポリシー・セットを自動的に削除します。

- prompt - ポリシー・セットの削除ごとに、ユーザーの確認を要求します。使用可能なオプションは、yes、noおよびcancelです。いずれかのプロパティ・セットの削除にcancelを選択すると、操作は取り消され、いずれのポリシー・セットも削除されません。

モードを指定しない場合、この引数はデフォルトでpromptモードになります。

例

次の例では、プロンプトを表示しないでリポジトリからすべてのポリシー・セットを自動的に削除します。

wls:/jrfServer_domain/serverConfig> deleteAllPolicySets("force")

Starting Operation deleteAllPolicySets ...

All policy sets were deleted successfully from repository.

deleteAllPolicySets Operation Completed.

次の例では、リポジトリから、選択したポリシー・セットを削除します。

wls:/jrfServer_domain/serverConfig> deleteAllPolicySets()

または

wls:/jrfServer_domain/serverConfig> deleteAllPolicySets('prompt')

Starting Operation deleteAllPolicySets ...

Policy Set Name: create_policyset_6
Select "create_policyset_6" for deletion (yes/no/cancel)? no
Policy Set Name: create_policyset_8
Select "create_policyset_8" for deletion (yes/no/cancel)? yes
Policy Set Name: create_policyset_21
Select "create_policyset_21" for deletion (yes/no/cancel)? no
Policy Set Name: create_policyset_10
Select "create_policyset_10" for deletion (yes/no/cancel)? yes

All the selected policy sets were deleted successfully from repository.

deleteAllPolicySets Operation Completed.

3.8.11 deleteWSMAllPolicySets

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内のすべてまたは選択したポリシー・セットを削除します。すべてのポリシー・セットを強制的に削除するか、削除するポリシー・セットを個別に選択するようプロンプト表示するかを指定できます。いずれかのポリシー・セットの削除が失敗すると、この操作で例外がスローされます。いずれのポリシー・セットも削除されません。

構文

deleteWSMAllPolicySets([mode])

引数

定義

mode

省略可能。ポリシー・セット削除を行うために実行されるアクション。有効なオプションは次のとおりです。

- force - プロンプトを表示せずに、すべてのポリシー・セットを自動的に削除します。

- prompt - ポリシー・セットの削除ごとに、ユーザーの確認を要求します。使用可能なオプションは、yes、noおよびcancelです。いずれかのプロパティ・セットの削除にcancelを選択すると、操作は取り消され、いずれのポリシー・セットも削除されません。

モードを指定しない場合、この引数はデフォルトでpromptモードになります。

例

次の例では、プロンプトを表示しないでリポジトリからすべてのポリシー・セットを自動的に削除します。

wls:/jrfServer_domain/serverConfig> deleteWSMAllPolicySets("force")

Starting Operation deleteWSMAllPolicySets ...

All policy sets were deleted successfully from repository.

deleteWSMAllPolicySets Operation Completed.

次の例では、リポジトリから、選択したポリシー・セットを削除します。

wls:/jrfServer_domain/serverConfig> deleteWSMAllPolicySets()

または

wls:/jrfServer_domain/serverConfig> deleteWSMAllPolicySets('prompt')

Starting Operation deleteWSMAllPolicySets ...

Policy Set Name: create_policyset_6
Select "create_policyset_6" for deletion (yes/no/cancel)? no
Policy Set Name: create_policyset_8
Select "create_policyset_8" for deletion (yes/no/cancel)? yes
Policy Set Name: create_policyset_21
Select "create_policyset_21" for deletion (yes/no/cancel)? no
Policy Set Name: create_policyset_10
Select "create_policyset_10" for deletion (yes/no/cancel)? yes

All the selected policy sets were deleted successfully from repository.

deleteWSMAllPolicySets Operation Completed.

3.8.12 deletePolicySet

注意:

Oracle Infrastructure Webサービスでは、「deleteWSMPolicySet」に記載されているとおり、deleteWSMPolicySetコマンドを使用することをお薦めします。次の例に、deleteWSMPolicySetコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> deletePolicySet('myPolicySet')

12cリリース:

wls:/jrfServer_domain/serverConfig> deleteWSMPolicySet ('myPolicySet')

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で指定したポリシー・セットを削除します。セッションにすでに別のポリシー・セットが含まれている場合は、エラーが表示されます。セッションに、指定したポリシー・セットがすでに含まれている場合、作成は行われず、変更は削除に変換されます。

セッション外でこのコマンドを発行するとエラーになります。

構文

deletePolicySet(name)

引数

定義

name

削除されるポリシー・セットの名前。

例

次の例では、指定したmyPolicySetポリシー・セットを削除します。

wls:/wls-domain/serverConfig>deletePolicySet('myPolicySet')

3.8.13 deleteWSMPolicySet

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、指定したポリシー・セットを削除します。セッションにすでに別のポリシー・セットが含まれている場合は、エラーが表示されます。セッションに、指定したポリシー・セットがすでに含まれている場合、作成は行われず、変更は削除に変換されます。

セッション外でこのコマンドを発行するとエラーになります。

構文

deleteWSMPolicySet(name)

引数

定義

name

削除されるポリシー・セットの名前。

例

次の例では、指定したmyPolicySetポリシー・セットを削除します。

wls:/wls-domain/serverConfig>deleteWSMPolicySet('myPolicySet')

3.8.14 describeRepositorySession

注意:

このコマンドは非推奨になりました。「describeWSMSession」に記載されているとおり、describeWSMSessionコマンドを使用することをお薦めします。次の例に、describeWSMSessionコマンドを使用するための移行方法を示します。

11gリリース(リポジトリ操作)の場合:

wls:/jrfServer_domain/serverConfig> describeRepositorySession()

12cリリース(リポジトリ操作とポリシー・サブジェクト操作の両方)の場合:

wls:/jrfServer_domain/serverConfig> describeWSMSession()

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

現在のセッションの内容を説明します。これは、セッションが空であることを示すか、更新対象のポリシー・サブジェクトの名前を更新のタイプ(作成、変更または削除)とともにリストするかのいずれかです。現在のセッションがない場合、エラーが表示されます。

構文

describeRepositorySession()

例

次の例では、現在のリポジトリの変更セッションを記述します。

wls:/wls-domain/serverConfig>describeRepositorySession()

3.8.15 detachPolicySetPolicy

注意:

Oracle Infrastructure Webサービスでは、「detachWSMPolicy」に記載されているとおり、detachWSMPolicyコマンドを使用することをお薦めします。次の例に、detachWSMPolicyコマンドを使用するための移行方法を示します。

11gリリース(ポリシー・セットでのリポジトリ操作とポリシー・サブジェクト操作の両方)の場合:

wls:/jrfServer_domain/serverConfig> detachPolicySetPolicy ('oracle/wss_username_token_service_policy')

12cリリース:

wls:/jrfServer_domain/serverConfig> detachWSMPolicy('oracle/wss_username_token_service_policy')

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、指定したURIで特定されるポリシーを、現在のポリシー・セットからデタッチします。

作成中または変更中のポリシー・セットが含まれるセッション外でこのコマンドを発行するとエラーになります。

構文

detachPolicySetPolicy(uri)

引数

定義

uri

現在のポリシー・セットからデタッチするポリシーを指定するURI。たとえば、oracle/log_policy'です。

例

次の例では、OWSMロギング・ポリシーを現在のポリシー・セットからデタッチします。

wls:/wls-domain/serverConfig> detachPolicySetPolicy('oracle/log_policy')

3.8.16 displayPolicySet

注意:

Oracle Infrastructure Webサービスでは、「displayWSMPolicySet」に記載されているとおり、displayWSMPolicySetコマンドを使用することをお薦めします。次の例に、displayWSMPolicySetコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> displayPolicySet('myPolicySet')

12cリリース:

wls:/jrfServer_domain/serverConfig> displayWSMPolicySet ('myPolicySet')

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

指定したポリシー・セットの構成を表示します。現在のセッションでポリシー・セットが変更されている場合、そのバージョンが表示されます。それ以外の場合は、リポジトリ内の最新バージョンが表示されます。ポリシー・セットが存在しない場合、エラーが表示されます。

このコマンドは、セッションの外で発行できます。

構文

displayPolicySet([name])

引数

定義

name

省略可能。表示されるポリシー・セットの名前。

名前が指定されていない場合、現在のセッションのポリシー・セットの構成(存在する場合)が表示されるか、エラー・メッセージが表示されます。

例

次の例では、myPolicySetポリシー・セットの構成を表示します。

wls:/wls-domain/serverConfig>displayPolicySet('myPolicySet')

3.8.17 displayWSMResource

注意:

このコマンドは、Oracle InfrastructureおよびRESTful Webサービスに適用されます。このリリースのJava EE Webサービスには適用されません。

コマンド・カテゴリ: リポジトリ

WLSTでの使用: オンライン

説明

登録済リソース・インスタンスの構成を表示します。現在のセッションでリソース・インスタンスが変更されている場合、そのバージョンが表示されます。それ以外の場合は、リポジトリ内の最新バージョンが表示されます。リソース・インスタンスが存在しない場合はエラーが表示されます。このコマンドは、セッションの外で発行できます。

displayWSMResource(resourceName=None), (resourceName=Type)

引数

定義

resourceName

既存のリソース・インスタンスの名前です。これはスラッシュで区切られた、リソースのプラットフォーム名、ドメイン名および論理名の組合せです。nullの場合、現在選択されているリソースが表示されます。

resourceType

リソースのタイプを指定します。値は次のいずれかになります。

- application–アプリケーション・リソースです。

- domain–管理ドメイン・リソースです。

- server–サーバー・リソースです。

resourceTypeが省略された場合、デフォルトでapplication値になります。

例

次の例は、IBM WebSphereアプリケーション・サーバー上のbase_cellドメインにあるmyApplicationという名前のアプリケーションの構成を表示します。

wls:/wls-domain/serverConfig> displayWSMResource('/WAS/base_cell/myApplication')

次の例は、IBM WebSphereアプリケーション・サーバー上のbase_cellドメインの構成を表示します。

wls:/wls-domain/serverConfig> displayWSMResource('/WAS/base_cell','domain')

resourceType引数が省略されているため、次の例で表示される内容は...

displayWSMResource()

3.8.18 displayWSMPolicySet

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

指定したポリシー・セットの構成を表示します。現在のセッションでポリシー・セットが変更されている場合、そのバージョンが表示されます。それ以外の場合は、リポジトリ内の最新バージョンが表示されます。ポリシー・セットが存在しない場合、エラーが表示されます。

このコマンドは、セッションの外で発行できます。

構文

displayWSMPolicySet([name])

引数

定義

name

省略可能。表示されるポリシー・セットの名前。

名前が指定されていない場合、現在のセッションのポリシー・セットの構成(存在する場合)が表示されるか、エラー・メッセージが表示されます。

例

次の例では、myPolicySetポリシー・セットの構成を表示します。

wls:/wls-domain/serverConfig>displayWSMPolicySet('myPolicySet')

3.8.19 enablePolicySet

注意:

Oracle Infrastructure Webサービスでは、「enableWSMPolicySet」に記載されているとおり、enableWSMPolicySetコマンドを使用することをお薦めします。次の例に、enableWSMPolicySetコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> enablePolicySet(true)

12cリリース:

wls:/jrfServer_domain/serverConfig> enableWSMPolicySet(true)

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、現在のポリシー・セットを有効化または無効化します。指定しない場合、このコマンドによってポリシー・セットが有効化されます。

作成中または変更中のポリシー・セットが含まれるセッション外でこのコマンドを発行するとエラーになります。

構文

enablePolicySet([enable=True])

引数

定義

enable

省略可能。ポリシー・セットを有効にするか無効にするかを指定します。有効なオプションは次のとおりです。

- true - ポリシー・セットを有効にします。デフォルトはtrueです。

- false - ポリシー・セットを無効にします。

この引数を省略した場合、ポリシー・セットが有効になります。

例

次の例では、現在のポリシー・セットを有効化します。

wls:/wls-domain/serverConfig>enablePolicySet(true)

3.8.20 enablePolicySetPolicy

注意:

Oracle Infrastructure Webサービスでは、「enableWSMPolicySet」に記載されているとおり、enableWSMPolicySetコマンドを使用することをお薦めします。次の例に、enableWSMPolicySetコマンドを使用するための移行方法を示します。

11gリリース:

wls:/wls-domain/serverConfig>enablePolicySetPolicy('/oracle/log_policy',false)

12cリリース:

wls:/wls-domain/serverConfig>enableWSMPolicy('/oracle/log_policy',false)

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、現在のポリシー・セット内の指定されたURIで特定されるポリシー・アタッチメントを有効化または無効化します。指定しない場合、このコマンドによってポリシー・セットが有効化されます。特定されたポリシーがそのポリシー・セットに現在アタッチされていない場合は、エラーが表示されます。

作成中または変更中のポリシー・セットが含まれるセッション外でこのコマンドを発行するとエラーになります。

構文

enablePolicySetPolicy(uri,[enable=true])

引数

定義

uri

ポリシー・セット内のポリシー・アタッチメントを指定するURI。

enable

省略可能。ポリシー・セット内のURIで指定されるポリシー・アタッチメントを有効化するか無効化するかを指定します。有効なオプションは次のとおりです。

- true - ポリシー・セット内の指定したポリシー・アタッチメントを有効化します。デフォルトはtrueです。

- false - ポリシー・セット内の指定したポリシー・アタッチメントを無効化します。

この引数を省略した場合、ポリシー・セット・アタッチメントが有効になります。

例

次の例では、現在のポリシー・セット内の指定したロギング・ポリシー・アタッチメントを無効化します。

wls:/wls-domain/serverConfig>enablePolicySetPolicy('/oracle/log_policy',false)

3.8.21 enableWSMPolicySet

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、現在のポリシー・セットを有効化または無効化します。オプションのenable引数が指定されない場合、このコマンドではポリシー・セットがデフォルトで有効化されます。

作成中または変更中のポリシー・セットが含まれるセッション外でこのコマンドを発行するとエラーになります。

構文

enableWSMPolicySet([enable=True])

引数

定義

enable

省略可能。ポリシー・セットを有効にするか無効にするかを指定します。有効なオプションは次のとおりです。

- true - ポリシー・セットを有効にします。デフォルトはtrueです。

- false - ポリシー・セットを無効にします。

この引数を省略した場合、ポリシー・セットが有効になります。

例

次の例では、現在のポリシー・セットを有効化します。

wls:/wls-domain/serverConfig>enableWSMPolicySet(true)

3.8.22 listPolicySets

注意:

Oracle Infrastructure Webサービスでは、「listWSMPolicySets」に記載されているとおり、listWSMPolicySetsコマンドを使用することをお薦めします。次の例に、listWSMPolicySetsコマンドを使用するための移行方法を示します。

11gリリース:

wls:/wls-domain/serverConfig>listPolicySets('ws-service')

12cリリース:

wls:/wls-domain/serverConfig>listWSMPolicySets('ws-service')

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

リポジトリ内のポリシー・セットをリストします。このコマンドでは、現在のセッションで作成中、変更中または削除中のポリシー・セットも表示します。すべてのポリシー・セットを一覧表示することも、特定のポリシー・サブジェクト・リソース・タイプに適用されるもののみを含むように表示を制限することもできます。

構文

listPolicySets([type=None])

引数

定義

type=None

省略可能。関連するポリシー・セットが表示されるポリシー・サブジェクトのタイプを指定します。ポリシー・サブジェクトのタイプは、『Oracle Fusion Middleware Oracle Web Services Managerの理解』のポリシー・サブジェクトの理解に関する項に記載されているポリシー・サブジェクトのいずれかである必要があります。

この引数をNoneに設定すると、リポジトリに格納されているすべてのポリシー・セットが一覧表示されます。

例

最初の2つの例では、ws-serviceまたはws-clientのいずれかのリソース・タイプごとにポリシー・セットをリストします。3番目の例では、リポジトリに格納されているすべてのポリシー・セットをリストします。

wls:/wls-domain/serverConfig>listPolicySets('ws-service')
wls:/wls-domain/serverConfig>listPolicySets('ws-client')
wls:/wls-domain/serverConfig>listPolicySets()

3.8.23 listWSMPolicySets

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

リポジトリ内のポリシー・セットをリストします。このコマンドでは、現在のセッションで作成中、変更中または削除中のポリシー・セットも表示します。すべてのポリシー・セットをリストしたり、type引数を使用して特定のポリシー・サブジェクト・リソース・タイプに適用されるポリシー・セットのみを含むように表示を制限できます。

構文

listWSMPolicySets([type=None])

引数

定義

type=None

省略可能。関連するポリシー・セットが表示されるポリシー・サブジェクトのタイプを指定します。ポリシー・サブジェクトのタイプは、『Oracle Fusion Middleware Oracle Web Services Managerの理解』のポリシー・サブジェクトの理解に関する項に記載されているポリシー・サブジェクトのいずれかである必要があります。

この引数をNoneに設定すると、リポジトリに格納されているすべてのポリシー・セットが一覧表示されます。

例

最初の2つの例では、ws-serviceまたはws-clientのいずれかのリソース・タイプごとにポリシー・セットをリストします。一方、3番目の例では、リポジトリに格納されているすべてのポリシー・セットをリストします。

wls:/wls-domain/serverConfig>listWSMPolicySets('ws-service')
wls:/wls-domain/serverConfig>listWSMPolicySets('ws-client')
wls:/wls-domain/serverConfig>listWSMPolicySets()

3.8.24 migrateAttachments

注意:

このコマンドは非推奨になりました。「migrateWSMAttachments」に記載されているとおり、migrateWSMAttachmentsコマンドを使用することをお薦めします。次の例に、migrateWSMAttachmentsコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> migrateAttachments()

12cリリース:

wls:/jrfServer_domain/serverConfig> migrateWSMAttachments()

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

外部グローバル・ポリシー・アタッチメントと等しい直接(ローカル)ポリシー・アタッチメントを移行します。移行しない場合は現在のドメインで各ポリシー・サブジェクトにアタッチされます。強制的に移行するか、移行の前に確認のプロンプトを毎回表示するか、実行される移行を単に一覧表示するのかを指定できます。直接ポリシー・アタッチメントのURIがグローバル・ポリシー・アタッチメントで提供されるものと同じで、スコープが設定された構成オーバーライドがない場合は、直接ポリシー・アタッチメントは同一です。

注意:

スコープのないオーバーライドを含むダイレクト・アタッチメントは移行されますが、スコープのあるオーバーライドを含むアタッチメントは移行されません。これは、migrateAttachments()コマンドを実行した後、いくつかのポリシーはグローバルにアタッチされていても、すべてのサブジェクトに対するポリシーの施行が変わらないためです。

強制の場合でもプロンプトが表示される場合でも、移行された各直接ポリシー・アタッチメントが一覧表示されます。この出力では、変更されたポリシー・サブジェクト、同一のポリシー参照のURI、および直接アタッチメントを重複させたグローバル・ポリシー・アタッチメント・ドキュメントの名前が特定されます。

構文

migrateAttachments([mode])

引数

定義

mode

移行可能な各ポリシー・アタッチメントに対して実行されるアクション。有効なオプションは次のとおりです。

- force - プロンプトが表示されることなく、等しいポリシー・アタッチメントがすべて自動的に移行されます。

- preview - 移行可能なすべてのポリシー・アタッチメントが一覧表示されますが、移行は実施されません。

- prompt - 各ポリシー・アタッチメントの移行前にユーザーの確認を求められます。

モードを指定しない場合、この引数はデフォルトでpromptモードになります。

例

次の例では、リポジトリ・アタッチメント移行モードの使用方法を示します。

wls:/wls-domain/serverConfig>migrateAttachments()
wls:/wls-domain/serverConfig>migrateAttachments('force')
wls:/wls-domain/serverConfig>migrateAttachments('preview')
wls:/wls-domain/serverConfig>migrateAttachments('prompt')

3.8.25 modifyPolicySet

注意:

Oracle Infrastructure Webサービスでは、「selectWSMPolicySet」に記載されているとおり、selectWSMPolicySetコマンドを使用することをお薦めします。次の例に、selectWSMPolicySetコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> modifyPolicySet('myPolicySet')

12cリリース:

wls:/jrfServer_domain/serverConfig> selectWSMPolicySet ('myPolicySet')

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

現在のセッション内で変更するポリシー・セットを指定します。指定したポリシー・セットの最新バージョンが現在のセッションにロードされます。別のポリシー・セットがセッションにすでに含まれている場合は、エラーが表示されます。指定したポリシー・セットがすでにセッションに含まれている場合、アクションは実行されません。この後、指定したポリシー・セットを変更しようとすると、セッションにある現在のバージョンが表示されます。

セッション外でこのコマンドを発行するとエラーになります。

構文

modifyPolicySet(name)

引数

定義

name

現在のセッションで変更するポリシー・セットの名前。

例

次の例では、現在のセッション内で変更するmyPolicySetポリシー・セットを開きます。

wls:/wls-domain/serverConfig>modifyPolicySet('myPolicySet')

3.8.26 selectWSMPolicySet

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、変更するポリシー・セットを指定します。名前を指定したポリシー・セットの最新バージョンが現在のセッションにロードされます。別のポリシー・セットがセッションにすでに含まれている場合は、エラーが表示されます。指定したポリシー・セットがすでにセッションに含まれている場合、アクションは実行されません。この後、指定したポリシー・セットを変更しようとすると、セッションにある現在のバージョンが表示されます。

セッション外でこのコマンドを発行するとエラーになります。

構文

selectWSMPolicySet(name)

引数

説明

name

現在のセッションで変更するポリシー・セットの名前。

例

次の例では、現在のセッションでmyPolicySetという名前のポリシー・セットを選択します。

wls:/wls-domain/serverConfig> selectWSMPolicySet('myPolicySet')

3.8.27 setPolicySetConstraint

注意:

このコマンドは非推奨になりました。「setWSMPolicySetConstraint」に記載されているとおり、setWSMPolicySetConstraintコマンドを使用することをお薦めします。次の例に、setWSMPolicySetConstraintコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> setPolicySetConstraint ('HTTPHeader("VIRTUAL_HOST_TYPE","external")')

12cリリース:

wls:/jrfServer_domain/serverConfig> setWSMPolicySetConstraint ('HTTPHeader("VIRTUAL_HOST_TYPE","external")')

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で選択したポリシー・セットのランタイム制約値を指定します。作成中または変更中のポリシー・セットが含まれるセッション外でこのコマンドを発行するとエラーになります。

詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のポリシー・セットでのランタイム制約の指定に関する項を参照してください。

構文

setPolicySetConstraint(constraint)

引数

定義

constraint

ポリシー・セットが適用される実行時コンテキストを指定する式。指定しない場合、そのポリシー・セットがすべての実行時コンテキストに適用されます。

例

次の例では、ポリシー・セットを外部クライアントからのリクエストにのみ適用することを指定します。

wls:/wls-domain/serverConfig> setPolicySetConstraint('HTTPHeader("VIRTUAL_HOST_TYPE","external")')

次の例では、ポリシー・セットを外部以外のクライアントからのリクエストにのみ適用することを指定します。

wls:/wls-domain/serverConfig> setPolicySetConstraint('!HTTPHeader("VIRTUAL_HOST_TYPE","external")')

3.8.28 setPolicySetDescription

注意:

このコマンドは非推奨になりました。「setWSMPolicySetDescription」に記載されているとおり、setWSMPolicySetDescriptionコマンドを使用することをお薦めします。次の例に、setWSMPolicySetDescriptionコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> setPolicySetDescription ('Global policy set for web service endpoint.')

12cリリース:

wls:/jrfServer_domain/serverConfig> setWSMPolicySetDescription ('Global policy set for web service endpoint.')

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で選択したポリシー・セットの説明を指定します。

作成中または変更中のポリシー・セットが含まれるセッション外でこのコマンドを発行するとエラーになります。

構文

setPolicySetDescription(description)

引数

定義

description

ポリシー・セットを説明します。

例

次の例では、ポリシー・セットの説明を作成します。

wls:/wls-domain/serverConfig>setPolicySetDescription('PolicySetDescription')

3.8.29 setPolicySetPolicyOverride

注意:

このコマンドは非推奨になりました。「setWSMPolicyOverride」に記載されているとおり、setWSMPolicyOverrideコマンドを使用することをお薦めします。次の例に、setWSMPolicyOverrideコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> setPolicySetPolicyOverride ('oracle/wss_username_token_service_policy', 'reference.priority', '10')

12cリリース:

wls:/jrfServer_domain/serverConfig> setWSMPolicyOverride ('oracle/wss_username_token_service_policy', 'reference.priority', '10')

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

現在のポリシー・セット内のアタッチされたポリシー参照にnameとvalueのペアで記述される構成オーバーライドを追加します。value引数はオプションです。value引数を省略すると、name引数で指定されたプロパティが、ポリシー・セットのポリシー参照から削除されます。name引数で指定されたプロパティがすでに存在しており、value引数が指定されている場合、現在の値がvalue引数で指定されている新しい値で上書きされます。

作成中または変更中のポリシー・セットが含まれるセッション外でこのコマンドを発行するとエラーになります。

構文

setPolicySetPolicyOverride(uri,name,[value=None])

引数

定義

URI

OWSMポリシーURIを表す文字列で、たとえば、オーバーライド・プロパティが適用される'oracle/wss10_saml_token_service_policy'です。

name

オーバーライド・プロパティの名前を表す文字列。

例: ['reference.priority']

value

省略可能。プロパティの値を表す文字列。この引数を指定しない場合、name引数で指定されているプロパティがあると、それが削除されます。

例

次の例では、oracle/wss10_saml_token_service_policyのreference.priorityプロパティの構成オーバーライドを値1に指定します。

wls:/wls-domain/serverConfig> setPolicySetPolicyOverride('oracle/wss10_saml_token_service_policy', 'reference.priority','1')

次の例では、ポリシー・セットのoracle/wss10_saml_token_service_policyからプロパティreference.priorityを削除します。

wls:/wls-domain/serverConfig> setPolicySetPolicyOverride('oracle/wss10_saml_token_service_policy', 'reference.priority')

3.8.30 setWSMPolicySetConstraint

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、セッション内で選択したポリシー・セットの制約値を指定します。作成中または変更中のポリシー・セットが含まれるセッション外でこのコマンドを発行するとエラーになります。

詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のポリシー・セットでのランタイム制約の指定に関する項を参照してください。

構文

setWSMPolicySetConstraint(constraint)

引数

定義

constraint

ポリシー・セットが適用される実行時コンテキストを指定する式。指定しない場合、そのポリシー・セットがすべての実行時コンテキストに適用されます。

例

次の例では、ポリシー・セットを外部クライアントからのリクエストにのみ適用するように指定します。

wls:/wls-domain/serverConfig> setWSMPolicySetConstraint('HTTPHeader("VIRTUAL_HOST_TYPE","external")')

次の例では、ポリシー・セットを外部以外のクライアントからのリクエストにのみ適用するように指定します。

wls:/wls-domain/serverConfig> setWSMPolicySetConstraint('!HTTPHeader("VIRTUAL_HOST_TYPE","external")')

3.8.31 setWSMPolicySetDescription

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、ポリシー・セットの説明を指定します。作成中または変更中のポリシー・セットが含まれるセッション外でこのコマンドを発行するとエラーになります。

構文

setWSMPolicySetDescription(description)

引数

定義

description

ポリシー・セットを説明します。

例

次の例では、ポリシー・セットの説明を作成します。

wls:/wls-domain/serverConfig>setWSWPolicySetDescription('PolicySetDescription')

3.8.32 setWSMPolicySetOverride

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、nameとvalueのペアで記述される構成オーバーライドを、現在選択されているポリシー・セットに追加します。オーバーライドは、特定のポリシー参照にスコープ設定されていません。value引数はオプションです。value引数を省略した場合、nullがvalueに指定されたとみなされて、name引数で指定されたプロパティがポリシー・セットから削除されます。name引数で指定されたプロパティがすでに存在していて、value引数が指定されている場合は、現在の値が新しい値で上書きされます。

コマンドを開始する前に、セッションを開始してポリシー・セットを選択(selectWSMPolicySetコマンドを使用して)する必要があります。作成中または変更中のポリシー・サブジェクトが含まれるセッション外でこのコマンドを発行するとエラーになります。

構文

setWSMPolicySetOverride(name,[value=None])

引数

説明

name

オーバーライド・プロパティの名前を表す文字列。例: ['on.behalf.of']

value

省略可能。プロパティの値を表す文字列。この引数が指定されない場合、nullが指定されたとみなされて、同じ名前のプロパティが存在する場合は、name引数で指定されたプロパティが削除されます。

例

次の例では、セッションで選択されたポリシー・セットのon.behalf.ofプロパティの構成オーバーライドを値trueに指定します。

wls:/wls-domain/serverConfig> setWSMPolicySetOverride('on.behalf.of','true')

次の例では、ポリシー・セットからプロパティon.behalf.ofを削除します。

wls:/wls-domain/serverConfig> setWSMPolicySetOverride('on.behalf.of')

3.8.33 setWSMPolicySetScope

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、指定したリソース・スコープにポリシー・セットをアタッチする式を設定します。この式は、サポートされる形式で有効なリソース・スコープを定義する必要があります。

作成中または変更中のポリシー・セットが含まれるセッション外でこのコマンドを発行するとエラーになります。

構文

setWSMPolicySetScope(expression)

引数

定義

expression

指定されたリソース・スコープにポリシー・セットをアタッチする式。

リソース・スコープの式の指定の詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のリソース・スコープの定義に関する項を参照してください。

例

次の例では、指定したbase_domainリソースにポリシー・セットをアタッチします。

wls:/wls-domain/serverConfig>setWSMPolicySetScope('Domain("base_domain")')

この例では、指定したbase_domainおよびmanaged_serverリソースにポリシー・セットをアタッチします。

wls:/wls-domain/serverConfig>setWSMPolicySetScope('Domain("base_domain") and Server("managed_server")')

3.8.34 unregisterWSMResource

コマンド・カテゴリ: リポジトリ

WLSTでの使用: オンライン

説明

セッション内で、アプリケーション・サーバーなどの物理リソースを記述するリソース・インスタンスを登録解除または削除する、あるいはリソース・インスタンス内に存在するサブリソースを登録解除します。サブリソースにはリソースのクライアント・ポートおよびサービス・ポートについての情報が保持されます。セッション外でこのコマンドを発行するとエラーになります。

構文

unregisterWSMResource(resource, [assembly=None], [subject=None])

引数

説明

resource

既存のリソース・インスタンスの名前です。これはスラッシュで区切られた、プラットフォーム名、ドメイン名および論理名の組合せです。

assembly

リソース・インスタンス内のサブリソースを識別するのに使用されるアセンブリ名です。これはハッシュ記号で区切られた、モジュール・タイプおよびモジュール名の組合せです。

subject

サブリソースを識別するサブジェクトの名前です。これはサブリソース・タイプの組合せ、つまりハッシュ記号で区切られた、"server"または"client"およびサービス、または参照名およびポート名のいずれかです。

例

次の例は、IBM WebSphereアプリケーション・サーバー上のbase_domainにあるmyApplicationを登録解除します。

wls:/jrfServer_domain/serverConfig> unregisterWSMResource ('/WAS/base_cell/myApplication')

次の例は、IBM WebSphereプラットフォーム・ドメインWAS/base_cellを登録します。

wls:/jrfServer_domain/serverConfig> registerWSMResource ('WAS/base_cell')

次の例は、IBM WebSphereアプリケーション・サーバー上のbase_domainを登録解除します。

wls:/jrfServer_domain/serverConfig> unregisterWSMResource (‘/WAS/base_cell')

次の例は、アプリケーション/WAS/base_cell/myApplicationの、IBM WebSphereプラットフォームにあるStockQuoteServicePortエンドポイントを登録解除します。

wls:/jrfServer_domain/serverConfig> unregisterWSMResource (‘/WAS/base_cell/myApplication', ‘web# myModule', ‘service(StockQuoteService# StockQuoteServicePort)')

3.8.35 validatePolicySet

注意:

このコマンドは非推奨になりました。「validateWSMPolicySet」に記載されているとおり、validateWSMPolicySetコマンドを使用することをお薦めします。次の例に、validateWSMPolicySetコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> validatePolicySet ('myPolicySet')

12cリリース:

wls:/jrfServer_domain/serverConfig> validateWSMPolicySet ('myPolicySet')

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

既存のポリシー・セットを検証します。ポリシー・セット名を指定すると、指定されたポリシー・セットが検証されます。ポリシー・セット名が指定されていない場合は、現在のセッションのポリシー・セットがコマンドによって検証されます。

ポリシー・セットが存在しない場合、名前が指定されておらず、セッションがアクティブでない場合、または適切なポリシー・セットがOWSMリポジトリに含まれていない場合は、エラー・メッセージが表示されます。

構文

validatePolicySet([name=None])

引数

定義

name

省略可能。検証するポリシー・セットの名前。名前が指定されていない場合、現在のセッション内で作成中または変更中のポリシー・セットが検証されます。

例

最初の例では、現在のセッションのポリシー・セットが検証されます。2番目の例では、指定されたmyPolicySetポリシー・セットが検証されます。

wls:/wls-domain/serverConfig>validatePolicySet()
wls:/wls-domain/serverConfig>validatePolicySet('myPolicySet')

3.8.36 validateWSMPolicySet

コマンド・カテゴリ: ポリシー・セット管理

WLSTでの使用: オンライン

説明

セッション内で、既存のポリシー・セットを検証します。ポリシー・セット名が指定されている場合、指定されたポリシー・セットが検証されます。ポリシー・セット名が指定されていない場合は、現在のセッションのポリシー・セットが検証されます。

ポリシー・セットが存在しない場合、名前が指定されておらず、セッションがアクティブでない場合、または適切なポリシー・セットがリポジトリに含まれていない場合は、エラー・メッセージが表示されます。

構文

validateWSMPolicySet([name=None])

引数

定義

name

省略可能。検証するポリシー・セットの名前。名前が指定されていない場合、現在のセッション内で作成中または変更中のポリシー・セットが検証されます。

例

最初の例では、現在のセッションのポリシー・セットが検証されます。2番目の例では、指定されたmyPolicySetポリシー・セットが検証されます。

wls:/wls-domain/serverConfig> validateWSMPolicySet()
wls:/wls-domain/serverConfig> validateWSMPolicySet('myPolicySet')

3.9 OWSMリポジトリ管理コマンド

表3-10にリストされているコマンドを使用して、OWSMリポジトリに格納されているOracle Infrastructure Webサービス・ドキュメントを管理します。OWSMリポジトリ内のドキュメントのアップグレードまたは移行の詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のOWSMリポジトリのアップグレードに関する項を参照してください。

注意:

表3-11にリストされているリポジトリ管理コマンドは、このリリースで非推奨になりました。

リリース12cでOWSMリポジトリを管理するには、表3-10にリストされているWLSTの新しいコマンドを使用することをお薦めします。非推奨コマンドをすべて示すリストは、『Oracle Fusion Middleware Oracle Fusion Middleware Infrastructureリリース・ノート』の非推奨となったOracle Infrastructure Webサービスのコマンドに関する項を参照してください。

追加のMDS WLSTコマンドについては、Metadata Services (MDS)のカスタムWLSTコマンドで説明します。

表3-10 Oracle Infrastructure Webサービス - リポジトリ管理用のWLSTコマンド

使用するコマンド

目的

WLSTでの使用

exportWSMAppMetadata

アプリケーション・メタデータのセットをリポジトリからサポートされているZIPアーカイブにエクスポートします。

注意: このコマンドは、Oracle InfrastructureおよびRESTful Webサービスでのみサポートされます。このコマンドは、ADF DC Webサービス・クライアントおよびJava EE Webサービスではサポートされません。

オンライン

exportWSMRepository

サポートされているZIPアーカイブに、リポジトリから一連のドキュメントをエクスポートします。

オンライン

importWSMArchive

サポートされているZIPアーカイブからリポジトリに一連のドキュメントをインポートします。

オンライン

migrateWSMPMRoles

カスタム・ロールおよびポリシーをPlan.xmlファイルからwsm-pm.earポリシー・ストアに移行します。

オンライン

migrateWSMAttachments

外部グローバル・ポリシー・アタッチメントと等しい直接(ローカル)ポリシー・アタッチメントを移行します。移行しない場合は現在のドメインで各ポリシー・サブジェクトにアタッチされます。

オンライン

resetWSMRepository

リポジトリ内に格納されている既存のポリシーを削除して、Oracle Fusion Middlewareソフトウェアの新しいインストールで提供される事前定義ポリシーの最新セットでリフレッシュします。

オンライン

upgradeWSMRepository

リポジトリ内に格納されているOWSM事前定義ポリシーを、Oracle Fusion Middlewareソフトウェアの最新のインストールで提供される任意の新しい事前定義ポリシーでアップグレードします。

オンライン

表3-11に、このリリースで非推奨になったOWSMリポジトリを管理するためのWLSTコマンドをリストします。

表3-11 非推奨のリポジトリ管理用のWLSTコマンド

使用するコマンド

目的

WLSTでの使用

exportRepository

サポートされているZIPアーカイブに、リポジトリから一連のドキュメントをエクスポートします。指定されているアーカイブがすでに存在している場合、アーカイブを上書きするか、ドキュメントを既存のアーカイブにマージするのかを選択できます。

オンライン

importRepository

サポートされているZIPアーカイブからリポジトリに一連のドキュメントをインポートします。ソース環境からターゲット環境に物理情報をマップする方法を記述するファイルの場所を指定できます。

オンライン

resetWSMPolicyRepository

リポジトリ内に格納されている既存のポリシーを削除して、Oracle Fusion Middlewareソフトウェアの新しいインストールで提供される事前定義ポリシーの最新セットでリフレッシュします。

オンライン

upgradeWSMPolicyRepository

リポジトリ内に格納されているOWSM事前定義ポリシーを、Oracle Fusion Middlewareソフトウェアの最新のインストールで提供される任意の新しい事前定義ポリシーでアップグレードします。

オンライン

3.9.1 exportRepository

注意:

このコマンドは非推奨になりました。「exportWSMRepository」に記載されているとおり、exportWSMRepositoryコマンドを使用することをお薦めします。次の例に、exportWSMRepositoryコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> exportRepository ("/tmp/repo.zip")

12cリリース:

wls:/jrfServer_domain/serverConfig> exportWSMRepository ("/tmp/repo.zip")

コマンド・カテゴリ: OWSMリポジトリ管理

WLSTでの使用: オンライン

説明

ドキュメントのセットをOWSMリポジトリからサポートされているZIPアーカイブにエクスポートします。指定されているアーカイブがすでに存在している場合、次のオプションが提示されます。

The specified archive already exists. Update existing archive?
Enter "yes" to merge documents into existing archive, "no" to overwrite,
or "cancel" to cancel the operation.

エクスポートするドキュメントのリストを指定することもできます。または、検索式を使用してリポジトリ内の特定のドキュメントを見つけることもできます。

事前定義済ポリシー、アサーション・テンプレートなどの読取り専用ドキュメントは、エクスポートに含まれません。

構文

exportRepository(archive,[documents=None],[includeShared='false'])

引数

定義

archive

アーカイブ・ファイルの名前。指定されているアーカイブがすでに存在している場合、アーカイブを上書きするか、ドキュメントを既存のアーカイブにマージするのかを選択できます。

オーバーライド中に、元のアーカイブがバックアップされ、メッセージにバックアップ・アーカイブの場所が示されます。

documents=None

省略可能。アーカイブにエクスポートするドキュメント。ドキュメントを指定しない場合、すべてのアサーション・テンプレート、インテント、ポリシーおよびポリシー・セットがエクスポートされます。エクスポートするドキュメントのリストを指定したり、検索式を使用してリポジトリ内の特定のドキュメントを検索できます。

includeShared='false'

省略可能。ポリシー参照をエクスポート中に拡張するかどうかを指定します。

例

次の例では、リポジトリ・エクスポート・セッションを説明します。最初の例では、すべてのOWSMドキュメントをpolicies.zipファイルにエクスポートします。

wls:/wls-domain/serverConfig>exportRepository("/tmp/policies.zip")

この例では、MyPolicySet1、MyPolicySet2およびMyPolicySet3のポリシー・セットのみをpolicies.jarファイルにエクスポートし、エクスポート・プロセス中にすべてのポリシー参照出力を拡張します。

wls:/wls-domain/serverConfig>exportRepository("/tmp/policies.jar",
["/policysets/MyPolicySet1","/policysets/MyPolicySet2","/policysets/MyPolicySet3"], true)

この例では、ワイルドカードを使用してポリシー・セットをsome_global_with_noreference_2ファイルにエクスポートします。

wls:/wls-domain/serverConfig>exportRepository('./export/some_global_with_noreference_2', ['policysets:global/web_%','policysets:global/web_ref%', 'policysets:global/web_call%'], false)

3.9.2 exportWSMAppMetadata

注意:

このコマンドは、Oracle Infrastructure WebサービスおよびRESTful Webサービスでのみサポートされます。このコマンドは、ADF DC Webサービス・クライアントおよびJava EE Webサービスではサポートされません。

コマンド・カテゴリ: OWSMリポジトリ管理

WLSTでの使用: オンライン

説明

アプリケーション・メタデータのセットをリポジトリからサポートされているZIPアーカイブにエクスポートします。指定したアーカイブがすでに存在している場合、ドキュメントを既存のアーカイブにマージする、アーカイブを上書きする、操作を取り消す、といったオプションのセットが表示されます。デフォルトでは、現在のドメイン内のアプリケーションのすべてのメタデータがアーカイブにエクスポートされますが、リポジトリ内のアプリケーションの特定のメタデータをエクスポートするための検索式も使用できます。

注意:

事前定義済ポリシー、アサーション・テンプレートなどの読取り専用ドキュメントは、エクスポートに含まれません。

構文

exportWSMAppMetadata(archive,[applications=None],[includeShared='false'])

引数

説明

archive

アーカイブ・ファイルの名前。指定されているアーカイブがすでに存在している場合、アーカイブを上書きするか、ドキュメントを既存のアーカイブにマージするのかを選択できます。オーバーライド中に、元のアーカイブがバックアップされ、メッセージにバックアップ・アーカイブの場所が示されます。

applications=None

省略可能。アーカイブにエクスポートするアプリケーションのメタデータ。アプリケーション名を指定しない場合、現在のドメイン内のアプリケーションのすべてのメタデータがエクスポートされます。この構文/{PLATFORM_NAME}/{DOMAIN_NAME}/{APPLICATION_NAME}を使用して、リポジトリ内の特定のアプリケーション・メタデータを検索するための検索式のリストを指定できます。

includeShared='false'

省略可能。共有ドキュメント(wsm-assemblyドキュメント内でポリシー参照として指定されている)をエクスポート時に含むかどうかを指定します。読取り専用ドキュメントはエクスポートできないため、エクスポートにはカスタムまたはクローンの共有ポリシーのみが含まれます。

例

最初の例では、リポジトリ内のアプリケーション・メタデータをapplications.zipファイルにエクスポートして、それをtmpディレクトリに保存します。

2番目の例では、名前がSalesAppおよびTradeAppで始まるアプリケーションのメタデータをapplications.zipファイルにエクスポートして、それをtmpディレクトリに保存します。

3番目の例では、名前がSalesAppおよびTradeAppで始まるアプリケーションのメタデータをapplications.zipファイルにエクスポートして、それをtmpディレクトリに保存します。さらに、共有リソースがこのエクスポートに含まれます。

wls:/wls-domain/serverConfig> exportWSMAppMetadata("/tmp/applications.zip")

wls:/wls-domain/serverConfig> exportWSMAppMetadata("/tmp/applications.zip",["/WLS/base_domain/SalesApp%","WLS/base_domain/TradeApp%"])

wls:/wls-domain/serverConfig> exportWSMAppMetadata("/tmp/applications.zip",["/WLS/base_domain/SalesApp%","WLS/base_domain/TradeApp%"], true)

注意:

これらのスクリプト・ツールで使用されているPythonのバージョンはブール型がサポートされていない可能性があるため、wsadminおよびojbstでブール型を渡すには、整数値0 (false)または1 (true)を使用してください。

3.9.3 exportWSMRepository

コマンド・カテゴリ: OWSMリポジトリ管理

WLSTでの使用: オンライン

説明

ドキュメントのセットをOWSMリポジトリからサポートされているZIPアーカイブにエクスポートします。指定されているアーカイブがすでに存在している場合、次のオプションが提示されます。

The specified archive already exists. Update existing archive?
Enter "yes" to merge documents into existing archive, "no" to overwrite,
or "cancel" to cancel the operation.

エクスポートするドキュメントのリストを指定することもできます。または、検索式を使用してリポジトリ内の特定のドキュメントを見つけることもできます。

注意:

事前定義済ポリシー、アサーション・テンプレートなどの読取り専用ドキュメントは、エクスポートに含まれません。

構文

exportWSMRepository(archive,[documents=None],[includeShared='false'])

引数

定義

archive

アーカイブ・ファイルの名前。指定されているアーカイブがすでに存在している場合、アーカイブを上書きするか、ドキュメントを既存のアーカイブにマージするのかを選択できます。

オーバーライド中に、元のアーカイブがバックアップされ、メッセージにバックアップ・アーカイブの場所が示されます。

documents=None

省略可能。アーカイブにエクスポートするドキュメント。ドキュメントが指定されない場合、ポリシーおよびポリシー・セットを含む共有ドキュメントのみがエクスポートされます。この引数が空白文字列([''])として指定される場合、ポリシーおよびポリシー・セットを含むすべての共有ドキュメント、アプリケーション・メタデータおよび構成ドキュメントがエクスポートされます。エクスポートするドキュメントのリストを指定したり、リポジトリ内の特定のドキュメントを検索するための検索式を使用できます。

includeShared='false'

省略可能。共有ドキュメント(ポリシー・セット内およびwsm-assemblyドキュメント内でポリシー参照として指定されている)をエクスポート時に含むかどうかを指定します。読取り専用ドキュメントはエクスポートできないため、エクスポートにはカスタムまたはクローンの共有ポリシーのみが含まれます。

例

次の例では、リポジトリ・エクスポート・セッションを説明します。最初の例では、すべてのOWSMドキュメントをpolicies.zipアーカイブにエクスポートします。

wls:/wls-domain/serverConfig>exportWSMRepository("/tmp/policies.zip")

この例では、MyPolicySet1、MyPolicySet2およびMyPolicySet3のポリシー・セットのみをpolicies.jarアーカイブにエクスポートし、エクスポート・プロセス中にすべてのポリシー参照出力を拡張します。

wls:/wls-domain/serverConfig>exportWSMRepository("/tmp/policies.jar",
["/policysets/MyPolicySet1","/policysets/MyPolicySet2","/policysets/MyPolicySet3"], true)

この例では、ワイルドカードを使用してポリシー・セットをsome_global_with_noreference_2アーカイブにエクスポートします。

wls:/wls-domain/serverConfig>exportWSMRepository('./export/some_global_with_noreference_2',
['policysets:global/web_%','policysets:global/web_ref%', 'policysets:global/web_call%'], false)

3.9.4 importRepository

注意:

このコマンドは非推奨になりました。「importWSMArchive」に記載されているとおり、importWSMArchiveコマンドを使用することをお薦めします。次の例に、importWSMArchiveコマンドを使用するための移行方法を示します。

11gリリース(リポジトリ・ドキュメント)の場合:

wls:/jrfServer_domain/serverConfig> importRepository ("/tmp/repo.zip")

12cリリース(リポジトリ・ドキュメント)の場合:

wls:/jrfServer_domain/serverConfig> importWSMArchive ("/tmp/repo.zip")

コマンド・カテゴリ: OWSMリポジトリ管理

WLSTでの使用: オンライン

説明

ドキュメントのセットをサポートされているZIPアーカイブからOWSMリポジトリにインポートします。map引数を使用して、ソース環境からターゲット環境に物理情報をマップする方法を記述するファイルの場所を指定できます。たとえば、マップ・ファイルを使用して、ポリシー・セット・ドキュメント内のアタッチメント式がDomain("foo")=Domain("bar")のようにターゲット環境と一致するように更新されるようにすることができます。

事前定義済ポリシー、アサーション・テンプレートなどの読取り専用ドキュメントは、インポートに含まれません。

構文

importRepository(archive,[map=None],[generateMapFile='false'])

引数

定義

archive

インポートするドキュメントのリストを含むアーカイブ・ファイルへのパス。インポートするドキュメントがリポジトリにすでに存在する現行バージョンの複製である場合は、そのドキュメントはインポートされず、ドキュメントの新しいバージョンは作成されません。

map=None

省略可能。物理情報をソース環境からターゲット環境にマップする方法を記述するサンプル・マップ・ファイルの場所。generateMapFile引数をtrueに設定することで新しいマップ・ファイルを生成できます。

generateMapFile引数をtrueに設定しないでマップ・ファイルを指定し、そのファイルが存在しない場合、操作は失敗し、エラーが表示されます。

generateMapFile=false

省略可能。map引数で指定した場所にサンプル・マップ・ファイルを作成するかどうかを指定します。この引数をtrueに設定すると、どのドキュメントもインポートされません。デフォルトは、falseです。

マップ・ファイルが作成された後、任意のテキスト・エディタを使用して編集できます。マップ・ファイルには、アーカイブ・ファイルに指定されているドキュメント名および対応するattachTo値が含まれます。attachTo値は、新しい環境に対応するように更新できます。ドキュメント名に対してマッピングの更新が不要な場合は、そのエントリを削除するか、文字#を使用してコメント化することができます。

注意: リポジトリへのドキュメントのインポート時、OWSMはattachTo値のみを検証します。値が無効な場合、ポリシー・セットは無効化されます。マップ・ファイル内の他のテキストは検証されません。

例

次の例では、リポジトリ・インポート・セッションを示します。

最初の例では、policies.zipファイルのコンテンツがリポジトリにインポートされます。

wls:/wls-domain/serverConfig>importRepository("/tmp/policies.zip")

この例では、generateMapFile引数を使用してマップ・ファイルを生成します。

wls:/wls-domain/serverConfig>importRepository("./export/some_global_with_noreference_2', map="./export/some_global_with_noreference_2_map', generateMapFile=true)

生成されたマップ・ファイルの例は次のとおりです:

This is an auto generated override file containing the document names given in
the archive file and their corresponding attachTo values. The attachTo value can
be updated according to the new environment details. If there is no update
required for any document name,that entry may be either deleted or commented
using the character ("#")

[Resource Scope Mappings
]

sca_component_add_1=Composite("*Async*")

sca_reference_add_1=Composite("*Basic_SOA_Client*")

sca_reference_no=Server("*")

sca_service_add_1=Composite("*Basic_SOA_service")

web_callback_add_1=Application("*")
web_client_add_1=Module("*")
web_reference_add_1=Domain("*")
web_service_add_1=Domain("*domain*") and Server("*soa*") and Application("*ADF*")
ws_service_no_1=Server("*Admin*")

この例では、生成されたマップ・ファイル/some_global_with_noreference_2_mapを使用してドキュメントをインポートする方法を示します。

wls:/wls-domain/serverConfig>importRepository('../export/export_all', 'export_all_map')

3.9.5 importWSMArchive

コマンド・カテゴリ: OWSMリポジトリ管理

WLSTでの使用: オンライン

説明

ドキュメントのセットをサポートされているZIPアーカイブからOWSMリポジトリにインポートします。map引数を使用して、ソース環境からターゲット環境に物理情報をマップする方法を記述するファイルの場所を指定できます。たとえば、マップ・ファイルを使用して、ポリシー・セット・ドキュメント内のアタッチメント式がDomain("foo")=Domain("bar")のようにターゲット環境と一致するように更新されるようにすることができます。

事前定義済ポリシー、アサーション・テンプレートなどの読取り専用ドキュメントは、インポートに含まれません。

構文

importWSMArchive(archive,[map=None],[generateMapFile='false'])

引数

定義

archive

アーカイブ・ファイルの名前。

map=None

省略可能。物理情報をソース環境からターゲット環境にマップする方法を記述するサンプル・マップ・ファイルの場所。generateMapFile引数をtrueに設定することで新しいマップ・ファイルを生成できます。

generateMapFile引数をtrueに設定しないでマップ・ファイルを指定し、そのファイルが存在しない場合、操作は失敗し、エラーが表示されます。

generateMapFile=false

省略可能。map引数で指定した場所にサンプル・マップ・ファイルを作成するかどうかを指定します。この引数をtrueに設定すると、どのドキュメントもインポートされません。デフォルトは、falseです。

ファイルが作成された後に、任意のテキスト・エディタを使用して編集できます。attachTo値は、更新して新しい環境に対応させることができます。ドキュメント名に対してマッピングの更新が不要な場合は、そのエントリを削除するか、文字#を使用してコメント化することができます。

注意: リポジトリへのドキュメントのインポート時には、OWSMによりattachTo値のみが検証されます。値が無効な場合、ポリシー・セットは無効化されます。マップ・ファイル内の他のテキストは検証されません。

例

次の例では、リポジトリ・インポート・セッションを示します。

最初の例では、policies.zipファイルのコンテンツがリポジトリにインポートされます。

wls:/wls-domain/serverConfig>importWSMArchive("/tmp/policies.zip")

この例では、generateMapFile引数を使用してマップ・ファイルを生成します。

wls:/wls-domain/serverConfig>importWSMArchive("./export/some_global_with_noreference_2', map="./export/some_global_with_noreference_2_map', generateMapFile=true)

生成されたマップ・ファイルの例は次のとおりです:

This is an auto generated override file containing the document names given in
the archive file and their corresponding attachTo values. The attachTo value can
be updated according to the new environment details. If there is no update
required for any document name,that entry may be either deleted or commented
using the character ("#")

[Resource Scope Mappings
]

sca_component_add_1=Composite("*Async*")

sca_reference_add_1=Composite("*Basic_SOA_Client*")

sca_reference_no=Server("*")

sca_service_add_1=Composite("*Basic_SOA_service")

web_callback_add_1=Application("*")
web_client_add_1=Module("*")
web_reference_add_1=Domain("*")
web_service_add_1=Domain("*domain*") and Server("*soa*") and Application("*ADF*")
ws_service_no_1=Server("*Admin*")

この例では、生成されたマップ・ファイル/some_global_with_noreference_2_mapを使用してドキュメントをインポートする方法を示します。

wls:/wls-domain/serverConfig>importWSMArchive('../export/export_all', 'export_all_map')

3.9.6 migrateWSMPMRoles

コマンド・カテゴリ: OWSMリポジトリ管理

WLSTでの使用: オンライン

説明

カスタム・ロールおよびポリシーをPlan.xmlファイルからwsm-pm.earポリシー・ストアに移行します。Plan.xmlファイルがデフォルト・セキュリティのオーバーライドに使用されない場合、このコマンドはwsm-pm.earポリシー・ストアを移行しません。

構文

migrateWSMPMRoles(domain)

引数

説明

domain

wsm-pmアプリケーションが構成されているドメイン・ホームへの絶対パス。

例

次の例では、カスタム・ロールおよびポリシーをPlan.xmlファイルから'/WLS/myDomainにあるwsm-pm.earポリシー・ストアに移行します。

wls:/wls-domain/serverConfig> migrateWSMPMRoles('/WLS/myDomain')

3.9.7 migrateWSMAttachments

コマンド・カテゴリ: OWSMリポジトリ管理

WLSTでの使用: オンライン

説明

外部グローバル・ポリシー・アタッチメントと等しい直接(ローカル)ポリシー・アタッチメントを移行します。移行しない場合は現在のドメインで各ポリシー・サブジェクトにアタッチされます。強制的に移行するか、移行の前に確認のプロンプトを毎回表示するか、実行される移行を単に一覧表示するのかを指定できます。直接ポリシー・アタッチメントのURIがグローバル・ポリシー・アタッチメントで提供されるものと同じで、スコープが設定された構成オーバーライドがない場合は、直接ポリシー・アタッチメントは同一です。

注意:

スコープのないオーバーライドを含むダイレクト・アタッチメントは移行されますが、スコープのあるオーバーライドを含むアタッチメントは移行されません。これは、migrateAttachments()コマンドを実行した後、いくつかのポリシーはグローバルにアタッチされていても、すべてのサブジェクトに対するポリシーの施行が変わらないためです。

強制の場合でもプロンプトが表示される場合でも、移行された各直接ポリシー・アタッチメントが一覧表示されます。この出力では、変更されたポリシー・サブジェクト、同一のポリシー参照のURI、および直接アタッチメントを重複させたグローバル・ポリシー・アタッチメント・ドキュメントの名前が特定されます。

構文

migrateWSMAttachments([mode='prompt'])

引数

定義

mode

移行可能な各ポリシー・アタッチメントに対して実行されるアクション。有効なオプションは次のとおりです。

- force - プロンプトが表示されることなく、等しいポリシー・アタッチメントがすべて自動的に移行されます。

- preview - 移行可能なすべてのポリシー・アタッチメントが一覧表示されますが、移行は実施されません。

- prompt - 各ポリシー・アタッチメントの移行前にユーザーの確認を求められます。

モードを指定しない場合、この引数はデフォルトでpromptモードになります。

例

次の例では、リポジトリ・アタッチメント移行モードの使用方法を示します。

wls:/wls-domain/serverConfig>migrateWSMAttachments()
wls:/wls-domain/serverConfig>migrateWSMAttachments('force')
wls:/wls-domain/serverConfig>migrateWSMAttachments('preview')
wls:/wls-domain/serverConfig>migrateWSMAttachments('prompt')

3.9.8 resetWSMPolicyRepository

注意:

このコマンドは非推奨になりました。「resetWSMRepository」に記載されているとおり、resetWSMRepositoryコマンドを使用することをお薦めします。次の例に、resetWSMRepositoryコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> resetWSMPolicyRepository()

12cリリース:

wls:/jrfServer_domain/serverConfig> resetWSMRepository()

コマンド・カテゴリ: OWSMリポジトリ管理

WLSTでの使用: オンライン

説明

OWSMリポジトリ内に格納されている既存のポリシー・ストアを削除して、Oracle Fusion Middlewareソフトウェアの新しいインストールで提供される事前定義ポリシーの最新セットでリフレッシュします。clearStore引数を使用して、新しい事前定義ポリシーをロードする前に、カスタム・ユーザー・ポリシーを含むすべてのポリシーをOWSMリポジトリから削除するかどうかを指定できます。

構文

resetWSMPolicyRepository([clearStore='false'])

引数

定義

clearStore='false'

削除するポリシー・セット。有効な値は次のとおりです。

- true - リポジトリ内の、カスタム・ユーザー・ポリシーを含むすべてのポリシーが削除されます。

- false - オラクル社によって提供される事前定義済ポリシーのみが削除されます。デフォルトは、falseです。

例

次の例では、リポジトリ内のすべてのポリシーが、ユーザー・ポリシーも含めて削除され、現在の製品インストールで提供される事前定義済ポリシーが追加されます。

wls:/wls-domain/serverConfig>resetWSMPolicyRepository(true)

注意:

これらのスクリプト・ツールで使用されているPythonのバージョンはブール型がサポートされていない可能性があるため、wsadminおよびojbstでブール型を渡すには、整数値0 (false)または1 (true)を使用してください。

3.9.9 resetWSMRepository

コマンド・カテゴリ: OWSMリポジトリ管理

WLSTでの使用: オンライン

説明

リポジトリ内に格納されている既存のポリシー・ストアを削除して、Oracle Fusion Middlewareソフトウェアの最新インストールで提供される事前定義ポリシーの現在のセットでリフレッシュします。clearStore引数を使用して、新しい事前定義ポリシーをロードする前に、カスタム・ユーザー・ポリシーを含むすべてのポリシーをリポジトリから削除するかどうかを指定できます。

注意:
これらのコマンドは、事前定義ポリシーおよびアサーション・テンプレートのバージョン番号も更新します。

構文

resetWSMRepository([clearStore='false'])

引数

定義

clearStore='false'

削除するポリシー・セット。有効な値は次のとおりです。

- true - リポジトリ内の、カスタム・ユーザー・ポリシーを含むすべてのポリシーが削除されます。その後、事前定義ドキュメントの新しいセットでリポジトリが再作成されます。

- false - オラクル社によって提供される事前定義済ポリシーのみが削除されます。このオプションの使用時には、カスタム・ドキュメントは削除されません。その後、事前定義ドキュメントの新しいセットでリポジトリが再作成されます。デフォルトは、falseです。

例

次の例では、リポジトリ内のすべてのポリシーが、ユーザー・ポリシーも含めて削除され、現在の製品インストールで提供される事前定義済ポリシーが追加されます。

wls:/wls-domain/serverConfig>resetWSMRepository(true)

3.9.10 upgradeWSMPolicyRepository

注意:

このコマンドは非推奨になりました。「upgradeWSMRepository」に記載されているとおり、upgradeWSMRepositoryコマンドを使用することをお薦めします。次の例に、upgradeWSMRepositoryコマンドを使用するための移行方法を示します。

11gリリース:

wls:/jrfServer_domain/serverConfig> upgradeWSMPolicyRepository()

12cリリース:

wls:/jrfServer_domain/serverConfig> upgradeWSMRepository()

コマンド・カテゴリ: OWSMリポジトリ管理

WLSTでの使用: オンライン

説明

OWSMリポジトリ内に格納されているOWSM事前定義ポリシーを、Oracle Fusion Middlewareソフトウェアの最新のインストールで提供される任意の新しい事前定義ポリシーでアップグレードします。リポジトリが空である場合、インストールに含まれている事前定義済ポリシーのすべてがリポジトリにロードされます。

このコマンドで、リポジトリ内の既存の事前定義済ポリシーおよびユーザー定義カスタム・ポリシーが削除されることはありません。事前定義済ポリシーが後続のリリースで変更されたか廃止された場合、次のいずれかになります。

- 廃止されたポリシーの場合、廃止されたポリシーを一覧表示するメッセージが表示されます。この場合、それらのポリシーの参照を停止し、Oracle Enterprise Managerを使用してそれらを削除することをお薦めします。

- 後続のリリースで変更されたポリシーの場合、変更されたポリシーを一覧表示するメッセージが表示されます。この場合、Oracle Enterprise Managerを使用してそれらのポリシーの最新バージョンをインポートすることをお薦めします。

構文

upgradeWSMPolicyRepository()

例

次の例では、最新のリリースで提供されているポリシーで、既存のインストールをアップグレードします。

wls:/wls-domain/serverConfig>upgradeWSMPolicyRepository()

3.9.11 upgradeWSMRepository

コマンド・カテゴリ: OWSMリポジトリ管理

WLSTでの使用: オンライン

説明

リポジトリ内に格納されているOWSM事前定義ポリシーを、Oracle Fusion Middlewareソフトウェアの最新のインストールで提供される任意の新しい事前定義ポリシーでアップグレードします。リポジトリが空である場合、インストールに含まれている事前定義済ポリシーのすべてがリポジトリにロードされます。

このコマンドで、リポジトリ内の既存の事前定義済ポリシーおよびユーザー定義カスタム・ポリシーが削除されることはありません。事前定義済ポリシーが後続のリリースで変更されたか廃止された場合、次のいずれかになります。

- 廃止されたポリシーの場合、廃止されたポリシーを一覧表示するメッセージが表示されます。この場合、それらのポリシーの参照を停止し、Oracle Enterprise Managerを使用してそれらを削除することをお薦めします。

- 後続のリリースで変更されたポリシーの場合、変更されたポリシーを一覧表示するメッセージが表示されます。この場合、Oracle Enterprise Managerを使用してそれらのポリシーの最新バージョンをインポートすることをお薦めします。

構文

upgradeWSMRepository()

例

次の例では、最新のリリースで提供されているポリシーで、既存のインストールをアップグレードします。

wls:/wls-domain/serverConfig>upgradeWSMRepository()

3.10 トークン発行者信頼構成のコマンド

表3-12にリストされているWLSTコマンドを使用して、信頼できる発行者、信頼できる識別名(DN)リストおよび信頼できるDNのトークン属性ルールを表示および定義します。

WLSTを使用してトークン発行者信頼ドキュメントを作成、変更および削除する場合、セッションのコンテキストでコマンドを実行する必要があります。各セッションは、単一の信頼ドキュメントにのみ適用されます。

これらのコマンドの使用の詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のWLSTを使用したSAML信頼発行者、DNリストおよびトークン属性ルールの構成に関する項を参照してください。

注意:

この項のコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

この項で説明するWLSTコマンドのヘルプを表示するには、実行中のサーバー・インスタンスに接続し、help('wsmManage')と入力します。

help('wsmManage')を使用すると、サポートされているトークン・タイプとしてJWT信頼発行者が表示されます。

表3-12 Webサービスのトークン発行者信頼コマンド

使用するコマンド

目的

WLSTでの使用

createWSMTokenIssuerTrustDocument

指定された名前を使用して新しいトークン発行者信頼ドキュメントを作成します。

オンライン

deleteWSMTokenIssuerTrust

発行者に対するエントリを、そこに含まれるDNリストも含めて削除します。

オンライン

deleteWSMTokenIssuerTrustAttributeRule

信頼できるDNに関連付けられているトークン属性ルールを削除します。

オンライン

deleteWSMTokenIssuerTrustDocument

name引数で指定されたトークン発行者信頼ドキュメントをリポジトリから削除します。

オンライン

displayWSMTokenIssuerTrust

指定された発行者に関連付けられているDNリストの名前を表示します。

オンライン

exportWSMTokenIssuerTrustMetadata

信頼できる発行者、関連付けられているDNおよびトークン属性ルールをエクスポートします。

オンライン

importWSMTokenIssuerTrustMetadata

信頼できる発行者、関連付けられているDNおよびトークン属性ルールをインポートします。

オンライン

listWSMTokenIssuerTrustDocuments

リポジトリ内のトークン発行者信頼ドキュメントをリストします。

オンライン

revokeWSMTokenIssuerTrust

信頼できる発行者、関連付けられているDNおよびトークン属性ルールを削除します。

オンライン

selectWSMTokenIssuerTrustDocument

セッション内で変更する、name引数で特定されるトークン発行者信頼ドキュメントを選択します。

オンライン

setWSMTokenIssuerTrust

DNリストを持つ信頼できるトークン発行者を指定します。

オンライン

setWSMTokenIssuerTrustAttributeFilter

指定されたトークン署名証明書DNのトークン属性ルールを、追加、削除または更新します。

オンライン

setWSMTokenIssuerTrustAttributeMapping

マッピングを設定して、信頼できるDNの属性値をローカル・ユーザー属性値およびマップされたユーザー属性にマップします。

オンライン

setWSMTokenIssuerTrustDisplayName

セッションで現在選択されているトークン発行者信頼ドキュメントの表示名を設定またはリセットします。

オンライン

3.10.1 createWSMTokenIssuerTrustDocument

注意:

このコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: トークン発行者信頼構成

WLSTでの使用: オンライン

説明

セッション内で、指定された名前を使用して新しいトークン発行者信頼ドキュメントを作成します。

トークン発行者信頼ドキュメントを作成または変更する前に、セッションを開始(beginWSMSession)する必要があります。現在のセッションがないか、既存の変更プロセスがすでに存在する場合は、エラーが表示されます。

このコマンドの使用方法の詳細は、『Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』のWLSTを使用したSAML信頼発行者、DNリストおよびトークン属性ルールの構成に関する項を参照してください。

構文

createWSMTokenIssuerTrustDocument(name, displayName)

引数

定義

name

作成するドキュメントの名前。名前が指定されない場合は、エラーがスローされます。

displayName

省略可能。ドキュメントの表示名。

例

次の例では、tokenissuertrustWLSbase_domainという名前の信頼ドキュメントを、wls_domain Trust Documentという表示名で作成します。2番目の例では、表示名は指定されていません。

wls:/wls-domain/serverConfig> createWSMTokenIssuerTrustDocument("tokenissuertrustWLSbase_domain","wls_domain Trust Document")
wls:/wls-domain/serverConfig> createWSMTokenIssuerTrustDocument("tokenissuertrustWLSbase_domain")

3.10.2 deleteWSMTokenIssuerTrust

注意:

このコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: トークン発行者信頼構成

WLSTでの使用: オンライン

説明

セッション内で、指定された発行者のタイプ(dns.hok、dns.svまたはdns.jwtなど)と一致する信頼できるすべてのキー識別子のリストが削除されます。この発行者は、変更するためにセッションで選択されたトークン発行者信頼ドキュメントに存在している必要があります。信頼できるキー識別子が存在しない場合は、発行者自体が削除されます。

発行者の信頼できるキー識別子の指定されたリストを削除するには、selectWSMTokenIssuerTrustDocumentを使用します。

このコマンドを実行する前に、セッションを開始(beginWSMSession)して、変更を行うためにトークン発行者信頼ドキュメントを選択する必要があります。現在のセッションがないか、既存の変更プロセスがすでに存在する場合は、エラーが表示されます。

デフォルトのトークン発行者信頼ドキュメントは変更できません。

構文

deleteWSMTokenIssuerTrust(type, issuer)

引数

定義

type

削除する発行者のタイプ(dns.hok、dns.svまたはdns.jwtなど)。

issuer

信頼できるDNリストを削除する発行者の名前。

例

次の例では、発行者www.yourCompany.comおよび、その発行者の信頼できるSAML送信者保証クライアント・リストdns.sv内のDNリストを削除します。

wls:/wls-domain/serverConfig> deleteWSMTokenIssuerTrust('dns.sv', 'www.yourCompany.com')

3.10.3 deleteWSMTokenIssuerTrustAttributeRule

注意:

このコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: トークン発行者信頼構成

WLSTでの使用: オンライン

説明

信頼できるDNに関連付けられているトークン属性ルールをトークン発行者信頼ドキュメントから削除します。

属性のフィルタ値のリストのみを削除するには、setWSMTokenIssuerTrustAttributeFilterコマンドを使用します。

このコマンドを実行する前に、セッションを開始(beginWSMSession)して、変更を行うためにトークン発行者信頼ドキュメントを選択する必要があります。現在のセッションがないか、既存の変更プロセスがすでに存在する場合は、エラーが表示されます。

構文

deleteWSMTokenIssuerTrustAttributeRule(dn)

引数

説明

dn

削除するルールを特定するトークン署名証明書のDN。

例

次の例では、信頼できるDN 'CN=weblogic, OU=Orakey Test Encryption Purposes Only, O=Oracle, C=USに関連付けられているトークン属性ルールが削除されます。

wls:/wls-domain/serverConfig> deleteWSMTokenIssuerTrustAttributeRule('CN=weblogic, OU=Orakey Test Encryption Purposes Only, O=Oracle, C=US')

3.10.4 deleteWSMTokenIssuerTrustDocument

注意:

このコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: トークン発行者信頼構成

WLSTでの使用: オンライン

説明

name引数で指定されたトークン発行者信頼ドキュメントをリポジトリから削除します。デフォルトのトークン発行者信頼ドキュメントは削除できません。

構文

deleteWSMTokenIssuerTrustDocument (name)

引数

定義

name

作成するトークン発行者信頼ドキュメントの名前。

例

次の例では、トークン発行者信頼ドキュメントtokenissuertrustWLSbase_domainを削除します。

wls:/wls-domain/serverConfig> deleteWSMTokenIssuerTrustDocument('tokenissuertrustWLSbase_domain')

3.10.5 displayWSMTokenIssuerTrust

注意:

このコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: トークン発行者信頼構成

WLSTでの使用: オンライン

説明

指定されたタイプ(dns.hok、dns.svまたはdns.jwtなど)、およびissuer名と一致する信頼できるすべてのキー識別子のリストが表示されます。

このコマンドを実行する前に、セッションを開始(beginWSMSession)して、変更を行うためにトークン発行者信頼ドキュメントを選択する必要があります。現在のセッションがないか、既存の変更プロセスがすでに存在する場合は、エラーが表示されます。

構文

displayWSMTokenIssuerTrust(type, issuer=None)

引数

定義

type

発行者の表示される信頼できるキー識別子のタイプ。たとえば、dns.hok、dns.svまたはdns.jwtなどです。

issuer

省略可能。信頼できるキー識別子のリストを表示する信頼できる発行者の名前。発行者名を指定しないと、指定されたタイプのすべての信頼できる発行者がリストされます。

例

次の例では、信頼できる発行者www.example.comのDNリストを表示します。

wls:/wls-domain/serverConfig> displayWSMTokenIssuerTrust('dns.sv', 'www.example.com')

3.10.6 exportWSMTokenIssuerTrustMetadata

注意:

このコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: トークン発行者信頼構成

WLSTでの使用: オンライン

説明

すべての信頼できる発行者の信頼構成(発行者、DNおよびトークン属性ルール)をエクスポートします。構成は、指定された場所で識別されるXMLファイルにエクスポートされます。除外リストに指定された発行者の構成はエクスポートされません。引数を渡さない場合、すべての信頼できる発行者の信頼構成がエクスポートされます。

構文

exportWSMTokenIssuerTrustMetadata(trustFile,excludeIssuers=None)

引数

定義

trustFile

エクスポートされたメタデータが格納されるファイルの場所。

excludeIssuers

省略可能。信頼メタデータがエクスポートされない発行者のリスト。

例

次の例に、exportWSMTokenIssuerTrustMetadataコマンドを示します。

exportWSMTokenIssuerTrustMetadata(trustFile='/tmp/trustData.xml',
excludeIssuers=['www.example.com','www.myissuer.com'])

exportWSMTokenIssuerTrustMetadata('/tmp/trustData.xml',['www.example.com'])

exportWSMTokenIssuerTrustMetadata(trustFile='/tmp/trustData.xml')

3.10.7 importWSMTokenIssuerTrustMetadata

注意:

このコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: トークン発行者信頼構成

WLSTでの使用: オンライン

説明

すべての信頼できる発行者の信頼構成(発行者、DNおよびトークン属性ルール)をインポートします。構成は、指定されたXMLファイルからインポートされます。

構文

importWSMTokenIssuerTrustMetadata(trustFile)

引数

定義

trustFile

構成がインポートされるファイルの場所。

例

次の例に、importWSMTokenIssuerTrustMetadataコマンドを示します。

importWSMTokenIssuerTrustMetadata(trustFile='/tmp/trustData.xml')

importWSMTokenIssuerTrustMetadata('/tmp/trustData.xml')

3.10.8 listWSMTokenIssuerTrustDocuments

注意:

このコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: トークン発行者信頼構成

WLSTでの使用: オンライン

説明

引数を指定しないで使用すると、リポジトリ内のすべてのトークン発行者信頼ドキュメントがコマンドによってリストされます。detail引数をtrueに設定すると、ドキュメントの表示名およびステータスも表示されます。

ワイルドカード文字(*)を他の文字と組み合せて使用できます。name引数にワイルドカード文字が指定されない場合、name引数と正確に一致するドキュメントが表示されます。detail引数をtrueに設定すると、ドキュメントの内容がリストされます。

このコマンドは、セッションの内および外で実行できます。

構文

listWSMTokenIssuerTrustDocuments(name=None, detail='false')

引数

定義

name

省略可能。トークン発行者信頼ドキュメントの名前。この引数にワイルドカードを使用できます。

detail

省略可能。リクエストしたドキュメントの詳細をリストします。デフォルトは、falseです。

例

次の例では、トークン発行者信頼ドキュメントtokenissuertrustWLSbase_domainを削除します。

wls:/wls-domain/serverConfig> listWSMTokenIssuerTrustDocuments(detail='true')

3.10.9 revokeWSMTokenIssuerTrust

注意:

このコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: トークン発行者信頼構成

WLSTでの使用: オンライン

説明

信頼できる発行者、関連付けられているDNおよびトークン属性ルールを削除します。除外リストで指定された発行者は削除されません。引数が渡されない場合、すべての信頼できる発行者と、関連付けられている構成が削除されます。

構文

revokeWSMTokenIssuerTrust(excludeIssuers=None)

引数

定義

excludeIssuers

信頼構成が削除されない発行者のオプション・リスト。

例

次の例に、revokeWSMTokenIssuerTrustコマンドを示します。

revokeWSMTokenIssuerTrust(excludeIssuers=['www.example.com','www.issuer.com'])

revokeWSMTokenIssuerTrust(['www.example.com','www.issuer.com'])

revokeWSMTokenIssuerTrust()

3.10.10 selectWSMTokenIssuerTrustDocument

注意:

このコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: トークン発行者信頼構成

WLSTでの使用: オンライン

説明

セッション内で変更する、name引数で特定されるトークン発行者信頼ドキュメントを選択します。この名前は、ドキュメント内のname属性の値と一致する必要があります。

このコマンドを実行する前に、セッションを開始(beginWSMSession)する必要があります。現在のセッションがないか、既存の変更プロセスがすでに存在する場合は、エラーが表示されます。

デフォルトのトークン発行者信頼ドキュメントは変更できません。

構文

selectWSMTokenIssuerTrustDocument(name)

引数

定義

name

セッション内で変更するドキュメントの名前。名前が指定されない場合は、エラーがスローされます。

例

次の例では、tokenissuertrustWLSbase_domainドキュメントを変更のために選択します。

wls:/wls-domain/serverConfig> selectWSMTokenIssuerTrustDocument('tokenissuertrustWLSbase_domain')

3.10.11 setWSMTokenIssuerTrust

注意:

このコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: トークン発行者信頼構成

WLSTでの使用: オンライン

説明

DNリストを持つ信頼できるトークン発行者を指定します。このコマンドは次のように動作します。

- 指定されたタイプに対して信頼できる発行者がすでに存在する場合、trustedKeys引数にDNリストまたは別名を指定すると、以前のリストが新しいリストに置換されます。trustedDNs引数に空集合([])を入力すると、発行者からDN値のリストが削除されます。

- 指定されたタイプに対して信頼できる発行者が存在しない場合、trustedKeys引数に値を指定すると、関連するDNリストで発行者が作成されます。trustedKeys引数を設定しない場合は、空のDNリストで新しい発行者が作成されます。

このコマンドを実行する前に、セッションを開始(beginWSMSession)して、変更を行うためにトークン発行者信頼ドキュメントを選択する必要があります。現在のセッションがないか、既存の変更プロセスがすでに存在する場合は、エラーが表示されます。

デフォルトのトークン発行者信頼ドキュメントは変更できません。

構文

setWSMTokenIssuerTrust(type, issuer, [trustedKeys]=None)

引数

定義

type

発行者によって発行されたトークンのタイプおよび発行者による証明書の署名方法は、信頼できるキーで識別されます。次のタイプがサポートされています。

- dns.sv—発行者のトークン・タイプはSAML SVで、信頼できるキー識別子のタイプはX509証明書DNです。

- dns.hok—発行者のトークン・タイプはSAML HOKまたはBearerで、信頼できるキー識別子のタイプはX509証明書DNです。

- dns.jwt—発行者のトークン・タイプはJWTで、信頼できるキー識別子のタイプはX509証明書DNです。

- dns.alias.sv—発行者のトークン・タイプはSAML SVで、キー・ストア内の発行者署名証明書のX509証明書の別名は信頼できるキー識別子のタイプに使用されます。

- dns.alias.hok—発行者のトークン・タイプはSAML HOKまたはBearerで、キー・ストア内の発行者署名証明書のX509証明書の別名は信頼できるキー識別子のタイプに使用されます。

issuer

信頼できる発行者の名前、たとえば、www.example.comです。

trustedKeys

省略可能。指定された発行者に設定する信頼できるキー識別子値のリスト。

例

次の例では、www.yourcompany.comを信頼できる発行者として設定し、DNリストは指定しません。

wls:/wls-domain/serverConfig> setWSMTokenIssuerTrust('dns.sv', 'www,yourcompany.com', [])

次の例では、名前'CN=orcladmin, OU=Doc, O=Oracle, C=US'を、信頼できる発行者www.example.comのDNリストdns.svに追加します。

wls:/wls-domain/serverConfig> setWSMTokenIssuerTrust('dns.sv', 'www.example.com', [['CN=weblogic, OU=Orakey Test Encryption Purposes Only, O=Oracle, C=US',  'CN=orcladmin, OU=Doc, O=Oracle, C=US'])

次の例では、DNリストdns.sv内のDN値のリストを、信頼できる発行者www.example.comから削除します。

wls:/wls-domain/serverConfig> setWSMTokenIssuerTrust('dns.sv', 'www.example.com', [])

次の例では、別名orakeyを、信頼できる発行者www.example.comのSAML SVトークン・タイプのX509証明書の別名として指定します。

wls:/wls-domain/serverConfig> setWSMTokenIssuerTrust('dn.alias.sv', 'www.example.com', ['orakey'])

3.10.12 setWSMTokenIssuerTrustAttributeFilter

注意:

このコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: トークン発行者信頼構成

WLSTでの使用: オンライン

説明

指定されたトークン署名証明書DNのトークン属性ルールを、追加、削除または更新します。

ルールは2部構成で、名前IDと、署名証明書のDNがアサートできるユーザー属性の属性部分で構成されます。名前IDおよび属性には、複数の値パターンを持つフィルタを含めることができます。

このコマンドは次のように動作します。

- attr-name引数で指定される属性がフィルタ値のリストとともにすでに存在する場合、filters引数で新しい値のリストを指定すると、以前のリストが新しいリストに置換されます。filters引数に空集合([])を入力すると、既存のフィルタ値のリストが削除されます。

- attr-name引数で指定される属性が存在しない場合、filters引数で値のリストを指定すると、指定されたフィルタ値で属性が作成され、ドキュメントに追加されます。filters引数の値を指定しない場合は、エラーがスローされます。

このコマンドを実行する前に、セッションを開始(beginWSMSession)して、変更を行うためにトークン発行者信頼ドキュメントを選択する必要があります。現在のセッションがないか、既存の変更プロセスがすでに存在する場合は、エラーが表示されます。

注意:

まずsetWSMTokenIssuerTrustコマンドを使用して、発行者に対して信頼できるDN名のリストを構成する必要があります。

構文

setWSMTokenIssuerTrustAttributeFilter(dn, attr-name, filters)

引数

定義

dn

トークン署名証明書のDN。

attr-name

アサートする属性の名前。次のように値を指定できます。

- name-id: サブジェクト名IDをアサートします。

filters

省略可能。属性のフィルタのリスト。リストは、['value1', 'value2', 'value3, ...という書式です。各値には、厳密な名前またはワイルドカード文字「*」を使用した名前パターンを指定できます。

attr-name引数に対してname-idが選択されている場合、通過するためには、受信SAMLアサーションのサブジェクト名IDの値が指定されたいずれかの値と一致する必要があります。値が指定されていない場合、サブジェクト名IDの任意の値が使用されます。

attr-name引数にuser.tenent.nameを選択した場合、リクエスト・メッセージ内またはシステム環境のユーザー・テナント名の値が、アサートされた値に対して検証されます。

例

次の例では、信頼できるDNweblogicに対する信頼できるユーザーとして、名前IDyourTrustedUserが設定されています。

wls:/wls-domain/serverConfig> setWSMTokenIssuerTrustAttributeFilter('CN=weblogic, OU=Orakey Test Encryption Purposes Only, O=Oracle, C=US','name-id', ['yourTrustedUser'])

次の例では、信頼できるDNweblogicに対する信頼できるユーザーのリストに、名前IDjdoeが追加されています。

wls:/wls-domain/serverConfig> setWSMTokenIssuerTrustAttributeFilter('CN=weblogic, OU=Orakey Test Encryption Purposes Only, O=Oracle, C=US','name-id', ['yourTrustedUser', 'jdoe'])

次の例では、信頼できるDNweblogicに対する信頼できるユーザーのリストが削除されています。

wls:/wls-domain/serverConfig> setWSMTokenIssuerTrustAttributeFilter('CN=weblogic, OU=Orakey Test Encryption Purposes Only, O=Oracle, C=US', 'name-id', [])

3.10.13 setWSMTokenIssuerTrustAttributeMapping

注意:

このコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: トークン発行者信頼構成

WLSTでの使用: オンライン

説明

信頼できるトークン発行者の信頼できるDNリストのDNに対して、このコマンドは、attrName引数で指定された属性(たとえば、name-idなど)のマッピングを設定します。ユーザー属性引数はオプションで、対応するローカル・ユーザー属性を示します。ユーザー・マッピング属性もオプションで、ユーザーを認証するためにシステムで使用されるユーザー属性を示します。

構文

setWSMTokenIssuerTrustAttributeMapping(dn,attrName,userAttribute=None, userMappingAttribute=None)

引数

定義

dn

変更が行われるトークン属性ルールの識別子としてのDN。

attrName

マッピングが適用されるユーザー属性の名前。

userAttribute

属性の値に対応するローカル・ユーザー属性のオプションの名前。

userMappingAttribute

マップ先のローカル・ユーザー属性のオプションの名前。

例

次の例に、setWSMTokenIssuerTrustAttributeMappingコマンドを示します。

setWSMTokenIssuerTrustAttributeMapping('CN=weblogic, OU=Orakey, O=Oracle, C=US', 'name-id', 'mail', 'uid')

setWSMTokenIssuerTrustAttributeMapping('CN=weblogic, OU=Orakey, O=Oracle, C=US','name-id')

3.10.14 setWSMTokenIssuerTrustDisplayName

注意:

このコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: トークン発行者信頼構成

WLSTでの使用: オンライン

説明

セッションで現在選択されているトークン発行者信頼ドキュメントの表示名を設定またはリセットします。

トークン発行者信頼ドキュメントを作成または変更する前に、セッションを開始(beginWSMSession)する必要があります。現在のセッションがないか、既存の変更プロセスがすでに存在する場合は、エラーが表示されます。

構文

setWSMTokenIssuerTrustDisplayName("displayName")

引数

定義

displayName

セッション内で、変更のために現在選択されているドキュメントの表示名として設定される名前。

例

次の例では、変更される信頼ドキュメントの表示名をTest Documentに設定します。

wls:/wls-domain/serverConfig> setWSMTokenIssuerTrustDisplayName("Test Document")

3.11 安全な会話セッション管理コマンド

「WS-SecureConversationアーキテクチャ」で説明したように、OWSMは計算されたセッションIDに基づいて、クライアントとサーバーの安全な会話セッション情報を保持します。OWSM (内部セッション・メカニズムを介して)は実行時にメッセージごとにセッションIDを計算し、1つのセッションに1つ以上のリクエストを関連付けます。

セッション管理コマンドは、特定のクライアントでセッションが不要になったことがわかったときに、サーバー上のリソースを解放する方法を提供します。

セッションは、同一クライアントからのすべてのリクエストに再利用されます。セッションが手動で削除された場合、新しいセッションが作成されます。セッションが手動で解放されない場合、JVMをホストするサーバーが次回再起動されるときに解放されます。

表3-13にリストされているWLSTコマンドを使用して、セッションを管理します。

これらのコマンドの使用の詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』の安全な会話セッションの管理に関する項を参照してください。

表3.13 安全な会話セッション管理コマンド

使用するコマンド

目的

WLSTでの使用

getWebServiceSessionInfo

指定したアクティブ・セッションの詳細を表示します。

オンライン

listWebServiceSessionNames

セッション・マネージャに対して現在アクティブなセッションをリストします。

オンライン

listWebServiceSessionNamesForKey

指定したキーと値のペアについて、セッション・マネージャに対してアクティブなセッションをリストします。

オンライン

removeWebServiceSession

アクティブ・セッションを削除してストア内のセッションをクリアします。

オンライン

3.11.1 getWebServiceSessionInfo

コマンド・カテゴリ: 安全な会話セッション管理

WLSTでの使用: オンライン

説明

指定したセッション・オブジェクトを取得します。sessionNameがlistWebServiceSessionNames()によって返されます。

返されたセッション名は、getWebServiceSessionInfo(String)およびremoveWebServiceSession(String)コマンドへの以降の呼び出しで名前パラメータとして使用するのに適しています。

このコマンドが成功するには、ドメイン内のすべてのWebLogic Serverインスタンスが実行されている必要があります。セッションのスコープは、現在の永続性プロバイダです。

これらのコマンドの使用の詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』の安全な会話セッションの管理に関する項を参照してください。

構文

getWebServiceSessionInfo ("sessionName")

引数

定義

sessionName

情報が表示されるアクティブ・セッションの名前。sessionNameがlistWebServiceSessionNames()によって返されます。

例

次の例では、215d0d4a5ebbc3fec662f46adedc5bc74ecbc87bという名前のセッションに関する情報が返されます。

wls:/base_domain/serverConfig>
getWebServiceSessionInfo('215d0d4a5ebbc3fec662f46adedc5bc74ecbc87b')
Name: 215d0d4a5ebbc3fec662f46adedc5bc74ecbc87b
Creation time: Mon Nov 04 17:47:39 PST 2013
Last update time: Mon Nov 04 17:47:42 PST 2013
Expiration time: Mon Nov 04 18:17:41 PST 2013
Key info: [oracle.wsm.security.secconv.util.property.SCT, 0x0000014225F1A1260AE4F30351FD1544DC10ED14201988C8CFEDFDBE8E0E4B09]

3.11.2 listWebServiceSessionNames

コマンド・カテゴリ: 安全な会話セッション管理

WLSTでの使用: オンライン

説明

現在の永続性プロバイダについて、ドメイン内で表示可能なすべてのアクティブ・セッションの名前をリストします。返されるリストは、表示可能なセッション・インスタンスのスナップショットで、変更されることがあります。

返された名前は、getWebServiceSessionInfo()およびremoveWebServiceSession()コマンドへの以降の呼び出しで名前パラメータとして使用するのに適しています。

このコマンドが成功するには、ドメイン内のすべてのWebLogic Serverインスタンスが実行されている必要があります。セッションのスコープは、現在の永続性プロバイダです。

これらのコマンドの使用の詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』の安全な会話セッションの管理に関する項を参照してください。

構文

listWebServiceSessionNames()

例

次の例には、1つのアクティブ・セッションがあります。

wls:/base_domain/serverConfig> listWebServiceSessionNames()
215d0d4a5ebbc3fec662f46adedc5bc74ecbc87b

3.11.3 listWebServiceSessionNamesForKey

コマンド・カテゴリ: 安全な会話セッション管理

WLSTでの使用: オンライン

説明

名前keyNameおよび値keyValue. keyNameおよびkeyValueを持つすべてのセッションのリストが、getWebServiceSessionInfo()によって返されます。

返されたセッション名は、getWebServiceSessionInfo(String)およびremoveWebServiceSession(String)コマンドへの以降の呼び出しで名前パラメータとして使用するのに適しています。

このコマンドが成功するには、ドメイン内のすべてのWebLogic Serverインスタンスが実行されている必要があります。セッションのスコープは、現在の永続性プロバイダです。

これらのコマンドの使用の詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』の安全な会話セッションの管理に関する項を参照してください。

構文

listWebServiceSessionNamesForKey ("keyName", "keyValue")

引数

定義

keyName

セッション名をリストするキー名を指定する文字列。keyNameがgetWebServiceSessionInfo()によって返されます。

keyValue

セッション名をリストするキー値を指定する文字列。keyValueがgetWebServiceSessionInfo()によって返されます。

例

次の例には、値が0x0000014225F1A1260AE4F30351FD1544DC10ED14201988C8CFEDFDBE8E0E4B09のキー名oracle.wsm.security.secconv.util.property.SCTの1つのアクティブ・セッションがあります。

wls:/base_domain/serverConfig>
listWebServiceSessionNamesForKey('oracle.wsm.security.secconv.util.property.SCT',
'0x0000014225F1A1260AE4F30351FD1544DC10ED14201988C8CFEDFDBE8E0E4B09')
215d0d4a5ebbc3fec662f46adedc5bc74ecbc87b

3.11.4 removeWebServiceSession

コマンド・カテゴリ: 安全な会話セッション管理

WLSTでの使用: オンライン

説明

名前を指定してセッション・オブジェクトを削除します。sessionNameがlistWebServiceSessionNames()によって返されます。

このコマンドが成功するには、ドメイン内のすべてのWebLogic Serverインスタンスが実行されている必要があります。セッションのスコープは、現在の永続性プロバイダです。

これらのコマンドの使用の詳細は、『Oracle Fusion Middleware Oracle Web Services ManagerによるWebサービスの保護とポリシーの管理』の安全な会話セッションの管理に関する項を参照してください。

構文

removeWebServiceSession ("sessionName")

引数

定義

sessionName

削除するアクティブ・セッションの名前。sessionNameがlistWebServiceSessionNames()によって返されます。

例

次の例では、215d0d4a5ebbc3fec662f46adedc5bc74ecbc87bという名前のセッションが削除されます。

wls:/base_domain/serverConfig>
removeWebServiceSession('215d0d4a5ebbc3fec662f46adedc5bc74ecbc87b')

3.12 JKSキーストア構成コマンド

JKSキーストアの資格証明と証明書を表示および管理するには、表3-14にリストされているWLSTコマンドを使用します。

注意:

この項のコマンドは、Oracle Infrastructure Webサービスにのみ適用されます。

この項で説明するWLSTコマンドのヘルプを表示するには、実行中のサーバー・インスタンスに接続し、help('wsmManage')と入力します。

キーストアがKSSである場合、OPSSキーストア・コマンドを使用する必要があります。次のコマンド構文を使用して、関連するコマンドを表示できます。

svc = getOpssService(name='KeyStoreService')

svc.help()

表3-14 JKSキーストア構成コマンド

使用するコマンド

目的

WLSTでの使用

deleteWSMKeyStoreEntry

キーストアから単一のKeyStore.TrustedCertificateEntryエントリを削除します。

オンライン

deleteWSMKeyStoreEntries

除外リストで別名で識別されているものを除いて、キーストアからすべてのKeyStore.TrustedCertificateEntryエントリを削除します。

オンライン

displayWSMCertificate

別名でKeyStore.TrustedCertificateEntryが指定されている場合、ユーザーの証明書の内容を表す文字列を表示します。別名がKeyStore.PrivateKeyEntryで指定された証明書チェーンを参照している場合、チェーン内の証明書を表示します。

オンライン

exportWSMCertificate

指定された別名で示された秘密鍵に関連付けられた、信頼できる証明書または証明書チェーンを、指定された場所にエクスポートします。

オンライン

importWSMCertificate

指定された別名で示された秘密鍵に関連付けられた、信頼できる証明書または証明書チェーンをインポートします。Base64でエンコードされた証明書が、指定された場所からインポートされます。

オンライン

listWSMKeystoreAliases

キーストア内のすべての別名をリストします。

オンライン

3.12.1 deleteWSMKeyStoreEntry

注意:

このコマンドはOracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: JKSキーストア管理

WLSTでの使用: オンライン

説明

キーストアから単一のKeyStore.TrustedCertificateEntryエントリを削除します。keyStore.PrivateKeyEntryは削除できません。

構文

deleteWSMKeyStoreEntry(alias)

引数

説明

alias

削除される証明書の別名。

例

この例では、キーストア・エントリの別名testalias1がキーストアから削除されます。

wls:/base_domain/serverConfig> deleteWSMKeyStoreEntry('testalias')

Starting Operation deleteWSMKeyStoreEntry ...
Certificate for alias "testalias" successfully deleted.

3.12.2 deleteWSMKeyStoreEntries

注意:

このコマンドはOracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: JKSキーストア管理

WLSTでの使用: オンライン

説明

除外リストで別名で識別されているものを除いて、キーストアからすべてのKeyStore.TrustedCertificateEntryエントリを削除します。引数が渡されない場合、すべてのKeyStore.TrustedCertificateEntryエントリが削除されます。

構文

deleteWSMKeyStoreEntries(exclusionList=None)

引数

説明

exclusionList

省略可能。削除されない証明書の別名のリスト。

例

この例では、除外リストで指定された別名testaliasおよびtestalias2を除いて、すべてのキーストア・エントリが、キーストアから削除されます。

wls:/base_domain/serverConfig> deleteWSMKeyStoreEntries(['testalias', 'testalias2'])

Starting Operation deleteWSMKeyStoreEntries ...
Certificate(s) deleted successfully.

この例では、すべてのキーストア・エントリがキーストアから削除されます。

wls:/base_domain/serverConfig> deleteWSMKeyStoreEntries()

3.12.3 displayWSMCertificate

別名でKeyStore.TrustedCertificateEntryが指定されている場合、ユーザーの証明書の内容を表す文字列を表示します。別名がKeyStore.PrivateKeyEntryで指定された証明書チェーンを参照している場合、チェーン内の証明書を表示します。

注意:

このコマンドはOracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: JKSキーストア管理

WLSTでの使用: オンライン

説明

構文

displayWSMCertificate(alias)

引数

説明

alias

表示される証明書/証明書チェーンの別名。

例

この例では、信頼できる証明書orakeyの内容が表示されます。

wls:/base_domain/serverConfig>displayWSMCertificate('orakey')

Starting Operation displayWSMCertificate ...
[
Version: V3
Subject: CN=OWSM QA, OU=Fusion Middleware, O=Oracle, L=Redwood City, ST=CA, C=US
Signature Algorithm: SHA1withRSA, OID = 1.2.840.113549.1.1.5

Key:  Sun RSA public key, 1024 bits
modulus:
101336654071087305620295721341875459581727184852017960998615641847764412775989
046768838406911494435712364431883104460420101263455337490958825568587912620074
497379158835791101805994438262634259467352941329678718608662643461089403600239
418798937444529854556507844518713085827283731161032187719240566731105687269
public exponent: 65537
Validity: [From: Tue Apr 07 15:04:45 PDT 2009,
To: Thu Feb 14 14:04:45 PST 2019]
Issuer: CN=OWSM QA, OU=Fusion Middleware, O=Oracle, L=Redwood City, ST=CA, C=US
SerialNumber: [    49dbcdfd]
]
Algorithm: [SHA1withRSA]
Signature:
0000: 69 29 71 5D 97 1C 28 07   F1 5E 6A AA 49 A7 F7 31  i)q]..(..^j.I..1
0010: F2 B6 91 91 A1 7E D3 F9   1A C6 58 38 85 00 BA 49  ..........X8...I
0020: 21 69 E0 06 8D 9F BF 7B   C4 8C 83 95 69 4A 49 EB  !i..........iJI.
0030: 70 D8 7E A9 75 0D 8C C5   7C 9B 14 AB 93 76 A9 35  p...u........v.5
0040: 56 21 71 77 8D 2A AB 1C   CA 81 E0 15 36 4E 81 0A  V!qw.*......6N..
0050: 55 8F D4 5E 1C D0 BF 12   A3 44 8E 65 18 D9 4C E6  U..^.....D.e..L.
0060: 4C 5E 14 4A 7F DF CD 51   59 43 02 41 67 B0 EA 3E  L^.J...QYC.Ag..>
0070: 58 F4 38 50 3B 2D A3 81   08 8A 84 4C 4B E0 8B 3E  X.8P;-.....LK..>

3.12.4 exportWSMCertificate

注意:

このコマンドはOracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: JKSキーストア管理

WLSTでの使用: オンライン

説明

指定された別名で示された秘密鍵に関連付けられた、信頼できる証明書または証明書チェーンをエクスポートします。証明書が、指定された場所にエクスポートされます。

- type引数がCertificateである場合:

- aliasがKeyStore.TrustedCertificateEntryを参照している場合、エントリに関連付けられた信頼できる証明書が戻されます。

- aliasがKeyStore.PrivateKeyEntryを参照している場合、証明書チェーンの最初の証明書が戻されます。

- aliasがKeyStore.TrustedCertificateEntryもKeyStore.PrivateKeyEntryも参照していない場合、エラー・メッセージが戻されます。

- type引数がPKCS7である場合:

- aliasがKeyStore.PrivateKeyEntryを参照している場合、PKCS7形式のエントリに関連付けられている証明書チェーンが戻されます。

- aliasがKeyStore.PrivateKeyEntryを参照していない場合、エラー・メッセージが戻されます。

- type引数が無効な値に設定されている場合、エラー・メッセージが戻されます。

構文

exportWSMCertificate(alias, certFile, type)

引数

説明

alias

エクスポートされる証明書の別名。

certFile

エクスポートされた証明書が格納されるファイルの場所。

type

エクスポートするキーストア・エントリのタイプ。有効な値は次のとおりです。

- KeyStore.TrustedCertificateEntryをエクスポートする場合、Certificate。

- aliasで指定されたkeyStoreKeyStore.PrivateKeyEntryに対応する証明書チェーンをPKCS7形式でエクスポートする場合、PKCS7。

例

この例では、信頼できる証明書testaliasは、タイプによりCertificateと識別され、指定されたcertificate.cerファイルにエクスポートされます。

wls:/base_domain/serverConfig> exportWSMCertificate('testalias','/tmp/certificate.cer','Certificate')

Starting Operation exportWSMCertificate ...
Certificate for alias "testalias" successfully exported.

この例では、証明書チェーンtestalias2は、タイプによりPKCS7と識別され、指定されたcertificatechain.p7bファイルにエクスポートされます。

wls:/base_domain/serverConfig> exportWSMCertificate('testalias2','/tmp/certificatechain.p7b','PKCS7')

3.12.5 importWSMCertificate

注意:

このコマンドはOracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: JKSキーストア管理

WLSTでの使用: オンライン

説明

指定された別名で示された秘密鍵に関連付けられた、信頼できる証明書または証明書チェーンをインポートします。Base64でエンコードされた証明書が、指定された場所からインポートされます。

構文

importWSMCertificate(alias, certFile, type, password=None)

引数

説明

alias

インポートされる証明書の別名。

certFile

Base64エンコードされた証明書がインポートされるファイルの場所。

type

インポートするキーストア・エントリのタイプ。有効な値は次のとおりです。

- KeyStore.TrustedCertificateEntryをインポートする場合、Certificate。

- aliasで指定されたkeyStoreKeyStore.PrivateKeyEntryに対応する証明書チェーンをPKCS7形式でインポートする場合、PKCS7。

password

省略可能。秘密鍵に関連付けられたパスワード。

例

この例では、信頼できる証明書testaliasは、タイプによりCertificateと識別され、指定されたcertificate.cerファイルからインポートされます。

wls:/base_domain/serverConfig> importWSMCertificate('testalias','/tmp/certificate.cer','Certificate')

Starting Operation importWSMCertificate ...
Certificate for alias "testalias" successfully imported.

この例では、パスワード保護された証明書チェーンtestaliasは、タイプによりPKCS7と識別され、指定されたcertificatechain.p7bファイルからインポートされます。

wls:/base_domain/serverConfig> importWSMCertificate('testalias','/tmp/certificatechain.p7b','PKCS7',password='privatekeypassword')

この例では、証明書チェーンtestaliasは、タイプによりPKCS7と識別され、指定されたcertificatechain.p7bファイルからインポートされます。

wls:/base_domain/serverConfig> importWSMCertificate('testalias','/tmp/certificatechain.p7b','PKCS7')

3.12.6 listWSMKeystoreAliases

注意:

このコマンドはOracle Infrastructure Webサービスにのみ適用されます。

コマンド・カテゴリ: JKSキーストア管理

WLSTでの使用: オンライン

説明

キーストア内のすべての別名をリストします。

構文

listWSMKeystoreAliases()

例

この例では、キーストア内のすべての別名がリストされます。

wls:/base_domain/serverConfig>listWSMKeystoreAliases()

Starting Operation listWSMKeystoreAliases ...

testalias
orakey
testalias2

4 メタデータ・サービス(MDS)カスタムWLSTコマンド

Oracle Metadata Services (MDS)のWLSTコマンドでは、リポジトリ、およびリポジトリを使用するアプリケーションを管理できます。

この章では、コマンドの構文および引数を説明し、コマンドの例を示します。

MDSリポジトリの作成および管理の詳細は、『Oracle Fusion Middleware Oracle Fusion Middlewareの管理』のOracleメタデータ・リポジトリの管理に関する項を参照してください。各操作の実行に必要なロールの詳細は、『Oracle Fusion Middleware Oracle Fusion Middlewareの管理』のMDS操作の理解に関する項を参照してください。

表4-1の各カテゴリにリストされているOracle Metadata Services (MDS)のコマンドを使用して、MDSを管理します。

表4-1 MDSコマンド・カテゴリ

コマンド・カテゴリ

説明

リポジトリ管理コマンド

MDSリポジトリを管理します。

アプリケーション・メタデータ管理コマンド

MDSリポジトリのアプリケーション・メタデータを管理します。

サンドボックス・メタデータ管理コマンド

MDSリポジトリ内のサンドボックスのメタデータを管理します。

アプリケーション・ラベル管理コマンド

アプリケーションのラベルを管理します。

アプリケーション・デプロイメント管理コマンド

アプリケーションのデプロイメントを管理します。

マルチテナンシ管理コマンド

テナントを管理します。

4.1 共通名のパターン形式

多くのコマンドは、名前パターンを使用する引数を含んでいます。たとえば、restrictCustTo引数は名前パターンを使用します。名前パターンのルールは、これらの引数で同じです。

パターンには、次の特殊文字を含めることができます。

- パーセント(%)文字。これは、任意の数の文字に一致します。

- アンダースコア(_)文字。これは、正確に1つの任意の文字に一致します。

- バックスラッシュ(\)文字。これを使用すると、パーセント文字、アンダースコア文字、およびバックスラッシュ文字自体をエスケープして、それらが%、_、または\にのみ一致するようにすることができます。

次に例を示します。

restrictCustTo="user[scott]"
restrictCustTo="site[site1],user[scott]"
restrictCustTo="site[site1, %_2],user[scott, m%]"

4.2 リポジトリ管理コマンド

WLSTリポジトリ管理コマンドでは、MDSリポジトリの作成と削除、およびリポジトリの登録と登録解除が可能です。

リポジトリを管理するには、表4-2にリストされているMDSコマンドを使用します。「WLSTでの使用」列で、オンラインとは、実行中の管理サーバーに接続されている場合にのみ、コマンドが使用可能であることを意味します。オフラインとは、コマンドが実行中のサーバーに接続されてない場合のみに使用されることを意味します。オンラインまたはオフラインとは、コマンドは両方の状況に使用できることを意味します。

表4-2 リポジトリ管理コマンド

使用するコマンド

目的

WLSTでの使用

createMetadataPartition

メタデータ・リポジトリ・パーティションを作成します。

オンライン

deleteMetadataPartition

メタデータ・リポジトリ・パーティションを削除します。

オンライン

deregisterMetadataDBRepository

データベース・ベースのMDSリポジトリを登録解除します。

オンライン

registerMetadataDBRepository

データベース・ベースのMDSリポジトリを登録します。

オンライン

注意:

スクリプト内で、次のWLSTコマンドまたは比較可能なMBeanを起動する場合は、次のことに注意してください。

- registerMetadataDBRepository

- deregisterMetadataDBRepository

このリリースおよび以前のリリースでは、これらのコマンドまたはMBeanは次のように動作します。

1. Oracle WebLogic Serverの編集セッションを開始します。

2. リポジトリを登録または登録解除します。

3. 変更をアクティブ化します。

ただし、編集セッションは明示的に開始できます。その場合、変更の自動アクティブ化は推奨されません。

4.2.1 createMetadataPartition

コマンド・カテゴリ: リポジトリ管理

WLSTでの使用: オンライン

説明

メタデータ・リポジトリは、様々なアプリケーションのメタデータを管理する共通リポジトリとして使用されます。多くのアプリケーションでは、MDSリポジトリを使用してそのメタデータが管理されます。デプロイされた各アプリケーションでは、メタデータ・リポジトリに論理パーティションを使用します。この論理パーティションはメタデータ・ライフサイクルを管理するためにも役立ちます。アプリケーションをデプロイする前に、MDSリポジトリにパーティションを作成します。このコマンドは、指定したリポジトリに特定の名前でパーティションを作成します。

構文

createMetadataPartition(repository, partition)

引数

定義

repository

パーティションが作成されるリポジトリの名前。

partition

リポジトリに作成するパーティションの名前。

例

次の例では、リポジトリmds-myreposにメタデータ・パーティションpartition1を作成します。

wls:/weblogic/serverConfig> createMetadataPartition(repository='mds-myrepos',
partition='partition1')
Executing operation: createMetadataPartition
Metadata partition created: partition1
"partition1"

4.2.2 deleteMetadataPartition

コマンド・カテゴリ: リポジトリ管理

WLSTでの使用: オンライン

説明

指定したリポジトリ内のメタデータ・パーティションを削除します。リポジトリ・パーティションを削除する場合、そのパーティションにあるメタデータがすべて失われます。

構文

deleteMetadataPartition(repository, partition)

引数

定義

repository

パーティションを含むリポジトリの名前。

partition

リポジトリで削除するパーティションの名前。

例

次の例では、リポジトリmds-myreposからメタデータ・パーティションpartition1を削除します。

wls:/weblogic/serverConfig> deleteMetadataPartition(repository='mds-myrepos',
partition='partition1')
Executing operation: deleteMetadataPartition
Metadata partition deleted: partition1

4.2.3 deregisterMetadataDBRepository

コマンド・カテゴリ: リポジトリ管理

WLSTでの使用: オンライン

説明

データベース・メタデータ・リポジトリの、ドメイン内のシステムJDBCデータ・ソースとしての登録を削除します。このコマンドが正常に完了したら、アプリケーションはこのリポジトリを使用できなくなります。

構文

deregisterMetadataDBRepository(name)

引数

定義

name

登録を削除するリポジトリの名前。

例

次の例では、メタデータ・リポジトリmds-myreposを登録解除します。

wls:/weblogic/serverConfig> deregisterMetadataDBRepository('mds-myrepos')
Executing operation: deregisterMetadataDBRepository.
Metadata DB repository "mds-myrepos" was deregistered successfully.

4.2.4 registerMetadataDBRepository

コマンド・カテゴリ: リポジトリ管理

WLSTでの使用: オンライン

説明

データベース・メタデータ・リポジトリをアプリケーションで使用できるようにするには、WebLogic Serverインスタンスに登録する必要があります。このコマンドは、データベース・ベースのメタデータ・リポジトリとして使用するためにドメインにシステムJDBCデータ・ソースを登録します。

構文

registerMetadataDBRepository(name, dbVendor, host, port, dbName, user, password  [, targetServers])

引数

定義

name

登録するリポジトリの名前。指定された名前がmds-で始まっていない場合、コマンドは接頭辞mds-を追加します。

dbVendor

データベース・ベンダー。許容値は、ORACLE、MSSQL、IBMDB2およびMYSQLです。

host

データベースのホスト名またはIPアドレス。

port

データベースで使用されるポート番号。

dbName

データベースのサービス名。例: orcl.hostname.com

user

データベース・ユーザー名。

password

データベース・ユーザーのパスワード。

targetServers

省略可能。このリポジトリの登録先となるWebLogic Serverインスタンス。この引数を指定しない場合、リポジトリが管理サーバーのみに登録されます。複数のサーバーを指定するには、名前をカンマで区切って入力します。

リポジトリのターゲットをクラスタにするには、サーバー名ではなくクラスタ名を指定します。

アプリケーションがデプロイされるすべての管理対象サーバーにリポジトリを登録します。

例

次の例では、メタデータ・リポジトリmyreposを2つのサーバーに登録し、データベース・パラメータを指定します。

wls:/weblogic/serverConfig> registerMetadataDBRepository('myrepos','ORACLE',
'test.oracle.com','1521','mds', 'user1','password','server1, server2')
Executing operation: registerMetadataDBRepository.
Metadata DB repository "mds-myrepos" was registered successfully.
'mds-myrepos'

次の例では、メタデータ・リポジトリmyrepos_clustをクラスタsoa_clusterに登録し、データベース・パラメータを指定します。

wls:/weblogic/serverConfig> registerMetadataDBRepository('myrepos','ORACLE',
'test.oracle.com','1521','mds', 'user1','password','soa_cluster')
Executing operation: registerMetadataDBRepository.
Metadata DB repository "mds-myrepos_clust" was registered successfully.
'mds-myrepos'

4.3 アプリケーション・メタデータ管理コマンド

WLSTアプリケーション・メタデータ管理では、メタデータのインポートやエクスポート、またはメタデータの削除など、アプリケーション・メタデータを管理できます。

表4-3のコマンドを使用して、アプリケーション・メタデータを管理します。「WLSTでの使用」列で、オンラインとは、実行中の管理サーバーに接続されている場合にのみ、コマンドが使用可能であることを意味します。オフラインとは、コマンドが実行中のサーバーに接続されてない場合のみに使用されることを意味します。オンラインまたはオフラインとは、コマンドは両方の状況に使用できることを意味します。

表4-3 アプリケーション・メタデータ・コマンド

使用するコマンド

目的

WLSTでの使用

deleteMetadata

アプリケーション・リポジトリのメタデータを削除します。

オンライン

exportMetadata

アプリケーションのメタデータをエクスポートします。

オンライン

importMetadata

アプリケーションのメタデータをインポートします。

オンライン

purgeMetadata

メタデータを消去します。

オンライン

4.3.1 deleteMetadata

コマンド・カテゴリ: アプリケーション・メタデータ

WLSTでの使用: オンライン

説明

アプリケーション・リポジトリから選択されたドキュメントを削除します。バージョニングをサポートするリポジトリ(つまり、データベース・ベースのリポジトリ)に対してこのコマンドが実行される場合、削除は論理的に行われ、選択されたドキュメントのヒント・バージョン(最新バージョン)がMDSリポジトリ・パーティションで削除済としてマークされます。

メタデータは、別のリポジトリに移動される場合、削除する必要があります。この場合、メタデータをエクスポートした後、元のリポジトリのメタデータを削除できます。

構文

deleteMetadata(application, server, docs [, restrictCustTo] [, excludeAllCust]
[, excludeBaseDocs] [, excludeExtendedMetadata] [, cancelOnException] [, applicationVersion] [, tenantName])

引数

定義

application

メタデータを削除するアプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。

docs

完全修飾ドキュメントまたはドキュメント名パターン、あるいはその両方のカンマ区切りのリスト。パターンには、ワイルドカード文字「*」および「**」を含めることができます。

アスタリスク(*)は、現在のネームスペースの中のすべてのドキュメントを表します。2つのアスタリスク(**)は、現在のネームスペースの中のすべてのドキュメントを表し、サブネームスペースのすべてのドキュメントも再帰的に含めます。

たとえば、「/oracle/*」は、「/oracle/」の中のすべてのドキュメントを含めますが、「/oracle/mds/」の中のドキュメントを含めません。

別の例では、「/oracle/**」は、「/oracle/」の下のすべてのドキュメントを含め、「/oracle/mds/」の下のドキュメントおよびネームスペース・チェーンの連続のドキュメントも含めます。

restrictCustTo

省略可能。有効な値は、パーセント(%)またはカスタマイズ・レイヤー名のカンマ区切りのリストです。後者は、指定したカスタマイズ・レイヤーに一致するカスタマイズ・ドキュメントのみを削除するように、削除操作を制限するために使用されます。各カスタマイズ・レイヤー名には、オプションのカスタマイズ・レイヤー値と値のパターン(カンマ区切り)を大カッコで囲んで含めることができます。

この引数で使用できるパターンの詳細は、「共通名のパターン形式」を参照してください。

次に例を示します。

restrictCustTo="user[scott]"
restrictCustTo="site[site1],user[scott]"
restrictCustTo="site[site1, %_2],user[scott, m%]"

この引数を指定しない場合、adf-config.xmlのcust-config要素で宣言されているカスタマイズ・クラスのみが削除されます。adf-config.xmlでcust-config要素が宣言されていない場合、すべてのカスタマイズ・クラスが削除されます。

この引数の値としてパーセント(%)を指定すると、adf-config.xmlのcust-config要素で宣言されているかどうかに関係なく、すべてのカスタマイズが削除されます。

すべてのカスタマイズまたは宣言されたカスタマイズのサブセットを削除するには、このオプションを使用します。このオプションを使用して、adf-config.xmlのcust-config要素で宣言されていないカスタマイズ・クラスのカスタマイズを削除することもできます。

excludeAllCust

省略可能。すべてのカスタマイズ・ドキュメントを削除するかどうかを指定するブール値(trueまたはfalse)。

この引数のデフォルトはfalseです。restrictCustToオプションをオーバーライドします。

excludeBaseDocs

省略可能。ベース・ドキュメントを削除するかどうかを指定するブール値(trueまたはfalse)。この引数のデフォルトはfalseです。

excludeExtendedMetadata

省略可能。拡張されたメタデータ・ドキュメントを削除するかどうかを指定するブール値(trueまたはfalse)。この引数のデフォルトはfalseです。

cancelOnException

省略可能。例外が発生する場合削除操作を中止するかどうかを指定するブール値(trueまたはfalse)。中止すると、削除が対象ストアでサポートされる場合、ロールバックされます。この引数のデフォルトはtrueです。

applicationVersion

省略可能。アプリケーション・バージョン(同じアプリケーションの複数のバージョンをデプロイした場合)。

tenantName

この操作で使用するテナントを識別する一意の名前。この引数は、マルチテナント・アプリケーションには必要ですが、非マルチテナント・アプリケーションには適用されません。非マルチテナント・アプリケーションでは、指定された値はいずれも無視されます。

例

次の例では、サーバーserver1にデプロイされたmdsAppからパッケージmypackageのメタデータ・ファイルを削除します。

wls:/weblogic/serverConfig> deleteMetadata(application='mdsapp',
server='server1', docs='/mypackage/*')
Executing operation: deleteMetadata.
"deleteMetadata" operation completed. Summary of "deleteMetadata" operation is:
List of documents successfully deleted:
/mypackage/jobs.xml
/mypackage/mo.xml
/mypackage/mdssys/cust/site/site1/jobs.xml.xml
/mypackage/mdssys/cust/site/site1/mo.xml.xml
4 documents successfully deleted.

次の例では、サーバーserver1にデプロイされたmdsAppからパッケージmypackageのメタデータ・ファイルを削除し、拡張されたメタデータおよびすべてのカスタマイズを除外します。

wls:/weblogic/serverConfig> deleteMetadata(application='mdsapp',
server='server1', docs='/mypackage/*', cancelOnException='false',
excludeExtendedMetadata='true',
excludeAllCust='true')
Executing operation: deleteMetadata.
"deleteMetadata" operation completed. Summary of "deleteMetadata" operation is:
List of documents successfully deleted:
/mypackage/jobs.xml
/mypackage/mo.xml
2 documents successfully deleted.

次の例では、サーバーserver1にデプロイされたアプリケーションapp1からパッケージmypackageのテナントtenant1に属しているメタデータ・ファイルを削除します。

wls:/weblogic/serverConfig> deleteMetadata(application='app1', server='server1',
docs='/mypackage/**', tenantName='tenant1')
Executing operation: deleteMetadata.
deleteMetadata" operation completed. Summary of "deleteMetadata" operation is:
List of documents successfully deleted:
/mypackage/jobs.xml
/mypackage/mdssys/cust/site/site1/jobs.xml.xml
/mypackage/mdssys/cust/site/site2/mo.xml.xml
/mypackage/mdssys/cust/user/user1/mo.xml.xml

4.3.2 exportMetadata

コマンド・カテゴリ: アプリケーション・メタデータ

WLSTでの使用: オンライン

説明

アプリケーション・メタデータをエクスポートします。このコマンドおよびimportMetadataコマンドを使用して、アプリケーション・メタデータを、あるサーバー位置(たとえばテスト・システム)から別のサーバー位置(たとえば本番システム)に転送します。

このコマンドは、カスタマイズも含めてアプリケーション・メタデータをエクスポートします。ただし、デフォルトでは、adf.config.xmlのcust-config要素で定義されているカスタマイズ・クラスのカスタマイズのみがエクスポートされます。宣言されていないカスタマイズ・クラスのカスタマイズをエクスポートするには、restrictCustToオプションを使用します。

exportMetadataコマンドをNFS共有において使用している場合、NFSマウント・オプションによってはファイル・システム上に書き込まれたファイルの出現までに待ち時間がある可能性があることに注意してください。詳細は、http://man7.org/linux/man-pages/man5/nfs.5.htmlを参照してください。

構文

exportMetadata(application, server, toLocation  [, docs]
[, restrictCustTo] [, excludeCustFor] [, excludeAllCust] [, excludeBaseDocs]
[, excludeExtendedMetadata] [, excludeSeededDocs]
[, fromLabel][, toLabel] [, applicationVersion] [, remote] [, tenantName])

引数

定義

application

メタデータのエクスポート元となるアプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。

toLocation

ソース・パーティションから選択されたドキュメントの転送先となるターゲット・ディレクトリまたはアーカイブ・ファイル(.jar、.JAR、.zipまたは.ZIP)。ディレクトリにエクスポートする場合、そのディレクトリは、アプリケーションが物理的にデプロイされているローカル・ディレクトリかネットワーク・ディレクトリまたはファイルである必要があります。アーカイブにエクスポートする場合、アプリケーションが物理的にデプロイされているローカル・ディレクトリかネットワーク・ディレクトリまたはファイルにあるアーカイブ、あるいはコマンドが実行されているシステムにあるアーカイブを指定できます。

該当する場所がファイル・システム上に存在しない場合は、名前の最後が.jar、.JAR、.zipまたは.ZIPであるときを除き、ディレクトリが作成されます。その場合は、アーカイブ・ファイルが作成されます。アーカイブ・ファイルがすでに存在する場合、exportMetadata操作によってファイルが上書きされます。

この引数は、1つのサーバーから別のサーバーにメタデータを転送するときに一時ファイル・システムとして使用できます。詳細は、『Oracle Fusion Middleware Oracle Fusion Middlewareの管理』のテスト・システムから本番システムへのメタデータの移動に関する項を参照してください。

docs

省略可能。完全修飾ドキュメントまたはドキュメント名パターン、あるいはその両方のカンマ区切りのリスト。パターンには、ワイルドカード文字「*」および「**」を含めることができます。

この引数は、デフォルトで/**に設定されます。この設定では、リポジトリ内のすべてのメタデータがエクスポートされます。

アスタリスク(*)は、現在のネームスペースの中のすべてのドキュメントを表します。2つのアスタリスク(**)は、現在のネームスペースの中のすべてのドキュメントを表し、サブネームスペースのすべてのドキュメントも再帰的に含めます。

たとえば、/oracle/*には/oracle/の下のすべてのドキュメントが含まれますが、/oracle/mds/の下のドキュメントは含まれません。

/oracle/**には/oracle/の下のすべてのドキュメントおよび/oracle/mds/の下のすべてのドキュメント、およびネームスペース・チェーン内のその他のドキュメントが含まれます。

restrictCustTo

省略可能。有効な値は、パーセント(%)またはカスタマイズ・レイヤー名のカンマ区切りのリストです。後者は、指定したカスタマイズ・レイヤーに一致するカスタマイズ・ドキュメントのみをエクスポートするように、エクスポート操作を制限するために使用されます。各カスタマイズ・レイヤー名には、オプションのカスタマイズ・レイヤー値と値のパターン(カンマ区切り)を大カッコで囲んで含めることができます。

この引数で使用できるパターンの詳細は、「共通名のパターン形式」を参照してください。

次に例を示します。

restrictCustTo="user[scott]"
restrictCustTo="site[site1],user[scott]"
restrictCustTo="site[site1, %_2],user[scott, m%]"

この引数を指定しない場合、adf-config.xmlのcust-config要素で宣言されているカスタマイズ・クラスのみがエクスポートされます。adf-config.xmlでcust-config要素が宣言されていない場合、すべてのカスタマイズ・クラスがエクスポートされます。

この引数の値としてパーセント(%)を指定すると、adf-config.xmlのcust-config要素で宣言されているかどうかに関係なく、すべてのカスタマイズがエクスポートされます。

すべてのカスタマイズまたは宣言されたカスタマイズのサブセットをエクスポートするには、このオプションを使用します。このオプションを使用して、adf-config.xmlのcust-config要素で宣言されていないカスタマイズ・クラスのカスタマイズをエクスポートすることもできます。

excludeAllCust引数も指定すると、この引数は無視されます。

excludeCustFor

省略可能。指定したカスタマイズ・レイヤーに一致するカスタマイズ・ドキュメントをエクスポートから除外するように、エクスポート操作を制限するために使用するカスタマイズ・レイヤー名のカンマ区切りのリスト。

excludeAllCust引数も指定すると、この引数は無視されます。

excludeAllCust

省略可能。すべてのカスタマイズ・ドキュメントをエクスポートするかどうかを指定するブール値(trueまたはfalse)。この引数のデフォルトはfalseです。この引数は、restrictCustToおよびexcludeCustFor引数をオーバーライドします。

excludeBaseDocs

省略可能。ベース・ドキュメントをエクスポートするかどうかを指定するブール値(trueまたはfalse)。この引数のデフォルトはfalseです。

excludeExtendedMetadata

省略可能。拡張メタデータ・ドキュメントをエクスポートするかどうかを指定するブール値(trueまたはfalse)。この引数のデフォルトはfalseです。

excludeSeededDocs

省略可能。すべてのドキュメントをエクスポートするか、非シード・ドキュメントのみをエクスポートするかを指定するブール値(trueまたはfalse)。シード・ドキュメントとは、MARでパッケージ化されているドキュメントです。

シード・ドキュメントを除外するには、trueを指定します。

デフォルトはfalseです。

fromLabel

省略可能。このラベルに関連付けられているソース・パーティションからドキュメントを転送します。

toLabel

省略可能。ソース・パーティションからfromLabelとtoLabelの間にデータを転送するために、fromLabelと連携して動作します。

applicationVersion

省略可能。アプリケーション・バージョン(同じアプリケーションの複数のバージョンをデプロイした場合)。

remote

省略可能。アーカイブ・ファイルを、アプリケーションがデプロイされている場所に書き込むか(false)、コマンドが実行されているシステムに書き込むか(true)を指定するブール値(trueまたはfalse)。

デフォルトはfalseです。

tenantName

この操作で使用するテナントを識別する一意の名前。この引数は、マルチテナント・アプリケーションには必要ですが、非マルチテナント・アプリケーションには適用されません。非マルチテナント・アプリケーションの場合、指定した値は無視されます。

例

次の例では、サーバーserver1にデプロイされたアプリケーションmdsappからすべてのメタデータ・ファイルをエクスポートします。

wls:/weblogic/serverConfig> exportMetadata(application='mdsapp',
server='server1',toLocation='/tmp/myrepos',docs='/**')
Location changed to domainRuntime tree. This is a read-only tree with DomainMBean as the root.
For more help, use help(domainRuntime)
Executing operation: exportMetadata.
"exportMetadata" operation completed. Summary of "exportMetadata" operation is:
List of documents successfully transferred:
/mypackage/write.xml
/mypackage/write1.xml
/sample1.jspx

次の例では、ラベルlabel1からラベルlabel2にレイヤーuserの中のベース・ドキュメントを除いてカスタマイズ・ドキュメントのみをエクスポートします。

wls:/weblogic/serverConfig> exportMetadata(application='mdsapp',
server='server1',toLocation='/tmp/myrepos',
restrictCustTo='user',
excludeBaseDocs='true',
fromLabel='label1',
toLabel='label2',
applicationVersion='11.1.1')
List of documents successfully transferred:
/mypackage/mdssys/cust/user/user1/write1.xml.xml
/mypackage/mdssys/cust/user/user2/write2.xml.xml
2 documents successfully transferred.

4.3.3 importMetadata

コマンド・カテゴリ: アプリケーション・メタデータ

WLSTでの使用: オンライン

説明

アプリケーション・メタデータをインポートします。exportMetadataコマンドおよびこのコマンドを使用して、アプリケーション・メタデータを、あるサーバー位置(たとえばテスト・システム)から別のサーバー位置(たとえば本番・システム)に転送します。

importMetadataコマンドをNFS共有において使用している場合、NFSマウント・オプションによってはファイル・システム上に書き込まれたファイルの出現までに待ち時間がある可能性があることに注意してください。詳細は、http://man7.org/linux/man-pages/man5/nfs.5.htmlを参照してください。

構文

importMetadata(application, server, fromLocation  [, docs]
[, restrictCustTo] [, excludeAllCust] [, excludeBaseDocs]
[, excludeExtendedMetadata] [, excludeUnmodifiedDocs]
[, cancelOnException] [, applicationVersion] [, remote] [, tenantName])

引数

定義

application

メタデータをインポートするアプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。

fromLocation

転送するドキュメントの選択元となるソース・ディレクトリまたはアーカイブ・ファイル。ドキュメントがディレクトリ内にある場合、このディレクトリは、ローカル・ディレクトリまたはネットワーク・ディレクトリ、あるいはアプリケーションが物理的にデプロイされているファイルである必要があります。ドキュメントがアーカイブ内にある場合、ローカル・ディレクトリ内かネットワーク・ディレクトリ内、アプリケーションが物理的にデプロイされているファイル内、またはコマンドを実行しているシステム上にあるアーカイブを指定できます。

この引数は、1つのサーバーから別のサーバーにメタデータを転送するときに一時ファイル・システム場所として使用できます。詳細は、『Oracle Fusion Middleware Oracle Fusion Middlewareの管理』のテスト・システムから本番システムへのメタデータの移動に関する項を参照してください。

docs

省略可能。完全修飾ドキュメントまたはドキュメント名パターン、あるいはその両方のカンマ区切りのリスト。パターンには、ワイルドカード文字「*」および「**」を含めることができます。

この引数は、デフォルトで/**に設定されます。この設定では、リポジトリ内のすべてのドキュメントがインポートされます。

アスタリスク(*)は、現在のネームスペースの中のすべてのドキュメントを表します。2つのアスタリスク(**)は、現在のネームスペースの中のすべてのドキュメントを表し、サブネームスペースのすべてのドキュメントも再帰的に含めます。

たとえば、/oracle/*には/oracle/の下のすべてのドキュメントが含まれますが、/oracle/mds/の下のドキュメントは含まれません。

/oracle/**には/oracle/の下のすべてのドキュメントおよび/oracle/mds/の下のすべてのドキュメント、およびネームスペース・チェーン内のその他のドキュメントが含まれます。

restrictCustTo

省略可能。有効な値は、パーセント(%)またはカスタマイズ・レイヤー名のカンマ区切りのリストです。後者は、adf-config.xmlのcust-config要素で宣言されていないカスタマイズ・クラスを含めて、指定したカスタマイズ・レイヤーに一致するカスタマイズ・ドキュメントのみをインポートするように、インポート操作を制限するために使用されます。各カスタマイズ・レイヤー名には、オプションのカスタマイズ・レイヤー値と値のパターン(カンマ区切り)を大カッコで囲んで含めることができます。

この引数で使用できるパターンの詳細は、「共通名のパターン形式」を参照してください。

次に例を示します。

restrictCustTo="user[scott]"
restrictCustTo="site[site1],user[scott]"
restrictCustTo="site[site1, %_2],user[scott, m%]"

この引数を指定しない場合、adf-config.xmlのcust-config要素で宣言されているカスタマイズ・クラスのみがインポートされます。adf-config.xmlでcust-config要素が宣言されていない場合、すべてのカスタマイズ・クラスがインポートされます。

この引数の値としてパーセント(%)を指定すると、adf-config.xmlのcust-config要素で宣言されているかどうかに関係なく、すべてのカスタマイズがインポートされます。

すべてのカスタマイズまたは宣言されたカスタマイズのサブセットをインポートするには、このオプションを使用します。このオプションを使用して、adf-config.xmlのcust-config要素で宣言されていないカスタマイズ・クラスのカスタマイズをエクスポートすることもできます。

excludeAllCust引数も指定すると、この引数は無視されます。

excludeAllCust

省略可能。すべてのカスタマイズ・ドキュメントをインポートするかどうかを指定するブール値(trueまたはfalse)。この引数のデフォルトはfalseです。この引数は、restrictCustTo引数をオーバーライドします。

excludeBaseDocs

省略可能。ベース・ドキュメントをインポートするかどうかを指定するブール値(trueまたはfalse)。この引数のデフォルトはfalseです。

excludeExtendedMetadata

省略可能。拡張メタデータ・ドキュメントをインポートするかどうかを指定するブール値(trueまたはfalse)。この引数のデフォルトはfalseです。

excludeUnmodifiedDocs

省略可能。変更されたドキュメントのみをインポートするかどうかを指定するブール値(trueまたはfalse)。

trueを指定すると、変更されたドキュメントのみがインポートされます。

デフォルトはfalseです。

cancelOnException

省略可能。例外が発生した場合インポート操作を中止するかどうかを指定するブール値(trueまたはfalse)。

デフォルトは、trueです。

applicationVersion

省略可能。アプリケーション・バージョン(同じアプリケーションの複数のバージョンをデプロイした場合)。

remote

省略可能。アーカイブ・ファイルが、アプリケーションがデプロイされている場所にあるか(false)、コマンドが実行されているシステム上にあるか(true)を指定するブール値(trueまたはfalse)。

デフォルトはfalseです。

tenantName

この操作で使用するテナントを識別する一意の名前。この引数は、マルチテナント・アプリケーションには必要ですが、非マルチテナント・アプリケーションには適用されません。非マルチテナント・アプリケーションの場合、指定した値は無視されます。

例

次の例では、サーバーserver1にデプロイされたアプリケーションmdsappに、/tmp/myreposで使用可能なすべてのメタデータをインポートします。

wls:/weblogic/serverConfig> importMetadata(application='mdsapp', server='server1',
fromLocation='/tmp/myrepos',docs="/**")
Executing operation: importMetadata.
"importMetadata" operation completed. Summary of "importMetadata" operation is:
List of documents successfully transferred:
/app1/jobs.xml
/app1/mo.xml
2 documents successfully transferred.

4.3.4 purgeMetadata

コマンド・カテゴリ: アプリケーション・メタデータ

WLSTでの使用: オンライン

説明

アプリケーションのリポジトリから、ラベルのないドキュメントの古い(ヒント以外の)バージョンをパージします。存続期間(olderThan引数)に基づいて、ラベルのない期限切れのドキュメントはすべてパージされます。このコマンドは、バージョニングをサポートするリポジトリ(つまり、データベース・ベースのリポジトリ)にのみ適用できます。

構文

purgeMetadata(application, server, olderThan [, applicationVersion])

引数

定義

application

パージ 操作が実行されるリポジトリでのパーティションを識別するために使用されるアプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。

olderThan

この値(秒単位)よりも古いドキュメント・バージョンがパージされます。最大値は2147483647秒です。

applicationVersion

省略可能。アプリケーション・バージョン(同じアプリケーションの複数のバージョンをデプロイした場合)。

例

次の例では、バージョンが10秒よりも古い場合、サーバーserver1にデプロイされたアプリケーションmdsappのドキュメント・バージョン履歴をパージします。

wls:/weblogic/serverConfig> purgeMetadata('mdsapp', 'server1', 10)
Executing operation: purgeMetadata.
Metadata purged: Total number of versions: 10.
Number of versions purged: 0.

4.4 サンドボックス・メタデータ管理コマンド

WLSTサンドボックス・メタデータ管理コマンドでは、サンドボックス内のメタデータを管理できます。サンドボックスとは、本番システムに移動する前に変更をテストするための一時的な場所です。サンドボックスは、適用されるまでほとんどのユーザーからは見えません。

表4-4のコマンドを使用して、サンドボックス内のメタデータを管理します。「WLSTでの使用」列で、オンラインとは、実行中の管理サーバーに接続されている場合にのみ、コマンドが使用可能であることを意味します。オフラインとは、コマンドが実行中のサーバーに接続されてない場合のみに使用されることを意味します。オンラインまたはオフラインとは、コマンドは両方の状況に使用できることを意味します。

表4-4 サンドボックス・メタデータ管理コマンド

使用するコマンド

目的

WLSTでの使用

destroyMDSSandbox

MDSサンドボックスを破棄します。

オンライン

exportSandboxMetadata

サンドボックスからメタデータをエクスポートします。

オンライン

importSandboxMetadata

サンドボックスにメタデータをインポートします。

オンライン

listMDSSandboxes

サンドボックスをリストします。

オンライン

4.4.1 destroyMDSSandbox

コマンド・カテゴリ: サンドボックス・メタデータ管理

WLSTでの使用: オンライン

説明

サンドボックスおよびその内容を破棄します。

データベース・ベースのMDSリポジトリでのみ、このコマンドを使用できます。

構文

destroyMDSSandbox(application, server, sandboxName [, applicationVersion])

引数

定義

application

アプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。

sandboxName

破棄するサンドボックスの名前。

applicationVersion

省略可能。アプリケーション・バージョン(同じアプリケーションの複数のバージョンをデプロイした場合)。

例

次の例では、アプリケーションmyappのMDSリポジトリからサンドボックスsandbox1を破棄します。

wls:/weblogic/serverConfig>destroyMDSSandbox('myapp', 'server1',
'sandbox1')
Executing operation: destroyMDSSandbox.

Sandbox "sandbox1" successfully destroyed.

4.4.2 exportSandboxMetadata

コマンド・カテゴリ: サンドボックス・メタデータ管理

WLSTでの使用: オンライン

説明

テスト・システム上のサンドボックスからメタデータに対する変更をエクスポートします。

データベース・ベースのMDSリポジトリでのみ、このコマンドを使用できます。

構文

exportSandboxMetadata(application, server, toArchive, sandboxName
[, restrictCustTo] [, applicationVersion] [, remote] [, tenantName])

引数

定義

application

メタデータのエクスポート元となるアプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。

toArchive

サンドボックス・コンテンツの転送先となるターゲット・アーカイブ・ファイル(.jar、.JAR、.zipまたは.ZIP)。アプリケーションが物理的にデプロイされるローカルまたはネットワーク・ディレクトリにあるアーカイブを指定できます。-remote引数を指定すると、コマンドが実行されているシステム上のアーカイブを指定できます。

sandboxName

エクスポートするサンドボックスの名前。

restrictCustTo

省略可能。有効な値は、パーセント(%)またはカスタマイズ・レイヤー名のカンマ区切りのリストです。後者は、指定したカスタマイズ・レイヤーに一致するカスタマイズ・ドキュメントのみをエクスポートするように、エクスポート操作を制限するために使用されます。各カスタマイズ・レイヤー名には、オプションのカスタマイズ・レイヤー値と値のパターン(カンマ区切り)を大カッコで囲んで含めることができます。

この引数で使用できるパターンの詳細は、「共通名のパターン形式」を参照してください。

次に例を示します。

restrictCustTo="user[scott]"
restrictCustTo="site[site1],user[scott]"
restrictCustTo="site[site1, %_2],user[scott, m%]"

この引数を指定しない場合、またはこの引数の値としてパーセント(%)を指定した場合は、adf-config.xmlのcust-config要素で宣言されているかどうかに関係なく、すべてのカスタマイズがエクスポートされます。

すべてのカスタマイズまたは宣言されたカスタマイズのサブセットをエクスポートするには、このオプションを使用します。このオプションを使用して、adf-config.xmlのcust-config要素で宣言されていないカスタマイズ・クラスのカスタマイズをエクスポートすることもできます。

excludeAllCust引数も指定すると、この引数は無視されます。

applicationVersion

省略可能。アプリケーション・バージョン(同じアプリケーションの複数のバージョンをデプロイした場合)。

remote

省略可能。アーカイブ・ファイルを、アプリケーションがデプロイされている場所に書き込むか(false)、コマンドが実行されているシステムに書き込むか(true)を指定するブール値(trueまたはfalse)。

デフォルトはfalseです。

tenantName

この操作で使用するテナントを識別する一意の名前。この引数は、マルチテナント・アプリケーションには必要ですが、非マルチテナント・アプリケーションには適用されません。非マルチテナント・アプリケーションでは、指定された値はいずれも無視されます。

例

次の例では、アプリケーションmyappのMDSリポジトリから/tmp/sandbox1.jarにサンドボックスsandbox1をエクスポートします。

wls:/weblogic/serverConfig>exportSandboxMetadata('myapp', 'server1',
'/tmp/sandbox1.jar', 'sandbox1')

4.4.3 importSandboxMetadata

コマンド・カテゴリ: サンドボックス・メタデータ管理

WLSTでの使用: オンライン

説明

サンドボックス・アーカイブのコンテンツを、指定されたアプリケーションのMDSリポジトリ・パーティション内の別のサンドボックスにインポートします。また、特定のアプリケーションのMDSリポジトリ・パーティション内のサンドボックスにある特定のアーカイブのコンテンツを更新することもできます。adf-config.xmlのcust-config要素で宣言されているかどうかに関係なく、すべてのカスタマイズがインポートされます。

データベース・ベースのMDSリポジトリでのみ、このコマンドを使用できます。

構文

importSandboxMetadata(application, server, fromArchive  [, forceSBCreation]
[, useExistingSandbox] [, sandboxName] [, applicationVersion]
[, remote] [, tenantName])

引数

定義

application

メタデータをインポートするアプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。

fromArchive

転送するドキュメントの選択元となるソース・アーカイブ・ファイル。アプリケーションが物理的にデプロイされるローカルまたはネットワーク・ディレクトリにあるアーカイブを指定できます。-remote引数を指定すると、コマンドが実行されているシステム上のアーカイブを指定できます。

forceSBCreation

省略可能。操作によって同じ名前の既存のサンドボックスを上書きするかどうかを指定するブール値(trueまたはfalse)。引数がtrueに設定された場合、fromArchive引数で、アプリケーションのパーティションにすでに存在しているものと同じ名前のサンドボックスが指定されると、元のサンドボックスは削除され、新しいサンドボックスが作成されます。引数がfalseに設定された場合、同じ名前のサンドボックスが存在していると、例外がスローされます。

デフォルトは、falseです。

useExistingSandbox

省略可能。trueに設定されると、アーカイブのコンテンツが、sandboxName引数で指定されたサンドボックスにインポートされます。sandboxNameに対して何も値が指定されていない場合、この引数は無視されます。

デフォルトは、falseです。

sandboxName

省略可能。更新するサンドボックスの名前。useExistingSandboxがfalseである場合、この引数は無視されます。

applicationVersion

省略可能。アプリケーション・バージョン(同じアプリケーションの複数のバージョンをデプロイした場合)。

remote

省略可能。アーカイブ・ファイルが、アプリケーションがデプロイされている場所にあるか(false)、コマンドが実行されているシステム上にあるか(true)を指定するブール値(trueまたはfalse)。

デフォルトは、falseです。

tenantName

この操作で使用するテナントを識別する一意の名前。この引数は、マルチテナント・アプリケーションには必要ですが、非マルチテナント・アプリケーションには適用されません。非マルチテナント・アプリケーションでは、指定された値はいずれも無視されます。

例

次の例では、sandbox1.jarのコンテンツをインポートし、アプリケーションmyappのMDSリポジトリ・パーティションにサンドボックスを作成します。

wls:/weblogic/serverConfig> importSandboxMetadata(application='myapp', 'server1'',
'/tmp/sandbox1.jar')

次の例では、アプリケーションmyappのMDSリポジトリ・パーティションの既存のサンドボックスsandbox1をsandbox1.jarの内容で更新します。

wls:/weblogic/serverConfig>importSandboxMetadata('myapp', 'server1', '/tmp/sandbox1.jar', useExistingSandbox='true', sandboxName='sandbox1')

4.4.4 listMDSSandboxes

コマンド・カテゴリ: サンドボックス・メタデータ管理

WLSTでの使用: オンライン

説明

指定した基準に一致するサンドボックスをリストします。

データベース・ベースのMDSリポジトリでのみ、このコマンドを使用できます。

構文

listMDSSandboxes(application, server [, sbNamePattern] [, applicationVersion])

引数

定義

application

サンドボックスがリストされるアプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。

sbNamePattern

省略可能。1つ以上のサンドボックスの名前が一致するパターン。この引数を指定しない場合、アプリケーションのメタデータ・リポジトリ・パーティションに関連付けられているすべてのサンドボックスがリストされます。

この引数で使用できるパターンの詳細は、「共通名のパターン形式」を参照してください。

applicationVersion

省略可能。アプリケーション・バージョン(同じアプリケーションの複数のバージョンをデプロイした場合)。

例

次の例では、文字FlexFieldで始まる、アプリケーションmyappのすべてのサンドボックスをリストします。

wls:/weblogic/serverConfig>listMDSSandboxes('myapp', 'server1',
'FlexField%')
Executing operation: listMDSSandboxes.

Following Sandboxes match the selection criteria:
FlexfieldAutoSandbox_1347601004722
FlexfieldAutoSandbox_1347653193237
FlexfieldAutoSandbox_1347691996491

4.5 アプリケーション・ラベル管理コマンド

WLSTアプリケーション・ラベル管理コマンドでは、アプリケーションのラベルを作成、削除および管理できます。

表4-5のコマンドを使用して、アプリケーションのラベルを管理します。「WLSTでの使用」列で、オンラインとは、実行中の管理サーバーに接続されている場合にのみ、コマンドが使用可能であることを意味します。オフラインとは、コマンドが実行中のサーバーに接続されてない場合のみに使用されることを意味します。オンラインまたはオフラインとは、コマンドは両方の状況に使用できることを意味します。

表4-5 アプリケーション・ラベル管理コマンド

使用するコマンド

目的

WLSTでの使用

createMetadataLabel

メタデータ・ラベルを作成します。

オンライン

deleteMetadataLabel

リポジトリ・パーティションからメタデータ・ラベルを削除します。

オンライン

listMetadataLabels

リポジトリ・パーティションのメタデータ・ラベルを示します。

オンライン

promoteMetadataLabel

ラベルに関連付けられるメタデータを先頭に昇格させます。

オンライン

purgeMetadataLabels

指定された条件に一致するラベルを削除します。

オンライン

4.5.1 createMetadataLabel

コマンド・カテゴリ: アプリケーション・ラベル管理

WLSTでの使用: オンライン

説明

アプリケーションのリポジトリ・パーティションにドキュメントのための新しいラベルを作成します。このコマンドは、バージョニングをサポートするリポジトリにのみ適用されます。

構文

createMetadataLabel(application, server, name [, applicationVersion] [, tenantName])

引数

定義

application

このアプリケーションに対して構成したパーティション内にラベルが作成されるアプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。アプリケーションがクラスタ内の複数の管理対象サーバーにデプロイされている場合、いずれのサーバー名も使用できます。複数のサーバー名を指定することはできません。

name

リポジトリ・パーティション内に作成するラベルの名前。

applicationVersion

省略可能。アプリケーション・バージョン(同じアプリケーションの複数のバージョンをデプロイした場合)。

tenantName

この操作で使用するテナントを識別する一意の名前。この引数は、マルチテナント・アプリケーションには必要ですが、非マルチテナント・アプリケーションには適用されません。非マルチテナント・アプリケーションでは、指定された値はいずれも無視されます。

例

次の例では、サーバーserver1にデプロイされたアプリケーションmdsappのラベルlabel1を作成します。

wls:/weblogic/serverConfig> createMetadataLabel('mdsapp','server1','label1')
Executing operation: createMetadataLabel.
Created metadata label "label1".

4.5.2 deleteMetadataLabel

コマンド・カテゴリ: アプリケーション・ラベル管理

WLSTでの使用: オンライン

説明

アプリケーションのリポジトリ・パーティションからドキュメントのラベルを削除します。このコマンドは、バージョニングをサポートするリポジトリにのみ適用されます。

構文

deleteMetadataLabel(application, server, name [, applicationVersion] [, tenantName])

引数

定義

application

ラベルを削除するパーティションが関連付けられるアプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。アプリケーションがクラスタ内の複数の管理対象サーバーにデプロイされている場合、いずれのサーバー名も使用できます。複数のサーバー名を指定することはできません。

name

リポジトリ・パーティションに削除するラベルの名前。

applicationVersion

省略可能。アプリケーション・バージョン(同じアプリケーションの複数のバージョンをデプロイした場合)。

tenantName

この操作で使用するテナントを識別する一意の名前。この引数は、マルチテナント・アプリケーションには必要ですが、非マルチテナント・アプリケーションには適用されません。非マルチテナント・アプリケーションでは、指定された値はいずれも無視されます。

例

次の例では、サーバーserver1にデプロイされたアプリケーションmdsappからメタデータ・ラベルlabel1を削除します。

wls:/weblogic/serverConfig> deleteMetadataLabel('mdsapp','server1','label1')
Executing operation: deleteMetadataLabel.
Deleted metadata label "label1".

4.5.3 listMetadataLabels

コマンド・カテゴリ:

WLSTでの使用: オンライン

説明

アプリケーションのリポジトリ・パーティションにあるメタデータ・ラベルを示します。このコマンドは、バージョニングをサポートするリポジトリにのみ適用されます。

構文

listMetadataLabels(application, server [, applicationVersion] [, tenantName])

引数

定義

application

リポジトリ・パーティション内のすべてのラベルを一覧表示する対象のアプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。アプリケーションがクラスタ内の複数の管理対象サーバーにデプロイされている場合、いずれのサーバー名も使用できます。複数のサーバー名を指定することはできません。

applicationVersion

省略可能。アプリケーション・バージョン(同じアプリケーションの複数のバージョンをデプロイした場合)。

tenantName

この操作で使用するテナントを識別する一意の名前。この引数は、マルチテナント・アプリケーションには必要ですが、非マルチテナント・アプリケーションには適用されません。非マルチテナント・アプリケーションでは、指定された値はいずれも無視されます。

例

次の例では、サーバーserver1にデプロイされたアプリケーションmdsappで使用可能なメタデータ・ラベルを一覧表示します。

wls:/weblogic/serverConfig> listMetadataLabels('mdsapp', 'server1')
Executing operation: listMetadataLabels.
Database Repository partition contains the following labels:
label2
label3

4.5.4 promoteMetadataLabel

コマンド・カテゴリ: アプリケーション・ラベル管理

WLSTでの使用: オンライン

説明

リポジトリにある先頭のバージョンにラベルに関連付けられるドキュメントを昇格します。このコマンドは、ロールバック機能の実現に役立ちます。このコマンドは、バージョニングをサポートするリポジトリにのみ適用されます。

構文

promoteMetadataLabel(application, server, name [, applicationVersion] [, tenantName])

引数

定義

application

メタデータを先頭に昇格させるリポジトリが関連するアプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。アプリケーションがクラスタ内の複数の管理対象サーバーにデプロイされている場合、いずれのサーバー名も使用できます。複数のサーバー名を指定することはできません。

name

リポジトリ・パーティションに昇格するラベルの名前。

applicationVersion

省略可能。アプリケーション・バージョン(同じアプリケーションの複数のバージョンをデプロイした場合)。

tenantName

この操作で使用するテナントを識別する一意の名前。この引数は、マルチテナント・アプリケーションには必要ですが、非マルチテナント・アプリケーションには適用されません。非マルチテナント・アプリケーションでは、指定された値はいずれも無視されます。

例

次の例では、サーバーserver1にデプロイされたアプリケーションmdsapp内のメタデータ・ラベルlabel1をヒントに昇格します。

wls:/weblogic/serverConfig> promoteMetadataLabel('mdsapp', 'server1','label1')
Executing operation: promoteMetadataLabel.
Promoted metadata label "label1" to tip.

4.5.5 purgeMetadataLabels

コマンド・カテゴリ: アプリケーション・ラベル管理

WLSTでの使用: オンライン

説明

指定されたパターンまたは経過期間に一致するメタデータ・ラベルをパージまたは一覧表示しますが、ラベルの一部であったメタデータ・ドキュメントは削除しません。purgeMetadataコマンドを実行することで、ドキュメントを削除できます。

構文

purgeMetadataLabels(repository, partition [, namePattern] [, olderThanInMin]
[, infoOnly] [, tenantName])

引数

定義

repository

メタデータ・ラベルがパージまたは一覧表示されるパーティションを含むMDSリポジトリの名前。

partition

メタデータ・ラベルがパージまたは一覧表示されるパーティションの名前。

namePattern

省略可能。ラベルの名前に一致するパターン。この引数を指定しない場合、パーティション内のすべてのラベルが消去されます。

この引数で使用できるパターンの詳細は、「共通名のパターン形式」を参照してください。

olderThanInMin

省略可能。ラベルの経過期間(分単位)。デフォルトは525600 (1年)です。

infoOnly

省略可能。有効な値はtrueまたはfalseです。これをtrueに設定すると、ラベルはパージされず、指定されたパターンに一致するラベルが一覧表示されます。

デフォルトは、falseです。

tenantName

この操作で使用するテナントを識別する一意の名前。この引数は、マルチテナント・アプリケーションには必要ですが、非マルチテナント・アプリケーションには適用されません。非マルチテナント・アプリケーションでは、指定された値はいずれも無視されます。

例

次の例では、指定されたnamePatternに一致するラベルを一覧表示しますが、それらのラベルは削除しません。

wls:/weblogic/serverConfig> purgeMetadataLabels(repository='mds-myRepos',
partition='partition1', namePattern='mylabel*', infoOnly='true' )

次の例では、指定されたnamePatternに一致し、かつ1年以上経過したラベルをパージします。

wls:/weblogic/serverConfig> purgeMetadataLabels(repository='mds-myRepos',
partition='partition1', namePattern='mylabel*')

次の例では、指定されたnamePatternに一致し、かつ30分以上経過したラベルを削除します。

wls:/weblogic/serverConfig> purgeMetadataLabels(repository='mds-myRepos',
partition='partition1',
namePattern='mylabel*', olderThanInMin='30')

4.6 アプリケーション・デプロイメント管理コマンド

WLST MDSアプリケーション・デプロイメント管理コマンドでは、MARファイルをインポートできます。

表4-6のコマンドを使用して、デプロイメントを管理します。「WLSTでの使用」列で、オンラインとは、実行中の管理サーバーに接続されている場合にのみ、コマンドが使用可能であることを意味します。オフラインとは、コマンドが実行中のサーバーに接続されてない場合のみに使用されることを意味します。オンラインまたはオフラインとは、コマンドは両方の状況に使用できることを意味します。

表4-6 アプリケーション・デプロイメント管理コマンド

使用するコマンド

目的

WLSTでの使用

getMDSArchiveConfig

MDSArchiveConfigオブジェクトを返します。

オフライン

importMAR

MARをインポートします。

オンライン

4.6.1 getMDSArchiveConfig

コマンド・カテゴリ: アプリケーション管理デプロイメント

WLSTでの使用: オフライン

説明

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

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

- setAppMetadataRepository - このメソッドは、アプリケーション・メタデータ・リポジトリの接続詳細を設定します。
アーカイブの既存のadf-config.xmlファイルにアプリケーションのメタデータ・リポジトリの構成が含まれていない場合、ターゲット・リポジトリを定義するために必要なすべての引数を指定する必要があります。データベース・ベースのリポジトリを定義するには、リポジトリ、パーティション、タイプおよびjndi引数を提供します。ファイル・ベースのリポジトリの場合、jndiのかわりにパス引数を提供します。

adf-config.xmlファイルには、アプリケーションのメタデータ・リポジトリの一部の構成がすでに存在する場合、変更する引数のサブセットのみ提供できます。この場合すべての引数を提供する必要はありません。ただし、ストア・タイプを変更する場合、対応するjndiまたはパス引数が必要です。

- setAppSharedMetadataRepository - このメソッドは、指定したネームスペースにマップするアプリケーション・アーカイブに共有リポジトリの接続詳細を設定します。
アーカイブの既存のadf-config.xmlファイルに、指定されたネームスペースにマップされる共有メタデータ・リポジトリの構成が含まれていない場合、必要なすべての引数(この場合は、リポジトリ、パーティション、タイプおよびjndiまたはパス)を指定する必要があります。データベース・ベースのリポジトリの場合、jndi引数を提供します。ファイル・ベースのリポジトリの場合、パースは必須の引数です。

指定したネームスペースにマップされる共有メタデータ・リポジトリの構成がすでにadf-config.xmlファイルに含まれており、特定の引数を変更する場合、それらの引数のサブセットだけを提供できます(それ以外はすべて不要)。

- save - toLocation引数を指定する場合、変更はターゲット・アーカイブ・ファイルに格納され、元のファイルは変更されないままです。これを指定しない場合、変更は元のファイル自体に保存されます。

構文

archiveConfigObject = getMDSArchiveConfig(fromLocation)

引数

定義

fromLocation

完全パスを含むearファイルの名前。

setAppMetadataRepositoryの構文は次のようになります。

archiveConfigObject.setAppMetadataRepository([repository] [, partition]
[, type] [, jndi] [, path])

引数

定義

repository

省略可能。アプリケーションのリポジトリの名前。

partition

省略可能。アプリケーションのメタデータ用のパーティションの名前。

type

省略可能。リポジトリへの接続のタイプ、ファイルまたはデータベース。有効な値は「File」または「DB」です(大文字と小文字は区別されません)。

jndi

省略可能。データベース接続のJNDI場所。タイプをDBに設定する場合、この引数は必須です。タイプをFileに設定すると、この引数は無視されます。

path

省略可能。メタデータ・ファイルのディレクトリ。タイプをFileに設定する場合、この引数は必須です。タイプをDBに設定すると、この引数は無視されます。

setAppSharedMetadataRepositoryの構文は次のようになります。

archiveConfigObject.setAppSharedMetadataRepository(namespace [, repository]
[, partition] [, type] [, jndi] [, path])

引数

定義

namespace

接続詳細を設定する場合、共有リポジトリを検索するために使用するネームスペース。

repository

省略可能。アプリケーションの共有リポジトリの名前。

partition

省略可能。アプリケーションの共有メタデータのパーティションの名前。

type

省略可能。リポジトリへの接続のタイプ、ファイルまたはデータベース。有効な値は「File」または「DB」です(大文字と小文字は区別されません)。

jndi

省略可能。データベース接続のJNDI場所。タイプをDBに設定する場合、この引数は必須です。タイプをFileに設定する場合、この引数は無視されます。

path

省略可能。ファイル・メタデータ・ストアの場所。タイプをFileに設定する場合、この引数は必須です。タイプをDBに設定する場合、この引数は無視されます。

保存するための構文は次のとおりです:

archiveConfigObject.save([toLocation])

引数

定義

toLocation

省略可能。変更の保存先の絶対パスを含むファイル名。このオプションを提供しない場合、変更はこの構成オブジェクトで表されるアーカイブに書き込まれます。

例

次の例では、アーカイブのadf-config.xmlファイルには定義されたアプリケーションおよび共有メタデータ・リポジトリがない場合、詳細な接続情報を提供する必要があります。

wls:/offline> archive = getMDSArchiveConfig(fromLocation='/tmp/testArchive.ear')

wls:/offline> archive.setAppMetadataRepository(repository='AppRepos1',
partition='partition1', type='DB', jndi='mds-jndi1')

wls:/offline> archive.setAppSharedMetadataRepository(namespace='/a',
repository='SharedRepos1', partition='partition2', type='File',
path='/temp/dir')
wls:/offline> archive.save()

次の例では、アーカイブのadf-config.xmlファイルには定義されたアプリケーションおよび共有メタデータ・リポジトリがすでにある場合、すべての引数は省略できます。変更する引数のみを設定できます。

wls:/offline> archive = getMDSArchiveConfig(fromLocation='/tmp/testArchive.ear')
wls:/offline> archive.setAppMetadataRepository(partition='MDS-partition2')
wls:/offline> archive.setAppSharedMetadataRepository(namespace='/a',
repository='SharedRepos2')
wls:/offline> archive.save(toLocation='/tmp/targetArchive.ear')

4.6.2 importMAR

コマンド・カテゴリ: アプリケーション管理デプロイメント

WLSTでの使用: オンライン

説明

アプリケーションのEARファイルとともにパッケージ化されるMARからメタデータをインポートします。MARがすでにパーティションにインポートされている場合、コマンドにより以前のバージョンが削除され、新しいバージョンがインポートされます。

構文

importMAR(application, server [, force] [, applicationVersion] )

引数

定義

application

メタデータをインポートするアプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。

force

省略可能。変更されたドキュメントおよびMARのみをインポートするかどうかを指定するブール値(trueまたはfalse)。

データベース・ベースのリポジトリでは、この引数をfalseに設定すると、変更されたMARの新しいドキュメントまたは変更されたドキュメントのみがインポートされます。コマンドにより、ドキュメントがインポートされる各MARのラベルが作成されます。ラベルの形式は次のとおりです:

postDeploy_application_name_MAR_name_MAR_checksum

ファイル・ベースのリポジトリでは、この引数をfalseに設定すると、変更されたMARのみがインポートされます。コマンドにより、個々のドキュメントが比較されることはなく、インポートされた各MARのリポジトリ内にファイルが作成されます。

デフォルトは、trueです。

applicationVersion

省略可能。アプリケーション・バージョン(同じアプリケーションの複数のバージョンをデプロイした場合)。

例

次の例では、MARからメタデータをアプリケーションmdsappにインポートします。

wls:/weblogic/serverConfig> importMAR('mdsapp','server1')
Executing operation: importMAR.
"importMAR" operation completed. Summary of "importMAR" operation is:
/app1/jobs.xml
/app1/mo.xml
2 documents successfully transferred.

4.7 マルチテナンシ管理コマンド

WLST MDSマルチテナンシ・コマンドでは、テナントの一覧表示、およびテナントのプロビジョニング解除が可能です。

表4-7のコマンドを使用して、テナントを管理します。「WLSTでの使用」列で、オンラインとは、実行中の管理サーバーに接続されている場合にのみ、コマンドが使用可能であることを意味します。オフラインとは、コマンドが実行中のサーバーに接続されてない場合のみに使用されることを意味します。オンラインまたはオフラインとは、コマンドは両方の状況に使用できることを意味します。

表4-7 マルチテナンシ管理コマンド

使用するコマンド

目的

WLSTでの使用

deprovisionTenant

メタデータ・ストアからテナントをプロビジョニング解除します。

オンライン

listTenants

テナントをリストします。

オンライン

4.7.1 deprovisionTenant

メタデータ・ストアからテナントをプロビジョニング解除します。テナントに関連付けられているすべてのメタデータがストアから削除されます

構文

deprovisionTenant(repository, partition, tenantName)

引数

定義

repository

テナントを含むリポジトリの名前。

partition

テナントを含むパーティションの名前。

tenantName

この操作で使用するテナントを識別する一意の名前。

例

次の例では、tenantNameがtenant1であるテナントをプロビジョニング解除します。

wls:/weblogic/serverConfig> deprovisionTenant("mds-myrepos", "part1", "tenant1")
Executing operation: deprovisionTenant.
Tenant "tenant1" has been deprovisioned.

4.7.2 listTenants

MDSリポジトリ・パーティション内のすべてのテナントを一覧表示します。

構文

listTenants(repository, partition)

引数

定義

repository

テナントを含むリポジトリの名前。

partition

テナントを含むパーティションの名前。

例

次の例では、指定されたリポジトリおよびパーティション内のすべてのテナントを一覧表示します。

wls:/weblogic/serverConfig> listTenants("mds-myrepos", "part1")
Executing operation: listTenants.
0  GLOBAL
1  tenant1
2  tenant2
3  tenant3

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

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

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

- ADF固有のWLSTコマンド

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

例

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

6 DMSカスタムWLSTコマンド

パフォーマンス・メトリックの表示やイベント・トレースの構成には、ダイナミック・モニタリング・サービス(DMS)のカスタムWLSTコマンドを使用します。

この章では、コマンドの構文および引数を説明し、コマンドの例を示します。

表6-1のカテゴリのDMSコマンドを使用して、パフォーマンス・メトリックの表示およびイベント・トレースの構成を行います。

表6-1 DMSコマンド・カテゴリ

コマンド・カテゴリ

説明

DMSの構成コマンド

DMSシステム構成パラメータを設定および表示します。

DMSメトリック・コマンド

パフォーマンス・メトリックに関する情報を表示します。

DMSパラメータ・スコープ・メトリック・ルール・コマンド

一連のナウン・タイプを一連のパラメータ名のセットに関連付ける制約およびルールを指定して、メトリックを作成します

DMSイベント・トレース・コマンド

イベント・トレースを構成します

6.1 DMS構成コマンド

WLST DMS構成コマンドでは、DMW構成パラメータについて情報を表示することや、パラメータの値を設定することができます。

表6-2のコマンドを使用して、システム・プロパティを構成し、システム・プロパティを表示します。「WLSTでの使用」列で、オンラインとは、実行中の管理サーバーに接続されている場合にのみ、コマンドが使用可能であることを意味します。オフラインとは、コマンドが実行中のサーバーに接続されてない場合のみに使用されることを意味します。オンラインまたはオフラインとは、コマンドは両方の状況に使用できることを意味します。

表6-2 DMSの構成コマンド

使用するコマンド

目的

WLSTでの使用

listDMSConfigurationParameters

1つ以上のDMS構成パラメータに関する情報を表示します。

オンライン

setDMSConfigurationParameter

DMS構成パラメータの値を設定します。

オンライン

6.1.1 listDMSConfigurationParameters

オンラインで使用します。

説明

1つ以上のDMSシステム構成パラメータに関する情報を表示します。

構文

listDMSConfigurationParameters([name][, server])

引数

定義

name

パラメータ名。

server

サーバーの名前。

例

次の例では、すべてのDMSシステム構成パラメータに関する情報を表示します。

listDMSConfigurationParameters()

Server: AdminServer

Parameter Config Value Runtime Value
DMSClockType DEFAULT DEFAULT
SensorActivationLevel NORMAL NORMAL
DMSClockUnits MICROSECONDS MICROSECONDS

次の例では、DMSシステム構成パラメータDMSClockUnitsに関する情報を表示します。

listDMSConfigurationParameters(name="DMSClockUnits")

Server: AdminServer

Parameter Config Value Runtime Value
DMSClockUnits MICROSECONDS MICROSECONDS

6.1.2 setDMSConfigurationParameter

オンラインで使用します。

説明

指定したDMSシステム構成パラメータの値を設定します。このコマンドは、既存のDMSシステム・プロパティ(現在は非推奨)を置き換えます。

構文

setDMSConfigurationParameter(name, value, server)

引数

定義

name

パラメータ名。

value

パラメータの値。

server

サーバーの名前。

次の表に、サポートされている構成パラメータを、対応するシステム・プロパティとともにリストします。これらのシステム・プロパティは、現在は非推奨です。

構成パラメータ

値

デフォルト

非推奨のシステム・プロパティ

DMSClockType

default | highres

default

oracle.dms.clock

DMSClockUnits

milliseconds | microseconds | nanoseconds

microseconds

oracle.dms.clock.units

SensorActivationLevel

none | normal | heavy | all

normal

oracle.dms.sensors

DMSPublisherClass

任意の文字列

null (構成デフォルト)

oracle.dms.publisher.classes

DMSHTTPPort

任意の数値のポート番号

0 (構成デフォルト)

oracle.dms.httpd.port.start

例

次の例では、DMSClockTypeのHIGHRESへの設定を示します。

setDMSConfigParameter(name= 'DMSClockType', value='HIGHRES', server='mymanaged')

6.2 DMSメトリック・コマンド

WLST DMSメトリック・コマンドでは、パフォーマンス・メトリックを表示できます。

表6-3のコマンドを使用して、特定のパフォーマンス・メトリック、一連のパフォーマンス・メトリックまたは特定のサーバーまたはコンポーネントに対するすべてのパフォーマンス・メトリックに関する情報を表示します。「WLSTでの使用」列で、オンラインとは、実行中の管理サーバーに接続されている場合にのみ、コマンドが使用可能であることを意味します。オフラインとは、コマンドが実行中のサーバーに接続されてない場合のみに使用されることを意味します。オンラインまたはオフラインとは、コマンドは両方の状況に使用できることを意味します。

メトリックの詳細は、『Oracle Fusion Middleware Oracle Fusion Middlewareの管理』の章「Oracle Fusion Middlewareの監視」、および『Oracle Fusion Middlewareパフォーマンスのチューニング・ガイド』の章「Oracle Dynamic Monitoring Serviceの使用方法」を参照してください。

表6-3 DMSメトリック・コマンド

使用するコマンド

目的

WLSTでの使用

displayMetricTableNames

使用可能なメトリック表の名前を表示します。

オンライン

displayMetricTables

DMSメトリック表の内容を表示します。

オンライン

dumpMetrics

使用可能なメトリックを表示します。

オンライン

reloadMetricRules

メトリック・ルールをリロードします。

オンライン

6.2.1 displayMetricTableNames

コマンド・カテゴリ: DMSメトリック

WLSTでの使用: オンライン

説明

使用可能なDMSメトリック表の名前を表示します。戻り値は、メトリック表名のリストです。

構文

displayMetricTableNames([servers])

引数

定義

servers

省略可能。メトリックを取得するサーバーを指定します。有効な値は、WebLogic Serverインスタンス名およびシステム・コンポーネント名のリストです。

1つのサーバーを指定するには、次の構文を使用します:

servers='servername'

複数のサーバーを指定するには、次のいずれかの構文オプションを使用します:

servers=['servername1', 'servername2', ...]
servers=('servername1', 'servername2', ...)

この引数を指定しない場合、コマンドは、すべてのWebLogicサーバーおよびシステム・コンポーネントのメトリック表名のリストを戻します。

Oracle HTTP Serverなどのシステム・コンポーネントの場合は、次の書式を使用します。

servers=['component_name], servertype='component_type')

例

次の例では、すべてのWebLogicサーバーおよびシステム・コンポーネントのメトリック表名を一覧表示します。

displayMetricTableNames()
ADF
ADFc
ADFc_Metadata_Service
ADFc_Region
ADFc_Taskflow
ADFc_Viewport
BAM_common_connectionpool
BAM_common_connectionpool_main
BAM_common_messaging
BAM_common_messaging_consumers
.
.
.

次の例では、WebLogic管理対象サーバーwls_server1のメトリック表の名前を表示します。

displayMetricTableNames(servers='wls_server1')
ADF
JVM
JVM_ClassLoader
JVM_Compiler
JVM_GC
JVM_Memory
JVM_MemoryPool
JVM_MemorySet
JVM_OS
JVM_Runtime
.
.
.

次の例では、2つのWebLogic管理対象サーバーのメトリック表名を示します。

displayMetricTableNames(servers=['wls_server1', 'bam-server1'])
ADF
ADFc
ADFc_Metadata_Service
ADFc_Region
ADFc_Taskflow
ADFc_Viewport
BAM_common_connectionpool
BAM_common_connectionpool_main
BAM_common_messaging
BAM_common_messaging_consumers
.
.
.

次の例では、Oracle HTTP Serverインスタンスohs_1のメトリック表の名前を表示します。

displayMetricTableNames(servers='ohs_1', servertype='OHS')

6.2.2 displayMetricTables

コマンド・カテゴリ: DMSメトリック

WLSTでの使用: オンライン

説明

DMSメトリック表の内容を表示します。

戻り値は、DMSメトリック表のリストです。このリストには、各表に関する次の情報が含まれています。

- メトリック表名。

- メトリック表スキーマ情報。

- メトリック表の行。

メトリック表スキーマ情報には、次のものが含まれます。

- 列の名前。

- 列値の型。

- 列の単位。

- 列の説明。

構文

displayMetricTables([metricTable_1] [, metricTable_2], [...] [, servers]
[, variables])

引数

定義

metricTable_n

省略可能。メトリック表のリストを指定します。デフォルトでは、この引数はすべての使用可能なメトリックを表示します。メトリック表名では、単純なパターン一致のための特殊文字を使用できます。マッチング文字「?」は単一の文字に一致します。文字「*」は、0文字以上の文字列に一致します。

メトリック表名を指定します。カンマ区切りのリストで、複数のメトリック表名を指定できます。

これらは、WLSTコマンドdisplayMetricTableNamesによって出力されるものと同じ名前です。

servers

省略可能。メトリックを取得するサーバーを指定します。有効な値は、WebLogic Serverインスタンス名およびシステム・コンポーネント名のリストです。

1つのサーバーを指定するには、次の構文を使用します:

servers='servername'

複数のサーバーを指定するには、次のいずれかの構文オプションを使用します:

servers=['servername1', 'servername2', ...]
servers=('servername1', 'servername2', ...)

この引数を指定しない場合、コマンドは、すべてのWebLogicサーバーおよびシステム・コンポーネントのメトリック表のリストを戻します。

Oracle HTTP Serverなどのシステム・コンポーネントの場合は、次の書式を使用します。

servers=['component_name], servertype='component_type')

variables

省略可能。メトリックの集約パラメータを定義します。有効な値は、名前と値のペアのセットです。次の構文を使用します:

variables={name1:value1, name2:value2, ...}

特定の名前と値のペアは、集約されたメトリック表によって異なります。集約されたメトリック表のすべては、変数名の特定のセットがあります。

例

次の例では、JVMおよびweblogic.management.runtime.WebAppComponentRuntimeMBeanメトリック表のデータを表示し、wls_server1およびwls_server2から取得されたデータに制限します。

displayMetricTables('JVM','weblogic.management.runtime.WebAppComponentRuntimeMBean',
servers=['wls_server1','wlsserver2'])
.
.
.

---
JVM
---

Host:   host.example.com
Name:   JVM
Parent: /
Process:        wls_server_2:7004
ServerName:     wls_server_2
activeThreadGroups.maxValue:    8.0     groups
activeThreadGroups.minValue:    7.0     groups
activeThreadGroups.value:       8       groups
activeThreads.maxValue: 58.0    threads
activeThreads.minValue: 39.0    threads
activeThreads.value:    57      threads
freeMemory.maxValue:    174577.0        kbytes
freeMemory.minValue:    12983.0 kbytes
freeMemory.value:       98562   kbytes
startTime.value:        1368467917680   msecs
.
.
.

次の例では、指定したメトリックの集約パラメータを持つ集約されたメトリック表を示します。

displayMetricTables('j2ee_application:webservices_port_rollup',
servers=['wls_server1','ls_server1'],
variables={'host':'hostname', 'servletName':'dms'})
----------------------------------------
j2ee_application:webservices_port_rollup
----------------------------------------

Faults: 0
Requests:       0
Requests.averageTime:   0.0
Requests.totalTime:     0.0
ServerName:     wls_server1
moduleName:     RuntimeConfigService
moduleType:     WEBs
portName:       RuntimeConfigServicePortSAML
processRequest.active:  0
service.throughput:     0.0
service.time:   0.0
startTime:      1238182359291
webserviceName: RuntimeConfigService

Faults: 0
Requests:       0
Requests.averageTime:   0.0
Requests.totalTime:     0.0
ServerName:     wls_server1
moduleName:     TaskMetadataService
moduleType:     WEBs
portName:       TaskMetadataServicePort
processRequest.active:  0
service.throughput:     0.0
service.time:   0.0
startTime:      1238182358096
webserviceName: TaskMetadataService
.
.
.

次の例では、指定したパターンに一致する名前のメトリック表を示します。

displayMetricTables('J??', 'JVM_*')
.
.
.
---------------
JVM_ThreadStats
---------------

Host:   hostname.com
JVM:    JVM
Name:   threads
Parent: /JVM/MxBeans
Process:        AdminServer:7001
ServerName:     AdminServer
contention.value:       enabled in JVM
daemon.value:   85      threads
deadlock.value: 0       threads
live.value:     89      threads
peak.value:     95      threads
started.value:  836     threads
.
.
.

6.2.3 dumpMetrics

コマンド・カテゴリ: DMSメトリック

WLSTでの使用: オンライン

説明

内部フォーマットまたはXMLで利用可能なメトリックを示します。戻り値は、テキスト・ドキュメントです。

構文

dumpMetrics([servers] [, format])

引数

定義

servers

省略可能。メトリックを取得するサーバーを指定します。有効な値は、WebLogic Serverインスタンス名およびシステム・コンポーネント名のリストです。

1つのサーバーを指定するには、次の構文を使用します:

servers='servername'

複数のサーバーを指定するには、次のいずれかの構文オプションを使用します:

servers=['servername1', 'servername2', ...]
servers=('servername1', 'servername2', ...)

この引数を指定しない場合、コマンドは、すべてのWebLogicサーバーおよびシステム・コンポーネントのメトリック表のリストを戻します。

Oracle HTTP Serverなどのシステム・コンポーネントの場合は、次の書式を使用します。

servers=['component_name], servertype='component_type')

format

省略可能。コマンド出力フォーマットを指定します。有効な値は、raw(デフォルト)、xmlおよびpdmlです。次に例を示します。

format='raw'
format='xml'
format='pdml'

DMSの生のフォーマットは、単純なメトリック表示フォーマットで、1つの行に1つのメトリックを表示します。

例

次の例は、XMLフォーマットにあるネイティブWebLogic Serverメトリックおよび内部的なDMSメトリックを含むすべての使用可能なメトリックを出力します。

dumpMetrics(format='xml')
<table name='weblogic_j2eeserver:jvm' keys='ServerName serverName'
componentId='wls_server1' cacheable='false'>
<row cacheable='false'>
<column name='serverName'><![CDATA[wls_server2]]></column>
<column name='nurserySize.value' type='DOUBLE'>0.0</column>
<column name='jdkVersion.value'><![CDATA[1.6.0_05]]></column>
<column name='jdkVendor.value'><![CDATA[BEA Systems, Inc.]]></column>
<column name='daemonThreads.active' type='LONG'>68</column>
<column name='cpuUsage.percentage' type='DOUBLE'>100.0</column>
<column name='threads.active' type='LONG'>71</column>
<column name='ServerName'><![CDATA[wls_server2]]></column>
<column name='heapUsed.value' type='DOUBLE'>0.0</column>
</row>

次の例では、Server-0からのメトリックをデフォルトの生のフォーマットで出力します。

dumpMetrics(servers='Server-0')
.
.
.
/JVM/MxBeans/threads/Thread-44 [type=JVM
_Thread]
ECID.value:        null
RID.value: null
blocked.value:     0       msec
blockedCount.value:        1       times
cpu.value: 40      msecs
lockName.value:    null
lockOwnerID.value: null
lockOwnerName.value:       null
name.value:        LDAPConnThread-0 ldap://host:7001
state.value:       RUNNABLE
waited.value:      0       msec
waitedCount.value: 0       times
/JVM/MxBeans/threads/Thread-45 [type=JVM_Thread]
ECID.value:        null
RID.value: null
blocked.value:     0       msec
.
.
.

次の例では、wls_server1とwls_server2のメトリックをXML形式で出力します。

dumpMetrics(servers=['wls_server1', 'wls_server2'], format='xml')
<table name='oracle_soainfra:high_latency_sync_composites' keys='ServerName
soainfra_composite soainfra_composite_revision soainfra_domain'
componentId='wls_server2' cacheable='false'>
</table>
<table name='weblogic_j2eeserver:ejb_transaction' keys='ServerName appName
ejbModuleName name serverName' componentId='wls_server2' cacheable='false'>
<row cacheable='false'>
<column name='serverName'><![CDATA[wls_server2]]></column>
<column name='name'><![CDATA[MessagingClientParlayX]]></column>
<column name='ejbTransactionCommit.percentage' type='DOUBLE'>0.0</column>
<column name='ejbTransactionRollback.completed' type='LONG'>0</column>
<column name='ejbTransactionTimeout.throughput' type='DOUBLE'>0.0</column>
<column name='ejbTransactionCommit.completed' type='LONG'>0</column>
<column name='ejbTransactionTimeout.completed' type='LONG'>0</column>
<column name='appName'><![CDATA[usermessagingserver]]></column>
<column name='ejbTransactionRollback.throughput' type='DOUBLE'>0.0</column>
<column name='ServerName'><![CDATA[wls_server2]]></column>
<column name='ejbTransactionCommit.throughput' type='DOUBLE'>0.0</column>
<column name='ejbModuleName'><![CDATA[sdpmessagingclient-ejb-parlayx.jar]]></column>
</row>
.
.
.

6.2.4 reloadMetricRules

コマンド・カテゴリ: DMSメトリック

WLSTでの使用: オンライン

説明

メトリック・ルールをリロードします。システム・コンポーネントをデプロイした後、またはメトリック・ルールを変更した後に、このコマンドを実行する必要があります。一般的に、メトリック・ルールは変更しないことをお薦めします。

構文

reloadMetricRules()

例

次の例では、ドメイン内で実行されているすべてのサーバーのメトリック・ルールをリロードします。

reloadMetricRules()
Location changed to domainRuntime tree. This is a read-only tree with DomainMBean
as the root.
For more help, use help(domainRuntime)
loaded 'server-mds-11.0.xml'
loaded 'server-weblogic_j2ee_application_webservices-11.0.xml'
loaded 'server-weblogic_j2eeserver_adf-11.0.xml'
loaded 'server-weblogic_soa_composite-11.0.xml'
loaded 'server-weblogic_j2eeserver_webservices-11.0.xml'
loaded 'server-oracle_sdpmessaging-11.0.xml'
loaded 'server-weblogic_j2ee_application_webcenter-11.0.xml'
loaded 'server-weblogic_j2eeserver-11.0.xml'
reloaded metric rules for server 'wls_server_1'

.
.
.

6.3 DMSパラメータ・スコープ・メトリック・ルール・コマンド

WLST DMSパラメータ・スコープ・メトリック・コマンドでは、ナウン・タイプのセットをパラメータ名のセットに関連付ける制約およびルールを指定して、メトリックを作成できます。

表6-4のパラメータ・スコープ・メトリック・コマンドを使用して、パラメータ・スコープ・メトリックを管理します。

表6-4 DMSパラメータ・スコープ・メトリック・ルール・コマンド

使用するコマンド

目的

WLSTでの使用

createDMSScopedMetricsParameterConstraint

setParameterScopedMetricsRuleコマンドで使用できるパラメータ制約を作成します。

オンライン

deleteDMSParameterScopedMetricsRules

指定したパラメータ・スコープ・メトリック・ルールを削除します。

オンライン

dumpParameterScopedMetrics

指定したルールIDのパラメータ・スコープ・メトリック・データを表示します。

オンライン

listDMSContextParameters

DMSで認識されている実行コンテキスト・パラメータのセットをリストします。

オンライン

listDMSParameterScopedMetricsRules

現在のパラメータ・スコープ・メトリックの構成を表示します。

オンライン

resetDMSParameterScopedMetrics

特定のルール識別子に関連付けられているパラメータ・スコープ・メトリック・データをリセットします。

オンライン

sampleDMSContextParameterValues

指定された名前のコンテキスト・パラメータの値セットのサンプルを収集します。

オンライン

setDMSParameterScopedMetricsRule

パラメータ・スコープ・メトリック・ルールを作成または更新します。

オンライン

6.3.1 createDMSScopedMetricsParameterConstraint

コマンド・カテゴリ: DMSパラメータ・スコープ・メトリック

WLSTでの使用: オンライン

説明

setParameterScopedMetricsRuleコマンドで使用できる制約を作成します。

構文

createDMSScopedMetricsParameterConstraint(name [, values] [,maxnumofvalues])

引数

定義

name

制約の参照先パラメータの名前。

values

省略可能。制約によって適用される特定の値のリスト。

maxmumofvalues

省略可能。制約で使用される値の最大数。関係するにもかかわらず指定しなかった場合、値が10と仮定されます。valuesオプションが指定されている場合、この値は無視されます。

例

次の例では、URIという名前のパラメータ制約を作成します。値MyApp/advSearch.jspxおよびMyApp/basicSearch.jspxが適用されます。

createDMSScopedMetricsParameterConstraint(  name="URI", values=["MyApp/advSearch.jspx", "MyApp/basicSearch.jspx"])

6.3.2 deleteDMSParameterScopedMetricsRules

コマンド・カテゴリ: DMSパラメータ・スコープ・メトリック

WLSTでの使用: オンライン

説明

指定したパラメータ・スコープ・メトリック・ルールおよび収集したデータを削除します。

構文

deleteDMSParameterScopedMetricsRules([server,] ids)

引数

定義

server

省略可能。パラメータ・スコープ・メトリックの削除元となるサーバーを指定します。有効な値は、WebLogic Serverインスタンス名およびシステム・コンポーネント名のリストです。

サーバーを指定するには、次の構文を使用します。

server='servername'

この引数を指定しない場合、コマンドは、すべてのWebLogicサーバーおよびシステム・コンポーネントのメトリック表のリストを戻します。

この引数を使用するには、管理サーバーに接続している必要があります。

Oracle HTTP Serverなどのシステム・コンポーネントの場合は、次の書式を使用します。

servers=['component_name], servertype='component_type')

ids

削除するルールの識別子のリスト。複数の識別子を指定するには、IDをカンマで区切り、全体を大カッコで囲みます。次に例を示します。

ids=["id1", "id2"

例

次の例では、管理対象サーバーwls_server1のIDがrule1のパラメータ・スコープ・メトリック・ルールを削除します。

deleteDMSParameterScopedMetricsRules(server='wls_server1', rule1)

6.3.3 dumpParameterScopedMetrics

コマンド・カテゴリ: DMSパラメータ・スコープ・メトリック

WLSTでの使用: オンライン

説明

指定したルールIDのパラメータ・スコープ・メトリック・データを表示します。

構文

dumpParameterScopedMetrics([server,] ruleid)

引数

定義

server

省略可能。パラメータ・スコープ・メトリック・データのダンプ先となるサーバーを指定します。有効な値は、WebLogic Serverインスタンス名およびシステム・コンポーネント名のリストです。

サーバーを指定するには、次の構文を使用します。

server='servername'

この引数を指定しない場合、コマンドは、すべてのWebLogicサーバーおよびシステム・コンポーネントのメトリック表のリストを戻します。

この引数を使用するには、管理サーバーに接続している必要があります。

Oracle HTTP Serverなどのシステム・コンポーネントの場合は、次の書式を使用します。

servers=['component_name], servertype='component_type')

ruleid

データを表示するパラメータ・スコープ・メトリック・ルールのID。

例

次の例では、管理対象サーバーwls_server1のパラメータ・スコープ・メトリック・ルールregionRuleのデータを表示します。

dumpParameterScopedMetrics(server="wls_server1", ruleid="regionRule")

6.3.4 listDMSContextParameters

コマンド・カテゴリ: DMSパラメータ・スコープ・メトリック

WLSTでの使用: オンライン

説明

DMSで認識されている実行コンテキスト・パラメータのセットをリストします。

構文

listDMSContextParameters([server][, parameternames] [, verbose])

引数

定義

server

省略可能。実行コンテキスト・パラメータを表示するサーバーを指定します。有効な値は、WebLogic Serverインスタンス名およびシステム・コンポーネント名のリストです。

サーバーを指定するには、次の構文を使用します。

server='servername'

この引数を指定しない場合、コマンドは、すべてのWebLogicサーバーおよびシステム・コンポーネントのメトリック表のリストを戻します。

この引数を使用するには、管理サーバーに接続している必要があります。

Oracle HTTP Serverなどのシステム・コンポーネントの場合は、次の書式を使用します。

servers=['component_name], servertype='component_type')

parameternames

省略可能。該当する実行コンテキスト・パラメータの名前のリスト。サーバー上に見つからないパラメータ名は無視されます(エラーはレポートされません)。この引数が使用されない場合、すべての実行コンテキスト・パラメータがリストされます。

verbose

省略可能。trueの場合、各実行コンテキスト・パラメータについて、(使用可能な場合)実行コンテキスト・パラメータの説明が、可能な値およびその説明のセットとともに出力に含まれます。

例

次の例では、管理対象サーバーwls_server1のパラメータ・スコープ・メトリック・ルールを示します。

listDMSContextParameters(server='wls_server1')
Server: ManagedServer1

Module
FlowId
Action
RCID

6.3.5 listDMSParameterScopedMetricsRules

コマンド・カテゴリ: DMSパラメータ・スコープ・メトリック

WLSTでの使用: オンライン

説明

現在のパラメータ・スコープ・メトリックの構成を表示します。

構文

listDMSParameterScopedMetricsRules([server])

引数

定義

server

省略可能。パラメータ・スコープ・メトリック構成を表示するサーバーを指定します。有効な値は、WebLogic Serverインスタンス名およびシステム・コンポーネント名のリストです。

サーバーを指定するには、次の構文を使用します。

server='servername'

この引数を指定しない場合、コマンドは、すべてのWebLogicサーバーおよびシステム・コンポーネントのメトリック表のリストを戻します。

この引数を使用するには、管理サーバーに接続している必要があります。

Oracle HTTP Serverなどのシステム・コンポーネントの場合は、次の書式を使用します。

servers=['component_name], servertype='component_type')

例

次の例では、管理対象サーバーwls_server1のパラメータ・スコープ・メトリック・ルールを示します。

listDMSParameterScopedMetricsRules(server='wls_server1')

Rule: ruleA
Noun types:
JDBC_Connection
Context Parameter Constraints:
Parameter: URI
Constraining values:
MyApp/advSearch.jspx
MyApp/basicSearch.jspx

6.3.6 resetDMSParameterScopedMetrics

コマンド・カテゴリ: DMSパラメータ・スコープ・メトリック

WLSTでの使用: オンライン

説明

特定のルール識別子に関連付けられているパラメータ・スコープ・メトリック・データをリセットします。この操作は原子性でない場合があるため、リセット操作が進行中でも、メトリック・データは引き続き収集されます。

構文

resetDMSParameterScopedMetrics([server,] ids)

引数

定義

server

省略可能。パラメータ・スコープ・メトリックをリセットするサーバーを指定します。有効な値は、WebLogic Serverインスタンス名およびシステム・コンポーネント名のリストです。

サーバーを指定するには、次の構文を使用します。

server='servername'

この引数を指定しない場合、コマンドは、すべてのWebLogicサーバーおよびシステム・コンポーネントのメトリック表のリストを戻します。

この引数を使用するには、管理サーバーに接続している必要があります。

Oracle HTTP Serverなどのシステム・コンポーネントの場合は、次の書式を使用します。

servers=['component_name], servertype='component_type')

ids

リセットするルールの識別子のリスト。複数の識別子を指定するには、IDをカンマで区切り、全体を大カッコで囲みます。次に例を示します。

ids=["id1", "id2"

例

次の例では、管理対象サーバーwls_server1のIDがruleAのルールをリセットします。

resetDMSParameterScopedMetrics(server="wls_server1", ids="ruleA")

6.3.7 sampleDMSContextParameterValues

コマンド・カテゴリ: DMSパラメータ・スコープ・メトリック

WLSTでの使用: オンライン

説明

指定された名前のコンテキスト・パラメータの値セットのサンプルを収集します。

構文

sampleDMSContextParameterValues([parametername] [, naxmuofvaleus] [,action])

引数

定義

parametername

省略可能。サンプリング対象のコンテキスト・パラメータの名前。この引数は、引数actionとの組合せで使用する必要があります。

manmumofvalues

省略可能。サンプルに含める個別値の最大数。省略した場合、値10が適用されます。値0では、すべての個別値がサンプリングされます。コンテキスト・パラメータによっては、これは無制限のサイズのセットをサンプリングすることを意味します。action="start"を指定した場合にのみ関連します。

action

省略可能。サンプリング対象のアクション。この引数は、引数parameternameとの組合せで使用する必要があります。

有効な値は、次のとおりです。

- start: 値のサンプリングを開始します。

- stop: 値のサンプリングを停止して値を表示します。

- show: サンプリング値のヒストグラムを表示します。

例

次の例では、パラメータbespoke.ServiceLevelの値のサンプリングを開始します。

sampleDMSContextParameterValues(parametername="bespoke.ServiceLevel", maxnumofvalues=5, action="start")
Values of the parameter bespoke.ServiceLevel are now being sampled.
List of parameters currently being sampled:
bespoke.ServiceLevel has been sampled for 0 seconds.

次の例では、サンプリングを停止して、値のヒストグラムを表示します。

sampleDMSContextParameterValues()
List of parameters currently being sampled:    bespoke.ServiceLevel has been sampled for 87 seconds.
sampleDMSContextParameterValues(parametername="bespoke.ServiceLevel", action="stop")
Histogram of values for parameter bespoke.ServiceLevel.
Gold 21
Silver 5
Bronze 37
Values of the parameter bespoke.ServiceLevel will no longer be sampled.

6.3.8 setDMSParameterScopedMetricsRule

コマンド・カテゴリ: DMSパラメータ・スコープ・メトリック

WLSTでの使用: オンライン

説明

パラメータ・スコープ・メトリック・ルールを作成または更新します。特定のナウン・タイプとパラメータの組合せについて、メトリックのコレクションを管理できるのは一度に1つのルールです。たとえば、コンテキスト・パラメータURIおよびナウン・タイプJDBC_Connectionに基づいて、2つの個別のルールでパラメータ・スコープ・メトリックの収集を試行することはできません。

構文

setDMSParameterScopedMetricsRule([server,] id, nountypes [, ctxparamconstraints][, actparamconstraints] [,replace={true|false}])

引数

定義

server

省略可能。パラメータ・スコープ・メトリック・ルールを設定するサーバーを指定します。有効な値は、WebLogic Serverインスタンス名およびシステム・コンポーネント名のリストです。

サーバーを指定するには、次の構文を使用します。

server='servername'

この引数を指定しない場合、コマンドは、すべてのWebLogicサーバーおよびシステム・コンポーネントのメトリック表のリストを戻します。

この引数を使用するには、管理サーバーに接続している必要があります。

Oracle HTTP Serverなどのシステム・コンポーネントの場合は、次の書式を使用します。

servers=['component_name], servertype='component_type')

id

ルールの識別子。

nountypes

ルールが適用されるナウン・タイプのリスト。

ctxparamconstraints

省略可能。このルールで使用されるコンテキスト・パラメータ制約のリスト。この引数またはactparamconstraintsのうち少なくとも1つを指定する必要があります。

「createDMSScopedMetricsParameterConstraint」を参照してください。

actparamconstraints

省略可能。このルールで使用されるアクティブ化パラメータ制約のリスト。この引数またはctxparamconstraintsのうち少なくとも1つを指定する必要があります。

「createDMSScopedMetricsParameterConstraint」を参照してください。

replace

省略可能。trueの場合、同じIDを持つ既存のルールが新規ルールによって置き換えられます。falseまたは設定しない場合で、そのIDを持つルールがすでに存在する場合は、エラーが発生します。

例

次の例では、idがruleA、nountypeがJDBC_Connection、コンテキスト・パラメータ制約がctxP1のルールを作成します。

setDMSParameterScopedMetricsRule(id="ruleA", nountypes=["JDBC_Connection"],  ctxparamconstraints=[ctxP1])

6.4 DMSイベント・トレース・コマンド

イベント・トレースでは、再起動せずにライブ・トレースを構成できます。Oracle Fusion Middleware製品を使用して更新されたDMSメトリックは、DMSイベント・トレースを使用してトレースできます。

表6-5のコマンドを使用して、イベント・トレースを構成します。

DMSイベント・トレースの詳細は、『Oracle Fusion Middlewareパフォーマンスのチューニング・ガイド』のDMSトレースおよびイベントに関する項を参照してください。

表6-5 DMSトレース・コマンド

使用するコマンド

目的

WLSTでの使用

addDMSEventDestination

イベント・トレース構成に新しい宛先を追加します。

オンライン

addDMSEventFilter

イベント・トレース構成にフィルタを追加します。

オンライン

addDMSEventRoute

指定されたイベント・ルートをイベント・トレース構成に追加します。

オンライン

enableDMSEventTrace

イベント・トレースを有効にし、指定された条件と宛先および有効なイベント・ルートでフィルタを作成します。

オンライン

listDMSEventConfiguration

イベント・トレース構成の概要を表示します。

オンライン

listDMSEventDestination

1つの宛先またはすべての宛先のリストに関する完全な構成を表示します。

オンライン

listDMSEventFilter

フィルタの構成またはすべてのフィルタのリストを表示します。

オンライン

listDMSEventRoutes

イベント・ルートおよびそのステータス(有効または無効)を表示します。

オンライン

removeDMSEventDestination

指定した宛先を削除します。

オンライン

removeDMSEventFilter

指定したフィルタを削除します。

オンライン

removeDMSEventRoute

指定したイベント・ルートを削除します。

オンライン

updateDMSEventDestination

イベントの宛先の構成を更新します。

オンライン

updateDMSEventFilter

イベント・フィルタの構成を更新します。

オンライン

updateDMSEventRoute

イベント・ルートの構成を更新します。

オンライン

6.4.1 addDMSEventDestination

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレース構成に新しい宛先を追加します。同じIDの宛先がすでに存在している場合、その旨が報告され、宛先は追加されません。宛先を追加するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

addDMSEventDestination(id [, name] ,class
[, props= {'name': 'value'...}] [,server])

引数

定義

id

指定された宛先の一意の識別子。

name

省略可能。宛先の名前。

class

宛先の完全なクラス名。

使用可能な宛先クラスのリストについては、表6-6を参照してください。

props

省略可能。宛先に使用する名前/値プロパティ。表6-6に示されているように、一部に宛先にはプロパティが必要です。

server

省略可能。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

表6-6に、完全ランタイム・クラス名を表示した組込みの宛先を示します。

表6-6 組込みの宛先

宛先のランタイム・クラス名

説明

oracle.dms.trace2.runtime.LoggerDestination

ODLを使用して、ログ・メッセージをファイルに送ります。

この宛先のプロパティのリストについては、表6-7を参照してください。

oracle.dms.event.HTTPRequestTrackerDestination

アクティブなHTTPリクエストのセットをダンプし、管理者がアクティビティのスナップショットを取得できるようにします。

この宛先のプロパティのリストについては、表6-8を参照してください。

oracle.dms.jrockit.jfr.JFRDestination

JRockit Mission Controlを使用してJRockit JVMおよびWLDFからの他のデータのコンテキストでイベントを表示できるように、JRockitフライト・レコーダにイベントを渡します。

この宛先のプロパティのリストについては、表6-9を参照してください。

oracle.dms.jmx.MetricMBeanFactory

ナウンをMBeanとして公開します。この宛先にはプロパティはありません。

oracle.dms.util.StackTraceCollatorDestination

特定のイベントが発生するたびに実行中のスタック・トレースを照合します。これは、主としてデバッグ・ツールです。

照合済のデータは、シャットダウン時に書き出されます。また、処理されているイベントが一定の時間内(デフォルトは1分間)に報告されなかった場合にも書き出されます。

この宛先のプロパティのリストについては、表6-10を参照してください。

表6-7に、宛先oracle.dms.trace2.runtime.LoggerDestinationのプロパティを示します。

表6-7 oracle.dms.trace2.runtime.LoggerDestinationのプロパティ

プロパティ

説明

有効な値

LoggerName

必須。ログ出力の名前。

有効なログ出力名。

writeDataAsMessageAttributes

省略可能。trueに設定されている場合、イベント・データはログ・メッセージにコロン区切り文字列ではなくサプリメンタル属性として記録されます。イベント・データをサプリメンタル属性として記録することで、サプリメンタル属性を使用するODLの問合せ機能を利用できます。

例については、『Oracle Fusion Middleware Oracle Fusion Middlewareの管理』のWLSTを使用したログ・ファイルの検索に関する項を参照してください。

trueおよびfalse

表6-8に、宛先oracle.dms.event.HTTPRequestTrackerDestinationのプロパティを示します。

表6-8 oracle.dms.event.HTTPRequestTrackerDestinationのプロパティ

プロパティ

説明

有効な値

excludeHeaderNames

省略可能。指定されたHTTPリクエスト・ヘッダーにセキュリティ・センシティブな情報が含まれる可能性がある場合に、宛先がそのようなヘッダーをレポートしないようにします。

除外するヘッダー名のカンマ区切りのリスト。

requestThresholdSeconds

省略可能。リクエストがスローであるとみなされてからの秒数。generateIncidentMinutes設定が定義されていない場合、スロー・リクエストの検出時にだたちにインシデントが作成されます。

正の数値(秒単位)。

requestFilters

省略可能。監視する特定のURIまたはURI+クリックのフィルタ。各フィルタには独自のしきい値があります。各フィルタは次のように定義されます。

thresholdInSeconds!!uri!!clickId

thresholdInSecondsは、この値を超えるとリクエストがスローとみなされる時間を定義します。uriは一致するURIで正規表現として記述できます。clickIdはオプションで、一致するクリックIDを定義します。正規表現として記述できます。

各フィルタは%%を使用して区切ることができます。次に例を示します。

/SimpleWebApp-ViewController-context-root/.!!cb.%%/HCM-App/.!!'pt1:AP1:r3:0:AT1:_ATp:resId1:[0-9]+:cl1

requestFiltersが指定されている場合、requestThresholdSeconds設定はすべて無視されます。

リクエスト・フィルタのカンマ区切りのリスト

generateIncidentMinutes

省略可能。スロー・リクエストが発生した場合、インシデントを生成する前に確認する頻度。この設定はrequestThresholdSeconds設定とともに使用します。

正の数値(秒単位)。

incidentSkipCount

省略可能。スローリクエスト検出が有効になっている場合(requestThresholdSeconds設定で)、この設定を使用して、作成されたであろう最初のnのインシデントの作成を阻止できます。これは、最初のいくつかのリクエストを処理する追加オーバーヘッドのあるコールド・サーバーでは便利です。

正の数値(秒単位)。

maxRequestsReport

省略可能。遅延インシデントの生成時にレポートする最大リクエスト数。この設定はgenerateIncidentMinutes設定とともに使用します。定義されていない場合、すべてのリクエストがレポートされます。

正の数値(秒単位)。

incidentDumps

省略可能。スロー・リクエストの検出時に実行する診断ダンプのリスト。この設定が定義されていない場合、インシデントの作成時に診断ルールおよび診断ダンプのデフォルト・セットが評価されます。

診断ダンプ名のカンマ区切りのリスト。

dumpIntervalMinutes

省略可能。最初のスロー・リクエストの検出時にダンプを実行する間隔。既存のincidentDumps設定とともに設定することで制御されます。これにより、インシデントを作成するよりも頻繁に診断を収集できます。たとえば、インシデントを30分ごとに作成し、ダンプを10分ごとに収集できます。

次に、どのように機能するかについて詳しく説明します。

1. 最初のスロー・リクエストの検出時、HTTPRequestTracker宛先は指定された名前のダンプを実行してから、指定された頻度でさらにダンプをスケジュールします。

2. 次のダンプ頻度の間隔で新しいスロー・リクエストがあった場合、ダンプは再度実行されます。ない場合、この間隔ではダンプは実行されません。

3. 最後のダンプ頻度の間隔以降にスロー・リクエストがあった場合、レビュー期間の最後に、generateIncidentMinutes設定で指定されているように、さらにダンプが実行され、作成されたすべてのダンプ・ファイルを含むインシデントが作成されます。

インシデントのreadme.txtに各ダンプが取得された時期が詳しく記載されます。

正の数値(秒単位)。

enablePerformanceMetrics

省略可能。URIまたはURI+クリックの組合せがスローと識別された後、同じURI+クリックと一致する後続のリクエスト(レビュー期間内)の追加診断が可能になります。追加診断により、リクエストで時間が費やされた箇所(JDBC、MDS、ADFなど)の概要が示されます。このデータはslowrequests.txtファイルに含められます。

trueまたはfalse。デフォルトはfalseです。

表6-9に、宛先oracle.dms.jrockit.jfr.JFRDestinationのプロパティを示します。

表6-9 oracle.dms.jrockit.jfr.JFRDestinationのプロパティ

プロパティ

説明

有効な値

maxRecordingSize

必須。DMS記録のサイズ(この値を超えると、フライド・レコーダーから古いデータが削除されます)

後ろにK (KB)、M (MB)、G (GB)が付いた整数

表6-10に、宛先oracle.dms.util.StackTraceCollatorDestinatioのプロパティを示します。

表6-10 oracle.dms.util.StackTraceCollatorDestinationのプロパティ

プロパティ

説明

有効な値

printStream

省略可能。印刷ストリームの書込み先となる出力を識別する文字列

stderrまたはstdout。デフォルトはstderrです。

loggerName

省略可能。出力の書込み先となるログ出力の名前。宛先はログ出力を確認し、INFOメッセージが記録されない場合はstderrの使用に戻ります。

有効なログ出力名。

clearTracesWhenDumped

省略可能。現行データが書き出された後、宛先が一連の既知のスタックおよび発生回数をリセットすべきかどうか。Falseの場合、宛先の存続期間、一連のスタックおよび回数がメモリー内に累積されます。

trueまたはfalse。デフォルトはfalseです。

minDumpIntervalInMinutes

省略可能。特定のイベント・タイプについて照合されたデータを書き出す間の最小期間。

正の数値(分単位)。

eventTypesOfInterest

必須。スタック・トレースを照合するイベント・タイプを説明する文字列。

有効なイベント・タイプ。例: SENSOR。

例

次の例では、IDがdestination1、名前がFile-system、クラスがoracle.dms.trace2.runtime.LoggerDestinationである宛先を追加します。LoggerDestinationではloggerNameプロパティが必要であるため、値はtrace2-loggerに設定されます。

addDMSEventDestination(id='destination1', name='File-system',
class='oracle.dms.trace2.runtime.LoggerDestination',
props={'loggerName': 'trace2-logger'})

Destination "destination1" added.

次の例では、すでに存在しているIDを持つ宛先を追加しようとします。

addDMSEventDestination(id='destination1', name='File-system',
class='oracle.dms.trace2.runtime.LoggerDestination',
props={'loggerName': 'trace2-logger'})

Destination "destination1" already exists. Unable to add this.

6.4.2 addDMSEventFilter

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレース構成にフィルタを追加します。同じIDのフィルタがすでに存在している場合、エラーが戻され、フィルタは追加されません。

イベント・フィルタを追加するには、管理サーバーに接続している必要があります。接続していないと、エラー・メッセージが報告されます。

構文

addDMSEventFilter(id [, name] [, etypes,]
props= {'prop-name': 'value'...} [, server])

引数

定義

id

指定されたフィルタの一意の識別子。

name

省略可能。フィルタ名。

etypes

省略可能。イベントとアクションのペアのカンマ区切りリストを含む文字列。この引数を条件とともに使用することで、よりきめ細かいフィルタを作成することが可能になります。より広範囲なメトリックを持つフィルタを作成することもできます。たとえば、すべてのナウン、またはアクションが作成されているすべてのナウンです。

props

prop-name: フィルタ・プロパティの名前。有効な唯一のプロパティは<condition>であり、指定できるのは1つの条件のみです。

value: フィルタのプロパティの値。

server

省略可能。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

etypesの構文は次のとおりです:

<etypes>:==
<type>:[<action>]

有効なetypesは次のとおりです:

NOUN:CREATE|DELETE|TYPE_CHANGE
SENSOR
EVENT_SENSOR:CREATE|DELETE|METRIC_SELECTION_CHANGED,
PHASE_SENSOR:CREATE|DELETE|METRIC_SELECTION_CHANGED|START|STOP|ABORT
STATE_SENSOR:CREATE|DELETE|METRIC_SELECTION_CHANGED|UPDATE
ROLLUP_SENSOR:CREATE|DELETE|METRIC_SELECTION_CHANGED
EXECUTION_CONTEXT:START|STOP|SUSPEND
HTTP_REQUEST:START|STOP|CONTEXT_CHANGED

次の点に注意してください。

- SENSORには関連付けられたアクションはなく、関連するすべてのSENSORSおよび関連するアクションを含むために拡張されます。

- 関連付けられたアクションを指定しないタイプは、そのタイプのすべてのアクションにデフォルト設定されます。たとえば、HTTP_REQUESTは次にデフォルト設定されます。
HTTP_REQUEST:START,HTTP_REQUEST:STOP、HTTP_REQUEST:CONTEXT_CHANGED

次に、2つのイベントとアクションのペアがカンマで区切られたetypeを示します。

etypes='NOUN:DELETE, STATE_SENSOR:DELETE'

次に、引数propsの<condition>プロパティに対する構文を示します。引数については、構文の次にある表で説明しています。

<condition>::=
<type>  [<operator> <condition>]

<type>::=
<nountype> | <context>

<nountype>::=
NOUNTYPE <nountype-operator> value

<nountype-operator>::=
"equals" | "starts_with" | "contains" | "not_equals"

<context>::=
CONTEXT <name> <context-operator> [<value>] [IGNORECASE=true|false] [DATATYPE="string|long|double"
]

<context-operator>::=
"equals" | "starts_with" | "contains" | "not_equals" | "is_null" | "gt" | "le" | "ge"

<operator>::=
AND |OR

次の表では、<type>の引数を示します。

値

説明

<nountype>

各センサーは、関連付けられているメトリックとともに、ナウンに応じて階層に編成されます。Nounタイプは、収集される一連のメトリックを反映する名前です。たとえば、JDBCはNounタイプの一例です。センサーとナウンについては、『Oracle Fusion Middlewareパフォーマンスのチューニング・ガイド』のDMSの一般的な用語と概念の理解に関する説明を参照してください。

<context>

実行コンテキストは、実行コンテキストID (ECID)、関係ID (RID)および値のマップの関連付けです。この引数を使用することで、値のマップ内に格納されているデータをフィルタが調べて使用できるようになります。たとえば、マップにuserというキーが含まれている場合、userがbruceであるリクエストを戻すフィルタを作成することができます。

次の表では、<nountype>の引数を示します。

値

説明

NOUNTYPE

キーワード。

<nountype-operator>

有効な演算子は次のとおりです:

- equals: Nounタイプ名がその値と等しい場合のみ、フィルタ処理を行います。

- starts_with: Nounタイプ名がその値で始まっている場合のみ、フィルタ処理を行います。

- contains: Nounタイプ名がその値と等しい場合のみ、フィルタ処理を行います。

- not_equals: Nounタイプ名がその値と等しくない場合のみ、フィルタ処理を行います。

value

操作するNounタイプの名前。パフォーマンスを測定するどのオブジェクトの名前でも指定できます。

次の表では、<context>の引数を示します。

値

説明

CONTEXT

キーワード。

name

フィルタ処理するコンテキストの名前。

value

操作するコンテキストの名前。

<context-operator>

有効な演算子は次のとおりです:

- equals: コンテキスト名がその値と等しい場合のみ、フィルタ処理を行います。

- starts_with: コンテキスト名がその値で始まっている場合のみ、フィルタ処理を行います。

- contains: コンテキスト名がその値と等しい場合のみ、フィルタ処理を行います。

- not_equals: コンテキスト名がその値と等しくない場合のみ、フィルタ処理を行います。

- is_null: コンテキスト名がnullである場合のみ、フィルタ処理を行います。

- lt: コンテキスト名がその値未満である場合のみ、フィルタ処理を行います。

- gt: コンテキスト名がその値を超えている場合のみ、フィルタ処理を行います。

- le: コンテキスト名がその値以下である場合のみ、フィルタ処理を行います。

- ge: コンテキスト名がその値以上である場合のみ、フィルタ処理を行います。

IGNORECASE

省略可能。指定された場合、文字列データ型の大文字/小文字の区別は無視されます。デフォルトは、コンテキストで使用されている大文字/小文字です。

IGNORECASE AND DATATYPEは、コマンド内の位置には依存しません。

DATATYPE

省略可能。有効な値は、string、longまたはdoubleです。デフォルトはstringです。

IGNORECASE AND DATATYPEは、コマンド内の位置には依存しません。

例

次の例では、名前がMyFilterであるフィルタを、Nounタイプおよびコンテキストを指定して追加します。

addDMSEventFilter(id='mds1', name='MyFilter',
props={'condition': 'NOUNTYPE equals MDS_Connections AND CONTEXT user equals bruce IGNORECASE'})

Filter "mds1" added.

次の例では、同じIDを持つフィルタを追加しようとします。このコマンドではエラーが戻されます。

addDMSEventFilter(id='mds1', name='MyFilter',
props={'condition': 'NOUNTYPE equals MDS_Connections AND CONTEXT user equals bruce'})

Unable to add filter "mds1" as a filter with that ID already exists for server "AdminServer".

次の例では、2つのイベントとアクションのペアを持つフィルタを追加します。

addDMSEventFilter(id='mds2', name='MyFilter',
etypes='NOUN:CREATE,HTTP_REQUEST:START',
props={'condition': 'NOUNTYPE equals MDS_Connections
AND CONTEXT user equals bruce IGNORECASE=true'})
Filter "mds2" added.

6.4.3 addDMSEventRoute

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレース構成に指定されたイベント・ルートを追加します。同じIDのイベント・ルートがすでに存在している場合、エラーが戻され、イベント・ルートは追加されません。

イベント・ルートを追加するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

addDMSEventRoute([filterid,] destinationid [,enable=true|false] [,server])

引数

定義

filterid

省略可能。フィルタの一意の識別子。

destinationid

特定の宛先の一意の識別子。この宛先が存在している必要があります。

enable

省略可能。フィルタを有効にします。有効な値は、trueおよびfalseです。デフォルトは、trueです。

server

省略可能。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、フィルタIDがmds1で宛先IDがdestination1であるイベント・ルートを追加します。

addDMSEventRoute(filterid='mds1', destinationid='destination1', enable='false')
Event-route for filter "mds1", destination "destination1" added for server "AdminServer".

次の例では、すでに存在しているイベント・ルートを追加しようとしています:

addDMSEventRoute(filterid='mds1', destinationid='destination1', enable='false')
Unable to add event route as a mapping with filter "mds1" and destination "destination1" already exists for server "AdminServer".

6.4.4 enableDMSEventTrace

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレースを有効にし、指定された条件と宛先および有効なイベント・ルートでフィルタを作成します。これは、フィルタ、宛先およびイベント・ルートを明示的に作成せずにフィルタ処理を開始できるようにする簡単な方法ですが、構成オプションは少なくなります。指定された宛先が存在している必要があります。

DMSイベント・トレースを有効にするには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

より複雑な構成が必要な場合は、addDMSEventDestination、addDMSEventFilterおよびaddDMSEventRouteを使用します。

構文

enableDMSEventTrace(destinationid [, etypes] [, condition]  [, server])

引数

定義

destinationid

特定の宛先の一意の識別子。既存の宛先はいずれも有効です。

etypes

省略可能。イベントとアクションのペアのカンマ区切りリストを含む文字列。使用可能なetypesのリストについては、addDMSEventFilterを参照してください。

condition

省略可能。フィルタ処理する条件。条件の構文については、addDMSEventFilterを参照してください。

条件が指定されない場合、すべてのDMSイベントが渡されます

server

省略可能。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、指定された条件を持つイベント・トレースを有効にします。

enableDMSEventTrace(destinationid='destination1', condition='CONTEXT username EQUALS Joe AND CONTEXT ip EQUALS 192.168.1.5')

Filter "auto215443800" using Destination "destination1" added, and event-route enabled for server "AdminServer".

6.4.5 listDMSEventConfiguration

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレース構成の概要を表示します。

構文

listDMSEventConfiguration([server])

引数

定義

server

省略可能。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、接続している管理対象サーバーの構成を一覧表示します。

listDMSEventConfiguration()

Server: AdminServer

Event routes:
Filter        :  auto215443800
Destination   :  destination1
Enabled       :  true

6.4.6 listDMSEventDestination

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

特定の宛先について、完全な構成を表示します。宛先IDが指定されない場合、イベント・トレース構成内のすべての宛先の宛先IDおよび名前が示されます。

構文

listDMSEventDestination([id] [, server])

引数

定義

id

省略可能。特定の宛先の一意の識別子。

server

省略可能。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、接続している管理対象サーバーの宛先に関する情報を表示します。

listDMSEventDestination()
Server: AdminServer

Id            : HTTPRequestTrackerDestination
Name          : HTTP Request Tracker Destination

Id            : mbeanCreationDestination
Name          : MBean Creation Destination

次の例では、管理対象サーバーwls_server_1の宛先に関する情報を表示します。

listDMSEventDestination(server='wls_server_1')
Server: wls_server_1

Id            : HTTPRequestTrackerDestination
Name          : HTTP Request Tracker Destination

Id            : mbeanCreationDestination
Name          : MBean Creation Destination
.
.
.

次の例では、宛先destination1に関する情報を表示します。

listDMSEventDestination(id='destination1')
Server: AdminServer

Id            : destination1
Name          : File-system
Class         : oracle.dms.trace2.runtime.LoggerDestination
Class Info    : Logs incoming events to the logger configured for the Destination.
Properties    :
Name                         Value
loggerName                   trace2-logger

6.4.7 listDMSEventFilter

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

特定のフィルタについて、完全な構成を表示します。フィルタIDを指定しない場合、イベント・トレース構成内のすべてのフィルタのフィルタIDおよび名前が表示されます。

構文

listDMSEventFilter([id] [, server])

引数

定義

id

省略可能。指定されたフィルタの一意の識別子。

server

省略可能。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、イベント・トレース構成内のすべてのフィルタのリストを表示します。

listDMSEventFilter()
Id                              Name
auto215443800                   auto generated using enableEventTrace
JFRFilter                       JFRFilter
traceFilter
mds2                            MyFilter
mds1                            MyFilter

次の例では、フィルタmds1の構成を表示します。

listDMSEventFilter(id='mds1')
Server: AdminServer

Id            : mds1
Name          : MyFilter
Properties    :
Condition :
NOUNTYPE equals MDS_Connections AND CONTEXT user equals bruce IGNORECASE

6.4.8 listDMSEventRoutes

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

指定されたフィルタまたは宛先に関連付けられているイベント・ルートおよびそのステータス(有効か無効か)を一覧表示します。filteridまたはdestinationidを指定しない場合、イベント・トレース構成内のすべてのイベント・ルートが示されます。

構文

listDMSEventRoutes([filterid] [, destinationid][, server])

引数

定義

filterid

省略可能。フィルタの一意の識別子。

destinationid

省略可能。特定の宛先の一意の識別子。この宛先が存在している必要があります。

server

省略可能。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、すべてのイベント・ルートを示します。

listDMSEventRoutes()
Server: AdminServer

Filter        :  auto215443800
Destination   :  destination1
Enabled       :  true

Filter        :  None
Destination   :  HTTPRequestTrackerDestination
Enabled       :  true

次の例では、フィルタIDがfilter1であるイベント・ルートを一覧表示します。

listDMSEventRoutes(filterid='mds1')
Server: AdminServer

Filter        : mds1
Destination   : destination1
Enabled       : false

次の例では、宛先IDがdestination1であるイベント・ルートを一覧表示します。

listDMSEventRoutes(destinationid='destination1')
Server: AdminServer

Filter        : auto215443800
Destination   : destination1
Enabled       : true
Filter        : mds2
Destination   : destination1
Enabled       : false
Filter        : mds1
Destination   : destination1
Enabled       : false

6.4.9 removeDMSEventDestination

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレース構成から既存の宛先を削除します。宛先を削除できるのは、どのイベント・ルートもその宛先に依存していない場合のみです。その宛先に依存するイベント・ルートが存在する場合、警告が戻されます。

宛先を削除するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

removeDMSEventDestination(id [, server])

引数

定義

id

削除する宛先の一意の識別子。

server

省略可能。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、宛先jfrを削除します。

removeDMSEventDestination(id='jfr')

Destination "jfr" removed.

次の例では、宛先styx.inpass.db1を削除しようとします。しかし、この宛先にはイベント・ルートが存在するため、エラーが戻されます。

removeDMSEventDestination(id='styx.inpass.db1')

An event-route for destination 'styx.inpass.db1' exists. Unable to remove this destination for server "AdminServer".

6.4.10 removeDMSEventFilter

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレース構成から既存のフィルタを削除します。フィルタを削除できるのは、どのイベント・ルートもそのフィルタに依存していない場合のみです。そのフィルタに依存するイベント・ルートが存在する場合、警告が戻されます。

イベント・フィルタを削除するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

removeDMSEventFilter(id [, server])

引数

定義

id

削除するフィルタの一意の識別子。

server

省略可能。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、フィルタmds1を削除します。

removeDMSEventFilter(id='mds1')

Filter "mds1" removed  for server "AdminServer".

次の例では、イベント・ルートが現在存在しているフィルタを削除しようとします。

removeDMSEventFilter(id='allaccounts')

Filter "allaccounts" cannot be removed. An event-route currently exists for that
filter. Remove the event-route first using the command removeDMSEventRoute().

6.4.11 removeDMSEventRoute

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

指定されたイベント・ルートを削除します。イベント・ルートを追加するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

removeDMSEventRoute([filterid] [, destinationid]
[, server])

引数

定義

filterid

省略可能。フィルタの一意の識別子。

destinationid

省略可能。特定の宛先の一意の識別子。この宛先が存在している必要があります。

server

省略可能。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、フィルタIDがmds1であり、宛先がjfrであるイベント・ルートを削除します。

removeDMSEventRoute(filterid='mds1', destinationid='jfr')
Event-route for filter "mds1", destination "jfr" removed for server "AdminServer".

次の例では、宛先がdestination1であるイベント・ルートを削除します。

removeDMSEventRoute(destinationid='destination1')
Event-route for filter "None", destination "destination1" removed for server "AdminServer".

6.4.12 updateDMSEventDestination

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

既存の宛先を更新します。このコマンドでは、指定された引数を更新できます。宛先を更新するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

updateDMSEventDestination(id [, name,] class
[,props= {'name': 'value'...}] [, server])

引数

定義

id

更新する宛先の一意の識別子。

name

省略可能。宛先の名前。

class

宛先の完全なクラス名。

使用可能な宛先のリストについては、表6-6を参照してください。

props

省略可能。宛先に使用する名前/値プロパティ。新しいプロパティを追加したり、既存のプロパティを更新または削除したりすることができます。プロパティを更新する場合は、すべてのプロパティを指定する必要があります。プロパティを省略すると、そのプロパティは削除されます。たとえば、ある宛先にプロパティLoggerNameおよびseverityが含まれている場合、severityを省略すると、severityはその宛先から削除されます。

構文および許可されている値については、addDMSEventFilterを参照してください。

server

省略可能。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、宛先jfrの名前を更新します。

updateDMSEventDestination(id='jfr', name='Alternative Flight-Recorder')

Destination "jfr" updated  for server "AdminServer".

次の例では、存在しない宛先を更新しようとします。このコマンドではエラーが戻されます。

updateDMSEventDestination(id='destination1',
props={'loggerName': 'MyNewTrace2-logger'})

Destination "destination1" does not exist for server "AdminServer".

6.4.13 updateDMSEventFilter

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレース構成内の既存のフィルタを更新します。

イベント・フィルタを更新するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

updateDMSEventFilter(id [, name] [,etypes],
props= {'prop-name': 'value'...} [,server])

引数

定義

id

更新するフィルタの一意の識別子。

name

省略可能。更新するフィルタの名前。

etypes

省略可能。イベントとアクションのペアのカンマ区切りリストを含む文字列。有効な値のリストについては、addDMSEventFilterを参照してください。

props

prop-name: フィルタ・プロパティの名前。有効な唯一のプロパティは<condition>であり、指定できるのは1つの条件のみです。prop-nameの構文の詳細は、「addDMSEventFilter」を参照してください。

value: フィルタのプロパティの値。

server

省略可能。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、IDがmds1であるフィルタのフィルタ・プロパティを更新します。

updateDMSEventFilter(id='mds1',
props={'condition': 'NOUNTYPE equals XYZ_Total_Connections AND CONTEXT user equals bruce'})

Filter "mds1" updated for server "AdminServer"..

次の例では、存在しないフィルタを更新しようとします。

updateDMSEventFilter(id='Filter2')

Filter "Filter2" does not exist for server "AdminServer".

6.4.14 updateDMSEventRoute

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

指定されたイベント・ルートを有効または無効にします。イベント・ルートを更新するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

updateDMSEventRoute([filterid] [, destinationid]
[, enable=true|false] [, server])

引数

定義

filterid

省略可能。フィルタの一意の識別子。

destinationid

省略可能。特定の宛先の一意の識別子。この宛先が存在している必要があります。

enable

省略可能。フィルタを有効にします。有効な値は、trueおよびfalseです。

server

省略可能。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、filteridがmds1であり、destinationidがjfrであるイベント・ルートを無効にします。

updateDMSEventRoute(filterid='mds1', destinationid='jfr', enable='false')
Event-route for filter "mds1", destination "destination1" updated for server "AdminServer".

7 ロギング・カスタムWLSTコマンド

ログ・ファイルの設定の構成、およびログ・ファイルの表示と検索には、カスタムWLSTロギング・コマンドを使用します。

この章では、コマンドの構文および引数を説明し、コマンドの例を示します。

ログ・ファイルの構成および検索の詳細は、『Oracle Fusion Middleware Oracle Fusion Middlewareの管理』のログ・ファイルと診断データの管理に関する項を参照してください。

表7-1では、ロギング・コマンドの各種カテゴリを説明します。

表7-1 ロギング・コマンドのカテゴリ

コマンド・カテゴリ

説明

ログの構成コマンド

ファイルに書き込まれる情報レベルやファイルの最大サイズなどのログ・ファイルの設定を構成します。

検索および表示コマンド

Oracle Fusion Middlewareログ・ファイルを表示し、特定のメッセージのログ・ファイルを検索します。

選択的トレース・コマンド

選択的トレースを構成および使用します。選択的トレースでは、メッセージが特定のサーバー、ロガーまたはユーザーについてトレースされることが指定されます。

7.1 ログの構成コマンド

WLSTログ構成コマンドでは、ファイルに書き込まれる情報のレベルやファイルの最大サイズなど、ログ・ファイルの設定を構成できます。

ログ・ファイルの設定を構成するには、表7-2にあるコマンドを使用します。WLST列で使用する場合は、オンラインとは、コマンドが実行中のサーバーに接続されている場合のみに使用されることを意味します。オフラインとは、コマンドが実行中のサーバーに接続されてない場合のみに使用されることを意味します。オンラインまたはオフラインとは、コマンドは両方の状況に使用できることを意味します。

表7-2 ロギング構成のコマンド

使用するコマンド

目的

WLSTでの使用

configureLogHandler

既存のログ・ハンドラを構成し、新しいハンドラを追加または既存ハンドラを削除します。

オンライン

getLogLevel

指定したロガーのレベルを取得します。

オンライン

listLoggers

ロガーの一覧および各ロガーのレベルを取得します。

オンライン

listLogHandlers

1つまたは複数のログ・ハンドラの構成を示します。

オンライン

setLogLevel

指定したロガーのレベルを設定します。

オンライン

7.1.1 configureLogHandler

コマンド・カテゴリ: ログ構成

WLSTでの使用: オンライン

説明

既存のJavaロギング・ハンドラを構成し、新しいハンドラを追加、既存のハンドラを削除します。ハンドラごとに1つのエントリを持つjava.util.Listを返します。各エントリは、ハンドラを説明するjavax.management.openmbean.CompositeDataオブジェクトです。

このコマンドを使用して、ログ・ファイルの場所、ログ・ファイルのローテーション頻度および他のログ・ファイルのプロパティを変更できます。

構文

configureLogHandler([target,] name [, maxFileSize] [,maxLogSize] [, rotationFrequency]
[, baseRotationTime] [, retentionPeriod] [, format] [, encoding] [, path]
[, handlerType] [, propertyName] [, propertyValue] [, addProperty]
[, removeProperty] [, addHandler] [, removeHandler] [, level] [, addToLogger]
[, removeFromLogger] [, useParentHandlers]  )

引数

定義

target

省略可能。WebLogic Serverインスタンスの名前、またはシステム・コンポーネントを記述する文字列。システム・コンポーネントの詳細は、コンポーネントのドキュメントを参照してください。

デフォルト値は、WLSTの接続先となるサーバーです。

name

必須。ログ・ハンドラの名前。

maxFileSize

省略可能。ODLハンドラの最大ファイル・サイズの値。この値は数値を表す文字列で、オプションとしてサイズ単位を示す接尾辞(キロバイトはk、メガバイトはm、ギガバイトはg)が付加されます。

接尾辞を指定しない場合、値がバイト単位で返されます。

このオプションはQuickTraceハンドラには適用されないことに注意してください。

maxLogSize

省略可能。ODLハンドラの最大ログ・ファイルのサイズの値。この値は数値を表す文字列で、オプションとしてサイズ単位を示す接尾辞(キロバイトはk、メガバイトはm、ギガバイトはg)が付加されます。

このオプションはQuickTraceハンドラには適用されないことに注意してください。

rotationFrequency

省略可能。ODLハンドラのローテーション頻度の値。この値は数値を表す文字列で、オプションとして時間単位を示す接尾辞(分はm、時間はh、日はd)が付加されます。デフォルトの時間単位は分(m)です。特殊な値(HOUR、HOURLY、DAY、DAILY、WEEK、WEEKLY、MONTH、MONTHLY)も使用でき、分単位の数値に変換されます。

このオプションはQuickTraceハンドラには適用されないことに注意してください。

baseRotationTime

省略可能。rotationFrequencyオプションとともに使用されるベース・ローテーション時間。値は、日付と時刻値を表す文字列である必要があります。ISO 8601の日時書式で表す完全な書式の場合と、時と分のみで表す短い書式の場合があります。デフォルトのbaseRotationTimeは00:00です。

このオプションはQuickTraceハンドラには適用されないことに注意してください。

retentionPeriod

省略可能。ログ・ファイルが保持される時間。この値は数値を表す文字列である必要があり、オプションとして時間単位を示す接尾辞(分はm、時間はh、日はd)が付加されます。デフォルトの時間単位は分(m)です。特殊な値(HOUR、HOURLY、DAY、DAILY、WEEK、WEEKLY、MONTH、MONTHLY)も使用でき、分単位の数値に変換されます。

このオプションはQuickTraceハンドラには適用されないことに注意してください。

format

省略可能。ODLハンドラのフォーマット。有効な値は「ODL-Text」または「ODL-XML」のいずれかです。デフォルト形式はODL-Textです。

encoding

省略可能。ログ・ファイルのキャラクタ・エンコーディング。

path

省略可能。ログ・ファイルのパス。

このオプションはQuickTraceハンドラには適用されないことに注意してください。

handlerType

省略可能。ハンドラの実装を用意しているJavaクラスの名前。java.util.logging.Handlerまたはoracle.core.ojdl.logging.HandlerFactoryのインスタンスにする必要があります。

propertyName

省略可能。追加または更新される拡張ハンドラ・プロパティの名前。プロパティ値は、propertyValueオプションで指定します。有効なプロパティについては、ハンドラのドキュメントを参照してください。

propertyValue

省略可能。propertyNameオプションで定義されたハンドラ・プロパティの新規の値。

addProperty

省略可能。Jythonブール値。ハンドラに新しいプロパティが追加されることを定義するためにpropertyNameおよびpropertyValueオプションと組み合せて使用します。

removeProperty

省略可能。1つ以上の削除対象ハンドラ・プロパティのリスト。

addHandler

省略可能。ブール値。値がtrueの場合、指名されたハンドラが追加されます。

removeHandler

省略可能。ブール値。値がtrueの場合、指名されたハンドラが削除されます。

level

省略可能。JavaまたはODLレベル値。ハンドラ・レベルが指定のレベルに設定されます。

addToLogger

省略可能。ログ出力名のリスト。ハンドラは特定のロガー名に追加されます。

removeFromLogger

省略可能。ログ出力名のリスト。ハンドラは特定のロガーから削除されます。

useParentHandlers

省略可能。ブール値。addToLoggerまたはremoveFromLoggerオプションによって定義されるロガーにuseParentHandlersフラグを設定します。

次の表では、quicktrace-handlerのプロパティを示します。このハンドラにより、特定のロガーのメッセージをトレースし、メモリー内にそれらのメッセージを格納できます。詳細は、『Oracle Fusion Middleware Oracle Fusion Middlewareの管理』のQuickTraceの構成に関する項を参照してください。

QuickTraceのプロパティ

説明

bufferSize

循環QuickTraceバッファのおおよそのサイズ。ログ・レコードは、メモリー内のこのバッファに格納されます。実際のメモリー消費量は、この値より少なくなることはありますが、多くなることはありません。

enableDMSMetrics

trueに指定された場合、quicktrace-handlerに対してDMSメトリックが有効になります。デフォルトは、trueです。

enableUserBuffer

trueに指定された場合、ハンドラは、reserveBufferUserIDプロパティで指定されているユーザーごとに個別のバッファを維持します。reserveBufferUserIDプロパティでユーザーが定義されていない場合、メッセージはCOMMONバッファにキャッシュされます。

falseに指定された場合、ハンドラは、COMMONという1つのバッファのみを維持します。

デフォルトはfalseです。

flushOnDump

trueに指定された場合、executeDumpコマンドを実行すると、バッファがフラッシュされます。デフォルトは、trueです。

includeMessageArguments

trueに指定された場合、メッセージIDを持つフォーマット済ログ・メッセージにメッセージ引数が含まれます。デフォルトはfalseです。

maxFieldLength

メッセージ内の各フィールドの最大長(バイト単位)。フィールドには、メッセージ・テキスト、サプリメンタル属性、スレッド名、ソース・クラス名、ソース・メソッド名およびメッセージ引数が含まれます。

デフォルトは240バイトです。

小さい数値を指定すると、メッセージに対して戻される情報の量を制限することができます。非常に大きな数値を指定すると、各メッセージでより多くのバイトが使用されるため、バッファ内のログ・レコードの量を削減できます。

reserveBufferUserID

カンマで区切られた、ユーザーIDのリスト。enableUserBufferがtrueに指定された場合、そのユーザーに関連するすべてのログ・メッセージは別のバッファに書き込まれます。

supplementalAttributes

サプリメンタル属性名のリスト。属性は、logging.xmlファイルにリストされます。

サプリメンタル属性の設定には、追加のメモリーまたはCPU時間が必要になります。

useDefaultAttributes

trueに指定された場合、デフォルトの属性値が各ログ・メッセージに追加されます。デフォルト属性は、HOST_ID、HOST_NWADDRおよびUSER_IDです。

useLoggingContext

trueに指定された場合、ログ・メッセージにはDMSロギング・コンテキスト属性が含まれます。デフォルトはfalseです。

このオプションを有効にした場合、トレースでは追加のCPU時間が必要になります。

useRealThreadID

trueに指定された場合、ハンドラは、jave.util.logging.logRecordによって提供されるスレッドIDではなく、実際のスレッドIDを使用しようとします。デフォルトはfalseです。

このオプションを有効にした場合、トレースでは追加のCPU時間が必要になります。

useThreadName

trueに指定された場合、ログ・メッセージにはスレッドIDではなく、スレッド名が含まれます。デフォルトはfalseです。

例

次の例では、odlハンドラの最大ファイル・サイズを指定します。

configureLogHandler(name="odl-handler", maxFileSize="5M")

次の例では、odlハンドラのローテーション頻度を指定します。

configureLogHandler(name="odl-handler", rotationFrequency="daily")

次の例では、odlハンドラのローテーション頻度および保存期間を指定します。さらに、maxFileSizeプロパティを削除します。

configureLogHandler(name="odl-handler", rotationFrequency="daily",
retentionPeriod="week", removeProperty='maxFileSize'])

次の例では、quicktrace-handlerを構成します。ロガーoracle.adf.facesを追加し、user1およびuser2に対してユーザー・バッファを有効にします。

configureLogHandler(name="quicktrace-handler", addToLogger="oracle.adf.faces",
propertyName="enableUserBuffer", propertyValue="true",
propertyName="reserveBufferUserID", propertyValue="user1, user2")

oracle.adfロガーは、ハンドラodl-handler、wls-domainおよびconsole-handlerに関連付けられています。ロガーのレベルを設定すると、これらのハンドラは、ロガーoracle.adfに対して同じレベル(TRACE:1)を使用します。結果として、ログ・ファイルに多くの情報が書き込まれ、リソースが消費されることになります。リソースの消費を避けるためには、ハンドラのレベルを、WARNINGまたはINFORMATIONなど、より低いレベルに設定します。次に例を示します。

configureLogHandler(name="odl-handler", level="WARNING:1")
configureLogHandler(name="wls-domain", level="WARNING:1")
configureLogHandler(name="console-handler", level="WARNING:1")

7.1.2 getLogLevel

コマンド・カテゴリ: ログ構成

WLSTでの使用: オンライン

説明

特定のJavaロガーのレベルを返します。

戻り値は、ロガーのレベルを示す文字列で、ロガーが存在しない場合はNoneです。空の文字列は、ロガー・レベルがNullになることを示します。

構文

getLogLevel( [target,] logger [, runtime] )

引数

定義

target

省略可能。WebLogic Serverインスタンスの名前、またはシステム・コンポーネントを記述する文字列。システム・コンポーネントの詳細は、コンポーネントのドキュメントを参照してください。

デフォルト値は、WLSTの接続先となるサーバーです。

logger

ログ出力の名前。空の文字列はルート・ロガーを示します。

このオプションは必須で、デフォルト値はありません。

runtime

省略可能。操作によりランタイム・ロガーと構成ロガーのどちらがリストされるかを決定するJythonブール値(0または1)。デフォルト値は1 (実行時)です。

例

次の例では、ロガーOracleのレベルを返します。

getLogLevel(logger='oracle')
NOTIFICATION:1

次の例では、ラインタイム・ロガーではなく、構成ロガーのみを指定して、ロガーOracleのレベルを戻します。

getLogLevel(logger='oracle', runtime=0)
NOTIFICATION:1

次の例では、Oracle WebLogic Server server2上のロガーOracleのレベルを返します。

getLogLevel(logger='oracle', target='server2')
NOTIFICATION:1

7.1.3 listLoggers

コマンド・カテゴリ: ログ構成

WLSTでの使用: オンライン

説明

Javaロガーおよびそれらのレベルを示します。このコマンドは、キーはロガー名であり、関連付けられた値はロガー・レベルであるPyDictionaryオブジェクトを返します。空のレベルは、ロガーにレベル・セットはないことを示すために使用されます。

構文

listLoggers([target] [, pattern] [,runtime])

引数

定義

target

省略可能。WebLogic Serverインスタンスの名前、またはシステム・コンポーネントを記述する文字列。システム・コンポーネントの詳細は、コンポーネントのドキュメントを参照してください。

デフォルト値は、WLSTの接続先となるサーバーです。

pattern

省略可能。WebLogic Serverインスタンスの名前、またはシステム・コンポーネントを記述する文字列。システム・コンポーネントの詳細は、コンポーネントのドキュメントを参照してください。

runtime

省略可能。操作によりランタイム・ロガーと構成ロガーのどちらがリストされるかを決定するJythonブール値(0または1)。デフォルト値は1 (実行時)です。

例

次の例では、すべてのロガーを示します。

listLoggers()

次の例では、「oracle.*」という名前で開始するすべてのロガーを表示します。

listLoggers(pattern="oracle.*")

次の例では、すべての構成ロガーを表示します。

listLoggers(runtime=0)

次の例では、WebLogic Server server1のすべてのロガーを一覧表示します。

listLoggers(target="server1")

7.1.4 listLogHandlers

コマンド・カテゴリ: ログ構成

WLSTでの使用: オンライン

説明

Javaログ・ハンドラ構成を示します。このコマンドは、ハンドラごとに1つのエントリを持つjava.util.Listを返します。各エントリは、ハンドラを説明するjavax.management.openmbean.CompositeDataオブジェクトです。

構文

listLogHandlers([target] [, name])

引数

定義

target

省略可能。WebLogic Serverインスタンスの名前、またはシステム・コンポーネントを記述する文字列。システム・コンポーネントの詳細は、コンポーネントのドキュメントを参照してください。

デフォルト値は、WLSTの接続先となるサーバーです。

name

省略可能。ログ・ハンドラの名前。名前を指定しない場合、すべてのハンドラを表示します。

例

次の例では、すべてのログ・ハンドラの一覧を表示します。

listLogHandlers()

次の例では、「odl-handler」という名前のログ・ハンドラをすべて表示します。

listLogHandlers(name="odl-handler")

次の例では、WebLogic Server server1のすべてのログ・ハンドラを一覧表示します。

listLogHandlers(target="server1")

7.1.5 setLogLevel

コマンド・カテゴリ: ログ構成

WLSTでの使用: オンライン

説明

特定のJavaロガーによってログ・ファイルに書き込まれた情報のレベルを設定します。

構文

setLogLevel([target,] logger [, addlogger] , level [, runtime] [, persist] )

引数

定義

target

省略可能。WebLogic Serverインスタンスの名前、またはシステム・コンポーネントを記述する文字列。システム・コンポーネントの詳細は、コンポーネントのドキュメントを参照してください。

デフォルト値は、WLSTの接続先となるサーバーです。

logger

ログ出力の名前。空の文字列はルート・ロガーを示します。

このオプションは必須で、デフォルト値はありません。addLoggerオプションを使用しないかぎり、ロガーが存在しない場合このコマンドによって例外が送出されます。

addLogger

省略可能。ログ出力が存在しない場合に作成する必要があるかどうかを決定するJythonブール値(0または1)。このオプションは、ランタイム・モードに対しては非推奨です。ロガーはガベージ・コレクションされる可能性があるため、ランタイム・ロガーの追加が何の効果もないことがあります。まだ作成されていないロガーのレベルを設定する必要がある場合は、永続モードを使用します。

level

レベル名。これは、JavaレベルまたはODLレベルのどちらかです。有効なJavaレベルは次のとおりです。SEVERE、WARNING、INFO、CONFIG、FINE、FINERまたはFINEST。有効なODLレベルには、コロンおよびメッセージ・レベルを付加したメッセージ・タイプが含まれます。有効なODLメッセージ・タイプは次のとおりです。INCIDENT_ERROR、ERROR、WARNING、NOTIFICATION、TRACEおよびUNKNOWN。メッセージ・レベルは、メッセージ・タイプを修飾する整数値で表現されます。指定できる値は、1 (最高の重大度)から32 (最低の重大度)までです。

空の文字列を使用すると、レベルをnullに設定できます(親から継承)。

このオプションは必須で、デフォルト値はありません。

runtime

省略可能。操作によりランタイム・ロガーと構成ロガーのどちらがリストされるかを決定するJythonブール値(0または1)。デフォルト値は1 (実行時)です。ターゲットが、変化するランタイム・ロガーをサポートしないシステム・コンポーネントである場合、このオプションは無視されます。

注意: ランタイム・ロガーはガベージ・コレクションされる可能性があるため、ランタイム・ロガーのレベルの変更は、ロガーが存在しており、かつそのロガーへの強参照があることがわかっている場合にのみ行うようにしてください。ロガーがガベージ・コレクションされた場合、ランタイム・モードでロガー・レベルに加えられた永続的ではない変更は、すべて失われる可能性があります。

persist

省略可能。レベルを構成ファイルに保存するかどうかを決定するJythonブール値(0または1)。値0はレベルが保存されることを示し、値1は保存されないことを示します。デフォルト値は1です。

例

次の例では、ロガーoracle.my.loggerのためにログ・レベルをNOTIFICATION:1に設定します。

setLogLevel(logger="oracle.my.logger", level="NOTIFICATION:1")

次の例では、ロガーoracle.my.loggerのためにログ・レベルをTRACE:1に設定し、レベルは構成ファイルに保存する必要があることを指定します。

setLogLevel(logger="oracle.my.logger", level="TRACE:1", persist=0)

次の例では、WebLogic Server server1上の構成ロガーoracle.my.loggerに対するログ・レベルをWARNINGに設定します。

setLogLevel(target="server1", logger="oracle.my.logger", level="WARNING", runtime=0)

7.2 検索および表示コマンド

WLSTロギング・コマンドでは、ログ・ファイルの検索やログ・ファイル内の情報の表示が可能です。

表7-3のコマンドを使用して、Oracle Fusion Middlewareログ・ファイルを表示し、特定のメッセージのログ・ファイルを検索します。

表7-3 検索および表示コマンド

使用するコマンド

目的

WLSTでの使用

displayLogs

1つまたは複数のログを表示します。

オンラインまたはオフライン

listLogs

ログ・ファイルの内容を検索し、表示します。

オンラインまたはオフライン

7.2.1 displayLogs

コマンド・カテゴリ: 検索および表示

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

説明

診断ログ・ファイルの内容を検索し、表示します。コマンドは、returnDataオプションをtrueに設定した場合のみ値を返します。デフォルトでは、データを返しません。使用するオプションによって戻り値は異なります。

構文

displayLogs([searchString,][target] [, oracleInstance] [, log] [, last] [, tail]
[, pattern] [, ecid] [, component] [, module] [, type] [, app] [, query] [, groupBy]
[, orderBy [, returnData] [, format] [, exportFile] [, follow])

引数

定義

searchString

オプションの検索文字列。指定した文字列(大文字と小文字は区別されない)を含むメッセージのみが返されます。

displayLogsコマンドでは、複数のフォーマットでログを読み込むことができ、ODLフォーマットにメッセージを変換できます。検索は、できるだけネイティブ・フォーマットで実行されます。それ以外の場合、検索がメッセージ・コンテンツ内に実行され、マークアップを除外する場合もあります。したがって、検索文字列でマークアップ文字の使用を避ける必要があります。

target

省略可能。WebLogic Serverインスタンス、またはシステム・コンポーネントの名前。

システム・コンポーネントの場合、ターゲットの構文は次のとおりです:

sc:component-name

接続モードでは、デフォルトのターゲットはWebLogicドメインです。接続解除モードでは、デフォルト値がない、ターゲット・オプションは必須です。

oracleInstance

省略可能。ORACLE_INSTANCEまたはWebLogicドメイン・ホームへのパスを定義します。このパラメータを使用すると、コマンドは接続解除モードで実行されます。

log

省略可能。ログ・ファイルのパス。コマンドは、指定したログ・ファイルからメッセージを読み込みます。ログ・ファイルのパスを指定しない場合、コマンドは、指定したターゲットに関連付けられるすべてのログを読み込みます。

last

省略可能。整数値。検索範囲を最後の指定分数以内に記録されたメッセージに制限します。値に接尾辞(秒はs、分はm、時間はhまたは日はd)を付加することで、異なる時間単位を指定することができます。(例: last='2h'は最後の2時間と解釈されます)。

tail

省略可能。整数値。検索範囲を各ログ・ファイルに含まれる最後のn個のメッセージに制限し、表示されるメッセージ数をn個に制限します。

pattern

省略可能。正規表現パターン。特定のパターンを含むメッセージのみが返されます。パターン・オプションの使用は、searchString引数の使用と同様ですが、正規表現を使用できる点が異なります。

正規表現パターンの検索では、(パターンの大文字/小文字を区別しないフラグを明示的に有効にしないかぎり)大文字と小文字が区別されます。パターンはjava.util.regex構文に従う必要があります。

ecid

省略可能。ログ・メッセージのフィルタとして使用される1つ以上の実行コンテキストID (ECID)値を含む文字列または連続した文字列。

component

省略可能。ログ・メッセージのフィルタとして使用される1つ以上のコンポーネントID値を含む文字列または連続した文字列。

module

省略可能。ログ・メッセージのフィルタとして使用される1つ以上のモジュールID値を含む文字列または連続した文字列。

type

省略可能。ログ・メッセージのフィルタとして使用される1つ以上のメッセージ・タイプ値を含む文字列または連続した文字列。

app

省略可能。ログ・メッセージのフィルタとして使用される1つ以上のアプリケーション値を含む文字列または連続した文字列。

query

省略可能。ログ・メッセージのコンテンツの絞込みに使用される式を指定する文字列。

単純な式の形式は次のとおりです:

field-name operator value

field-nameはログ・レコード・フィールド名で、operatorはフィールド・タイプに適する演算子です(たとえば、文字列フィールドのためにequals、startsWith、containsまたはmatchesを指定できます)。

フィールド名は、標準ODL属性名のいずれか(COMPONENT_ID、MSG_TYPE、MSG_TEXT、SUPPL_DETAILなど)、またはSUPPL_ATTRという接頭辞が付いたアプリケーション固有のサプリメンタル属性名(SUPPL_ATTR.myAttributeなど)のいずれかです。

一部の共通サプリメンタル属性は接頭辞なしで使用できます。たとえば、APPを使用して、アプリケーション名でフィルタ処理することができます。

ブール演算子and、orおよびnotを使用し複数の単純な式を組み合せて複雑な式を作成することができます。そして、丸括弧を使用して式をグループ化できます。

問合せ構文の詳細は、『Oracle Fusion Middleware Oracle Fusion Middlewareの管理』のWLSTを使用したログ・ファイルの検索に関する項を参照してください。

groupBy

省略可能。文字列リスト。groupByオプションを使用する場合、出力は文字列リストに定義された属性でグループしたログ・メッセージの数です。

orderBy

省略可能。結果のソート順序を定義する文字列リスト。値はログ・メッセージの属性名です。必要に応じて、名前に:ascまたは:descのサフィックスを追加することで昇順または降順のソートを指定できます。デフォルトのソート順序は昇順です。

デフォルトでは、結果は時間でソートされます。

returnData

省略可能。Jythonブール値(0または1)。値がtrueの場合、コマンドによってデータが返されます。(たとえば、スクリプトで使用するデータ)。デフォルト値がfalseです。つまり、コマンドはデータを表示するだけで、戻しません。

format

省略可能。出力形式を定義する文字列。有効な値は、ODL-Text、ODL-XML、ODL-completeおよびsimpleです。デフォルト形式はODL-Textです。

exportFile

省略可能。コマンド出力が書き込まれるファイルの名前。デフォルトでは、出力は標準出力に書き込まれます。

follow (f)

省略可能。コマンドで引き続きログを読み取り、新規メッセージがログに追加された際にメッセージを表示するために、コマンドをフォロー・モードに設定します(Unixのtail -fコマンドと同様)。fオプションを使用すると、コマンドは値を戻しません。このオプションは、現在システム・コンポーネントではサポートされていません。

例

次の例では、ドメインのすべてのログ・ファイルから最後の100メッセージを表示します。

displayLogs(tail=100)

次の例では、最後の15分にログされるすべてのメッセージを表示します。

displayLogs(last='15m')

次の例では、指定した文字列を含むログ・メッセージを表示します。

displayLogs('Exception')

次の例では、指定したECIDを含むログ・メッセージを表示します。

displayLogs(ecid='0000Hl9TwKUCslT6uBi8UH18lkWX000002')

次の例では、ERRORまたはINCIDENT_ERRORタイプのログ・メッセージを表示します。

displayLogs(type=['ERROR','INCIDENT_ERROR'])

次の例では、指定したJava EEアプリケーションのログ・メッセージを表示します。

displayLogs(app="myApplication")

次の例では、システム・コンポーネントohs1のメッセージを表示します。

displayLogs(target="sc:ohs1")

次の例では、コンポーネントとタイプでメッセージ概要を表示します。

displayLogs(groupBy=['COMPONENT_ID', 'MSG_TYPE'])

次の例では、特定の時間間隔のメッセージを表示します。

displayLogs(query="TIME from 11:15 and TIME to 11:20")

次の例では、詳細な問合せを示します。

displayLogs(query="TIME from 11:15 and TIME to 11:20 and ( MSG_TEXT contains
exception or SUPPL_DETAIL contains exception )")

同じ問合せを次のように記述することができます。

displayLogs("exception", query="TIME from 11:15 and TIME to 11:20")

7.2.2 listLogs

コマンド・カテゴリ: 検索および表示

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

説明

Oracle Fusion Middlewareコンポーネントのログ・ファイルの一覧を表示します。このコマンドは、ログごとに1つの要素を含むPyArrayを返します。配列の要素は各ログを説明するjavax.management.openmbean.CompositeDataオブジェクトです。

構文

listLogs([target] [, oracleInstance] [, unit] [, fullTime]

引数

定義

target

省略可能。WebLogic ServerインスタンスまたはOracle Fusion Middlewareシステム・コンポーネントの名前。

システム・コンポーネントの場合、ターゲットの構文は次のとおりです:

sc:component-name

接続モードでは、デフォルトのターゲットはWebLogicドメインです。

接続解除モードでは、デフォルト値がない、ターゲット・オプションは必須です。

oracleInstance

省略可能。ORACLE_INSTANCEまたはWebLogicドメイン・ホームへのパスを定義します。このパラメータを使用すると、コマンドは接続解除モードで実行されます。

unit

省略可能。ファイル・サイズをレポートするために使用する単位を定義します。有効な値は、B(バイト)、K(キロバイト)、M(メガバイト)、G(ギガバイト)またはH(判読可能な形式でサイズを表示するもので、UNIXのls -hオプションに似ています)です。デフォルト値はHです。

fullTime

省略可能。Jythonブール値。trueの場合は、ログ・ファイルの最終更新日時の全時間をレポートします。それ以外の場合、時間の短いバージョンを表示します。デフォルト値はfalseです。

例

次の例では、WebLogicドメインのすべてのログ・ファイルの一覧を表示します。

listLogs()

次の例では、WebLogic Server server1のログ・ファイルを一覧表示します。

listLogs(target="server1")

次の例では、Oracle HTTP Server ohs1用のログ・ファイルの一覧を表示します。

listLogs(target="sc:ohs1")

接続解除モードで使用される次の例では、WebLogic Server server1のログ・ファイルを一覧表示します。

listLogs(oracleInstance="/scratch/Oracle/domains/base_domain",
target="server1")

7.3 選択的トレース・コマンド

選択的トレースにより、指定されたユーザーまたはリクエストの他のプロパティに対するきめ細かいロギングを実行することができます。WLST選択的トレース・コマンドでは、選択的トレースを構成および使用できます。

表7-4のコマンドを使用して、選択的トレースを構成および使用します。WLST列で使用する場合は、オンラインとは、コマンドが実行中のサーバーに接続されている場合のみに使用されることを意味します。

表7-4 トレース・コマンド

使用するコマンド

目的

WLSTでの使用

configureTraceProvider

トレース・プロバイダを構成します。

オンライン

configureTracingLoggers

選択的トレースについて1つ以上のログ出力を構成します。

オンライン

listActiveTraces

アクティブなトレースをリストします。

オンライン

listTraceProviders

トレース・プロバイダをリストします。

listTracingLoggers

選択的トレースをサポートするログ出力をリストします。

オンライン

startTracing

選択的トレース・セッションを開始します。

オンライン

stopTracing

1つ以上の選択的トレース・セッションを停止します。

オンライン

7.3.1 configureTraceProvider

コマンド・カテゴリ: トレース

WLSTでの使用: オンライン

説明

トレース・プロバイダを構成します。現在は、プロバイダの有効化または無効化のオプションのみを使用できます。

構文

configureTraceProvider([target,] name, action)

引数

定義

target

省略可能。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ターゲットは、JRFが有効化されたドメイン内の実行中のすべてのサーバーです。

name

必須。トレース・プロバイダ名。

action

プロバイダのトレースを有効または無効にします。有効な値は、enableおよびdisableです。このオプションは必須で、デフォルト値はありません。

例

次の例では、ドメイン内の実行中のすべてのサーバーでDMSトレースを無効化します。

configureTraceProvider(name='DMS', action='disable')

次の例では、サーバーwls_server1でDMSトレース・プロバイダを有効化します。

configureTraceProvider(target='wls_server1', name='DMS', action='enable')

7.3.2 configureTracingLoggers

コマンド・カテゴリ: トレース

WLSTでの使用: オンライン

説明

選択的トレースに対する1つ以上のロガーを構成します。このコマンドはまた、選択的トレースに対するロガーを有効または無効にします。

構文

configureTracingLoggers([target] [, pattern,] action)

引数

定義

target

省略可能。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ドメイン内の、JRFが有効なすべての実行中のサーバー・インスタンス上のロガーがトレースに対して構成されます。

pattern

省略可能。ロガー名のフィルタ処理に使用される正規表現パターン。デフォルト値は、すべてのトレース・ロガー名に一致します。

action

必須。すべてのログ出力のトレースを有効または無効にします。有効な値は、enableおよびdisableです。デフォルト値はありません。

例

次の例では、oracle.securityで始まるすべてのロガーについて選択的トレースを構成します。

configureTracingLoggers(pattern='oracle.security.*', action="enable")
Configured 80 loggers

次の例では、すべてのロガーについて選択的トレースを無効にします。

configureTracingLoggers(action="disable")
Configured 969 loggers

7.3.3 listActiveTraces

コマンド・カテゴリ: トレース

WLSTでの使用: オンライン

説明

アクティブなトレースを一覧表示します。

構文

listActiveTraces([target])

引数

定義

target

省略可能。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ドメイン内の、JRFが有効なすべての実行中のサーバー・インスタンス上のロガーが一覧表示されます。

例

次の例では、アクティブなトレースを一覧表示します。

listActiveTraces()

-------------------------------------+----------+-----------+------+-------------------+---
Trace ID                             |Attr. Name|Attr. Value| Level| Start Time        |Exp. Time
-------------------------------------+----------+-----------+------+-------------------+---
bf13025b-b8f8-480d-8d92-14200a669b3e |USER_ID   |user1      | FINE |  5/28/13 12:28 PM |
a04b47f7-2830-4d80-92ee-ba160cdacf6b |USER_ID   |user2      | FINE |  5/28/13 12:30 PM |

7.3.4 listTraceProviders

コマンド・カテゴリ: トレース

WLSTでの使用: オンライン

説明

使用可能なトレース・プロバイダの名前、ステータス、説明およびサポートされるパラメータをリストします。プロバイダのステータスは、プロバイダがすべてのターゲット上で有効化されるenabled、プロバイダがすべてのターゲット上で無効化されるdisabledまたはプロバイダが一部のターゲット上で有効化されるmixedのいずれかになります。

構文

listTraceProviders([target,] [name])

引数

定義

target

省略可能。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、JRFが有効化されたドメイン内の実行中のすべてのサーバー・インスタンス上のプロバイダがリストされます。

name

省略可能。トレース・プロバイダ名。このパラメータを指定した場合、このプロバイダのみがリストされます。

例

次の例では、ドメイン内の実行中のすべてのサーバーのトレース・プロバイダをすべてリストします。

listTraceProviders()

7.3.5 listTracingLoggers

コマンド・カテゴリ: トレース

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

説明

選択的トレースをサポートするログ出力をリストします。このコマンドでは、ログ出力名およびそのトレース・ステータスの表が表示されます。ステータスenabledは、すべてのサーバー上のトレースでロガーが有効であることを意味します。ステータスdisabledは、すべてのサーバー上のトレースでロガーが無効であることを意味します。ステータスmixedは、一部のサーバー上のトレースではロガーが有効であり、他のサーバー上のトレースではロガーが無効であることを意味します。

構文

listTracingLoggers([target] [, pattern])

引数

定義

target

省略可能。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ドメイン内の、JRFが有効なすべての実行中のサーバー・インスタンス上のロガーが一覧表示されます。

pattern

省略可能。ロガー名のフィルタ処理に使用される正規表現パターン。デフォルト値は、すべてのトレース・ロガー名に一致します。

例

次の例では、oracle.securityで始まるすべてのトレース・ロガーを一覧表示します。

listTracingLoggers(pattern="oracle.security.*")
------------------------------------------------------------------+--------
Logger                                                            | Status
------------------------------------------------------------------+--------
oracle.security                                                   | enabled
oracle.security.audit.logger                                      | enabled
oracle.security.audit.config                                      | enabled
.
.
.

7.3.6 startTracing

コマンド・カテゴリ: トレース

WLSTでの使用: オンライン

説明

指定されたユーザーまたはDMSコンテキスト属性に対する新しい選択的トレース・セッションを、指定されたトレース・レベルで開始します。

構文

startTracing([target,] [ traceId,] [attrName, attrValue,] [user,] level [, desc])

引数

定義

target

省略可能。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ドメイン内の、JRFが有効なすべての実行中のサーバー・インスタンス上のロガーがトレースに含まれます。

traceId

省略可能。トレース・セッションの識別子。traceIdが指定されない場合、コマンドは一意のtraceIdを生成します。

attrName

user引数が指定されない場合を除いて、オプション。有効な値は、USER _ID、APP、CLIENT_HOST、CLIENT_ADDR、composite_name、WEBSERVICE.name、WEBSERVICE_PORT.nameです。

attrValue

attrNameが指定されている場合は必須。属性の値。

user

ユーザー名。このユーザーに関連付けられているメッセージが戻されます。これは、attrNameおよびAttrValueオプションを指定してUSER_IDを渡すことと同じです。

level

必須。トレース・レベル。このレベルは、有効なJavaまたはODLレベルであることが必要です。『Oracle Fusion Middleware Oracle Fusion Middlewareの管理』の表「ODL、Oracle WebLogic ServerおよびJava間のログ・レベルのマッピング」を参照してください。

desc

省略可能。トレース・セッションの説明。

例

次の例では、user1に関連付けられているメッセージのトレースを開始し、情報のレベルをFINEに設定します。

startTracing(user="user1",level="FINE")
Started tracing with ID: 885649f7-8efd-4a7a-9898-accbfc0bbba3

7.3.7 stopTracing

コマンド・カテゴリ: トレース

WLSTでの使用: オンライン

説明

1つ以上の選択的トレース・セッションを停止します。

構文

stopTracing([target,] {stopAll] | traceId | attrName, attrValue | user} [, createIncident)

引数

定義

target

省略可能。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ドメイン内の、JRFが有効なすべての実行中のサーバー・インスタンス上のロガーが操作に含まれます。

stopAll

アクティブなトレースをすべて停止するかどうかを決定するJythonブール値(0または1)。traceId、user、またはattrNameおよびattrValue引数が指定されていない場合は必須。デフォルト値は0 (false)です。

traceId

停止するトレース・セッションの識別子。stopAll、user、またはattrNameおよびattrValue引数が指定されていない場合は必須。

attrName

有効な値は、USER _ID、APP、CLIENT_HOST、CLIENT_ADDR、composite_name、WEBSERVICE.name、WEBSERVICE_PORT.nameです。traceId、user、stopAll引数が指定されていない場合は必須。

attrValue

attrNameが指定されている場合は必須。属性の値。

user

ユーザー名。このユーザーに関連付けられているすべてのトレース・セッションが停止されます。stopAll、traceId、またはattrNameおよびattrValue引数が指定されていない場合は必須。

createIncident

省略可能。Jythonブール値(0または1)。trueの場合、停止するトレースごとにインシデントが作成されます。デフォルト値は0 (false)です。

例

次の例では、指定されたtraceIdを持つトレース・セッションを停止します。

stopTracing(traceId="a04b47f7-2830-4d80-92ee-ba160cdacf6b")
Stopped 1 traces

次の例では、すべてのトレース・セッションを停止します。

stopTracing(stopAll=1)
Stopped 1 traces

8 診断フレームワーク・カスタムWLSTコマンド

診断フレームワークによって、クリティカル・エラーについて関連する診断を適時に捕捉できます。診断は、詳細に分析するためにOracleサポートに送信できます。診断フレームワークのコマンドを使用して、インシデントを生成し、既存のインシデントを問い合せ、個別の診断ダンプを実行して特定の診断データを収集します。 この章では、診断フレームワーク用のWLSTコマンド、およびそのコマンド構文、引数、コマンド例を詳細に説明します。

診断フレームワークの使用の詳細は、『Oracle Fusion Middleware Oracle Fusion Middlewareの管理』の問題の診断に関する項を参照してください。

表8-1に、診断フレームワーク・コマンドの各種カテゴリをリストします。

表8-1 診断コマンド・カテゴリ

コマンド・カテゴリ

説明

インシデント・コマンド

問題およびインシデントを表示し、インシデントを作成します。

診断ダンプ・コマンド

ダンプに関する情報を表示し、ダンプを実行します。

ダンプ・サンプリング・コマンド

指定された間隔で診断ダンプのサンプルを取得します。

8.1 インシデント・コマンド

インシデントとは、問題の1回の発生です。問題(クリティカル・エラー)が複数回発生すると、インシデントはそれぞれの発生分に対して作成されます。WLST診断フレームワークのインシデント・コマンドでは、問題とインシデントの表示、およびインシデントの作成が可能です。

表8-2のコマンドを使用して、問題およびインシデントを表示し、インシデントを作成します。

表8-2 インシデント・コマンド

使用するコマンド

目的

WLSTでの使用

createAggregatedIncident

指定した基準に一致するインシデントのコピーを含むzipファイルが含まれている集計インシデントを作成します。

オンライン

createIncident

診断インシデントを作成します。

オンライン

getIncidentFile

指定したインシデント・ファイルの内容を取得します。

オンライン

listADRHomes

一連のADRホームのパスを一覧表示します。

オンライン

listIncidents

一連の診断インシデントを一覧表示します。

オンライン

listProblems

一連の診断問題を一覧表示します。

オンライン

queryIncidents

指定した基準に一致するインシデントをリストします。

オンライン

reloadCustomRules

すべてのカスタム診断ルールまたは指定したルールをリロードします。

オンライン、オフライン

showIncident

指定したインシデントの詳細を表示します。

オンライン

8.1.1 createAggregatedIncident

WLSTでの使用: オンライン

説明

指定した基準に一致するインシデントのコピーを含むzipファイルが含まれている集計インシデントを作成します。

構文

createAggregatedIncident(query [, servers])

引数

定義

query

単純式で構成された式で、ブール演算子で連結できます。式には、インシデント属性、演算子および文字列が次の書式で含まれます。

attribute operator "string"

単純式はカッコ()でグループ化されたブール演算子ANDまたはORで連結できます。

次のインシデント属性がサポートされています。

- TIMESTAMP: インシデント作成時間。fromおよびto演算子を使用して時間範囲を指定できます。日付書式はYYYY-MM-DD HH:MMです。

- ECID: 実行コンテキストID

- PROBLEM_KEY: 問題キー

- MSG_FACILITY: エラー・メッセージ機能(ORA、OHSなど)

- MSG_NUMBER: エラー・メッセージID (600など)

カスタム・インシデント属性もサポートされています。たとえば、TRACEID、APP、URI、AND DSIDがサポートされています。

サポートされている演算子は次のとおりです。

- equals

- notEqual

- startsWith

- endsWith

- contains

- isNull

- notNull

servers

問い合せる1つ以上のサーバーの名前。この引数はオプションです。指定しない場合、ドメイン内のすべてのサーバーに対してコマンドが実行されます。

このオプションは、管理サーバーに接続している場合にのみ有効です。

例

次の例では、サーバーwls_server1でODL_TRACE_IDに123456を含むすべてのインシデントに対する集計インシデントを作成します。

createAggregatedIncident(query="ORDL_TRACE_ID equals 123456", servers="wls_server1")
Incident 55 created, containing the following incidents:
Server wls_server1
Incident Id    Problem Key                                     Incident Time
15                 TRACE [123456] [MANUAL]          Mon Apr 15 11:22:12 EDT 2013

次の例では、ドメイン内のすべてのサーバーでODL_TRACE_IDに123456を含むすべてのインシデントに対する集計インシデントを作成します。

createAggregatedIncident(query="ORDL_TRACE_ID equals 123456", servers="wls_server1")
Incident 55 created, containing the following incidents:
Server wls_server1, wls_server2
Incident Id    Problem Key                                     Incident Time
15                 TRACE [123456] [MANUAL]          Mon Apr 15 11:22:12 EDT 2013

8.1.2 createIncident

WLSTでの使用: オンライン

説明

診断インシデントを作成し、指定した情報を使用して、実行する一連の診断ルールおよびアクションを決定します。

構文

createIncident([adrHome] [,incidentTime] [,messageId] [,ecid] [,appName]
[,description] [,server])

引数

定義

adrHome

インシデントを作成するADRホームのパス。ADRホームが存在している必要があります。この引数が指定されていない場合、デフォルトADRホームが使用されます。

デフォルトADRホームは次の場所です。

ADR_BASE/diag/OFM/domain_name/server_name

incidentTime

インシデントが発生した時点のタイムスタンプ。これが指定されていない場合、現在の時刻が使用されます。次のものを指定できます。

- HH:MMの形式の現在の日の時刻。例: 19:45

- MM/DD/YYYY HH:MMの形式の日付と時刻

messageId

エラー・メッセージのID。たとえば、MDS-50400です。

ecid

エラー・メッセージの実行コンテキストID。

appNname

診断を収集する対象となるデプロイされたアプリケーションの名前。

たとえば、複数のADFアプリケーションをデプロイした場合、それぞれがadf.dumpというダンプを登録することがあります。このコマンドを特定のアプリケーションに対して実行するには、そのアプリケーション名を指定する必要があります。

description

インシデントと関連付ける説明テキスト。これは、後でインシデントを確認する場合に便利です。

server

情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、IDがMDS-50400のメッセージに関連するインシデントを作成します。

createIncident(messageId="MDS-50400", description="sample incident")
Incident Id: 3
Problem Id: 2
Problem Key: MDS-50400 [MANUAL]
Incident Time:Tue May 28 11:52:45 PDT 2013
Error Message Id: MDS-50400
Execution Context:null
Flood Controlled: false
Dump Files :
jvm_threads25_i3.txt
dms_metrics26_i3.txt
dfw_samplingArchive28_i3.readme.txt
odl_logs29_i3.txt

8.1.3 getIncidentFile

WLSTでの使用: オンライン

説明

指定したインシデント・ファイルの内容を取得します。

構文

getIncidentFile(id, name [,outputFile] [,adrHome] [,server])

引数

定義

id

取得するインシデントのID。

name

取得するファイルの名前。ファイルの名前を見つけるには、showIncident コマンドを使用します。

outputFile

出力の書き込み先となるファイルの名前。

adrHome

情報の取得元となるADRホームのパス。この引数が指定されていない場合、デフォルトADRホームに問い合されます。

デフォルトADRホームは次の場所です。

ADR_BASE/diag/OFM/domain_name/server_name

server

情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、インシデントdms_metrics3_i1.dmpの内容を、指定した出力ファイルに書き込みます。

getIncidentFile(id='1', name='dms_metrics3_i1.dmp', outputFile='/tmp/incident1_dms.txt')
The content of 'dms_metrics3_i1.dmp'is written to /tmp/incident1_dms.txt

8.1.4 listADRHomes

WLSTでの使用: オンライン

説明

サーバーのすべてのADRホームのパスを一覧表示します。

構文

listADRHomes([server])

引数

定義

server

情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、ADRホームのパスを一覧表示します。

listADRHomes()
diag/ofm/base_domain/AdminServer
diag/ofm/EMGC_DOMAIN/EMOMS

8.1.5 listIncidents

WLSTでの使用: オンライン

説明

指定した問題ID(指定されている場合)または使用可能なすべてのインシデントの一連の診断インシデントを一覧表示します。

構文

listIncidents([id] [, adrHome] [,server])

引数

定義

id

一連の診断インシデントを一覧表示する問題のID。

adrHome

インシデントを問い合せるADRホームのパス。この引数が指定されていない場合、デフォルトADRホームに問い合されます。

デフォルトADRホームは次の場所です。

ADR_BASE/diag/OFM/domain_name/server_name

server

情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、IDが1の問題に関連付けられているインシデントを一覧表示します。

listIncidents(id="1")
Incident Id     Incident Time                   Problem Key
2       Tue May 28 11:05:59 PDT 2013    MDS-50500 [MANUAL]
1       Tue May 28 11:02:22 PDT 2013    MDS-50500 [MANUAL]

8.1.6 listProblems

WLSTでの使用: オンライン

説明

指定したADRホームに関連付けられている一連の診断問題を一覧表示します。

構文

listProblems([adrHome][,server])

引数

定義

adrHome

問題を問い合せるADRホームのパス。この引数が指定されていない場合、デフォルトADRホームに問い合されます。

デフォルトADRホームは次の場所です。

ADR_BASE/diag/OFM/domain_name/server_name

server

情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、デフォルトADRホームの診断問題を一覧表示します。

listProblems()
Problem Id        Problem Key
1        MDS-50500 [MANUAL]
2        JOC-38922 [AdminServer] [oracle.cache.network]

8.1.7 queryIncidents

WLSTでの使用: オンライン

説明

指定した基準に一致するインシデントをリストします。1つ以上のサーバー間、またはドメイン内のすべてのサーバーに対して特定の属性の値を問い合わせできます。

構文

queryIncidents(query [,servers])

引数

定義

query

単純式で構成された式で、ブール演算子で連結できます。式には、インシデント属性、演算子および文字列が次の書式で含まれます。

attribute operator "string"

単純式はカッコ()でグループ化されたブール演算子ANDまたはORで連結できます。

次のインシデント属性がサポートされています。

- TIMESTAMP: インシデント作成時間。fromおよびto演算子を使用して時間範囲を指定できます。日付書式はYYYY-MM-DD HH:MMです。

- ECID: 実行コンテキストID

- PROBLEM_KEY: 問題キー

- MSG_FACILITY: エラー・メッセージ機能(ORA、OHSなど)

- MSG_NUMBER: エラー・メッセージID (600など)

カスタム・インシデント属性もサポートされています。たとえば、TRACEID、APP、URI、AND DSIDがサポートされています。さらに、インシデントのreadme.txtファイルに示されるコンテキスト値がサポートされています。たとえば、DFW_APP_NAMEおよびDFW_USER_NAMEがサポートされています。

サポートされている演算子は次のとおりです。

- equals

- notEqual

- startsWith

- endsWith

- contains

- isNull

- notNull

servers

問い合せる1つ以上のサーバーの名前。この引数はオプションです。指定しない場合、ドメイン内のすべてのサーバーに対してコマンドが実行されます。

このオプションは、管理サーバーに接続している場合にのみ有効です。

例

次の例では、ドメイン内のすべてのインシデントに対してECID f19wAgN000001を問い合せます。

queryIncidents(query="ECID equals f19wAgN000001")

次の例では、2013年4月1日から2013年4月15日の間に発生したすべてのインシデントをサーバーwls_server1に問い合せます。

queryIncidents(query="TIMESTAMP from '2013-04-01 00:00'AND TIMESTAMP to '2013-04-15 00:00'", servers=["wls_server1"])

8.1.8 reloadCustomRules

WLSTの使用状況: オンライン、オフライン

説明

すべてのカスタム診断ルールまたは指定されたカスタム診断ルールを再ロードします。

構文

reloadCustomRules([name] [, server])

引数

定義

name

カスタム診断ルールの名前。この引数はオプションです。指定した場合は、指定したルールのみが再ロードされます。この引数を指定しない場合、すべてのカスタム診断ルールが再ロードされます。

カスタム診断ルールを含むファイルが、次のいずれかのディレクトリに置かれている必要があります。

DOMAIN_HOME/config/fmwconfig/dfw
DOMAIN_HOME/config/fmwconfig/servers/server_name/dfw

server

ルールの再ロード先のサーバーの名前。この引数はオプションです。指定しない場合、ルールはすべてのサーバーに再ロードされます。

このオプションは、管理サーバーに接続している場合にのみ有効です。

例

次の例では、カスタム診断ルールmyCustomRules.xmlを再ロードします。

reloadCustomRules(name='myCustomRules.xml')

8.1.9 showIncident

WLSTでの使用: オンライン

説明

指定したインシデントの詳細を表示します。

構文

showIncident(id, [adrHome][, server])

引数

定義

id

表示するインシデントのID。

adrHome

インシデントを問い合せるADRホームのパス。この引数が指定されていない場合、デフォルトADRホームに問い合されます。

デフォルトADRホームは次の場所です。

ADR_BASE/diag/OFM/domain_name/server_name

server

情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、IDが10のインシデントに関する情報を表示します。

showIncident(id="10")
Incident Id: 10
Problem Id: 10
Problem Key: MDS-50500 [MANUAL]
Incident Time:Tue May 28 11:02:22 PDT 2013
Error Message Id: MDS-50500
Execution Context:
Flood Controlled: false
Dump Files :
readme.txt
jvm_threads10_i1.txt
dms_metrics11_i1.txt
dfw_samplingArchive13_i1.JVMThreadDump.txt
dfw_samplingArchive13_i1.readme.txt
odl_logs14_i1.txt
dms_metrics20_i1.txt

8.2 診断ダンプ・コマンド

診断ダンプは、特定の診断情報を取得およびダンプします。この処理は、インシデントが作成された時点では自動で、管理者が要求した時点では手動で行われます。WLST診断ダンプ・コマンドでは、ダンプを表示および実行できます。

表8-3のコマンドを使用して、ダンプに関する情報を表示し、ダンプを実行します。

表8-3 診断ダンプ・コマンド

使用するコマンド

目的

WLSTでの使用

describeDump

指定した診断ダンプの説明を表示します。

オンライン

executeDump

指定した診断ダンプを実行します。

オンライン

listDumps

実行できる一連の診断ダンプを表示します。

オンライン

8.2.1 describeDump

WLSTでの使用: オンライン

説明

指定した診断ダンプの説明を表示します。

構文

describeDump(name [,appName] [.server])

引数

定義

name

情報を表示するダンプの名前。

appName

情報を収集するデプロイされたアプリケーションの名前。

たとえば、複数のADFアプリケーションをデプロイした場合、それぞれがadf.dumpというダンプを登録することがあります。このコマンドを特定のアプリケーションに対して実行するには、そのアプリケーション名を指定する必要があります。

server

情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、odl.logsという名前のダンプに関する情報を表示します。listDumpsコマンドを使用して、使用可能なダンプのリストを取得します。

describeDump(name="odl.logs")
Name: odl.logs
Description: Dump contents of diagnostic logs
Run Mode: asynchronous
Mandatory Arguments:
Optional Arguments:
Name        Type     Description
match_all   BOOLEAN  Whether to match both ECID and time range or any one of them.
timestamp   LONG     Log message timestamp in milliseconds
ecid        STRING   Log message execution context ID (ecid)
exclude_access_logs BOOLEAN  Excludes access logs from dump.
timerange   LONG     Time range in minutes

8.2.2 executeDump

WLSTでの使用: オンライン

説明

指定した診断ダンプを実行します。

構文

executeDump(name [,args] [,outputFile] [,id] [,adrHome] [,server])

引数

定義

name

実行する診断ダンプの名前。

args

ダンプに渡す必須またはオプションの引数。

outputFile

ダンプの書き込み先となるファイルの名前。この引数を指定しない場合、出力はコンソールに書き込まれます。

id

ダンプを関連付けるインシデントのID。デフォルトでは、指定したダンプはインシデントと関連付けされません。

adrHome

インシデントが含まれているADRホーム。この引数を指定しない場合、デフォルトADRホームが使用されます。

デフォルトADRホームは次の場所です。

ADR_BASE/diag/OFM/domain_name/server_name

server

情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

argsキーワードを使用して、必須またはオプションの引数を指定できます。次に例を示します。

executeDump("java.sysprops",args={"prop" : "os.name"})

例

次の例では、jvm.threadsという名前のダンプを実行し、それをdumpout.txtファイルに書き込みます。

executeDump(name="jvm.threads", outputFile="/tmp/dumpout.txt")
Diagnostic dump jvm.threads output written to /tmp/dumpoutput.txt

次の例では、jvm.threadsという名前で、インシデントIDが33のダンプを実行し、それをdumpout.txtファイルに書き込みます。

executeDump(name="jvm.threads", outputFile="/tmp/dumpout.txt", id="33")
Diagnostic dump jvm.threads output associated with incident 33 in ADR Home diag/ofm/base_domain/AdminServer

次の例では、引数propを値os.nameに設定してダンプを実行します。

executeDump(name="java.sysprops",args={"prop" : "os.name"})

8.2.3 listDumps

WLSTでの使用: オンライン

説明

実行できる一連の診断ダンプを表示します。

構文

listDumps([appName] [,server])

引数

定義

appName

診断を収集する対象となるデプロイされたアプリケーションの名前。

たとえば、複数のADFアプリケーションをデプロイした場合、それぞれがadf.dumpというダンプを登録することがあります。このコマンドを特定のアプリケーションに対して実行するには、そのアプリケーション名を指定する必要があります。

この引数を指定した場合、指定されたアプリケーションのダンプが返されます。この引数を指定しない場合、システム・ダンプが返されます。

server

情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、使用可能なすべてのダンプを一覧表示します。

listDumps()
adf.DiagnosticsJarsVersionDump
dfw.samplingArchive
dms.configuration
dms.ecidctx
dms.metrics
http.requests
jvm.classhistogram
jvm.threads
mds.MDSInstancesDump
odl.activeLogConfig
odl.logs
odl.quicktrace
opss.diagTest
opss.identityStoreUserRoleApiConfig
opss.securityContext
wls.image

Use the command describeDump(name=<dumpName>) for help on a specific dump.

8.3 ダンプ・サンプリング・コマンド

診断ダンプ・サンプリングは、指定された間隔で診断ダンプの出力を取得します。WLSTダンプ・サンプリング・コマンドでは、ダンプ・サンプリングを管理できます。

表8-4のコマンドを使用して、指定した間隔で診断ダンプのサンプルを取得します。

表8-4 ダンプ・サンプリング・コマンド

使用するコマンド

目的

WLSTでの使用

addDumpSample

診断フレームワーク・ダンプのサンプリングを作成します。

オンライン

enableDumpSampling

すべてのダンプ・サンプリングを有効化または無効化します。

オンライン

getSamplingArchives

すべてのダンプ・サンプルを、個々のサンプリング・ファイルとREADMEファイルを含むzipファイルに収集します。

オンライン

isDumpSamplingEnabled

ダンプ・サンプリングが有効か無効かをリストします。

オンライン

listDumpSamples

すべてのダンプ・サンプリング、指定したダンプ・サンプリングまたは指定したサーバーに関連付けられているすべてのダンプ・サンプリングをリストします。

オンライン

removeDumpSample

指定したダンプ・サンプリングを削除します。

オンライン

updateDumpSample

指定したダンプ・サンプリングを更新し、サンプリングの設定を変更します。

オンライン

8.3.1 addDumpSample

WLSTでの使用: オンライン

説明

診断フレームワーク・ダンプに対するダンプ・サンプリングを作成します。

構文

addDumpSample(sampleName, diagnosticDumpName [, appName], samplingInterval,
rotationCount [, dumpedImplicitly] [, toAppend] [, args] [, server])

引数

定義

sampleName

サンプリングの名前。

diagnosticDumpName

取得する診断ダンプの名前。

appName

省略可能。指定された診断ダンプに関連付けられているアプリケーションの名前。appNameを指定しない場合、診断ダンプの対象はシステムになります。

samplingInterval

秒単位のサンプリング間隔。0または負の値を指定すると、サンプリングは一時停止されます。

rotationCount

ローテーション・リストに含める診断ダンプ・サンプルの最大数。この上限に達すると、最も古いサンプルが削除されます。

dumpedImplicitly

省略可能。診断ダンプのアーカイブをdfw.samplingArchiveに含むかどうかを指定するブール値。有効な値は、trueおよびfalseです。デフォルトは、trueです。

値がfalseの場合に、ダンプ・アーカイブをdfw.samplingArchiveに含めるには、argsパラメータを使用してサンプリング名をexecuteDumpコマンドに渡す必要があります。

toAppend

省略可能。dfw.samplingArchiveの実行時に診断ダンプ・サンプルが前のサンプルに追加され、単一アーカイブとなるようにするどうかを指定するブール値。有効な値は、trueおよびfalseです。デフォルトは、trueです。値がtrueの場合、サンプルが前のサンプルに追加されます。値がfalseの場合、dfw.sampleArchiveによって個々のサンプル・ファイルが含まれるzipファイルが返されます。ダンプ・サンプルにバイナリ・データが含まれている場合はfalseを指定します。

args

省略可能。各サンプリング時に診断ダンプにより使用される診断ダンプ引数。引数は名前/値ペアで指定します。

server

省略可能。情報の収集元となるサーバーの名前。このパラメータを指定しないと、このコマンドにより、ダンプ・サンプリングが管理サーバーに関連付けられます。

例

次の例では、ダンプdms.metricsに対するサンプリングを追加します。

addDumpSample(sampleName='dms_metrics', diagnosticDumpName='dms.metrics',
samplingInterval=300, rotationCount=10)

dms_metrics is added

8.3.2 enableDumpSampling

WLSTでの使用: オンライン

説明

すべてのダンプ・サンプリングを有効化または無効化します。このコマンドは構成済のすべてのダンプ・サンプリングに影響します。

構文

enableDumpSampling(enable [,server])

引数

定義

enable

ダンプ・サンプリングを有効化または無効化するかを指定するブール値。有効な値は、trueおよびfalseです。

server

省略可能。ダンプ・サンプリングを有効化または無効化するサーバーの名前。このパラメータを指定しないと、このコマンドにより、管理サーバーに対するダンプ・サンプリングが有効化または無効化されます。

例

次の例では、すべてのダンプ・サンプリングを無効化します。

enableDumpSampling(enable=false)

Dump sampling disabled

8.3.3 getSamplingArchives

WLSTでの使用: オンライン

説明

すべてのダンプ・サンプリングを、個々のサンプリング・ファイルとREADMEファイルを含むzipファイルに収集します。この方法は、バイナリ形式のダンプを扱う場合に特に有用です。

構文

getSamplingArchives([sampleName,] outputFile [,server])

引数

定義

name

省略可能。取得する特定のダンプ・サンプリングの名前。この引数を指定しない場合、このコマンドにより、すべてのダンプ・サンプリングが返されます。

outputFile

ダンプ・サンプリングが書き込まれるファイルの絶対パス。

server

省略可能。情報の収集元となるサーバーの名前。このパラメータを指定しないと、このコマンドにより、管理サーバーに対するダンプ・サンプリングが収集されます。

例

次の例では、ダンプJVMThreadDumpに対するダンプ・サンプリングを取得します。

getSamplingArchives(sampleName="JVMThreadDump", outputFile="/tmp/jvm_dump.zip")
wrote 63518 bytes to /tmp/jvm_dump.zip

zipファイルの内容を次に示します。

unzip -l jvm_dump.zip
Archive:  jvm_dump.zip
Length     Date   Time    Name
--------    ----   ----    ----
508780  05-21-13 07:25   dfw_samplingArchive1065570966467923683.JVMThreadDump.dmp
840  05-21-13 07:25   dfw_samplingArchive7749640004639161119.readme.txt
--------                   -------
509620                   2 files

8.3.4 isDumpSamplingEnabled

WLSTでの使用: オンライン

説明

ダンプ・サンプリングが有効化されているかどうかを示します。

構文

isDumpSamplingEnabled([server])

引数

定義

server

省略可能。ダンプ・サンプリングが有効化されているかどうかを判断するサーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、サーバーwls_server_1に対するダンプ・サンプリングが有効化されているか無効化されているかをリストします。

isDumpSamplingEnabled(server="wls_server_1")

true

8.3.5 listDumpSamples

WLSTでの使用: オンライン

説明

すべてのダンプ・サンプリング、指定されたダンプ・サンプリングまたは指定されたサーバーに関連付けられているすべてのダンプ・サンプリングを表示します。

構文

listDumpSamples([sampleName] [, server])

引数

定義

sampleName

省略可能。サンプリングの名前。

server

省略可能。ダンプ・サンプリングを一覧表示するサーバーの名前。このパラメータを指定しないと、このコマンドにより、管理サーバーに対するダンプ・サンプリングが一覧表示されます。

例

次の例では、サーバーwls_server_1に関連付けられているすべてのダンプ・サンプリングをリストします。

listDumpSamples(server="wls_server_1")
Name              : JVMThreadDump
Dump Name         : jvm.threads
Application Name  :
Sampling Interval : 30
Rotation Count    : 20
Dump Implicitly   : true
Append Samples    : true
Dump Arguments    : context=true, timing=true, progressive=true, depth=20, threshold=30000

Name              : JavaClassHistogram
Dump Name         : jvm.classhistogram
Application Name  :
Sampling Interval : 1800
Rotation Count    : 5
Dump Implicitly   : false
Append Samples    : true
Dump Arguments    :

8.3.6 removeDumpSample

WLSTでの使用: オンライン

説明

ダンプ・サンプリングを削除します。

構文

removeDumpSample(sampleName [,server])

引数

定義

sampleName

削除するダンプ・サンプリングの名前。

server

省略可能。サンプリングの削除元となるサーバーの名前。このパラメータを指定しないと、管理サーバーからダンプ・サンプリングが削除されます。

例

次の例では、サーバーwls_server_1に関連付けられているHTTPSamplingという名前のダンプ・サンプリングを削除します。

removeDumpSample(sampleName="HTTPSampling", server="wls_server_1")

Removed HTTPSampling

8.3.7 updateDumpSample

WLSTでの使用: オンライン

説明

サンプリングの設定を変更して、指定されたダンプ・サンプリングを更新します。サンプリングの名前は変更できません。変更は、次回のサンプリング間隔から有効になります。

構文

updateDumpSample(sampleName [, appName], samplingInterval,
rotationCount [,dumpedImplicitly] [, toAppend] [, arg,]
[, server])

引数

定義

sampleName

ダンプ・サンプリングの名前。

appName

省略可能。指定された診断ダンプに関連付けられているアプリケーションの名前。appNameを指定しない場合、診断ダンプの対象はシステムになります。

samplingInterval

省略可能。秒単位のサンプリング間隔。0または負の値を指定すると、サンプリングは一時停止されます。

rotationCount

省略可能。ローテーション・リストに含める診断ダンプ・サンプリングの最大数。この上限に達すると、最も古いサンプリングが削除されます。

dumpedImplicitly

省略可能。診断ダンプのアーカイブをdfw.samplingArchiveに含むかどうかを指定するブール値。有効な値は、trueおよびfalseです。デフォルトは、trueです。

値がfalseの場合に、ダンプ・アーカイブをdfw.samplingArchiveに含めるには、argsパラメータを使用してサンプリング名をexecuteDumpコマンドに渡す必要があります。

toAppend

省略可能。dfw.samplingArchiveの実行時に診断ダンプ・サンプルが前のサンプルに追加され、単一アーカイブとなるようにするどうかを指定するブール値。有効な値は、trueおよびfalseです。デフォルトは、trueです。値がtrueの場合、サンプルが前のサンプルに追加されます。値がfalseの場合、dfw.sampleArchiveによって個々のサンプリング・ファイルが含まれるzipファイルが返されます。ダンプ・サンプリングにバイナリ・データが含まれている場合はfalseを指定します。

args

省略可能。各サンプリング時に診断ダンプにより使用される診断ダンプ引数。引数は名前/値ペアで指定します。

server

省略可能。情報の収集元となるサーバーの名前。このパラメータを指定しないと、管理サーバーに対してダンプ・サンプリングが更新されます。

例

次の例では、サンプリング間隔、ローテーション数およびサーバーを変更して、ダンプ・サンプリングHTTPSamplingを更新します。

updateDumpSample(sampleName="HTTPSampling", samplingInterval=200,
rotationCount=5, server="wls_server1")

HTTPSampling is updated

9 User Messaging Service (UMS)カスタムWLSTコマンド

Oracle User Messaging Serviceは、アプリケーションからデバイスにメッセージを送信する共通サービスを提供します。また、着信メッセージをデバイスからアプリケーションにルーティングします。

この章では、Oracle User Messaging Service (UMS)で使用可能なWLSTコマンドについて説明します。

9.1 UMS WLSTコマンド・グループ

UMS WLSTコマンドは、「ums」コマンド・グループの下に一覧表示されます。

注意:

これらのコマンドを使用するには、コンポーネントがインストールされているOracleホームからWLSTを呼び出す必要があります。『Oracle Fusion Middleware Oracle Fusion Middlewareの管理』のカスタムWLSTコマンドの使用に関する項を参照してください。

9.1.1 configUserMessagingDriver

コマンド・カテゴリ: ums

WLSTでの使用: オンライン

説明

configUserMessagingDriverは、メッセージング・ドライバの構成に使用されます。

新しいドライバ構成のベース・ドライバ・タイプ(apns、smpp、email、xmppなど)および短縮名を指定します。指定したアプリケーション名の前に文字列usermessagingdriver-が付加されます。

構文

configUserMessagingDriver(baseDriver, appName, driverProperties, clusterName=None,serverName=None, enabled=true)

propertyGroupsの使用は、12.2.1以降非推奨です。非推奨になった構文:

configUserMessagingDriver(baseDriver, appName, driverProperties,
clusterName=None
serverName=None, propertyGroups=None, enabled=true)

引数

定義

baseDriver

ベース・メッセージ・ドライバ・タイプを指定します。

apns、email、extension、smpp、twitter、xmppなどの既知のドライバ・タイプにする必要があります。

appName

デプロイメントの短い説明の名前。指定した値をusermessagingdriver-文字列の先頭に追加します。

driverProperties

ドライバ・プロパティを持つオブジェクト。次のいずれかのクラスのオブジェクトになります。

CommonDriverProperties、ApnsDriverProperties、EmailDriverProperties、SmppDriverProperties、ExtensionDriverProperties、TwitterDriverPropertiesまたはXmppDriverProperties。

ドライバの使用可能なすべてのドライバ・プロパティを確認するには、クラスのdictフィールドを出力します。次に例を示します。

print CommonDriverProperties().__dict__

print EmailDriverProperties().__dict__

serverName

省略可能。この構成を有効にする管理対象サーバーの名前。clusterNameまたはServerNameのいずれかを指定する必要があります。両方は許可されていません。両方がNoneである場合、構成はすべての管理対象サーバーで管理対象サーバー・レベル構成になります。

clusterName

省略可能。この構成を有効にするクラスタの名前。clusterNameまたはserverNameのいずれかを指定する必要があります。両方は許可されていません。両方がNoneである場合、構成はすべての管理対象サーバーで管理対象サーバー・レベル構成になります。

enabled

省略可能。構成を有効または無効にするかどうかを指定します。

設定されていない場合、デフォルト値はtrueです。

例

例9-1 xmppという名前でXMPPドライバを構成する場合

driverProperties = XmppDriverProperties()
driverProperties.SenderAddresses = 'IM:alice@example.com'
driverProperties.IMServerHost = 'example.com'
driverProperties.IMServerUsername = 'alice'
driverProperties.IMServerPassword = 'secret'
configUserMessagingDriver(baseDriver='xmpp', appName='xmpp',
driverProperties=driverProperties, clusterName='my_cluster')

例9-2 extensionという名前で拡張ドライバを構成する場合

driverProperties = ExtensionDriverProperties()
extensionDriverProperties.EndpointURL = 'http://domain.example.com/extension'
extensionDriverProperties.MappedDomain = 'example.com'
extensionDriverProperties.Protocol = 'popup'
configUserMessagingDriver(baseDriver='extension', appName='extension',
driverProperties=driverProperties)

9.1.2 configUserMessagingServer

コマンド・カテゴリ: ums

WLSTでの使用: オンライン

説明

configUserMessagingServerは、メッセージング・サーバーの構成に使用されます。

構文

configUserMessagingServer(serverProperties, clusterName=None), serverName=None)

引数

定義

serverProperties

サーバー・プロパティを持つオブジェクト。クラスServerPropertiesのオブジェクトである必要があります。

使用可能なすべてのプロパティを確認するには、クラスのdictフィールドを出力します。次に例を示します。

print serverProperties().__dict__

clusterName

省略可能。この構成を有効にする管理対象サーバーの名前。clusterNameまたはServerNameのいずれかを指定する必要があります。両方は許可されていません。両方がNoneである場合、構成はすべての管理対象サーバーで管理対象サーバー・レベル構成になります。

serverName

省略可能。この構成を有効にするクラスタの名前。clusterNameまたはserverNameのいずれかを指定する必要があります。両方は許可されていません。両方がNoneである場合、構成はすべての管理対象サーバーで管理対象サーバー・レベル構成になります。

例

例9-3 my_clusterという名前のクラスタ内のUMSサーバーのJPSコンテキスト名を構成する場合

serverProperties = ServerProperties()
serverProperties.JpsContext = 'my_jps_context'
configUserMessagingServer(serverProperties=serverProperties, clusterName='my_cluster')

例9-4 ドメイン内のUMSサーバーのセキュリティ・プリンシパルを構成する場合

serverProperties = ServerProperties()
serverProperties.SecurityPrincipal = 'MyUser'
configUserMessagingServer(serverProperties=serverProperties)

9.1.3 manageUserCommunicationPrefs

コマンド・カテゴリ: ums

WLSTでの使用: オフライン

説明

manageUserCommunicationPrefsは、ユーザー・メッセージング・プリファレンスをバックエンド・データベースから指定したXMLファイルにダウンロードするため、またはユーザー・メッセージング・プリファレンスをXMLファイルからバックエンド・データベースにアップロードするため、またはユーザー・プリファレンスをバックアップ・データベースから削除してプリファレンスを指定したXMLファイルにバックアップするために使用されます。

構文

manageUserCommunicationPrefs (operation={'download' | 'upload' | 'delete'}, filename='file_name', url='jndi_url', username='username', password='password'
[, encoding='character_encoding'] [, guid='guid1,guid2, ...' ] [, merge={'create_new' | 'overwrite' | 'append'}] )

引数

定義

operation

実行するアップロード、削除またはダウンロード操作を指定します。

filename

ダウンロードするための、ユーザー・プリファレンスをダウンロードするユニークなファイル名(パス)。たとえば、/tmp/download.xml (Linux)またはC:\\temp\\download.xml (Windows)。

アップロードの場合、ユーザー・プリファレンスをアップロードするファイル名(パス)。

削除の場合、ファイル名(パス)は、削除されるユーザー・プリファレンスを格納するために使用されます。

url

User Messaging ServerにアクセスするためのJNDI URL。たとえば: t3://<hostname>:<port>

username

User Messaging Serverにアクセスするためのログイン権限を持つユーザー名。

password

ユーザー名のパスワード。

encoding

(オプション)ユーザー・プリファレンスのダウンロードに使用する文字エンコーディング。

guid

(オプション)プリファレンスのダウンロードに使用するユーザー・リストのグローバル一意識別子(GUID)。guidが指定されない場合、すべてのユーザーのプリファレンスがダウンロードされます。削除の場合、GUIDは、この操作でプリファレンスが削除されるユーザーを指定します。

merge

(オプション)この引数はアップロード専用です。有効な値は次のとおりです。

create_new(デフォルト): 新しいユーザー・デバイス、デバイス・アドレスやルール・セット・エンティティを作成します。同じプライマリ・キーを持つエンティティがすでに存在する場合は、例外がスローされ、処理が停止します。

overwrite: ユーザーの既存のエンティティのすべてを削除し、新しいエンティティを作成します。

append: 既存に存在しないエンティティのみをアップロードします。

例

注意:

下のURLで、ポート7001はUMSがデプロイされている管理対象サーバー・ポートを表します。

すべてのユーザーのユーザー・メッセージング・プリファレンスを指定されたファイルにダウンロードするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='download',
filename='download.xml', url='t3://localhost:7001', username='weblogic',
password='<password>')

すべてのユーザーのユーザー・メッセージング・プリファレンスを、UTF-8文字エンコーディングを使用されている指定したファイルにダウンロードするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='download',
filename='download.xml', url='t3://localhost:7001', username='weblogic',
password='<password>', encoding='UTF-8')

guid 「john.doe」のユーザーのユーザー・メッセージング・プリファレンスを指定したファイルにダウンロードするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='download',
filename='download.xml', url='t3://localhost:7001', username='weblogic',
password='<password>', guid='john.doe')

guid 「john.doe」および「jane.doe」を持つユーザーのユーザー・メッセージング・プリファレンスをUTF-8文字エンコーディングを使用している指定したファイルにダウンロードするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='download',
filename='download.xml', url='t3://localhost:7001', username='weblogic',
password='<password>', guid='john.doe,jane.doe', encoding='UTF-8')

指定したファイルからのユーザー・メッセージング・プリファレンスをバックエンドのデータベースにアップロードするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='upload', filename='upload.xml',
url='t3://localhost:7001', username='weblogic', password='<password>')

指定したファイルからのユーザー・メッセージング・プリファレンスをバックエンドのデータベースにアップロードして、既存のプリファレンスを上書きするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='upload', filename='upload.xml',
url='t3://localhost:8001', username='weblogic', password='<password>',
merge='overwrite')

GUIDが'john.doe'のユーザーのユーザー・プリファレンスを削除し、指定したファイルにプリファレンスをバックアップするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='delete', filename='backup.xml', url='t3://localhost:7001', username='weblogic', password='<password>', guid='john.doe')

GUIDが'john.doe'および'jane.doe'のユーザーのユーザー・メッセージング・プリファレンスを削除し、UTF-8文字エンコーディングを使用して指定されたファイルにプリファレンスをバックアップするには、次のコマンドを実行します。

wls:offline> manageUserCommunicationPrefs(operation='delete', filename='backup.xml', url='t3://localhost:7001', username='weblogic', password='<password>', guid='john.doe,jane.doe', encoding='UTF-8')

Oracleの法律上の注意点

コピーライト

Copyright © 1994-2017, Oracle and/or its affiliates. All rights reserved.

ライセンス制約の保証と結果的に生じる損害の免責

このソフトウェアおよび関連ドキュメントの使用と開示は、ライセンス契約の制約条件に従うものとし、知的財産に関する法律により保護されています。ライセンス契約で明示的に許諾されている場合もしくは法律によって認められている場合を除き、形式、手段に関係なく、いかなる部分も使用、複写、複製、翻訳、放送、修正、ライセンス供与、送信、配布、発表、実行、公開または表示することはできません。このソフトウェアのリバース・エンジニアリング、逆アセンブル、逆コンパイルは互換性のために法律によって規定されている場合を除き、禁止されています。

保証免責

ここに記載された情報は予告なしに変更される場合があります。また、誤りが無いことの保証はいたしかねます。誤りを見つけた場合は、オラクルまでご連絡ください。

制限付権利について

このソフトウェアまたは関連ドキュメントを、米国政府機関もしくは米国政府機関に代わってこのソフトウェアまたは関連ドキュメントをライセンスされた者に提供する場合は、次の通知が適用されます。

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

危険な用途への使用について

このソフトウェアまたはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアまたはハードウェアは、危険が伴うアプリケーション(人的傷害を発生させる可能性があるアプリケーションを含む)への用途を目的として開発されていません。このソフトウェアまたはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性(redundancy)、その他の対策を講じることは使用者の責任となります。このソフトウェアまたはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、Oracle Corporationおよびその関連会社は一切の責任を負いかねます。

商標と登録商標について

OracleおよびJavaはオラクルおよびその関連会社の登録商標です。その他の社名、商品名等は各社の商標または登録商標である場合があります。

Intel、Intel Xeonは、Intel Corporationの商標または登録商標です。すべてのSPARCの商標はライセンスをもとに使用し、SPARC International, Inc.の商標または登録商標です。AMD、Opteron、AMDロゴ、AMD Opteronロゴは、Advanced Micro Devices, Inc.の商標または登録商標です。UNIXは、The Open Groupの登録商標です。

第三者のコンテンツ、製品、サービスに対する免責事項

このソフトウェアまたはハードウェア、そしてドキュメントは、第三者のコンテンツ、製品、サービスへのアクセス、あるいはそれらに関する情報を提供することがあります。適用されるお客様とOracle Corporationとの間の契約に別段の定めがある場合を除いて、Oracle Corporationおよびその関連会社は、第三者のコンテンツ、製品、サービスに関して一切の責任を負わず、いかなる保証もいたしません。適用されるお客様とOracle Corporationとの間の契約に定めがある場合を除いて、Oracle Corporationおよびその関連会社は、第三者のコンテンツ、製品、サービスへのアクセスまたは使用によって損失、費用、あるいは損害が発生しても一切の責任を負いかねます。

Pre-General Availability (一般提供前)版のドキュメントについて

このドキュメントがPre-General Availability (一般提供前)版の場合:

このドキュメントはPre-General Availability (一般提供前)版であり、デモおよび暫定使用のみを目的としたものです。このソフトウェアを使用するハードウェアに限定するものではありません。Oracle Corporationおよびその関連会社は、このドキュメントに関して一切の責任を負わず、いかなる保証もいたしません。また、このドキュメントを使用したことによって損失、費用、あるいは損害が発生しても、一切の責任を負いかねます。

非公開のPre-General Availability (一般提供前)版のドキュメントについて

このドキュメントが非公開のPre-General Availability (一般提供前)版の場合:

このドキュメントに含まれる情報は、情報の共有のみを目的としたものであって、顧客諮問委員会(Customer Advisory Board)のメンバーとしてのお客様の立場でのみ、またはお客様のPre-General Availability Trial Agreement (Pre-GAトライアル契約)のみに従って検討されるべきものとします。マテリアル、コード、または機能の提供をお約束するものではなく、購入決定を行う際の判断材料とすべきではありません。このドキュメントに記載されている特徴または機能の開発、リリースおよび時期については、オラクルの裁量により決定されます。

このドキュメントには、ソフトウェアまたは印刷物などの形式を問わず、オラクルが独占的な権利を有する財産的情報が含まれています。この機密資料へのアクセスと使用は、お客様とオラクルとの間で締結され、お客様が遵守に同意した、Oracle Master Agreement、Oracle License and Oracle Services Agreement (オラクル・ライセンスおよびサービスに関する契約書)、Oracle Partner Network Agreement、Oracle Distribution Agreementまたはその他のライセンス契約の条件に従うものとします。このドキュメントとその内容の開示、コピー、複製および配布には、オラクルによる事前の承諾を必要とします。このドキュメントはライセンス契約の一部となるものではなく、オラクルおよびその子会社や関連会社との契約を構成するものではありません。

ドキュメントのアクセシビリティ

オラクルのアクセシビリティについての詳細情報は、Oracle Accessibility ProgramのWebサイト(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc)を参照してください。

Oracle Supportへのアクセス

サポートをご契約のお客様には、My Oracle Supportを通して電子支援サービスを提供しています。詳細情報は(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info)か、聴覚に障害のあるお客様は(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs)を参照してください。