Oracle® Fusion Middleware

WebLogic Scripting Toolコマンド・リファレンス

11gリリース2 (11.1.2.2.0)

B71704-04(原本部品番号:E28155-09)

2014年2月

このドキュメントでは、WebLogic Scripting Tool (WLST)で利用できるすべてのコマンドについて説明します。このドキュメントでは、インストールされたOracle Fusion Middlewareコンポーネントの管理に使用できるWebLogic ServerでのWLSTコマンドおよびカスタムWLSTコマンドについて説明します。

Oracle Fusion Middleware WebLogic Scripting Toolコマンド・リファレンス11gリリース2 (11.1.2.2.0)

B71704-04

Copyright © 2007, 2014, Oracle and/or its affiliates. All rights reserved.

原本主著者: Gail Flanegin、Michael Teger

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

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

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

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

このソフトウェアもしくはハードウェアは様々な情報管理アプリケーションでの一般的な使用のために開発されたものです。このソフトウェアもしくはハードウェアは、危険が伴うアプリケーション(人的傷害を発生させる可能性があるアプリケーションを含む)への用途を目的として開発されていません。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用する際、安全に使用するために、適切な安全装置、バックアップ、冗長性(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の登録商標です。

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

目次

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

はじめに

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

- 表記規則

1 概要とロードマップ

- ドキュメントの内容と対象読者

- このドキュメントの手引き

- 関連ドキュメント

- このリリースでのWLSTの新機能と変更点

2 WebLogic Server WLSTオンラインおよびオフライン・コマンド・リファレンス

- WebLogic Server WLSTコマンドのサマリー(コマンドのアルファベット順)

- WebLogic Server WLSTオンライン・コマンドのサマリー

- WebLogic Server WLSTオフライン・コマンドのサマリー

3 WLSTコマンドおよび変数リファレンス

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

- 参照コマンド

- cd

- currentTree

- prompt

- pwd

- 制御コマンド

- addTemplate

- closeDomain

- closeTemplate

- connect

- createDomain

- disconnect

- exit

- readDomain

- readTemplate

- updateDomain

- writeDomain

- writeTemplate

- カスタマイズ・コマンド

- addHelpCommandGroup

- addHelpCommand

- デプロイメント・コマンド

- deploy

- distributeApplication

- getWLDM

- listApplications

- loadApplication

- redeploy

- startApplication

- stopApplication

- undeploy

- updateApplication

- 診断コマンド

- exportDiagnosticData

- exportDiagnosticDataFromServer

- getAvailableCapturedImages

- saveDiagnosticImageCaptureFile

- saveDiagnosticImageCaptureEntryFile

- 編集コマンド

- activate

- assign

- cancelEdit

- create

- delete

- encrypt

- get

- getActivationTask

- invoke

- isRestartRequired

- loadDB

- loadProperties

- save

- set

- setOption

- showChanges

- startEdit

- stopEdit

- unassign

- undo

- validate

- 情報コマンド

- addListener

- configToScript

- dumpStack

- dumpVariables

- find

- getConfigManager

- getMBean

- getMBI

- getPath

- listChildTypes

- lookup

- ls

- man

- redirect

- removeListener

- showListeners

- startRecording

- state

- stopRecording

- stopRedirect

- storeUserConfig

- threadDump

- viewMBean

- writeIniFile

- ライフサイクル・コマンド

- migrate

- resume

- shutdown

- start

- startServer

- suspend

- ノード・マネージャ・コマンド

- nm

- nmConnect

- nmDisconnect

- nmEnroll

- nmGenBootStartupProps

- nmKill

- nmLog

- nmServerLog

- nmServerStatus

- nmStart

- nmVersion

- startNodeManager

- stopNodeManager

- ツリー・コマンド

- custom

- domainConfig

- domainCustom

- domainRuntime

- edit

- jndi

- serverConfig

- serverRuntime

- WLST変数リファレンス

4 インフラストラクチャ・セキュリティ・カスタムWLSTコマンド

- WSLTコマンドの使用

- 監査設定コマンド

- getNonJavaEEAuditMBeanName

- getAuditPolicy

- setAuditPolicy

- getAuditRepository

- setAuditRepository

- listAuditEvents

- exportAuditConfig

- importAuditConfig

- SSL設定コマンド

- addCertificateRequest

- addSelfSignedCertificate

- changeKeyStorePassword

- changeWalletPassword

- configureSSL

- createKeyStore

- createWallet

- deleteKeyStore

- deleteWallet

- exportKeyStore

- exportKeyStoreObject

- exportWallet

- exportWalletObject

- generateKey

- getKeyStoreObject

- getSSL

- getWalletObject

- importKeyStore

- importKeyStoreObject

- importWallet

- importWalletObject

- listKeyStoreObjects

- listKeyStores

- listWalletObjects

- listWallets

- removeKeyStoreObject

- removeWalletObject

- セキュリティ・コマンド

- createAppRole

- deleteAppRole

- grantAppRole

- revokeAppRole

- listAppRoles

- listAppRolesMembers

- grantPermission

- revokePermission

- listPermissions

- deleteAppPolicies

- migrateSecurityStore

- listCred

- updateCred

- createCred

- deleteCred

- modifyBootStrapCredential

- addBootStrapCredential

- exportEncryptionKey

- importEncryptionKey

- restoreEncryptionKey

- reassociateSecurityStore

- upgradeSecurityStore

- createResourceType

- getResourceType

- deleteResourceType

- listAppStripes

- createResource

- deleteResource

- listResources

- listResourceActions

- createEntitlement

- getEntitlement

- deleteEntitlement

- addResourceToEntitlement

- revokeResourceFromEntitlement

- listEntitlements

- grantEntitlement

- revokeEntitlement

- listEntitlement

- listResourceTypes

- Oracle Access Management Access Managerコマンド

- updateCustomPages

- createUserIdentityStore

- editUserIdentityStore

- deleteUserIdentityStore

- displayUserIdentityStore

- createOAMServer

- editOAMServer

- deleteOAMServer

- displayOAMServer

- configurePersistentLogin

- configOAMLoginPagePref

- configRequestCacheType

- displayRequestCacheType

- editOssoAgent

- deleteOssoAgent

- displayOssoAgent

- editWebgateAgent

- deleteWebgateAgent

- displayWebgateAgent

- exportPolicy

- importPolicy

- importPolicyDelta

- migratePartnersToProd

- exportPartners

- importPartners

- displayTopology

- configureOAAMPartner

- registerOIFDAPPartner

- registerOIFDAPPartnerIDPMode

- registerThirdPartyTAPPartner

- disableCoexistMode

- enableOamAgentCoexist

- disableOamAgentCoexist

- editGITOValues

- editWebgate11gAgent

- deleteWebgate11gAgent

- displayWebgate11gAgent

- displayOAMMetrics

- updateOIMHostPort (非推奨)

- configureOIM (非推奨)

- updateOSSOResponseCookieConfig

- deleteOSSOResponseCookieConfig

- configureAndCreateIdentityStore

- configAndCreateIdStoreUsingPropFile

- migrateArtifacts (deprecated)

- displaySimpleModeGlobalPassphrase

- exportSelectedPartners

- oamMigrate

- preSchemeUpgrade

- postSchemeUpgrade

- oamSetWhiteListMode

- oamWhiteListURLConfig

- enableMultiDataCentreMode

- disableMultiDataCentreMode

- setMultiDataCentreClusterName

- setMultiDataCentreLogoutURLs

- updateMultiDataCentreLogoutURLs

- addPartnerForMultiDataCentre

- removePartnerForMultiDataCentre

- Oracle Access Management Identity Federationコマンド

- addOpenID20IdPFederationPartner

- addOpenID20SPFederationPartner

- addOpenID20GoogleIdPFederationPartner

- addOpenID20YahooIdPFederationPartner

- addSAML11IdPFederationPartner

- addSAML11SPFederationPartner

- addSAML20IdPFederationPartner

- addSAML20SPFederationPartner

- addSAML20IdPFederationPartnerWithoutMetadata

- addSAML20SPFederationPartnerWithoutMetadata

- configureIdPPartnerAttributeProfile

- configureSAML20Logout

- configureSAMLBinding

- configureUserSelfRegistration

- configureUserSelfRegistrationAttr

- createAuthnSchemeAndModule

- createIdPPartnerAttributeProfile

- createSPPartnerAttributeProfile

- deleteAuthnSchemeAndModule

- deleteFederationPartner

- deleteFederationPartnerEncryptionCert

- deleteFederationPartnerSigningCert

- deleteIdPPartnerAttributeProfile

- deleteSPPartnerAttributeProfile

- deleteIdPPartnerAttributeProfileEntry

- deleteSPPartnerAttributeProfileEntry

- deletePartnerProperty

- displayIdPPartnerAttributeProfile

- displaySPPartnerAttributeProfile

- getAllFederationIdentityProviders

- getAllFederationServiceProviders

- getFederationPartnerEncryptionCert

- getFederationPartnerSigningCert

- getIdPPartnerBasicAuthCredentialUsername

- getPartnerProperty

- getStringProperty

- isFederationPartnerPresent

- listIdPPartnerAttributeProfileIDs

- listSPPartnerAttributeProfileIDs

- putStringProperty

- setDefaultSSOIdPPartner

- setFederationPartnerEncryptionCert

- setFederationPartnerSigningCert

- setIdPPartnerAttributeProfile

- setIdPDefaultScheme

- setSPPartnerAttributeProfile

- setIdPPartnerAttributeProfileEntry

- setSPPartnerAttributeProfileEntry

- setIdPPartnerBasicAuthCredential

- setIdPPartnerMappingAttribute

- setIdPPartnerMappingAttributeQuery

- setIdPPartnerMappingNameID

- setPartnerAlias

- setPartnerIDStoreAndBaseDN

- setSPSAMLPartnerNameID

- updatePartnerMetadata

- updatePartnerProperty

- Oracle Access Management Advanced Identity Federationコマンド

- フェデレーション・サービスとデータストアの構成

- フェデレーション・アクセスの構成

- 属性共有の構成

- 認証メソッドのマッピング管理でのWLSTの使用

- パートナ・プロファイル管理でのWLSTの使用

- WLSTとSAML 1.1の使用

- Oracle Access Management Mobile and Socialコマンド

- getRPSystemConfig

- replaceRPSystemConfig

- getRPApplications

- removeRPApplication

- displayRPApplication

- createRPApplication

- updateRPApplication

- getServiceProviderInterfaces

- removeServiceProviderInterface

- displayServiceProviderInterface

- createServiceProviderInterface

- updateServiceProviderInterface

- getInternetIdentityProviders

- removeInternetIdentityProvider

- displayInternetIdentityProvider

- createInternetIdentityProvider

- updateInternetIdentityProvider

- getUserAttributeMappings

- removeUserAttributeMapping

- displayUserAttributeMapping

- updateUserAttributeMapping

- createServiceProvider

- updateServiceProvider

- addRelationshipToServiceProvider

- removeRelationshipFromServiceProvider

- getServiceProviders

- removeServiceProvider

- displayServiceProvider

- createServiceProfile

- updateServiceProfile

- removeServiceProfile

- displayServiceProfile

- getServiceProfiles

- getApplicationProfiles

- createApplicationProfile

- updateApplicationProfile

- removeApplicationProfile

- displayApplicationProfile

- createServiceDomain

- updateServiceDomain

- getServiceDomains

- removeServiceDomain

- displayServiceDomain

- createSecurityHandlerPlugin

- updateSecurityHandlerPlugin

- getSecurityHandlerPlugins

- removeSecurityHandlerPlugin

- displaySecurityHandlerPlugin

- createJailBreakingDetectionPolicy

- updateJailBreakingDetectionPolicy

- getJailBreakingDetectionPolicys

- removeJailBreakingDetectionPolicy

- displayJailBreakingDetectionPolicy

- removeOAuthIdentityDomain

- createOAuthIdentityDomain

- updateOAuthIdentityDomain

- updateOAuthSystemConfig

- removeOAuthSysComponent

- createOAuthSysComponent

- updateOAuthSysComponent

- removeOAuthServiceProvider

- createOAuthServiceProvider

- updateOAuthServiceProvider

- updateOAuthServiceProviderParam

- removeOAuthClient

- createOAuthClient

- updateOAuthClient

- updateOAuthClientParam

- removeOAuthServiceProfile

- createOAuthServiceProfile

- updateOAuthServiceProfile

- updateOAuthServiceProfileParam

- removeOAuthAdaptiveAccessPlugin

- createOAuthAdaptiveAccessPlugin

- updateOAuthAdaptiveAccessPlugin

- removeOAuthTokenAttributesPlugin

- createOAuthTokenAttributesPlugin

- updateOAuthTokenAttributesPlugin

- removeOAuthResourceServerInterface

- updateOAuthResourceServerInterface

- updateOAuthResourceServerInterfaceParam

- createOAuthResourceServerInterface

- updateOAuthJailBreakingDetectionPolicy

- removeOAuthUserProfileResourceServer

- updateOAuthUserProfileResourceServer

- createOAuthUserProfileResourceServer

- getOAuthIdentityDomains

- displayOAuthIdentityDomain

- displayOAuthSystemConfig

- getOAuthSysComponents

- displayOAuthSysComponent

- getOAuthServiceProviders

- displayOAuthServiceProvider

- getOAuthClients

- displayOAuthClient

- getOAuthAdaptiveAccessPlugins

- displayOAuthAdaptiveAccessPlugin

- getOAuthAuthzPlugin

- displayOAuthAuthzPlugin

- getOAuthTokenAttributesPlugins

- displayOAuthTokenAttributesPlugin

- getOAuthResourceServerInterfaces

- displayOAuthResourceServerInterface

- getOAuthUserProfileResourceServers

- displayOAuthUserProfileResourceServer

- getOAuthServiceProfiles

- displayOAuthServiceProfile

- Oracle Access Managementセキュリティ・トークン・サービス

- getPartner

- getAllRequesterPartners

- getAllRelyingPartyPartners

- getAllIssuingAuthorityPartners

- isPartnerPresent

- createPartner

- updatePartner

- deletePartner

- getPartnerUsernameTokenUsername

- getPartnerUsernameTokenPassword

- setPartnerUsernameTokenCredential

- deletePartnerUsernameTokenCredential

- getPartnerSigningCert

- getPartnerEncryptionCert

- setPartnerSigningCert

- setPartnerEncryptionCert

- deletePartnerSigningCert

- deletePartnerEncryptionCert

- getPartnerAllIdentityAttributes

- getPartnerIdentityAttribute

- setPartnerIdentityAttribute

- deletePartnerIdentityAttribute

- getAllWSPrefixAndPartnerMappings

- getWSPrefixAndPartnerMapping

- createWSPrefixAndPartnerMapping

- deleteWSPrefixAndPartnerMapping

- getAllPartnerProfiles

- getPartnerProfile

- createRequesterPartnerProfile

- createRelyingPartyPartnerProfile

- createIssuingAuthorityPartnerProfile

- deletePartnerProfile

- getAllIssuanceTemplates

- getIssuanceTemplate

- createIssuanceTemplate

- deleteIssuanceTemplate

- getAllValidationTemplates

- getValidationTemplate

- createWSSValidationTemplate

- createWSTrustValidationTemplate

- deleteValidationTemplate

- Oracleキーストア・サービス

- changeKeyPassword

- changeKeyStorePassword

- createKeyStore

- deleteKeyStore

- deleteKeyStoreEntry

- exportKeyStore

- exportKeyStoreCertificate

- exportKeyStoreCertificateRequest

- generateKeyPair

- generateSecretKey

- getKeyStoreCertificates

- getKeyStoreSecretKeyProperties

- importKeyStore

- importKeyStoreCertificate

- listExpiringCertificates

- listKeyStoreAliases

- listKeyStores

- アイデンティティ・ディレクトリ・サービス・コマンド

- activateIDSConfigChanges

- addAttributeInEntityConfig

- addAttributeRefForEntity

- addEntity

- addEntityRelation

- addIdentityDirectoryService

- addOperationConfig

- addPropertyForOperationConfig

- deleteAttributeInEntityConfig

- deleteEntity

- deleteEntityRelation

- deleteIdentityDirectoryService

- deleteOperationConfig

- listAllAttributeInEntityConfig

- listAllEntityInEntityConfig

- listAllIdentityDirectoryService

- removeAttributeRefForEntity

- removePropertyForOperationConfig

- Oracle Virtual Directoryライブラリ(LibOVD)コマンド

- activateLibOVDConfigChanges

- addAttributeExclusionRule

- addAttributeRule

- addDomainExclusionRule

- addDomainRule

- addJoinRule

- addLDAPHost

- addMappingContext

- addPlugin

- addPluginParam

- createJoinAdapter

- createLDAPAdapter

- deleteAdapter

- deleteAttributeExclusionRule

- deleteAttributeRule

- deleteDomainExclusionRule

- deleteDomainRule

- deleteMappingContext

- getAdapterDetails

- listAdapters

- listAllMappingContextIds

- listAttributeRules

- listDomainRules

- modifyLDAPAdapter

- removeJoinRule

- removeLDAPHost

- removePlugin

- removePluginParam

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

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

- manageUserMessagingPrefs

- deployUserMessagingDriver

6 DMSカスタムWLSTコマンド

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

- displayMetricTableNames

- displayMetricTables

- dumpMetrics

- reloadMetricRules

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

- addDMSEventDestination

- addDMSEventFilter

- addDMSEventRoute

- enableDMSEventTrace

- listDMSEventConfiguration

- listDMSEventDestination

- listDMSEventFilter

- listDMSEventRoutes

- removeDMSEventDestination

- removeDMSEventFilter

- removeDMSEventRoute

- updateDMSEventDestination

- updateDMSEventFilter

- updateDMSEventRoute

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

- ログの構成コマンド

- configureLogHandler

- getLogLevel

- listLoggers

- listLogHandlers

- setLogLevel

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

- displayLogs

- listLogs

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

- configureTracingLoggers

- listActiveTraces

- listTracingLoggers

- startTracing

- stopTracing

8 メタデータ・サービス(MDS)カスタムWLSTコマンド

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

- createMetadataPartition

- deleteMetadataPartition

- deregisterMetadataDBRepository

- registerMetadataDBRepository

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

- deleteMetadata

- exportMetadata

- importMetadata

- purgeMetadata

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

- exportSandboxMetadata

- importSandboxMetadata

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

- createMetadataLabel

- deleteMetadataLabel

- listMetadataLabels

- promoteMetadataLabel

- purgeMetadataLabels

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

- getMDSArchiveConfig

- importMAR

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

- deprovisionTenant

- listTenants

9 Oracle SOA SuiteカスタムWLSTコマンド

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

- デプロイメント・コマンド

- sca_deployComposite

- sca_undeployComposite

- SOAコンポジット・アプリケーション管理コマンド

- sca_startComposite

- sca_stopComposite

- sca_activateComposite

- sca_retireComposite

- sca_assignDefaultComposite

- sca_getDefaultCompositeRevision

- sca_listDeployedComposites

- 構成プラン管理コマンド

- sca_attachPlan

- sca_extractPlan

- sca_generatePlan

- sca_validatePlan

- タスク検証コマンド

- sca_validateTask

- SOAコンポジット・アプリケーション・コンパイルのコマンド

- sca_setProp

- sca_compile

- SOAコンポジット・アプリケーション・パッケージ化のコマンド

- sca_package

- SOAコンポジット・アプリケーション・テスト・コマンド

- sca_test

- SOAコンポジット・アプリケーションのHTTPクライアント・ベースのエクスポートおよびインポート・コマンド

- sca_exportComposite

- sca_exportUpdates

- sca_importUpdates

- sca_exportSharedData

- sca_removeSharedData

- SOAコンポジット・アプリケーションのMBeanベースのエクスポートおよびインポート・コマンド

- sca_exportCompositeMb

- sca_exportUpdatesMb

- sca_importUpdatesMb

- sca_exportSharedDataMb

- SOAコンポジット・アプリケーションのパーティション管理コマンド

- sca_createPartition

- sca_deletePartition

- sca_startCompositesInPartition

- sca_stopCompositesInPartition

- sca_activateCompositesInPartition

- sca_retireCompositesInPartition

- sca_listPartitions

- sca_listCompositesInPartition

10 WebCenter PortalカスタムWLSTコマンド

- WebCenter PortalのWLSTコマンド・カテゴリ

- 一般

- deleteConnection

- setWebCenterServiceFrameworkConfig

- getWebCenterServiceFrameworkConfig

- webcenterErrorOccurred

- getWebCenterConnectionTypes

- cloneWebCenterManagedServer

- 分析

- createAnalyticsCollectorConnection

- setAnalyticsCollectorConnection

- listAnalyticsCollectorConnections

- setDefaultAnalyticsCollectorConnection

- listDefaultAnalyticsCollectorConnection

- setAnalyticsCollectorConfig

- listAnalyticsCollectorConfig

- listAnalyticsEventTypes

- アクティビティ・グラフ

- exportAGMetadata

- importAGMetadata

- exportAGProviderConfiguration

- deleteAllAGMetadata

- deleteAGAction

- deleteAGNodeClass

- deleteAGSimilarityCalculation

- deleteAGRankCalculation

- deleteAGProviderAssignment

- deleteAGQRPPRegistration

- deleteAGProviderConfiguration

- renameAGAction

- renameAGNodeClass

- setAGProperty

- getAGProperty

- setAGPasswordCredential

- アクティビティ・ストリーム

- archiveASByDate

- archiveASByDeletedObjects

- archiveASByClosedSpaces

- archiveASByInactiveSpaces

- restoreASByDate

- truncateASArchive

- コンテンツ・リポジトリ

- createJCRContentServerConnection

- setJCRContentServerConnection

- listJCRContentServerConnections

- createJCRPortalConnection

- setJCRPortalConnection

- listJCRPortalConnections

- createJCRFileSystemConnection

- setJCRFileSystemConnection

- listJCRFileSystemConnections

- createJCRSharePointConnection

- setJCRSharePointConnection

- listJCRSharePointConnections

- listDocumentsSpacesProperties

- setDocumentsSpacesProperties

- deleteDocumentsSpacesProperties

- ディスカッションおよび通知

- createDiscussionForumConnection

- setDiscussionForumConnection

- setDiscussionForumConnectionProperty

- deleteDiscussionForumConnectionProperty

- listDiscussionForumConnections

- listDefaultDiscussionForumConnection

- setDefaultDiscussionForumConnection

- setDiscussionForumServiceProperty

- removeDiscussionForumServiceProperty

- listDiscussionForumServiceProperties

- setAnnouncementServiceProperty

- removeAnnouncementServiceProperty

- listAnnouncementServiceProperties

- addDiscussionsServerAdmin

- syncDiscussionServerPermissions

- setDiscussionsServerProperty

- getDiscussionsServerProperty

- removeDiscussionsServerProperty

- 外部アプリケーション

- createExtAppConnection

- setExtAppConnection

- listExtAppConnections

- addExtAppField

- setExtAppField

- removeExtAppField

- addExtAppCredential

- setExtAppCredential

- removeExtAppCredential

- インスタント・メッセージおよびプレゼンス

- createIMPConnection

- setIMPConnection

- setIMPConnectionProperty

- deleteIMPConnectionProperty

- listIMPAdapters

- listIMPConnections

- listDefaultIMPConnection

- setDefaultIMPConnection

- setIMPServiceProperty

- removeIMPServiceProperty

- listIMPServiceProperties

- createIMPExtAppConnection

- メール

- createMailConnection

- setMailConnection

- setMailConnectionProperty

- deleteMailConnectionProperty

- listMailConnections

- listDefaultMailConnection

- setDefaultMailConnection

- setMailServiceProperty

- removeMailServiceProperty

- listMailServiceProperties

- createMailExtApp

- 通知

- setNotificationsConfig

- getNotificationsConfig

- 個人イベント

- createPersonalEventConnection

- setPersonalEventConnection

- listPersonalEventConnections

- パーソナライズ

- createWCPSCMISConnection

- createWCPSActivityGraphConnection

- createWCPSPeopleConnection

- createWCPSCustomConnection

- listWCPSCMISConnection

- listWCPSActivityGraphConnection

- listWCPSPeopleConnection

- listWCPSCustomConnection

- deleteWCPSCMISConnection

- deleteWCPSActivityGraphConnection

- deleteWCPSPeopleConnection

- deleteWCPSCustomConnection

- setWCPSConnectionProperty

- ポートレット・プロデューサ

- registerWSRPProducer

- setWSRPProducer

- listWSRPProducers

- deregisterWSRPProducer

- listWSRPProducerRegistrationProperties

- listWSRPProducerUserCategories

- mapWSRPProducerUserCategory

- registerPDKJavaProducer

- setPDKJavaProducer

- deregisterPDKJavaProducer

- listPDKJavaProducers

- registerPageletProducer

- setPageletProducer

- listPageletProducers

- deregisterPageletProducer

- refreshProducer

- registerOOTBProducers

- deregisterOOTBProducers

- registerSampleProducers

- deregisterSampleProducers

- RSSニュース・フィード

- getRssProxyConfig

- setRssProxyConfig

- unsetRssProxyConfig

- 検索 - Oracle SES検索

- createSESConnection

- setSESConnection

- listSESConnections

- setSearchSESConfig

- listSearchSESConfig

- createFederationTrustedEntity

- 検索 - Oracle SES検索クローラ

- createSpacesCrawler

- createDocumentsCrawler

- createDiscussionsCrawler

- listSpacesCrawler

- listDocumentsCrawler

- listDiscussionsCrawler

- startSpacesCrawler

- startDocumentsCrawler

- startDiscussionsCrawler

- stopSpacesCrawler

- stopDocumentsCrawler

- stopDiscussionsCrawler

- deleteSpacesCrawler

- deleteDocumentsCrawler

- deleteDiscussionsCrawler

- 検索 - WebCenter Portal検索

- setSearchConfig

- listSearchConfig

- setSpacesCrawlProperties

- getSpacesCrawlProperties

- ワークリスト

- createBPELConnection

- setBPELConnection

- listBPELConnections

- addWorklistConnection

- removeWorklistConnection

- listWorklistConnections

- Spacesアプリケーション

- getSpacesWorkflowConnectionName

- setSpacesWorkflowConnectionName

- refreshGroupSpaceCache

- refreshSpaceTemplateCache

- WebCenter Portalアイデンティティ・ストア

- setWebCenterIdStoreSearchConfig

- listWebCenterIdStoreSearchConfig

- startSyncProfiles

- stopSyncProfiles

- isSyncProfilesRunning

- syncProfile

- setProfileCacheNumberOfObjects

- setProfileSyncLDAPReadBatchSize

- setProfileCacheTimeToLive

- printProfileConfig

- renameUsersInWebCenterApplication

- synchronizeUserInformation

- WebCenter Portalのインポートとエクスポート

- exportWebCenterApplication

- importWebCenterApplication

- exportGroupSpaces

- exportGroupSpaceTemplates

- importGroupSpaces

- exportWebCenterResource

- importWebCenterResource

- exportPortletClientMetadata

- importPortletClientMetadata

- importWebCenterTranslations

- setSpaceState

- showProducerImportFailures

- retryAllFailedProducerImports

- WebCenter Portalアップグレード

- upgradeWebCenterDomain

- upgradeWebCenterPermissions

- upgradeWebCenterApplication

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

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

- ADF固有のWLSTコマンド

- adf_createFileUrlConnection

- adf_createHttpUrlConnection

- adf_setURLConnectionAttributes

- adf_listUrlConnection

- getADFMArchiveConfig

12 ポータル・カスタムWLSTコマンド

- データベース・アクセス記述子コマンド

- listDads

- createPortalDad

- updatePortalDad

- deletePortalDad

- 構成コマンド

- configurePortalCache

- configurePortalPageEngine

- listPortalWebcacheConfigAttributes

- listPortalSiteConfigAttributes

- listPortalOIDConfigAttributes

- setPortalWebcacheConfig

- setPortalOIDConfig

- setPortalMidtierConfig

13 Java Required FilesカスタムWLSTコマンド

- Java Required Filesコマンド

- applyJRF

- cloneDeployments

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

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

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

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

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

- listWebServices

- listWebServicePorts

- listWebServiceConfiguration

- setWebServiceConfiguration

- listWebServiceClients

- listWebServiceClientPorts

- listWebServiceClientStubProperties

- setWebServiceClientStubProperty

- setWebServiceClientStubProperties

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

- listAvailableWebServicePolicies

- listWebServicePolicies

- attachWebServicePolicy

- attachWebServicePolicies

- enableWebServicePolicy

- enableWebServicePolicies

- detachWebServicePolicy

- detachWebServicePolicies

- listWebServiceClientPolicies

- attachWebServiceClientPolicy

- attachWebServiceClientPolicies

- enableWebServiceClientPolicy

- enableWebServiceClientPolicies

- detachWebServiceClientPolicy

- detachWebServiceClientPolicies

- setWebServicePolicyOverride

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

- beginRepositorySession

- commitRepositorySession

- describeRepositorySession

- abortRepositorySession

- createPolicySet

- listPolicySets

- clonePolicySet

- displayPolicySet

- modifyPolicySet

- setPolicySetPolicyOverride

- setPolicySetConstraint

- enablePolicySet

- enablePolicySetPolicy

- setPolicySetDescription

- validatePolicySet

- deletePolicySet

- deleteAllPolicySets

- attachPolicySet

- attachPolicySetPolicy

- detachPolicySetPolicy

- migrateAttachments

- Oracle WSMリポジトリ管理のコマンド

- upgradeWSMPolicyRepository

- resetWSMPolicyRepository

- exportRepository

- importRepository

- デプロイメント・ディスクリプタ移行のコマンド

- exportJRFWSApplicationPDD

- importJRFWSApplicationPDD

- savePddToAllAppInstancesInDomain

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

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

- createIncident

- getIncidentFile

- listADRHomes

- listIncidents

- listProblems

- showIncident

- 診断ダンプ・コマンド

- describeDump

- executeDump

- listDumps

16 Information Rights ManagementカスタムWLSTコマンド

- WLST IRMコマンドの概要

- 一般サーバー・コマンド

- addIRMRefreshPeriod

- getIRMRefreshPeriod

- getIRMRefreshPeriods

- removeIRMRefreshPeriod

- updateIRMRefreshPeriod

- addIRMSyncWindow

- getIRMSyncWindow

- getIRMSyncWindows

- removeIRMSyncWindow

- updateIRMSyncWindow

- getIRMCryptoSchema

- setIRMCryptoSchema

- getIRMDeviceCount

- setIRMDeviceCount

- getIRMJournalCleanUp

- setIRMJournalCleanUp

- getIRMLicenseStateCleanUp

- setIRMLicenseStateCleanUp

- getIRMPrivacyURL

- setIRMPrivacyURL

- getIRMKeyStore

- setIRMKeyStore

- 移行コマンド

- setIRMExportFolder

- getIRMExportFolder

- setIRMImportFolder

- getIRMImportFolder

- テスト・コンテンツ・コマンド

- addIRMTestContent

- getIRMTestContent

- getIRMTestContents

- removeIRMTestContent

- updateIRMTestContent

- 言語サポート・コマンド

- addIRMTranslation

- getIRMDefaultTranslation

- getIRMTranslations

- removeIRMTranslation

- setIRMTranslations

- Oracle IRM Desktopインストーラ・コマンド

- addIRMDownload

- getIRMDownload

- getIRMDownloads

- removeIRMDownload

- updateIRMDownload

17 Oracle WebCenter: ImagingカスタムWLSTコマンド

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

- 診断コマンド

- clearIPMWorkflowFaults

- listIPMWorkflowFaults

- repairIPMWorkflowFaults

- sumIPMWorkflowFaults

- resetIpmDMSMetrics

- Imagingの構成コマンド

- createIPMConnection

- getIPMConfig

- grantIPMCredAccess

- importIPMApplication

- importIPMInput

- importIPMSearch

- listIPMConfig

- listIPMExportFile

- refreshIPMSecurity

- setIPMConfig

- submitIPMToWorkflow

18 Oracle Business Process ManagementカスタムWLSTコマンド

- BPMLifecycleAdminコマンド・グループ

- create_public_share

- unlock_public_share

- export_public_share

- delete_public_share

- publish_template

- export_template

- delete_template

19 Oracle WebCenter ContentカスタムWLSTコマンド

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

- WLST WebCenter Contentのヘルプ

- ゲッター・メソッドとセッター・メソッドの実装

- サーバー構成コマンド

- getUCMHttpServerAddress

- setUCMHttpServerAddress

- getUCMServerPort

- setUCMServerPort

- getUCMIPAddressFilter

- setUCMIPAddressFilter

- getUCMUseSSL

- setUCMUseSSL

- 電子メール構成コマンド

- getUCMMailServer

- setUCMMailServer

- getUCMSmtpPort

- setUCMSmtpPort

- getUCMSysAdminAddress

- setUCMSysAdminAddress

- 追加のコマンド

- getUCMCSVersion

- getUCMServerUptime

20 エンタープライズ・スケジューラ・カスタムWLSTコマンド

- エンタープライズ・スケジューラ・カスタム・コマンド

- essGetRequestContent

- essManageRequest

- essManageRuntimeConfig

- essManageServer

- essQueryRequests

はじめに

ここでは、このガイド『WebLogic Scripting Toolコマンド・リファレンス』で使用されている、ドキュメントのアクセシビリティ機能と表記規則について説明します。

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

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

Oracleサポートへのアクセス

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を参照してください。

表記規則

このドキュメントでは次の表記規則を使用します。

規則

意味

太字

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

斜体

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

固定幅フォント

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

1 概要とロードマップ

この節では、このガイド『WebLogic Scripting Toolコマンド・リファレンス』の内容と構成について説明します。

- ドキュメントの内容と対象読者

- このドキュメントの手引き

- 関連ドキュメント

- このリリースでのWLSTの新機能と変更点

ドキュメントの内容と対象読者

このドキュメントでは、WebLogic Scripting Tool (WLST)で利用できるすべてのコマンドについて説明します。このドキュメントでは、インストールされたOracle Fusion Middlewareコンポーネントの管理に使用できるWebLogic ServerでのWLSTコマンドおよびカスタムWLSTコマンドについて説明します。

注意:

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

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

このドキュメントの手引き

このドキュメントの構成は次のとおりです:

- この章「概要とロードマップ」では、このガイドの構成および関連ドキュメントについて説明します。

- 第2章「WebLogic Server WLSTオンラインおよびオフライン・コマンド・リファレンス」では、WebLogic Server WLSTコマンドをアルファベット順に、またオンラインで使用するものとオフラインで使用するものに分けて示します。

- 第3章「WLSTコマンドおよび変数リファレンス」では、WLSTのコマンドおよび変数の各々について詳細に説明します。

- 第4章「インフラストラクチャ・セキュリティ・カスタムWLSTコマンド」では、Oracle Fusion Middlewareインフラストラクチャ・セキュリティ・コンポーネントを管理する各カスタムWLSTコマンドについて詳細に説明します。

- 第5章「User Messaging Service (UMS)カスタムWLSTコマンド」では、Oracle Fusion Middleware User Messaging Service (UMS)コンポーネントを管理するカスタムWLSTコマンドについて詳細に説明します。

- 第6章「DMSカスタムWLSTコマンド」では、Oracle Fusion Middleware Dynamic Monitoring Service (DMS)コンポーネントを管理するカスタムWLSTコマンドについて詳細に説明します。

- 第7章「ロギング・カスタムWLSTコマンド」では、Oracle Fusion Middlewareロギング・コンポーネントを管理するカスタムWLSTコマンドについて詳細に説明します。

- 第8章「メタデータ・サービス(MDS)カスタムWLSTコマンド」では、Oracle Fusion Middleware メタデータ・サービス(MDS)コンポーネントを管理するカスタムWLSTコマンドについて詳細に説明します。

- 第9章「Oracle SOA SuiteカスタムWLSTコマンド」では、Oracle Fusion Middleware SOAコンポーネントを管理するカスタムWLSTコマンドについて詳細に説明します。

- 第10章「WebCenter PortalカスタムWLSTコマンド」では、Oracle Fusion Middleware WebCenterコンポーネントを管理する各カスタムWLSTコマンドについて詳細に説明します。

- 第11章「Application Development Framework (ADF)カスタムWLSTコマンド」では、Oracle Fusion Middleware ADFコンポーネントを管理するカスタムWLSTコマンドについて詳細に説明します。

- 第12章「ポータル・カスタムWLSTコマンド」では、Oracle Fusion Middlewareポータル・コンポーネントを管理するカスタムWLSTコマンドについて詳細に説明します。

- 第13章「Java Required FilesカスタムWLSTコマンド」では、Oracle Fusion Middleware JRFコンポーネントを管理するカスタムWLSTコマンドについて詳細に説明します。

- 第14章「Web ServicesカスタムWLSTコマンド」では、Oracle Fusion Middleware Web Servicesコンポーネントを管理するカスタムWLSTコマンドについて詳細に説明します。

- 第15章「Diagnostic FrameworkカスタムWLSTコマンド」では、Oracle Fusion Middleware Diagnostic Frameworkコンポーネントを管理するカスタムWLSTコマンドについて詳細に説明します。

- 第16章「Information Rights ManagementカスタムWLSTコマンド」では、Oracle Fusion Middleware Information Rights Managementコンポーネントを管理するカスタムWLSTコマンドについて詳細に説明します。

- 第17章「Oracle WebCenter: ImagingカスタムWLSTコマンド」では、Oracle Imaging and Process Managementコンポーネントを管理するカスタムWLSTコマンドについて詳細に説明します。

- 第18章「Oracle Business Process ManagementカスタムWLSTコマンド」では、Oracle Business Process ManagementのカスタムWLSTコマンドについて詳細に説明します。

- 第19章「Oracle WebCenter ContentカスタムWLSTコマンド」では、Oracle WebCenter ContentのカスタムWLSTコマンドについて詳細に説明します。

- 第20章「Enterprise SchedulerカスタムWLSTコマンド」では、Oracle Enterprise Scheduling Service (ESS)のカスタムWLSTコマンドについて詳細に説明します。

関連ドキュメント

WebLogic Scripting Toolの使い方については、『Oracle WebLogic Scripting Tool』を参照してください。

WLSTは、WebLogic Serverを管理およびモニターするためのインタフェースの1つです。他の管理インタフェースについては、次の場所を参照してください。

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

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

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

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

- 『PackおよびUnpackコマンドによるテンプレートとドメインの作成』: 既存のWebLogicドメインをすばやく簡単に再作成するコマンドについて説明します。

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

- 『Oracle WebLogic Server SNMP管理ガイド』: Simple Network Management Protocol (SNMP)を使用してWebLogicドメインを監視する方法について説明します。

- Oracle Fusion Middleware管理者ガイド: Oracle Fusion Middlewareを起動および停止する方法、コンポーネントを構成および再構成する方法、バックアップおよびリカバリを行う方法など、Oracle Fusion Middlewareを管理する方法について説明します。

このリリースでのWLSTの新機能と変更点

WebLogic Serverのこのリリースに追加された新機能の一覧については、『Oracle WebLogic Serverの新機能』を参照してください。

2 WebLogic Server WLSTオンラインおよびオフライン・コマンド・リファレンス

次の項では、WebLogic Server WLSTコマンドについて簡単に説明しています。

- WebLogic Server WLSTコマンドのサマリー(コマンドのアルファベット順)

- WebLogic Server WLSTオンライン・コマンドのサマリー

- WebLogic Server WLSTオフライン・コマンドのサマリー

注意:

それぞれ次のコマンドを使用して、すべてのオンラインおよびオフライン・コマンドのサマリーをコマンド行からリスト表示できます。

help("online")
help("offline")

Fusion Middleware (FMW)コンポーネントのカスタムWLSTコマンドについては、このドキュメントの適切な章を参照してください。FMWカスタム・コマンドを実行する方法については、Oracle Fusion Middleware管理ガイドのカスタムWLSTコマンドの使用に関する項を参照してください。

WebLogic Server WLSTコマンドのサマリー(コマンドのアルファベット順)

次の表では、WebLogic Server WLSTの各コマンドについて、コマンドのアルファベット順で簡単に説明します。この表には、FMWコンポーネントのカスタムWLSTコマンドは含まれません。指定されたFMWコンポーネントのカスタム・コマンドのリストについては、このドキュメントの適切な章を参照してください。

表2-1 WebLogic Server WLSTコマンドのサマリー

コマンド

説明

WLSTでの使用

activate

現在の編集セッション中に保存されてまだデプロイされていない変更をアクティブ化します。

オンライン

addHelpCommand

コマンドのために新しいコマンド・ヘルプを既存のコマンド・グループに追加します。グループに追加した後、help('commandGroup')コマンドを入力した場合、グループのためにコマンド(簡単な説明を持つ)はコマンド・リストに表示されます。

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

addHelpCommandGroup

WLST help()コマンドで表示されているコマンド・グループに新しいヘルプ・コマンド・グループを追加します。

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

addListener

指定されたMBeanにJMXリスナーを追加します。

オンライン

addTemplate

アプリケーションまたはサービスの拡張テンプレートを使用して、現在のWebLogicドメインを拡張します。

オフライン

assign

リソースを1つまたは複数の宛先に割り当てます。

オフライン

cancelEdit

編集セッションを取り消して、編集ロックを解放し、未保存の変更をすべて破棄します。この操作は、その編集セッションを開始したユーザーでなくても、管理者権限を持つユーザーであれば誰でも呼び出すことができます。

オンライン

cd

構成Beanまたは実行時Beanの階層を移動します。

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

closeDomain

現在のWebLogicドメインを閉じます。

オフライン

closeTemplate

現在のドメイン・テンプレートを閉じます。

オフライン

configToScript

既存のサーバー構成(configディレクトリ)を実行可能なWLSTスクリプトに変換します。

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

connect

WLSTをWebLogic Serverインスタンスに接続します。

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

create

現在のBeanに対して、指定されたタイプの構成Beanを作成します。

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

currentTree

階層内の現在の場所を返します。

オンライン

custom

実行時MBeanサーバーに登録されているカスタムMBeansのルートに移動します。

オンライン

delete

現在の構成Beanに対する、指定されたタイプの構成Beanのインスタンスを削除します。

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

deploy

WebLogic Serverインスタンスにアプリケーションをデプロイします。

オンライン

disconnect

WLSTをWebLogic Serverインスタンスから接続解除します。

オンライン

distributeApplication

指定されたターゲットにデプロイメント・バンドルをコピーします。

オンライン

domainConfig

ドメインの構成階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

オンライン

domainCustom

ドメイン実行時MBeanサーバーに登録されているカスタムMBeansのツリーに移動します。

オンライン

domainRuntime

ドメインの実行時階層内で最後に移動したMBean、または階層のルートであるDomainRuntimeMBeanに移動します。

オンライン

dumpStack

WLSTアクションの実行中に発生した最近の例外のスタック・トレースを表示して、スタック・トレースをリセットします。

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

dumpVariables

WLSTによって使用されたすべての変数を、その名前と値を含めて表示します。

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

edit

構成編集MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

オンライン

encrypt

指定された文字列を暗号化します。

オンライン

exit

WLSTをユーザー・セッションから終了させて、スクリプト・シェルを閉じます。

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

exportDiagnosticData

指定されたログ・ファイルに対する問合せを実行します。

オフライン

exportDiagnosticDataFromServer

サーバー側で問合せを実行して、エクスポートされたWebLogic診断フレームワーク(WLDF)データを取得します。

オンライン

find

現在の階層内でMBeanと属性を検索します。

オンライン

get

指定された属性の値を返します。

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

getActivationTask

ユーザーがステータスを取得できる最新のActivationTask MBeanを返します。

オンライン

getAvailableCapturedImages

以前に捕捉した診断イメージのリストを返します。

オンライン

getConfigManager

変更プロセスを管理している最新のConfigurationManagerBean MBeanを返します。

オンライン

getMBean

指定されたパスを参照してMBeanを返します。

オンライン

getMBI

指定されたMBeanTypeまたはcmo変数のMBeanInfoを返します。

オンライン

getPath

指定されたMBeanインスタンスのMBeanパスを返します。

オンライン

getWLDM

WebLogic DeploymentManagerオブジェクトを返します。

オンライン

invoke

現在の構成Beanの管理操作を呼び出します。

オンライン

isRestartRequired

サーバーの再起動が必要かどうかを判断します。

オンライン

jndi

WLSTが現在接続しているサーバーのJNDIツリーに移動します。

オンライン

listApplications

ドメイン内に現在デプロイされているすべてのアプリケーションをリストします。

オンライン

listChildTypes

cmoで作成または削除できるすべての子MBeanを表示します。

オンライン

loadApplication

アプリケーションとデプロイメント・プランをメモリーにロードします。

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

loadDB

SQLファイルをデータベースにロードします。

オフライン

loadProperties

プロパティ値をファイルからロードします。

オンラインおよびオフライン

lookup

指定されたMBeanをルックアップします。

オンライン

ls

現在の構成Beanまたは実行時Beanのすべての子Beanと属性を表示します。

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

man

現在のMBeanまたはそのMBeanの指定された属性に関する、MBeanInfoのヘルプを表示します。

オンライン

migrate

クラスタ内のターゲット・サーバーにサービスを移行します。

オンライン

nm

WLSTがノード・マネージャに接続しているかどうかを判断します。

オンライン

nmConnect

WLSTをノード・マネージャに接続してセッションを確立します。

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

nmDisconnect

WLSTをノード・マネージャ・セッションから接続解除します。

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

nmEnroll

WLSTが現在動作しているマシンを登録します。

オンライン

nmGenBootStartupProps

指定されたサーバーのためのノード・マネージャ・プロパティ・ファイルboot.propertiesおよびstartup.propertiesを生成します。

オンライン

nmKill

ノード・マネージャで起動された、指定されたサーバー・インスタンスを強制停止します。

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

nmLog

ノード・マネージャ・ログを返します。

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

nmServerLog

ノード・マネージャで起動されたサーバーのサーバー出力ログを返します。

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

nmServerStatus

ノード・マネージャで起動されたサーバーのステータスを返します。

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

nmStart

ノード・マネージャを使用して、現在のドメイン内のサーバーを起動します。

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

nmVersion

ノード・マネージャのサーバーのバージョンを返します。

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

prompt

プロンプトでパス情報の表示を切り替えます。

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

pwd

構成Beanまたは実行時Bean階層内の現在の場所を表示します。

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

readDomain

更新する既存のWebLogicドメインを開きます。

オフライン

readTemplate

WebLogicドメインを作成するために既存のドメイン・テンプレートを開きます。

オフライン

redeploy

クラスを再ロードして、以前にデプロイされたアプリケーションを再デプロイします。

オンライン

redirect

WLST出力を指定されたファイル名にリダイレクトします。

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

removeListener

以前に定義したリスナーを削除します。

オンライン

resume

一時停止された、またはADMIN状態にあるサーバー・インスタンスを再開します。

オンライン

save

編集されてまだ保存されていない編集内容を保存します。

オンライン

saveDiagnosticImageCaptureFile

指定された診断イメージ・キャプチャをダウンロードします。

オンライン

saveDiagnosticImageCaptureEntryFile

診断イメージ・キャプチャから特定のエントリをダウンロードします。

オンライン

serverRuntime

実行時MBean階層内で最後に移動したMBean、または階層のルートであるServerRuntimeMBeanに移動します。

オンライン

set

現在の構成Beanの指定された属性値を設定します。

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

setOption

WebLogicドメインの作成または更新に関連するオプションを設定します

オフライン

showChanges

現在の編集セッション中に現在のユーザーが行った変更内容を表示します。

オンライン

showListeners

現在定義されているすべてのリスナーを表示します。

オンライン

shutdown

実行中のサーバー・インスタンスまたはクラスタを正常に停止します。

オンライン

start

ノード・マネージャを使用して管理対象サーバー・インスタンスまたはクラスタを起動します。

オンライン

startApplication

アプリケーションを起動して、ユーザーが利用できるようにします。

オンライン

startEdit

現在接続しているユーザーのために構成編集セッションを開始します。

オンライン

startNodeManager

ノード・マネージャをデフォルト・ポート(5556)で起動します。

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

startRecording

WLSTとユーザーのすべての対話を記録します。再試行するコマンドの捕捉に便利。

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

startServer

管理サーバーを起動します。

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

state

ノード・マネージャを使用して、サーバーまたはクラスタとその状態のマップを返します。

オンライン

stopApplication

アプリケーションを停止して、ユーザーが利用できないようにします。

オンライン

stopEdit

編集セッションを停止して、編集ロックを解放し、未保存の変更を破棄します。

オンライン

stopNodeManager

ノード・マネージャを停止します。

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

stopRecording

WLSTコマンドの記録を停止します。

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

stopRedirect

WLST出力のファイルへのリダイレクトを停止します。

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

storeUserConfig

ユーザー構成ファイルと、関連付けられたキー・ファイルを作成します。

オンライン

suspend

実行中のサーバーを一時停止します。

オンライン

threadDump

指定されたサーバーのスレッド・ダンプを表示します。

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

undeploy

指定されたサーバーからアプリケーションをアンデプロイします。

オンライン

updateApplication

新しいデプロイメント・プランを使用してアプリケーションの構成を更新します。

オンライン

updateDomain

現在のドメインを更新して保存します。

オフライン

unassign

1つまたは複数の宛先からアプリケーションまたはサービスの割当てを解除します。

オフライン

undo

保存またはアクティブ化されていない編集をすべて元に戻します。

オンライン

validate

変更されてまだ保存されていない変更内容を検証します。

オンライン

viewMBean

属性名と属性値、操作など、MBeanに関する情報を表示します。

オンライン

writeDomain

指定されたディレクトリにドメインの構成情報を書き込みます。

オフライン

writeIniFile

WLST定義およびメソッド宣言をPython (.py)ファイルに変換します。

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

writeTemplate

指定されたドメイン・テンプレート・ファイルにドメイン構成情報を書き込みます。

オフライン

WebLogic Server WLSTオンライン・コマンドのサマリー

次の表では、WebLogic Server WLSTオンライン・コマンドについて、コマンドのアルファベット順で簡単に説明します。この表には、FMWコンポーネントのカスタムWLSTコマンドは含まれません。指定されたFMWコンポーネントのカスタム・コマンドのリストについては、このドキュメントの適切な章を参照してください。

表2-2 WebLogic Server WLSTオンライン・コマンドのサマリー

コマンド

説明

activate

現在の編集セッション中に保存されてまだデプロイされていない変更をアクティブ化します。

addHelpCommand

コマンドのために新しいコマンド・ヘルプを既存のコマンド・グループに追加します。グループに追加した後、help('commandGroup')コマンドを入力した場合、グループのためにコマンド(簡単な説明を持つ)はコマンド・リストに表示されます。

addHelpCommandGroup

WLST help()コマンドで表示されているグループに新しいヘルプ・コマンド・グループを追加して、グループに対して定義されているヘルプ情報のリソース・バンドルを指定します。

addListener

指定されたMBeanにJMXリスナーを追加します。

cancelEdit

編集セッションを取り消して、編集ロックを解放し、未保存の変更をすべて破棄します。この操作は、その編集セッションを開始したユーザーでなくても、管理者権限を持つユーザーであれば誰でも呼び出すことができます。

cd

構成Beanまたは実行時Beanの階層を移動します。

configToScript

既存のサーバー構成(configディレクトリ)を実行可能なWLSTスクリプトに変換します。

connect

WLSTをWebLogic Serverインスタンスに接続します。

create

現在のBeanに対して、指定されたタイプの構成Beanを作成します。

currentTree

現在のツリーの場所を返します。

custom

実行時MBeanサーバーに登録されているカスタムMBeansのルートに移動します。

delete

現在の構成Beanに対する、指定されたタイプの構成Beanのインスタンスを削除します。

deploy

WebLogic Serverインスタンスにアプリケーションをデプロイします。

disconnect

WLSTをWebLogic Serverインスタンスから接続解除します。

distributeApplication

指定されたターゲットにデプロイメント・バンドルをコピーします。

domainConfig

ドメインの構成階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

domainCustom

ドメイン実行時MBeanサーバーに登録されているカスタムMBeansのツリーに移動します。

domainRuntime

ドメインの実行時階層内で最後に移動したMBean、または階層のルートであるDomainRuntimeMBeanに移動します。

dumpStack

最後に発生した実行のスタック・トレースを表示して、トレースをリセットします。

dumpVariables

WLSTによって使用されたすべての変数を、その名前と値を含めて表示します。

edit

構成編集MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

encrypt

指定された文字列を暗号化します。

exit

WLSTを対話セッションから終了させて、スクリプト・シェルを閉じます。

exportDiagnosticDataFromServer

サーバー側で問合せを実行して、エクスポートされたWebLogic診断フレームワーク(WLDF)データを取得します。

find

現在の階層内でMBeanと属性を検索します。

get

指定された属性の値を返します。

getActivationTask

ユーザーがステータスを取得できる最新のActivationTask MBeanを返します。

getAvailableCapturedImages

以前に捕捉した診断イメージのリストを返します。

getConfigManager

変更プロセスを管理している最新のConfigurationManagerBean MBeanを返します。

getMBean

指定されたパスを参照してMBeanを返します。

getMBI

指定されたMBeanTypeまたはcmo変数のMBeanInfoを返します。

getPath

指定されたMBeanインスタンスのMBeanパスを返します。

getWLDM

WebLogic DeploymentManagerオブジェクトを返します。

invoke

現在の構成Beanの管理操作を呼び出します。

isRestartRequired

サーバーの再起動が必要かどうかを判断します。

jndi

WLSTが現在接続しているサーバーのJNDIツリーに移動します。

listApplications

ドメイン内に現在デプロイされているすべてのアプリケーションをリストします。

listChildTypes

cmoで作成または削除できるすべての子MBeanを表示します。

loadApplication

アプリケーションとデプロイメント・プランをメモリーにロードします。

loadProperties

プロパティ値をファイルからロードします。

lookup

指定されたMBeanをルックアップします。

ls

現在の構成Beanまたは実行時Beanのすべての子Beanと属性を表示します。

man

現在のMBeanまたはそのMBeanの指定された属性に関する、MBeanInfoのヘルプを表示します。

migrate

クラスタ内のターゲット・サーバーにサービスを移行します。

nm

WLSTがノード・マネージャに接続しているかどうかを判断します。

nmConnect

WLSTをノード・マネージャに接続してセッションを確立します。

nmDisconnect

WLSTをノード・マネージャ・セッションから接続解除します。

nmEnroll

WLSTが現在動作しているマシンを登録します。

nmGenBootStartupProps

指定されたサーバーのためのノード・マネージャ・プロパティ・ファイルboot.propertiesおよびstartup.propertiesを生成します。

nmKill

ノード・マネージャで起動された、指定されたサーバー・インスタンスを強制停止します。

nmLog

ノード・マネージャ・ログを返します。

nmServerLog

ノード・マネージャで起動されたサーバーのサーバー出力ログを返します。

nmServerStatus

ノード・マネージャで起動されたサーバーのステータスを返します。

nmStart

ノード・マネージャを使用して、現在のドメイン内のサーバーを起動します。

nmVersion

ノード・マネージャのサーバーのバージョンを返します。

prompt

プロンプトでパス情報の表示を切り替えます。

pwd

構成Beanまたは実行時Bean階層内の現在の場所を表示します。

redeploy

クラスを再ロードして、以前にデプロイされたアプリケーションを再デプロイします。

redirect

WLST出力を指定されたファイル名にリダイレクトします。

removeListener

以前に定義したリスナーを削除します。

resume

一時停止された、またはADMIN状態にあるサーバー・インスタンスを再開します。

save

編集されてまだ保存されていない編集内容を保存します。

saveDiagnosticImageCaptureFile

指定された診断イメージ・キャプチャをダウンロードします。

saveDiagnosticImageCaptureEntryFile

診断イメージ・キャプチャから特定のエントリをダウンロードします。

serverConfig

構成MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

serverRuntime

実行時MBean階層内で最後に移動したMBean、または階層のルートであるServerRuntimeMBeanに移動します。

set

現在の構成Beanの指定された属性値を設定します。

showChanges

現在の編集セッション中に現在のユーザーが行った変更内容を表示します。

showListeners

現在定義されているすべてのリスナーを表示します。

shutdown

実行中のサーバー・インスタンスまたはクラスタを正常に停止します。

start

ノード・マネージャを使用して管理対象サーバー・インスタンスまたはクラスタを起動します。

startApplication

アプリケーションを起動して、ユーザーが利用できるようにします。

startEdit

現在接続しているユーザーのために構成編集セッションを開始します。

startNodeManager

ノード・マネージャをデフォルト・ポート(5556)で起動します。

startRecording

WLSTとユーザーのすべての対話を記録します。再試行するコマンドの捕捉に便利。

startServer

管理サーバーを起動します。

state

ノード・マネージャを使用して、サーバーまたはクラスタとその状態のマップを返します

stopApplication

アプリケーションを停止して、ユーザーが利用できないようにします。

stopEdit

編集セッションを停止して、編集ロックを解放し、未保存の変更を破棄します。

stopNodeManager

ノード・マネージャを停止します。

stopRedirect

WLST出力のファイルへのリダイレクトを停止します。

storeUserConfig

ユーザー構成ファイルと、関連付けられたキー・ファイルを作成します。

suspend

実行中のサーバーを一時停止します。

threadDump

指定されたサーバーのスレッド・ダンプを表示します。

undeploy

指定されたサーバーからアプリケーションをアンデプロイします。

undo

保存またはアクティブ化されていない編集をすべて元に戻します。

updateApplication

新しいデプロイメント・プランを使用してアプリケーションの構成を更新します。

validate

変更されてまだ保存されていない変更内容を検証します。

viewMBean

属性名と属性値、操作など、MBeanに関する情報を表示します。

writeIniFile

WLST定義およびメソッド宣言をPython (.py)ファイルに変換します。

WebLogic Server WLSTオフライン・コマンドのサマリー

次の表では、WebLogic Server WLSTオンライン・コマンドについて、コマンドのアルファベット順で簡単に説明します。

表2-3 Weblogic Server WLSTオフライン・コマンドのサマリー

コマンド

説明

addHelpCommand

コマンドのために新しいコマンド・ヘルプを既存のコマンド・グループに追加します。グループに追加した後、help('commandGroup')コマンドを入力した場合、グループのためにコマンド(簡単な説明を持つ)はコマンド・リストに表示されます。

addHelpCommandGroup

WLST help()コマンドで表示されているグループに新しいヘルプ・コマンド・グループを追加して、グループに対して定義されているヘルプ情報のリソース・バンドルを指定します。

addTemplate

アプリケーションまたはサービスの拡張テンプレートを使用して、現在のドメインを拡張します。

assign

リソースを1つまたは複数の宛先に割り当てます。

cd

構成Beanまたは実行時Beanの階層を移動します。

closeDomain

現在のドメインを閉じます。

closeTemplate

現在のドメイン・テンプレートを閉じます。

configToScript

既存のサーバー構成(configディレクトリ)を実行可能なWLSTスクリプトに変換します。

connect

WLSTをWebLogic Serverインスタンスに接続します。

create

現在のBeanに対して、指定されたタイプの構成Beanを作成します。

delete

現在の構成Beanに対する、指定されたタイプの構成Beanのインスタンスを削除します。

dumpStack

WLSTアクションの実行中に発生した最近の例外のスタック・トレースを表示して、スタック・トレースをリセットします。

dumpVariables

WLSTによって使用されたすべての変数を、その名前と値を含めて表示します。

exit

WLSTを対話セッションから終了させて、スクリプト・シェルを閉じます。

exportDiagnosticData

指定されたログ・ファイルに対する問合せを実行します。

get

指定された属性の値を返します。

loadApplication

アプリケーションとデプロイメント・プランをメモリーにロードします。

loadDB

SQLファイルをデータベースにロードします。

loadProperties

プロパティ値をファイルからロードします。

ls

現在の構成Beanまたは実行時Beanのすべての子Beanと属性を表示します。

nmConnect

WLSTをノード・マネージャに接続してセッションを確立します。

prompt

プロンプトでパス情報の表示を切り替えます。

pwd

構成Beanまたは実行時Bean階層内の現在の場所を表示します。

readDomain

更新する既存のWebLogicドメインを開きます。

readTemplate

ドメインを作成するために既存のドメイン・テンプレートを開きます。

redirect

WLST出力を指定されたファイル名にリダイレクトします。

set

現在の構成Beanの指定された属性値を設定します。

setOption

WebLogicドメインの作成または更新に関連するオプションを設定します。

startNodeManager

ノード・マネージャをデフォルト・ポート(5556)で起動します。

startRecording

WLSTとユーザーのすべての対話を記録します。再試行するコマンドの捕捉に便利。

startServer

管理サーバーを起動します。

stopNodeManager

ノード・マネージャを停止します。

stopRedirect

WLST出力のファイルへのリダイレクトを停止します。

threadDump

指定されたサーバーのスレッド・ダンプを表示します。

unassign

1つまたは複数の宛先からアプリケーションまたはサービスの割当てを解除します。

updateDomain

現在のドメインを更新して保存します。

writeDomain

指定されたディレクトリにドメインの構成情報を書き込みます。

writeIniFile

WLST定義およびメソッド宣言をPython (.py)ファイルに変換します。

writeTemplate

指定されたドメイン・テンプレート・ファイルにドメイン構成情報を書き込みます。

3 WLSTコマンドおよび変数リファレンス

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

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

- 参照コマンド

- 制御コマンド

- カスタマイズ・コマンド

- デプロイメント・コマンド

- 診断コマンド

- 編集コマンド

- 情報コマンド

- ライフサイクル・コマンド

- ノード・マネージャ・コマンド

- ツリー・コマンド

- WLST変数リファレンス

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

注意:

コマンドの構文の要件について、『Oracle WebLogic Scripting Tool』のWLSTコマンドの構文に関する項を参照しておくことをお薦めします。

WLSTコマンドは次のカテゴリに分かれています。

表3-1 WLSTコマンド・カテゴリ

コマンド・カテゴリ

説明

参照コマンド

構成Beanまたは実行時Beanの階層を移動します。プロンプトの表示を制御します。

制御コマンド

- サーバーに接続したり、サーバーへの接続を切断したりします。

- WebLogicドメインまたはドメイン・テンプレートを作成および構成します。

- WLSTを終了します。

カスタマイズ・コマンド

WLST help()およびhelp('commandGroup')コマンドによって表示されるコマンド・グループ・ヘルプおよびコマンド・ヘルプを追加します。

デプロイメント・コマンド

- アプリケーションとスタンドアロン・モジュールをWebLogic Serverインスタンスにデプロイ、アンデプロイ、および再デプロイします。

- 既存のデプロイメント・プランを更新します。

- WebLogicデプロイメント・マネージャ・オブジェクトに照会します。

- デプロイされたアプリケーションを起動および停止します。

診断コマンド

診断データをエクスポートします。

編集コマンド

構成Beanの照会や編集を行います。

情報コマンド

WebLogicドメイン、サーバー、変数に照会します。構成Bean、実行時Bean、WLSTに関連した情報を提供します。

ライフサイクル・コマンド

サーバー・インスタンスのライフサイクルを管理します。

ノード・マネージャ・コマンド

ノード・マネージャを使用して、WebLogic Serverインスタンスを起動、停止、再起動、およびモニターします。

ツリー・コマンド

MBean階層内を移動します。

参照コマンド

表3-2に示すWLST参照コマンドを使用して、構成Beanまたは実行時Beanの階層を移動したり、プロンプトの表示を制御したりします。

表3-2 WLST構成の参照コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

cd

構成Beanまたは実行時Beanの階層を移動します。

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

currentTree

階層内の現在の場所を返します。

オンライン

prompt

プロンプトでパス情報の表示を切り替えます。

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

pwd

階層内の現在の場所を表示します。

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

cd

コマンド・カテゴリ: 参照コマンド

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

説明

構成Beanまたは実行時Beanの階層を移動します。このコマンドでは、WindowsまたはUNIXコマンド・シェルのファイル・システムを移動するときと同様のモデルを使用しています。たとえば、親の構成Beanまたは実行時Beanに戻るには、cd('..')と入力します。文字列.. (ドット、ドット)は、カレント・ディレクトリのすぐ上のディレクトリを表します。階層の深くにあるBeanに移動した後でルートのBeanに戻るには、cd('/')と入力します。

現在の階層内のBeanに移動できます。子やインスタンスに移動することができます。

cdコマンドは、構成Beanまたは実行時Beanのインスタンスがある場合は、そのスタブを返します。特定のタイプに移動する場合は、移動元になる構成Beanまたは実行時Beanインスタンスのスタブを返します。エラーが発生した場合は、WLSTExceptionが返されます。

注意:

cmo変数は、WLSTをサーバー・インスタンスに最初に接続するときに、すべてのドメイン構成Beanのルートに初期化されます。あるインスタンスに移動するまでは、この値が親構成Beanタイプとなります。cmo変数の詳細は、『Oracle WebLogic Scripting Tool』の現在の管理オブジェクトの変更に関する項を参照してください。

構文

cd(mbeanName)

引数

定義

mbeanName

ネーム・スペース内のBeanのパス。

例

次の例では、構成Beanの階層を移動します。最初のコマンドではServers構成Beanタイプに、2番目のコマンドではmyserver構成Beanインスタンスに移動します。最後のコマンドで、2レベル上の元のディレクトリ位置に戻ります。

wls:/mydomain/serverConfig> cd('Servers')
wls:/mydomain/serverConfig/Servers> cd('myserver')
wls:/mydomain/serverConfig/Servers/myserver> cd('../..')
wls:/mydomain/serverConfig>

currentTree

コマンド・カテゴリ: 参照コマンド

WLSTでの使用: オンライン

説明

階層内の現在の場所を返します。このコマンドを使用すると、階層内の現在の場所を格納しておいて、参照後に簡単にそこに戻ることができます。エラーが発生した場合は、WLSTExceptionが返されます。

構文

currentTree()

例

次の例では、階層内の現在の場所をmyTreeに格納して、管理サーバー・インスタンス上の実行時MBean階層から編集MBean階層に戻るときに使用します。

wls:/mydomain/edit> myTree=currentTree()
wls:/mydomain/edit> serverRuntime()
Location changed to serverRuntime tree. This is a read-only tree with
ServerRuntimeMBean as the root.
For more help, use help('serverRuntime')

wls:/mydomain/serverRuntime> myTree()
wls:/mydomain/edit>

prompt

コマンド・カテゴリ: 参照コマンド

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

説明

引数なしで入力した場合は、プロンプトでパス情報の表示を切り替えます。このコマンドは、パスが長くてプロンプトが長くなり過ぎた場合に便利です。

このコマンドに、引数としてonまたはoffを明示的に指定することもできます。offを指定した場合、WLSTはWLSTプロンプトを非表示にして、デフォルトでJythonプロンプトを表示します。デフォルトでは、WLSTプロンプトは構成または実行時の移動パス情報を表示します。

プロンプトの詳細を表示しない場合に、階層内の現在の場所を調べるには、pwdコマンドを使用できます(「pwd」を参照)。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

prompt(myPrompt)

引数

定義

myPrompt

オプション。WLSTプロンプトを非表示にしたり表示したりします。有効な値はoffまたはonです。

- off引数の場合、WLSTプロンプトは非表示になります。
WLSTオンラインを使用してprompt('off')を実行した場合、プロンプトはデフォルトでJythonプロンプトになります。Jython構文を使用して新しいプロンプトを作成できます。Jythonを使用したプログラミングの詳細は、http://www.jython.orgを参照してください。その後に、引数なしでpromptコマンドを入力すると、WLSTはWLSTコマンド・プロンプトをパス情報なしで表示します。パス情報を再表示するには、prompt()と再度入力するか、prompt('on')と入力します。

- on引数の場合、パス情報を含むデフォルトのWLSTプロンプトが表示されます。

例

次の例では、プロンプトでパス情報を非表示にしてから再表示します。

wls:/mydomain/serverConfig/Servers/myserver> prompt()
wls:/> prompt()
wls:/mydomain/serverConfig/Servers/myserver>

次の例では、プロンプトを非表示にして、デフォルトでJythonプロンプトを表示し(WLSTオンラインを使用してコマンドを実行している場合)、Jythonプロンプトを変更してから、WLSTプロンプトを再表示します。この例では、pwdコマンドの使い方も示しています。

注意:

Jythonを使用したプログラミングの詳細は、http://www.jython.orgを参照してください。

wls:/mydomain/serverConfig/Servers/myserver> prompt('off')
>>>sys.ps1="myprompt>"
myprompt> prompt()
wls:> pwd()
'serverConfig:Servers/myserver'
wls:> prompt()
wls:/mydomain/serverConfig/Servers/myserver>

pwd

コマンド・カテゴリ: 参照コマンド

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

説明

構成Beanまたは実行時Bean階層内の現在の場所を表示します。

このコマンドは、promptコマンドを使用してプロンプトでパス情報の表示を無効にした場合に便利です(「prompt」を参照)。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

pwd()

例

次の例では、構成Bean階層内の現在の場所を表示します。

wls:/mydomain/serverConfig/Servers/myserver/Log/myserver> pwd()
'serverConfig:/Servers/myserver/Log/myserver'

制御コマンド

表3-3に示すWLST制御コマンドを使用して、次のタスクを行います。

- サーバーに接続したり、サーバーへの接続を切断したりします(connectおよびdisconnectコマンド)

- 構成ウィザードと同様に、ドメイン・テンプレートから新しいWebLogicドメインを作成します(createDomain、readTemplate、writeDomainおよびcloseTemplateコマンド)

- 既存のWebLogicドメインをオフラインで更新します(readDomain、addTemplate,、updateDomainおよびcloseDomainコマンド)

- ドメイン・テンプレートを記述します(writeTemplateコマンド)

- WLSTを終了します

表3-3に、WLST構成の制御コマンドを示します。

表3-3 WLST構成の制御コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

connect

WLSTをWebLogic Serverインスタンスに接続します。

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

disconnect

WLSTをWebLogic Serverインスタンスから接続解除します。

オンライン

createDomain

指定されたテンプレートを使用して新しいWebLogicドメインを作成します。

オフライン

readTemplate

ドメインを作成するために既存のドメイン・テンプレートを開きます。

オフライン

writeDomain

指定されたディレクトリにドメインの構成情報を書き込みます。

オフライン

closeTemplate

現在のドメイン・テンプレートを閉じます。

オフライン

readDomain

更新する既存のWebLogicドメインを開きます。

オフライン

addTemplate

アプリケーションまたはサービスの拡張テンプレートを使用して、現在のWebLogicドメインを拡張します。

オフライン

updateDomain

現在のドメインを更新して保存します。

オフライン

closeDomain

現在のドメインを閉じます。

オフライン

writeTemplate

指定されたドメイン・テンプレート・ファイルに構成情報を書き込みます。

オフライン

exit

WLSTを対話セッションから終了させて、スクリプト・シェルを閉じます。

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

addTemplate

コマンド・カテゴリ: 制御コマンド

WLSTでの使用: オフライン

説明

アプリケーションまたはサービスの拡張テンプレートを使用して、現在のWebLogicドメインを拡張します。テンプレート・ビルダーを使用してアプリケーション・テンプレートまたはサービスの拡張テンプレートを作成します。『Oracle WebLogic Serverドメイン・テンプレート・ビルダーによるテンプレートの作成』を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

addTemplate(templateFileName)

引数

定義

templateFileName

アプリケーションまたはサービスの拡張テンプレートの名前。

例

次の例では、WebLogicドメインを開いて、指定された拡張テンプレートDefaultWebApp.jarを使用してドメインを拡張します。

wls:/offline> readDomain('c:/Oracle/Middleware/user_projects/domains/wlw')
wls:/offline/wlw> addTemplate('c:/Oracle/Middleware/wlserver_10.3
/common/templates/applications/DefaultWebApp.jar')
wls:/offline/wlw>

closeDomain

コマンド・カテゴリ: 制御コマンド

WLSTでの使用: オフライン

説明

現在のドメインを閉じます。一度閉じるとそのドメインは編集できなくなります。エラーが発生した場合は、WLSTExceptionが返されます。

構文

closeDomain()

例

次の例では、現在のドメインを閉じます。

wls:/offline> readDomain('c:/Oracle/Middleware/user_projects/domains/medrec')
...
wls:/offline/medrec> updateDomain()
wls:/offline/medrec> closeDomain()
wls:/offline>

closeTemplate

コマンド・カテゴリ: 制御コマンド

WLSTでの使用: オフライン

説明

現在のドメイン・テンプレートを閉じます。一度閉じるとそのテンプレートは使用できなくなります。エラーが発生した場合は、WLSTExceptionが返されます。

構文

closeTemplate()

例

次の例では、既存のドメイン・テンプレートを開き、いくつかの操作を実行してから、現在のドメイン・テンプレートを閉じます。

wls:/offline> readTemplate('c:/Oracle/Middleware/wlserver_10.3
/common/templates/domains/wls.jar')
...
wls:/offline/wls> closeTemplate()
wls:/offline>

connect

コマンド・カテゴリ: 制御コマンド

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

説明

WLSTをWebLogic Serverインスタンスに接続します。

アクティブなWebLogicセキュリティ・レルムで定義されているユーザーの資格証明(ユーザー名およびパスワード)を提供する必要があります。接続後は、一群のセキュリティ・ポリシーによって、表示または変更できる構成属性が決まります。(Oracle WebLogic Server MBeanリファレンスのMBeanのデフォルト・セキュリティ・ ポリシーに関する項を参照してください。)

ユーザー資格証明は、次のいずれかの方法で提供できます。

- コマンド行で資格証明を入力します。この方法は、WLSTを対話モードで使用している場合にのみお薦めします。

- 資格証明をコマンド行で入力してから、storeUserConfigコマンドを使用して、暗号化された形式の資格証明が格納されたユーザー構成ファイル、およびその資格証明の復号化に使用されるキー・ファイルを作成します。以降のWLSTセッション(またはWLSTスクリプト)では、コマンド行で資格証明を入力するかわりに、このユーザー構成ファイルおよびキー・ファイルの名前を指定します。この方法は、WLSTをスクリプト・モードで使用している場合にお薦めします。スクリプト・モードでは、暗号化されていないユーザー資格証明がスクリプトに格納されないためです。

- 管理サーバーのboot.propertiesファイルに格納されている資格証明を使用します。デフォルトでは、管理サーバーを開発モードで作成すると、WebLogic Serverはサーバーの作成に使用された資格証明を暗号化し、暗号化した資格証明をboot.propertiesファイルに格納します。管理サーバーを本番モードで作成すると、boot.propertiesファイルは作成されません。本番ドメインがboot.propertiesファイルを含まない場合、手動で作成できます。『Oracle WebLogic Serverサーバーの起動と停止の管理』の管理サーバーのブート識別ファイルの作成に関する項を参照してください。
connectコマンドの実行時にドメインの暗号化されたユーザー名とパスワードを含むboot.propertiesファイルが存在する場合、管理サーバーに接続するユーザー名とパスワードを入力する必要はありません。ただし、connectコマンドで管理サーバーの名前を指定する必要があります。

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

- ユーザー名とパスワード、またはユーザー構成ファイルとキー・ファイルを指定しないでスクリプトでconnectコマンドを実行すると、WSLTExceptionが発生します。対話モードでは、ユーザー名とパスワードの入力を求められます。

- WLSTのサーバーへの接続は、SSLポートまたは管理ポートを介して行うことが強く推奨されます。そうしなかった場合は、次の警告メッセージが表示されます。

Warning: An insecure protocol was used to connect to the server. To ensure
on-the-wire security, the SSL port or Admin port should be used instead.

- デモ用のSSLキーおよび証明書を使用しているサーバーのSSLリスン・ポートからWebLogic Serverインスタンスに接続している場合は、次のコマンドでWLSTを呼び出します。

java -Dweblogic.security.SSL.ignoreHostnameVerification=true
-Dweblogic.security.TrustKeyStore=DemoTrust weblogic.WLST

WLSTの呼出しの詳細は、『Oracle WebLogic Scripting Tool』のWLSTの対話モードまたはスクリプト・モードでの使用の主な手順に関する項を参照してください。

- HTTPを介してWebLogic Serverインスタンスに接続している場合は、そのWebLogic ServerインスタンスのTunnelingEnabled属性がtrueに設定されていることを確認してください。詳細は、Oracle WebLogic Server MBeanリファレンスのトンネリングの有効化に関する項を参照してください。

- ホスト名にlocalhostを使用してWLSTからWebLogic Server管理サーバーに接続する場合、管理サーバーのlisten-address属性が特定のIPアドレスに制限されていると、次のメッセージが表示されることがあります。

javax.naming.CommunicationException [Root exception is
java.net.ConnectException : <t3://HOST:PORT> : Destination unreachable;
nested exception is: java.net.ConnectException: Connection refused; No
available router to destination

この問題には次のいずれかの回避策を使用できます。

- 管理サーバーのlisten-address属性が正しく設定されていることを確認します。次に、ドメイン構成ファイルの例を示します。

<server>
<name>AdminServer</name>
<ssl>
.
.
.
</ssl>
<machine>your_machine</machine>
<!-- listen-address><your_ip_address></listen-address -->
</server>

- WLST connectコマンドで、localhostのかわりに管理サーバーのホスト名を使用します。

WebLogic Serverインスタンスに正常に接続した後で、すべてのローカル変数が初期化されます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

connect([username, password], [url], [timeout])
connect([userConfigFile, userKeyFile], [url], [timeout])
connect([url], [adminServerName], [timeout])

引数

定義

username

オプション。WLSTをサーバーに接続するオペレータのユーザー名。指定しない場合、WLSTはコマンドを上記のように処理します。

password

オプション。WLSTをサーバーに接続するオペレータのパスワード。指定しない場合、WLSTはコマンドを上記のように処理します。

url

オプション。サーバー・インスタンスのリスン・アドレスとリスン・ポート。[protocol://]listen-address:listen-portという形式で指定します。指定しない場合、この引数はデフォルトでt3://localhost:7001になります。

timeout

オプション。オンライン・コマンドが完了する(返される)のをWLSTが待機するミリ秒数。

WLSTオンライン・コマンドを呼び出すと、WLSTはMBeanサーバーに接続してMBeanサーバー・メソッドを呼び出し、呼出しの結果を返します。MBeanサーバー・メソッドがタイムアウト期間内に返されない場合、WLSTは呼出しを破棄します。この引数には次の構文を使用します:

timeout='milliseconds'

値0は、操作がタイムアウトしないことを表します。この引数のデフォルトは300,000ミリ秒(5分)です。

userConfigFile

オプション。暗号化されたユーザー名とパスワードを格納するユーザー構成ファイルの名前と場所。この引数には次の構文を使用します:

userConfigFile='file-system-path'

指定しない場合、WLSTはコマンドを上記のように処理します。

ユーザー構成ファイルの作成時に、storeUserConfigコマンドはキー・ファイルを使用してユーザー名とパスワードを暗号化します。ユーザー構成ファイルを暗号化するキー・ファイルのみが、そのユーザー名とパスワードを復号化できる(「storeUserConfig」を参照。)

userKeyFile

オプション。指定されたユーザー構成ファイルに関連付けられていて、そのファイルの復号化に使用されるキー・ファイルの名前と場所。この引数には次の構文を使用します:

userKeyFile='file-system-path'

指定しない場合、WLSTはコマンドを上記のように処理します。

「storeUserConfig」を参照してください。

adminServerName

オプション。ドメインの管理サーバーの名前。connectコマンドで、管理サーバーのboot.propertiesファイルに格納されている資格証明を使用するようにします。この引数には次の構文を使用します:

adminServerName='server-name'

この引数は、WLSTをドメイン・ディレクトリから起動した場合にのみ有効となります。管理サーバーのboot.propertiesファイルがドメイン・ディレクトリに格納されている場合は、この引数を指定する必要はありません。

指定しない場合、WLSTはコマンドを上記のように処理します。

例

次の例では、WLSTをWebLogic Serverインスタンスに接続します。この例では、管理サーバー名はデフォルトのAdminServerになります。サーバーへの接続にSSLまたは管理ポートが使用されない場合は警告が表示されます。

wls:/offline> connect('weblogic','welcome1','t3://localhost:8001')
Connecting to weblogic server instance running at t3://localhost:8001 as
username weblogic...

Successfully connected to Admin Server 'AdminServer' that belongs to domain
'mydomain'.

Warning: An insecure protocol was used to connect to the server. To ensure
on-the-wire security, the SSL port or Admin port should be used instead.

wls:/mydomain/serverConfig>

次の例では、WLSTを指定されたURLのWebLogic Serverインスタンスに接続します。この例では、ユーザー名とパスワードが引数として渡されます。この例ではセキュアなプロトコルを使用しています。

wls:/offline> username = 'weblogic'
wls:/offline> password = 'welcome1'
wls:/offline> connect(username,password,'t3s://myhost:8001')
Connecting to weblogic server instance running at t3://myhost:8001 as
username weblogic...

Successfully connected to Admin Server 'AdminServer' that belongs to domain
'mydomain'.
wls:/mydomain/serverConfig>

次の例では、ユーザー資格証明を提供するユーザー構成ファイルとキー・ファイルを使用して、WLSTをWebLogic Serverインスタンスに接続します。

wls:/offline> connect(userConfigFile='c:/myfiles/myuserconfigfile.secure',
userKeyFile='c:/myfiles/myuserkeyfile.secure')
Connecting to t3://localhost:7001 with userid username ...

Successfully connected to Admin Server 'AdminServer' that belongs to domain 'mydomain'.
wls:/mydomain/serverConfig>

次の例では、パラメータを使用しないでコマンドを実行する場合に対話モードで表示されるプロンプトを示します。

wls:/offline> connect()
Please enter your username :username
Please enter your password :
Please enter your server URL [t3://localhost:7001] :
Connecting to t3//localhost:7001 with userid username

createDomain

コマンド・カテゴリ: 制御コマンド

WLSTでの使用: オフライン

説明

指定されたテンプレートを使用してWebLogicドメインを作成します。

注意:

WebLogicドメイン作成時にドメイン構成の設定を変更する場合は、『Oracle WebLogic Scripting Tool』のドメインの編集(オフライン)のオプション2に関する項を参照してください。

createDomainコマンドは、『packおよびunpackコマンドを使用したテンプレートとドメインの作成』で説明されているように、unpackコマンドに類似した機能を備えています。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

createDomain(domainTemplate, domainDir, user, password)

引数

定義

domainTemplate

作成するドメインの基になるドメイン・テンプレートの名前および場所。

domainDir

ドメイン構成情報を書き込むディレクトリの名前。

使用する環境のすべてのドメインをミドルウェア・ホーム・ディレクトリ以外の場所に作成することをお薦めします。これによって、ドメインやアプリケーションを再作成せずに、既存のインストールの削除や新しいバージョンのWebLogic Serverのインストールが簡単にできるようになります。

user

デフォルト・ユーザーの名前。

password

デフォルト・ユーザーのパスワード。

例

次の例では、Avitek MedRecテンプレートを使用して新しいWebLogicドメインを作成し、デフォルトのユーザー名をweblogic、パスワードをwelome1に設定しています。ドメインがc:/Oracle/Middleware/wlserver_10.3/user_projects/domains/medrecディレクトリに保存されます。

wls:/offline> createDomain('c:/Oracle/Middleware/wlserver_10.3/common
/templates/domains/wls_medrec.jar','c:/Oracle/Middleware/user_projects/domains/medrec',
'weblogic', 'welcome1')

disconnect

コマンド・カテゴリ: 制御コマンド

WLSTでの使用: オンライン

説明

WLSTをWebLogic Serverインスタンスから接続解除します。disconnectコマンドを実行しても対話スクリプト・シェルは終了しません。対話シェルを開いたままで、現在のWebLogic Serverインスタンスの接続を閉じて、すべての変数をリセットします。

エラーが発生した場合は、WLSTExceptionが返されます。

connectコマンドを使用して別のWebLogic Serverインスタンスに接続できます(「connect」を参照)。

構文

disconnect(force)

引数

定義

force

オプション。アクティブなセッションの完了を待たずに接続を解除するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合は、すべてのアクティブ・セッションが完了してから接続解除します。

例

次の例では、実行中のサーバーから接続を解除します。

wls:/mydomain/serverConfig> disconnect()
Disconnected from weblogic server: myserver
wls:/offline>

exit

コマンド・カテゴリ: 制御コマンド

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

説明

WLSTをユーザー・セッションから終了させて、スクリプト・シェルを閉じます。

進行中の編集セッションがある場合、WLSTはユーザーに確認を求めます。このプロンプトをスキップするには、defaultAnswer引数をyに設定します。

デフォルトでは、WLSTを終了するときに、現在のWLST JVMのSystem.exit(0)が呼び出されます。JVMに別の終了コードで終了させるには、exitCode引数を使用して値を指定できます。

注意:

Antスクリプトの中でWLST exitコマンドが発行されると、Antスクリプトの実行も終了する可能性があります。Antスクリプトの中でWLSTを呼び出す場合は、fork="true"を指定して新しいJVMを使用することをお薦めします。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

exit([defaultAnswer], [exitcode])

引数

定義

defaultAnswer

オプション。コマンド行で入力を求められたくない場合の、デフォルトのレスポンス。有効な値はyおよびnです。この引数のデフォルトはnullです。nullの場合、WLSTはユーザーにレスポンスを求めます。

exitcode

オプション。WLSTを終了するときに設定する終了コード。

例

次の例では、ユーザー・セッションから接続解除して、スクリプト・シェルを閉じます。

wls:/mydomain/serverConfig> exit()
Exiting WebLogic Scripting Tool ...
c:\>

次の例では、ユーザー・セッションから接続解除して、スクリプト・シェルを閉じ、エラー・コードを101に設定します。

wls:/mydomain/serverConfig> exit(exitcode=101)
Exiting WebLogic Scripting Tool ...
c:\>

readDomain

コマンド・カテゴリ: 制御コマンド

WLSTでの使用: オフライン

説明

更新するために既存のWebLogicドメインを開きます。

WLSTオフラインでは、テンプレート・ビルダーを使用して作成したドメイン・テンプレートJAR内、またはWebLogicドメインのconfigディレクトリ内に永続化されている構成データへの読み書きアクセスが可能です。このデータは、XMLドキュメントの集合であり、管理オブジェクトの階層構造を表します。

テンプレートまたはWebLogicドメインを開くと、WLSTはそのドメインの構成階層のルートに入り、プロンプトはその構成階層での現在の場所を示すように更新されます。例:

wls:/offline/base_domain>

詳細は、『Oracle WebLogic Scripting Tool』のMBeanの移動と照会に関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

readDomain(domainDirName)

引数

定義

domainDirName

開くWebLogicドメイン・ディレクトリの名前。

例

次の例では、編集するためにmedrecドメインを開きます。

wls:/offline> readDomain('c:/Oracle/Middleware/user_projects/domains/medrec')
wls:/offline/medrec>

readTemplate

コマンド・カテゴリ: 制御コマンド

WLSTでの使用: オフライン

説明

ドメインを作成するために既存のドメイン・テンプレートを開きます。

ドメイン・テンプレートを開くと、WLSTはそのドメイン・テンプレートの構成Bean階層に入り、プロンプトはその構成階層での現在の場所を示すように更新されます。例:

wls:/offline/base_domain>

WebLogic Server構成Beanは階層構造の中に存在します。WLSTファイル・システムでは、階層はドライブに、タイプとインスタンスはディレクトリに、属性と操作はファイルに相当します。UNIXまたはWindowsコマンド・シェルでファイル・システムを移動するときと同じように、WLSTはcd、ls、およびpwdなどのコマンドを使用して、構成Beanの階層構造を移動します。構成Beanインスタンスに移動したら、WLSTコマンドを使用してBeanと対話します。詳細は、『Oracle WebLogic Scripting Tool』のMBeanの移動と照会に関する項を参照してください。

注意:

WLSTとドメイン・テンプレートを使用する場合、新しいWebLogicドメインを作成するときにのみセキュリティ情報を作成してアクセスできます。WebLogicドメインを更新するときは、WLSTからセキュリティ情報にアクセスすることはできません。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

readTemplate(templateFileName)

引数

定義

templateFileName

ドメイン・テンプレートに相当するJARファイルの名前。

例

次の例では、WebLogicドメインを作成するためにmedrec.jarドメイン・テンプレートを開きます。

wls:/offline> readTemplate('c:/Oracle/Middleware/wlserver_10.3/common/templates
/domains/wls_medrec.jar')
wls:/offline/wls_medrec>

updateDomain

コマンド・カテゴリ: 制御コマンド

WLSTでの使用: オフライン

説明

現在のWebLogicドメインを更新して保存します。更新して保存した後、ドメインは引続き編集可能になります。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

updateDomain()

例

次の例では、medrecドメインを開き、いくつかの操作を実行してから、現在のドメインを更新して保存します。

wls:/offline> readDomain('c:/Oracle/Middleware/user_projects/domains/medrec')
...
wls:/offline/medrec> updateDomain()

writeDomain

コマンド・カテゴリ: 制御コマンド

WLSTでの使用: オフライン

説明

指定されたディレクトリにドメインの構成情報を書き込みます。

WebLogicドメインをファイル・システムに書き込んだ後で、メモリー内に存在するドメイン・テンプレート・オブジェクトを引続き更新し、writeDomainコマンドを再発行して、ドメイン構成を新しいファイルまたは既存のファイルに格納できます。

デフォルトでは、WebLogicドメインを書き込むときに、関連するアプリケーションがWL_HOME/user_projects/applications/domainnameに書き込まれます。WL_HOMEはWebLogic Serverホーム・ディレクトリ、domainnameはWebLogicドメインの名前を表します。このディレクトリは空でなければなりません。空でない場合はエラーが表示されます。

メモリー内のドメイン・テンプレート・オブジェクトを使用し終えたら、closeTemplateコマンドを使用して閉じます。ディスクに保存されているWebLogicドメインを編集する場合は、readDomainコマンドを使用してドメインを開くことができます。

注意:

WebLogicドメインの名前はドメイン・ディレクトリの名前から取られます。たとえば、ドメインがc:/Oracle/Middleware/user_projects/domains/myMedrecに保存される場合、ドメイン名はmyMedrecになります。

既存のドメインを更新する場合は、writeDomain()のかわりにupdateDomainを使用する必要があります。

ドメインを書き込む前に、まだ定義されていない場合は、デフォルト・ユーザーのパスワードを定義する必要があります。例:

cd('/Security/base_domain/User/weblogic')
cmo.setPassword('welcome1')

エラーが発生した場合は、WLSTExceptionが返されます。

構文

writeDomain(domainDir)

引数

定義

domainDir

ドメイン構成情報を書き込むディレクトリの名前。

例

次の例では、medrec.jarドメイン・テンプレートを読み込み、いくつかの操作を実行してから、ドメイン構成情報をc:/Oracle/Middleware/user_projects/domains/medrecディレクトリに書き込みます。

wls:/offline> readTemplate('c:/Oracle/Middleware/wlserver_10.3/common/templates
/domains/wls.jar')
...
wls:/offline/base_domain> writeDomain('c:/Oracle/Middleware/user_projects/domains/base_domain')

writeTemplate

コマンド・カテゴリ: 制御コマンド

WLSTでの使用: オフライン

説明

指定されたドメイン・テンプレート・ファイルにドメイン構成情報を書き込みます。ドメイン構成テンプレートを使用してWebLogicドメインを再作成できます。

構成情報をドメイン構成テンプレートに書き込んだ後で、メモリー内に存在するWebLogicドメインまたはドメイン・テンプレート・オブジェクトを引続き更新し、writeDomainまたはwriteTemplateコマンドを再発行して、ドメイン構成を新規あるいは既存のWebLogicドメインまたはドメイン・テンプレート・ファイルに格納できます。詳細は、「writeDomain」または「writeTemplate」をそれぞれ参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

注意:

writeTemplateコマンドは、packコマンドと類似した機能を備えています。『packおよびunpackコマンドを使用したテンプレートとドメインの作成』のpackコマンドに関する項を参照してください。ただし、writeTemplateは管理対象サーバー・テンプレートの作成をサポートしていません。

構文

writeTemplate(templateName)

引数

定義

templateName

ドメイン構成情報を格納するドメイン・テンプレートの名前。

例

次の例では、現在のドメイン構成をc:/Oracle/Middleware/user_projects/templates/myTemplate.jarというドメイン・テンプレートに書き込みます。

wls:/offline> readDomain('c:/Oracle/Middleware/user_projects/domains/mydomain')
...
wls:/offline/base_domain> writeTemplate('c:/Oracle/Middleware/user_projects
/templates/myTemplate.jar')

カスタマイズ・コマンド

表3-4に示すWLSTカスタマイズ・コマンドを使用して、WLST help()およびhelp('commandGroup')コマンドで示されるコマンド・グループ・ヘルプおよびコマンド・ヘルプを追加します。WLSTへのコマンド・ヘルプの追加の詳細は、『Oracle WebLogic Scripting Tool』のカスタム・コマンドの統合型ヘルプの追加に関する項を参照してください。

表3-4 WLST構成のカスタマイズ・コマンド

コマンド

説明

WLSTの使用...

addHelpCommandGroup

WLST help()コマンドで表示されているコマンド・グループに新しいヘルプ・コマンド・グループを追加します。

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

addHelpCommand

コマンドのために新しいコマンド・ヘルプを既存のコマンド・グループに追加します。グループに追加した後、help('commandGroup')コマンドを入力した場合、グループのためにコマンド(簡単な説明を持つ)はコマンド・リストに表示されます。

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

addHelpCommandGroup

コマンド・カテゴリ: カスタマイズ・コマンド

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

説明

WLST help()コマンドで表示されているグループに新しいコマンド・ヘルプ・グループを追加して、グループに対して定義されているヘルプ情報のリソース・バンドルを指定します。

構文

addHelpCommandGroup(commandGroup, resourceBundleName)

引数

定義

commandGroup

コマンド・グループの一意の名前を使用します。WLST help()コマンドですでに示されているコマンド・グループ名を使用しないでください。

resourceBundleName

クラス名またはプロパティ・リソース・ファイル名を表します。リソース・バンドルには、標準パターンを使用したコマンド・グループのエントリのヘルプ・テキストが格納されます。リソース・バンドル名がResourceBundle.getBundle(...)に渡されます。複数のコマンド・グループで同じリソース・バンドルを使用できます。

リソース・バンドルは、クラスパスに指定されている必要があります。

各コマンド・グループおよびコマンドのヘルプ・テキストの定義方法の詳細は、『Oracle WebLogic Scripting Tool』のカスタム・コマンドの統合型ヘルプの追加に関する項を参照してください。

ResourceBundleおよびローカライゼーションについては、http://download.oracle.com/javase/6/docs/api/java/util/ResourceBundle.htmlを参照してください。

例

次の例では、bootコマンド・グループをhelp()コマンドで示されるグループのリストに追加し、ヘルプ・テキストをプロパティ・リソース・ファイル'myhelp'に格納します。

wls:/offline> addHelpCommandGroup('boot','myhelp')

次の例では、bootコマンド・グループをhelp()コマンドで示されるグループのリストに追加し、ヘルプ・テキストをクラスfoo.bar.MyResourceBundleClassに格納します。

wls:/offline> addHelpCommandGroup('boot','foo.bar.MyResourceBundleClass')

addHelpCommand

コマンド・カテゴリ: カスタマイズ・コマンド

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

説明

コマンドのために新しいコマンド・ヘルプを既存のコマンド・グループに追加します。グループに追加した後、help('commandGroup')コマンドを入力した場合、グループのためにコマンド(簡単な説明を持つ)はコマンド・リストに表示されます。help('online')およびhelp('offline')コマンドで示すコマンドかどうかを指定することもできます。

構文

addHelpCommand(commandName,commandGroup,[offline=false, online=false])

引数

定義

commandName

commandGroupで指定されたコマンド・グループで定義されるコマンドの名前。

commandGroup

コマンドが属するcommandGroup。

online

オプション。コマンドをhelp('online')出力に表示するかどうかを決定するブール値。デフォルト値はfalseです。

offline

オプション。コマンドをhelp('offline')出力に表示するかどうかを決定するブール値。デフォルト値はfalseです。

例

次の例では、オンライン・コマンドbootDBをhelp('boot')およびhelp('online')コマンドで示される出力に追加する方法を示します。

wls:/offline> addHelpCommand('bootDB','boot',online='true',offline='false')

デプロイメント・コマンド

表3-5に示すWLSTデプロイメント・コマンドを使用して、次のことを行います。

- アプリケーションとスタンドアロン・モジュールをWebLogic Serverインスタンスにデプロイ、アンデプロイ、および再デプロイします。

- 既存のデプロイメント・プランを更新します。

- WebLogicデプロイメント・マネージャ・オブジェクトに照会します。

- デプロイされたアプリケーションを起動および停止します。

アプリケーションのデプロイの詳細は、『Oracle WebLogic Serverへのアプリケーションのデプロイ』を参照してください。

表3-5 WLST構成のデプロイメント・コマンド

コマンド

説明

WLSTの使用...

deploy

WebLogic Serverインスタンスにアプリケーションをデプロイします。

オンライン

distributeApplication

指定されたターゲットにデプロイメント・バンドルをコピーします。

オンライン

getWLDM

WebLogic DeploymentManagerオブジェクトを返します。

オンライン

listApplications

WebLogicドメイン内に現在デプロイされているすべてのアプリケーションをリストします。

オンライン

loadApplication

アプリケーションとデプロイメント・プランをメモリーにロードします。

オンラインおよびオフライン

redeploy

以前にデプロイされたアプリケーションを再デプロイします。

オンライン

startApplication

アプリケーションを起動して、ユーザーが利用できるようにします。

オンライン

stopApplication

アプリケーションを停止して、ユーザーが利用できないようにします。

オンライン

undeploy

指定されたサーバーからアプリケーションをアンデプロイします。

オンライン

updateApplication

新しいデプロイメント・プランを使用してアプリケーションの構成を更新します。

オンライン

deploy

コマンド・カテゴリ: デプロイメント・コマンド

WLSTでの使用: オンライン

説明

WebLogic Serverインスタンスにアプリケーションをデプロイします。

deployコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTExceptionが返されます。

注意:

進行中の編集セッションがある場合、deployコマンドはユーザーの対話をブロックしません。

構文

deploy(appName, path, [targets], [stageMode], [planPath], [options])

引数

定義

appName

デプロイするスタンドアロンJava EEモジュールまたはアプリケーションの名前。

path

デプロイするアプリケーション・ディレクトリ、アーカイブ・ファイル、または展開されたアーカイブ・ディレクトリのルートの名前。

targets

オプション。カンマ区切りのターゲットのリスト。各ターゲットをJava EEモジュール名で修飾できます(たとえば、module1@server1)。それによって、別々のサーバーにあるアプリケーション・アーカイブの別々のモジュールをデプロイできます。この引数のデフォルトは、WLSTが現在接続しているサーバーになります。

stageMode

オプション。デプロイするアプリケーションのステージング・モード。有効な値はstage、nostage、およびexternal_stageです。ステージング・モードについては、『Oracle WebLogic Serverへのアプリケーションのデプロイ』のステージング・モードによるデプロイメント・ファイルのコピーの制御に関する項を参照してください。ステージ・モードを指定しない場合、デフォルトのステージ・モードが使用されます。デフォルトのステージ・モードは、管理サーバーではnostageで、管理対象サーバーではstageです。

planPath

オプション。デプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは、アプリケーション・ディレクトリのplan/plan.xmlファイル(存在する場合)です。

options

オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:

- altDD - 管理サーバーにある、代替アプリケーション・デプロイメント記述子の場所。

- altWlsDD - 管理サーバーにある、代替WebLogicアプリケーション・デプロイメント記述子の場所。

- archiveVersion - アーカイブのバージョン番号。

- block - コマンドが完了するまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。このオプションのデフォルトはtrueです。falseに設定した場合、WLSTはコマンドの発行後に制御をユーザーに返します。WLSTProgressオブジェクトに問い合わせて、コマンドのステータスを調べることができます。『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。

- clusterDeploymentTimeout - このアプリケーションでクラスタのデプロイメント・タスクに認められた時間(ミリ秒単位)。

- createPlan - ユーザーがデフォルト・プランを作成するかどうかを示すブール値。このオプションのデフォルトはfalseです。

- defaultSubmoduleTargets - 適格JMSサブモジュールの対象指定がシステムによって行われるかどうかを示すブール値。『Oracle WebLogic Serverへのアプリケーションのデプロイ』のJMSアプリケーション・モジュールにおけるサブモジュールの対象指定の使用に関する項を参照してください。デフォルト値はtrueです。

- deploymentPrincipalName - 起動および停止時にファイルまたはアーカイブをデプロイするときに使用されるプリンシパルを示す文字列値。静的デプロイメントであるため、現在のデプロイメント・タスクには影響を与えません。ユーザーの存在を確認してください。このオプションによって、config.xmlファイルの要素<app-deployment>に<deployment-principal-name>が追加されます。

- forceUndeployTimeout - アンデプロイメントのタイムアウト値を強制します。

- gracefulIgnoreSessions - 本番モードから管理モードへの正常な移行の際に保留中のHTTPセッションを無視するかどうかを指定するブール値。このオプションのデフォルトはfalseで、gracefulProductionToAdminがtrueに設定されている場合にのみ適用されます。

- gracefulProductionToAdmin - 本番モードから管理モードへの移行を正常に行う必要があるかどうかを指定するブール値。このオプションのデフォルトはfalseです。

- libImplVersion - ライブラリの実装バージョン(マニフェストにない場合)。

- libraryModule - モジュールがライブラリ・モジュールかどうかを示すブール値。このオプションのデフォルトはfalseです。

options

(続き)

- libSpecVersion - ライブラリの仕様バージョン(マニフェストにない場合)。

- planVersion - プランのバージョン番号。

- remote - ソースを格納するファイル・システムに対して操作がリモートになるかどうかを指定するブール値。この引数は、管理サーバーとは別のマシンで作業していて、管理サーバーのある指定された場所にすでにデプロイメント・ファイルがある場合に使用します。デフォルトはfalseです。

- retireGracefully - すべての処理中の作業が完了した後でのみ、アプリケーションを正常にリタイアするためのリタイアメント・ポリシー。このポリシーは停止および再デプロイ操作でのみ意味があり、リタイアされたタイムアウト・ポリシーと相互に排他的になります。

- retireTimeout - 新しいバージョンで置き換えられたアプリケーションをリタイアする前にWLSTが待機する時間(秒単位)。このオプションのデフォルトは-1で、正常なタイムアウトを指定します。

- securityModel - セキュリティ・モデル。有効な値はDDOnly、CustomRoles、CustomRolesAndPolicies、およびAdvancedです。

- securityValidationEnabled - セキュリティ検証を有効にするかどうかを指定するブール値。

- subModuleTargets - JMSモジュールのサブモジュール・レベルの対象。submod@mod-jms.xml@target | submoduleName@targetなど。

- testMode - アクセスを制限してWebアプリケーションを起動するかどうかを指定するブール値。このオプションのデフォルトはfalseです。

- timeout - 操作を取り消す前にWLSTがデプロイメント・プロセスの完了を待機する時間(ミリ秒単位)。値0は、操作がタイムアウトしないことを表します。この引数のデフォルトは300,000ミリ秒(5分)です。

- upload - アプリケーション・ファイルが、デプロイメントの前にWebLogic Server管理サーバーのアップロード・ディレクトリにアップロードされるかどうかを指定するブール値。このオプションは、管理サーバーがファイル・システムでアプリケーション・ファイルにアクセスできない場合に使用します。デフォルトはfalseです。

- versionIdentifier - バージョン識別子。

例

次の例では、c:/myapps/businessにあるbusinessAppアプリケーションをデプロイします。デフォルトのデプロイメント・プランが作成されます。

deployコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトはユーザー定義の変数(この場合はprogress)に格納されます。

wls:/mydomain/serverConfig/Servers> progress= deploy(appName='businessApp',
path='c:/myapps/business',createplan='true')

前の例では、返されたWLSTProgressオブジェクトが、ユーザー定義の変数(この場合はprogress)に格納されています。progress変数を使用してdeployコマンドのステータスを出力できます。例:

wls:/mydomain/serverConfig/Servers> progress.printStatus()
Current Status of your Deployment:
Deployment command type: deploy
Deployment State       : completed
Deployment Message     : null
wls:/mydomain/serverConfig/Servers>

WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

次の例では、c:/myapps/demos/app/demoApp.earにあるアーカイブ・ファイル内のdemoAppアプリケーションをデプロイして、そのアプリケーション・モジュールをmyserverに割り当て、c:/myapps/demos/app/plan/plan.xmlにあるデプロイメント・プラン・ファイルを使用します。WLSTは、プロセスが完了するまで120,000ミリ秒待機します。

wls:/mydomain/serverConfig/Servers> deploy('demoApp',
'c:/myapps/demos/app/demoApp.ear', targets='myserver',
planPath='c:/myapps/demos/app/plan/plan.xml', timeout=120000)

次の例では、c:/myapps/demos/jmsApp/demo-jms.xmlにあるjmsAppアプリケーションをデプロイして、そのアプリケーション・モジュールを特定の対象に割り当てます。

wls:/mydomain/serverConfig/Servers> deploy('jmsApp',path=
'c:/myapps/demos/jmsApps/demo-jms.xml', subModuleTargets='jmsApp@managed1')

次の例では、本番(サイドバイサイド)再デプロイメントをサポートするように、アプリケーションのバージョン(appVersion)をユニークな識別子に設定する方法を示します。この例では、c:/myapps/demos/app/demoApp.earにあるアーカイブ・ファイル内のdemoAppアプリケーションをデプロイし、アプリケーションとアーカイブのバージョン番号を、指定された値に設定します。

wls:/mydomain/serverConfig> deploy('demoApp', 'c:/myapps/demos/app/demoApp.ear',
archiveVersion='901-101', appVersion='901-102')

本番再デプロイメント戦略の詳細は、『Oracle WebLogic Serverへのアプリケーションのデプロイ』の本番環境でのアプリケーションの再デプロイメントに関する項を参照してください。

distributeApplication

コマンド・カテゴリ: デプロイメント・コマンド

WLSTでの使用: オンライン

説明

指定されたターゲットにデプロイメント・バンドルをコピーします。デプロイメント・バンドルにはモジュール、構成データ、その他の生成コードが含まれます。distributeApplicationコマンドではデプロイメントは開始されません。

distributeApplicationコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTExceptionが返されます。

構文

distributeApplication(appPath, [planPath], [targets], [options])

引数

定義

appPath

デプロイするアーカイブ・ファイル、または展開されたアーカイブ・ディレクトリのルートの名前。

planPath

オプション。デプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは、アプリケーション・ディレクトリのplan/plan.xmlファイル(存在する場合)です。

targets

オプション。カンマ区切りのターゲットのリスト。各ターゲットをJava EEモジュール名で修飾できます(たとえば、module1@server1)。それによって、別々のサーバーにあるアプリケーション・アーカイブの別々のモジュールをデプロイできます。この引数のデフォルトは、WLSTが現在接続しているサーバーになります。

options

オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。

例

次の例では、c:/myappsディレクトリにあるBigAppアプリケーションをロードして、WLSTProgressオブジェクトを、ユーザー定義の変数(この場合はprogress)に格納します。

次の例では、c:/deployment/BigApp/plan.xmlで定義されたデプロイメント・プランを使用して、c:/myapps/BigAppアプリケーションをmyserver、oamserver1、oamclusterの各サーバーに配布します。

wls:/offline> progress=distributeApplication('c:/myapps/BigApp',
'c:/deployment/BigApp/plan.xml', 'myserver,oamserver1,oamcluster')
Distributing Application and Plan ...
Successfully distributed the application.

前の例では、WLSTProgressオブジェクトが、ユーザー定義の変数(この場合はprogress)に格納されています。progress変数を使用して、distributeApplicationコマンドが完了したかどうかを判断できます。例:

wls:/mydomain/serverConfig/Servers> progress.isCompleted()
1
wls:/mydomain/serverConfig/Servers>

WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

getWLDM

コマンド・カテゴリ: デプロイメント・コマンド

WLSTでの使用: オンライン

説明

WebLogic DeploymentManagerオブジェクトを返します。このオブジェクトのメソッドを使用して、アプリケーションを構成したりデプロイしたりできます。このコマンドを実行するには、WLSTが管理サーバーに接続している必要があります。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getWLDM()

例

次の例では、WebLogicDeploymentManagerオブジェクトを取得してwldm変数に格納します。

wls:/mydomain/serverConfig> wldm=getWLDM()
wls:/mydomain/serverConfig> wldm.isConnected()
1
wls:/mydomain/serverConfig>

listApplications

コマンド・カテゴリ: デプロイメント・コマンド

WLSTでの使用: オンライン

説明

WebLogicドメイン内に現在デプロイされているすべてのアプリケーションをリストします。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

listApplications()

例

次の例では、mydomain内に現在デプロイされているすべてのアプリケーションをリストします。

wls:/mydomain/serverConfig> listApplications()
SamplesSearchWebApp
asyncServletEar
jspSimpleTagEar
ejb30
webservicesJwsSimpleEar
ejb20BeanMgedEar
xmlBeanEar
extServletAnnotationsEar
examplesWebApp
apache_xbean.jar
mainWebApp
jdbcRowSetsEar

loadApplication

コマンド・カテゴリ: デプロイメント・コマンド

WLSTでの使用: オンラインおよびオフライン

説明

アプリケーションとデプロイメント・プランをメモリーにロードします。オンライン・モードで使用する場合、管理サーバーにのみ接続できます。管理対象サーバーには接続できません。

loadApplicationコマンドは、デプロイメント・プランを変更するためにアクセスできるWLSTPlanオブジェクトを返します。WLSTPlanオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTPlanオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTExceptionが返されます。

構文

loadApplication(appPath, [planPath], [createPlan])

引数

定義

appPath

ロードするアプリケーションが含まれている、最上位の親アプリケーション・ディレクトリ、アーカイブ・ファイル、または展開されたアーカイブ・ディレクトリのルートの名前。

planPath

オプション。デプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは、アプリケーション・ディレクトリのplan/plan.xmlファイル(存在する場合)です。

createPlan

オプション。指定されたプランが存在しない場合に、WLSTがアプリケーション・ディレクトリにプランを作成するかどうかを指定するブール値。この引数のデフォルトはtrueです。

例

次の例では、c:/myplans/myejb/plan.xmlのプラン・ファイルを使用してc:/myapps/myejb.jarアプリケーションをロードします。

wls:/offline> myPlan=loadApplication('c:/myapps/myejb.jar', 'c:/myplans/myejb/plan.xml')
Loading application from c:/myapps/myejb.jar and deployment plan from c:/myplans/myejb/plan.xml ...
Successfully loaded the application.

前の例では、返されたWLSTPlanオブジェクトをmyPlan変数に格納しています。myPlan変数を使用して、プランに関する情報(変数など)を表示できます。例:

wls:/offline> myPlan.showVariables()
MyEJB jndi.ejb
MyWAR app.foo

WLSTPlanオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTPlanオブジェクトに関する項を参照してください。

redeploy

コマンド・カテゴリ: デプロイメント・コマンド

WLSTでの使用: オンライン

説明

クラスを再ロードして、以前にデプロイされたアプリケーションを再デプロイします。

redeployコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

アプリケーションの再デプロイの詳細は、『Oracle WebLogic Serverへのアプリケーションのデプロイ』の一般的なデプロイメント・シナリオの概要に関する項を参照してください。

構文

redeploy(appName, [planPath], [options])

引数

定義

appName

再デプロイするアプリケーションの名前。

planPath

オプション。デプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトは、アプリケーション・ディレクトリのplan/plan.xmlファイル(存在する場合)です。

options

オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。

加えて、redeployコマンドに対しては次のデプロイメント・オプションを指定可能。

- appPath - 再デプロイするアーカイブ・ファイル、または展開されたアーカイブ・ディレクトリのルートの名前。

- deploymentPrincipalName - 起動および停止時にファイルまたはアーカイブをデプロイするときに使用されるプリンシパルを示す文字列値。このオプションを使用すると、config.xmlファイルの現在の<deployment-principal-name>を上書きできます。

例

次の例では、c:/myappsディレクトリにあるplan.xmlファイルを使用してmyAppアプリケーションを再デプロイします。

wls:/mydomain/serverConfig> progress=redeploy('myApp' 'c:/myapps/plan.xml')
Redeploying application 'myApp' ...
Redeployment of 'myApp' is successful
wls:/mydomain/serverConfig>

前の例では、返されたWLSTProgressオブジェクトが、ユーザー定義の変数(この場合はprogress)に格納されています。progress変数を使用してredeployコマンドの状態にアクセスできます。例:

wls:/mydomain/serverConfig/Servers> progress.getState()
'completed'
wls:/mydomain/serverConfig/Servers>

WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

startApplication

コマンド・カテゴリ: デプロイメント・コマンド

WLSTでの使用: オンライン

説明

アプリケーションを起動して、ユーザーが利用できるようにします。アプリケーションは完全に構成済で、WebLogicドメインで利用できる状態でなければなりません。

startApplicationコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTExceptionが返されます。

構文

startApplication(appName, [options])

引数

定義

appName

plan.xmlファイルに指定されている、起動するアプリケーションの名前。

options

オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。

例

次の例では、指定されたデプロイメント・オプションでBigAppアプリケーションを起動します。

wls:/mydomain/serverConfig/Servers> progress=startApplication('BigApp', stageMode='NOSTAGE', testMode='false')
Starting the application...
Successfully started the application.

前の例では、返されたWLSTProgressオブジェクトが、ユーザー定義の変数(この場合はprogress)に格納されています。progress変数を使用してstartApplicationコマンドの状態にアクセスできます。例:

wls:/mydomain/serverConfig/Servers> progress.getState()
'completed'
wls:/mydomain/serverConfig/Servers>

WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

stopApplication

コマンド・カテゴリ: デプロイメント・コマンド

WLSTでの使用: オンライン

説明

アプリケーションを停止して、ユーザーが利用できないようにします。アプリケーションは完全に構成済で、WebLogicドメインで利用できる状態でなければなりません。

stopApplicationコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

stopApplication(appName, [options])

引数

定義

appName

plan.xmlファイルに指定されている、停止するアプリケーションの名前。

options

オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。

例

次の例では、BigAppアプリケーションを停止します。

wls:/offline> progress=stopApplication('BigApp')
Stopping the application...
Successfully stopped the application.

前の例では、返されたWLSTProgressオブジェクトが、ユーザー定義の変数(この場合はprogress)に格納されています。progress変数を使用して、stopApplicationコマンドが実行中かどうかをチェックできます。例:

wls:/mydomain/serverConfig/Servers> progress.isRunning()
0
wls:/mydomain/serverConfig/Servers>

WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

undeploy

コマンド・カテゴリ: デプロイメント・コマンド

WLSTでの使用: オンライン

説明

指定されたサーバーからアプリケーションをアンデプロイします。

undeployコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTExceptionが返されます。

アプリケーションのデプロイとアンデプロイの詳細は、『Oracle WebLogic Serverへのアプリケーションのデプロイ』の一般的なデプロイメント・シナリオの概要に関する項を参照してください。

構文

undeploy(appName,[targets],[options])

引数

定義

appName

デプロイ済のアプリケーションのデプロイメント名。

targets

オプション。アプリケーションを削除するターゲット・サーバーのリスト。指定しない場合は、デフォルトで現在のすべての対象に設定されます。

options

オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。

例

次の例では、すべてのターゲット・サーバーからbusinessAppアプリケーションを削除します。WLSTはプロセスが完了するまで60,000ミリ秒待機します。

wls:/mydomain/serverConfig> undeploy('businessApp', timeout=60000)
Undeploying application businessApp ...
<Jul 20, 2005 9:34:15 AM EDT> <Info> <J2EE Deployment SPI> <BEA-260121>
<Initiating undeploy operation for application, businessApp [archive: null],
to AdminServer .>
Completed the undeployment of Application with status
Current Status of your Deployment:
Deployment command type: undeploy
Deployment State       : completed
Deployment Message     : no message
wls:/mydomain/serverConfig>

updateApplication

コマンド・カテゴリ: デプロイメント・コマンド

WLSTでの使用: オンライン

説明

新しいデプロイメント・プランを使用してアプリケーションの構成を更新します。アプリケーションは完全に構成済で、WebLogicドメインで利用できる状態でなければなりません。

updateApplicationコマンドは、コマンドのステータスをチェックするためにアクセスできるWLSTProgressオブジェクトを返します。WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。エラーが発生した場合は、WLSTExceptionが返されます。

構文

updateApplication(appName, [planPath], [options])

引数

定義

appName

現在のplan.xmlファイルに指定されているアプリケーションの名前。

planPath

オプション。新しいデプロイメント・プラン・ファイルの名前。ファイル名は絶対パスでも、アプリケーション・ディレクトリを基準とした相対パスでもかまいません。

options

オプション。デプロイメント・オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なデプロイメント・オプションのリストについては、「deploy」のoptions引数の説明を参照してください。

例

次の例では、c:/myapps/BigApp/newPlanにあるplan.xmlファイルを使用して、BigAppのアプリケーション構成を更新します。

wls:/offline> progress=updateApplication('BigApp',
'c:/myapps/BigApp/newPlan/plan.xml', stageMode='STAGE', testMode='false')
Updating the application...
Successfully updated the application.

前の例では、返されたWLSTProgressオブジェクトが、ユーザー定義の変数(この場合はprogress)に格納されています。progress変数を使用してupdateApplicationコマンドの状態にアクセスできます。例:

wls:/mydomain/serverConfig/Servers> progress.getState()
'completed'
wls:/mydomain/serverConfig/Servers>

WLSTProgressオブジェクトの詳細は、『Oracle WebLogic Scripting Tool』のWLSTProgressオブジェクトに関する項を参照してください。

診断コマンド

表3-6に示すWLST診断コマンドを使用し、WebLogic診断フレームワーク(WLDF)のデータ・ストアに対して問合せを実行することによって、診断データを取得できます。WLDFの詳細は、『Oracle WebLogic Server診断フレームワークの構成と使用』を参照してください。

表3-6 WLST構成の診断コマンド

コマンド

説明

WLSTの使用...

exportDiagnosticData

指定されたログ・ファイルに対する問合せを実行します。

オフライン

exportDiagnosticDataFromServer

サーバー側で問合せを実行して、エクスポートされたWebLogic診断フレームワーク(WLDF)データを取得します。

オンライン

getAvailableCapturedImages

以前に捕捉した診断イメージのリストを返します。

オンライン

saveDiagnosticImageCaptureFile

指定された診断イメージ・キャプチャをダウンロードします。

オンライン

saveDiagnosticImageCaptureEntryFile

診断イメージ・キャプチャから特定のエントリをダウンロードします。

オンライン

exportDiagnosticData

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

WLSTでの使用: オフライン

説明

指定されたログ・ファイルに対する問合せを実行します。結果はXMLファイルとして保存されます。

WebLogic Server診断サービスの詳細は、『Oracle WebLogic Server診断フレームワークの構成と使用』を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

exportDiagnosticData([options])

引数

定義

options

オプション。エクスポート診断オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:

- beginTimestamp - 結果セットに追加する最も早い記録のタイム・スタンプ(そのタイム・スタンプを含む)。このオプションのデフォルトは0です。

- endTimestamp - 結果セットに追加する最も遅い記録のタイム・スタンプ(そのタイム・スタンプを含まない)。このオプションのデフォルトはLong.MAX_VALUEです。

- exportFileName - データのエクスポート先になるファイルの名前。このオプションのデフォルトはexport.xmlです。

- logicalName - 読み込まれるログ・ファイルの論理名。有効な値は、HarvestedDataArchive、EventsDataArchive、ServerLog、DomainLog、HTTPAccessLog、WebAppLog、ConnectorLog、およびJMSMessageLogです。このオプションのデフォルトはServerLogです。

- logName - エクスポートするログ・データが含まれている基本ログ・ファイル名。このオプションのデフォルトはmyserver.logです。

- logRotationDir - ローテーションされるログ・ファイルが含まれるディレクトリ。このオプションのデフォルトは「.」(ログ・ファイルが格納されているディレクトリと同じディレクトリ)です。

- query - 結果セットに含まれるデータ記録のフィルタ条件を指定する式。このオプションのデフォルトは"" (空の文字列)で、すべてのデータが返されます。詳細は、『Oracle WebLogic Server診断フレームワークの構成と使用』のWLDF問合せ言語に関する項を参照してください。

- storeDir - サーバーの診断ストアの場所。このオプションのデフォルトは../data/store/diagnosticsです。

例

次の例では、myserver.logという名前のServerLogに対して問合せを実行し、その結果をmyExport.xmlというファイルに格納します。

wls:/offline/mydomain>exportDiagnosticData(logicalName='ServerLog',
logName='myserver.log', exportFileName='myExport.xml')
{'elfFields': '', 'logName': 'myserver.log', 'logRotationDir': '.',
'endTimestamp': 9223372036854775807L, 'exportFileName': 'export.xml',
'storeDir': '../data/store/diagnostics', 'logicalName': 'ServerLog',
'query': '', 'beginTimestamp': 0}

Exporting diagnostic data to export.xml
<Aug 2, 2005 6:58:21 PM EDT> <Info> <Store> <BEA-280050> <Persistent store
"WLS_DIAGNOSTICS" opened: directory="c:\Oracle\Middleware
\wlserver_10.3\server\data\store\diagnostics"
writePolicy="Disabled" blockSize=512 directIO=false driver="wlfileio2">

wls:/mydomain/serverRuntime>

exportDiagnosticDataFromServer

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

WLSTでの使用: オンライン

説明

サーバー側で問合せを実行して、エクスポートされたWebLogic診断フレームワーク(WLDF)データを取得します。結果はXMLファイルとして保存されます。

WebLogic Server診断サービスの詳細は、『Oracle WebLogic Server診断フレームワークの構成と使用』を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

exportDiagnosticDataFromServer([options])

引数

定義

options

オプション。エクスポート診断オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:

- beginTimestamp - 結果セットに追加する最も早い記録のタイム・スタンプ(そのタイム・スタンプを含む)。このオプションのデフォルトは0です。

- endTimestamp - 結果セットに追加する最も遅い記録のタイム・スタンプ(そのタイム・スタンプを含まない)。このオプションのデフォルトはLong.MAX_VALUEです。

- exportFileName - データのエクスポート先になるファイルの名前。このオプションのデフォルトはexport.xmlです。

- logicalName - 読み込まれるログ・ファイルの論理名。有効な値は、HarvestedDataArchive、EventsDataArchive、ServerLog、DomainLog、HTTPAccessLog、WebAppLog、ConnectorLog、およびJMSMessageLogです。このオプションのデフォルトはServerLogです。

- query - 結果セットに含まれるデータ記録のフィルタ条件を指定する式。このオプションのデフォルトは"" (空の文字列)で、すべてのデータが返されます。

例

次の例では、HTTPAccessLogに対して問合せを実行し、その結果をmyExport.xmlというファイルに格納します。

wls:/mydomain/serverRuntime> exportDiagnosticDataFromServer(logicalName="HTTPAccessLog", exportFileName="myExport.xml")

getAvailableCapturedImages

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

WLSTでの使用: オンライン

説明

サーバーで構成したイメージの宛先ディレクトリに格納される以前に捕捉した診断イメージのリストを文字列の配列で戻します。デフォルトのディレクトリはSERVER\logs\diagnostic_imagesです。

このコマンドは、ダウンロードする診断イメージ・キャプチャの識別または特定のエントリをダウンロードする診断イメージ・キャプチャの識別に役立ちます。

WebLogic Server診断サービスの詳細は、『Oracle WebLogic Server診断フレームワークの構成と使用』を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

getAvailableCapturedImages()

例

次の例では、イメージの宛先ディレクトリで使用できる診断イメージ・キャプチャ・ファイルのリストを含むimagesという文字列の配列を戻し、diagnostic_image_myserver_2009_06_15_14_58_36.zipという診断イメージに含まれるエントリを出力します。

wls:/mydomain/serverRuntime>images=getAvailableCapturedImages()
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverRuntime>print images [ 'diagnostic_image_myserver_2009_06_15_14_58_36.zip' ]

saveDiagnosticImageCaptureFile

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

WLSTでの使用: オンライン

説明

WLSTが現在接続されているサーバーから指定した診断イメージ・キャプチャをダウンロードします。

WebLogic Server診断サービスの詳細は、『Oracle WebLogic Server診断フレームワークの構成と使用』を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

saveDiagnosticImageCaptureFile(imageName, [outputFile])

引数

定義

imageName

ダウンロードする診断イメージ・キャプチャの名前。

outputFile

オプション。取得した診断イメージ・キャプチャを格納するローカル・パスおよびファイル名。指定しない場合、この引数はデフォルトでimageNameの値および現在の作業ディレクトリになります。

例

次の例では、サーバーのイメージ宛先ディレクトリにある診断イメージ・キャプチャのリストを取得します。saveDiagnosticImageCaptureFileコマンドの2つの使用例を示します。最初の使用例では、リストの最初の診断イメージ・キャプチャがデフォルトの出力ファイル名でローカル・マシンにダウンロードされます。2番目の使用例では、リストの最初の診断イメージ・キャプチャがファイルmylocalimg.zipでローカル・マシンにダウンロードされます。

wls:/mydomain/serverRuntime>images=getAvailableCapturedImages()
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverConfig> saveDiagnosticImageCaptureFile(images[0])
Retrieving diagnostic_image_myserver_2009_06_25_12_12_50.zip to local
path diagnostic_image_myserver_2009_06_25_12_12_50.zip
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverConfig> saveDiagnosticImageCaptureFile(images[0], 'mylocalimg.zip')
Retrieving diagnostic_image_myserver_2009_06_25_12_12_50.zip to local
path mylocalimg.zip
Connecting to http://localhost:7001 with userid weblogic ...

saveDiagnosticImageCaptureEntryFile

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

WLSTでの使用: オンライン

説明

WLSTが現在接続されているサーバーにある診断イメージ・キャプチャから特定のエントリをダウンロードします。

WebLogic Server診断サービスの詳細は、『Oracle WebLogic Server診断フレームワークの構成と使用』を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

saveDiagnosticImageCaptureEntryFile(imageName, imageEntryName, [outputFile])

引数

定義

imageName

任意のエントリを含む診断イメージ・キャプチャの名前。

imageEntryName

診断イメージ・キャプチャから取得する特定のエントリの名前。これは、次のいずれかです。

image.summary
JTA.img
JRockitFlightRecorder.jfr
FlightRecording.jfr
WatchSource.img
configuration.img
WORK_MANAGER.img
JNDI_IMAGE_SOURCE.img
APPLICATION.img
InstrumentationImageSource.img
SAF.img
Logging.img
PERSISTENT_STORE.img
JDBC.img
PathService.img
JMS.img
Deployment.img
JVM.img
CONNECTOR.img

outputFile

オプション。診断イメージ・キャプチャから取得したエントリを格納するローカル・パスおよびファイル名。指定しない場合、この引数はデフォルトでimageEntryNameの値および現在の作業ディレクトリになります。

例

次の例では、診断イメージ・キャプチャのリストを取得し、saveDiagnosticImageCaptureEntryFileを2回使用します。最初の使用例では、デフォルトの出力ファイル名でローカル・マシンにイメージのサマリーを取得します。2番目の使用例では、ファイルmyimage.summaryでローカル・マシンにイメージのサマリーを取得します。

wls:/mydomain/serverRuntime>images=getAvailableCapturedImages()
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverConfig> saveDiagnosticImageCaptureEntryFile(images[0], 'image.summary')
Retrieving entry image.summary from diagnostic_image_myserver_2009_06_25_12_12_50.zip to local path image.summary
Connecting to http://localhost:7001 with userid weblogic ...
wls:/mydomain/serverConfig> saveDiagnosticImageCaptureEntryFile(images[0], 'image.summary', 'myimage.summary')
Retrieving entry image.summary from diagnostic_image_myserver_2009_06_25_12_12_50.zip to local path myimage.summary
Connecting to http://localhost:7001 with userid weblogic ...

編集コマンド

表3-7に示すWLST編集コマンドを使用して、構成Beanの照会や編集を行います。

注意:

構成Beanを編集するには、管理サーバーに接続している必要があります。また、編集ツリーに移動して、編集セッションを開始する必要があります。「edit」および「startEdit」をそれぞれ参照してください。

管理対象サーバーに接続した場合、WLSTの機能は構成Bean階層の参照だけに制限されます。WLSTを使用して管理対象サーバー上のMBeanの値を変更することはできませんが、管理APIを使用すれば可能です。ただし、管理サーバー上の構成MBeanの値のみを変更することをお薦めします。管理対象サーバー上のMBeanの値を変更すると、ドメイン構成に矛盾が生じる可能性があります。

構成Beanの編集の詳細は、『Oracle WebLogic Scripting Tool』のWLSTオンラインを使用した既存ドメインの更新に関する項を参照してください。

表3-7 WLST構成の編集コマンド

コマンド

説明

WLSTの使用...

activate

現在の編集セッション中に保存されてまだデプロイされていない変更をアクティブ化します。

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

assign

リソースを1つまたは複数の宛先に割り当てます。

オフライン

cancelEdit

編集セッションを取り消して、編集ロックを解放し、未保存の変更をすべて破棄します。この操作は、その編集セッションを開始したユーザーでなくても、管理者権限を持つユーザーであれば誰でも呼び出すことができます。

オンライン

create

現在のBeanに対して、指定されたタイプの構成Beanを作成します。

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

delete

現在の構成Beanの構成のインスタンスを削除します。

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

encrypt

指定された文字列を暗号化します。

オンライン

get

指定された属性の値を返します。

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

getActivationTask

ユーザーがステータスを取得できる最新のActivationTask MBeanを返します。

オンライン

invoke

現在の構成Beanの管理操作を呼び出します。

オンライン

isRestartRequired

サーバーの再起動が必要かどうかを判断します。

オンライン

loadDB

SQLファイルをデータベースにロードします。

オフライン

loadProperties

プロパティ値をファイルからロードします。

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

save

編集されてまだ保存されていない編集内容を保存します。

オンライン

set

現在の構成Beanの指定された属性値を設定します。

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

setOption

WebLogicドメインの作成または更新に関連するオプションを設定します。

オフライン

showChanges

現在の編集セッション中に現在のユーザーが行った構成の変更内容を表示します。

オンライン

startEdit

現在接続しているユーザーのために構成編集セッションを開始します。

オンライン

stopEdit

編集セッションを停止して、編集ロックを解放し、未保存の変更を破棄します。

オンライン

unassign

1つまたは複数の宛先からアプリケーションまたはリソースの割当てを解除します。

オフライン

undo

保存またはアクティブ化されていない編集をすべて元に戻します。

オンライン

validate

変更されてまだ保存されていない変更内容を検証します。

オンライン

activate

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オンライン

説明

現在の編集セッション中に保存されてまだデプロイされていない変更をアクティブ化します。アクティブ化する変更内容にサーバーの再起動が必要なものがある場合、このコマンドはメッセージを出力します。

activateコマンドは、ユーザーが現在行っている変更、または最近行った変更の状態を反映する、最新のActivationTask MBeanを返します。メソッドを呼び出して、進行中または完了したばかりの、最近の構成マネージャのアクティブ化タスクに関する情報を取得できます。エラーが発生した場合は、WLSTExceptionが返されます。

構文

activate([timeout], [block])

引数

定義

timeout

オプション。操作を取り消す前に、WLSTが構成の変更のアクティブ化が完了するのを待機する時間(ミリ秒単位)。値 -1は、操作がタイムアウトしないことを表します。この引数のデフォルトは300,000ミリ秒(5分)です。

block

オプション。コマンドが完了するまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトはfalseで、ユーザー対話がブロックされないことを示します。この場合、WLSTはコマンドを発行した後でユーザーに制御を返し、現在のタスクに関連付けられているタスクMBeanを変数に割り当てます。その変数を利用すると、タスクのステータスをチェックできます。『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。

例

次の例では、現在の編集セッション中に変更され、ディスクに保存されていて、まだアクティブ化されていない変更内容をアクティブ化します。WLSTはアクティブ化が完了するのを100,000ミリ秒待機し、アクティブ化を停止する前に200,000ミリ秒待機します。

wls:/mydomain/edit !> activate(200000, block='true')
Activating all your changes, this may take a while ...
The edit lock associated with this edit session is released once the activation is completed.
Action completed.
wls:/mydomain/edit>

assign

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オフライン

説明

リソースを1つまたは複数の宛先に割り当てます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

assign(sourceType, sourceName, destinationType, destinationName)

引数

定義

sourceType

割り当てる構成Beanのタイプ。この値は、次のいずれかの値に設定できます。

- AppDeployment

- Library

- securityType (Userなど)

- Server

- service (JDBCSystemResourceなど)

- service.SubDeployment。serviceには、SubDeploymentのサービス・タイプを指定します(JMSSystemResource.SubDeploymentなど)。ネストされたサブデプロイメントも指定できます(AppDeployment.SubDeployment.SubDeploymentなど)。

この値の設定のガイドラインについては次を参照してください。

sourceName

割り当てるリソースの名前。複数の名前をカンマで区切って指定することも、ワイルドカード(*)を使って指定されたタイプのすべてのリソースを指定することも可能です。

サブデプロイメントはservice.subDeploymentという形式で指定します。serviceには親サービス、subDeploymentにはサブデプロイメントの名前を指定します。myJMSResource.myQueueSubDeploymentなど。ネストされたサブデプロイメントも指定できます(MedRecEAR.MedRecAppScopedJMS.MedRecJMSServerなど)。

注意: assignコマンドがネストされたサブデプロイメントと解釈するため、指定されたサブデプロイメント名でドット(.)を使用できません。

destinationType

宛先のタイプ。この値の設定のガイドラインについては次を参照してください。

destinationName

宛先の名前。複数の名前をカンマで区切って指定できます。

sourceTypeおよびdestinationTypeの設定では次のガイドラインを使用してください。

- アプリケーション・デプロイメントを割り当てるときは、次のように値を設定します。

- sourceType: AppDeployment

- destinationType: Target

- ライブラリを割り当てるときは、次のように値を設定します。

- sourceType: Library

- destinationType: Target

- サービスを割り当てるときは、次のように値を設定します。

- sourceType: 特定のサーバーの名前(JDBCSystemResourceなど)

- destinationType: Target

- サーバーをクラスタに割り当てるときは、次のように値を設定します。

- sourceType: Server

- destinationType: Cluster

- サブデプロイメントを割り当てるときは、次のように値を設定します。

- sourceType: service.SubDeployment。serviceにはSubDeploymentの親を指定します(JMSSystemResource.SubDeploymentなど)。ネストされたサブデプロイメントも指定できます(AppDeployment.SubDeployment.SubDeploymentなど)。

- destinationType: Target

- セキュリティ・タイプを割り当てるときは、次のように値を設定します。

- sourceType: 特定のセキュリティ・タイプの名前(Userなど)

- destinationType: 宛先のセキュリティ・タイプの名前(Groupなど)

例

例:

- myServerとmyServer2をクラスタmyClusterに割り当てます。

wls:/offline/mydomain> assign("Server", "myServer,myServer2", "Cluster", "myCluster")

- すべてのサーバーをクラスタmyClusterに割り当てます。

wls:/offline/mydomain> assign("Server", "*", "Cluster", "myCluster")

- アプリケーション・デプロイメントmyAppDeploymentをターゲット・サーバーnewServerに割り当てます。

wls:/offline/mydomain> assign("AppDeployment", "myAppDeployment", "Target", "newServer")

- ユーザーnewUserをグループMonitorsに割り当てます。

wls:/offline/mydomain> assign("User", "newUser", "Group", "Monitors")

- サブデプロイメントmyQueueSubDeployment (JMSリソースmyJMSResourceの子)をターゲット・サーバーnewServerに割り当てます。

wls:/offline/mydomain> assign('JMSSystemResource.SubDeployment',
'myJMSResource.myQueueSubDeployment', 'Target', 'newServer')

- ネストされたサブデプロイメントMedRecAppScopedJMS.MedRecJMSServer (アプリケーション・デプロイメントAppDeploymentの子)をターゲット・サーバーAdminServerに割り当てます。

wls:/offline/mydomain>assign('AppDeployment.SubDeployment.SubDeployment
','MedRecEAR.MedRecAppScopedJMS.MedRecJMSServer','Target','AdminServer')

cancelEdit

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オンライン

説明

編集セッションを取り消して、編集ロックを解放し、未保存の変更をすべて破棄します。

このコマンドを発行するユーザーは現在の編集者でなくてもかまいません。つまり、必要な場合は、他のユーザーが編集セッションを開始できるように、管理者が編集セッションを取り消すことができます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

cancelEdit([defaultAnswer])

引数

定義

defaultAnswer

オプション。コマンド行で入力を求められたくない場合の、デフォルトのレスポンス。有効な値はyおよびnです。この引数のデフォルトはnullです。nullの場合、WLSTはユーザーにレスポンスを求めます。

例

次の例では、現在の編集セッションを取り消します。WLSTは取り消す前に確認を求めます。

wls:/mydomain/edit !> cancelEdit()
Sure you would like to cancel the edit session? (y/n)y
Edit session is cancelled successfully
wls:/mydomain/edit>

create

コマンド・カテゴリ: 編集コマンド

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

説明

現在のBeanに対して、指定されたタイプの構成Beanを作成します。

createコマンドは新しく作成された構成Beanのスタブを返します。エラーが発生した場合は、WLSTExceptionが返されます。

注意:

子タイプは、その親タイプのインスタンスの下に作成される必要があります。現在の構成管理オブジェクト(cmo)タイプの子である構成Beanのみを作成できます。cmo変数の詳細は、『Oracle WebLogic Scripting Tool』の現在の管理オブジェクトの変更に関する項を参照してください。

WLSTオンラインでcreateコマンドを使用する場合は、次の点に注意してください。

- 管理サーバーに接続している必要があります。実行時MBeanに対して、またはWLSTが管理対象サーバー・インスタンスに接続しているときに、createコマンドを使用することはできません。

- このコマンドを発行する前に、editコマンドを使用して構成MBean階層に移動する必要があります。「edit」を参照してください。

- createコマンドを使用して、現在のMBeanタイプの子であるWebLogic Server構成MBeanを作成できます。

WLSTオフラインでcreateコマンドを使用する場合は、次の点に注意してください。

- WLSTオフラインを使用している場合、オブジェクト名において、ピリオド(.)、フォワード・スラッシュ(/)またはバックスラッシュ(\)は無効です。

詳細は、次を参照してください。

- MBeanの作成については、『JMXによるカスタム管理ユーティリティの開発』のWebLogic Server MBeanの理解に関する項を参照してください。

- JMSまたはJDBCシステム・リソースなど、特定のタイプのMBeanリソースを作成する例については、製品と一緒にインストールされるWLSTサンプル・スクリプトを参照(『Oracle WebLogic Scripting Tool』のWLSTサンプル・スクリプトに関する項を参照)。

- MBeanとその子タイプ、属性、操作については、Oracle WebLogic Server MBeanリファレンスを参照してください。

構文

create(name, childMBeanType, [baseProviderType])

引数

定義

name

作成する構成Beanの名前。

childMBeanType

作成する構成Beanのタイプ。config.xmlファイルに定義されたタイプのインスタンスを作成できます(カスタム・セキュリティ・タイプは除く)。有効な構成Beanの詳細は、Oracle WebLogic Server MBeanリファレンスを参照してください。

baseProviderType

セキュリティ・プロバイダを作成する場合は、基本セキュリティ・プロバイダ・タイプ(AuthenticationProviderなど)を指定します。この引数のデフォルトはNoneです。

例

次の例では、現在の構成Beanで、newServerという名前のServerタイプの子構成Beanを作成して、スタブをserver1に格納します。

wls:/mydomain/edit !> server1=create('newServer','Server')
Server with name 'newServer' has been created successfully.
wls:/mydomain/edit !> server1.getName()
'newServer'
wls:/mydomain/edit !>

次の例では、myProviderという認証セキュリティ・プロバイダを作成します。

wls:/mydomain/edit !> cd('SecurityConfiguration/mydomain/Realms/myrealm')
wls:/mydomain/edit !> create('myProvider','weblogic.security.providers.authentication.SQLAuthenticator'
,'AuthenticationProvider')
wls:/mydomain/edit ! cd('AuthenticationProviders/myProvider')
wls:/mydomain/edit ! set('ControlFlag', 'REQUIRED')

次の例では、highsec_nmというマシンを作成して、関連するノード・マネージャの属性を設定します。

wls:/mydomain/edit !> create('highsec_nm', 'Machine')
wls:/mydomain/edit !> cd('Machine/highsec_nm/NodeManager/highsec_nm')
wls:/mydomain/edit !> set('DebugEnabled', 'true')
wls:/mydomain/edit !> set('ListenAddress', 'innes')
wls:/mydomain/edit !> set('NMType', 'SSL')
wls:/mydomain/edit !> set('ShellCommand', '')

delete

コマンド・カテゴリ: 編集コマンド

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

説明

現在の構成Beanに対する、指定されたタイプの構成Beanのインスタンスを削除します。

エラーが発生した場合は、WLSTExceptionが返されます。

注意:

現在の構成管理オブジェクト(cmo)タイプの子である構成Beanのみを削除できます。cmo変数の詳細は、『Oracle WebLogic Scripting Tool』の現在の管理オブジェクトの変更に関する項を参照してください。

構文

delete(name, childMBeanType)

引数

定義

name

削除する子構成Beanの名前。

childMBeanType

削除する構成Beanのタイプ。config.xmlファイルで定義されたタイプのインスタンスを削除できます。有効な構成Beanの詳細は、Oracle WebLogic Server MBeanリファレンスを参照してください。

例

次の例では、newServerという名前のServerタイプの構成Beanを削除します。

wls:/mydomain/edit !> delete('newServer','Server')
Server with name 'newServer' has been deleted successfully.
wls:/mydomain/edit !>

encrypt

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オンライン

説明

指定された文字列を暗号化します。暗号化した文字列は、構成ファイルやコマンドの引数として使用できます。

このコマンドは、暗号化された文字列を使用する必要のある各WebLogicドメインにつき1回呼び出す必要があります。暗号化された文字列は、その文字列が元々暗号化されたWebLogicドメインでのみ使用できます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

encrypt(obj, [domainDir])

引数

定義

obj

暗号化する文字列。

domainDir

オプション。WebLogicドメイン・ディレクトリの絶対パス名。暗号化された文字列は、指定したディレクトリ内にあるWebLogicドメインでのみ使用できます。

この引数を指定しない場合、WLSTが現在接続されているWebLogicドメインで使用されるために文字列が暗号化されます。

例

次の例では、指定されたWebLogicドメイン・ディレクトリにあるsecurity/SerializedSystemIni.datファイルを使用して、指定された文字列を暗号化します。

wls:/mydomain/serverConfig> es=encrypt('myPassword','c:/Oracle/Middleware/domains/mydomain')

get

コマンド・カテゴリ: 編集コマンド

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

説明

指定された属性の値を返します。表示できるMBean属性の詳細は、Oracle WebLogic Server MBeanリファレンスを参照してください。エラーが発生した場合は、WLSTExceptionが返されます。

注意:

ls('a')と入力すると、すべての属性とその現在の値を表示できます。詳細は、「ls」を参照してください。

かわりに、cmo変数を使用して、現在の構成Beanの任意のgetメソッドを実行できます。例:

cmo.getListenPort()

cmo変数の詳細は、『Oracle WebLogic Scripting Tool』の現在の管理オブジェクトの変更に関する項を参照してください。

構文

get(attrName)

引数

定義

attrName

表示する属性の名前。属性のフル・パス名を指定できます。パス名を指定しない場合は、現在の構成オブジェクトの属性が表示されます。

例

次の例では、現在の構成BeanのAdministrationPortの値を返します。

wls:/mydomain/serverConfig> get('AdministrationPort')
9002

かわりに、cmo変数を使用できます。

cmo.getAdministrationPort()

getActivationTask

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オンライン

説明

ユーザーがステータスを取得できる最新のActivationTask MBeanを返します。ActivationTask MBeanは、ユーザーがWLSTで最近行った変更の状態を反映します。メソッドを呼び出して、進行中または完了したばかりの、最近の構成マネージャのアクティブ化タスクに関する情報を取得できます。エラーが発生した場合は、WLSTExceptionが返されます。

注意:

WLSTの外部の変更をアクティブ化している場合、ConfigurationManagerMBean getActivationTasks()メソッドを使用して他のツールで作成したアクティブ化タスクにアクセスします。詳細は、Oracle WebLogic Server MBeanリファレンスを参照してください。

構文

getActivationTask()

例

次の例では、ユーザーがステータスを取得できる最新のActivationTask MBeanを返して、task変数に格納します。

wls:/mydomain/edit> task=getActivationTask()
wls:/mydomain/edit> if task!=None:
...   task.getState()
...
4

invoke

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オンライン

説明

現在の構成Beanの管理操作を呼び出します。通常、このコマンドを使用して、ほとんどのWebLogic Server構成Beanで提供されているgetおよびset以外の操作を呼び出します。クラス・オブジェクトは、このアクションが呼び出される構成Beanをロードする際に使用されたものと同じクラス・ローダーから、ロードされます。

WLSTが管理対象サーバー・インスタンスに接続しているときにinvokeコマンドを使用することはできません。

成功した場合、invokeコマンドは、呼び出された操作が返すオブジェクトを返します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

invoke(methodName, parameters, signatures)

引数

定義

methodName

呼び出すメソッドの名前。

parameters

メソッド呼出しに渡されるパラメータの配列。

signatures

アクションのシグネチャを含む配列。

例

次の例では、現在の構成BeanのlookupServerメソッドを呼び出します。

wls:/mydomain/config> objs = jarray.array([java.lang.String("oamserver")],java.lang.Object)
wls:/mydomain/edit> strs = jarray.array(["java.lang.String"],java.lang.String)
wls:/mydomain/edit> invoke('lookupServer',objs,strs)
true
wls:/mydomain/edit>

isRestartRequired

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オンライン

説明

サーバーの再起動が必要かどうかを判断します。

編集セッションの進行中にこのコマンドを呼び出すと、現在進行中の編集に基づいてレスポンスが行われます。属性の名前を指定した場合は、その属性に関してのみ、サーバーの再起動が必要かどうかが示されます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

isRestartRequired([attributeName])

引数

定義

attributeName

オプション。サーバーの再起動が必要かどうかをチェックする特定の属性の名前。

例

次の例では、現在のWLSTセッション中に行われるすべての変更について、サーバーの再起動が必要かどうかが示されます。

wls:/mydomain/edit !> isRestartRequired()
Server re-start is REQUIRED for the set of changes in progress.

The following attribute(s) have been changed on MBeans that require server re-start.
MBean Changed : mydomain:Name=mydomain,Type=Domain
Attributes changed : AutoConfigurationSaveEnabled

次の例では、ConsoleEnabled属性を編集する場合にサーバーの再起動が必要かどうかが示されます。

wls:/mydomain/edit !> isRestartRequired("ConsoleEnabled")
Server re-start is REQUIRED if you change the attribute ConsoleEnabled wls:/mydomain/edit !>

loadDB

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オフライン

説明

SQLファイルをデータベースにロードします。

loadDBコマンドは、テンプレート・ファイルからSQLファイルをロードします。このコマンドは、ドメイン・テンプレートまたは拡張テンプレートがメモリーにロードされた後でのみ発行できます(「readDomain」および「readTemplate」を参照)。

このコマンドを実行する前に、次の条件に該当することを確認してください。

- 適切なデータベースが実行されています。

- 指定されたデータベースとバージョンのSQLファイルが存在します。
適切なSQLファイルが存在することを確認するには、ドメイン・テンプレートを開いて、_jdbc_ディレクトリにある関連するSQLファイル・リストjdbc.indexを見つけます。たとえば、Oracle 9iの場合、SQLファイル・リストは_jdbc_\Oracle\9i\jdbc.indexにあります。

上記の条件が満たされていない場合、コマンドは失敗します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

loadDB(dbVersion, datasourceName, dbCategory)

引数

定義

dbVersion

SQLファイルが使用されるデータベースのバージョン。

datasourceName

SQLファイルのロードに使用するJDBCデータ・ソースの名前。

dbCategory

オプション。指定されたデータ・ソースに関連付けられるデータベース・カテゴリ。

jdbc.indexファイルおよびデータベース・カテゴリの詳細は、『Oracle WebLogic Serverドメイン・テンプレート・リファレンス』のテンプレートに含まれるファイルに関する項を参照してください。

例

次の例では、p13nDataSource JDBCデータ・ソースを使用して、データベースのバージョン5.1用のDrop/Create P13N Database Objectsに関連するSQLファイルをロードします。

wls:/offline/mydomain> loadDB('5.1', 'p13nDataSource', 'Drop/Create P13N Database Objects')

loadProperties

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オンラインおよびオフライン

説明

プロパティ値をファイルからロードして、WLSTセッションで使用できるようにします。

『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、このコマンドは使用できません。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

loadProperties(fileName)

引数

定義

fileName

プロパティ・ファイルのパス名。

例

この例では、プロパティ・ファイルの値を取得して設定します。

wls:/mydomain/serverConfig> loadProperties('c:/temp/myLoad.properties')

save

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オンライン

説明

編集されてまだ保存されていない編集内容を保存します。このコマンドは、編集セッションが進行中の場合にのみ有効です。編集セッションの開始方法については、「startEdit」を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

save()

例

次の例では、まだディスクに保存されていない編集内容を保存します。

wls:/mydomain/edit !> save()
Saving all your changes ...
Saved all your changes successfully.
wls:/mydomain/edit !>

set

コマンド・カテゴリ: 編集コマンド

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

説明

現在の管理オブジェクトの指定された属性値を設定します。WLSTオフラインを使用する場合、このコマンドは、属性値をドメインの構成ファイルに書き込みます。WLSTオンラインでは、MBean属性の値が設定されます。オンラインでの変更は、編集をアクティブ化したときに、ドメインの構成ファイルに書き込まれます。

エラーが発生した場合は、WLSTExceptionが返されます。

暗号化された属性(名前の末尾がEncryptedとなっている属性)の設定については、『Oracle WebLogic Scripting Tool』の暗号化された構成値の読み書きに関する項を参照してください。

WLSTオンラインを使用する場合は次の点に注意してください。

- このコマンドを使用するには、編集セッションに移動する必要があります。「startEdit」を参照してください。

- このコマンドは、WLSTが管理対象サーバーに接続しているときには使用できません。

- このコマンドのかわりとして、次の構文とともにcmo変数を使用できます。
cmo.setattrName(value)

たとえば、set('ListenPort', 7011)を使用するかわりに、次の構文を使用できます。

cmo.setListenPort(7011)

cmo変数の詳細は、『Oracle WebLogic Scripting Tool』の現在の管理オブジェクトの変更に関する項を参照してください。

構文

set(attrName, value)

引数

定義

attrName

設定する属性の名前。

value

設定する属性の値。

注意: この値は一重または二重の引用符で囲む必要がありません。例を参照してください。

例

次の例では、DomainMBeanのArchiveConfigurationCount属性を10に設定します。

wls:/mydomain/serverConfig> set('ArchiveConfigurationCount', 10)

次の例では、カスタムMbeanのT1TimerInterval属性のlong値を123に設定しています。

wls:/mydomain/serverConfig> set('T1TimerInterval', Long(123))

次の例では、カスタムMbeanのMyBooleanAttribute属性のブール値をtrueに設定しています。

wls:/mydomain/serverConfig> set('MyBooleanAttribute', Boolean(true))

setOption

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オフライン

説明

WebLogicドメインの作成または更新に関連するオプションを設定します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

setOption(optionName, optionValue)

引数

定義

optionName

設定するオプションの名前。

ドメインの作成で使用できるオプションは次のとおりです:

- CreateStartMenu - Windowsプラットフォームの[スタート]メニューにショートカットを作成するかどうかを指定するブール値。このオプションのデフォルトはtrueです。
注意: 管理者権限を持つユーザーがソフトウェアをインストールして、「All Users」フォルダに「スタート」メニューのエントリを作成した場合は、管理者権限を持つユーザーのみが、構成ウィザードまたはWLSTを使用してWebLogicドメインを作成するときに、同じフォルダに「スタート」メニューのエントリを作成できます。つまり、管理者権限を持たないユーザーが、このインストールから構成ウィザードまたはWLSTを使用してドメインを作成しても、そのドメインへの「スタート」メニューのショートカットは作成されません。この場合は、必要に応じて、ローカルの「スタート・メニュー」フォルダに手動でショートカットを作成できます。

- DomainName - WebLogicドメインの名前。デフォルトでは、WebLogicドメインの名前はドメイン・ディレクトリの名前から取られます。たとえば、WebLogicドメインがc:/Oracle/Middleware/user_projects/domains/myMedrecに保存される場合、ドメイン名はmyMedrecになります。DomainNameを設定すると、作成されたドメインの名前がドメイン・ディレクトリ名に依存することはなくなります。

- JavaHome - サーバーの起動時に使用するJVMのホーム・ディレクトリ。このオプションのデフォルトは、WebLogic Serverをインストールしているプラットフォームによって異なります。

- OverwriteDomain - 既存のWebLogicドメインを上書き可能にするかどうかを指定するブール値。このオプションのデフォルトはfalseです。

- ServerStartMode - 新規作成したWebLogicドメインでサーバーを起動するときに使用するモード。この値は、dev (開発)またはprod (本番)に設定できます。このオプションのデフォルトはdevです。

ドメインの更新で使用できるオプションは次のとおりです:

- AllowCasualUpdate - 拡張テンプレートを追加せずに、WebLogicドメインの更新を許可するかどうかを指定するブール値。このオプションのデフォルトはtrueです。

- ReplaceDuplicates - 競合があった場合に、WebLogicドメインの元の構成の要素を保持するか、拡張テンプレートの対応する要素で置き換えるかを指定するブール値。このオプションのデフォルトはtrueです。

ドメインの作成とドメインの更新の両方で使用できるオプションは次のとおりです:

- AppDir - 指定されたテンプレートに従って、アプリケーションに別のディレクトリが必要な場合に使用するアプリケーション・ディレクトリ。このオプションのデフォルトは、WL_HOME/user_projects/applications/domainnameになります。WL_HOMEはWebLogic Serverホーム・ディレクトリ、domainnameはWebLogicドメインの名前を表します。

- AutoAdjustSubDeploymentTarget - WLSTが、AppDeploymentsのサブデプロイメントの対象を自動的に調整するかどうかを指定するブール値。このオプションのデフォルトはtrueです。この機能を無効にするには、オプションをfalseに設定して、WebLogicドメインまたはドメイン・テンプレートを書き込むか更新する前に、AppDeploymentのサブデプロイメントの対象を明示的に設定します。

- AutoDeploy - クラスタまたは複数の管理対象サーバーを作成するときに、自動デプロイメントをアクティブにするかどうかを指定するブール値。このオプションのデフォルトはtrueです。この機能を無効にするには、スクリプトの最初の行でこのオプションをfalseに設定します。

optionValue

オプションの値。

注意: ブール値は、文字列(true、false)または整数(0、1)として指定できます。

例

次の例では、CreateStartMenuオプションをfalseに設定します。

wls:/offline> setOption('CreateStartMenu', 'false')

showChanges

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オンライン

説明

現在の編集セッション中に現在のユーザーが行った構成の変更内容を表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

showChanges([onlyInMemory])

引数

定義

onlyInMemory

オプション。まだ保存されていない変更のみを表示するかどうかを指定するブール値。この引数のデフォルトはfalseで、セッションの最初から行われたすべての変更が表示されることを表します。

例

次の例では、現在の編集セッションが開始されてから、現在のユーザーが構成に加えたすべての変更が表示されます。

wls:/mydomain/edit !> showChanges()
Changes that are in memory and saved to disc but not yet activated are:

MBean Changed           : com.bea:Name=basicWLSDomain,Type=Domain
Operation Invoked       : add
Attribute Modified      : Machines
Attributes Old Value    : null
Attributes New Value    : Mach1
Server Restart Required : false

MBean Changed           : com.bea:Name=basicWLSDomain,Type=Domain
Operation Invoked       : add
Attribute Modified      : Servers
Attributes Old Value    : null
Attributes New Value    : myserver
Server Restart Required : false

startEdit

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オンライン

説明

現在接続しているユーザーのために構成編集セッションを開始します。このコマンドを発行する前に、editコマンドを使用して構成MBean階層に移動する必要があります。詳細は、「edit」を参照してください。

WebLogicドメイン構成を変更するコマンドを呼び出す前に、このコマンドを呼び出す必要があります。

エラーが発生した場合は、WLSTExceptionが返されます。

注意:

同じユーザーによる進行中の編集セッションがあることを検出した場合、WLSTは自動的に編集セッションを開始します。進行中のセッションは管理コンソールまたは別のWLSTセッションから開始された可能性があります。

構文

startEdit([waitTimeInMillis], [timeoutInMillis], [exclusive])

引数

定義

waitTimeInMillis

オプション。別のユーザーがロックを保持している場合に、WLSTがロックを取得するまでに待機する時間(ミリ秒単位)。この引数のデフォルトは0ミリ秒です。

timeOutInMillis

オプション。WLSTが編集ロックの解放を待機するタイムアウト(ミリ秒単位)。この引数のデフォルトは -1ミリ秒で、この編集セッションが期限切れにならないことを表します。

exclusive

オプション。編集セッションを排他的なセッションにするかどうかを指定します。trueに設定した場合、同じ所有者がstartEditコマンドを入力すると、WLSTは新しい編集セッションを開始する前に、現在の編集セッションのロックが解放されるまで待機します。排他的なロックはtimeoutInMillisで指定された時間に従ってタイムアウトします。この引数のデフォルトはfalseです。

例

次の例では、まだディスクに保存されていない編集内容を保存します。

wls:/mydomain/edit> startEdit(60000, 120000)
Starting an edit session ...
Started edit session, please be sure to save and activate your changes once you are done.
wls:/mydomain/edit !>

stopEdit

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オンライン

説明

編集セッションを停止して、編集ロックを解放し、未保存の変更を破棄します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

stopEdit([defaultAnswer])

引数

定義

defaultAnswer

オプション。コマンド行で入力を求められたくない場合の、デフォルトのレスポンス。有効な値はyおよびnです。この引数のデフォルトはnullです。nullの場合、WLSTはユーザーにレスポンスを求めます。

例

次の例では、現在の編集セッションを停止します。WLSTは取り消す前に確認を求めます。

wls:/mydomain/edit !> stopEdit()
Sure you would like to stop your edit session? (y/n)
y
Edit session has been stopped successfully.
wls:/mydomain/edit>

unassign

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オフライン

説明

1つまたは複数の宛先からアプリケーションまたはリソースの割当てを解除します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

unassign(sourceType, sourceName, destinationType, destinationName)

引数

定義

sourceType

割当て解除する構成Beanのタイプ。この値は、次のいずれかの値に設定できます。

- AppDeployment

- Library

- securityType(Userなど)

- Server

- service(JDBCSystemResourceなど)

- service.SubDeployment。serviceには、SubDeploymentのサービス・タイプを指定します(JMSSystemResource.SubDeploymentなど)。ネストされたサブデプロイメントも指定できます(AppDeployment.SubDeployment.SubDeploymentなど)。

sourceName

割当てを解除するアプリケーションまたはリソースの名前。複数の名前をカンマで区切って指定することも、ワイルドカード(*)を使って指定されたタイプのすべてのリソースを指定することも可能です。

サブデプロイメントはservice.subDeploymentという形式で指定します。serviceには親サービス、subDeploymentにはサブデプロイメントの名前を指定します。たとえば、myJMSResource.myQueueSubDeployment。ネストされたサブデプロイメントも指定できます(MedRecEAR.MedRecAppScopedJMS.MedRecJMSServerなど)。

destinationType

宛先のタイプ。この値の設定のガイドラインについては次を参照してください。

destinationName

宛先の名前。複数の名前をカンマで区切って指定できます。

sourceTypeおよびdestinationTypeの設定では次のガイドラインを使用してください。

- アプリケーション・デプロイメントを割当て解除するときは、次のように値を設定します。

- sourceType: AppDeployment

- destinationType: Target

- ライブラリを割当て解除するときは、次のように値を設定します。

- sourceType: Library

- destinationType: Target

- セキュリティ・タイプを割当て解除するときは、次のように値を設定します。

- sourceType: 特定のセキュリティ・タイプの名前(Userなど)

- destinationType: 宛先のセキュリティ・タイプの名前(Groupなど)

- クラスタからサーバーを割当て解除するときは、次のように値を設定します。

- sourceType: Server

- destinationType: Cluster

- サービスを割当て解除するときは、次のように値を設定します。

- sourceType: 特定のサーバーの名前(JDBCSystemResourceなど)

- destinationType: Target

- サブデプロイメントを割当て解除するときは、次のように値を設定します。

- sourceType: service.SubDeployment。serviceにはSubDeploymentの親を指定します(JMSSystemResource.SubDeploymentなど)。ネストされたサブデプロイメントも指定できます(AppDeployment.SubDeployment.SubDeploymentなど)。

- destinationType: Target

例

例:

- myServerとmyServer2をクラスタmyClusterから割当て解除します。

wls:/offline/medrec> unassign("Server", "myServer,myServer2", "Cluster", "myCluster")

- すべてのサーバーをクラスタmyClusterから割当て解除します。

wls:/offline/mydomain> unassign("Server", "*", "Cluster", "myCluster")

- ユーザーnewUserをグループMonitorsから割当て解除します。

wls:/offline/medrec> unassign("User", "newUser", "Group", "Monitors")

- アプリケーション・デプロイメントmyAppDeploymentをターゲット・サーバーnewServerから割当て解除します。

wls:/offline/mydomain> unassign("AppDeployment", "myAppDeployment", "Target", "newServer")

- ネストされたサブデプロイメントMedRecAppScopedJMS.MedRecJMSServer (アプリケーション・デプロイメントAppDeploymentの子)をターゲット・サーバーAdminServerから割当て解除します。

wls:/offline/mydomain> assign('AppDeployment.SubDeployment.SubDeployment',
'MedRecEAR.MedRecAppScopedJMS.MedRecJMSServer', 'Target','AdminServer')

undo

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オンライン

説明

保存またはアクティブ化されていない編集をすべて元に戻します。

(ディスクに保存されたものも含めて)アクティブ化されていないすべての編集を元に戻すか、または、最後のsave操作以降に行われたすべての編集を元に戻すかを指定します。このコマンドでは編集セッションは解放されません。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

undo([unactivatedChanges], [defaultAnswer])

引数

定義

unactivatedChanges

オプション。ディスクに保存された編集内容も含めて、アクティブ化されていないすべての変更を元に戻すかどうかを指定するブール値。この引数のデフォルトはfalseで、最後のsave操作以降に行われたすべての編集を元に戻すことを表します。

defaultAnswer

オプション。コマンド行で入力を求められたくない場合の、デフォルトのレスポンス。有効な値はyおよびnです。この引数のデフォルトはnullです。nullの場合、WLSTはユーザーにレスポンスを求めます。

例

次の例では、最後のsave操作以降に行われたすべての変更を元に戻します。WLSTは元に戻す前に確認を求めます。

wls:/mydomain/edit !> undo()
Sure you would like to undo your changes? (y/n)
y
Discarded your in-memory changes successfully.
wls:/mydomain/edit>

次の例では、アクティブ化されていないすべての変更を元に戻します。WLSTは元に戻す前に確認を求めます。

wls:/mydomain/edit !> undo('true')
Sure you would like to undo your changes? (y/n)
y
Discarded all your changes successfully.
wls:/mydomain/edit>

validate

コマンド・カテゴリ: 編集コマンド

WLSTでの使用: オンライン

説明

変更されてまだ保存されていない変更内容を検証します。このコマンドを使用すると、保存する前に、すべての変更が有効かどうかを検証することができます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

validate()

例

次の例では、変更されてまだ保存されていないすべての変更内容を検証します。

wls:/mydomain/edit !> validate()
Validating changes ...
Validated the changes successfully

情報コマンド

表3-8に示すWLST情報コマンドを使用して、ドメイン、サーバー、変数に照会したり、構成Bean、実行時Bean、WLSTに関連した情報を提供したりします。

表3-8 WLST構成の情報コマンド

コマンド

説明

WLSTの使用...

addListener

指定されたMBeanにJMXリスナーを追加します。

オンライン

configToScript

既存のサーバー構成(configディレクトリ)を実行可能なWLSTスクリプトに変換します

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

dumpStack

WLSTアクションの実行中に発生した最近の例外のスタック・トレースを表示して、スタック・トレースをリセットします。

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

dumpVariables

WLSTによって使用されたすべての変数を、その名前と値を含めて表示します。

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

find

現在の階層内でMBeanと属性を検索します。

オンライン

getConfigManager

変更プロセスを管理している最新のConfigurationManagerBean MBeanを返します。

オンライン

getMBean

指定されたパスを参照してMBeanを返します。

オンライン

getMBI

指定されたMBeanTypeまたはcmo変数のMBeanInfoを返します。

オンライン

getPath

指定されたMBeanインスタンスのMBeanパスを返します。

オンライン

listChildTypes

cmoタイプで作成または削除できるすべての子MBeanを表示します。

オンライン

lookup

指定されたMBeanをルックアップします。

オンライン

ls

現在の構成Beanまたは実行時Beanのすべての子Beanと属性を表示します。

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

man

現在のMBeanまたはそのMBeanの指定された属性に関する、MBeanInfoのヘルプを表示します。

オンライン

redirect

WLST出力を指定されたファイル名にリダイレクトします。

オンライン

removeListener

以前に定義したリスナーを削除します。

オンライン

showListeners

現在定義されているすべてのリスナーを表示します。

オンライン

startRecording

WLSTとユーザーのすべての対話を記録します。再試行するコマンドの捕捉に便利。

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

state

ノード・マネージャを使用して、サーバーまたはクラスタとその状態のマップを返します。

オンライン

stopRecording

WLSTコマンドの記録を停止します。

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

stopRedirect

WLST出力のファイルへのリダイレクトを停止します。

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

storeUserConfig

ユーザー構成ファイルと、関連付けられたキー・ファイルを作成します。

オンライン

threadDump

指定されたサーバーのスレッド・ダンプを表示します。

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

viewMBean

属性名と属性値、操作など、MBeanに関する情報を表示します。

オンライン

writeIniFile

WLST定義およびメソッド宣言をPython (.py)ファイルに変換します。

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

addListener

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

指定されたMBeanにJMXリスナーを追加します。MBeanで変更が行われると、その内容が標準出力に報告されて、指定された構成ファイルに保存されます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

addListener(mbean, [attributeNames], [logFile], [listenerName])

引数

定義

mbean

リスンするMBeanまたはMBeanオブジェクトの名前。

attributeNames

オプション。JMXリスナーを追加するすべての属性名のカンマ区切りのリスト。この引数のデフォルトはnullで、すべての属性にJMXリスナーが追加されます。

logFile

オプション。リスナー情報を書き込むログ・ファイルの名前と場所です。この引数のデフォルトは標準出力です。

listenerName

オプション。JMXリスナーの名前。この引数のデフォルトは、WLSTで生成される名前です。

例

次の例では、cmo MBeanで、NotesおよびArchiveConfigurationCount属性に対してJMXリスナーを定義します。リスナーの名前はdomain-listenerで、./listeners/domain.logに保存されます。

wls:/mydomain/serverConfig> addListener(cmo, "Notes,ArchiveConfigurationCount",
"./listeners/domain.log","domain-listener")

configToScript

コマンド・カテゴリ: 情報コマンド

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

既存のサーバー構成(configディレクトリ)を実行可能なWLSTスクリプトに変換します。その結果得られたスクリプトは、他のサーバー上のリソースの再作成に使用できます。

configToScriptコマンドでは次のファイルが作成されます。

- 構成の再作成に必要なコマンドが格納されているWLSTスクリプト。

- ドメイン固有の値が格納されているプロパティ・ファイル。このファイルの値を更新すると、元の構成に似た新しいドメインを作成することができます。

- 暗号化された属性を格納するユーザー構成ファイルおよび関連キー・ファイル。ユーザー構成ファイルには暗号化された情報が格納されます。キー・ファイルには、情報の暗号化と復号化に使用される秘密鍵が格納されます。

生成されたスクリプトを実行すると、次の処理が行われます。

- サーバーが現在実行中であれば、WLSTはプロパティ・ファイル内の値を使用して接続を確立し、次にスクリプト・コマンドを実行して、サーバー・リソースを作成しようとします。

- 現在実行されているサーバーがなければ、WLSTはプロパティ・ファイル内の値でサーバーを起動し、スクリプト・コマンドを実行してサーバー・リソースを作成し、サーバーを停止します。これにより、WLSTがコマンド・シェルを終了させることがあります。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

configToScript([configPath], [pyPath], [overwrite], [propertiesFile], [createDeploymentScript])

引数

定義

configPath

オプション。変換する構成が格納されたdomainディレクトリのパス。この引数のデフォルトは、WLSTの起動元ディレクトリ(./)です。

pyPath

オプション。変換後のWLSTスクリプトを書き込むパスとファイル名。この引数のデフォルトは/config/config.pyです。

overwrite

オプション。スクリプト・ファイルがすでに存在する場合、そのファイルを上書きするかどうかを指定するブール値。この引数のデフォルトはtrueで、スクリプト・ファイルは上書きされます。

propertiesFile

オプション。WLSTがプロパティ・ファイルを書き込むパスとディレクトリ。この引数のデフォルトは、scriptPath引数で指定されたパス名です。

createDeploymentScript

オプション。WLSTがデプロイメントのみを実行するスクリプトを作成するかどうかを指定するブール値。この引数のデフォルトはfalseで、デプロイメント・スクリプトが作成されないことを表します。

例

次の例では、構成をWLSTスクリプトconfig.pyに変換します。デフォルトで、構成ファイルは./configからロードされて、スクリプト・ファイルは.config/config.pyに、プロパティ・ファイルは.config/config.py.propertiesに保存されます。

wls:/offline> configToScript()
configToScript is loading configuration from c:\Oracle\Middleware
\user_projects\domains\wls\config\config.xml ...
Completed configuration load, now converting resources to wlst script...
configToScript completed successfully
The WLST script is written to c:\Oracle\Middleware
\user_projects\domains\wls\config\config.py
and the properties file associated with this script is written to c:\Oracle\
Middleware\user_projects\domains\wls\config\config.py.properties
wls:/offline>

次の例では、ファイルc:\Oracle\Middleware\user_projects\domains\mydomain\configディレクトリで構成されたサーバー・リソースをWLSTスクリプトc:\Oracle\Middleware\myscripts\config.pyに変換します。

wls:/offline> configToScript('c:/Oracle/Middleware/user_projects/domains
/mydomain','c:/Oracle/Middleware/myscripts')
configToScript is loading configuration from c:\Oracle\Middleware
\user_projects\domains\mydomain\config\config.xml ...
Completed configuration load, now converting resources to wlst script...
configToScript completed successfully
The WLST script is written to c:\Oracle\Middleware\myscripts\config.py
and the properties file associated with this script is written to
c:\Oracle\Middlware\mydomain\config.py.properties
wls:/offline>

dumpStack

コマンド・カテゴリ: 情報コマンド

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

説明

WLSTアクションの実行中に発生した最近の例外のスタック・トレースを表示して、スタック・トレースをリセットします。

成功した場合、dumpstackコマンドはThrowableオブジェクトを返します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

dumpStack()

例

この例ではスタック・トレースを表示します。

wls:/myserver/serverConfig> dumpStack()
com.bea.plateng.domain.script.jython.WLSTException: java.lang.reflect.Invocation TargetException
...

dumpVariables

コマンド・カテゴリ: 情報コマンド

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

説明

WLSTによって使用されたすべての変数を、その名前と値を含めて表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

dumpVariables()

例

この例では、現在のすべての変数とその値を表示します。

wls:/mydomain/serverConfig> dumpVariables()
adminHome   weblogic.rmi.internal.BasicRemoteRef - hostID:
'-1 108080150904263937S:localhost:[7001,8001,-1,-1,-1,-1,-1]:
mydomain:AdminServer', oid: '259', channel: 'null'
cmgr   [MBeanServerInvocationHandler]com.bea:Name=ConfigurationManager,
Type=weblogic.management.mbeanservers.edit.ConfigurationManagerMBean
cmo   [MBeanServerInvocationHandler]com.bea:Name=mydomain,Type=Domain
connected true
domainName mydomain
...
wls:/mydomain/serverConfig>

find

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

現在の階層内でMBeanと属性を検索します。

WLSTは、属性または属性タイプとその値を格納するMBeanのパス名を返します。searchInstancesOnlyをfalseに設定した場合は、サーバーでインスタンス化されていないものの、作成が可能なMBeanTypeパスの検索も行います。エラーが発生した場合は、WLSTExceptionが返されます。

構文

find([name], [type], [searchInstancesOnly])

引数

定義

name

オプション。検索する属性の名前。

type

オプション。検索する属性のタイプ。

searchInstancesOnly

オプション。登録されたインスタンスのみを検索するか、または、サーバーでインスタンス化されていないものの、作成が可能なMBeanTypesパスも検索するかどうかを指定するブール値。この引数のデフォルトはtrueで、登録されたインスタンスのみが検索されます。

例

次の例では、現在の構成階層でjavaCompilerという属性を検索します。

wls:/mydomain/serverConfig> find(name = 'JavaCompiler')
Finding 'JavaCompiler' in all registered MBean instances ...
/Servers/AdminServer                         JavaCompilerPreClassPath      null
/Servers/AdminServer                       JavaCompiler                  java
/Servers/AdminServer                      JavaCompilerPostClassPath   null
wls:/mydomain/serverConfig>

次の例では、現在の構成階層でJMSRuntimeタイプの属性を検索します。

wls:/mydomain/serverRuntime> find(type='JMSRuntime')
Finding MBean of type 'JMSRuntime' in all the instances ...
/JMSRuntime/AdminServer.jms
wls:/mydomain/serverRuntime>

次の例では、現在の構成階層でexecuteという属性を検索します。searchInstancesOnly引数はfalseに設定されており、サーバーでインスタンス化されていないMBeanTypeも検索することを示しています。

wls:/mydomain/serverConfig> find(name='execute', searchInstancesOnly='false')
Finding 'execute' in all registered MBean instances ...
/Servers/AdminServer      ExecuteQueues [Ljavax.management.ObjectName;@1aa7dbc
/Servers/AdminSever       Use81StyleExecuteQueues                            false
Now finding 'execute' in all MBean Types that can be instantiated ...
/Servers                                      ExecuteQueues
/Servers                                      Use81StyleExecuteQueues
wls:/mydomain/serverConfig>

getConfigManager

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

変更プロセスを管理している最新のConfigurationManager MBeanを返します。そのメソッドを呼び出して、WebLogicドメイン内の構成の変更を管理できます。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getConfigManager()

例

次の例では、最新のConfigurationManagerBean MBeanを返して、cm変数に格納します。

wls:/mydomain/serverConfig> cm=getConfigManager()
wls:/mydomain/serverConfig> cm.getType()
'weblogic.management.mbeanservers.edit.ConfigurationManagerMBean'

getMBean

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

指定されたパスを参照してMBeanを返します。エラーが発生した場合は、WLSTExceptionが返されます。

注意:

MBeanが見つからない場合に例外はスローされません。

構文

getMBean(mbeanPath)

引数

定義

mbeanPath

現在の階層内のMBeanのパス名。

例

次の例では、パスで指定されたMBeanを返します。

wls:/mydomain/edit !> com=getMBean('Servers/myserver/COM/myserver')
wls:/mydomain/edit !> com.getType()
'Server'

getMBI

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

指定されたMBeanTypeまたはcmo変数のMBeanInfoを返します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getMBI([mbeanType])

引数

定義

mbeanType

オプション。MBeanInfoを表示するMBeanType。

例

次の例では、指定されたMBeanTypeのMBeanInfoを取得して、svrMbi変数に格納します。

wls:/mydomain/serverConfig> svrMbi=getMBI('weblogic.management.configuration.ServerMBean')

getPath

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

現在のツリーで、指定されたMBeanインスタンスのMBeanパスまたはMBeanのObjectNameを返します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getPath(mbean)

引数

定義

mbean

MBeanパスを返す、現在のツリー内のMBeanのMBeanインスタンスまたはObjectName。

例

次の例では、パスで指定されたMBeanを返します。

wls:/mydomain/edit !> path=getPath('com.bea:Name=myserver,Type=Server')
wls:/mydomain/edit !> print path
'Servers/myserver'

listChildTypes

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

cmoで作成または削除できるすべての子MBeanを表示します。cmo変数は、WLSTを使用して最後に移動した構成Beanインスタンスを表します。cmo変数の詳細は、『Oracle WebLogic Scripting Tool』の現在の管理オブジェクトの変更に関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

listChildTypes([parent])

引数

定義

parent

オプション。子タイプを表示する親タイプ。

例

次の例では、cmoタイプで作成または削除できる子MBeanを表示します。

wls:/mydomain/serverConfig> listChildTypes()
AppDeployments
BridgeDestinations
CachingRealms
Clusters
...
wls:/mydomain/serverConfig>

lookup

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

指定されたMBeanをルック・アップします。MBeanは現在のMBeanの子でなければなりません。エラーが発生した場合は、WLSTExceptionが返されます。

構文

lookup(name, [childMBeanType])

引数

定義

name

ルック・アップするMBeanの名前。

childMBeanType

オプション。ルック・アップするMBeanのタイプ。

例

次の例では、指定されたサーバーmyserverをルック・アップして、返されたスタブをsbean変数に格納します。

wls:/mydomain/serverConfig> sbean=lookup('myserver','Server')
wls:/mydomain/serverConfig> sbean.getType()
'Server'
wls:/mydomain/serverConfig>

ls

コマンド・カテゴリ: 情報コマンド

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

説明

指定した管理オブジェクトの属性、操作、および子の管理オブジェクトをリストします。

エラーが発生した場合は、WLSTExceptionが返されます。

デフォルトでは、出力は文字列として返され、3つの列に配列されます。

- 1列目には、リストされた項目を説明する一連のコードが表示されます。表3-9を参照してください。

- 2列目には、項目の名前が表示されます。

- 項目が属性である場合、3列目には、その属性値が表示されます。属性が暗号化されている場合、3列目には、値のかわりにアスタリスクが表示されます。(『Oracle WebLogic Scripting Tool』の暗号化された構成値の読み書きに関する項を参照してください。)

- 項目が操作である場合、3列目には、次の形式でその操作の戻り値の型と入力パラメータが表示されます。returnType: parameterType(parameterName)

表3-9 lsコマンド出力情報

コード

説明

d

項目が子の管理オブジェクトであることを示します。

UNIXまたはWindowsのファイル・システムにおけるディレクトリと同様に、cdコマンドを使用して子オブジェクトを現在の管理オブジェクトにすることができます。

r

項目が子の管理オブジェクト、または読取り可能な属性であることを示します(セキュリティ・レルムのポリシーによって現在のユーザーに読取りパーミッションが付与されていることが前提)。(Oracle WebLogic Server MBeanリファレンスのMBeanのデフォルト・セキュリティ・ ポリシーに関する項を参照してください。)

w

項目が書込み可能な属性であることを示します(セキュリティ・レルムのポリシーによって現在のユーザーに書込みパーミッションが付与されていることが前提)。(Oracle WebLogic Server MBeanリファレンスのMBeanのデフォルト・セキュリティ・ ポリシーに関する項を参照してください。)

x

項目が実行可能な操作であることを示します(セキュリティ・レルムのポリシーによって現在のユーザーに実行パーミッションが付与されていることが前提)。(Oracle WebLogic Server MBeanリファレンスのMBeanのデフォルト・セキュリティ・ ポリシーに関する項を参照してください。)

デフォルトの出力では、現在の管理オブジェクトのすべての属性、操作、および子の管理オブジェクトがリストされます。出力をフィルタリングする、または異なる管理オブジェクトのリストを表示するには、コマンドの引数を指定します。

注意:

パフォーマンスを最適化するため、WLSTオフラインを使用する場合、WebLogic Serverのデフォルト値のほとんどは、WebLogicドメインの構成ファイルには格納されません。この最適化が原因で、WLSTオフラインでは管理オブジェクト全体を表示できない場合があります(WebLogic Serverでは対応するXML要素をドメインの構成ファイルに書き込んでいないため)。たとえば、ドメインがアクティブであるときにWebLogicドメインのロギングのデフォルト重大度を変更しなかった場合、WLSTオフラインではドメインのLog管理オブジェクトは表示されません。

WLSTオフラインで表示されない管理オブジェクトの属性のデフォルト値を変更する場合、最初にcreateコマンドを使用して管理オブジェクトを作成する必要があります。次に、cdを使用して管理オブジェクトに移動し、属性値を変更します。「create」を参照してください。

構文

ls( [ a | c | o ] [ moPath ])

ls( [ moPath ] returnMap [ returnType ] )

引数

定義

a

オプション。指定した管理オブジェクトの属性のみ表示します(他の項目の表示は抑制されます)。

c

オプション。指定した管理オブジェクトの子の管理オブジェクトのみ表示します(他の項目の表示は抑制されます)。

o

オプション。指定した管理オブジェクトで呼出し可能な操作のみ表示します(他の項目の表示は抑制されます)。

この引数は、WLSTオンラインにのみ適用できます。

moPath

オプション。リストする属性、操作、および子の管理オブジェクトの管理オブジェクトへのパス名。

階層の現在の場所に対して相対的なパス名を指定することも、絶対パス名を指定することも可能です。

WLSTオフラインでは、フォワード・スラッシュ(/)を使用して構成ドキュメントのルートを指定します。

WLSTオンラインでは、任意の管理階層のMBeanの内容をリストできます(「ツリー・コマンド」を参照)。次の構文を使用して、階層のルートを指定してください。

root-name:/

たとえば、サーバーの実行時階層のルートを示す例を次に示します。

ls('serverRuntime:/')

この引数を指定しない場合、現在の管理オブジェクトの項目がリストされます。

returnMap

オプション。コマンドで値をマップとして返すかどうかを指定するブール値。この引数のデフォルトはfalseです(コマンドでは文字列が返されます)です。

returnType

オプション。マップで返される出力を制御します。この表の冒頭で説明した、出力をフィルタリングするa、c、またはoを指定します。

この引数は、returnMapがtrueに設定されている場合にのみ有効です。この引数のデフォルトはcです。

例

次の例では、examplesドメインの、すべての子構成Beanと属性名および値を表示します。このドメインはWLSTオフライン・モードでメモリーにロードされています。

wls:/offline/mydomain > ls()
dr--   AppDeployments
dr--   BridgeDestinations
dr--   Clusters
dr--   CustomResources
dr--   DeploymentConfiguration
dr--   Deployments
dr--   EmbeddedLDAP
dr--   ErrorHandlings
dr--   FileStores
dr--   InternalAppDeployments
dr--   InternalLibraries
dr--   JDBCDataSourceFactories
dr--   JDBCStores
dr--   JDBCSystemResources
dr--   JMSBridgeDestinations
dr--   JMSInteropModules
dr--   JMSServers
dr--   JMSSystemResources
dr--   JMX
...
wls:/offline/examples>

次の例では、DomainMBeanドメインのすべての属性名と値を表示します。

wls:/mydomain/serverConfig> ls('a')
-r--   AdminServerName                              AdminServer
-r--   AdministrationMBeanAuditingEnabled           false
-r--   AdministrationPort                           9002
-r--   AdministrationPortEnabled                    false
-r--   AdministrationProtocol                       t3s
-r--   ArchiveConfigurationCount                    0
-r--   ClusterConstraintsEnabled                    false
-r--   ConfigBackupEnabled                          false
-r--   ConfigurationAuditType                       none
-r--   ConfigurationVersion                         9.0.0.0
-r--   ConsoleContextPath                           console
-r--   ConsoleEnabled                               true
-r--   ConsoleExtensionDirectory                    console-ext
-r--   DomainVersion                                9.0.0.0
-r--   LastModificationTime                         0
-r--   Name                                         basicWLSDomain
-r--   Notes                                        null
-r--   Parent                                       null
-r--   ProductionModeEnabled                        false
-r--   RootDirectory                                .
-r--   Type                                         Domain
wls:/mydomain/serverConfig>

次の例では、Servers MBeanのすべての子Beanと属性名および値を表示します。

wls:/mydomain/serverConfig> ls('Servers')
dr--   AdminServer

次の例では、指定されたMBeanパスの属性名と値を表示し、その情報をマップで返します。

wls:/mydomain/serverConfig> svrAttrList = ls('edit:/Servers/myserver', 'true', 'a')
-rw-   AcceptBacklog                                50
-rw-   AdminReconnectIntervalSeconds                10
-rw-   AdministrationPort                           9002
-rw-   AdministrationProtocol                       t3s
-rw-   AutoKillIfFailed                             false
-rw-   AutoMigrationEnabled                         false
-rw-   AutoRestart                                  true
-rw-   COMEnabled                                   false
-rw-   ClasspathServletDisabled                     false
-rw-   ClientCertProxyEnabled                       false
-rw-   Cluster                                      null
-rw-   ClusterRuntime                               null
-rw-   ClusterWeight                                100
wls:/mydomain/serverConfig>

man

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

現在のMBeanまたはそのMBeanの指定された属性に関する、MBeanInfoのヘルプを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

man([attrName])

引数

定義

attrName

オプション。ヘルプを表示するMBean属性名。指定しない場合は、現在のMBeanのヘルプが表示されます。

例

次の例では、ServerMBean Beanに関するMBeanInfoのヘルプを表示します。

wls:/mydomain/serverConfig> man('Servers')
dynamic : true
creator : createServer
destroyer : destroyServer
description : <p>Returns the ServerMBeans representing the servers that have been
configured to be part of this domain.</p>
descriptorType : Attribute
Name : Servers
interfaceClassName : [Lweblogic.management.configuration.ServerMBean;
displayName : Servers
relationship : containment

redirect

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

WLSTの情報、エラー、およびデバッグに関する各メッセージを指定したファイル名にリダイレクトします。また、dumpStack()およびdumpVariables()コマンドの出力を、指定したファイル名にリダイレクトします。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

redirect(outputFile, [toStdOut])

引数

定義

outputFile

WLSTコマンドを記録するファイルの名前。ファイル名は、絶対パスでも、WLSTを起動したディレクトリを基準とする相対パスでもかまいません。

toStdOut

オプション。出力をstdoutに送信するかどうかを指定するブール値。この引数のデフォルトはtrueで、出力がstdoutに送信されることを表します。

例

次の例では、logs/wlst.logファイルへ、WLST出力のリダイレクトを開始します。

wls:/mydomain/serverConfig> redirect('./logs/wlst.log')

removeListener

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

以前に定義したリスナーを削除します。引数を指定しない場合は、すべてのMBeanで定義されたすべてのリスナーが削除されます。リスナーの設定の詳細は、「addListener」を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

removeListener([mbean], [listenerName])

引数

定義

mbean

オプション。以前に定義されたリスナーを削除するMBeanまたはMBeanオブジェクトの名前。

listenerName

オプション。削除するリスナーの名前。

例

次の例では、mylistenerというリスナーを削除します。

wls:/mydomain/serverConfig> removeListener(listenerName="mylistener")

showListeners

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

現在定義されているすべてのリスナーを表示します。リスナーの設定の詳細は、「addListener」を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

showListeners()

例

次の例では、現在定義されているすべてのリスナーを表示します。

wls:/mydomain/serverConfig> showListeners()

startRecording

コマンド・カテゴリ: 情報コマンド

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

説明

WLSTとユーザーのすべての対話を記録します。このコマンドは、再試行するコマンドの捕捉に役立ちます。

エラーが発生した場合は、WLSTExceptionが返されます。

『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、このコマンドは使用できません。

構文

startRecording(recordFile, [recordAll])

引数

定義

recordFile

WLSTコマンドを記録するファイルの名前。ファイル名は、絶対パスでも、WLSTを呼び出したディレクトリを基準とする相対パスでもかまいません。

recordAll

オプション。すべてのユーザー対話をファイルに捕捉するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合はWLSTコマンドのみが捕捉され、WLST以外のコマンド出力は捕捉されません。

例

次の例では、record.pyファイルにWLSTコマンドの記録を開始します。

wls:/mydomain/serverConfig> startRecording('c:/myScripts/record.py')
Starting recording to c:/myScripts/record.py
wls:/mydomain/serverConfig>

state

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

ノード・マネージャを使用して、サーバーまたはクラスタとその状態のマップを返します。ノード・マネージャが動作している必要があります。

サーバーの状態の詳細は、『Oracle WebLogic Serverサーバーの起動と停止の管理』のサーバーのライフサイクルの理解に関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

state(name, [type])

引数

定義

name

現在の状態を取得するサーバーまたはクラスタの名前。

type

オプション。タイプ。ServerまたはCluster。この引数のデフォルトはServerです。クラスタの状態を返す場合は、この引数を明示的にClusterに設定する必要があります。設定しない場合、コマンドは失敗します。

例

次の例では、管理対象サーバーmanaged1の状態を返します。

wls:/mydomain/serverConfig> state('managed1','Server')
Current state of "managed1": SUSPENDED
wls:/mydomain/serverConfig>

次の例では、クラスタmyclusterの状態を返します。

wls:/mydomain/serverConfig> state('mycluster','Cluster')
There are 3 server(s) in cluster: mycluster

States of the servers are
MServer1---SHUTDOWN
MServer2---SHUTDOWN
MServer3---SHUTDOWN
wls:/mydomain/serverConfig>

stopRecording

コマンド・カテゴリ: 情報コマンド

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

説明

WLSTコマンドの記録を停止します。記録の開始の詳細は、「startRecording」を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

stopRecording()

例

次の例では、WLSTコマンドの記録を停止します。

wls:/mydomain/serverConfig> stopRecording()
Stopping recording to c:\myScripts\record.py
wls:/mydomain/serverConfig>

stopRedirect

コマンド・カテゴリ: 情報コマンド

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

説明

WLST出力のファイルへのリダイレクトが行われている場合は、リダイレクトを停止します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

stopRedirect()

例

次の例では、WLST出力のファイルへのリダイレクトを停止します。

wls:/mydomain/serverConfig> stopRedirect()
WLST output will not be redirected to myfile.txt any more

storeUserConfig

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

ユーザー構成ファイルと、関連付けられたキー・ファイルを作成します。ユーザー構成ファイルには、暗号化されたユーザー名とパスワードが格納されます。キー・ファイルには、ユーザー名とパスワードの暗号化と復号化に使用される秘密鍵が格納されます。

最初にユーザー名とパスワードを暗号化したキー・ファイルのみが、その値の復号化に使用されます。キー・ファイルを失った場合には、新しいユーザー構成ファイルとキー・ファイルのペアを作成しなければなりません。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

storeUserConfig([userConfigFile], [userKeyFile], [nm])

引数

定義

userConfigFile

オプション。ユーザー構成を格納するファイルの名前。パス名は、絶対パスでも、WLSTを起動したファイル・システムのディレクトリを基準とする相対パスでもかまいません。

この引数を指定しない場合、ファイルは、現在のJVMで決定されるホーム・ディレクトリに格納されます。ホーム・ディレクトリの場所は、WLSTが実行されているオペレーティング・システムのSDKおよびタイプによって異なります。デフォルトのファイル名は次の形式に基づいています。

username - WebLogicConfig.properties

usernameは、オペレーティング・システムのログインに使用したユーザー名を表します。

また、ファイルを作成した場所が標準出力に出力されます。

userKeyFile

オプション。指定するユーザー構成ファイルに関連付けられているキー情報を格納するファイルの名前。パス名は、絶対パスでも、WLSTを起動したファイル・システムのディレクトリを基準とする相対パスでもかまいません。

この引数を指定しない場合、ファイルは、現在のJVMで決定されるホーム・ディレクトリに格納されます。ホーム・ディレクトリの場所は、WLSTが実行されているオペレーティング・システムのタイプおよびSDKによって異なります。デフォルトのファイル名は次の形式に基づいています。

username - WebLogicKey.properties

usernameは、オペレーティング・システムのログインに使用したユーザー名を表します。

また、ファイルを作成した場所が標準出力に出力されます。

nm

オプション。ノード・マネージャまたはWebLogic Serverのどちらのユーザー名とパスワードを格納するかを指定するブール値。trueに設定した場合は、ノード・マネージャのユーザー名とパスワードが格納されます。この引数のデフォルトはfalseです。

例

次の例では、デフォルトの場所に、ユーザー構成ファイルとキー・ファイルが作成および格納されます。

wls:/mydomain/serverConfig>  storeUserConfig()
Creating the key file can reduce the security of your system if it is not kept in
a secured location after it is created. Do you want to create the key file? y or n
y
The username and password that were used for this current WLS connection are
stored in C:\Documents and Settings\pat\pat-WebLogicConfig.properties
and C:\Documents and Settings\pat\pat-WebLogicKey.properties.

次の例では、指定された場所に、ユーザー構成ファイルとキー・ファイルが作成および格納されます。

wls:/mydomain/serverConfig>  storeUserConfig('c:/myFiles/myuserconfigfile.secure', 'c:/myFiles/myuserkeyfile.secure')
Creating the key file can reduce the security of your system if it is not kept in
a secured location after it is created. Do you want to create the key file? y or n
y
The username and password that were used for this current WLS connection are
stored in c:/myFiles/mysuserconfigfile.secure and c:/myFiles/myuserkeyfile.secure
wls:/mydomain/serverConfig>

threadDump

コマンド・カテゴリ: 情報コマンド

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

説明

指定されたサーバーのスレッド・ダンプを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

threadDump([writeToFile], [fileName], [serverName])

引数

定義

writeToFile

オプション。出力をファイルに保存するかどうかを指定するブール値。この引数のデフォルトはtrueで、出力はファイルに保存されます。

fileName

オプション。出力が書き込まれるファイルの名前。ファイル名は絶対パスでも、WLSTを実行しているディレクトリを基準とした相対パスでもかまいません。この引数のデフォルトはThread_Dump_serverNameファイルです。serverNameはサーバーの名前を表します。この引数は、writeToFileがtrueに設定されている場合にのみ有効です。

serverName

オプション。スレッド・ダンプをリクエストするサーバーの名前。この引数のデフォルトは、WLSTが接続しているサーバーになります。

管理サーバーに接続している場合は、管理サーバーと、WebLogicドメインで動作している任意の管理対象サーバーのスレッド・ダンプを表示できます。管理対象サーバーに接続している場合は、その管理対象サーバーのスレッド・ダンプのみを表示できます。

例

次の例では、現在のサーバーのスレッド・ダンプを表示して、出力をThread_Dump_serverNameファイルに保存します。

wls:/mydomain/serverConfig> threadDump()

次の例では、サーバーmanagedServerのスレッド・ダンプを表示します。情報はファイルに保存されません。

wls:/mydomain/serverConfig> threadDump(writeToFile='false', serverName='managedServer')

viewMBean

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

属性名と属性値、操作など、MBeanに関する情報を表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

viewMBean(mbean)

引数

定義

mbean

情報を表示するMBean。

例

次の例では、現在のMBean cmoに関する情報を表示します。

wls:/mydomain/serverConfig> cmo.getType()
'Domain'
wls:/mydomain/serverConfig> viewMBean(cmo)
Attribute Names and Values
--------------------------
XMLEntityCaches   null
Targets   javax.management.ObjectName[com.bea
:Name=MedRecJMSServer,Type=JMSServer,
com.bea:Name=WSStoreForwardInternalJMSServerMedRecServer,Type=JMSServer,
com.bea:Name=MedRecWseeJMSServer,Type=JMSServer,
com.bea:Name=PhysWSEEJMSServer,Type=JMSServer,
com.bea:Name=MedRecSAFAgent,Type=SAFAgent,
com.bea:Name=AdminServer,Type=Server]
RootDirectory                                .
EmbeddedLDAP                          com.bea:Name=OOTB_medrec,Type=EmbeddedLDAP
RemoteSAFContexts  null
Libraries   javax.management.ObjectName[com.bea
...
wls:/mydomain/serverConfig>

writeIniFile

コマンド・カテゴリ: 情報コマンド

WLSTでの使用: オンライン

説明

上級ユーザーがJythonモジュールとしてインポートできるように、WLST定義およびメソッド宣言をPython (.py)ファイルに変換します。インポートすると、その定義とメソッド宣言は他のJythonモジュールから使用できるようになり、Jython構文を使用して直接アクセスできます。詳細は、『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

writeIniFile(filePath)

引数

定義

filePath

変換された情報を保存するファイルのフル・パス名。

例

次の例では、WLSTをwl.pyというPythonファイルに変換します。

wls:/offline> writeIniFile("wl.py")
The Ini file is successfully written to wl.py
wls:/offline>

ライフサイクル・コマンド

表3-10に示すWLSTライフサイクル・コマンドを使用して、サーバー・インスタンスのライフサイクルを管理します。

サーバー・インスタンスのライフサイクルの詳細は、『Oracle WebLogic Serverサーバーの起動と停止の管理』のサーバーのライフサイクルの理解に関する項を参照してください。

表3-10 WLST構成のライフサイクル・コマンド

コマンド

説明

WLSTの使用...

migrate

クラスタ内のターゲット・サーバーにサービスを移行します。

オンライン

resume

一時停止された、またはADMIN状態にあるサーバー・インスタンスを再開します。

オンライン

shutdown

実行中のサーバー・インスタンスまたはクラスタを正常に停止します。

オンライン

start

ノード・マネージャを使用して管理対象サーバー・インスタンスまたはクラスタを起動します。

オンライン

startServer

管理サーバーを起動します。

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

suspend

実行中のサーバーを一時停止します。

オンライン

migrate

コマンド・カテゴリ: ライフサイクル・コマンド

WLSTでの使用: オンライン

説明

指定されたサービス(JTA、JMS、またはサーバー)を、クラスタ内のターゲット・サーバーに移行します。エラーが発生した場合は、WLSTExceptionが返されます。

サービスの移行の詳細は、『Oracle WebLogic Serverクラスタの使用』のサービスの移行に関する項を参照してください。

構文

migrate(sname, destinationName, [sourceDown], [destinationDown], [migrationType])

引数

定義

sname

サービスの移行元のサーバーの名前。

destinationName

サービスの移行先のマシンまたはサーバーの名前。

sourceDown

オプション。元のサーバーを停止するかどうかを指定するブール値。この引数のデフォルトはtrueで、元のサーバーが実行されていないことを示します。

JTAサービスを移行する場合、sourceDown引数が無視され、指定された場合、デフォルトはtrueです。JTAサービスを正常に移行するには、元のサーバーを停止する必要がある。

destinationDown

オプション。移行先のサーバーを停止するかどうかを指定するブール値。この引数のデフォルトはfalseで、移行先のサーバーが実行されていることを示します。

移行先が実行されておらず、この引数をtrueに設定しない場合、WLSTはMigrationExceptionを返します。

JMS関連サービスを実行されていないサーバー・インスタンスに移行する場合、サーバー・インスタンスは次の起動時にJMSサービスをアクティブ化します。JTAトランザクション回復サービスを実行されていないサーバー・インスタンスに移行する場合、ターゲット・サーバー・インスタンスは起動時に回復サービスを前提とします。

migrationType

オプション。移行するサービスのタイプ。有効な値は次のとおりです:

- jms - JMS関連サービス(JMSサーバー、SAFエージェント、パス・サービス、WebLogic永続ストアなど)のみを移行します。

- jta - JTAサービスのみを移行します。

- server - サーバー・サービスのみを移行します。

- all - すべてのJTAおよびJMSサービスを移行します。

この引数のデフォルトはallです。

例

次の例では、server1にあるすべてのJMSおよびJTAサービスをserver2に移行します。ブール値の引数では、元のサーバーが停止していて、移行先のサーバーが動作していることを指定します。

wls:/mydomain/edit !> migrate('server1','server2', 'true', 'false', 'all')
Migrating all JMS and JTA services from 'server1' to destination 'server2' ...
wls:/mydomain/edit !>

次の例では、server1にあるすべてのサーバー・サービスをserver2に移行します。ブール値の引数では、元のサーバーが停止していて、移行先のサーバーが動作していることを指定します。

wls:/mydomain/edit !> migrate('server1','server2', 'true', 'false', 'Server')
Migrating singleton server services from 'server1' to machine 'server2'...
wls:/mydomain/edit !>

resume

コマンド・カテゴリ: ライフサイクル・コマンド

WLSTでの使用: オンライン

説明

一時停止された、またはADMIN状態にあるサーバー・インスタンスを再開します。このコマンドはサーバーをRUNNING状態に移行します。サーバーの状態の詳細は、『Oracle WebLogic Serverサーバーの起動と停止の管理』のサーバーのライフサイクルの理解に関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

resume([sname], [block])

引数

定義

sname

再開するサーバーの名前。この引数のデフォルトは、WLSTが現在接続しているサーバーになります。

block

オプション。サーバーが再開されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトはfalseで、ユーザー対話がブロックされないことを示します。この場合、WLSTはコマンドを発行した後でユーザーに制御を返し、現在のタスクに関連付けられているタスクMBeanを変数に割り当てます。その変数を利用すると、タスクのステータスをチェックできます。『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。

例

次の例では、管理対象サーバー・インスタンスを再開します。

wls:/mydomain/serverConfig> resume('managed1', block='true')
Server 'managed1' resumed successfully.
wls:/mydomain/serverConfig>

shutdown

コマンド・カテゴリ: ライフサイクル・コマンド

WLSTでの使用: オンライン

説明

実行中のサーバー・インスタンスまたはクラスタを正常に停止します。shutdownコマンドは、進行中のすべての作業が完了するのを待機してから、サーバーまたはクラスタを停止します。

引数を指定しないでshutdownコマンドを入力すると、WLSTが接続しているサーバーが停止されます。

管理対象サーバー・インスタンスに接続している場合は、WLSTが接続している管理対象サーバー・インスタンスを停止するためにのみshutdownコマンドを使用できます。管理対象サーバー・インスタンスに接続しているときに、別のサーバーを停止することはできません。

WLSTはノード・マネージャを使用して管理対象サーバーを停止します。管理対象サーバーを停止するときは、ノード・マネージャが動作している必要があります。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

shutdown([name], [entityType], [ignoreSessions], [timeOut], [force], [block])

引数

定義

name

オプション。定義するサーバーまたはクラスタの名前。この引数のデフォルトは、WLSTが現在接続しているサーバーになります。

entityType

オプション。タイプ。ServerまたはCluster。この引数のデフォルトはServerです。クラスタを停止する場合は、この引数を明示的にClusterに設定する必要があります。設定しない場合、コマンドは失敗します。

ignoreSessions

オプション。停止時に、WLSTがすべてのHTTPセッションをただちに中止するか、または、HTTPセッションの完了(またはタイムアウト)を待機するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合は、すべてのHTTPセッションが完了(またはタイムアウト)する必要があります。

timeOut

オプション。サーバーを一時停止する前に、サーバーが進行中の作業を完了するのをWLSTが待機する時間(秒単位)。この引数のデフォルトは0秒で、タイムアウトがないことを表します。

force

オプション。WLSTが、アクティブなセッションの完了を待たずに、サーバー・インスタンスまたはクラスタを停止するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合は、すべてのアクティブ・セッションが完了してから停止します。

block

オプション。サーバーが停止されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトはfalseで、ユーザー対話がブロックされないことを示します。この場合、WLSTはコマンドを発行した後でユーザーに制御を返し、現在のタスクに関連付けられているタスクMBeanを変数に割り当てます。その変数を利用すると、タスクのステータスをチェックできます。『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。

例

次の例では、接続しているサーバーを停止するようにWLSTに指示します。

wls:/mydomain/serverConfig> shutdown()
Shutting down the admin server that you are currently connected to .......
Disconnected from weblogic server: AdminServer

次の例では、HTTPセッションが完了または(1000ミリ秒で)タイムアウトするのを1000秒待機してからmyserverを停止するように、WLSTに指示します。

wls:/mydomain/serverConfig> shutdown('myserver','Server','false',1000, block='false')

次の例では、管理対象サーバー・インスタンスに接続しているときに、すべてのHTTPセッションをただちに中止するように、WLSTに指示します。

wls:/mydomain/serverConfig> shutdown('MServer1','Server','true',1200)
Shutting down a managed server that you are connected to ...
Disconnected from weblogic server: MServer1

次の例では、クラスタmyclusterを停止するようにWLSTに指示します。

wls:/mydomain/serverConfig> shutdown('mycluster','Cluster')
Shutting down the cluster with name mycluster
Shutdown of cluster mycluster has been issued, please
refer to the logs to check if the cluster shutdown is successful.
Use the state(<server-name>) or state(<cluster-name>,"Cluster")
to check the status of the server or cluster
wls:/mydomain/serverConfig> state('mycluster','Cluster')
There are 3 server(s) in cluster: mycluster

States of the servers are
MServer1---SHUTDOWN
MServer2---SHUTDOWN
MServer3---SHUTDOWN
wls:/mydomain/serverConfig>

start

コマンド・カテゴリ: ライフサイクル・コマンド

WLSTでの使用: オンライン

説明

ノード・マネージャを使用して管理対象サーバー・インスタンスまたはクラスタを起動します。WLSTが管理サーバーに接続していて、ノード・マネージャが動作している必要があります。

ノード・マネージャに接続して使用するためのWLSTコマンドの詳細は、「ノード・マネージャ・コマンド」を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

start(name, [type], [url], [block])

引数

定義

name

起動する管理対象サーバーまたはクラスタの名前。

type

オプション。タイプ。ServerまたはCluster。この引数のデフォルトはServerです。クラスタを起動する場合は、この引数を明示的にClusterに設定する必要があります。設定しない場合、コマンドは失敗します。

url

オプション。サーバー・インスタンスのリスン・アドレスとリスン・ポート。[protocol://]listen-address:listen-portという形式で指定します。指定しない場合、この引数はデフォルトでt3://localhost:7001になります。

block

オプション。サーバーまたはクラスタが起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトはfalseで、ユーザー対話がブロックされないことを示します。この場合、WLSTはコマンドを発行した後でユーザーに制御を返し、現在のタスクに関連付けられているタスクMBeanを変数に割り当てます。その変数を利用すると、タスクのステータスをチェックできます。『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。

例

次の例では、ノード・マネージャに管理対象サーバー・インスタンスを起動するように指示します。リスン・アドレスはlocalhost、リスン・ポートは8801です。blockがfalseに設定されているので、WLSTはこのコマンドを発行した後で制御をユーザーに返します。

wls:/mydomain/serverConfig> start('myserver', 'Server', block='false')
Starting server myserver ...
Server with name myserver started successfully.
wls:/mydomain/serverConfig>

次の例では、ノード・マネージャにクラスタを起動するように指示します。blockはtrueに設定されているので、WLSTはクラスタが起動されるまでユーザーの対話をブロックします。

wls:/mydomain/serverConfig> start('mycluster', 'Cluster')
Starting the following servers in Cluster, mycluster: MS1, MS2, MS3...
......................................................................
All servers in the cluster mycluster are started successfully.
wls:/mydomain/serverConfig>

startServer

コマンド・カテゴリ: ライフサイクル・コマンド

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

説明

管理サーバーを起動します。エラーが発生した場合は、WLSTExceptionが返されます。

注意:

WL_HOME/common/binディレクトリからWLSTを実行し、startServerのみを使用してWebLogic管理サーバーを起動できます。startServerを使用して統合型のWebLogic管理サーバー(ORACLE_HOMEディレクトリにインストールされるFusion Middleware Suite製品の管理サーバー)を起動できません。

WebLogic Server以外のFusion Middleware Suite製品の管理サーバーを起動するには、次のいずれかの方法を使用します。

- 関連するWebLogicドメインのサーバー起動スクリプトを実行します。

- ノード・マネージャを使用して、サーバーを起動します。この方法を使用する場合、startScriptEnabledプロパティがノード・マネージャでtrueに設定されていることを確認します。

構文

startServer([adminServerName], [domainName], [url], [username], [password],
[domainDir], [block], [timeout], [serverLog], [systemProperties], [jvmArgs] [spaceAsJvmArgsDelimiter])

引数

定義

adminServerName

オプション。起動する管理サーバーの名前。この引数のデフォルトはmyserverです。

domainName

オプション。管理サーバーが属しているWebLogicドメインの名前。この引数のデフォルトはmydomainです。

url

オプション。管理サーバーのURL。startServerコマンドに指定したURLによって、config.xmlファイルに指定されたリスン・アドレスとリスン・ポートがオーバーライドされます。この引数がコマンド行またはconfig.xmlファイルに指定されていない場合は、デフォルトのt3://localhost:7001が使用されます。

username

オプション。WLSTをサーバーに接続するときのユーザー名。この引数のデフォルトはweblogicです。

password

オプション。WLSTをサーバーに接続するときのパスワード。この引数のデフォルトはwelcome1です。

domainDir

オプション。管理サーバーが起動されるドメイン・ディレクトリ。この引数のデフォルトは、WLSTの起動元ディレクトリです。

block

オプション。サーバーが起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。blockがfalseに設定されると、WLSTはコマンドを発行した後でユーザーに制御を返します。この引数のデフォルトはtrueで、ユーザー対話がブロックされることを示します。『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。

timeout

オプション。操作を取り消す前に、WLSTがサーバーの起動を待機する時間(ミリ秒単位)。デフォルト値は60000ミリ秒です。この引数は、blockがtrueに設定されている場合にのみ適用可能です。

serverLog

オプション。サーバー・ログ・ファイルの場所。この引数のデフォルトはstdoutです。

systemProperties

オプション。サーバー・プロセスに渡すシステム・プロパティ。システム・プロパティは、名前と値のペアをカンマで区切って指定します。名前と値は等号(=)で区切ります。

jvmArgs

オプション。サーバー・プロセスに渡すJVM引数。複数の引数をカンマで区切って指定できます。

spaceAsJvmArgsDelimiter

オプション。JVM引数がスペース区切りであるかどうかを示すブール値。デフォルト値はfalseです。

例

次の例では、demoDomainのdemoServerという管理サーバーを起動します。

wls:/offline> startServer('demoServer','demoDomain','t3://localhost:8001',
'myweblogic','wlstdomain','c:/mydomains/wlst','false', 60000,
jvmArgs='-XX:MaxPermSize=75m, -Xmx512m, -XX:+UseParallelGC')
wls:/offline>

suspend

コマンド・カテゴリ: ライフサイクル・コマンド

WLSTでの使用: オンライン

説明

実行中のサーバーを一時停止します。このコマンドでは、サーバーをRUNNING状態からADMIN状態に移行します。サーバーの状態の詳細は、『Oracle WebLogic Serverサーバーの起動と停止の管理』のサーバーのライフサイクルの理解に関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

suspend([sname], [ignoreSessions], [timeOut], [force], [block])

引数

定義

sname

オプション。一時停止するサーバーの名前。この引数のデフォルトは、WLSTが現在接続しているサーバーになります。

ignoreSessions

オプション。一時停止するときに、WLSTがすべてのHTTPセッションをただちに中止するか、または、HTTPセッションの完了(またはタイムアウト)を待機するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合は、HTTPセッションが完了(またはタイムアウト)する必要があります。

timeOut

オプション。サーバーを一時停止する前に、サーバーが進行中の作業を完了するのをWLSTが待機する時間(秒単位)。この引数のデフォルトは0秒で、タイムアウトがないことを表します。

force

オプション。アクティブなセッションの完了を待たずにサーバーを一時停止するかどうかを指定するブール値。この引数のデフォルトはfalseです。その場合は、すべてのアクティブ・セッションが完了してからサーバーを一時停止します。

block

オプション。サーバーが起動されるまでWLSTがユーザー対話をブロックするかどうかを指定するブール値。この引数のデフォルトはfalseで、ユーザー対話がブロックされないことを示します。この場合、WLSTはコマンドを発行した後でユーザーに制御を返し、現在のタスクに関連付けられているタスクMBeanを変数に割り当てます。その変数を利用すると、タスクのステータスをチェックできます。『Oracle WebLogic Scripting Tool』のJythonモジュールとしてのWLSTのインポートに関する項で説明するように、WLSTをJythonモジュールとしてインポートしている場合、blockは常にtrueに設定されます。

例

次の例では、管理対象サーバー・インスタンスを一時停止します。

wls:/mydomain/serverConfig> suspend('managed1')
Server 'managed1' suspended successfully.
wls:/mydomain/serverConfig>

ノード・マネージャ・コマンド

表3-11に示すWLSTノード・マネージャ・コマンドを使用して、WebLogic Serverインスタンスを起動、停止、再起動、およびモニターします。

注意:

このカテゴリのコマンドを実行する前に、ノード・マネージャを実行する必要があります。

ノード・マネージャの詳細は、『Oracle WebLogic Serverノード・マネージャ管理者ガイド』のノード・マネージャの使用に関する項を参照してください。

表3-11 WLST構成のノード・マネージャ・コマンド

コマンド

説明

WLSTの使用...

nm

WLSTがノード・マネージャに接続しているかどうかを判断します。

オンライン

nmConnect

WLSTをノード・マネージャに接続してセッションを確立します。

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

nmDisconnect

WLSTをノード・マネージャ・セッションから接続解除します。

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

nmEnroll

現在のコンピュータのノード・マネージャを有効にして、指定されたWebLogicドメインのサーバーを管理します。

オンライン

nmGenBootStartupProps

指定されたサーバーのためのノード・マネージャ・プロパティ・ファイルboot.propertiesおよびstartup.propertiesを生成します。

オンライン

nmKill

ノード・マネージャで起動された、指定されたサーバー・インスタンスを強制停止します。

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

nmLog

ノード・マネージャ・ログを返します。

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

nmServerLog

ノード・マネージャで起動されたサーバーのサーバー出力ログを返します。

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

nmServerStatus

ノード・マネージャで起動されたサーバーのステータスを返します。

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

nmStart

ノード・マネージャを使用して、現在のWebLogicドメイン内のサーバーを起動します。

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

nmVersion

ノード・マネージャのバージョンを返します。

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

startNodeManager

WLSTを実行している同じコンピュータ上のノード・マネージャを起動します。

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

stopNodeManager

ノード・マネージャを停止します。

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

nm

コマンド・カテゴリ: ノード・マネージャ・コマンド

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

説明

WLSTがノード・マネージャに接続しているかどうかを判断します。trueまたはfalseを返し、説明のメッセージを出力します。このコマンドを実行する前に、ノード・マネージャを実行する必要があります。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nm()

例

次の例では、WLSTは現在、mydomainをモニターするノード・マネージャに接続しています。

wls:/mydomain/serverConfig> nm()
Currently connected to Node Manager that is monitoring the domain "mydomain"
wls:/mydomain/serverConfig>

次の例では、WLSTは現在ノード・マネージャに接続していません。

wls:/mydomain/serverConfig> nm()
Not connected to any Node Manager
wls:/mydomain/serverConfig>

nmConnect

コマンド・カテゴリ: ノード・マネージャ・コマンド

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

説明

WLSTをノード・マネージャに接続してセッションを確立します。ノード・マネージャに接続したら、WLSTからノード・マネージャ・コマンドを呼び出すことができます。このコマンドを実行する前に、ノード・マネージャを実行する必要があります。

注意:

現在のWLSTセッションでconnectコマンドを以前に使用している場合、nmconnectは、特に指定しないかぎり、connectコマンドに使用されたユーザー資格証明を使用します。

接続すると、WLSTプロンプトにはwls:/nm/domainName>と表示されます。domainNameは管理するWebLogicドメインの名前を表します。その後でWLSTをWebLogic Serverに接続すると、プロンプトにはWebLogic Serverインスタンスが示されます。nmコマンドを使用すると、WLSTがノード・マネージャに接続しているかどうかを判断できます(「nm」を参照)。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmConnect([username, password], [host], [port], [domainName], [domainDir] [nmType], [verbose])

nmConnect([userConfigFile, userKeyFile], [host], [port], [domainName], [domainDir] [nmType], [verbose])

引数

定義

username

WLSTをノード・マネージャに接続するオペレータのユーザー名。ユーザー名のデフォルトはweblogicです。

注意: 本番モードでサーバーを実行している場合は、ノード・マネージャに接続するときに適切なユーザー名とパスワードが使用されるように、コマンド行でユーザー名とパスワードを明示的に指定する必要があります。

password

WLSTをノード・マネージャに接続するオペレータのパスワード。パスワードのデフォルトはwelcome1です。

注意: 本番モードでサーバーを実行している場合は、ノード・マネージャに接続するときに適切なユーザー名とパスワードが使用されるように、コマンド行でユーザー名とパスワードを明示的に指定する必要があります。

host

オプション。ノード・マネージャのホスト名。この引数のデフォルトはlocalhostです。

port

オプション。ノード・マネージャのポート番号。この引数のデフォルトは、ノード・マネージャ・タイプに基づいた、次の値になります。

- plainタイプの場合、デフォルトは5556

- rshタイプの場合、デフォルトは514

- sshタイプの場合、デフォルトは22

- sslタイプの場合、デフォルトは5556

domainName

オプション。管理するWebLogicドメインの名前。この引数のデフォルトはmydomainです。

domainDir

オプション。ノード・マネージャ秘密ファイル(nm_password.properties)とSerializedSystemIni.datファイルを保存するドメイン・ディレクトリのパス。この引数のデフォルトはWLSTを起動したディレクトリです。

nmType

ノード・マネージャ・タイプ。有効な値は次のとおりです:

- plain - プレーンなソケットのJavaベースの実装
注意: nmTypeにplainを指定する場合、WL_HOME/common/nodemanager/nodemanager.propertiesのSecureListenerパラメータをfalseに手動で設定する必要があります。そうしないと、nmConnectコマンドは失敗します。

- rsh - RSH実装

- ssh - スクリプト・ベースのSSH実装

- ssl - JavaベースのSSL実装

この引数のデフォルトはsslです。

verbose

オプション。WLSTがノード・マネージャに冗長モードで接続するかどうかを指定するブール値。この引数のデフォルトはfalseで、冗長モードは無効になります。

userConfigFile

オプション。暗号化されたユーザー名とパスワードを格納するユーザー構成ファイルの名前と場所。

ユーザー構成ファイルの作成時に、storeUserConfigコマンドはキー・ファイルを使用してユーザー名とパスワードを暗号化します。ユーザー構成ファイルを暗号化するキー・ファイルのみが、そのユーザー名とパスワードを復号化できる(「storeUserConfig」を参照。)

userKeyFile

オプション。指定されたユーザー構成ファイルに関連付けられていて、そのファイルの復号化に使用されるキー・ファイルの名前と場所。(「storeUserConfig」を参照。)

例

次の例では、デフォルトのホストおよびポート番号とplainノード・マネージャ・タイプを使用して、oamdomainをモニターするノード・マネージャにWLSTを接続します。

wls:/myserver/serverConfig> nmConnect('weblogic', 'welcome1', 'localhost',
'5555', 'oamdomain', 'c:/Oracle/Middleware/user_projects/domains/oamdomain','ssl')
Connecting to Node Manager Server ...
Successfully connected to Node Manager.
wls:/nm/oamdomain>

次の例では、ユーザー資格証明を提供するユーザー構成ファイルとキー・ファイルを使用して、WLSTをノード・マネージャ・サーバー・インスタンスに接続します。

wls:/myserver/serverConfig> nmConnect(userConfigFile='
c:/myfiles/myuserconfigfile.secure',
userKeyFile='c:/myfiles/myuserkeyfile.secure',
host='172.18.137.82', port=26106, domainName='mydomain',
domainDir='c:/myfiles/mydomain', mType='ssl')
Connecting to Node Manager Server ...
Successfully connected to Node Manager.
wls:/nm/mydomain>

nmDisconnect

コマンド・カテゴリ: ノード・マネージャ・コマンド

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

WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

説明

WLSTをノード・マネージャ・セッションから接続解除します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmDisconnect()

例

次の例では、WLSTをノード・マネージャ・セッションから接続解除します。

wls:/nm/oamdomain> nmDisconnect()
Successfully disconnected from Node Manager
wls:/myserver/serverConfig>

nmEnroll

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTでの使用: オンライン

説明

WLSTが現在動作しているマシンを登録します。このコマンドを実行するにはWLSTが管理サーバーに接続している必要がありますが、ノード・マネージャに接続している必要はありません。

このコマンドでは、次のファイルを管理サーバーからダウンロードします。

- ノード・マネージャ秘密ファイル(nm_password.properties)。サーバー認証に使用される暗号化されたユーザー名とパスワードが含まれます

- SerializedSystemIni.datファイル

また、このコマンドでは、WL_HOME/common/nodemanagerディレクトリにあるnodemanager.domainsファイルをドメイン情報で更新します。WL_HOMEはWebLogic Serverの最上位のインストール・ディレクトリです。

WebLogicドメインが管理サーバーとルート・ディレクトリを共有している場合を除いて、このコマンドは1つのWebLogicドメイン、1つのマシンごとに実行する必要があります。

このコマンドを実行するときにそのマシンがすでに登録されている場合は、ノード・マネージャ秘密ファイル(nm_password.properties)が管理サーバーの最新の情報で更新されます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmEnroll([domainDir], [nmHome])

引数

定義

domainDir

オプション。ノード・マネージャ秘密ファイル(nm_password.properties)とSerializedSystemIni.datファイルを保存するドメイン・ディレクトリのパス。この引数のデフォルトはWLSTを起動したディレクトリです。

nmHome

オプション。ノード・マネージャ・ホームのパス。ドメイン情報を含むnodemanager.domainsファイルはこのディレクトリに書き込まれます。この引数のデフォルトはWL_HOME/common/nodemanagerです。WL_HOMEはWebLogic Serverの最上位のインストール・ディレクトリです。

例

次の例では、現在のマシンをノード・マネージャに登録して、ノード・マネージャ秘密ファイル(nm_password properties)とSerializedSystemIni.datファイルをc:/Oracle/Middleware/mydomain/common/nodemanager/nm_password.propertiesに保存します。nodemanager.domainsファイルはデフォルトではWL_HOME/common/nodemanagerに書き込まれます。

wls:/mydomain/serverConfig> nmEnroll('c:/Oracle/Middleware/mydomain/common/nodemanager')
Enrolling this machine with the domain directory at c:\Oracle\Middleware\mydomain\common\nodemanager....
Successfully enrolled this machine with the domain directory at C:\Oracle\Middleware\mydomain\common\nodemanager
wls:/mydomain/serverConfig>

nmGenBootStartupProps

コマンド・カテゴリ: ノード・マネージャ・コマンド

WLSTでの使用: オンライン

説明

指定されたサーバーのためのノード・マネージャ・プロパティ・ファイルboot.propertiesおよびstartup.propertiesを生成します。ノード・マネージャ・プロパティ・ファイルは、指定されたサーバーのルート・ディレクトリを基準とする相対的な場所に格納されます。対象となるルート・ディレクトリは、コマンドを実行しているマシンと同じマシン上にある必要があります。

サーバーの名前を指定する必要があります。そうしないと、コマンドは失敗します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmGenBootStartupProps(serverName)

引数

定義

serverName

ノード・マネージャ・プロパティ・ファイルを生成するサーバーの名前。

例

次の例では、指定されたサーバーms1のルート・ディレクトリ内にboot.propertiesおよびstartup.propertiesを生成します。

wls:/mydomain/serverConfig> nmGenBootStartupProps('ms1')
Successfully generated boot.properties at
c:\Oracle\Middleware\mydomain\servers\ms1\data\nodemanager\boot.properties
Successfully generated startup.properties at
c:\Oracle\Middleware\mydomain\servers\ms1\data\nodemanager\startup.properties
wls:/mydomain/serverConfig>

nmKill

コマンド・カテゴリ: ノード・マネージャ・コマンド

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

WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

説明

ノード・マネージャで起動された、指定されたサーバー・インスタンスを強制停止します。

serverName引数を使用してサーバー名を指定しない場合、引数はデフォルトでmyServerに設定されます。この引数は使用しているサーバー名と一致している必要があり、一致していない場合はコマンドが失敗します。

起動する際にノード・マネージャを使用しなかったサーバー・インスタンスを強制停止しようとすると、エラーが表示されます。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmKill([serverName], [serverType])

引数

定義

serverName

オプション。強制停止するサーバーの名前。この引数のデフォルトはmyserverです。

serverType

オプション。起動するサーバーのタイプ。この引数のデフォルトはWebLogicです。別の有効なオプションはCoherence。

例

次の例では、oamserverというサーバーを強制停止します。

wls:/nm/oamdomain> nmKill('oamserver')
Killing server 'oamserver' ...
Server oamServer killed successfully.
wls:/nm/oamdomain>

nmLog

コマンド・カテゴリ: ノード・マネージャ・コマンド

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

WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

説明

ノード・マネージャ・ログを返します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmLog([writer])

引数

定義

writer

オプション。ログ出力を書き込むjava.io.Writerオブジェクト。この引数のデフォルトはWLSTライター・ストリームです。

例

次の例では、ノード・マネージャ・ログを表示します。

wls:/nm/oamdomain> nmLog()
Successfully retrieved the Node Manager log and written.
wls:/nm/oamdomain>

nmServerLog

コマンド・カテゴリ: ノード・マネージャ・コマンド

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

WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

説明

ノード・マネージャで起動されたサーバーのサーバー出力ログを返します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmServerLog([serverName], [writer], [serverType])

引数

定義

serverName

オプション。サーバーの出力ログを表示するサーバーの名前。この引数のデフォルトはmyserverです。

writer

オプション。ログ出力を書き込むjava.io.Writerオブジェクト。指定しない場合、この引数のデフォルトはWLSTInterpreter標準出力になります。

serverType

オプション。起動するサーバーのタイプ。この引数のデフォルトはWebLogicです。別の有効なオプションはCoherence。

例

次の例では、oamserverサーバーのサーバー出力ログを表示して、ログ出力をmyWriterに書き込みます。

wls:/nm/oamdomain> nmServerLog('oamserver',myWriter)
Successfully retrieved the server log and written.
wls:/nm/oamdomain>

nmServerStatus

コマンド・カテゴリ: ノード・マネージャ・コマンド

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

WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

説明

ノード・マネージャで起動されたサーバーのステータスを返します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmServerStatus([serverName], [serverType])

引数

定義

serverName

オプション。ステータスを表示するサーバーの名前。この引数のデフォルトはmyserverです。

serverType

オプション。起動するサーバーのタイプ。この引数のデフォルトはWebLogicです。別の有効なオプションはCoherence。

例

次の例では、ノード・マネージャで起動されたoamserverというサーバーのステータスを表示します。

wls:/nm/oamdomain> nmServerStatus('oamserver')
RUNNING
wls:/nm/oamdomain>

nmStart

コマンド・カテゴリ: ノード・マネージャ・コマンド

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

WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

説明

ノード・マネージャを使用して、現在のWebLogicドメイン内のサーバーを起動します。

エラーが発生した場合は、WLSTExceptionが返されます。

注意:

nmStartを使用してサーバーを起動するには、boot.propertiesが必要です。最初にサーバーを起動する場合、手動で作成してnmStartを使用する必要があります。

または、nmStartprops引数を使用して、ユーザー資格証明を提供できます(ノード・マネージャの接続後)。

prps = makePropertiesObject("username=weblogic, password=welcome1")
nmStart("AdminServer",props=prps)

構文

nmStart([serverName], [domainDir], [props], [writer], [serverType])

引数

定義

serverName

オプション。起動するサーバーの名前。

domainDir

オプション。起動するサーバーのドメイン・ディレクトリ。この引数のデフォルトは、WLSTの起動元ディレクトリです。

props

オプション。新しいサーバーに適用するシステム・プロパティ。

writer

オプション。サーバー出力が書き込まれるjava.io.Writerオブジェクト。この引数のデフォルトはWLSTライターです。

serverType

オプション。起動するサーバーのタイプ。この引数のデフォルトはWebLogicです。別の有効なオプションはCoherence。

例

次の例では、ノード・マネージャを使用して、現在のWebLogicドメインでmanaged1サーバーを起動します。

wls:/nm/mydomain> nmStart("managed1")
Starting server managed1 ...
Server managed1 started successfully
wls:/nm/mydomain>

次の例では、ノード・マネージャを使用して、指定されたWebLogicドメインで管理サーバーを起動します。この例では、prps変数にシステム・プロパティ設定を格納し、props引数を使用してコマンドに渡されます。

wls:/nm/mydomain> prps = makePropertiesObject("weblogic.ListenPort=8001")
wls:/nm/mydomain> nmStart("AdminServer",props=prps)
Starting server AdminServer...
Server AdminServer started successfully
wls:/nm/mydomain>

nmVersion

コマンド・カテゴリ: ノード・マネージャ・コマンド

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

WLSTをノード・マネージャに接続して、このコマンドを実行する必要があります。

説明

ノード・マネージャのバージョンを返します。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

nmVersion()

例

次の例では、ノード・マネージャのバージョンを表示します。

wls:/nm/oamdomain> nmVersion()
The Node Manager version that you are currently connected to is 9.0.0.0
wls:/nm/oamdomain>

startNodeManager

コマンド・カテゴリ: ノード・マネージャ・コマンド

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

説明

WLSTを実行している同じコンピュータ上のノード・マネージャを起動します。

注意:

WebLogic Serverのカスタム・インストール・プロセスでは、必要に応じてノード・マネージャをWindowsシステム上のWindowsサービスとしてインストールおよび起動できます。詳細は、『Oracle WebLogic Serverインストレーション・ガイド』のWindowsサービスとしてのノード・マネージャのインストールに関する項を参照してください。この場合、ノード・マネージャを手動で起動する必要はありません。

本番環境では、ノード・マネージャの起動にstartNodeManagerコマンドを使用しないことをお薦めします。推奨方法は、サービスまたはデーモンとしてノード・マネージャをインストールするか、startNodeManagerスクリプト(startNodeManager.shまたはstartNodeManger.cmd)を使用します。

startNodeManagerコマンドを呼び出すときに、ノード・マネージャをすでに実行している場合は、次のメッセージが表示されます。

A Node Manager has already been started.
Cannot start another Node Manager process via WLST

エラーが発生した場合は、WLSTExceptionが返されます。

構文

startNodeManager([verbose], [nmProperties])

引数

定義

verbose

オプション。WLSTがノード・マネージャを冗長モードで起動するかどうかを指定するブール値。この引数のデフォルトはfalseで、冗長モードは無効になります。

nmProperties

オプション。ノード・マネージャ・プロパティのカンマ区切りのリスト。名前と値のペアで指定します。ノード・マネージャ・プロパティの例としては、NodeManagerHome、ListenAddress、ListenPort、PropertiesFileなどがあげられます。

例

次の例では、ノード・マネージャのサーバーのバージョンを表示します。

wls:/mydomain/serverConfig> startNodeManager(verbose='true',
NodeManagerHome='c:/Oracle/Middleware/wlserver_10.3/common/nodemanager', ListenPort='6666', ListenAddress='myhost'))
Launching Node Manager ...
Successfully launched the Node Manager.
The Node Manager process is running independent of the WLST process
Exiting WLST will not stop the Node Manager process. Please refer
to the Node Manager logs for more information.
The Node Manager logs will be under c:\Oracle\Middleware\wlserver_10.3\common\nodemanager.
wls:/mydomain/serverConfig>

stopNodeManager

コマンド・カテゴリ: ノード・マネージャ・コマンド

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

説明

ノード・マネージャ・プロセスを停止します。

注意:

ノード・マネージャ・プロセスを停止するには、startNodeManagerを使用してノード・マネージャを起動するか、ノード・マネージャをプロパティQuitEnabled=trueを使用して起動する必要があります。$WLS_HOME/common/nodemanager.propertiesでこのプロパティを構成できます。これにより、ノード・マネージャに接続して停止できます。

stopNodeManagerコマンドを呼び出すときに、ノード・マネージャを実行していない場合は、次のメッセージが表示されます。

Cannot stop the Node Manager unless you are connected to it.

構文

stopNodeManager()

例

次の例では、base_domainドメインのノード・マネージャ・プロセスを停止します。

wls:/nm/base_domain> stopNodeManager()
Stopped Node Manager Process successfully
wls:/offline>

ツリー・コマンド

表3-12に示すWLSTツリー・コマンドを使用して、MBean階層内を移動します。

表3-12 WLST構成のツリー・コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

custom

サーバーに登録されているカスタムMBeanのルートに移動します。

オンライン

domainConfig

ドメインの構成階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

オンライン

domainCustom

ドメイン実行時MBeanサーバーに登録されているカスタムMBeansのルートに移動します

オンライン

domainRuntime

ドメインの実行時階層内で最後に移動したMBean、または階層のルートであるDomainRuntimeMBeanに移動します。

オンライン

edit

編集構成MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

オンライン

jndi

WLSTが現在接続しているサーバーのJNDIツリーに移動します。

オンライン

serverConfig

構成MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

オンライン

serverRuntime

実行時MBean階層内で最後に移動したMBean、または階層のルートであるServerRuntimeMBeanに移動します。

オンライン

custom

コマンド・カテゴリ: ツリー・コマンド

WLSTでの使用: オンライン

説明

実行時MBeanサーバーに登録されているカスタムMBeansのルートに移動します。WLSTはドメインMBeanと同じようにカスタムMBeanへの移動、照会、編集を行いますが、カスタムMBeanではスタブを利用できないためcmo変数は使用できません。

注意:

customツリーに移動する場合、WLSTは互換性MBeanサーバー、実行時MBeanサーバー、あるいはJVMプラットフォームMBeanサーバーにあるすべてのMBeanに問い合せて、カスタムMBeanを検索します。現在のWebLogicドメインにあるMBeanの数によっては、このプロセスに数分かかり、WLSTがすぐにプロンプトを返さない場合があります。

customコマンドは、WLSTが管理サーバー・インスタンスまたは管理対象サーバー・インスタンスに接続しているときに使用できます。WebLogic IntegrationまたはWebLogic Portalサーバーに接続している場合、WLSTはすべてのWebLogic IntegrationまたはWebLogic PortalサーバーMBeanと対話できます。

カスタムMBeanの詳細は、『Oracle WebLogic Server JMXによるカスタム管理ユーティリティの開発』を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

注意:

domainCustom()コマンドを使用して、ドメイン実行時MBeanサーバー上のカスタムMBeanに移動することもできます。詳細は、「domainCustom」を参照してください。

構文

custom()

例

次の例では、管理サーバー・インスタンス上で、構成MBean階層からカスタムMBean階層に移動します。

wls:/mydomain/serverConfig> custom()
Location changed to custom tree. This is a writeable tree with No root. For more help, use help('custom')
wls:/mydomain/custom>

domainConfig

コマンド・カテゴリ: ツリー・コマンド

WLSTでの使用: オンライン

説明

ドメインの構成階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。この読込み専用の階層には、現在のWebLogicドメインを表す構成MBeanが格納されています。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

domainConfig()

例

次の例では、管理サーバー・インスタンス上で、構成MBean階層からWebLogicドメインの構成階層に移動します。

wls:/mydomain/serverConfig> domainConfig()
Location changed to domainConfig tree. This is a read-only tree with DomainMBean as the root.
For more help, use help('domainConfig')
wls:/mydomain/domainConfig> ls()
dr--   AppDeployments
dr--   BridgeDestinations
dr--   Clusters
dr--   CustomResources
dr--   DeploymentConfiguration
dr--   Deployments
dr--   EmbeddedLDAP
dr--   ErrorHandlings
dr--   FileStores
dr--   InternalAppDeployments
dr--   InternalLibraries
dr--   JDBCDataSourceFactories
dr--   JDBCStores
dr--   JDBCSystemResources
dr--   JMSBridgeDestinations
dr--   JMSInteropModules
dr--   JMSServers
dr--   JMSSystemResources
...
wls:/mydomain/domainConfig>

domainCustom

コマンド・カテゴリ: ツリー・コマンド

WLSTでの使用: オンライン

説明

ドメイン実行時MBeanサーバーに登録されているカスタムMBeansのドメイン・カスタム・ツリーに移動します。WLSTはドメインMBeanと同じようにドメイン・カスタムMBeanへの移動、照会、編集を行いますが、ドメイン・カスタムMBeanではスタブを利用できないためcmo変数は使用できません。

注意:

domainCustomツリーに移動する場合、WLSTはドメイン実行時MBeanサーバー、各サーバーの実行時MBeanサーバー、およびJVMプラットフォームMBeanサーバーにあるすべてのMBeanに問い合せて、カスタムMBeanを検索します。現在のWebLogicドメインにあるMBeanの数によっては、このプロセスに数分かかり、WLSTがすぐにプロンプトを返さない場合があります。JMX問合せのオブジェクト名パターンを指定して実行される検索量を制限することをお薦めします。

WLSTが管理サーバー・インスタンスに接続されている場合のみ、domainCustomコマンドを使用できます。

ドメイン実行時MBeanサーバーの詳細は、『Oracle WebLogic Server JMXによるカスタム管理ユーティリティの開発』のWebLogic Server MBeansの理解に関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

domainCustom(ObjectNamePattern)

引数

定義

ObjectNamePattern

sip:*などのJMX問合せパターン。デフォルト値は、nullまたは*:*です。

例

次の例では、管理サーバー・インスタンス上で、構成MBean階層からドメイン・カスタムMBean階層に移動します。

wls:/mydomain/serverConfig> domainCustom()
Location changed to domain custom tree. This is a writeable tree with No root. For more help, use help('domainCustom').

wls:/mydomain/domainCustom

domainRuntime

コマンド・カテゴリ: ツリー・コマンド

WLSTでの使用: オンライン

説明

ドメインの実行時階層内で最後に移動したMBean、または階層のルートであるDomainRuntimeMBeanに移動します。この読込み専用の階層には、現在のWebLogicドメインを表す実行時MBeanが格納されています。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

domainRuntime()

例

次の例では、管理サーバー・インスタンス上で、構成MBean階層からドメインの実行時階層に移動します。

wls:/mydomain/serverConfig> domainRuntime()
wls:/mydomain/domainRuntime> ls()
dr--   AppRuntimeStateRuntime
dr--   DeployerRuntime
dr--   DomainServices
dr--   LogRuntime
dr--   MessageDrivenControlEJBRuntime
dr--   MigratableServiceCoordinatorRuntime
dr--   MigrationDataRuntimes
dr--   SNMPAgentRuntime
dr--   ServerLifeCycleRuntimes
dr--   ServerRuntimes
dr--   ServerServices

-r--   ActivationTime                               Mon Aug 01 11:41:25 EDT 2005
-r--   Clusters                                     null
-r--   MigrationDataRuntimes                        null
-r--   Name                                         sampleMedRecDomain
-rw-   Parent                                       null
-r--   SNMPAgentRuntime                             null
-r--   Type                                         DomainRuntime
-r-x   restartSystemResource                        Void :
WebLogicMBean(weblogic.management.configuration.SystemResourceMBean)
wls:/mydomain/domainRuntime>

edit

コマンド・カテゴリ: ツリー・コマンド

WLSTでの使用: オンライン

説明

編集構成MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。この書込み可能な階層には、現在のWebLogicドメインを表すすべての構成MBeanが格納されています。

注意:

構成Beanを編集するには、管理サーバーに接続する必要があります。管理対象サーバーに接続した場合、WLSTの機能は構成Bean階層の参照だけに制限されます。WLSTを使用して管理対象サーバー上のMBeanの値を変更することはできませんが、管理APIを使用すれば可能です。ただし、管理サーバー上の構成MBeanの値のみを変更することをお薦めします。管理対象サーバー上のMBeanの値を変更すると、ドメイン構成に矛盾が生じる可能性があります。

構成Beanの編集の詳細は、『Oracle WebLogic Scripting Tool』のWLSTオンラインを使用した既存ドメインの更新に関する項を参照してください。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

edit()

例

次の例では、管理サーバー・インスタンス上で、サーバー構成MBean階層から、ドメイン構成MBean階層の編集可能なコピーに移動する方法を示しています。

wls:/myserver/serverConfig> edit()
Location changed to edit tree. This is a writeable tree with DomainMBean as the root.
For more help, use help('edit')
wls:/myserver/edit !> ls()
dr--   AppDeployments
dr--   BridgeDestinations
dr--   Clusters
dr--   DeploymentConfiguration
dr--   Deployments
dr--   EmbeddedLDAP
...
wls:/myserver/edit !>

jndi

コマンド・カテゴリ: ツリー・コマンド

WLSTでの使用: オンライン

説明

WLSTが現在接続しているサーバーのJNDIツリーに移動します。この読込み専用のツリーには、現在JNDIにバインドされているすべての要素が保持されています。

エラーが発生した場合は、WLSTExceptionを返します。

構文

jndi()

例

次の例では、管理サーバー・インスタンス上で、実行時MBean階層からドメインのJNDIツリーに移動します。

wls:/myserver/runtime> jndi()
Location changed to jndi tree. This is a read-only tree with No root. For more help, use help('jndi')
wls:/myserver/jndi> ls()
dr--   ejb
dr--   javax
dr--   jms
dr--   weblogic
...

serverConfig

コマンド・カテゴリ: ツリー・コマンド

WLSTでの使用: オンライン

説明

構成MBean階層内で最後に移動したMBean、または階層のルートであるDomainMBeanに移動します。

この読込み専用の階層には、WLSTが現在接続しているサーバーを表す構成MBeanが格納されています。MBean属性値には、サーバーの起動時にユーザーが指定したコマンド行のオーバーライドが含まれています。

エラーが発生した場合は、WLSTExceptionが返されます。

詳細は、『Oracle WebLogic Scripting Tool』のMBean階層間の移動に関する項を参照してください。

構文

serverConfig()

例

次の例では、管理サーバー・インスタンス上で、ドメインの実行時MBean階層から構成階層に移動します。

wls:/mydomain/domainRuntime> serverConfig()
wls:/mydomain/serverConfig>

serverRuntime

コマンド・カテゴリ: ツリー・コマンド

WLSTでの使用: オンライン

説明

実行時MBean階層内で最後に移動したMBean、または階層のルートであるServerRuntimeMBeanに移動します。この読込み専用の階層には、WLSTが現在接続しているサーバーを表す実行時MBeanが格納されています。

エラーが発生した場合は、WLSTExceptionが返されます。

構文

serverRuntime()

例

次の例では、管理サーバー・インスタンス上で、構成MBean階層から実行時MBean階層に移動します。

wls:/mydomain/serverConfig> serverRuntime()
Location changed to serverRuntime tree. This is a read-only tree with ServerRuntimeMBean as the root.
For more help, use help('serverRuntime')
wls:/mydomain/serverRuntime>

WLST変数リファレンス

表3-13では、WLSTの変数とその一般的な使用方法について説明します。すべての変数はユーザー・セッションの開始時にデフォルト値に初期化されて、ユーザーとWLSTの対話に従って変更されます。

表3-13 WLST変数

変数

説明

例

cmgr

cmgr変数には、ConfigurationManagerMBeanが設定されます。この変数を使用すると、ConfigurationManagerMBean属性の現在の値を取得できます。

wls:/mydomain/edit> cmgr.getCurrentEditor()
'weblogic'

cmo

現在の管理オブジェクト。cmo変数には、WLSTを使用して移動したBeanインスタンスが設定されます。この変数を使用すると、現在のBeanインスタンスのget、set、またはinvokeメソッドを実行できます。

WLSTでは、この変数が現在のWLSTパスに設定されます。たとえば、serverConfig階層に変更すると、cmoはDomainMBeanに設定されます。serverRuntime階層に変更すると、cmoはServerRuntimeMBeanに設定されます。

この変数は、カスタムおよびjndi以外のすべてのWLST階層で利用できます。

wls:/mydomain/edit> cmo.setAdministrationPort(9092)

connected

WLSTが実行中のサーバーに接続しているかどうかを示すブール値。WLSTは、実行中のサーバーに接続する場合、この変数をtrueに設定します。それ以外の場合はfalseに設定します。

wls:/mydomain/serverConfig> print connected
false

domainName

WLSTが接続しているWebLogicドメインの名前。

wls:/mydomain/serverConfig> print domainName
mydomain

domainRuntimeService

DomainRuntimeServiceMBean MBean。この変数は、WLSTが管理サーバーに接続している場合にのみ使用できます。

wls:/mydomain/serverConfig> domainService.getServerName()
'myserver'

editService

EditServiceMBean MBean。この変数は、WLSTが管理サーバーに接続している場合にのみ使用できます。

wls:/mydomain/edit> dc = editService.getDomainConfiguration()

exitonerror

例外が発生した場合にWLSTがスクリプトの実行を終了するかどうかを指定するブール値。この変数のデフォルトはtrueで、WLSTでエラーが発生するとスクリプトの実行は終了します。この変数は、WLSTを対話モードで実行する場合には適用できません。

wls:/mydomain/serverConfig> print exitonerror
true

home

ローカルMBeanHomeを表します。

wls:/mydomain/serverConfig> print home
weblogic.rmi.internal.BasicRemoteRef - hostID: '-hostID:[7001,7001,-1,-1,-1,-1,-1]:mydomain:AdminServer', oid: '260', channel: 'null'

isAdminServer

WLSTがWebLogic管理サーバー・インスタンスに接続しているかどうかを示すブール値。WLSTは、WebLogic管理サーバーに接続している場合、この変数をtrueに設定します。それ以外の場合はfalseに設定します。

wls:/mydomain/serverConfig> print isAdminServer
true

mbs

階層内の現在の場所に相当するMBeanServerConnectionオブジェクト。

wls:/mydomain/serverConfig> mbs.isRegistered(ObjectName('mydomain:
Name=mydomain,Type=Domain'))

recording

WLSTがコマンドを記録しているかどうかを示すブール値。startRecordingコマンドが入力されると、WLSTはこの変数をtrueに設定します。それ以外の場合は、この変数をfalseに設定します。

wls:/mydomain/serverConfig> print recording
true

runtimeService

RuntimeServiceMBean MBean.

wls:/mydomain/serverConfig> sr=runtimeService.getServerRuntime()

serverName

WLSTが接続しているサーバーの名前。

wls:/mydomain/serverConfig> print serverName
myserver

typeService

TypeServiceMBean MBean.

wls:/mydomain/serverConfig> mi=typeService.getMBeanInfo('weblogic.
management.configuration.ServerMBean')

username

現在WLSTに接続しているユーザーの名前。

wls:/mydomain/serverConfig> print username
weblogic

version

WLSTが接続している実行中のサーバーの現在のバージョン。

wls:/mydomain/serverConfig> print version
WebLogic Server 9.0 Thu Aug 31 12:15:50 PST 2005 778899

4 インフラストラクチャ・セキュリティ・カスタムWLSTコマンド

次の項では、Oracle Fusion Middleware Infrastructure SecurityカスタムWLSTコマンドについて説明します。次のトピックがあります。

- WSLTコマンドの使用

- 監査設定コマンド

- SSL設定コマンド

- セキュリティ・コマンド

- Oracle Access Management Access Managerコマンド

- Oracle Access Management Identity Federationコマンド

- Oracle Access Management Advanced Identity Federationコマンド

- Oracle Access Management Mobile and Socialコマンド

- Oracle Access Managementセキュリティ・トークン・サービス

- Oracleキーストア・サービス

- アイデンティティ・ディレクトリ・サービス・コマンド

- Oracle Virtual Directoryライブラリ(LibOVD)コマンド

Oracleプラットフォーム・セキュリティ・サービスの詳細は、『Oracle Fusion Middleware Securityガイド』を参照してください。

WSLTコマンドの使用

WebLogic Serverでインフラストラクチャ・セキュリティ・カスタムWLSTコマンドを使用するには、Oracle共通ホームからWLSTスクリプトを呼び出す必要があります。Oracle Fusion Middleware管理者ガイドのカスタムWLSTコマンドの使用に関する項を参照してください。適用可能なインフラストラクチャ・セキュリティ・カスタムWLSTコマンドのWebSphere Serverでの使用については、サード・パーティ統合ガイドを参照してください。

WLSTセキュリティ・コマンドは次のカテゴリに分かれています。

表4-1 WLSTコマンド・カテゴリ

コマンド・カテゴリ

説明

監査設定コマンド

監査ポリシーおよび監査リポジトリ設定を表示し管理します

SSL設定コマンド

Oracle HTTP Server、Oracle WebCache、Oracleインターネット・ディレクトリおよびOracle仮想ディレクトリ・コンポーネントのウォレット、JKSキーストアおよびSSL設定を表示し管理します。

Oracle Access Management Identity Federationコマンド

Oracle Access Management Identity Federationの構成を表示し管理します

セキュリティ・コマンド

ドメインおよび資格証明ドメイン・ストアを管理し、ドメイン・ポリシー・ストアを移動します。

Oracle Access Management Access Managerコマンド

認可プロバイダ、IDアサーション・プロバイダ、SSOプロバイダなど、Access Manager関連コンポーネントを管理します。

監査設定コマンド

表4-2に表示されているWLSTコマンドを使用して、監査ポリシーおよび監査リポジトリ設定を表示し管理します。

表4-2 WLST監査コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

getNonJavaEEAuditMBeanName

Java EE以外のコンポーネントのmBean名を表示します。

オンライン

getAuditPolicy

監査ポリシー設定を表示します。

オンライン

setAuditPolicy

監査ポリシー設定を更新します。

オンライン

getAuditRepository

監査リポジトリ設定を表示します。

オンライン

setAuditRepository

監査リポジトリ設定を更新します。

オンライン

listAuditEvents

1つ またはすべてのコンポーネントの監査イベントを表示します。

オンライン

exportAuditConfig

コンポーネントの監査設定をエクスポートします。

オンライン

importAuditConfig

コンポーネントの監査設定をインポートします。

オンライン

詳細は、『Oracle Fusion Middleware Securityガイド』を参照してください。

getNonJavaEEAuditMBeanName

Java EE以外のコンポーネントのmbean名を表示するオンライン・コマンドを示します。

説明

このコマンドは、インスタンス名、コンポーネント名、コンポーネントのタイプおよびコンポーネントの監査mbeanが実行しているOracle WebLogic Serverを指定したJava EE以外のコンポーネントのmbean名を表示します。mbeanは、Java EE以外のコンポーネントを管理するときに別の監査WLSTコマンドに対して必要なパラメータです。

構文

getNonJavaEEAuditMBeanName(instName, compName, compType, svrName)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、ohs、oid、ovdおよびWebCache。

svrName

Oracle WebLogic Serverの名前を指定します。

例

次の対話型コマンドは、Oracleインターネット・ディレクトリのmBean名を表示します。

wls:/mydomain/serverConfig> getNonJavaEEAuditMBeanName(instName='inst1', compName='oid1', compType='oid', svrName='AdminServer')

getAuditPolicy

監査ポリシー設定を表示するオンライン・コマンドを示します。

説明

このコマンドは、フィルタの事前設定、特定ユーザー、カスタム・イベント、ログ・ファイルの最大サイズおよびログ・ディレクトリの最大サイズを含む監査ポリシー設定を表示します。mbeanコンポーネントは、Oracleインターネット・ディレクトリおよびOracle仮想ディレクトリなどJava EE以外のコンポーネントに必要です。

注意:

getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

構文

getAuditPolicy([mbeanName, componentType])

引数

定義

mbeanName

Java EE以外のコンポーネントに対してコンポーネント監査MBeanの名前を指定します。

componentType

監査ストアに登録されている特定のコンポーネントの監査ポリシーを要求します。指定しない場合、jps-config.xml内の監査ポリシーが戻されます。

例

次のコマンドは、Java EEコンポーネントの監査設定を表示します。

wls:/mydomain/serverConfig> getAuditPolicy()
Location changed to domainRuntime tree. This is a read-only tree with DomainMBean as the root.
For more help, use help(domainRuntime)

FilterPreset:All
Max Log File Size:104857600
Max Log Dir Size:0

次のコマンドは、MBean CSAuditProxyMBeanの監査設定を表示します。

wls:/mydomain/serverConfig> getAuditPolicy(on='oracle.security.audit.test:type=CSAuditMBean,
name=CSAuditProxyMBean')

setAuditPolicy

監査ポリシーを更新するオンライン・コマンドを示します。

説明

監査ポリシー設定を行うオンライン・コマンドを示します。フィルタの事前設定、ユーザーの追加/削除およびカスタム・イベントの追加/削除を行うことができます。mbeanコンポーネントは、Oracleインターネット・ディレクトリおよびOracle仮想ディレクトリなどJava EE以外のコンポーネントに必要です。

注意:

getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

構文

setAuditPolicy([mbeanName],[filterPreset],[addSpecialUsers],
[removeSpecialUsers],[addCustomEvents],[removeCustomEvents], [componentType], [maxDirSize], [maxFileSize], [andCriteria], [orCriteria], [componentEventsFile])

引数

定義

mbeanName

Java EE以外のコンポーネントに対してコンポーネント監査MBeanの名前を指定します。

filterPreset

フィルタの変更する事前設定を指定します。

addSpecialUsers

追加する特定ユーザーを指定します。

removeSpecialUsers

削除する特定ユーザーを指定します。

addCustomEvents

追加するカスタム・イベントを指定します。

removeCustomEvents

削除するカスタム・イベントを指定します。

componentType

更新するコンポーネント定義タイプを指定します。指定しない場合、jps-config.xmlに定義されている監査設定が変更されます。

maxDirSize

ログ・ディレクトリの最大サイズを指定します。

maxFileSize

ログ・ファイルの最大サイズを指定します。

andCriteria

事前定義済のカスタム・フィルタ定義においてand条件を指定します。

orCriteria

事前定義済のカスタム・フィルタ定義においてor条件を指定します。

componentEventsFile

11gリリース1 (11.1.1.6)のメタデータ・モデルのコンポーネント定義ファイルを指定します。11gリリース1 (11.1.1.6)メタデータ・モデル・コンポーネントの監査ストア内の監査ポリシーを作成/更新する場合、フィルタの事前定義済レベルがCustomに設定されているときは、このパラメータが必要です。

例

次の対話型コマンドは、監査ポリシーをNoneレベルに設定し、ポリシーからuser1を削除するときに、user2およびuser3を追加します。

wls:/mydomain/serverConfig> setAuditPolicy (filterPreset=
'None',addSpecialUsers='user2,user3',removeSpecialUsers='user1')

wls:/mydomain/serverConfig> getAuditPolicy();
Already in Domain Runtime Tree

FilterPreset:None
Special Users:user2,user3
Max Log File Size:104857600
Max Log Dir Size:0

次の対話型コマンドは、ポリシーからログアウト・イベントを削除するときに、ログイン・イベントを追加します。

wls:/mydomain/serverConfig> setAuditPolicy(filterPreset=
'Custom',addCustomEvents='UserLogin',removeCustomEvents='UserLogout')

次の対話型コマンドは、監査ポリシーをLowレベルに設定します。

wls:/IDMDomain/domainRuntime> setAuditPolicy(filterPreset='Low');
Already in Domain Runtime Tree
Audit Policy Information updated successfully

wls:/IDMDomain/domainRuntime> getAuditPolicy();
Already in Domain Runtime Tree
FilterPreset:Low
Max Log File Size:104857600
Max Log Dir Size:0

次のコマンドは、カスタム・フィルタを設定して、CheckAuthorizationイベントを監査します。

wls:/IDMDomain/domainRuntime> setAuditPolicy(filterPreset='Custom', addCustomEvents='JPS:CheckAuthorization');
Already in Domain Runtime Tree

Audit Policy Information updated successfully
wls:/IDMDomain/domainRuntime> getAuditPolicy();
Already in Domain Runtime Tree

FilterPreset:Custom
Special Users:user1
Max Log File Size:104857600
Max Log Dir Size:0
Custom Events:JPS:CheckAuthorization

getAuditRepository

監査リポジトリ設定を表示するオンライン・コマンドを示します。

説明

このコマンドは、Java EEコンポーネントおよびアプリケーション(Oracleインターネット・ディレクトリなどその他のコンポーネントの場合は、リポジトリ設定は、opmn.xmlに存在しています)の監査リポジトリ設定を表示します。また、リポジトリはデータベース型の場合、データベース設定を表示します。

構文

getAuditRepository

例

次のコマンドは、監査リポジトリ設定を表示します。

wls:/IDMDomain/domainRuntime> getAuditRepository()
Already in Domain Runtime Tree

Repository Type:File

setAuditRepository

監査リポジトリ設定を更新するオンライン・コマンドを示します。

説明

このコマンドは、Java EEコンポーネントおよびアプリケーション(Oracleインターネット・ディレクトリなどその他のコンポーネントの場合は、リポジトリが、opmn.xmlを編集して設定されます)の監査リポジトリ設定を設定します。

構文

setAuditRepository([switchToDB],[dataSourceName],[interval])

引数

定義

switchToDB

trueの場合、リポジトリをファイルからデータベースに切り替えます。

dataSourceName

データ・ソースの名前を指定します。

interval

監査ローダーのキックオフ間隔を指定します。

例

次のコマンドは、ファイル・リポジトリからデータベース・リポジトリに切り替えます。

wls:/IDMDomain/domainRuntime> setAuditRepository(switchToDB='true');
Already in Domain Runtime Tree

Audit Repository Information updated

wls:/IDMDomain/domainRuntime> getAuditRepository();
Already in Domain Runtime Tree

JNDI Name:jdbc/AuditDB
Interval:15
Repository Type:DB

次の対話型のコマンドは、監査リポジトリを特定のデータベースに変更し、監査ローダー間隔を14秒に設定します。

wls:/mydomain/serverConfig> setAuditRepository(switchToDB='true',dataSourceName='jdbcAuditDB',interval='14')

listAuditEvents

コマンドの監査イベントを表示するオンライン・コマンドを示します。

説明

このコマンドは、コンポーネントの監査イベントおよび属性を表示します。Java EE以外のコンポーネントの場合は、コンポーネントmbean名をパラメータとして渡します。Oracle Platform Security Services (OPSS)などJava EEアプリケーションおよびサービスでは、mbeanパラメータは不要です。コンポーネントのタイプを除いて、すべてのコンポーネントに対して適用するすべての一般的な属性が表示されます。

注意:

getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

構文

listAuditEvents([mbeanName],[componentType])

引数

定義

mbeanName

コンポーネントMBeanの名前を指定します。

componentType

コンポーネント・タイプを指定します。リストに表示される情報は、そのコンポーネント・タイプのすべてのイベントに限定されます。

例

次のコマンドは、Oracle Platform Security Servicesコンポーネントの監査イベントを表示します。

wls:/IDMDomain/domainRuntime> listAuditEvents(componentType='JPS');
Already in Domain Runtime Tree

Common Attributes
ComponentType
Type of the component. For MAS integrated SystemComponents this is the componentType
InstanceId
Name of the MAS Instance, that this component belongs to
HostId
DNS hostname of originating host
HostNwaddr
IP or other network address of originating host
ModuleId
ID of the module that originated the message. Interpretation is unique within Component ID.
ProcessId
ID of the process that originated the message

次のコマンドは、Oracle HTTP Serverの監査イベントを表示します。

wls:/mydomain/serverConfig> listAuditEvents(componentType='ohs')

次のコマンドは、すべての監査イベントを表示します。

wls:/IDMDomain/domainRuntime> listAuditEvents();
Already in Domain Runtime Tree

Components:
DIP
JPS
OIF
OWSM-AGENT
OWSM-PM-EJB
ReportsServer
WS-PolicyAttachment
WebCache
WebServices
Attributes applicable to all components:
ComponentType
InstanceId
HostId
HostNwaddr
ModuleId
ProcessId
OracleHome
HomeInstance
ECID
RID
...

exportAuditConfig

コンポーネントの監査設定をエクスポートするオンライン・コマンドを示します。

説明

このコマンドは、監査設定をファイルにエクスポートします。Java EE以外のコンポーネントの場合は、コンポーネントmbean名をパラメータとして渡します。Oracle Platform Security Services (OPSS)などJava EEアプリケーションおよびサービスでは、mbeanパラメータは不要です。

注意:

getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

構文

exportAuditConfig([mbeanName],fileName, [componentType])

引数

定義

mbeanName

Java EE以外のコンポーネントのMBean名を指定します。

fileName

監査設定をエクスポートする必要があるパスおよびファイル名を指定します。

componentType

特定のコンポーネントのイベントのみをファイルにエクスポートすることを指定します。指定しない場合、jps-config.xml内の監査設定がエクスポートされます。

例

次の対話型のコマンドは、コンポーネントの監査設定をエクスポートします。

wls:/mydomain/serverConfig> exportAuditConfig(on='oracle.security.audit.test:type=CSAuditMBean,
name=CSAuditProxyMBean',fileName='/tmp/auditconfig')

次の対話型のコマンドは、Java EEコンポーネントの監査設定をエクスポートします。mBeanは指定されていません。

wls:/mydomain/serverConfig> exportAuditConfig(fileName='/tmp/auditconfig')

importAuditConfig

コンポーネントの監査設定をインポートするオンライン・コマンドを示します。

説明

このコマンドは、外部ファイルから監査設定をインポートします。Java EE以外のコンポーネントの場合は、コンポーネントmbean名をパラメータとして渡します。Oracle Platform Security Services (OPSS)などJava EEアプリケーションおよびサービスでは、mbeanパラメータは不要です。

注意:

getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

構文

importAuditConfig([mbeanName],fileName, [componentType])

引数

定義

mbeanName

Java EE以外のコンポーネントのMBean名を指定します。

fileName

監査設定をインポートする必要があるパスおよびファイル名を指定します。

componentType

特定のコンポーネントのイベントのみをファイルからインポートすることを指定します。指定しない場合、jps-config.xml内の監査設定がインポートされます。

例

次の対話型のコマンドは、コンポーネントの監査設定をインポートします。

wls:/mydomain/serverConfig> importAuditConfig(on='oracle.security.audit.test:type=CSAuditMBean,
name='CSAuditProxyMBean',fileName='/tmp/auditconfig')

次の対話型のコマンドは、ファイルから監査設定をインポートします。mBeanは指定されていません。

wls:/mydomain/serverConfig> importAuditConfig(fileName='/tmp/auditconfig')

SSL設定コマンド

表4-3に指定されているコマンドを使用して、Oracle Fusion MiddlewareコンポーネントのSSL設定を表示し管理します。

表4-3 SSL設定のWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

addCertificateRequest

Oracleウォレットで証明書署名用要求を生成します。

オンライン

addSelfSignedCertificate

Oracleウォレットに自己署名証明書を追加します。

オンライン

changeKeyStorePassword

JKSキーストアへのパスワードを変更します。

オンライン

changeWalletPassword

Oracleウォレットへのパスワードを変更します。

オンライン

configureSSL

コンポーネント・リスナーのSSL属性を設定します。

オンライン

createKeyStore

JKSキーストアを作成します。

オンライン

createWallet

Oracleウォレットを作成します。

オンライン

deleteKeyStore

JKSキーストアを削除します。

オンライン

deleteWallet

Oracleウォレットを削除します。

オンライン

exportKeyStore

JKSキーストアをファイルにエクスポートします。

オンライン

exportKeyStoreObject

オブジェクトをJKSキーストアからファイルにエクスポートします。

オンライン

exportWallet

Oracleウォレットをファイルにエクスポートします。

オンライン

exportWalletObject

オブジェクトをOracleウォレットからファイルにエクスポートします。

オンライン

generateKey

JKSキーストアに鍵ペアを生成します。

オンライン

getKeyStoreObject

JKSキーストアに存在する証明書またはその他のオブジェクトを表示します。

オンライン

getSSL

コンポーネント・リスナーのSSL属性を表示します。

オンライン

getWalletObject

Oracleウォレットに存在する証明書またはその他のオブジェクトを表示します。

オンライン

importKeyStore

JKSキーストアをファイルからインポートします。

オンライン

importKeyStoreObject

証明書またはその他のオブジェクトをファイルからJKSキーストアにインポートします。

オンライン

importWallet

Oracleウォレットをファイルからインポートします。

オンライン

importWalletObject

証明書またはその他のオブジェクトをファイルからOracleウォレットにインポートします。

オンライン

listKeyStoreObjects

JKSキーストア内のすべてのオブジェクトを指定します。

オンライン

listKeyStores

コンポーネントのインスタンスに対して設定したすべてのJKSキーストアを指定します。

オンライン

listWalletObjects

Oracleウォレット内のすべてのオブジェクトを指定します。

オンライン

listWallets

コンポーネントのインスタンスに対して設定したすべてのOracleウォレットを指定します。

オンライン

removeKeyStoreObject

コンポーネントのインスタンスのJKSキーストアから証明者またはその他のオブジェクトを削除します。

オンライン

removeWalletObject

コンポーネントのインスタンスのOracleウォレットから証明者またはその他のオブジェクトを削除します。

オンライン

詳細は、Oracle Fusion Middleware管理者ガイドを参照してください。

addCertificateRequest

Oracleウォレットに証明書署名要求を生成するオンライン・コマンドを示します。

説明

このコマンドは、コンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)に対してOracleウォレットにBase64暗号化されたPKCS#10フォーマットで証明書署名要求を生成します。承認された認証局(CA)によって証明書を署名するには、CAに証明書署名要求を送信します。

構文

addCertificateRequest(instName, compName, compType, walletName, password, DN, keySize)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。

walletName

ウォレット・ファイルの名前を指定します。

password

ウォレットのパスワードを指定します。

DN

鍵ペア・エントリの識別された名前を指定します。

keySize

キーのサイズをビットの単位で指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対してwallet1にDNとしてcn=www.example.comおよびキーのサイズとして1024を指定した証明書署名要求を生成します。

wls:/mydomain/serverConfig> addCertificateRequest('inst1', 'oid1', 'oid','wallet1', 'password', 'cn=www.example.com', '1024')

addSelfSignedCertificate

自己署名証明書を追加するオンライン・コマンドを示します。

説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)に対して鍵ペアを作成し、Oracleウォレット内の自己署名証明書にラップします。RSAアルゴリズムに基づくキーのみ生成されます。

構文

addSelfSignedCertificate(instName, compName, compType, walletName, password, DN, keySize)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。

walletName

ウォレット・ファイルの名前を指定します。

password

ウォレットのパスワードを指定します。

DN

鍵ペア・エントリの識別された名前を指定します。

keySize

キーのサイズをビットの単位で指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対してwallet1にDNとしてcn=www.example.comおよびキーのサイズとして1024を指定した自己署名証明書を生成します。

wls:/mydomain/serverConfig> addSelfSignedCertificate('inst1', 'oid1', 'oid','wallet1', 'password', 'cn=www.example.com', '1024')

changeKeyStorePassword

キーストアのパスワードを変更するオンライン・コマンドを示します。

説明

このコマンドは、Oracle仮想ディレクトリ・インスタンスのJavaキーストア(JKS)のパスワードを変更します。

構文

changeKeyStorePassword(instName, compName, compType, keystoreName, currPassword, newPassword)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ovd」です。

keystoreName

キーストアのファイル名を指定します。

currPassword

キーストアの現在のパスワードを指定します。

newPassword

キーストアの新しいパスワードを指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対してファイルkeys.jksのパスワードを変更します。

wls:/mydomain/serverConfig> changeKeyStorePassword('inst1', 'ovd1', 'ovd','keys.jks', 'currpassword', 'newpassword')

changeWalletPassword

Oracleウォレットのパスワードを変更するオンライン・コマンドを示します。

説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)のOracleウォレットのパスワードを変更します。このコマンドは、パスワードが保護したウォレットに対してのみ適用されます。

構文

changeWalletPassword(instName, compName, compType, walletName,currPassword, newPassword)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「oid」、「ohs」および「webcache」です。

walletName

ウォレットのファイル名を指定します。

currPassword

ウォレットの現在のパスワードを指定します。

newPassword

ウォレットの新しいパスワードを指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle HTTP Serverインスタンスohs1に対してwallet1のパスワードをcurrpasswordからnewpasswordに変更します。

wls:/mydomain/serverConfig> changeWalletPassword('inst1', 'ohs1', 'ohs','wallet1', 'currpassword', 'newpassword')

configureSSL

SSLの属性を設定するオンライン・コマンドを示します。

説明

このコマンドは、コンポーネント・リスナーのSSL属性を設定します。属性は、プロパティ・ファイル・フォーマット(name=value)で指定されています。プロパティ・ファイルを提供しない場合またはプロパティ・ファイルにSSLの属性 が含まれていない場合、デフォルトの属性値が使用されます。コンポーネントに特有のSSL属性のデフォルト値については、Oracle Fusion Middleware管理者ガイドの章「Oracle Fusion Middleware内のSSLの設定」を参照してください。

構文

configureSSL(instName, compName, compType, listener, filePath)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「oid」、「ovd」、「ohs」および「webcache」です。

listener

SSLに対して設定するコンポーネント・リスナーの名前を示します。

filePath

設定するSSL属性を含むプロパティ・ファイルの絶対パスを指定します。

例

次のコマンドは、リスナーlistener1に対してアプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1のプロパティ・ファイル/tmp/ssl.propertiesに指定したSSLの属性を設定します。

wls:/mydomain/serverConfig> configureSSL('inst1', 'ovd1', 'ovd', 'listener1','/tmp/ssl.properties')

次のコマンドは、プロパティ・ファイルを指定せずにSSLの属性を設定します。ファイルは何も指定していないので、SSL属性のデフォルト値が使用されます。

wls:/mydomain/serverConfig> configureSSL('inst1', 'ovd1', 'ovd', 'listener2')

createKeyStore

JKSキーストアを作成するオンライン・コマンドを示します。

説明

このコマンドは、指定したOracle仮想ディレクトリ・インスタンスのJavaキーストア(JKS)を作成します。キーストア・ファイルの場所およびその他の情報については、Oracle Fusion Middleware管理者ガイドの章「キーストア、ウォレットおよび証明書の管理」を参照してください。

構文

createKeyStore(instName, compName, compType, keystoreName, password)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ovd」です。

keystoreName

作成するキーストアのファイル名を示します。

password

キーストアのパスワードを指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1のパスワードとしてpasswordを指定したJKSファイルkeys.jksを作成します。

wls:/mydomain/serverConfig> createKeyStore('inst1', 'ovd1', 'ovd','keys.jks', 'password')

createWallet

Oracleウォレットを作成するオンライン・コマンドを示します。

説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)のOracleウォレットを作成します。ウォレットは、パスワード保護したまたは自動ログイン・タイプ をとることができます。ウォレットの情報については、Oracle Fusion Middleware管理者ガイドの章「キーストア、ウォレットおよび証明書の管理」を参照してください。

構文

createWallet(instName, compName, compType, walletName, password)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「oid」、「ohs」および「webcache」です。

walletName

作成するウォレット・ファイルの名前を示します。

password

ウォレットのパスワードを指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle HTTP Serverインスタンスohs1に対してパスワードとしてpasswordを指定したwallet1という名前のウォレットを作成します。

wls:/mydomain/serverConfig> createWallet('inst1', 'ohs1', 'ohs','wallet1', 'password')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle WebCacheインスタンスのwc1に対してwallet2という名前の自動ログイン・ウォレットを作成します。

wls:/mydomain/serverConfig> createWallet('inst1', 'wc1', 'webcache','wallet2', '')

deleteKeyStore

キーストアを削除するオンライン・コマンドを示します。

説明

このコマンドは、指定したOracle仮想ディレクトリ・インスタンスのキーストアを削除します。

構文

deleteKeyStore(instName, compName, compType, keystoreName)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ovd」です。

keystoreName

削除するキーストア・ファイルの名前を指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1のJKSファイルkeys.jksを削除します。

wls:/mydomain/serverConfig> deleteKeyStore('inst1', 'ovd1', 'ovd','keys.jks')

deleteWallet

Oracleウォレットを削除するオンライン・コマンドを示します。

説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)のOracleウォレットを削除します。

構文

deleteWallet(instName, compName, compType, walletName)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「oid」、「ohs」および「webcache」です。

walletName

削除するウォレット・ファイルの名前を示します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle HTTP Serverインスタンスohs1に対してwallet1という名前のウォレットを削除します。

wls:/mydomain/serverConfig> deleteWallet('inst1', 'ohs1', 'ohs','wallet1')

exportKeyStore

キーストアをファイルにエクスポートするオンライン・コマンドを示します。

説明

このコマンドは、指定したディレクトリ内のファイルに指定したOracle仮想ディレクトリ・インスタンスに対して設定したキーストアをエクスポートします。エクスポートしたファイル名は、キーストア名と同じです。

構文

exportKeyStore(instName, compName, compType, keystoreName, password, path)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ovd」です。

keystoreName

キーストア・ファイルの名前を指定します。

password

キーストアのパスワードを指定します。

path

キーストアがエクスポートされているディレクトリの絶対パスを指定します。

例

次のコマンドは、/tmpの下にあるファイルkeys.jksにOracle仮想ディレクトリ・インスタンスovd1のキーストアkeys.jksをエクスポートします。

wls:/mydomain/serverConfig> exportKeyStore('inst1', 'ovd1', 'ovd', 'keys.jks', 'password', '/tmp')

exportKeyStoreObject

キーストアからファイルにオブジェクトをエクスポートするオンライン・コマンドを示します。

説明

次のコマンドは、Javaキーストア(JKS)にある証明書署名要求、証明書/証明書チェーンまたは信頼された証明書を指定したOracle仮想ディレクトリ・インスタンスのファイルにエクスポートします。オブジェクトのエクスポート前に証明書署名要求が作成されます。別名は、エクスポートするオブジェクトを指定します。

構文

exportKeyStoreObject(instName, compName, compType, keystoreName, password, type, path, alias)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ovd」です。

keystoreName

キーストア・ファイルの名前を指定します。

password

キーストアのパスワードを指定します。

type

エクスポートするキーストア・オブジェクトのタイプを指定します。有効な値は、「CertificateRequest」、「Certificate」、「TrustedCertificate」および「TrustedChain」です。

path

オブジェクトをbase64.txtという名前のファイルとしてエクスポートしたディレクトリの絶対パスを指定します。

alias

エクスポートするキーストア・オブジェクトの別名を指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対してkeys.jks内の別名mykeyによって指定した鍵ペアからの証明書署名用要求を生成し、エクスポートします。証明書署名用要求は、/tmpディレクトリの下にエクスポートされます。

wls:/mydomain/serverConfig> exportKeyStoreObject('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'CertificateRequest', '/tmp','mykey')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対してkeys.jks内の別名mykeyによって指定した証明書または証明書チェーンをエクスポートします。証明書または証明書チェーンは、/tmpディレクトリの下にエクスポートされます。

wls:/mydomain/serverConfig> exportKeyStoreObject('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'Certificate', '/tmp','mykey')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1ないのOracle仮想ディレクトリ・インスタンスovd1に対してkeys.jks内の別名mykeyによって指定した信頼された証明書をエクスポートします。信頼された証明書は、/tmpディレクトリの下にエクスポートされます。

wls:/mydomain/serverConfig> exportKeyStoreObject('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'TrustedCertificate', '/tmp','mykey')

exportWallet

Oracleウォレットをエクスポートするオンライン・コマンドを示します。

説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)に対して設定したOracleウォレットを提供したディレクトリの中にあるファイルにエクスポートします。エクスポートされたファイルは、自動ログインのウォレットの場合、ファイル「cwallet.sso」のみが作成されます。パスワードで保護されているウォレットの場合、ewallet.p12およびcwallet.ssoという2つのファイルが作成されます。

構文

exportWallet(instName, compName, compType, walletName,password, path)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「oid」、「ohs」および「webcache」です。

walletName

ウォレット・ファイルの名前を指定します。

password

ウォレットのパスワードを指定します。

path

オブジェクトがエクスポートされているディレクトリの絶対パスを指定します。

例

次のコマンドは、Oracleインターネット・ディレクトリ・インスタンスoid1の自動ログイン・ウォレットwallet1を/tmpの中にあるファイルcwallet.ssoにエクスポートします。

wls:/mydomain/serverConfig> exportWallet('inst1', 'oid1', 'oid', 'wallet1','','/tmp')

次のコマンドは、Oracleインターネット・ディレクトリ・インスタンスoid1のパスワード保護したウォレットwallet2を/tmpの中にある2つのファイルewallet.p12およびcwallet.ssoにエクスポートします。

wls:/mydomain/serverConfig> exportWallet('inst1', 'oid1', 'oid', 'wallet2', 'password', '/tmp')

exportWalletObject

証明書またはその他のウォレット・オブジェクトをファイルにエクスポートするオンライン・コマンドを示します。

説明

このコマンドは、Oracleウォレットにある証明書署名要求、証明書、証明書チェーンまたは信頼された証明書を指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)のファイルにエクスポートします。DNを使用してエクスポートするオブジェクトを指定します。

構文

exportWalletObject(instName, compName, compType, walletName, password, type, path, DN)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。

walletName

ウォレット・ファイルの名前を指定します。

password

ウォレットのパスワードを指定します。

type

エクスポートするウォレット・オブジェクトのタイプを指定します。有効な値は、「CertificateRequest」、「Certificate」、「TrustedCertificate」または「TrustedChain」です。

path

オブジェクト をbase64.txtという名前のファイルとしてエクスポートしたディレクトリの絶対パスを指定します。

DN

エクスポートするウォレット・オブジェクトの識別された名前を指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対してwallet1にDNとしてcn=www.example.comを指定した証明書署名要求をエクスポートします。証明書署名用要求は、/tmpディレクトリの下にエクスポートされます。

wls:/mydomain/serverConfig> exportWalletObject('inst1', 'oid1',
'oid','wallet1', 'password', 'CertificateRequest', '/tmp','cn=www.example.com')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対してwallet1にDNとしてcn=www.example.comを指定した証明書をエクスポートします。証明書または証明書チェーンは、/tmpディレクトリの下にエクスポートされます。

wls:/mydomain/serverConfig> exportWalletObject('inst1', 'oid1',
'oid','wallet1', 'password', 'Certificate', '/tmp','cn=www.example.com')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対してwallet1にDNとしてcn=www.example.comを指定した信頼された証明書をエクスポートします。信頼された証明書は、/tmpディレクトリの下にエクスポートされます。

wls:/mydomain/serverConfig> exportWalletObject('inst1', 'oid1',
'oid','wallet1', 'password', 'TrustedCertificate', '/tmp','cn=www.example.com')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対してwallet1にDNとしてcn=www.example.comを指定した証明書チェーンをエクスポートします。証明書または証明書チェーンは、/tmpディレクトリの下にエクスポートされます。

wls:/mydomain/serverConfig> exportWalletObject('inst1', 'oid1',
'oid','wallet1', 'password', 'TrustedChain', '/tmp','cn=www.example.com')

generateKey

Javaキーストアに鍵ペアを生成するオンライン・コマンドを示します。

説明

このコマンドは、Oracle仮想ディレクトリのJavaキーストア(JKS)に鍵ペアを生成します。また、このコマンドは、鍵ペアを自己署名証明書にラップします。RSAアルゴリズムに基づくキーのみ生成されます。

構文

generateKey(instName, compName, compType, keystoreName, password, DN, keySize, alias, algorithm)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ovd」です。

keystoreName

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

DN

鍵ペア・エントリの識別された名前を指定します。

keySize

キーのサイズをビットの単位で指定します。

alias

キーストア内の鍵ペア・エントリの別名を指定します。

algorithm

キーのアルゴリズムを指定します。有効な値は、「RSA」です。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対してDNとしてcn=www.example.com、キー・サイズとして1024、アルゴリズムとしてRSAおよび別名としてmykeyを指定したキー・ペアをkeys.jksに生成します。

wls:/mydomain/serverConfig> generateKey('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'cn=www.example.com', '1024', 'mykey', 'RSA')

次のコマンドは、上記と同じですが、キー・アルゴリズムを明示的に指定しません。

wls:/mydomain/serverConfig> generateKey('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'cn=www.example.com', '1024', 'mykey')

getKeyStoreObject

キーストア・オブジェクトの詳細情報を表示するオンライン・コマンドを示します。

説明

このコマンドは、Oracle仮想ディレクトリに対してJavaキーストア(JKS)にある特定の証明書または信頼された証明書を表示します。キーストア・オブジェクトは、listKeyStoreObjectsコマンドによって指定したインデックス番号で指定されます。これには、DN、キーのサイズ、アルゴリズムおよびその他の情報を含む証明書の詳細情報が表示されます。

構文

getKeyStoreObject(instName, compName, compType, keystoreName, password, type, index)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ovd」です。

keystoreName

キーストア・ファイルの名前を指定します。

password

キーストアのパスワードを指定します。

type

表示するキーストア・オブジェクトのタイプを指定します。有効な値は、「Certificate」および「TrustedCertificate」です。

index

listKeyStoreObjectsコマンドによって返されたキーストア・オブジェクトのインデックス番号を指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対してkeys.jks内のインデックス1で信頼証明書を表示します。

wls:/mydomain/serverConfig> getKeyStoreObject('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'TrustedCertificate', '1')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対してkeys.jks内のインデックス1で証明書を表示します。

wls:/mydomain/serverConfig> getKeyStoreObject('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'Certificate', '1')

getSSL

設定済SSL属性を表示するオンライン・コマンドを示します。

説明

このコマンドは、指定したコンポーネント・リスナーの設定済のSSL属性を表示します。Oracleインターネット・ディレクトリの場合に常にリスナー名としてsslport1を使用します。

構文

getSSL(instName, compName, compType, listener)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ovd」、「oid」、「ohs」および「webcache」です。

listener

コンポーネント・リスナーの名前を指定します。

例

次のコマンドは、リスナーsslport1に対してアプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対して設定したSSL属性を表示します。

wls:/mydomain/serverConfig> getSSL('inst1', 'oid1', 'oid', 'sslport1')

getWalletObject

Oracleウォレット内の証明書またはその他のオブジェクトに関する情報を表示するオンライン・コマンドを示します。

説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)に対してOracleウォレットにある特定の証明書署名要求、証明書または信頼された証明書を表示します。ウォレット・オブジェクトは、listWalletObjectsコマンドによって指定したインデックス番号で指定されます。証明書または信頼された証明書に対して、DN、キーのサイズ、アルゴリズムおよびその他のデータを含む証明書の詳細情報を表示します。証明書署名要求に対して、サブジェクトDN、キーのサイズおよびアルゴリズムを表示します。

構文

getWalletObject(instName, compName, compType, walletName, password, type, index)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。

walletName

ウォレット・ファイルの名前を指定します。

password

ウォレットのパスワードを指定します。

type

エクスポートするウォレット・オブジェクトのタイプを指定します。有効な値は、「CertificateRequest」、「Certificate」および「TrustedCertificate」です。

index

listWalletObjectsコマンドによって返されたウォレット・オブジェクトのインデックス番号を指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対してwallet1にあるインデックス0でオブジェクトの証明書署名要求の詳細情報を表示します。

wls:/mydomain/serverConfig> getKeyStoreObject('inst1', 'oid1', 'oid','wallet1','password', 'CertificateRequest', '0')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスのoid1に対してwallet1にあるインデックス0でオブジェクトの証明書の詳細情報を表示します。

wls:/mydomain/serverConfig> getKeyStoreObject('inst1', 'oid1', 'oid','wallet1','password', 'Certificate', '0')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスのoid1に対してwallet1にあるインデックス0でオブジェクトの信頼性のある証明書の詳細情報を表示します。

wls:/mydomain/serverConfig> getKeyStoreObject('inst1', 'oid1', 'oid','wallet1','password', 'TrustedCertificate', '0')

importKeyStore

ファイルからキーストアをインポートするオンライン・コマンドを示します。

説明

このコマンドは、管理可能性のためにJavaキーストア(JKS)をファイルから指定したOracle仮想ディレクトリ・インスタンスにインポートします。コンポーネント・インスタンス名はユニークである必要があります。

構文

importKeyStore(instName, compName, compType, keystoreName, password, filePath)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ovd」です。

keystoreName

インポートされているキーストアの名前を指定します。このコンポーネントに対してこの名前がユニークである必要があります。

password

キーストアのパスワードを指定します。

filePath

インポートするキーストア・ファイルの絶対パスを指定します。

例

次のコマンドは、Oracle仮想ディレクトリ・インスタンスovd1にキーストア/tmp/keys.jksをfile.jksとしてインポートします。その後、キーストアがfile.jksの名前を使用して管理されます。

wls:/mydomain/serverConfig> importKeyStore('inst1', 'ovd1', 'ovd', 'file.jks',
'password', '/tmp/keys.jks')

importKeyStoreObject

オブジェクトをファイルからキーストアにインポートするオンライン・コマンドを示します。

説明

このコマンドは、証明書、証明書チェーンまたは信頼された証明書にキーストアにユニークである必要がある指定した別名を割り当てることにより、Oracle仮想ディレクトリのJavaキーストア(JKS)にインポートします。証明書または証明書チェーンがインポートされている場合、別名は、対応する鍵ペアと一致する必要があります。

構文

importKeyStoreObject(instName, compName, compType, keystoreName, password, type, filePath, alias)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ovd」です。

keystoreName

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

type

インポートするキーストア・オブジェクトのタイプを指定します。有効な値は、「Certificate」および「TrustedCertificate」です。

filePath

キーストア・オブジェクトを含むファイルの絶対パスを指定します。

alias

インポートするキーストア・オブジェクトに割り当てる別名を指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対して、別名mykeyを使用してファイルcert.txtからの証明書または証明書チェーンをkeys.jksにインポートします。ファイルkeys.jksには、インポートする証明書内の公開鍵と一致する鍵ペアに対して、すでに別名mykeyを含まれている必要があります。

wls:/mydomain/serverConfig> > importKeyStoreObject('inst1', 'ovd1',
'ovd','keys.jks', 'password', 'Certificate','/tmp/cert.txt', 'mykey')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対して、別名mykeyを使用してファイルtrust.txtからの信頼された証明書をkeys.jksにインポートします。

wls:/mydomain/serverConfig> importKeyStoreObject('inst1', 'ovd1',
'ovd','keys.jks', 'password', 'TrustedCertificate','/tmp/trust.txt', 'mykey1')

importWallet

ファイルからOracleウォレットをインポートするオンライン・コマンドを示します。

説明

このコマンドは、管理可能性のためにOracleウォレットをファイルから指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)にインポートします。インポートされているウォレットが、自動ログイン・ウォレットの場合、ファイル・パスは、cwallet.ssoを参照する必要があります。ウォレットが、パスワード保護されている場合、ファイル・パスは、ewallet.p12を参照する必要があります。ウォレット名は、コンポーネント・インスタンスに対してユニークである必要があります。

構文

importWallet(instName, compName, compType, walletName, password, filePath)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。

walletName

インポートされているウォレットの名前を指定します。ウォレット名は、コンポーネント・インスタンスに対してユニークである必要があります。

password

ウォレットのパスワードを指定します。

filePath

インポートされているウォレット・ファイルの絶対パスを指定します。

例

次のコマンドは、自動ログイン・ウォレット・ファイル/tmp/cwallet.ssoをwallet1としてOracleインターネット・ディレクトリ・インスタンスoid1にインポートします。その後、ウォレットがwallet1という名前で管理されます。自動ログイン・ウォレットなので、パスワードを指定しません。

wls:/mydomain/serverConfig> importWallet('inst1', 'oid1', 'oid', 'wallet1', '', '/tmp/cwallet.sso')

次のコマンドは、パスワード保護したウォレット/tmp/ewallet.p12をwallet2としてOracleインターネット・ディレクトリ・インスタンスoid1にインポートします。その後、ウォレットがwallet2という名前で管理されます。ウォレットのパスワードがパラメータとして渡されます。

wls:/mydomain/serverConfig> importWallet('inst1', 'oid1', 'oid', 'wallet2', 'password', '/tmp/ewallet.p12')

importWalletObject

Oracleウォレットに証明書またはその他のオブジェクトをインポートするオンライン・コマンドを示します。

説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheコンポーネントまたはOracleインターネット・ディレクトリ)に対して証明書、信頼された証明書または証明書チェーンをOracleウォレットにインポートします。証明書のインポート時、証明書署名要求の生成先ウォレット・ファイルを使用します。

構文

importWalletObject(instName, compName, compType, walletName, password, type, filePath)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。

walletName

ウォレット・ファイルの名前を指定します。

password

ウォレットのパスワードを指定します。

type

インポートするウォレット・オブジェクトのタイプを指定します。有効な値は、「Certificate」、「TrustedCertificate」および「TrustedChain」です。

filePath

ウォレット・オブジェクトを含むファイルの絶対パスを指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対して証明書チェーンをPKCS#7フォーマットを使用してファイルchain.txtからwallet1にインポートします。

wls:/mydomain/serverConfig> importWalletObject('inst1', 'oid1', 'oid','wallet1', 'password', 'TrustedChain','/tmp/chain.txt')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対して証明書ファイルcert.txtからwallet1にインポートします。

wls:/mydomain/serverConfig> importWalletObject('inst1', 'oid1', 'oid','wallet1',
'password', 'Certificate','/tmp/cert.txt')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1に対して信頼された証明書ファイルtrust.txtからwallet1にインポートします。

wls:/mydomain/serverConfig> importWalletObject('inst1', 'oid1', 'oid','wallet1', 'password', 'TrustedCertificate','/tmp/trust.txt')

listKeyStoreObjects

キーストアの内容を表示するオンライン・コマンドを示します。

説明

このコマンドは、Oracle仮想ディレクトリのJavaキーストア(JKS)にある証明書または信頼された証明書を表示します。

構文

listKeyStoreObjects(instName, compName, compType, keystoreName, password, type)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ovd」です。

keystoreName

キーストア・ファイルの名前を指定します。

password

キーストアのパスワードを指定します。

type

表示するキーストア・オブジェクトのタイプを指定します。有効な値は、「Certificate」および「TrustedCertificate」です。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対して、keys.jksにあるすべての信頼された証明書を表示します。

wls:/mydomain/serverConfig> listKeyStoreObjects('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'TrustedCertificate')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対して、keys.jksにあるすべての証明書を表示します。

wls:/mydomain/serverConfig> listKeyStoreObjects('inst1', 'ovd1', 'ovd','keys.jks', 'password', 'Certificate')

listKeyStores

コンポーネントのすべてのキーストアを表示するオンライン・コマンドを示します。

説明

このコマンドは、指定したOracle仮想ディレクトリ・インスタンスに対して設定したすべてのJavaキーストア(JKS)を表示します。

構文

listKeyStores(instName, compName, compType)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します

compType

コンポーネントのタイプを指定します。有効な値は、「ovd」です。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1のすべてのキーストアを表示します。

wls:/mydomain/serverConfig> listKeyStores('inst1', 'ovd1', 'ovd')

listWalletObjects

Oracleウォレットにあるすべてのオブジェクトを表示するオンライン・コマンドを示します。

説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)に対してOracleウォレットにあるすべての証明書署名要求、証明書または信頼された証明書を表示します。

構文

listWalletObjects(instName, compName, compType, walletName, password, type)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。

walletName

ウォレット・ファイルの名前を指定します。

password

ウォレットのパスワードを指定します。

type

表示するウォレット・オブジェクトのタイプを指定します。有効な値は、「CertificateRequest」、「Certificate」および「TrustedCertificate」です。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のすべての証明書署名要求をwallet1に表示します。

wls:/mydomain/serverConfig> > listWalletObjects('inst1', 'oid1', 'oid','wallet1','password', 'CertificateRequest')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のすべての証明書をwallet1に表示します。

wls:/mydomain/serverConfig> listWalletObjects('inst1', 'oid1', 'oid','wallet1','password', 'Certificate')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のすべての信頼された証明書をwallet1に表示します。

wls:/mydomain/serverConfig> listWalletObjects('inst1', 'oid1', 'oid','wallet1','password', 'TrustedCertificate')

listWallets

コンポーネント・インスタンスに対して設定したすべてのウォレットを表示するオンライン・コマンドを示します。

説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)に対して指定したすべてのウォレットを表示し、自動ログイン・ウォレットを識別します。

構文

listWallets(instName, compName, compType)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します

compType

コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のすべてのウォレットをに表示します。

wls:/mydomain/serverConfig> listWallets('inst1', 'oid1', 'oid')

removeKeyStoreObject

キーストアからオブジェクトを削除するオンライン・コマンドを示します。

説明

このコマンドは、Oracle仮想ディレクトリのJavaキーストア(JKS)から証明書要求、証明書、信頼された証明書またはすべての信頼された証明書を削除します。別名を使用して特定のオブジェクトを削除します。すべての信頼された証明書が削除されている場合は、別名を使用する必要はありません。

構文

removeKeyStoreObject(instName, compName, compType, keystoreName, password, type, alias)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ovd」です。

keystoreName

キーストア・ファイルの名前を指定します。

password

キーストアのパスワードを指定します。

type

削除するキーストア・オブジェクトのタイプを指定します。有効な値は、「Certificate」、「TrustedCertificate」または「TrustedAll」です。

alias

削除するキーストア・オブジェクトの別名を指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対して、keys.jks内の別名mykeyによって指定された証明書または証明書チェーンを削除します。

wls:/mydomain/serverConfig> removeKeyStoreObject('inst1', 'ovd1',
'ovd','keys.jks', 'password', 'Certificate','mykey')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対してkeys.jks内の別名mykeyによって指定した信頼された証明書を削除します。

wls:/mydomain/serverConfig> removeKeyStoreObject('inst1', 'ovd1',
'ovd','keys.jks', 'password', 'TrustedCertificate','mykey')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracle仮想ディレクトリ・インスタンスovd1に対して、keys.jksにあるすべての信頼された証明書を削除します。別名を使用する必要はないので、そのパラメータになしという値が渡されます。

wls:/mydomain/serverConfig> removeKeyStoreObject('inst1', 'ovd1',
'ovd','keys.jks', 'password', 'TrustedAll',None)

removeWalletObject

Oracleウォレットから証明書またはその他のオブジェクトを削除するオンライン・コマンドを示します。

説明

このコマンドは、指定したコンポーネント・インスタンス(Oracle HTTP Server、Oracle WebCacheまたはOracleインターネット・ディレクトリ)に対してOracleウォレットから証明書署名要求、証明書またはすべての信頼された証明書を削除します。DNを使用して削除するオブジェクトを指定します。

構文

removeWalletObject(instName, compName, compType, walletName, password, type, DN)

引数

定義

instName

アプリケーション・サーバー・インスタンスの名前を指定します。

compName

コンポーネント・インスタンスの名前を指定します。

compType

コンポーネントのタイプを指定します。有効な値は、「ohs」、「oid」および「webcache」です。

walletName

ウォレット・ファイルの名前を指定します。

password

ウォレットのパスワードを指定します。

type

削除するキーストア・オブジェクトのタイプを指定します。有効な値は、「CertificateRequest」、「Certificate」、「TrustedCertificate」または「TrustedAll」です。

DN

削除するウォレット・オブジェクトの識別された名前を指定します。

例

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のすべての信頼された証明書をwallet1から削除します。DNを指定する必要はないので、DNパラメータにnull (Noneで指定される)を渡します。

wls:/mydomain/serverConfig> removeWalletObject('inst1', 'oid1', 'oid','wallet1', 'password', 'TrustedAll',None)

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のDNとしてcn=www.example.comを指定した証明書署名要求をwallet1から削除します。

wls:/mydomain/serverConfig> removeWalletObject('inst1', 'oid1', 'oid','wallet1', 'password', 'CertificateRequest','cn=www.example.com')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のDNとしてcn=www.example.comを指定した証明書をwallet1から削除します。

wls:/mydomain/serverConfig> removeWalletObject('inst1', 'oid1', 'oid','wallet1', 'password', 'Certificate','cn=www.example.com')

次のコマンドは、アプリケーション・サーバー・インスタンスinst1内のOracleインターネット・ディレクトリ・インスタンスoid1のDNとしてcn=www.example.comを指定した信頼された証明書をwallet1から削除します。

wls:/mydomain/serverConfig> removeWalletObject('inst1', 'oid1', 'oid','wallet1', 'password', 'TrustedCertificate','cn=www.example.com')

セキュリティ・コマンド

表4-4に示されているWLSTセキュリティ・コマンドを使用して、ドメイン・ポリシーまたは資格証明ストアの操作、ソース・リポジトリからターゲット・リポジトリへのポリシーおよび資格証明の移行、および(資格証明の)暗号化鍵のエクスポートとインポートを行います。

表4-4 WLSTセキュリティ・コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

listAppStripes

ポリシー・ストア内のアプリケーション・ストライプを一覧表示します。

オンライン

createAppRole

新しいアプリケーション・ロールを作成します。

オンライン

deleteAppRole

アプリケーション・ロールを削除します。

オンライン

grantAppRole

ロールにプリンシパルを追加します。

オンライン

revokeAppRole

ロールからプリンシパルを削除します。

オンライン

listAppRoles

アプリケーション内のすべてのロールを表示します。

オンライン

listAppRolesMembers

アプリケーション・ロール内のすべてのメンバーを表示します。

オンライン

grantPermission

新しいパーミッションを作成します。

オンライン

revokePermission

パーミッションを削除します。

オンライン

listPermissions

プリンシパルに付与されたすべてのパーミッションを表示します。

オンライン

deleteAppPolicies

アプリケーション内のすべてのポリシーを削除します。

オンライン

migrateSecurityStore

ポリシーまたは資格証明をソース・リポジトリから対象リポジトリに移動します。

オフライン

listCred

資格証明の属性の値のリストを取得します。

オンライン

updateCred

資格証明の属性の値を変更します。

オンライン

createCred

新しい資格証明を作成します。

オンライン

deleteCred

資格証明を削除します。

オンライン

modifyBootStrapCredential

ブート・ストラップ資格証明ストアを更新します

オフライン

addBootStrapCredential

資格証明をブート・ストラップ資格証明ストアに追加します

オフライン

exportEncryptionKey

ドメイン暗号化鍵をファイルewallet.p12にエクスポートします。

オフライン

importEncryptionKey

ファイルewallet.p12内の暗号化鍵をドメインにインポートします。

オフライン

restoreEncryptionKey

ドメイン暗号化鍵を、直近のインポートの前の状態にリストアします。

オフライン

reassociateSecurityStore

ポリシーおよび資格証明をLDAPリポジトリに再び関連付けます

オンライン

upgradeSecurityStore

セキュリティ・データをリリース10.1.xに使用されたデータからリリース11に使用されたデータにアップグレードします。

オフライン

createResourceType

新しいリソース・タイプを作成します。

オンライン

getResourceType

既存のリソース・タイプをフェッチします。

オンライン

deleteResourceType

既存のリソース・タイプを削除します。

オンライン

createResource

リソースを作成します。

オンライン

deleteResource

リソースを削除します。

オンライン

listResources

アプリケーション・ストライプ内のリソースを一覧表示します。

オンライン

listResourceActions

リソースのアクションを一覧表示します。

オンライン

createEntitlement

資格を作成します。

オンライン

getEntitlement

資格を一覧表示します。

オンライン

deleteEntitlement

資格を削除します。

オンライン

addResourceToEntitlement

資格にリソースを追加します。

オンライン

revokeResourceFromEntitlement

資格からリソースを削除します

オンライン

listEntitlements

アプリケーション・ストライプ内の資格を一覧表示します。

オンライン

grantEntitlement

資格を作成します。

オンライン

revokeEntitlement

資格を削除します。

オンライン

listEntitlement

資格を一覧表示します。

オンライン

listResourceTypes

アプリケーション・ストライプ内のリソース・タイプを一覧表示します。

オンライン

createAppRole

新しいアプリケーション・ロールを作成するオンライン・コマンドを示します。

説明

指定したアプリケーションおよびロール名のアプリケーション・ロールをドメイン・ポリシー・ストアに作成します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

createAppRole(appStripe, appRoleName)

引数

定義

appStripe

アプリケーション・ストライプを指定します。

appRoleName

ロール名を指定します。

例

次の呼出しは、アプリケーション・ストライプmyAppおよびロール名myRoleの新しいアプリケーション・ロールを作成します。

wls:/mydomain/serverConfig> createAppRole(appStripe="myApp", appRoleName="myRole")

deleteAppRole

アプリケーション・ロールを削除するオンライン・コマンドを示します。

説明

指定したアプリケーションおよびロール名のアプリケーション・ロールをドメイン・ポリシー・ストアから削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

createAppRole(appStripe, appRoleName)

引数

定義

appStripe

アプリケーション・ストライプを指定します。

appRoleName

ロール名を指定します。

例

次の呼出しは、アプリケーション・ストライプmyAppおよびロール名myRoleのロールを削除します。

wls:/mydomain/serverConfig> createAppRole(appStripe="myApp", appRoleName="myRole")

grantAppRole

ロールにプリンシパルを追加するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプおよび名前のロールにプリンシパル(クラスまたは名前)を追加します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

grantAppRole(appStripe, appRoleName,principalClass, principalName)

引数

定義

appStripe

アプリケーション・ストライプを指定します。

appRoleName

ロール名を指定します。

principalClass

クラスの完全修飾名を指定します。

principalName

プリンシパルの名前を指定します。

例

次の呼出しは、アプリケーション・ストライプmyAppおよびロール名myRoleのロールにプリンシパルを追加します。

wls:/mydomain/serverConfig> grantAppRole(appStripe="myApp",
appRoleName="myRole",principalClass="com.example.xyzPrincipal",
principalName="myPrincipal")

revokeAppRole

ロールからプリンシパルを削除するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプおよび名前のロールからプリンシパル(クラスまたは名前)を削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

revokeAppRole(appStripe, appRoleName, principalClass, principalName)

引数

定義

appStripe

アプリケーション・ストライプを指定します。

appRoleName

ロール名を指定します。

principalClass

クラスの完全修飾名を指定します。

principalName

プリンシパルの名前を指定します。

例

次の呼出しは、アプリケーション・ストライプmyAppおよびロール名myRoleのロールからプリンシパルを削除します。

wls:/mydomain/serverConfig> revokeAppRole(appStripe="myApp",
appRoleName="myRole",principalClass="com.example.xyzPrincipal",
principalName="myPrincipal")

listAppRoles

アプリケーション内のすべてのロールを表示するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプ内のすべてのロールを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

listAppRoles(appStripe)

引数

定義

appStripe

アプリケーション・ストライプを指定します。

例

次の呼出しは、アプリケーション・ストライプmyAppのすべてのロールを返します。

wls:/mydomain/serverConfig> listAppRoles(appStripe="myApp")

listAppRolesMembers

ロール内のすべてのメンバーを表示するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプおよびロール名のロール内のすべてのメンバーを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

listAppRoleMembers(appStripe, appRoleName)

引数

定義

appStripe

アプリケーション・ストライプを指定します。

appRoleName

ロール名を指定します。

例

次の呼出しは、アプリケーション・ストライプmyAppおよびロール名myRoleのロール内のすべてのメンバーを返します。

wls:/mydomain/serverConfig> listAppRoleMembers(appStripe="myApp", appRoleName="myRole")

grantPermission

新しいパーミッションを作成するオンライン・コマンドを示します。

説明

指定したコード・ベースおよびURLに対して新しいパーミッションを作成します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

オプションの引数は、角カッコで囲まれています。

grantPermission([appStripe,] [codeBaseURL,] [principalClass,] [principalName,]permClass, [permTarget,] [permActions])

引数

定義

appStripe

アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。

codeBaseURL

パーミッションのあるコードのURLを指定します。

principalClass

クラス(被譲与者)の完全修飾名を指定します。

principalName

被譲与者のプリンシパル名を指定します。

permClass

permissionクラスの完全修飾名を指定します。

permTarget

利用可能であれば、パーミッション対象の名前を指定します。一部のパーミッションには、この属性を含むことができない場合があります。

permActions

付与するアクションのカンマ区切りのリストを指定します。一部のパーミッションには、この属性が含まれない可能性があり、利用可能なアクションは、permissionクラスによって異なります。

例

次の呼出しは、指定したデータでアプリケーションの新しいパーミッション(アプリケーション・ストライプmyAppのアプリケーション)を作成します。

wls:/mydomain/serverConfig> grantPermission(appStripe="myApp",
principalClass="my.custom.Principal",  principalName="manager",
permClass="java.security.AllPermission")

次の呼出しは、指定したデータでシステムの新しいパーミッションを作成します。

wls:/mydomain/serverConfig> grantPermission(principalClass="my.custom.Principal", principalName="manager",
permClass="java.io.FilePermission", permTarget="/tmp/fileName.ext",
permTarget="/tmp/fileName.ext", permActions="read,write")

revokePermission

パーミッションを削除するオンライン・コマンドを示します。

説明

指定したコード・ベースおよびURLのパーミッションを削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

オプションの引数は、角カッコで囲まれています。

revokePermission([appStripe,] [codeBaseURL,] [principalClass,] [principalName,]permClass, [permTarget,] [permActions])

引数

定義

appStripe

アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。

codeBaseURL

パーミッションのあるコードのURLを指定します。

principalClass

クラス(被譲与者)の完全修飾名を指定します。

principalName

被譲与者のプリンシパル名を指定します。

permClass

permissionクラスの完全修飾名を指定します。

permTarget

利用可能であれば、パーミッション対象の名前を指定します。一部のパーミッションには、この属性を含むことができない場合があります。

permActions

付与するアクションのカンマ区切りのリストを指定します。一部のパーミッションには、この属性が含まれない可能性があり、利用可能なアクションは、permissionクラスによって異なります。

例

次の呼出しは、指定したデータのアプリケーションパーミッション(アプリケーション・ストライプmyAppのアプリケーション)を削除します。

wls:/mydomain/serverConfig> revokePermission(appStripe="myApp",
principalClass="my.custom.Principal", principalName="manager",
permClass="java.security.AllPermission")

次の呼出しは、システムの指定したデータのパーミッションを削除します。

wls:/mydomain/serverConfig> revokePermission(principalClass="my.custom.Principal", principalName="manager",
permClass="java.io.FilePermission", permTarget="/tmp/fileName.ext",
permActions="read,write")

listPermissions

指定したプリンシパルに付与したすべてのパーミッションを表示するオンライン・コマンドを示します。

説明

指定したプリンシパルに付与されたすべてのパーミッションを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

オプションの引数は、角カッコで囲まれています。

listPermissions([appStripe,] principalClass, principalName)

引数

定義

appStripe

アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。

principalClass

クラス(被譲与者)の完全修飾名を指定します。

principalName

被譲与者のプリンシパル名を指定します。

例

次の呼出しは、アプリケーションmyAppのポリシーによってプリンシパルに付与したすべてのパーミッションを表示します。

wls:/mydomain/serverConfig> listPermissions(appStripe="myApp", principalClass="my.custom.Principal",principalName="manager")

次の呼出しは、システム・ポリシーによってプリンシパルに付与したすべてのパーミッションを表示します。

wls:/mydomain/serverConfig> listPermissions(principalClass="my.custom.Principal", principalName="manager")

deleteAppPolicies

指定したアプリケーション・ストライプのすべてのポリシーを削除するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプのすべてのポリシーを削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

deleteAppPolicies(appStripe)

引数

定義

appStripe

アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。

例

次の呼出しは、アプリケーションmyAppのすべてのポリシーを削除します。

wls:/mydomain/serverConfig> deleteAppPolicies(appStripe="myApp")

migrateSecurityStore

ID、アプリケーション特定ポリシー、システム・ポリシー、特定資格証明フォルダまたはすべての資格証明を移動するオフライン・コマンドを示します。

説明

ID、アプリケーション特定ポリシーまたはシステム・ポリシーをソース・リポジトリから対象リポジトリに移動します。特定資格証明フォルダまたはすべての資格証明を移動します。

ソース・データおよび対象データの格納先リポジトリの種類は、コマンドに対して分かりやすく、ファイル・ベースおよびLDAPベース・リポジトリの任意の組合せを利用可能です(LDAPリポジトリが、OVDサーバーまたはOID LDAPサーバーのみ使用する必要があります)。エラーが発生した場合は、WLSTExceptionが返されます。

構文

コマンドの構文は、移動されているポリシーのスコープ(システム特定またはアプリケーション特定または両方)によって異なります。

オプションの引数は、角カッコで囲まれています。

IDを移動するには、次の構文を使用します:

migrateSecurityStore(type="idStore", configFile, src, dst, [dstLdifFile])

すべてのポリシー(すべてのアプリケーションのシステム特定およびアプリケーション特定ポリシー)を移動するには、次の構文を使用します

migrateSecurityStore(type="policyStore", configFile, src,
dst,[overWrite,][preserveAppRoleGuid])

システム・ポリシーだけ移動するには、次の構文を使用します:

migrateSecurityStore(type="globalPolicies", configFile, src, dst, [overWrite])

1つのアプリケーションのアプリケーション特定ポリシーだけ移動するには、次の構文を使用します:

migrateSecurityStore(type="appPolicies", configFile,src, dst, srcApp
[,dstApp] [,overWrite] [,migrateIdStoreMapping][,preserveAppRoleGuid] [,mode])

すべての資格証明を移動するには、次の構文を使用します:

migrateSecurityStore(type="credStore", configFile, src, dst, [overWrite])

資格証明フォルダを1つだけ移動するには、次の構文を使用します:

migrateSecurityStore(type="folderCred", configFile,src, dst, [srcFolder,]
[dstFolde,] [srcConfigFile,] [overWrite])

引数

定義

type

移動するポリシーのタイプを指定します。

IDを移動するには、idStoreに設定します。

すべてのポリシー(すべてのアプリケーションのシステム特定およびアプリケーション特定ポリシー)を移動するには、policyStoreに設定します。

システム・ポリシーだけを移動するには、globalPoliciesに設定します。

アプリケーション特定ポリシーだけを移動するには、appPoliciesに設定します。

すべての資格証明を移動するには、credStoreに設定します。

資格証明フォルダを1つだけ移動するには、folderCredに設定します。

configFile

コマンドが実行しているディレクトリに対して設定ファイルjps-config.xmlの場所を指定します。渡された設定ファイルは、実際のドメインの設定ファイルである必要はありませんが、これらのファイルを組み合せることだけで、移動するソース・リポジトリおよび宛先リポジトリを指定できます。

src

ソースのストアが指定されている引数configFileに渡された設定ファイル内のjpsコンテキストの名前を指定します。

dst

宛先のストアが指定されている引数configFileに渡された設定ファイル内の別のjpsコンテキストの名前を指定します。

srcApp

ポリシーが移動されているソース・アプリケーションの名前を指定します。

dstApp

ポリシーが書き込まれている対象アプリケーションの名前を指定します。指定しない場合、デフォルトは、ソース・アプリケーションの名前になります。

srcFolder

資格証明の移動先フォルダの名前を指定します。この引数はオプションです。指定しない場合、資格証明ストアにフォルダが1つのみ存在すると想定され、この引数のデフォルト値は、そのフォルダの名前になります。

dstFolder

ソース資格証明の移動先フォルダを指定します。この引数はオプションです。指定しない場合、デフォルトは、srcFolderに渡されたフォルダになります。

srcConfigFile

代替の設定ファイルの場所を指定します。代替の設定ファイルは、configFileに渡されたファイルに資格証明が設定されていないなど特定の場合に使用されます。この引数はオプションです。指定しない場合、デフォルトは、configFileに渡された値になります。指定する場合、configFileに渡された値が無視されます。

overWrite

移動されている対象と一致するデータ内のデータをソース・データと上書きするか、ソース・データにマージするかを指定します。オプションで、デフォルトはfalseです。一致するデータを上書きする場合、true設定します。一致するデータをマージする場合、falseに設定します。

migrateIdStoreMapping

アプリケーションのポリシーを移動するときにエンタープライズ・ポリシーの移動を行うか行わないかを指定します。オプションで、デフォルトはtrueです。アプリケーション・ポリシーの移動ときエンタープライズ・ポリシーの移動を行わない場合は、Falseに設定します。

dstLdifFile

LDIFファイルの作成先を指定します。宛先がLDAPベースIDストアの場合のみ必要です。LDIFファイルがLDAPサーバーにインポートされなく、使用しているLDAPサーバーに対して必要な属性を突き止めるためにこのファイルを変更した後、手動でインポートする必要があることに注意します。

preserveAppRoleGuid

ポリシーの移行でGUIDを保持するか再作成するかを指定します。オプションで、デフォルトはfalseです。GUIDを保持する場合はtrueに設定し、GUIDを再作成する場合はfalseに設定します。

mode

アプリケーション・ポリシーに重複するプリンシパルまたはパーミッションが見つかった場合、移行を停止し、エラーを表示するかどうかを指定します。laxに設定すると、重複する項目が見つかっても移行は続行され、重複する項目のうち1つだけが移行されて、その旨を知らせる警告がログに記録されます。strictに設定すると、重複する項目が見つかった場合、移行は強制的に停止されます。指定しない場合、この値はデフォルトのstrictに設定されます。

渡される引数に対しては、次の要求があります。

- ファイルjps-config.xmlが渡された場所に存在する必要があります。

- ファイルjps-config.xmlには、渡されたjpsコンテキストが含まれる必要があります。

- ソース・コンテキスト名および宛先コンテキスト名が異なる必要があります。コマンドは、これらの2つのコンテキストから移動に使用するソース・リポジトリおよび対象リポジトリの場所を決定します。

例

次の呼出しは、アプリケーションPolicyServlet1のファイル・ベース・ポリシーをアプリケーションPolicyServlet2のファイル・ベース・ポリシーに移行します。重複するプリンシパルまたはパーミッションが見つかっても移行は停止されず、重複する項目のうち1つだけが移行されて、重複する項目が見つかったことを知らせる警告がログに記録されます。

wls:/mydomain/serverConfig> migrateSecurityStore(type="appPolicies",
configFile="jps-congif.xml", src="default1", dst="context2",
srcApp="PolicyServlet1", dstApp="PolicyServlet2", overWrite="true", mode="lax")

上記の呼出しは、次のものを仮定しています。

- ファイルjps-config.xmlは、コマンドが実行されているディレクトリ(現在のディレクトリ)にあります。

- このファイルには、次の要素が含まれています。

<serviceInstance name="policystore1.xml" provider="some.provider">
<property name="location" value="jazn-data1.xml"/>
</serviceInstance>
<serviceInstance name="policystore2.xml" provider="some.provider">
<property name="location" value="jazn-data2.xml"/>
</serviceInstance>
...
<jpsContext name="default1">
<serviceInstanceRef ref="policystore1.xml"/>
...
</jpsContext>
<jpsContext name="context2">
<serviceInstanceRef ref="policystore2.xml"/>
...
</jpsContext>

移動に対して使用されている2つのアプリケーションのファイル・ベース・ポリシーは、ファイルjazn-data1.xmlおよびjazn-data2.xmlに定義されており、表示されなく、現在のディレクトリに存在されていると仮定されます。

次の呼出しは、ファイル・ベース資格証明の1つの場所から別の場所への移動を示してます。

wls:/mydomain/serverConfig> migrateSecurityStore(type="credStore", configFile="jps-congif.xml", src="default1", dst="context2")

上記の呼出しは、次のものを仮定しています。

- ファイルjps-config.xmlは、コマンドが実行されているディレクトリ(現在のディレクトリ)にあります。

- このファイルには、次の要素が含まれています。

<serviceInstance name="credstore1" provider="some.provider">
<property name="location" value="./credstore1/cwallet.sso"/>
</serviceInstance>
<serviceInstance name="credstore2" provider="some.provider">
<property name="location" value="./credstore2/cwallet.sso"/>
</serviceInstance>
...
<jpsContext name="default1">
<serviceInstanceRef ref="credstore1"/>
...
</jpsContext>
<jpsContext name="context2">
<serviceInstanceRef ref="credstore2"/>
...
</jpsContext>

このコマンドの詳細な構成例については、Oracle Fusion Middlewareセキュリティ・ガイドを参照してください。

listCred

ドメイン資格証明ストア内の資格証明の属性の値のリストを返すオンライン・コマンドを示します。

説明

指定したマップ名およびキー名のドメイン資格証明ストア内の資格証明の属性の値のリストを返します。このコマンドは、パスワード・タイプのみの資格証明にカプセル化されたデータを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

listCred(map, key)

引数

定義

map

マップ名(フォルダ)を指定します。

key

キー名を指定します。

例

次の呼出しは、マップ名myMapおよびキー名myKeyの資格証明内のすべての情報(ユーザー名、パスワード、URL、ポートおよび説明)を返します。

wls:/mydomain/serverConfig> listCred(map="myMap", key="myKey")

updateCred

資格証明のタイプ、ユーザー名およびパスワードを変更するオンライン・コマンドを示します。

説明

指定したマップ名およびキー名の資格証明ストア内の資格証明のタイプ、ユーザー名、パスワード、URLおよびポート番号を変更します。このコマンドは、パスワード・タイプのみの資格証明にカプセル化されたデータを更新できます。エラーが発生した場合は、WLSTExceptionが返されます。このコマンドは、対話型モードでのみ実行します。

構文

オプションの引数は、角カッコで囲まれています。

updateCred(map, key, user, password, [desc])

引数

定義

map

マップ名(フォルダ)を指定します。

key

キー名を指定します。

user

資格証明ユーザー名を指定します。

password

資格証明のパスワードを指定します。

desc

資格証明を説明する文字列を指定します。

例

次の呼出しは、指定したデータでパスワード資格証明を更新します。

wls:/mydomain/serverConfig> updateCred(map="myMap", key="myKey", user="myUsr",
password="myPassw", desc="updated passw cred to connect to app xyz")

createCred

ドメイン資格証明ストアに新しい資格証明を作成するオンライン・コマンドを示します。

説明

指定したマップ名、キー名、タイプ、ユーザー名およびパスワード、URLおよびポート番号のドメイン資格証明ストアに新しい資格証明を作成します。エラーが発生した場合は、WLSTExceptionが返されます。このコマンドは、対話型モードでのみ実行します。

構文

オプションの引数は、角カッコで囲まれています。

createCred(map, key, user, password, [desc])

引数

定義

map

マップ名(フォルダ)を指定します。

key

キー名を指定します。

user

資格証明ユーザー名を指定します。

password

資格証明のパスワードを指定します。

desc

資格証明を説明する文字列を指定します。

例

次の呼出しは、指定したデータで新しいパスワード資格証明を作成します。

wls:/mydomain/serverConfig> createCred(map="myMap, key="myKey", user="myUsr",
password="myPassw", desc="updated usr name and passw to connect to app xyz")

deleteCred

ドメイン資格証明ストア内の資格証明を削除するオンライン・コマンドを示します。

説明

指定したマップ名およびキー名の資格証明をドメイン資格証明ストアから削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

deleteCred(map,key)

引数

定義

map

マップ名(フォルダ)を指定します。

key

キー名を指定します。

例

次の呼出しは、マップ名myMapおよびキー名myKeyの資格証明を削除します。

wls:/mydomain/serverConfig> deleteCred(map="myApp",key="myKey")

modifyBootStrapCredential

ブート・ストラップ資格証明ストアを更新するオフライン・コマンドを示します。

説明

指定したユーザー名およびパスワードでブート・ストラップ資格証明を更新します。エラーが発生した場合は、WLSTExceptionが返されます。

一般的に、次のシナリオの場合に使用されます: ドメイン・ポリシーおよび資格証明ストアはLDAPベースで、(LDAPサーバーに格納された)LDAPストアにアクセスする資格証明が変更されたとします。その後、このコマンドを使用して、ブート・ストラップ資格証明ストアにこれらの変更を設定できます。

構文

modifyBootStrapCredential(jpsConfigFile, username, password)

引数

定義

jpsConfigFile

コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。

username

LDAPストア内のユーザーの識別名を指定します。

password

ユーザーのパスワードを指定します。

例

LDAPストアでは、識別された名cn=orcladminのユーザーのパスワードをwelcome1に変更しており、設定ファイルjps-config.xmlを現在のディレクトリに存在している場合、次の呼出しは、ブート・ストラップ資格証明ストア内のパスワードをwelcome1に変更します。

wls:/mydomain/serverConfig> modifyBootStrapCredential(jpsConfigFile='./jps-config.xml', username='cn=orcladmin', password='welcome1')

監査サービスに対する任意の出力を無視できます。

addBootStrapCredential

資格証明をブート・ストラップ資格証明ストアに追加するオフライン・コマンド。

説明

指定されたマップ、キー、ユーザー名およびユーザー・パスワードを持つパスワード資格証明を、JPS構成ファイルのデフォルトのJPSコンテキストで構成されたブートストラップ資格証明に追加します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

addBootStrapCredential(jpsConfigFile, map, key, username, password)

引数

定義

jpsConfigFile

コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。

map

追加する資格証明のマップを指定します。

key

追加する資格証明のキーを指定します。

username

追加する資格証明のユーザーの名前を指定します。

password

追加する資格証明のユーザーのパスワードを指定します。

例

次の呼出しは、資格証明をブート・ストラップ資格証明ストアに追加します。

wls:/mydomain/serverConfig> addBootStrapCredential(jpsConfigFile='./jps-config.xml', map='myMapName', key='myKeyName', username='myUser', password='myPassword')

exportEncryptionKey

ドメインのブートストラップ・ウォレットからファイルewallet.p12に暗号化鍵を抽出するオフライン・コマンド。

説明

ドメインの資格証明暗号化鍵をファイルewallet.p12に書き込みます。コマンドimportEncryptionKeyを使用してそのファイルからデータをインポートするには、このコマンドで渡されるパスワードを使用する必要があります。

構文

exportEncryptionKey(jpsConfigFile, keyFilePath, keyFilePassword)

引数

定義

jpsConfigFile

コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。

keyFilePath

ファイルewallet.p12の作成先となるディレクトリを指定します。このファイルのコンテンツは暗号化されており、keyFilePasswordに渡される値によって保護されていることに注意してください。

keyFilePassword

ファイルewallet.p12を保護するためのパスワードを指定します。このファイルをインポートする際は、これと同じパスワードを使用する必要があることに注意してください。

例

次の呼出しは、ディレクトリmyDirにファイルewallet.p12を書き込みます。

exportEncryptionKey(jpsConfigFile="pathName", keyFilePath="myDir" ,keyFilePassword="password")

importEncryptionKey

指定されたewallet.p12ファイルからドメインにキーをインポートするオフライン・コマンド。

説明

次の呼出しは、ファイルewallet.p12からドメインに暗号化鍵をインポートします。渡されるパスワードは、コマンドexportEncryptionKeyを使用してファイルを作成する際に使用されたものと同じである必要があります。

構文

importEncryptionKey(jpsConfigFile, keyFilePath, keyFilePassword)

引数

定義

jpsConfigFile

コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。

keyFilePath

ewallet.p12の書込み先となるディレクトリを指定します。

keyFilePassword

ファイルewallet.p12の生成時に使用されたパスワードを指定します。

例

importEncryptionKey(jpsConfigFile="pathName", keyFilePath="dirloc" ,keyFilePassword="password")

restoreEncryptionKey

ドメイン資格証明暗号化鍵をリストアするオフライン・コマンド。

説明

ドメイン・ブートストラップ・キーの状態を、importEncryptionKeyの実行前の状態にリストアします。

構文

restoreEncryptionKey(jpsConfigFile)

引数

定義

jpsConfigFile

コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。

例

restoreEncryptionKey(jpsConfigFile="pathName")

reassociateSecurityStore

ポリシーおよび資格証明ストアをLDAPリポジトリに移動するオンライン・コマンドを示します。

説明

指定したドメイン内のポリシー・ストアおよび資格証明ストアの両方を対象LDAPサーバー・リポジトリに移動します。LDAPサーバーの使用可能な種類は、OIDまたはOVDのみです。このコマンドでは、複数のドメインで共有するポリシー・ストアをセットアップすることも可能です(下記のオプションの引数joinを参照してください)。エラーが発生した場合は、WLSTExceptionが返されます。このコマンドは、対話型モードでのみ実行します。

構文

reassociateSecurityStore(domain, admin, password, ldapurl, servertype, jpsroot [, join] [,keyFilePath, keyFilePassword])

引数

定義

domain

再関連付けが起こるドメイン名を指定します。

admin

LDAPサーバー上の管理者のユーザー名を指定します。フォーマットは、cn=usrNameです。

password

引数adminに対して指定したユーザーに関連付けられるパスワードを指定します。

ldapurl

LDAPサーバーのURIを指定します。デフォルト・ポートを使用している場合は、フォーマットがldap//:host:portであり、保護したLDAPポートを使用している場合は、フォーマットがldaps://host:portです。保護したポートは、特にこの機能に対して設定する必要があり、デフォルト(保護以外)ポートと異なります。

servertype

対象LDAPサーバーの種類を指定します。有効なタイプとしては、OIDまたはOVDのみがあります。

jpsroot

すべてのデータが移動されている対象LDAPリポジトリ内のルート・ノードを指定します。フォーマットは、cn=nodeNameです。

join

このドメインで、他のドメイン内で指定されているポリシー・ストアを共有するかどうかを指定します。オプション。別のドメイン内の既存のポリシー・ストアを共有する場合はtrueに設定します。それ以外の場合はfalseに設定します。指定しない場合、この値はデフォルトのfalseに設定されます。この引数を使用することにより、複数のWebLogicドメインで同じ論理ポリシー・ストアをポイントすることができるようになります。

keyFilePath

ewallet.p12の書込み先となるディレクトリを指定します。

keyFilePassword

ファイルewallet.p12の生成時に使用されたパスワードを指定します。

例

次の呼出しは、ドメイン・ポリシーおよび資格証明をLDAP Oracleインターネット・ディレクトリ・サーバーに再び関連付けます。

wls:/mydomain/serverConfig> reassociateSecurityStore(domain="myDomain",
admin="cn=adminName", password="myPass",ldapurl="ldap://myhost.example.com:3060",
servertype="OID", jpsroot="cn=testNode")

ある他のドメイン(myDomainとは異なるドメインで、たとえばotherDomain)が、myDomain内のポリシー・ストアを共有するようにしたいとしましょう。この場合、次のようにコマンドを呼び出します。

wls:/mydomain/serverConfig> reassociateSecurityStore(domain="otherDomain",
admin="cn=adminName", password="myPass", ldapurl="ldap://myhost.example.com:3060",
servertype="OID", jpsroot="cn=testNode", join="true")

upgradeSecurityStore

リリース10.1.xセキュリティ・データをリリース11セキュリティ・データに移動するオフライン・コマンドを示します。

説明

リリース10.1.x 1で使用されたID、ポリシーおよび資格証明データをリリース11で使用可能なセキュリティ・データに移動します。このコマンドを別に呼び出して、各種類のデータが移動されます。エラーが発生した場合は、WLSTExceptionが返されます。

構文

構文は、更新されているデータのタイプによって異なります。

10.1.x XML IDデータを11 XML IDデータにアップグレードするには、次の構文を使用します:

updateSecurityStore(type="xmlIdStore", jpsConfigFile, srcJaznDataFile, srcRealm, dst)

10.1.x XMLポリシー・データを11 XMLポリシー・データにアップグレードするには、次の構文を使用します:

updateSecurityStore(type="xmlPolicyStore", jpsConfigFile, srcJaznDataFile, dst)

10.1.x OID LDAPベース・ポリシー・データを11 XMLポリシー・データにアップグレードするには、次の構文を使用します:

updateSecurityStore(type="oidPolicyStore", jpsConfigFile, srcJaznDataFile, dst)

10.1.x XML資格証明データを11 XML資格証明データにアップグレードするには、次の構文を使用します:

updateSecurityStore(type="xmlCredStore", jpsConfigFile, srcJaznDataFile, users,  dst)

引数

定義

type

アップグレードされているセキュリティ・データの種類を指定します。有効な値は、xmlIdStore、xmlPolicyStore、oidPolicyStoreおよびxmlCredStoreのみです。

jpsConfigFile

コマンドが実行しているディレクトリに対して設定ファイルjps-config.xmlの場所を指定します。アップグレードの対象ストアは、引数dstで指定したコンテキストから読み込まれます。

srcJaznDataFile

コマンドが実行しているディレクトリに対して10.1.x jaznデータ・ファイルの場所を指定します。指定したタイプは、xmlIdStore、xmlPolicyStoreまたはxmlCredStoreの場合、この引数を使用する必要があります。

srcJaznConfigFile

コマンドが実行しているディレクトリに対して10.1.x jazn設定ファイルの場所を指定します。指定したタイプは、oidPolicyStoreの場合、この引数を使用する必要があります。

srcRealm

IDを移動する必要があるレルムの名前を指定します。指定したタイプは、xmlIdStoreの場合、この引数を使用する必要があります。

users

realmName/userNameとしてフォーマットした各ユーザーのカンマ区切りのリストを指定します。指定したタイプは、xmlCredStoreの場合、この引数を使用する必要があります。

dst

宛先ストアが設定されている引数jpsConfigFileに渡されたファイル内のjpsContextの名前を指定します。オプション。指定しない場合、デフォルトは、引数jpsConfigFileに渡されたファイル内のデフォルト・コンテキストになります。

例

次の呼出しは、10.1.3ファイル・ベースIDを11ファイル・ベースIDストアに移動します。

wls:/mydomain/serverConfig> upgradeSecurityStore(type="xmlIdStore",
jpsConfigFile="jps-config.xml", srcJaznDataFile="jazn-data.xml",
srcRealm="jazn.com")

次の呼出しは、10.1.3 OIDベース・ポリシー・ストアを11ファイル・ベース・ポリシー・ストアに移動します。

wls:/mydomain/serverConfig> upgradeSecurityStore(type="oidPolicyStore",
jpsConfigFile="jps-config.xml", srcJaznDataFile="jazn-data.xml",
dst="destinationContext)

createResourceType

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアに新しいリソース・タイプを作成するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアに、指定された名前、表示名、説明およびアクションを持つ新しいリソース・タイプ要素を作成します。オプションの引数は、角カッコで囲まれています。それ以外のすべての引数は必須です。エラーが発生した場合は、WLSTExceptionが返されます。

構文

オプションの引数は、角カッコで囲まれています。

createResourceType(appStripe, resourceTypeName, displayName, description [, provider] [, matcher], actions [, delimeter])

引数

定義

appStripe

リソース・タイプの挿入対象のアプリケーション・ストライプを指定します。

resourceTypeName

挿入するリソース・タイプの名前を指定します。

displayName

UIガジェットで使用されるリソース・タイプの名前を指定します。

description

リソース・タイプの簡単な説明を指定します。

provider

リソース・タイプのプロバイダを指定します。

matchere

リソース・タイプのクラスを指定します。指定しない場合、この値はデフォルトのoracle.security.jps.ResourcePermissionに設定されます。

actions

このリソース・タイプのインスタンスで許可されるアクションを指定します。

delimeter

アクションのリストでデリミタとして使用する文字を指定します。指定しない場合、この値はデフォルトのカンマ(,)に設定されます。

例

次の呼出しは、ストライプmyApplication内に、アクションBWPrintおよびColorPrint(デリミタとしてセミコロンを使用します)を持つリソース・タイプを作成します。

wls:/mydomain/serverConfig> createResourceType(appStripe="myApplication",
resourceTypeName="resTypeName", displayName="displName", description="A resource
type", provider="Printer", matcher="com.printer.Printer",
actions="BWPrint;ColorPrint" [, delimeter=";"])

getResourceType

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアからリソース・タイプをフェッチするオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアの、指定された名前を持つ<resource-type>エントリの関連パラメータを取得します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getResourceType(appStripe, resourceTypeName)

引数

定義

appStripe

リソース・タイプのフェッチ元となるアプリケーション・ストライプを指定します。

resourceTypeName

フェッチするリソース・タイプの名前を指定します。

例

次の呼出しは、ストライプmyApplicationからリソース・タイプmyResTypeをフェッチします。

wls:/mydomain/serverConfig> getResourceType(appStripe="myApplication", resourceTypeName="myResType")

deleteResourceType

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアからリソース・タイプを削除するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアの、指定された名前を持つ<resource-type>エントリを削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

deleteResourceType(appStripe, resourceTypeName)

引数

定義

appStripe

リソース・タイプの削除元となるアプリケーション・ストライプを指定します。

resourceTypeName

削除するリソース・タイプの名前を指定します。

例

次の呼出しは、ストライプmyApplicationからリソース・タイプmyResTypeを削除します。

wls:/mydomain/serverConfig> deleteResourceType(appStripe="myApplication", resourceTypeName="myResType")

listAppStripes

ポリシー・ストア内のアプリケーション・ストライプを一覧表示するオンラインまたはオフライン・コマンド。

説明

このスクリプトは、オフライン・モードまたはオンライン・モードで実行できます。オフライン・モードで実行する場合は、構成ファイルを渡す必要があります。渡された構成ファイルのデフォルト・コンテキストで構成によって参照されるポリシー・ストア内のアプリケーション・ストライプが一覧表示されます。デフォルトの構成には、アイデンティティ・ストアへのサービス・インスタンス参照があってはいけません。オンライン・モードで実行する場合は、構成ファイルを渡さないでください。接続しているドメインのポリシー・ストア内のストライプが一覧表示されます。いずれのモードでも、正規表現が渡されると、その正規表現に一致する名前を持つアプリケーション・ストライプが一覧表示されます。それ以外の場合は、すべてのアプリケーション・ストライプが一覧表示されます。

データベース・ベースのストアへの再関連付け後にこのコマンドをオフライン・モードで使用する場合は、Oracle Fusion Middlewareセキュリティ・ガイドのデータベース・ベースのストアへの再関連付け後のlistAppStripesの実行に関する項の説明に従って、再関連付けで生成された構成ファイルを手動で編集する必要があります。

構文

listAppStripes([configFile="configFileName"] [, regularExpression="aRegExp"])

引数

定義

configFile

OPSS構成ファイルへのパスを指定します。オプション。指定した場合、スクリプトはオフラインで実行されます。指定された構成ファイルのデフォルト・コンテキストに、アイデンティティ・ストアへのサービス・インスタンス参照があってはいけません。指定しない場合、スクリプトはオンラインで実行され、ポリシー・ストア内のアプリケーション・ストライプが一覧表示されます。

regularExpression

正規表現を指定します。この正規表現に一致するストライプ名が戻されます。オプション。指定しない場合、すべての名前が一致します。サブストリングに一致させるには、文字*を使用します。

例

次の(オンライン)呼出しは、ポリシー・ストア内のアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes

次の(オフライン)呼出しは、指定された構成ファイルのデフォルト・コンテキストで参照されるポリシー・ストア内のアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes(configFile="
/home/myFile/jps-config.xml")

次の(オンライン)呼出しは、接頭辞Appを含むアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes(regularExpression="App*")

createResource

新しいリソースを作成するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内に、指定されたタイプのリソースを作成します。渡されるリソース・タイプは、渡されるアプリケーション・ストライプ内に存在している必要があります。

構文

createResource(appStripe="appStripeName", name="resName", type="resTypeName" [,-displayName="dispName"] [,-description="descript"])

引数

定義

appStripe

リソースの作成対象のアプリケーション・ストライプを指定します。

name

作成するリソースの名前を指定します。

type

作成するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。

displayName

作成するリソースの表示名を指定します。オプション。

description

作成するリソースの説明を指定します。オプション。

例

次の呼出しは、ストライプmyApplication内にリソースmyResourceを作成します。

wls:/mydomain/serverConfig> createResource(appStripe="myApplication", name="myResource", type="myResType", displayName="myNewResource")

deleteResource

リソースを削除するオンライン・コマンド。

説明

アプリケーション・ストライプ内の資格からリソースおよびそのすべての参照を削除します。このコマンドは、カスケード削除を実行します。資格が1つのリソースのみを参照している場合は、その資格を削除し、それ以外の場合は、渡されたタイプのリソース・アクションを資格から削除します。

構文

deleteResource(appStripe="appStripeName", name="resName", type="resTypeName")

引数

定義

appStripe

リソースの削除対象のアプリケーション・ストライプを指定します。

name

削除するリソースの名前を指定します。

type

削除するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。

例

次の呼出しは、ストライプmyApplication内のリソースmyResourceを削除します。

wls:/mydomain/serverConfig> deleteResource(appStripe="myApplication", name="myResource", type="myResType")

listResources

指定されたアプリケーション・ストライプ内のリソースを一覧表示するオンライン・コマンド。

説明

リソース・タイプを指定した場合、指定されたリソース・タイプのすべてのリソースが一覧表示されます。それ以外の場合は、すべてのタイプのすべてのリソースが一覧表示されます。

構文

listResources(appStripe="appStripeName" [,type="resTypeName"])

引数

定義

appStripe

リソースの一覧表示対象のアプリケーション・ストライプを指定します。

type

一覧表示するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。

例

次の呼出しは、ストライプmyApplication内のタイプmyResTypeのリソースをすべて一覧表示します。

wls:/mydomain/serverConfig> listResources(appStripe="myApplication", type="myResType")

listResourceActions

資格のリソースとアクションを一覧表示するオンライン・コマンド。

説明

アプリケーション・ストライプ内の資格のリソースとアクションを一覧表示します。

構文

listResourceActions(appStripe="appStripeName", permSetName="entitlementName")

引数

定義

appStripe

資格が存在するアプリケーション・ストライプを指定します。

permSetName

リソースとアクションを一覧表示する資格の名前を指定します。

例

次の呼出しは、ストライプmyApplication内の資格myEntitlementのリソースとアクションを一覧表示します。

wls:/mydomain/serverConfig> listResourceActions(appStripe="myApplication", permSetName="myEntitlement")

createEntitlement

新しい資格を作成するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプに、1つのリソースとアクションのリストを持つ新しい資格を作成します。既存の資格にリソースを追加するにはaddResourceToEntitlementを使用し、既存の資格からリソースを削除するにはrevokeResourceFromEntitlementを使用します。

構文

createEntitlement(appStripe="appStripeName", name="entitlementName", resourceName="resName", actions="actionList" [,-displayName="dispName"] [,-description="descript"])

引数

定義

appStripe

資格の作成対象のアプリケーション・ストライプを指定します。

name

作成する資格の名前を指定します。

resourceName

作成する資格の1つのリソース・メンバーの名前を指定します。

actions

リソースresourceNameのアクションのカンマ区切りのリストを指定します。

displayName

作成するリソースの表示名を指定します。オプション。

description

作成する資格の説明を指定します。オプション。

例

次の呼出しは、ストライプmyApplication内にリソースmyResourceのみを持つ資格myEntitlementを作成します。

wls:/mydomain/serverConfig> createEntitlement(appStripe="myApplication", name="myEntitlement", resourceName="myResource", actions="read,write")

getEntitlement

資格を取得するオンライン・コマンド。

説明

アプリケーション・ストライプ内の資格の名前、表示名およびすべてのリソース(とそれらの資格)を戻します。

構文

getEntitlement(appStripe="appStripeName", name="entitlementName")

引数

定義

appStripe

資格が存在するアプリケーション・ストライプを指定します。

name

アクセスする資格の名前を指定します。

例

次の呼出しは、ストライプmyApplication内の資格myEntitlementの情報を戻します。

wls:/mydomain/serverConfig> getEntitlement(appStripe="myApplication", name="myEntitlement")

deleteEntitlement

資格を削除するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内の資格を削除します。アプリケーション・ストライプ内の指定された資格へのすべての参照を削除することで、カスケード削除を実行します。

構文

deleteEntitlement(appStripe="appStripeName", name="entitlementName")

引数

定義

appStripe

資格の削除対象のアプリケーション・ストライプを指定します。

name

削除する資格の名前を指定します。

例

次の呼出しは、ストライプmyApplication内の資格myEntitlementを削除します。

wls:/mydomain/serverConfig> deleteEntitlement(appStripe="myApplication", name="myEntitlement")

addResourceToEntitlement

指定されたアクションを持つリソースを資格に追加するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内の資格に、指定されたアクションを持つリソースを追加します。渡されるリソース・タイプは、渡されるアプリケーション・ストライプ内に存在している必要があります。

構文

addResourceToEntitlement(appStripe="appStripeName", name="entName", resourceName="resName",actions="actionList")

引数

定義

appStripe

資格が存在するアプリケーション・ストライプを指定します。

name

変更する資格の名前を指定します。

resourceName

追加するリソースの名前を指定します。

resourceType

追加するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。

actions

追加されるリソースのアクションのカンマ区切りのリストを指定します。

例

次の呼出しは、アプリケーション・ストライプmyApplication内の資格myEntitlementにリソースmyResourceを追加します。

wls:/mydomain/serverConfig> addResourceToEntitlement(appStripe="myApplication",
name="myEntitlement", resourceName="myResource", resourceType="myResType",
actions="view,edit")

revokeResourceFromEntitlement

資格からリソースを削除するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内の資格からリソースを削除します。

構文

revokeResourceFromEntitlement(appStripe="appStripeName", name="entName", resourceName="resName", resourceType="resTypeName", actions="actionList")

引数

定義

appStripe

資格が存在するアプリケーション・ストライプを指定します。

name

変更する資格の名前を指定します。

resourceName

削除するリソースの名前を指定します。

resourceType

削除するリソースのタイプを指定します。

actions

削除するアクションのカンマ区切りのリストを指定します。

例

次の呼出しは、ストライプmyApplication内の資格myEntitlementからリソースmyResourceを削除します。

wls:/mydomain/serverConfig> revokeResourceFromEntitlement(appStripe="myApplication", name="myEntitlement",
resourceName="myResource", resourceType="myResType", actions="view,edit")

listEntitlements

アプリケーション・ストライプ内の資格を一覧表示するオンライン・コマンド。

説明

アプリケーション・ストライプ内のすべての資格を一覧表示します。リソース名およびリソース・タイプを指定した場合、指定されたリソース名に一致する、指定されたタイプのリソースを持つ資格が一覧表示されます。それ以外の場合は、アプリケーション・ストライプ内のすべての資格が一覧表示されます。

構文

listEntitlements(appStripe="appStripeName" [,resourceTypeName="resTypeName", resourceName="resName"])

引数

定義

appStripe

資格の一覧表示対象のアプリケーション・ストライプを指定します。

resourceTypeName

一覧表示するリソースのタイプの名前を指定します。オプション。

resourceName

一致させるリソースの名前を指定します。オプション。

例

次の呼出しは、ストライプmyApplication内のすべての資格を一覧表示します。

wls:/mydomain/serverConfig> listEntitlements(appStripe="myApplication")

次の呼出しは、リソース・タイプmyResType、およびリソース名がmyResNameに一致するリソースを含む、ストライプmyApplication内のすべての資格を一覧表示します。

wls:/mydomain/serverConfig> listEntitlements(appStripe="myApplication", resourceTypeName="myResType", resourceName="myResName")

grantEntitlement

新しい資格を作成するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内に、指定されたプリンシパルを持つ新しい資格を作成します。

構文

grantEntitlement(appStripe="appStripeName", principalClass="principalClass", principalName="principalName" ,-permSetName="entName")

引数

定義

appStripe

資格の作成対象のアプリケーション・ストライプを指定します。

principalClass

プリンシパルに関連付けられているクラスを指定します。

principalName

資格が付与されるプリンシパルの名前を指定します。

permSetName

作成する資格の名前を指定します。

例

次の呼出しは、ストライプmyApplication内に資格myEntitlementを作成します。

wls:/mydomain/serverConfig> grantEntitlement(appStripe="myApplication",
principalClass="oracle.security.jps.service.policystore.ApplicationRole",
principalName="myPrincipalName", permSetName="myEntitlement")

revokeEntitlement

資格を削除するオンライン・コマンド。

説明

資格を削除し、指定されたアプリケーション・ストライプ内のプリンシパルからその資格を取り消します。

構文

revokeEntitlement(appStripe="appStripeName", principalClass="principalClass", principalName="principalName" ,-permSetName="entName")

引数

定義

appStripe

資格の削除対象のアプリケーション・ストライプを指定します。

principalClass

プリンシパルに関連付けられているクラスを指定します。

principalName

資格が取り消されるプリンシパルの名前を指定します。

permSetName

削除する資格の名前を指定します。

例

次の呼出しは、ストライプmyApplication内の資格myEntitlementを削除します。

wls:/mydomain/serverConfig> revokeEntitlement(appStripe="myApplication",
principalClass="oracle.security.jps.service.policystore.ApplicationRole",
principalName="myPrincipalName", permSetName="myEntitlement")

listEntitlement

指定されたアプリケーション・ストライプ内の資格を一覧表示するオンライン・コマンド。

説明

プリンシパル名およびクラスを指定した場合、指定されたプリンシパルに一致する資格が一覧表示されます。それ以外の場合は、すべての資格が一覧表示されます。

構文

listEntitlement(appStripe="appStripeName" [, principalName="principalName", principalClass="principalClass"])

引数

定義

appStripe

資格の削除対象のアプリケーション・ストライプを指定します。

principalName

一致させるプリンシパルの名前を指定します。オプション。

principalClass

一致させるプリンシパルのクラスを指定します。オプション。

例

次の呼出しは、ストライプmyApplication内のすべての資格を一覧表示します。

wls:/mydomain/serverConfig> listEntitlement(appStripe="myApplication")

listResourceTypes

リソース・タイプを一覧表示するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のすべてのリソース・タイプを一覧表示します。

構文

listResourceTypes(appStripe="appStripeName")

引数

定義

appStripe

リソース・タイプが存在するアプリケーション・ストライプを指定します。

例

次の呼出しは、ストライプmyApplication内のすべてのリソース・タイプを一覧表示します。

wls:/mydomain/serverConfig> listEntitlement(appStripe="myApplication")

Oracle Access Management Access Managerコマンド

表4-5に示されているWLSTコマンドを使用して、認可プロバイダ、IDアサーション・プロバイダ、SSOプロバイダなど、Oracle Access Management Access Manager (Access Manager)関連コンポーネントの管理に加えて、メトリックおよびデプロイメント・トポロジの表示や、Access Managerサーバーとエージェントの構成の管理およびロガー設定の管理を行います。

表4-5 WLST Access Managerコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

updateCustomPages

カスタム・エラーとログイン・ページを有効または無効にします。

オンライン

オフライン

createUserIdentityStore

ユーザー・アイデンティティ・ストアの登録を作成します。

オンライン

オフライン

editUserIdentityStore

ユーザー・アイデンティティ・ストアの登録を編集します。

オンライン

オフライン

deleteUserIdentityStore

ユーザー・アイデンティティ・ストアの登録を削除します。

オンライン

オフライン

displayUserIdentityStore

ユーザー・アイデンティティ・ストアの登録を表示します。

オンライン

createOAMServer

Access Managerサーバー構成のエントリを作成します。

オンライン

オフライン

editOAMServer

Access Managerサーバー構成のエントリを編集します。

オンライン

オフライン

deleteOAMServer

指定されたAccess Managerサーバー構成を削除します。

オンライン

オフライン

displayOAMServer

Access Managerサーバー構成の詳細を表示します。

オンライン

オフライン

configurePersistentLogin

永続ログイン機能を有効または無効にします。

オンライン

configOAMLoginPagePref

Access Managerログイン・ページのユーザー・プリファレンスを構成します。

オンライン

configRequestCacheType

SSOサーバー・リクエスト・キャッシュ・タイプを構成します。

オンライン

displayRequestCacheType

SSOサーバー・リクエスト・キャッシュ・タイプ・エントリを表示します。

オンライン

オフライン

editOssoAgent

OSSOエージェント構成の詳細を編集します。

オンライン

オフライン

deleteOssoAgent

指定されたOSSOエージェント構成を削除します。

オンライン

オフライン

displayOssoAgent

OSSOエージェント構成の詳細を表示します。

オンライン

オフライン

editWebgateAgent

10g Webゲート・エージェントの登録の詳細を編集します。

オンライン

オフライン

deleteWebgateAgent

指定された10g Webゲート・エージェント構成を削除します。

オンライン

オフライン

displayWebgateAgent

Webゲート・エージェント構成の詳細を表示します。

オンライン

オフライン

exportPolicy

テスト(ソース)から中間Access ManagerファイルにAccess Managerポリシー・データをエクスポートします。

オンライン

importPolicy

指定されたAccess ManagerファイルからAccess Managerポリシー・データをインポートします。

オンライン

importPolicyDelta

指定されたAccess ManagerファイルからAccess Managerポリシーの変更をインポートします。

オンライン

migratePartnersToProd

ソースAccess Managerサーバーから指定されたターゲットAccess Managerサーバーにパートナを移行します。

オンライン

exportPartners

ソースから指定された中間Access ManagerファイルにAccess Managerパートナをエクスポートします。

オンライン

importPartners

指定された中間Access ManagerファイルからAccess Managerパートナをインポートします。

オンライン

displayTopology

デプロイ済のAccess Managerサーバーの詳細を一覧表示します。

オンライン

オフライン

configureOAAMPartner

Access ManagerとOracle Adaptive Access Managerの基本的な統合を構成します。

オンライン

registerOIFDAPPartner

Identity FederationをDelegated Authentication Protocol (DAP)パートナとして登録します。

オンライン

オフライン

registerOIFDAPPartnerIDPMode

IDPモードでIdentity Federationを登録します。

registerThirdPartyTAPPartner

任意のサード・パーティをTrusted Authentication Protocol (TAP)パートナとして登録します。

オンライン

disableCoexistMode

共存モードを無効にします。

オンライン

enableOamAgentCoexist

Access Managerエージェントの共存モードを有効にします(10g Webゲートによって設定されたObssocookieを所有するために、Access Manager 11gサーバーを有効にします)。

オンライン

disableOamAgentCoexist

Access Managerエージェントの共存モードを無効にします(10g Webゲートによって設定されたObssocookieからAccess Manager 11gサーバーを無効にします)。

オンライン

editGITOValues

GITO構成パラメータを編集します。

オンライン

editWebgate11gAgent

11g Webゲートの登録を編集します。

オンライン

オフライン

deleteWebgate11gAgent

11g Webゲート・エージェントの登録を削除します。

オンライン

オフライン

displayWebgate11gAgent

11g Webゲート・エージェントの登録を表示します。

オンライン

オフライン

displayOAMMetrics

Access Managerサーバーのメトリックを表示します。

オンライン

オフライン

updateOIMHostPort (非推奨)

Access Managerとの統合時にOracle Identity Manager構成を更新します。

オンライン

configureOIM (非推奨)

Access Managerとの統合時にOracle Identity Manager固有のエージェントの登録を作成します。

オンライン

updateOSSOResponseCookieConfig

OSSOプロキシ・レスポンスCookie設定を更新します。

オンライン

deleteOSSOResponseCookieConfig

OSSOプロキシ・レスポンスCookie設定を削除します。

オンライン

configureAndCreateIdentityStore

アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。

オンライン

configAndCreateIdStoreUsingPropFile

ファイル内に定義されている値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。

オンライン

migrateArtifacts (deprecated)

指定されたアーティファクト・ファイルに基づいてアーティファクトを移行します。

オンライン

displaySimpleModeGlobalPassphrase

システム構成から簡易モードのグローバル・パスフレーズを平文で表示します。

オンライン

exportSelectedPartners

指定された中間Access Managerファイルに、選択されたAccess Managerパートナをエクスポートします。

オンライン

oamMigrate

OSSO、OAM10g、OpenSSOまたはAM 7.1からOAM11gにポリシー、認証ストアおよびユーザー・ストアを移行します。

オンライン

preSchemeUpgrade

preSchemeUpgrade操作を呼び出します。

オンライン

postSchemeUpgrade

postSchemeUpgrade操作を呼び出します。

オンライン

oamSetWhiteListMode

trueに設定すると、Access Managerサーバーは、WhiteListURLリスト内で指定されているURLにのみリダイレクトされます。

オンライン

oamWhiteListURLConfig

構成ファイルにおいて、ホワイトリストURLエントリを追加、更新または削除します。

オンライン

enableMultiDataCentreMode

マルチ・データ・センター・モードを有効にします。

オンライン

disableMultiDataCentreMode

マルチ・データ・センター・モードを無効にします。

オンライン

setMultiDataCentreClusterName

マルチ・データ・センター・クラスタ名を設定します。

オンライン

setMultiDataCentreLogoutURLs

マルチ・データ・センター・ログアウトURLを設定します。

オンライン

addPartnerForMultiDataCentre

マルチ・データ・センターのパートナを追加します。

オンライン

removePartnerForMultiDataCentre

マルチ・データ・センターからパートナを削除します。

オンライン

updateCustomPages

カスタム・エラーとログイン・ページの構成を有効または無効にします。

説明

カスタム・エラーとログイン・ページを含むWARを指し示すoam-config.xmlへのコンテキスト・パスとページ拡張機能を追加します:

<Setting Name="ssoengine" Type="htf:map">
<Setting Name="ErrorConfig" Type="htf:map">
<Setting Name="ErrorMode" Type="xsd:string">EXTERNAL</Setting>
<Setting Name="CustomPageExtension" Type="xsd:string">jsp</Setting>
<Setting Name="CustomPageContext" Type="xsd:string">/SampleApp</Setting>
</Setting>
</Setting>

構文

updateCustomPages(pageExtension="<fileExtension>", context="<contextPath>")

引数

定義

context

アプリケーションへのコンテキスト・パスを指定します(例: /SampleApp)。

pageExtension

デフォルト値はjspですが、ブランクのままにすることができます。

例

カスタム・エラー・ページの機能を有効にするには、updateCustomPagesをcontextおよびpageExtensionパラメータとともに使用します。これにより、oam-config.xmlファイルが変更され、カスタム・ページ機能が有効になります。

updateCustomPages(pageExtension ="jsp", context="/SampleApp")

カスタム・エラー・ページ機能を無効にするには、パラメータなしでコマンドを使用します[updateCustomPages()]。これにより、パラメータを使用してコマンドが実行されたときに行われた変更が元に戻ります。

createUserIdentityStore

Access Managerシステム構成にアイデンティティ・ストア登録を作成します。

説明

Access Managerに登録する新しいユーザー・アイデンティティ・ストアのための、システム構成のエントリを作成します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

createUserIdentityStore(name="<Name>", principal="<Principal>",
credential="<Credential>", type="<Type>", userAttr="<userAttr>",
ldapProvider="<ldapProvider>", userSearchBase="<userSearchBase>",
ldapUrl="<ldapUrl>", isPrimary="<isPrimary>", isSystem="<isSystem>",
userIDProvider="<userIDProvider>", roleSecAdmin="<roleSecAdmin>",
roleSysMonitor="<roleSysMonitor>", roleAppAdmin="<roleAppAdmin>",
roleSysManager="<roleSysManager>", roleSecAdminGroups="<roleSecAdminGroups>",
roleSecAdminUsers="<roleSecAdminUsers>", groupSearchBase="<groupSearchBase>",
supplementaryReturnAttributes="<supplementaryReturnAttributes>",
domainHome="<domainHome>")

引数

定義

name

必須。作成するLDAPアイデンティティ・ストアの一意の名前を指定します。大文字と小文字の英字および数字のみを使用します。

principal

必須。作成するLDAPアイデンティティ・ストアのプリンシパル管理者を指定します。たとえば、cn=Adminです。

credential

必須。作成するLDAPアイデンティティ・ストアのプリンシパルのパスワードを指定します。

type

必須。作成するLDAPアイデンティティ・ストアのタイプを指定します。このコマンドでは、値はLDAPになります。

userAttr

必須。作成するLDAPアイデンティティ・ストアのユーザー属性を指定します。

ldapProvider

必須。作成するLDAPアイデンティティ・ストアのタイプを指定します。値は、ODSEE、AD、OID、OVD、SJS、OUDなどです。この値は、Access Manager管理コンソールを使用して新しいユーザー・アイデンティティ・ストアが作成されるときに定義され、ユーザー・アイデンティティ・ストア内のストア・タイプに一致します。

userSearchBase

必須。作成するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。たとえば、cn=usersです。

groupSearchBase

必須。作成するLDAPアイデンティティ・ストア内の、グループ・データが格納されるノードを指定します。たとえば、cn=groupsです。

ldapUrl

必須。作成するLDAPアイデンティティ・ストアのサーバー・ホストのURL(ポート番号を含む)を指定します。たとえば、ldap://localhost:7001です。

isPrimary

オプション。作成するLDAPアイデンティティ・ストアがプライマリ・アイデンティティ・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。

isSystem

オプション。作成するLDAPアイデンティティ・ストアがシステム・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。

userIDProvider

オプション。アイデンティティ・ストアへの接続に使用される基礎となるインフラストラクチャを指定します。サポートされているタイプはOracleUserRoleAPIのみです。

roleSecAdminGroups

オプション。Access Managerコンソール管理者権限を持つ1つ以上のグループをカンマで区切って指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。

roleSecAdminUsers

オプション。Access Managerコンソール管理者権限を持つ1人以上のユーザーをカンマで区切って指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。

roleSecAdmin

オプション。作成するLDAPアイデンティティ・ストアのセキュリティ管理者を指定します。

roleSysMonitor

オプション。作成するLDAPアイデンティティ・ストアのシステム・モニターを指定します。

roleAppAdmin

オプション。作成するLDAPアイデンティティ・ストアのアプリケーション管理者を指定します。

roleSysManager

オプション。作成するLDAPアイデンティティ・ストアのシステム管理者を指定します。

supplementaryReturnAttributes

Userオブジェクトの一部として取得する必要のある属性のカンマ区切りのリストを指定します。例: ORCL_USR_ENC_FIRST_NAME,ORCL_USR_ENC_LAST_NAME,USR_USRNAME,ORCL_USR_CTY_CODE,ORCL_USR_LANG_CODE_S,ORCL_USR_JROLE_ID_S,ORCL_USR_IND_ID,ORCL_USR_COMP_REL_ID,ORCL_USR_ASCII_IND,ORCL_ORA_UCM_VER,ORCL_ORA_UCM_SRVC

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。

例

次の例では、Access Managerで使用するための新しいOracle Internet Directoryユーザー・アイデンティティ・ストア定義を登録します。

createUserIdentityStore(name="Name1", principal="Principal1",
credential="Credential1", type="Type1", userAttr="userAttr1",
ldapProvider="ldapProvider", userSearchBase="userSearchBase", ldapUrl="ldapUrl",
isPrimary="isPrimary", isSystem="isSystem", userIDProvider="userIDProvider",
roleSecAdmin="<roleSecAdmin>", roleSysMonitor="<roleSysMonitor>",
roleAppAdmin="<roleAppAdmin>", roleSysManager="<roleSysManager>",
roleSecAdminGroups="<roleSecAdminGroups>",
roleSecAdminUsers="<roleSecAdminUsers>", groupSearchBase="groupSearchBase",
supplementaryReturnAttributes="supplementaryReturnAttributes",
domainHome="domainHome1")

editUserIdentityStore

Access Manager用の定義済のアイデンティティ・ストアの登録を変更するオンラインおよびオフライン・コマンド。

説明

Access Managerに登録されているユーザー・アイデンティティ・ストアの属性を1つ以上変更します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editUserIdentityStore(name="<Name>", [ principal="<Principal>",
credential="<Credential>", type="<Type>", userAttr="<userAttr>",
ldapProvider="<ldapProvider>", roleSecAdmin="<roleSecAdmin>",
roleSysMonitor="<roleSysMonitor>", roleSysManager="<roleSysManager>" ,
roleAppAdmin="<roleAppAdmin>", roleSecAdminGroups="<roleSecAdminGroups>",
roleSecAdminUsers="<roleSecAdminUsers>", userSearchBase="<userSearchBase>",
ldapUrl="<ldapUrl>", isPrimary="<isPrimary>", isSystem="<isSystem>",
userIDProvider="<userIDProvider>" , groupSearchBase="<groupSearchBase>",
domainHome="<domainHome>", userFilterObjectClasses="<userFilterObjectClasses>",
groupFilterObjectClasses="<groupFilterObjectClasses>",
referralPolicy="<referralPolicy>", searchTimeLimit="<searchTimeLimit>",
minConnections="<minConnections>", maxConnections="<maxConnections>",
connectionWaitTimeout="<connectionWaitTimeout>",
connectionRetryCount="<connectionRetryCount>", groupNameAttr="<groupNameAttr>",
groupCacheEnabled="<groupCacheEnabled>", groupCacheSize="<groupCacheSize>",
groupCacheTTL=<"groupCacheTTL>",
supplementaryReturnAttributes="<supplementaryReturnAttributes>" )

引数

定義

name

必須。変更するLDAPアイデンティティ・ストアの一意の名前を指定します。大文字と小文字の英字および数字のみを使用します。

principal

変更するLDAPアイデンティティ・ストアのプリンシパル管理者を指定します。たとえば、cn=Adminです。

credential

変更するLDAPアイデンティティ・ストアのプリンシパル管理者の暗号化パスワードを指定します。

type

変更するベース・アイデンティティ・ストアのタイプを指定します。このコマンドでは、値はLDAPになります。

userAttr

必須。変更するLDAPアイデンティティ・ストアのユーザー属性を指定します。

ldapProvider

必須。登録するLDAPアイデンティティ・ストアのLDAPタイプを指定します。値は、ODSEE、AD、OID、OVD、SJS、OUDなどです。この値は、Access Manager管理コンソールを使用して新しいユーザー・アイデンティティ・ストアが作成されるときに定義され、ユーザー・アイデンティティ・ストア内のストア・タイプに一致します。

roleSecAdminGroups

オプション。Access Managerコンソール管理者権限を持つ1つ以上のグループをカンマで区切って指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。

roleSecAdminUsers

オプション。Access Managerコンソール管理者権限を持つ1人以上のユーザーをカンマで区切って指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。

roleSecAdmin

オプション。変更するLDAPアイデンティティ・ストアのセキュリティ管理者を指定します。

roleSysMonitor

オプション。変更するLDAPアイデンティティ・ストアのシステム・モニターを指定します。

roleAppAdmin

オプション。変更するLDAPアイデンティティ・ストアのアプリケーション管理者を指定します。

roleSysManager

オプション。変更するLDAPアイデンティティ・ストアのシステム管理者を指定します。

userSearchBase

必須。変更するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。たとえば、cn=usersです。

groupSearchBase

必須。変更するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。たとえば、cn=groupsです。

ldapUrl

必須。変更するLDAPアイデンティティ・ストアのサーバー・ホストのURL(ポート番号を含む)を指定します。たとえば、ldap://localhost:7001です。

isPrimary

オプション。変更するLDAPアイデンティティ・ストアがプライマリ・アイデンティティ・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。

isSystem

オプション。変更するLDAPアイデンティティ・ストアがシステム・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。

userIDProvider

オプション。アイデンティティ・ストアへの接続に使用される基礎となるインフラストラクチャを指定します。サポートされているタイプはOracleUserRoleAPIのみです。

supplementaryReturnAttributes

Userオブジェクトの一部として取得する必要のある属性のカンマ区切りのリストを指定します。例: ORCL_USR_ENC_FIRST_NAME,ORCL_USR_ENC_LAST_NAME,USR_USRNAME,ORCL_USR_CTY_CODE,ORCL_USR_LANG_CODE_S,ORCL_USR_JROLE_ID_S,ORCL_USR_IND_ID,ORCL_USR_COMP_REL_ID,ORCL_USR_ASCII_IND,ORCL_ORA_UCM_VER,ORCL_ORA_UCM_SRVC

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

userFilterObjectClasses

必須。セミコロン区切りのユーザー・フィルタ・オブジェクト・クラスのリストを指定します。

groupFilterObjectClasses

グループ・フィルタ・オブジェクト・クラスのリスト(セミコロンで区切られたもの)を指定します。

referralPolicy

LDAP参照ポリシー(follow、ignore、throwのいずれか)を指定します。

searchTimeLimit

LDAP検索操作の時間制限(秒単位)を指定します。

minConnections

接続プール内の最小接続数を指定します。

maxConnections

接続プール内の最大接続数を指定します。

connectionWaitTimeout

プールから接続を取得するために待機する秒数を指定します。

connectionRetryCount

アイデンティティ・ストアへの接続を確立する際の再試行回数を指定します。

groupNameAttr

ユーザー・グループを検索するための属性の名前を指定します。たとえば、ou=people,ou=myrealm,dc=base_domainです。

groupCacheEnabled

LDAPグループ・キャッシュを有効にするかどうかを指定するブール値。値としてtrueまたはfalseを取ります。

groupCacheSize

LDAPグループ・キャッシュ内のエントリの数を指定します。

groupCacheTTL

LDAPグループ・キャッシュ内の各エントリの合計存続時間を指定します。

例

次の例では、登録されているアイデンティティ・ストアの検索ベースの値を変更します。

editUserIdentityStore(name="IdStore1", userSearchBase="cn=users", groupSearchBase="cn=groups")

deleteUserIdentityStore

Access Manager用の定義済のアイデンティティ・ストアの登録を削除するオンラインおよびオフライン・コマンド。

説明

アイデンティティ・ストアの登録を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteUserIdentityStore(name="<name>", domainHome="<domainHome>")

引数

定義

name

必須。削除するLDAPアイデンティティ・ストアの登録の名前を指定します。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例はWebSphereで使用でき、指定されたアイデンティティ・ストアの登録を削除します。WebLogic Serverのオンライン・モードでこのコマンドを使用するためには、domainHome引数を指定する必要はありません。

deleteUserIdentityStore(name="identity_store", domainHome="domainHome1")

displayUserIdentityStore

ユーザー・アイデンティティ・ストアの登録に関する情報を表示するオンライン・コマンド。

説明

Access Managerに登録されているアイデンティティ・ストアに関する情報を表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayUserIdentityStore(name="<name>", domainHome="<domainHome>")

引数

定義

name

必須。表示するLDAPアイデンティティ・ストアの登録の名前を指定します。

domainhome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。

例

WebSphere用の次の呼出しの例は、ユーザー・アイデンティティ・ストアの登録の詳細を表示します。WebLogicのオンライン・モードでこのコマンドを使用するために、domainHome引数を指定する必要はありません。

displayUserIdentityStore(name="ID_Store1", domainHome="domainHome1")

createOAMServer

システム構成内にAccess Managerサーバー・エントリを作成するオンラインおよびオフライン・コマンド。

説明

Access Managerサーバーの登録を作成します。詳細には、ホスト、ポート、登録名、Access Managerプロキシ・ポート、サーバーID、およびオプションでOAMプロキシ共有シークレットが含まれます。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

createOAMServer(configurationProfile="<configurationProfile>", host="<host>",port="<port>", oamProxyPort="<0000>", oamProxyServerID="<oamProxyServerID>",siteName="<siteName>", domainHome="<domainHome>")

引数

定義

configurationProfile

必須。OAM Serverの構成プロファイルを指定します。プロファイルは、Access Manager管理コンソールの「システム構成」タブの「サーバー・インスタンス」の下に表示されます。

host

必須。Access Managerサーバー・ホストの名前を指定します。

port

必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。

oamProxyPort

必須。Access Managerサーバー・ホストのプロキシ・ポートを指定します。

oamProxyServerID

必須。Access Managerサーバー・ホストのプロキシ・サーバーIDを指定します。Access Managerプロキシ名は、Access Manager管理コンソールのサーバー・インスタンスのAccess Managerプロキシ・サブタブの下に表示されます。

siteName

必須。インスタンスのsiteName/serverNameを指定します。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、リスニング・ポート15000でmy_hostの構成を作成します。Access Manager管理コンソール内のAccess Manager構成エントリは、oam_server1になります。Access Managerプロキシ・ポートは3004、Access Managerプロキシ・サーバーIDはoamProxyServerID1です。

createOAMServer(configurationProfile="oam_server1", host="my_host",
port="15000", oamProxyPort="3004", oamProxyServerID="oamProxyServerID1",
siteName="siteName1", domainHome="domainHome1")

editOAMServer

Access Managerサーバーの登録の詳細を変更するオンラインおよびオフライン・コマンド。

説明

指定された、Access Managerサーバーの登録のパラメータ値を変更します。詳細には、ホスト、ポート、登録名、Access Managerプロキシ・ポート、サーバーID、およびオプションでAccess Managerプロキシ共有シークレットなどが含まれます。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editOAMServer(configurationProfile="<configurationProfile>", host="<host>",port="<port>", oamProxyPort="<0000>", oamProxyServerID="<oamProxyServerID>",siteName="<siteName>", domainHome="<domainHome>")

引数

定義

configurationProfile

必須。Access Managerサーバーの構成プロファイルを指定します。プロファイルは、Access Manager管理コンソールの「システム構成」タブの「サーバー・インスタンス」の下に表示されます。

host

必須。Access Managerサーバー・ホストの名前を指定します。

port

必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。

oamProxyPort

必須。Access Managerサーバー・ホストのプロキシ・ポートを指定します。

oamProxyServerID

必須。Access Managerサーバー・ホストのプロキシ・サーバーIDを指定します。Access Managerプロキシ名は、Access Manager管理コンソールのサーバー・インスタンスのAccess Managerプロキシ・サブタブの下に表示されます。

siteName

必須。インスタンスのsiteName/serverNameを指定します。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

任意のオプションの属性を使用して、現在の設定を変更できます。次の呼出しは、Access Managerプロキシ・サーバーIDを構成エントリoam_server1に追加します。

editOAMServer(configurationProfile="oam_server1", host="my_host",
port="15000", oamProxyPort="3004", oamProxyServerID="oamProxyServerID1",
siteName="siteName1", domainHome="domainHome1")

deleteOAMServer

指定されたAccess Managerサーバーの登録を削除するオンラインおよびオフライン・コマンド。

説明

指定されたAccess Managerサーバー構成を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteOAMServer(host="<host>", port="<port>", domainHome="<domainHome>")

引数

定義

host

必須。Access Managerサーバー・ホストの名前を指定します。

port

必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、リスニング・ポートが15000であるoam_server1Access Managerサーバーの登録を削除します。

deleteOAMServer(host="oam_server1", port="15000", domainHome="domainHome1")

displayOAMServer

指定されたAccess Managerサーバーの登録の詳細を表示するオンラインおよびオフライン・コマンド。

説明

指定されたAccess Managerサーバーの登録の詳細を表示します。この詳細には、ホスト、ポート、登録名、Access Managerプロキシ・ポート、サーバーID、およびオプションでAccess Managerプロキシ共有シークレットが含まれます。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayOAMServer(host="<host>", port="<port>", domainHome="<domainHome>")

引数

定義

host

必須。Access Managerサーバー・ホストの名前を指定します。

port

必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、my_host Access Managerサーバー固有のすべてのメトリックを一覧表示します。

displayOAMServer(host="my_host", port="15000", domainHome="domainHome1")

configurePersistentLogin

永続ログイン機能を有効、無効にするオンライン・コマンド。

configurePersistentLogin

永続ログイン機能を有効にするコマンド。

説明

永続ログイン機能を有効にします。

構文

configurePersistentLogin(enable="true/false",
validityInDays="<#>", maxAuthnLevel="<#>", userAttribute="<userAttr>")

引数

定義

enable

必須。trueまたはfalseを指定します。

validityInDays

必須。特定のブラウザ・インスタンスまたはデバイスで永続するユーザー・ログインの日数を指定します。

maxAuthnLevel

必須。永続ログインを通じて自動的に再認証された後で許可される最大認証レベルを指定します。

userAttr

必須。永続ログインのプロパティが格納されるユーザー属性を指定します。

例

次の例では、登録されているアイデンティティ・ストアの検索ベースの値を変更します。

configurePersistentLogin(enable="true", validityInDays="30", maxAuthnLevel="2"
userAttribute="obPSFTID")

configOAMLoginPagePref

Access Managerログイン・ページのユーザー・プリファレンスを構成するオンライン・コマンド。

説明

Access Managerログイン・ページのユーザー・プリファレンスを構成します。

構文

configOAMLoginPagePref(persistentCookie="true", persistentCookieLifetime=14,
langPrefCookieDomain="oracle.com", langPrefOrder="serverOverrideLangPref,
oamPrefsCookie, browserAcceptLanguage, defaultLanguage",
serverOverrideLanguage="en", defaultLanguage="en",
applicationSupportedLocales="en,fr")

引数

定義

persistentCookie

必須。OAM_LANG_PREF Cookieが永続的であるか非永続的であるかを定義するブール。trueまたはfalseに設定します。

persistentCookieLifetime

必須。永続的なOAM_LANG_PREF Cookieの存続期間を示します。

langPrefCookieDomain

必須。OAM_LANG_PREF Cookieのドメインを定義します。

langPrefOrder

必須。言語の優先順位を決定します。構文と例としてフォーマットする必要があります。許容される値セットは、(serverOverrideLangPref,oamPrefsCookie,browserAcceptLanguage,defaultLanguage)です。

oamAppCookie、oamLocaleHeader、oamPrefsCookie、browserAcceptLanguage、serverOverrideLangPref

serverOverrideLanguage

Access Managerのサーバー側言語言語コードで定義し、OAM対応の言語から選択している必要があります。デフォルト値はenです。

defaultLanguage

デフォルト言語。

applicationSupportedLocales

カンマ区切りリストに定義されているサポートされている言語。applicationSupportedLocales="en,fr"を設定することにより、OAMログイン・ページにフランス語と英語を含む値のリストが確実に表示されます。サポートされている言語コードを、次の表4-6に示します。

表4-6 ログイン・ページの言語コード

言語コード

言語

管理者

ar

アラビア語

cs

チェコ語

da

デンマーク語

de

ドイツ語

ドイツ語

el

ギリシャ語

en

英語

英語

es

スペイン語

スペイン語

fi

フィンランド語

fr

フランス語

フランス語

fr-CA

フランス語(カナダ)

フランス語(カナダ)

he

ヘブライ語

hr

クロアチア語

hu

ハンガリー語

it

イタリア語

イタリア語

ja

日本語

日本語

ko

韓国語

韓国語

nl

オランダ語

no

ノルウェー語

pl

ポーランド語

pt-BR

ポルトガル語(ブラジル)

ポルトガル語(ブラジル)

pt

ポルトガル語

ro

ルーマニア語

ru

ロシア語

sk

スロバキア語

sv

スウェーデン語

th

タイ語

tr

トルコ語

zh-cn

簡体字中国語

簡体字中国語

zh-tw

繁体字中国語

繁体字中国語

例

configOAMLoginPagePref(persistentCookie="true", persistentCookieLifetime=14,
langPrefCookieDomain="oracle.com", langPrefOrder="serverOverrideLangPref,
oamPrefsCookie, browserAcceptLanguage, defaultLanguage",
serverOverrideLanguage="en", defaultLanguage="en",
applicationSupportedLocales="en,fr")

次の例により、管理者は値の言語リストが表示されない、デフォルトの動作に戻ることができます。

configOAMLoginPagePref(persistentCookie="true",
persistentCookieLifetime=14,langPrefCookieDomain="example.com",
langPrefOrder="serverOverrideLangPref,oamPrefsCookie,browserAcceptLanguage,
defaultLanguage",serverOverrideLanguage="",
defaultLanguage="en",applicationSupportedLocales="")

configRequestCacheType

システム構成内にSSOサーバー・リクエスト・キャッシュ・タイプを定義するオンラインおよびオフライン・コマンド。

説明

システム構成内にSSOサーバー・リクエスト・キャッシュ・タイプを定義します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

configRequestCacheType(type="<requestCacheType>", domainHome="<domainHome>")

引数

定義

type

必須。リクエスト・キャッシュ・タイプを指定します。値としてBASICまたはCOOKIEを取ります。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、リクエスト・キャッシュ・タイプをCookieとして定義します。

configRequestCacheType(type="COOKIE")

displayRequestCacheType

指定されたドメインに対して定義されているSSOサーバー・リクエスト・キャッシュ・タイプを表示するオンラインおよびオフライン・コマンド。リクエスト・キャッシュ・タイプは、BASICまたはCOOKIEです。

説明

指定されたドメインに対して定義されているSSOサーバー・リクエスト・キャッシュ・タイプ・エントリを表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayRequestCacheType(domainHome="<domainHome>")

引数

定義

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、指定されたドメイン・ホームに対して定義されているリクエスト・キャッシュ・タイプ(BASICまたはCOOKIE)を表示します。

displayRequestCacheType(domainHome="domainHome1")

editOssoAgent

システム構成内のOpenSSO (OSSO)エージェントの登録の詳細を変更するオンラインおよびオフライン・コマンド。

説明

サイト・トークン、成功URL、失敗URL、ホームURL、ログアウトURL、開始日、終了日、管理者ID、管理者情報など、OSSOエージェントの登録の詳細を変更します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editOssoAgent(agentName="AgentName", partnerId = "<partnerId>",
siteToken = "<siteToken>", siteName = "<siteName>", successUrl ="<successUrl>",
failureUrl = "<failureUrl>", homeUrl="<homeUrl>", logoutUrl="<logoutUrl>", startDate = "<startDate>", endDate = "<endDate>", adminId = "<adminId>",
adminInfo = "<AdminInfo>", domainHome="<domainHomeName>")

引数

定義

agentName

必須。変更するOSSOエージェント・エントリの名前を指定します。

adminIdは、OSSOエージェントの管理者IDです(オプション)。

adminInfoは、OSSOエージェントの管理者情報です(オプション)。

partnerId

オプション。OSSOエージェント・インスタンスのエージェント名を指定します。

siteToken

オプション。認証の要求時にパートナが使用するアプリケーション・トークンを指定します。

siteName

オプション。OSSOエージェント・インスタンスのSiteName/ServerNameを指定します。

successUrl

オプション。認証が成功した場合に、OSSOエージェントが使用するリダイレクトURLを指定します。

failureUrl

オプション。認証が失敗した場合に、OSSOエージェントが使用するリダイレクトURLを指定します。

homeUrl

オプション。認証後、ホーム・ページで使用するリダイレクトURLを指定します。

logoutUrl

オプション。ユーザーがログアウトしたときに使用するリダイレクトURLを指定します。

startDate

オプション。アプリケーションへのログインがサーバーによって許可される最初の年月日を指定します。

endDate

オプション。アプリケーションへのログインがサーバーによって許可される最後の年月日を指定します。

adminId

オプション。OSSOエージェントの管理者ログインIDを指定します。

adminInfo

オプション。トラッキング目的の、OSSOエージェントの管理者IDを指定します。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、OSSOAgent1の登録エントリ内の管理者IDおよび情報を変更します。

editOssoAgent(agentName = "OSSOAgent1", partnerId = "partnerId",
siteToken = "siteToken", siteName = "siteName", successUrl="successUrl",
failureUrl = "failureUrl", homeUrl="homeUrl", logoutUrl="logoutUrl",
startDate = "2009-12-10", endDate = "2012-12-30", adminId = "345",
adminInfo = "Agent11", domainHome="domainHome1")

deleteOssoAgent

システム構成内の、指定されたOSSOエージェントの登録を削除するオンラインおよびオフライン・コマンド。

説明

システム構成内の、指定されたOSSOエージェントの登録を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteOssoAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数

定義

agentName

必須。削除するOSSOエージェント・エントリの名前を指定します。

domainhome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、OSSOAgent1という名前のOSSOエージェントの登録エントリを削除します。

deleteOssoAgent(agentName="OSSOAgent1", domainHome="domainHome1")

displayOssoAgent

システム構成内の、指定されたOSSOエージェント・エントリの詳細を表示するオンラインおよびオフライン・コマンド。

説明

Access Manager管理コンソールに、指定されたOSSOエージェント・エントリの詳細を表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayOssoAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数

定義

agentName

必須。表示するOSSOエージェント・エントリの名前を指定します。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、OSSOAgent1エントリの詳細を表示します。

displayOssoAgent(agentName="OSSOAgent1", domainHome="domainHome1")

editWebgateAgent

システム構成内の、Webゲート10gの登録エントリを変更するオンラインおよびオフライン・コマンド。

説明

システム構成内の、Webゲート10gの登録エントリを変更します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editWebgateAgent(agentName="<AgentName>",
accessClientPasswd="<accessClientPassword >",state="<state>", preferredHost="<host>",
aaaTimeOutThreshold="<aaaTimeoutThreshold >", security="<security>",primaryCookieDomain="<primaryCookieDomain>", maxConnections="<maxConnections>",maxCacheElems="<maxCacheElements >", cacheTimeout="<cacheTimeOut>",
cookieSessionTime="<cookieSessionTime >", maxSessionTime="<maxSessionTime>",
idleSessionTimeout="<idleSessionTimeout >",failoverThreshold="<failoverThreshold >", domainHome="<domainHomeName>")

引数

定義

agentName

必須。変更するWebゲート・エージェントの名前を指定します。

accessClientPasswd

オプション。Webゲート・エージェントのアクセス・クライアント・パスワードを指定します。

state

オプション。Webゲート・エージェントを有効にするか、無効にするかを指定します。値はそれぞれ、EnabledまたはDisabledです。

preferredHost

オプション。Webゲート・エージェントの優先ホストを指定します。これにより、ホストの識別子がホスト識別子リストに含まれていない場合に生じる可能性があるセキュリティ・ホールを防ぐことができます。仮想ホスティングでは、ホスト識別子機能を使用する必要があります。

aaaTimeOutThreshold

オプション。Access Managerランタイム・サーバーからの応答を待機する秒数を指定します。このパラメータが設定された場合、アプリケーションのTCP/IPタイムアウトとして、デフォルトのTCP/IPタイムアウトではなくこの値が使用されます。デフォルト = -1(デフォルトのネットワークTCP/IPタイムアウトが使用されます)

security

オプション。Access Managerランタイム・サーバーに対するトランスポート・セキュリティのレベルを指定します。値としてopen、simpleまたはcertのいずれかを取ります。

primaryCookieDomain

オプション。Access Managerエージェントのデプロイ先のWebサーバー・ドメインを指定します。たとえば、acompany.comです。

maxConnections

オプション。このAccess ManagerエージェントがAccess Managerサーバーで確立できる接続の最大数を指定します。この数は、このエージェントに実際に関連付けられている接続の数と同じか、それを超える数である必要があります。デフォルト = 1

maxCacheElems

オプション。キャッシュ内で維持される要素の最大数を指定します。キャッシュ要素は、URLまたは認証スキームです。この設定の値は、これら両方のキャッシュ内の要素の最大合計カウントを意味します。デフォルト = 10000

cacheTimeout

オプション。キャッシュされた情報が使用も参照もされない場合に、その情報がAccess Managerエージェント・キャッシュ内にとどまる時間を指定します。デフォルトは1800(秒)です。

cookieSessionTime

オプション。ObSSOCookieが保持される時間を指定します。デフォルトは3600(秒)です。

maxSessionTime

オプション。ユーザーの認証セッションが、そのアクティビティに関係なく有効である最大時間(秒単位)を指定します。この時間が経過すると、ユーザーは、再度認証を求められます。これは強制的なログアウトです。値0を指定すると、このタイムアウト設定は無効になります。デフォルトは3600(秒)です。

idleSessionTimeout

ドメイン・ホームの場所を指定します。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

failoverThreshold

オプション。このAccess ManagerエージェントがセカンダリAccess Managerサーバーへの接続をオープンするときのポイントを表す数を指定します。デフォルトは1です

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

任意の設定またはすべての設定を変更できます。次の例を使用して、エージェントID、状態、最大接続数、Access Managerサーバーのタイムアウト、プライマリCookieドメイン、キャッシュ・タイムアウト、Cookieセッション・タイムアウト、最大セッション・タイムアウト、アイドル・セッション・タイムアウトおよびフェイルオーバーしきい値を変更します。

editWebgateAgent(agentName="WebgateAgent1", accessClientPasswd="welcome1",
state="Enabled", preferredHost="141.144.168.148:2001", aaaTimeOutThreshold = "10",
security="open", primaryCookieDomain="primaryCookieDomain", maxConnections="16",
maxCacheElems="10000", cacheTimeout="1800", cookieSessionTime="3600",
maxSessionTime="24", idleSessionTimeout="3600", failoverThreshold="1",
domainHome="domainHome1")

deleteWebgateAgent

システム構成内のWebgate_agent登録エントリを削除するオンラインおよびオフライン・コマンド。

説明

システム構成から指定されたWebgate_agent登録エントリを削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteWebgateAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数

定義

agentName

必須。削除するWebゲート・エージェントの名前を指定します。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、WebgateAgent1という名前のWebゲート・エージェントを削除します。

deleteWebgateAgent(agentName="WebgateAgent1", domainHome="domainHome1")

displayWebgateAgent

Webgate_agent登録エントリを表示するオンラインおよびオフライン・コマンド。

説明

Access Manager管理コンソールに、指定されたWebgate_agent登録エントリのすべての詳細を表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayWebgateAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数

定義

agentName

必須。表示するWebゲート・エージェントの名前を指定します。

domainhome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、WebgateAgent1のエントリの詳細を表示します。

displayWebgateAgent(agentName="WebgateAgent1", domainHome="domainHome1")

exportPolicy

テスト(ソース)環境から指定された中間Access ManagerファイルにAccess Managerポリシー・データをエクスポートするオンラインのみのコマンド。

説明

テスト(ソース)環境から中間Access ManagerファイルにAccess Managerポリシー・データをエクスポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

exportPolicy(pathTempOAMPolicyFile="<absoluteFilePath>")

引数

定義

pathTempOAMPolicyFile

必須。一時Access Managerファイルへの絶対パスを指定します。

例

次の例では、テスト(ソース)環境からポリシー・データをエクスポートするときに使用するtempfile.txtファイルへのパスを指定します。

exportPolicy(pathTempOAMPolicyFile="/exampleroot/parent/tempfile.txt")

importPolicy

指定されたAccess ManagerファイルからAccess Managerポリシー・データをインポートするオンラインのみのコマンド。

説明

指定されたAccess ManagerファイルからAccess Managerポリシー・データをインポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

importPolicy(pathTempOAMPolicyFile="<absoluteFilePath>")

引数

定義

pathTempOAMPolicyFile

必須。一時Access Managerファイルへの絶対パスを指定します。

例

次の例では、ポリシー・データを本番(ターゲット)環境にインポートするときに使用するtempfile.txtファイルへのパスを指定します。

importPolicy(pathTempOAMPolicyFile="/exampleroot/parent/tempfile.txt")

importPolicyDelta

指定されたAccess ManagerファイルからAccess Managerポリシーの変更をインポートするオンラインのみのコマンド。

説明

指定されたAccess ManagerファイルからAccess Managerポリシーの変更をインポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

importPolicyDelta(pathTempOAMPolicyFile="<absoluteFilePath>")

引数

定義

pathTempOAMPolicyFile

必須。一時Access Managerファイルへの絶対パスを指定します。

例

次の例では、変更されたポリシー・データを本番(ターゲット)環境にインポートするときに使用するtempfile_delta.txtファイルへのパスを指定します。

importPolicyDelta(pathTempOAMPolicyFile="/exampleroot/parent/tempfile_delta.txt")

migratePartnersToProd

現在の(ソース)Access Managerサーバーから指定された(ターゲット)Access Managerサーバーにパートナを移行するオンラインのみのコマンド。

説明

現在の(ソース)Access Managerサーバーから指定された(ターゲット)Access Managerサーバーにパートナを移行します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

migratePartnersToProd(prodServerHost="<host>", prodServerPort="<port>",
prodServerAdminUser="<user>", prodServerAdminPwd="<passwd>")

引数

定義

prodServerHost

パートナの移行先となるターゲットAccess Managerサーバーのホスト名。

prodServerPort

パートナの移行先となるターゲットAccess Managerサーバーのポート。

prodServerAdminUser

パートナの移行先となるターゲットAccess Managerサーバーの管理者。

prodServerAdminPwd

ターゲットAccess Managerサーバーの管理者のパスワード。

例

次の例では、パートナの移行に必要な情報を指定します。

migratePartnersToProd(prodServerHost="myhost", prodServerPort="1234",
prodServerAdminUser="weblogic", prodServerAdminPwd="welcome")

exportPartners

ソースから指定されたAccess ManagerファイルにAccess Managerパートナをエクスポートするオンラインのみのコマンド。

説明

ソースから指定されたAccess ManagerファイルにAccess Managerパートナをエクスポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

exportPartners(pathTempOAMPartnerFile="<absoluteFilePath>")

引数

定義

pathTempOAMPolicyFile

必須。一時Access Managerファイルへの絶対パスを指定します。

例

次の例では、Access Managerパートナ・ファイルへの絶対パスを指定します。

exportPartners(pathTempOAMPolicyFile="/exampleroot/parent/tempfile_partners.xml")

importPartners

指定されたAccess ManagerファイルからAccess Managerパートナをインポートするオンラインのみのコマンド。

説明

指定されたAccess ManagerファイルからAccess Managerパートナをインポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

importPartners(pathTempOAMPartnerFile="<absoluteFilePath>")

引数

定義

pathTempOAMPartnerFile

必須。一時Access Managerパートナ・ファイルへのパスを指定します。

例

次の例では、パートナのインポート元となるAccess Managerファイルへの絶対パスを指定します。

importPartners(pathTempOAMPolicyFile="/exampleroot/parent/tempfile_partners.xml")

displayTopology

デプロイメント内のすべてのAccess Managerサーバーに関する情報を表示するオンラインおよびオフライン・コマンド。

説明

デプロイ済のAccess Managerサーバーのトポロジを一覧表示します。

構文

displayTopology(domainHome="<domainHomeName>")

引数

定義

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、指定されたドメイン・ホーム内のデプロイ済のすべてのAccess Managerサーバーの詳細を一覧表示します。

displayTopology(domainHome="domainHome1")

configureOAAMPartner

Access ManagerとOracle Adaptive Access Manager (OAAM)の基本的な統合を構成するオンラインのみのコマンド。

説明

Access ManagerとOAAMの基本的な統合を構成します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

configureOAAMPartner(dataSourceName="<dataSourceName>", hostName="<hostName>",
port="<port>", serviceName="<serviceName>", userName="<userName>",
passWord="<passWord>", maxConnectionSize="<maxConnectionSize>",
maxPoolSize="<maxPoolSize>", serverName="<serverName>")

引数

定義

dataSourceName

必須。作成するデータ・ソースの名前を指定します。

hostName

必須。データベース・ホストの名前を指定します。

port

必須。データベース・ポート番号を指定します。

serviceName

必須。データベース・サービス名を指定します。

userName

必須。OAAMスキーマ名を指定します。

passWord

必須。OAAMスキーマ・パスワードを指定します。

maxConnectionSize

オプション。接続予約タイムアウトの最大値を指定します。

maxPoolSize

オプション。接続プールの最大サイズを指定します。

serverName

オプション。データソースのターゲット・サーバーを指定します。

例

次の例では、Access ManagerとOAAMの基本的な統合を構成します。

configureOAAMPartner(dataSourceName="MyOAAMDS", hostName="host.example.com",
port="1521", serviceName="sevice1", userName="username", passWord="password",
maxConnectionSize=None, maxPoolSize=None, serverName="oam_server1")

registerOIFDAPPartner

Oracle Access Management Identity Federation (Identity Federation)をDelegated Authentication Protocol (DAP)パートナとして登録するオンラインおよびオフライン・コマンド。

説明

Identity FederationをDelegated Authentication Protocol (DAP)パートナとして登録します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

registerOIFDAPPartner(keystoreLocation="/scratch/keystore"
logoutURL="http://<oifhost>:<oifport>/fed/user/splooam11g?
doneURL=http(s)://<oamhost>:<oamport>/oam/server/pages/logout.jsp",
rolloverTime="nnn")

引数

定義

keystoreLocation

必須。キーストア・ファイル(Identity Federationサーバーで生成されたもの)の場所を指定します。

logoutURL

必須。Identity FederationサーバーのログアウトURLを指定します。

rolloverTime

オプション。SASSOトークンの暗号化/復号化に使用されたキーをロールオーバーできる時間(秒数)を指定します。

例

次の例では、パラメータの使用例を示します。

registerOIFDAPPartner(keystoreLocation="/scratch/keystore",
logoutURL="http(s)://oif.mycompany.com:1234/fed/user/splooam11g?
doneURL=http(s)://oam.mycompany.com:5678/oam/server/pages/logout.jsp", rolloverTime="500")

registerOIFDAPPartnerIDPMode

Identity FederationをDelegated Authentication Protocol (DAP)パートナとしてIDPモードで登録するオンラインおよびオフライン・コマンド。

説明

Identity FederationをDelegated Authentication Protocol (DAP)パートナとしてIDPモードで登録します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

registerOIFDAPPartnerIDPMode(logoutURL="http://<oifhost>:<oifport>/fed/user/sploosso?doneURL=http://<oamhost>:<oamport>/ngam/server/pages/logout.jsp")

引数

定義

logoutURL

必須。Identity FederationサーバーのログアウトURLを指定します。

例

次の例では、ログアウトURLパラメータの使用例を示します。

registerOIFDAPPartner(
logoutURL="http://oif.oracle.com:1234/fed/user/sploosso?
doneURL=http://oam.oracle.com:5678/ngam/server/pages/logout.jsp")

registerThirdPartyTAPPartner

任意のサード・パーティをTrusted Authentication Protocol (TAP)パートナとして登録します。

説明

任意のサード・パーティをTrusted Authentication Protocol (TAP)パートナとして登録します。

構文

registerThirdPartyTAPPartner(partnerName="ThirdPartyTAPPartner",
keystoreLocation="/scratch/DAPKeyStore/mykeystore.jks",
password="test", tapTokenVersion="v2.0", tapScheme="TAPScheme",
tapRedirectUrl="http://thirdpartyserverhost:port/loginPage.jsp")

引数

定義

partnerName

必須。パートナの名前を指定します。サード・パーティのパートナの識別に使用する任意の名前を指定できます。

keystoreLocation

必須。キーストア・ファイルの場所を指定します。

password

必須。キーストア・ファイルのパスワードを指定します。

tapTokenVersion

必須。Trusted Authentication Protocolのバージョンを指定します。

tapScheme

オプション。リソースの保護に使用するTAPScheme名を指定します(TAPSchemeは即時利用可能)。

tapRedirectUrl

オプション。資格証明コレクタのリダイレクト先となるTAPチャレンジURLを指定します。

例

次の例では、パラメータの使用例を示します。

registerThirdPartyTAPPartner(partnerName = "ThirdPartyTAPPartner",
keystoreLocation="/scratch/DAPKeyStore/mykeystore.jks",
password="test", tapTokenVersion="v2.0", tapScheme="TAPScheme",
tapRedirectUrl="http://thirdpartyserverhost:port/loginPage.jsp")

disableCoexistMode

共存モードを無効にするオンライン・コマンド。

説明

共存モードを無効にします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。このコマンドには引数はありません。

構文

disableCoexistMode()

例

次の例では、共存モードを無効にします。

disableCoexistMode()

enableOamAgentCoexist

Access Managerエージェントの共存モードを有効にします(10g Webゲートによって設定されたObssocookieを所有するために、Access Manager 11gサーバーを有効にします)。

説明

Access Managerエージェントの共存モードを有効にします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。このコマンドには引数はありません。

構文

enableOamAgentCoexist()

例

次の例では、共存モードを有効にします。

enableOamAgentCoexist

disableOamAgentCoexist

Access Managerエージェントの共存モードを無効にします。

説明

Access Managerエージェントの共存モードを無効にします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。このコマンドには引数はありません。

構文

disableOamAgentCoexist()

例

次の呼出しは、共存モードを有効にします。

disableOamAgentCoexist

editGITOValues

GITO構成パラメータを編集するオンラインおよびオフライン・コマンド。

説明

GITO構成パラメータを編集します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editGITOValues(gitoEnabled="true", gitoCookieDomain=".abc.com",
gitoCookieName="ABC", gitoVersion="v1.0", gitoTimeout="20",
gitoSecureCookieEnabled="false", domainHome="/abc/def/ijk")

引数

定義

gitoEnabled

ユーザーによるGITO対応プロパティの設定を許可(または拒否)します。値としてtrueまたはfalseを取ります。

gitoCookieDomain

必須。GITO Cookieドメインを指定します。

gitoCookieName

オプション。Cookie名を指定します。

gitoVersion

オプション。GITOバージョンを指定します。値としてv1.0またはv3.0のみを取ります。

gitoTimeout

オプション。GITOタイムアウト値を指定します。

gitoSecureCookieEnabled

オプション。GITO Cookie対応プロパティを有効にします。値としてtrueまたはfalseを取ります。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、GITO構成パラメータを編集します。

editGITOValues(gitoEnabled="true", gitoCookieDomain=".abc.com",
gitoCookieName="ABC", gitoVersion="v1.0", gitoTimeout="20",
gitoSecureCookieEnabled="false", domainHome="/abc/def/ijk")

editWebgate11gAgent

システム構成内の11g Webgate_entry登録を編集するオンラインおよびオフライン・コマンド。

説明

システム構成内の11g Webgate_entry登録を編集します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editWebgate11gAgent(agentName="<AgentName>",
accessClientPasswd="<accessClientPassword >",state="<state>", preferredHost="<host>",
aaaTimeoutThreshold="<aaaTimeOutThreshold>", security="<security>",logOutUrls="<logOutUrls>", maxConnections="<maxConnections>",maxCacheElems="<maxCacheElements>", cacheTimeout="<cacheTimeOut>",
logoutCallbackUrl="<logoutCallbackUrl >",maxSessionTime="<maxSessionTime>", logoutRedirectUrl="<logoutRedirectUrl >",failoverThreshold="<failoverThreshold>",
tokenValidityPeriod="<tokenValidityPeriod>",logoutTargetUrlParamName="<logoutTargetUrlParamName>", domainHome="<domainHome>",allowManagementOperations="<allowManagementOperations>",
allowTokenScopeOperations="<allowTokenScopeOperations>",
allowMasterTokenRetrieval="<allowMasterTokenRetrieval>",
allowCredentialCollectorOperations="<allowCredentialCollectorOperations>")

引数

定義

agentName

必須。変更する11g Webゲート・エージェントの名前を指定します。

accessClientPasswd

オプション。このWebゲート・エージェントの一意のクライアント・パスワードを指定します。

state

オプション。Webゲート・エージェントを有効にするか、無効にするかを指定します。値はそれぞれ、EnabledまたはDisabledです。

preferredHost

オプション。Webゲート・エージェントの優先ホストを指定します。これにより、ホストの識別子がホスト識別子リストに含まれていない場合に生じる可能性があるセキュリティ・ホールを防ぐことができます。仮想ホスティングでは、ホスト識別子機能を使用する必要があります。

aaaTimeoutThreshold

オプション。Access Managerランタイム・サーバーからの応答を待機する秒数を指定します。このパラメータが設定された場合、アプリケーションのTCP/IPタイムアウトとして、デフォルトのTCP/IPタイムアウトではなくこの値が使用されます。デフォルト = -1(デフォルトのネットワークTCP/IPタイムアウトが使用されます)

security

オプション。Access Managerランタイム・サーバーに対するトランスポート・セキュリティのレベルを指定します。値としてopen、simpleまたはcertのいずれかを取ります。

logOutUrls

ログアウト・ハンドラをトリガーするURLのリスト。ログアウト・ハンドラは、ObSSOCookieを削除します。

maxConnections

オプション。このAccess ManagerエージェントがAccess Managerサーバーで確立できる接続の最大数を指定します。この数は、このエージェントに実際に関連付けられている接続の数と同じか、それを超える数である必要があります。デフォルト = 1

maxCacheElems

オプション。キャッシュ内で維持される要素の最大数を指定します。キャッシュ要素は、URLまたは認証スキームです。この設定の値は、これら両方のキャッシュ内の要素の最大合計カウントを意味します。デフォルト = 10000

cacheTimeout

オプション。キャッシュされた情報が使用も参照もされない場合に、その情報がAccess Managerエージェント・キャッシュ内にとどまる時間を指定します。デフォルトは1800(秒)です。

logoutCallbackUrl

oam_logout_successへのURL。oam_logout_successは、コールバック中にCookieを消去します。デフォルトでは、これは、エージェントの登録時に指定されたエージェント・ベースURLに基づきます。例:

http://<host>:<port>

maxSessionTime

オプション。ユーザーの認証セッションが、そのアクティビティに関係なく有効である最大時間(秒単位)を指定します。この時間が経過すると、ユーザーは、再度認証を求められます。これは強制的なログアウトです。値0を指定すると、このタイムアウト設定は無効になります。デフォルトは3600(秒)です。

logoutRedirectUrl

オプション。中央ログアウト・ページ(logout.html)へのURL(絶対パス)を指定します。デフォルトでは、これは、デフォルト・ポート14200のAccess Manager管理コンソールのホスト名に基づきます。

failoverThreshold

オプション。このAccess ManagerエージェントがセカンダリAccess Managerサーバーへの接続をオープンするときのポイントを表す数を指定します。デフォルト = 1

tokenValidityPeriod

オプション。Access Managerエージェントで保護されているリソースにアクセスすることなく、ユーザーの認証セッションが有効である時間(秒単位)を指定します。

logoutTargetUrlParamName

オプション。この値は、ログアウト時に呼び出され、OPSSレベルで構成されるログアウト・ターゲットURLです。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

allowManagementOperations

オプション。管理操作の許可のフラグを設定します

allowTokenScopeOperations

オプション。トークン・スコープ操作の許可のフラグを設定します

idleSessionTimeout

オプション。次を指定します

allowMasterTokenRetrieval

マスター・トークン取得の許可のフラグを設定します

allowCredentialCollectorOperations

資格証明コレクタ操作の許可のフラグを設定します

例

次の例では、必須のパラメータとオプションのパラメータをすべて使用しています。

editWebgate11gAgent(agentName="WebgateAgent1", accessClientPasswd="welcome1",
state="Enabled", preferredHost="141.144.168.148:2001", aaaTimeoutThreshold="10",
security="open", logOutUrls="http://host1.oracle.com:1234", maxConnections = "16",
maxCacheElems="10000", cacheTimeout="1800",
logoutCallbackUrl="http://host2.oracle.com:1234",
maxSessionTime="24", logoutRedirectUrl="logoutRedirectUrl",
failoverThreshold="1", tokenValidityPeriod="tokenValidityPeriod",
logoutTargetUrlParamName="logoutTargetUrl", domainHome="domainHome1",
allowManagementOperations="false", allowTokenScopeOperations="false",
allowMasterTokenRetrieval="false", allowCredentialCollectorOperations="false")

deleteWebgate11gAgent

システム構成内の11g Webgate_agentエントリを削除するオンラインおよびオフライン・コマンド。

説明

システム構成内の11g Webgate_agentエントリを削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteWebgate11gAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数

定義

agentName

必須。削除する11g Webゲート・エージェントの名前を指定します。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、my_11gWebGateという名前の11g Webgate_agentエントリを削除します。

deleteWebgate11gAgent(agentName="my_11gWebGate", domainHome="domainHome1")

displayWebgate11gAgent

11g Webgate_agent登録エントリを表示するオンラインおよびオフライン・コマンド。

説明

11g Webゲート・エージェント登録エントリを表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayWebgate11gAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数

定義

agentName

必須。変更する11g Webゲート・エージェントの名前を指定します。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、my_11gWebGateという名前のWebゲート・エージェントを表示します。

displayWebgate11gAgent(agentName="my_11gWebGate", domainHome="domainHome1")

displayOAMMetrics

Access Managerサーバーのメトリックを表示するオンラインおよびオフライン・コマンド。

説明

Access Managerサーバーのメトリックを表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayOAMMetrics(domainHome="<domainHomeName>")

引数

定義

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、指定されたドメイン内のAccess Managerサーバーのメトリックを表示します。

displayOAMMetrics(domainHome="domainHome1")

updateOIMHostPort (非推奨)

非推奨 - Access Managerとの統合時にOracle Identity Manager構成を更新するオンラインのみのコマンド。

説明

システム構成内のIdentity Manager構成を更新します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

updateOIMHostPort(hostName="<host name>", port="<port number>", secureProtocol="true")

引数

定義

hostName

Identity Managerホストの名前。

port

Identity Managerホストのポート。

secureProtocol

通信がHTTP経由かHTTPS経由かに応じて、値にtrueまたはfalseを取ります。

例

次の例では、このコマンドの使用例を示します。

updateOIMHostPort(hostName="OIM.oracle.com", port="7777", secureProtocol="true")

configureOIM (非推奨)

非推奨 - Access Managerとの統合時にOracle Identity Manager固有のエージェント・プロファイルを登録するオンラインのみのコマンド。

説明

Access Managerとの統合時にOracle Identity Manager固有のエージェント・プロファイルを作成します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

configureOIM(oimHost="<OIM host>", oimPort="<port>",
oimSecureProtocolEnabled="true | false", oimAccessGatePwd="<AccessGatePassword>",
oimCookieDomain="<OIMCookieDomain>", oimWgId="<OIMWebgateID>",
oimWgVersion="<OIMWebgateVersion>")

引数

定義

oimHost

Oracle Identity Managerホストの名前。EDGの場合は、OIMクラスタのフロント・エンドLBRホスト名。

oimPort

Oracle Identity Manager管理対象サーバーのポート。EDGの場合は、OIM管理対象サーバー・クラスタのフロント・エンドLBRポート。

oimSecureProtocolEnabled

通信がHTTP経由かHTTPS経由かに応じて、値にtrueまたはfalseを取ります。

oimAccessGatePwd

指定する場合は、オープン・モードのエージェント・パスワード。

oimCookieDomain

Cookieが設定されるドメイン。

oimWgId

エージェントの登録名。

oimWgVersion

可能な値は10gまたは11gです。指定しない場合、デフォルトは10gです。

例

次の例では、このコマンドの使用例を示します。

configureOIM(oimHost="oracle.com", oimPort="7777", oimSecureProtocolEnabled="true",
oimAccessGatePwd = "welcome", oimCookieDomain = "domain1",
oimWgId="<OIM Webgate ID>", oimWgVersion="10g")

updateOSSOResponseCookieConfig

OSSOプロキシ・レスポンスCookie設定を更新するオンラインおよびオフライン・コマンド。

説明

OSSOプロキシ・レスポンスCookie設定を更新します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

updateOSSOResponseCookieConfig(cookieName="<cookieName>",cookieMaxAge="<cookie age in minutes>", isSecureCookie="true | false",cookieDomain="<domain of the cookie>", domainHome="<domainHomeName>")

引数

定義

cookieName

オプション。設定が更新されるCookieの名前。指定しない場合、グローバル設定が更新されます。

cookieMaxAge

Cookieの最大保持時間(分単位)。負の値の場合、セッションCookieが設定されます。

isSecureCookie

Cookieを保護する(SSLチャネルで送信する)かどうかを指定するブール・フラグ。

cookieDomain

Cookieのドメイン。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、このコマンドの使用例を示します。

updateOSSOResponseCookieConfig(cookieName = "ORASSO_AUTH_HINT",
cookieMaxAge = "525600", isSecureCookie = "false",
cookieDomain=".example.com", domainHome = "<domain_home>")

deleteOSSOResponseCookieConfig

システム構成内のOSSOプロキシ・レスポンスCookie設定を削除するオンラインおよびオフライン・コマンド。

説明

OSSOプロキシ・レスポンスCookie設定を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteOSSOResponseCookieConfig(cookieName="<cookieName>",
domainHome="<domainHomeName>")

引数

定義

cookieName

必須。設定が削除されるCookieの名前。グローバルCookie設定は削除できません。

domainHome

Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、このコマンドの使用例を示します。

deleteOSSOResponseCookieConfig(cookieName="ORASSO_AUTH_HINT",
domainHome = "<domain_home>")

configureAndCreateIdentityStore

アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。

説明

指定された値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。

構文

configureOIM(oimHost="<OIM host>", oimPort="<port>",
oimSecureProtocolEnabled="true | false", oimAccessGatePwd="<AccessGatePassword>",
oimCookieDomain="<OIMCookieDomain>", oimWgId="<OIMWebgateID>",
oimWgVersion="<OIMWebgateVersion>"), nameOfIdStore="<nameOfIdStore>",
idStoreSecurityCredential="<idStoreSecurityCredential>",
userSearchBase="<userSearchBase>", ldapUrl="<ldapUrl>",
groupSearchBase="<groupSearchBase>", securityPrincipal="<securityPrincipal>", idStoreType="<idStoreType>", ldapProvider="<ldapProvider>",
isPrimary="<isPrimary>", userIDProvider="<userIDProvider>",
userNameAttr="<userNameAttr>"

引数

定義

oimHost

Oracle Identity Managerホストの名前。EDGの場合は、OIMクラスタのフロント・エンドLBRホスト名。

oimPort

Oracle Identity Manager管理対象サーバーのポート。EDGの場合は、OIM管理対象サーバー・クラスタのフロント・エンドLBRポート。

oimSecureProtocolEnabled

通信がHTTP経由かHTTPS経由かに応じて、値にtrueまたはfalseを取ります。

oimAccessGatePwd

指定する場合は、オープン・モードのエージェント・パスワード。

oimCookieDomain

Cookieが設定されるドメイン。

oimWgId

エージェントの登録名。

oimWgVersion

可能な値は10gまたは11gです。指定しない場合、デフォルトは10gです。

nameOfIdStore

必須。作成するLDAPアイデンティティ・ストアの名前を指定します。

idStoreSecurityCredential

必須。作成するLDAPアイデンティティ・ストアのプリンシパルのパスワードを指定します。

userSearchBase

必須。作成するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。

ldapUrl

必須。作成するLDAPアイデンティティ・ストアのLDAPホストのURL(ポート番号を含みます)を指定します。

groupSearchBase

必須。作成するLDAPアイデンティティ・ストア内の、グループ・データが格納されるノードを指定します。

securityPrincipal

必須。作成するLDAPアイデンティティ・ストアのプリンシパル管理者を指定します。

idStoreType

必須。作成するLDAPアイデンティティ・ストアのタイプを指定します。

ldapProvider

作成するストアのLDAPプロバイダ・タイプを指定します。

isPrimary

オプション。登録するLDAPアイデンティティ・ストアがプライマリ・アイデンティティ・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。

userIDProvider

作成するストアのユーザー・アイデンティティ・プロバイダを指定します。

userNameAttr

必須。ストアのユーザー属性を指定します。

例

次の例では、このコマンドの使用例を示します。

configureOIM(oimHost="oracle.com", oimPort="7777", oimSecureProtocolEnabled="true",
oimAccessGatePwd = "welcome", oimCookieDomain = "domain1",
oimWgId="<OIM Webgate ID>", oimWgVersion="10g"
nameOfIdStore="nameOfIdStore",
idStoreSecurityCredential="idStoreSecurityCredential",
userSearchBase="userSearchBase", ldapUrl="ldapUrl",
groupSearchBase="groupSearchBase", securityPrincipal="securityPrincipal", idStoreType="idStoreType", ldapProvider="ldapProvider", isPrimary="true", userIDProvider="userIDProvider", userNameAttr="userNameAttr")

configAndCreateIdStoreUsingPropFile

プロパティ・ファイル内に指定されている値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。

説明

指定されたプロパティ・ファイル内に指定されている値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。

構文

configAndCreateIdStoreUsingPropFile(path="<path_of_property_file>")

引数

定義

path

値が定義されているプロパティ・ファイルへのパス。

例

次の例では、このコマンドの使用例を示します。

configAndCreateIdStoreUsingPropFile(path="/prop_file_directory/values.properties")

migrateArtifacts(非推奨)

非推奨 - アーティファクトを移行します。

説明

入力アーティファクト・ファイル内に定義されている値に基づいてアーティファクトを移行します。

構文

migrateArtifacts(path="<path_to_artifacts_file>", password="<password>",
type="OutOfPlace|InPlace", isIncremental="true|false")

引数

定義

path

アーティファクト・ファイルの場所

password

元のアーティファクトの生成時に使用されたパスワード。

type

移行のタイプを定義するブール値で、値としてInPlaceまたはOutOfPlaceを取ります

isIncremental

ブール値(値としてtrueまたはfalseを取ります)。trueの場合、増分アップグレードが実行されます。

例

次の例では、このコマンドの使用例を示します。

migrateArtifacts(path="/exampleroot/parent/t", password="welcome",
type="InPlace", isIncremental="false")

displaySimpleModeGlobalPassphrase

システム構成内に定義されている簡易モードのグローバル・パスフレーズを平文で表示します。

説明

簡易モードのグローバル・パスフレーズを平文で表示するオンラインのみのコマンド。このコマンドには引数はありません。

構文

displaySimpleModeGlobalPassphrase()

例

次の例では、このコマンドの使用例を示します。

displaySimpleModeGlobalPassphrase()

exportSelectedPartners

指定されたAccess Managerファイルに、選択されたAccess Managerパートナをエクスポートします。

説明

指定されたAccess Managerファイルに、選択されたAccess Managerパートナをエクスポートします。

構文

exportSelectedPartners(pathTempOAMPartnerFile="<absoluteFilePath>",
partnersNameList="<comma_separated_partner_names>")

引数

定義

pathTempOAMPartnerFile

必須。情報のエクスポート先となるファイルの場所。

partnersNameList

必須。エクスポートされるパートナIDのカンマ区切りのリストを指定します。

例

次の例では、このコマンドの使用例を示します。

exportSelectedPartners(pathTempOAMPartnerFile="/exampleroot/parent/tempfile.extn"
partnersNameList="partner1,partner2")

oamMigrate

OSSO、OAM10g、OpenSSOまたはAM 7.1からOAM11gにポリシー、認証ストアおよびユーザー・ストアを移行するオンラインのみのコマンド。

説明

移行フレームワークMBeanのbeginMigrate操作を呼び出します。

構文

oamMigrate(oamMigrateType=<migrationType>,
pathMigrationPropertiesFile="<absoluteFilePath>")

引数

定義

oamMigrateType

必須。実行する移行のタイプを指定します。値として次のいずれかを取ります: OSSO | OpenSSO | OAM10g

注: OpenSSOはSAML 7.1とOpenSSOの両方に適用します。

pathMigrationPropertiesFile

必須。移行のために必要なアーティファクトの読取り元となるファイルへのパスを指定します。

例

次の例では、このコマンドの使用例を示します。

oamMigrate(oamMigrateType=OSSO,
pathMigrationPropertiesFile="/middlewarehome/oam-migrate.properties")

preSchemeUpgrade

preSchemeUpgrade操作を呼び出すオンラインのみのコマンド。

説明

preSchemeUpgrade操作を呼び出します。

構文

preSchemeUpgrade
(pathUpgradePropertiesFile="/middlewarehome/oam-upgrade.properties")

引数

定義

pathUpgradePropertiesFile

必須。アップグレードのために必要なシステム・プロパティの読取り元となるファイルへのパスを指定します。

例

次の例では、このコマンドの使用例を示します。

preSchemeUpgrade(pathUpgradePropertiesFile="/exampleroot/parent/tempfile.extn")

postSchemeUpgrade

postSchemeUpgrade操作を呼び出します。

説明

postSchemeUpgrade操作を呼び出します。

構文

postSchemeUpgrade
(pathUpgradePropertiesFile="/middlewarehome/oam-upgrade.properties")

引数

定義

pathUpgradePropertiesFile

必須。アップグレードのために必要なシステム・プロパティの読取り元となるファイルへのパスを指定します。

例

次の例では、このコマンドの使用例を示します。

postSchemeUpgrade(pathUpgradePropertiesFile="/exampleroot/parent/tempfile.extn")

oamSetWhiteListMode

oamSetWhiteListModeをtrueまたはfalseに設定します。

説明

oamSetWhiteListModeをtrueまたはfalseに設定します。trueの場合、Access Managerは、使用アプリケーションによって要求された最後のURLにリダイレクトされます(そのURLがホワイトリストURLとして構成されている場合のみ)。

構文

oamSetWhiteListMode(oamWhiteListMode="true|false")

引数

定義

oamWhiteListMode

必須。Access Managerのホワイトリスト・モードを有効にします。

例

次の例では、このコマンドの使用例を示します。

oamSetWhiteListMode(oamWhiteListMode="true")

oamWhiteListURLConfig

指定されたファイルにおいて、ホワイトリストURLエントリを追加、更新または削除します。

説明

指定されたファイルにおいて、ホワイトリストURLエントリを追加、更新または削除します。

構文

oamWhiteListURLConfig(Name="xyz", Value="http://xyz.com:1234",
Operation="Remove|Update")

引数

定義

Name

必須。このエントリの名前(キー)を表す有効な文字列。

Value

必須。<protocol>://<host>:<port>という形式の有効なURL。ポートが指定されない場合、デフォルトのHTTP/HTTPSポートがそれぞれ割り当てられます。

Operation

必須。値としてUpdateまたはRemoveを取ります。大/小文字は区別されません。

例

次の例では、このコマンドの使用例を示します。

oamWhiteListURLConfig(Name="xyz", Value="http://xyz.com:1234", Operation="Update")

enableMultiDataCentreMode

マルチ・データ・センター・モードを有効にするオンラインのみのコマンド。

説明

マルチ・データ・センター・モードを有効にします。

構文

enableMultiDataCentreMode(propfile="<absoluteFilePath>")

引数

定義

propFile

必須。マルチ・データ・センターを有効にするためのプロパティの読取り元となるファイルへの絶対パスを指定します。

例

次の例では、このコマンドの使用例を示します。

enableMultiDataCentre(propfile="/middlewarehome/oamMDCProperty.properties")

disableMultiDataCentreMode

マルチ・データ・センター・モードを無効にするオンラインのみのコマンド。

説明

マルチ・データ・センター・モードを無効にします。このコマンドには、引数はありません。

構文

disableMultiDataCentreMode()

例

次の例では、このコマンドの使用例を示します。

disableMultiDataCentreMode()

setMultiDataCentreClusterName

マルチ・データ・クラスタ名を設定します。

説明

マルチ・データ・クラスタ名を設定します。

構文

setMultiDataCentreClusterName(clusterName="MyCluster")

引数

定義

clusterName

必須。クラスタの名前を指定します。

例

次の例では、このコマンドの使用例を示します。

postSchemeUpgrade(clusterName="MyCluster")

setMultiDataCentreLogoutURLs

マルチ・データ・パートナ・ログアウトURLを設定します。

説明

マルチ・データ・パートナ・ログアウトURLを設定します。

構文

setMultiDataCentreLogoutURLs
(logoutURLs="http://<host>:<port>/logout.jsp,http://<host>:<port>/logout.jsp")

引数

定義

logoutURLs

必須。マルチ・データ・センター・パートナ・ログアウトURLのカンマ区切りのリストを指定します。

例

次の例では、このコマンドの使用例を示します。

setMultiDataCentreLogoutURLs(logoutURLs="http://localhost:6666/logout.jsp,http://localhost:8888/logout.jsp")

updateMultiDataCentreLogoutURLs

マルチ・データ・パートナ・ログアウトURLを更新します。

説明

マルチ・データ・パートナ・ログアウトURLを更新します。

構文

updateMultiDataCentreLogoutURLs
(logoutURLs="http://<host>:<port>/logout.jsp,http://<host>:<port>/logout.jsp")

引数

定義

logoutURLs

必須。マルチ・データ・センター・パートナ・ログアウトURLのカンマ区切りのリストを指定します。

例

次の例では、このコマンドの使用例を示します。

updateMultiDataCentreLogoutURLs(logoutURLs="http://localhost:7777/logout.jsp,http://localhost:9999/logout.jsp")

addPartnerForMultiDataCentre

マルチ・データ・センターにパートナを追加するオンライン・コマンド。

説明

マルチ・データ・センターにパートナを追加します。このコマンドは、オンライン・モードでのみサポートされ、一度に1つのパートナを追加します。

構文

addPartnerForMultiDataCentre(propfile="<absoluteFilePath>")

引数

定義

propFile

必須。エージェント情報を含むファイルへの絶対パスを指定します。

例

次の例では、このコマンドの使用例を示します。

addPartnerForMultiDataCentre(propfile="/middlewarehome/partnerInfo.properties")

removePartnerForMultiDataCentre

マルチ・データ・センターからパートナを削除します。

説明

マルチ・データ・センターからパートナを削除します。このコマンドは、オンライン・モードでのみサポートされ、一度に1つのパートナを削除します。

構文

removePartnerForMultiDataCentre(webgateid="<webgateId")

引数

定義

webgateid

必須。削除するパートナのIDを指定します。

例

次の例では、このコマンドの使用例を示します。

removePartnerForMultiDataCentre(webgateid="IAMSuite")

Oracle Access Management Identity Federationコマンド

この項では、フェデレーション・パートナを構成するためのコマンドを示します。

表4-7 フェデレーション・パートナ用のWLST Access Managerコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

addOpenID20IdPFederationPartner

OpenID 2.0 IdPパートナを作成します。

オンライン

addOpenID20SPFederationPartner

OpenID 2.0 SPパートナを作成します。

オンライン

addOpenID20GoogleIdPFederationPartner

Google OpenID 2.0 IdPパートナを作成します。

オンライン

addOpenID20YahooIdPFederationPartner

Yahoo OpenID 2.0 IdPパートナを作成します。

オンライン

addSAML11IdPFederationPartner

SAML 1.1プロトコルのもとでIdPフェデレーション・パートナを作成します(メタデータを含みます)。

オンライン

addSAML11SPFederationPartner

SAML 1.1プロトコルのもとでSPフェデレーション・パートナを作成します(メタデータを含みます)。

オンライン

addSAML20IdPFederationPartner

SAML 2.0プロトコルのもとでIdPフェデレーション・パートナを作成します。

オンライン

addSAML20SPFederationPartner

SAML 2.0プロトコルのもとでSPフェデレーション・パートナを作成します。

オンライン

addSAML20IdPFederationPartnerWithoutMetadata

SAML 2.0プロトコルのもとで、メタデータをインポートせずにIdPフェデレーション・パートナを作成します。

オンライン

addSAML20SPFederationPartnerWithoutMetadata

SAML 2.0プロトコルのもとで、メタデータをインポートせずにSPフェデレーション・パートナを作成します。

オンライン

configureIdPPartnerAttributeProfile

プロファイルの一部ではない着信属性を無視するかどうかを指定するIdPパートナ属性プロファイルを構成します。

オンライン

configureSAML20Logout

SAML 2.0フェデレーション・パートナのグローバル・フェデレーション・ログアウトを構成します。

オンライン

configureSAMLBinding

SAMLフェデレーション・パートナの優先バインディングを構成します。

オンライン

configureUserSelfRegistration

ユーザーの自己登録を有効にします。

オンライン

configureUserSelfRegistrationAttr

自己登録の際に、アサーションからのどの属性を電子メール、名、姓またはユーザー名として使用する必要があるかを設定します。

オンライン

createAuthnSchemeAndModule

IdPパートナの認証スキームおよびモジュールを作成します。

オンライン

createIdPPartnerAttributeProfile

フェデレーション・パートナのIdPパートナ属性プロファイルを作成します。

オンライン

createSPPartnerAttributeProfile

フェデレーション・パートナのSPパートナ属性プロファイルを作成します。

オンライン

deleteAuthnSchemeAndModule

IdPパートナの認証スキームおよびモジュールを削除します。

オンライン

deleteFederationPartner

特定のフェデレーション・パートナを削除します。

オンライン

deleteFederationPartnerEncryptionCert

フェデレーション・パートナの暗号化証明書を削除します。

オンライン

deleteFederationPartnerSigningCert

フェデレーション・パートナの署名証明書を削除します。

オンライン

deleteIdPPartnerAttributeProfile

IdPフェデレーション・パートナの属性プロファイルを削除します。

オンライン

deleteSPPartnerAttributeProfile

SPフェデレーション・パートナの属性プロファイルを削除します。

オンライン

deleteIdPPartnerAttributeProfileEntry

フェデレーション・パートナの属性プロファイルからエントリを削除します。

オンライン

deleteSPPartnerAttributeProfileEntry

フェデレーション・パートナの属性プロファイルからエントリを削除します。

オンライン

deletePartnerProperty

パートナの構成に追加されたパートナ固有のプロパティを削除します。

オンライン

displayIdPPartnerAttributeProfile

IdPフェデレーション・パートナの属性プロファイルを表示します。

オンライン

displaySPPartnerAttributeProfile

SPフェデレーション・パートナの属性プロファイルを表示します。

オンライン

getAllFederationIdentityProviders

すべてのIdPフェデレーション・パートナを一覧表示します。

オンライン

getFederationPartnerEncryptionCert

フェデレーション・パートナの暗号化証明書を取得します。

オンライン

getFederationPartnerSigningCert

フェデレーション・パートナの署名証明書を取得します

オンライン

getIdPPartnerBasicAuthCredentialUsername

フェデレーション・パートナのHTTP Basic認証ユーザー名を取得します。

オンライン

getPartnerProperty

フェデレーション・パートナのプロパティを取得します。

オンライン

getStringProperty

フェデレーション・パートナ・プロファイルから文字列プロパティを取得します。

オンライン

isFederationPartnerPresent

パートナが構成されているかどうかをチェックします。

オンライン

listIdPPartnerAttributeProfileIDs

IdPパートナの属性プロファイルを一覧表示します。

オンライン

listSPPartnerAttributeProfileIDs

SPパートナの属性プロファイルを一覧表示します。

オンライン

putStringProperty

デフォルトのフェデレーションIdPとしてOpenIDパートナを設定します。

オンライン

setDefaultSSOIdPPartner

IdPパートナを、フェデレーション・シングル・サインオンのデフォルトのアイデンティティ・プロバイダとして設定します。

オンライン

setFederationPartnerEncryptionCert

フェデレーション・パートナの暗号化証明書を設定します。

オンライン

setFederationPartnerSigningCert

フェデレーション・パートナの署名証明書を設定します。

オンライン

setIdPPartnerAttributeProfile

IdPパートナとのフェデレーテッド・シングル・サインオンで使用する属性プロファイルを設定します。

オンライン

setIdPDefaultScheme

デフォルトのOAM認証スキームを設定します。

オンライン

setSPPartnerAttributeProfile

SPパートナとのフェデレーテッド・シングル・サインオンで使用する属性プロファイルを設定します。

オンライン

setIdPPartnerAttributeProfileEntry

IdPフェデレーション・パートナのプロファイル内のエントリを設定します。

オンライン

setSPPartnerAttributeProfileEntry

SPフェデレーション・パートナのプロファイル内のエントリを設定します。

オンライン

setIdPPartnerBasicAuthCredential

フェデレーション・パートナのHTTP Basic認証資格証明を更新します。

オンライン

setIdPPartnerMappingAttribute

フェデレーション・パートナのアサーション・マッピングに使用される属性を設定します。

オンライン

setIdPPartnerMappingAttributeQuery

フェデレーション・パートナのアサーション・マッピングに使用される属性問合せを設定します。

オンライン

setIdPPartnerMappingNameID

IdPフェデレーション・パートナのアサーション・マッピングnameID値を設定します

オンライン

setPartnerAlias

フェデレーション・パートナの別名を更新します。

オンライン

setPartnerIDStoreAndBaseDN

フェデレーション・パートナのアイデンティティ・ストアおよびベースDNを設定します。

オンライン

setSPPartnerAlternateScheme

別の認証スキームを構成します。

オンライン

setSPPartnerDefaultScheme

デフォルトの認証スキームを構成します。

オンライン

setSPPartnerProfileDefaultScheme

デフォルトの認証スキームでプロファイルを構成します。

オンライン

setSPPartnerProfileAlternateScheme

別の認証スキームでプロファイルを構成します。

オンライン

updatePartnerMetadata

フェデレーション・パートナのメタデータを更新します。

オンライン

updatePartnerProperty

フェデレーション・パートナのプロパティを更新します

オンライン

注意:

この項のコマンド例には、キーと値の組合せ形式の属性で指定されるものとそうでないものがあります。Oracle Identity Federationはその両方をサポートしますが、キーと値の組合せ形式を使用する必要があります。

addOpenID20IdPFederationPartner

OpenID 2.0 IdPパートナを作成します。

説明

OpenID 2.0プロトコルのもとでIdPパートナを作成します。

構文

addOpenID20IdPFederationPartner(partnerName, idpSSOURL, discoveryURL, description)

引数

定義

partnerName

作成するパートナの名前。

idpSSOURL

IdPの起動SSO URL。検出URLを指定し、かつそれを使用する場合は、""に設定できます。

discoveryURL

IdPのOpenID検出URL。

description

パートナの説明。オプション。

例

addOpenID20IdPFederationPartner("testpartner1", "",
"http://host:port/discoveryurl", description="Test IdP1")

addOpenID20SPFederationPartner

OpenID 2.0 SPパートナを作成します。

説明

OpenID 2.0プロトコルのもとでSPパートナを作成します。

構文

addOpenID20SPFederationPartner(partnerName, realm, ssoURL, description)

引数

定義

partnerName

作成するパートナの名前。

realm

SP (RP)のレルム。

ssoURL

SP (RP)のエンドポイントURL。

description

パートナの説明。オプション。

例

addOpenID20SPFederationPartner(partnerName="partnerID",
realm="http://realm.domain.com", ssoURL="http://host:port/endpoint",
description="some description")

addOpenID20GoogleIdPFederationPartner

googleという名前のIdPパートナを作成します。

説明

検出URL https://www.google.com/accounts/o8/idを使用して、googleという名前のIdPパートナを作成します。

構文

addOpenID20GoogleIdPFederationPartner()

例

addOpenID20GoogleIdPFederationPartner()

addOpenID20YahooIdPFederationPartner

yahooという名前のIdPパートナを作成します。

説明

検出URL https://open.login.yahooapis.com/openid20/user_profile/xrdsを使用して、yahooという名前のIdPパートナを作成します。

構文

addOpenID20YahooIdPFederationPartner()

例

addOpenID20YahooIdPFederationPartner()

addSAML11IdPFederationPartner

SAML 1.1 IdPフェデレーション・パートナを作成します。

説明

SAML 1.1 IdPフェデレーション・パートナを作成します。

構文

addSAML11IdPFederationPartner(partnerName,providerID, ssoURL,
soapURL, succinctID, description)

引数

定義

partnerName

作成するパートナの名前。

providerID

パートナのproviderID。

ssoURL

IdPの起動SSO URL。

soapURL

IdPのアーティファクト解決SOAPエンドポイントURL。

succinctID

プロバイダのsuccinctID。

description

パートナの説明。オプション。

例

addSAML11IdPFederationPartner(partnerName="partnerID",
providerID="providerA", ssoURL="http://host:port/saml11sso",
soapURL="http://host:port/soapurl", succinctID="1234",
description="somedescription")

addSAML11SPFederationPartner

SAML 1.1 SPフェデレーション・パートナを作成します。

説明

SAML 1.1 SPフェデレーション・パートナを作成します。

構文

addSAML11SPFederationPartner(partnerName,providerID, ssoURL, description)

引数

定義

partnerName

作成するパートナの名前。

providerID

パートナのproviderID。

ssoURL

IdPの起動SSO URL。

description

パートナの説明。オプション。

例

addSAML11SPFederationPartner(partnerName="partnerID", providerID="providerA",
ssoURL="http://host:port/saml11sso", description="somedescription")

addSAML20IdPFederationPartner

SAML 2.0 IdPフェデレーション・パートナを作成します。

説明

SAML 2.0プロトコルのもとでフェデレーション・パートナをAccess Managerのアイデンティティ・プロバイダとして作成し、ファイルからパートナ・メタデータをロードします。

構文

addSAML20IdPFederationPartner(partnerName, metadataFile, description)

引数

定義

partnerName

作成するパートナの名前。

metadataFile

メタデータ・ファイルの場所(フルパス)。

description

パートナの説明。オプション。

例

addSAML20IdPFederationPartner(partnerName="partnerID",
metadataFile="location_metadata_file", description="somedescription")

addSAML20SPFederationPartner

SAML 2.0 SPフェデレーション・パートナを作成します。

説明

SAML 2.0プロトコルのもとでフェデレーション・パートナをAccess Managerのサービス・プロバイダとして作成し、ファイルからパートナ・メタデータをロードします。

構文

addSAML20SPFederationPartner(partnerName, metadataFile, description)

引数

定義

partnerName

作成するパートナの名前。

metadataFile

メタデータ・ファイルの場所(フルパス)。

description

パートナの説明。オプション。

例

addSAML20SPFederationPartner(partnerName="partnerID",
metadataFile="location_metadata_file", description="somedescription")

addSAML20IdPFederationPartnerWithoutMetadata

SAML 2.0メタデータなしでSAML20 IdPフェデレーション・パートナを作成します。

説明

SAML 2.0メタデータをロードせずにSAML20 IdPフェデレーション・パートナを作成します。

構文

addSAML20IdPFederationPartnerWithoutMetadata(partnerName,
providerID, ssoURL, soapURL, succinctID, description)

引数

定義

partnerName

作成するフェデレーション・パートナの名前。

providerID

パートナのproviderID。

ssoURL

IdPの起動SSO URL。

soapURL

IdPのアーティファクト解決SOAPエンドポイントURL。

succinctID

プロバイダのsuccinctID。

description

パートナの説明。オプション。

例

addSAML20IdPFederationPartnerWithoutMetadata(partnerName="partnerName", providerID="http://host:port", ssoURL="http://host:port/saml/sso", soapURL="http://host:port/saml/soap",description="some description")

addSAML20SPFederationPartnerWithoutMetadata

SAML 2.0メタデータなしでSAML20 SPフェデレーション・パートナを作成します。

説明

SAML 2.0メタデータをロードせずにSAML20 SPフェデレーション・パートナを作成します。

構文

addSAML20SPFederationPartnerWithoutMetadata(partnerName,
providerID, ssoURL, description)

引数

定義

partnerName

作成するフェデレーション・パートナの名前。

providerID

パートナのproviderID。

ssoURL

IdPの起動SSO URL。

description

パートナの説明。オプション。

例

addSAML20SPFederationPartnerWithoutMetadata(partnerName="partnerName", providerID="http://host:port", ssoURL="http://host:port/saml/sso", description="somedescription")

configureIdPPartnerAttributeProfile

着信属性を処理するようにIdPパートナ属性プロファイルを構成します。

説明

プロファイル内に定義されていない着信属性を処理または無視するようにIdPパートナ属性プロファイルを構成します。

構文

configureIdPPartnerAttributeProfile(attrProfileID, ignoreUnmappedAttributes)

引数

定義

attrProfileID

構成するIdPパートナ属性プロファイルを参照する識別子。

ignoreUnmappedAttributes

プロファイル内に定義されていない着信属性を無視するかどうかを決定します。

有効な値は、true(無視)または(デフォルト)false(処理)です。

例

configureIdPPartnerAttributeProfile(attrProfileID="idp-attribute-profile",
ignoreUnmappedAttributes="false")

configureSAML20Logout

SAML 2.0パートナのグローバル・フェデレーション・ログアウトを構成します。

説明

SAML 2.0フェデレーション・パートナのグローバル・フェデレーション・ログアウトを構成します。

構文

configureSAML20Logout(partnerName, partnerType, enable,
saml20LogoutRequestURL, saml20LogoutResponseURL, soapURL)

引数

定義

partnerName

更新するパートナのID。

partnerType

パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるか。

有効な値は、sp、idpです。

enable

そのパートナのグローバル・ログアウトを有効または無効にします。

有効な値は、true(有効)またはfalse(無効)です。

saml20LogoutRequestURL

SAML 2.0ログアウト・リクエスト・サービスURL。

パートナがメタデータを使用して作成された場合、またはログアウトが無効な場合は、オプションです。

saml20LogoutResponseURL

SAML 2.0ログアウト・レスポンス・サービスURL。

これは、パートナがメタデータを使用して作成された場合、またはログアウトが無効な場合は、オプションです。

soapURL

SAML 2.0 SOAPサービスURL。これは、パートナがメタデータを使用して作成された場合、ログアウトが無効な場合、またはSOAPログアウトがサポートされていない場合は、オプションです。

例

configureSAML20Logout(partnerName="partnerID", partnerType="sp", enable="true",
saml20LogoutRequestURL="http://host:port/saml/logoutrequest",
saml20LogoutResponseURL="http://host:port/saml/logoutresponse",
soapURL="http://host:port/saml/soap")

configureSAMLBinding

SAMLパートナのバインディングを指定します。

説明

SAMLパートナの優先バインディングを構成します。

構文

configureSAMLBinding(partnerName, partnerType, binding, ssoResponseBinding="httppost")

引数

定義

partnerName

構成するパートナの名前。

partnerType

パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを示します。有効な値は、sp、idpです。

binding

SSO応答以外のメッセージに使用するバインディングを指定します(認証リクエスト、ログアウト・メッセージ)。有効なオプションは、HTTP-POSTバインディングの場合はhttppost、HTTPリダイレクト・バインディングの場合はhttpredirectです。

ssoResponseBinding

このオプションの属性は、SSO応答に使用するバインディングを定義します。有効なオプションは、HTTP-POSTバインディングの場合はhttppost(デフォルト値)、HTTPリダイレクト・バインディングの場合はhttpredirect、アーティファクト・バインディングの場合はartifactです。

例

configureSAMLBinding(partnerName="partnerID",
partnerType="sp", binding="httpredirect", ssoResponseBinding="httppost")

configureUserSelfRegistration

ユーザー自己登録モジュールを有効にします。

説明

ユーザー自己登録モジュールを有効にします。

構文

configureUserSelfRegistration(<enabled>, <registrationURL>,
<regDataRetrievalAuthnEnabled>, <regDataRetrievalAuthnUsername>,
<regDataRetrievalAuthnPassword>, <partnerName>)

引数

定義

enabled

ユーザー自己登録モジュールが有効になっているかどうかを示します。値としてtrueまたはfalseを取ります。

registrationURL

自己登録のためにユーザーがリダイレクトされる場所です。partnerNameが指定されず、registrationURLが空であるか欠落している場合、現行のプロパティは変更されません。partnerNameが指定され、registrationURLが空であるか欠落している場合、このプロパティはパートナの構成から削除されます。

regDataRetrievalAuthnEnabled

登録データを取得するためにサーバーに接続するときに登録ページの認証が有効になっているかどうかを示します。

regDataRetrievalAuthnUsername

サーバーから登録データを取得するときに登録ページがサーバーに送信するユーザー名を指定します。

regDataRetrievalAuthnPassword

サーバーから登録データを取得するときに登録ページがサーバーに送信するパスワードを指定します。

partnerName

自己登録を有効にするIdPパートナを示します。欠落している場合、構成はグローバルに作用します。

例

configureUserSelfRegistration("true", regDataRetrievalAuthnEnabled="true",
regDataRetrievalAuthnUsername="username",
regDataRetrievalAuthnPassword="password")

configureUserSelfRegistrationAttr

アサーションの中のどの属性が電子メール、名、姓およびユーザー名として使用されるかを設定します。

説明

アサーションの中のどの属性が電子メール、名、姓およびユーザー名として使用されるかを設定します。

構文

configureUserSelfRegistration(<registrationAttrName>, <assertionAttrNames>,
<partnerName>)

引数

定義

registrationAttrName

設定する自己登録ページの属性。次の値のいずれか1つを設定できます: email、firstname、lastnameまたはusername。

assertionAttrNames

registrationAttrNameとして指定される自己登録ページのフィールドに移入するために使用できる、アサーションの設定可能な属性。

partnerName

ユーザー自己登録を構成するIdPパートナを示します。欠落している場合、構成はグローバルに作用します。

例

configureUserSelfRegistrationAttr("email", "mail,fed.nameidvalue")

2番目のパラメータは、アサーションからのmailまたはfed.nameidvalueをユーザーの自己登録ページでemail属性に移入できることを示します。

createAuthnSchemeAndModule

OpenD IdPを使用する認証スキームを作成します。

説明

OpenD IdPを使用する認証スキームを作成して、Access Managerのリソースを保護します。

構文

createAuthnSchemeAndModule(partnerName)

引数

定義

partnerName

スキームの作成対象となるパートナの名前。

例

createAuthnSchemeAndModule("testpartner")

createIdPPartnerAttributeProfile

IdP属性プロファイルを作成します。

説明

着信SAMLアサーション内の属性の処理に使用される名前マッピング・ルールを含むIdPパートナ属性プロファイルを作成します

構文

createIdPPartnerAttributeProfile(attrProfileID)

引数

定義

attrProfileID

IdP属性プロファイルの識別子。

例

createIdPPartnerAttributeProfile(attrProfileID="idp-attribute-profile")

createSPPartnerAttributeProfile

SP属性プロファイルを作成します。

説明

着信SAMLアサーション内の属性の処理に使用される名前マッピング・ルールを含むSPパートナ属性プロファイルを作成します

構文

createSPPartnerAttributeProfile(attrProfileID)

引数

定義

attrProfileID

SP属性プロファイルの識別子。

例

createSPPartnerAttributeProfile(attrProfileID="sp-attribute-profile")

deleteAuthnSchemeAndModule

IdPの認証スキームを削除します。

説明

IdPパートナの認証スキームを削除します。

構文

deleteAuthnSchemeAndModule(partnerName)

引数

定義

partnerName

スキームの削除対象となるパートナの名前。

例

deleteAuthnSchemeAndModule("testpartner")

deleteFederationPartner

フェデレーション・パートナを削除します。

説明

Access Managerからフェデレーション・パートナを削除します。

構文

deleteFederationPartner(partnerName, partnerType)

引数

定義

partnerName

削除するパートナのID。

partnerType

パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。

有効な値は、sp、idpです。

例

deleteFederationPartner(partnerName="partnerID", partnerType="idp")

deleteFederationPartnerEncryptionCert

パートナの暗号化証明書を削除します。

説明

フェデレーション・パートナの暗号化証明書を削除します。

構文

deleteFederationPartnerEncryptionCert(partnerName, partnerType)

引数

定義

partnerName

暗号化証明書の削除対象となるパートナのID。

partnerType

パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。

有効な値は、sp、idpです。

例

deleteFederationPartnerEncryptionCert(partnerName="customPartner", partnerType="idp")

deleteFederationPartnerSigningCert

パートナの署名証明書を削除します。

説明

フェデレーション・パートナの署名証明書を削除します。

構文

deleteFederationPartnerSigningCert(partnerName, partnerType)

引数

定義

partnerName

署名証明書の削除対象となるパートナのID。

partnerType

パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。

有効な値は、sp、idpです。

例

deleteFederationPartnerSigningCert(partnerName="customPartner",partnerType="idp")

deleteIdPPartnerAttributeProfile

IdPパートナ属性プロファイルを削除します。

説明

IdPパートナ属性プロファイルを削除します。

構文

deleteIdPPartnerAttributeProfile(attrProfileID)

引数

定義

attrProfileID

IdPパートナ属性プロファイルを参照する識別子。

例

deleteIdPPartnerAttributeProfile(attrProfileID="idp-attribute-profile")

deleteSPPartnerAttributeProfile

SPパートナ属性プロファイルを削除します。

説明

SPパートナ属性プロファイルを削除します。

構文

deleteSPPartnerAttributeProfile(attrProfileID)

引数

定義

attrProfileID

SPパートナ属性プロファイルを参照する識別子。

例

deleteSPPartnerAttributeProfile(attrProfileID="sp-attribute-profile")

deleteIdPPartnerAttributeProfileEntry

IdPパートナ属性プロファイル・エントリを削除します。

説明

属性プロファイルから属性を削除します。

構文

deleteIdPPartnerAttributeProfileEntry(attrProfileID,
messageAttributeName)

引数

定義

attrProfileID

IdPパートナ属性プロファイルを参照する識別子。

messageAttributeName

削除する属性の名前(送信メッセージに表示される名前です)。

例

deleteIdPPartnerAttributeProfileEntry(attrProfileID="idp-attribute-profile",
messageAttributeName="first_name")

deleteSPPartnerAttributeProfileEntry

SPパートナ属性プロファイル・エントリを削除します。

説明

属性プロファイルから属性を削除します。

構文

deleteSPPartnerAttributeProfileEntry(attrProfileID,
messageAttributeName)

引数

定義

attrProfileID

IdPパートナ属性プロファイルを参照する識別子。

messageAttributeName

削除する属性の名前(送信メッセージに表示される名前です)。

例

deleteSPPartnerAttributeProfileEntry(attrProfileID="sp-attribute-profile",
messageAttributeName="first_name")

deletePartnerProperty

パートナ・プロパティを削除します。

WLSTとSAML 1.1の使用に関する項も参照してください。

説明

パートナ固有のプロパティを削除します。このコマンドは、パートナの構成に追加されたプロパティに対してのみ使用します。

構文

deletePartnerProperty(partnerName,partnerType,propName)

引数

定義

partnerName

更新するパートナのID。

<partnerName>の値をパートナIDで置換し、includecertinsignatureパラメータを含めることによって、証明書は署名に含まれます。詳細は、WLSTとSAML 1.1の使用に関する項を参照してください。

partnerType

パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。

有効な値は、sp、idpです。

propName

削除する構成済プロパティの名前。

例

deletePartnerProperty(partnerName="partner1025", partnerType="sp/idp", propName="includecertinsignature")

displayIdPPartnerAttributeProfile

パートナ属性プロファイルを表示します。

説明

IdPパートナ属性プロファイルのコンテンツを表示します。

構文

displayIdPPartnerAttributeProfile(attrProfileID)

引数

定義

attrProfileID

表示するIdPパートナ属性プロファイルを参照する識別子。

例

displayIdPPartnerAttributeProfile(attrProfileID="idp-attribute-profile")

displaySPPartnerAttributeProfile

SPパートナ属性プロファイルを表示します。

説明

SPパートナ属性プロファイルのコンテンツを表示します。

構文

displaySPPartnerAttributeProfile(attrProfileID)

引数

定義

attrProfileID

表示するSPパートナ属性プロファイルを参照する識別子。

例

displaySPPartnerAttributeProfile(attrProfileID="sp-attribute-profile")

getAllFederationIdentityProviders

すべてのフェデレーション・アイデンティティ・プロバイダを一覧表示します。

説明

Access Managerのすべてのフェデレーション・アイデンティティ・プロバイダのリストを表示します。

構文

getAllFederationIdentityProviders()

例

getAllFederationIdentityProviders()

getAllFederationServiceProviders

すべてのフェデレーション・サービス・プロバイダを一覧表示します。

説明

Access Managerのすべてのフェデレーション・サービス・プロバイダのリストを表示します。

構文

getAllFederationServiceProviders()

例

getAllFederationServiceProviders()

getFederationPartnerEncryptionCert

パートナの暗号化証明書を取得します。

説明

フェデレーション・パートナの暗号化証明書を取得します。

構文

引数

定義

partnerName

暗号化証明書の取得対象となるパートナのID。

partnerType

パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。

有効な値は、sp、idpです。

例

getFederationPartnerEncryptionCert(partnerName="customPartner",partnerType="idp")

getFederationPartnerSigningCert

パートナの署名証明書を取得します。

説明

フェデレーション・パートナの署名証明書を取得します。

構文

引数

定義

partnerName

署名証明書の取得対象となるパートナのID。

partnerType

パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。

有効な値は、sp、idpです。

例

getFederationPartnerSigningCert(partnerName="partnerID1", partnerType="idp")

getIdPPartnerBasicAuthCredentialUsername

パートナの基本認証ユーザー名を取得します。

説明

フェデレーション・パートナのHTTP Basic認証ユーザー名を取得します。

構文

getIdPPartnerBasicAuthCredentialUsername(partnerName)

引数

定義

partnerName

ユーザー名の取得および表示対象となるパートナのID。

例

getIdPPartnerBasicAuthCredentialUsername(partnerName="partnerID5")

getPartnerProperty

パートナ・プロパティを取得します。

説明

フェデレーション・パートナのプロパティを取得します。

構文

getPartnerProperty(partnerName, partnerType, propName)

引数

定義

partnerName

プロパティの取得対象となるパートナのID。

<partnerName>の値をパートナIDで置換し、includecertinsignatureパラメータを含めることによって、証明書は署名に含まれます。詳細は、WLSTとSAML 1.1の使用に関する項を参照してください。

partnerType

パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。有効な値は、sp、idpです。

propName

構成するプロパティの名前。

例

getPartnerProperty(partnerName="partnerID4", partnerType="sp",
propName="providertrusted")

getStringProperty

文字列プロパティを取得します。

説明

フェデレーション・パートナ・プロファイルの文字列プロパティを取得します。

パートナに属性プロファイルが割り当てられていない場合、(パートナがIdPかSPかに基づいて)デフォルトの属性プロファイルが使用されます。fedserverconfigファイルのdefaultattributeprofileidpおよびdefaultattributeprofilespプロパティはデフォルト・プロファイルを参照します。

構文

getStringProperty("/fedserverconfig/<propertyName>")

引数

定義

propertyName

取得するプロパティの名前。

デフォルトのパートナ・プロファイルはインストール後に使用可能で、次のプロパティがそれらのプロファイルを参照します。デフォルトのプロパティ値は、propertyNameを次のいずれかで置換することにより取得できます。

- defaultpartnerprofileidpsaml20: SAML 2.0 IdPパートナのデフォルトのパートナ・プロファイル

- defaultpartnerprofilespsaml20: SAML 2.0 SPパートナのデフォルトのパートナ・プロファイル

- defaultpartnerprofileidpsaml11: SAML 1.1 IdPパートナのデフォルトのパートナ・プロファイル

- defaultpartnerprofilespsaml11: SAML 1.1 SPパートナのデフォルトのパートナ・プロファイル

- defaultpartnerprofileidpopenid20: OpenID 2.0 IdPパートナのデフォルトのパートナ・プロファイル

- defaultpartnerprofilespopenid20: OpenID 2.0 SPパートナのデフォルトのパートナ・プロファイル

- 条件:
"defaultattributeprofileidp: IdPパートナのデフォルトの属性プロファイル

"defaultattributeprofilesp: SPパートナのデフォルトの属性プロファイル

例

getStringProperty("/fedserverconfig/defaultpartnerprofileidpopenid20")

isFederationPartnerPresent

パートナが構成されているかどうかをチェックします。

説明

指定されたフェデレーション・パートナがAccess Manager内に定義されているかどうかをチェックします。

構文

isFederationPartnerPresent(partnerName, partnerType)

引数

定義

partnerName

パートナID。

partnerType

パートナがサービス・プロバイダであるかアイデンティティ・プロバイダであるかを指定します。

有効な値は、sp、idpです。

例

isFederationPartnerPresent(partnerABC, SP)

listIdPPartnerAttributeProfileIDs

IdPパートナ属性プロファイルを一覧表示します。

説明

既存のIdPパートナ属性プロファイルの識別子を一覧表示します。

構文

listIdPPartnerAttributeProfileIDs()

例

listIdPPartnerAttributeProfileIDs()

listSPPartnerAttributeProfileIDs

SPパートナ属性プロファイルを一覧表示します。

説明

既存のSPパートナ属性プロファイルの識別子を一覧表示します。

構文

listSPPartnerAttributeProfileIDs()

例

listSPPartnerAttributeProfileIDs()

putStringProperty

OSTS構成で指定されたパスの下に文字列値を配置します。

説明

OSTS構成で指定されたパスの下に文字列値を配置します。

構文

putStringProperty(path="/validationtemplates/username-wss-validation-template/StringNAME",value="TestString")

引数

定義

path

文字列プロパティが配置される構成内のパス。

value

文字列。

例

putStringProperty("/spglobal/defaultssoidp", "testpartner")

setDefaultSSOIdPPartner

フェデレーテッド・シングル・サインオン(SSO)のデフォルトIdPとして機能するIdPパートナを設定します。

説明

実行時にフェデレーション認証プラグインによって設定されない場合、フェデレーテッドSSOでデフォルトIdPとして機能するIdPパートナを設定します。

構文

setDefaultSSOIdPPartner(partnerName)

引数

定義

partnerName

フェデレーテッドSSOのデフォルトIdPとして機能するパートナのID。

例

setDefaultSSOIdPPartner(partnerName="partner25")

setFederationPartnerEncryptionCert

パートナの暗号化証明書を設定します。

説明

フェデレーション・パートナの暗号化証明書を設定します。

構文

setFederationPartnerEncryptionCert(partnerName,partnerType,certFile)

引数

定義

partnerName

更新するパートナのID

partnerType

パートナ・タイプ。有効な値は、idp、spです。

certFile

暗号化証明書を格納するファイルのフルパスと名前。証明書の形式は、PEMまたはDERのいずれかです。

例

setFederationPartnerEncryptionCert
(partnerName="customPartner",partnerType="idp",
certFile="/temp/encryption_cert")

setFederationPartnerSigningCert

パートナの署名証明書を設定します。

説明

フェデレーション・パートナの署名証明書を設定します。

構文

setFederationPartnerSigningCert(partnerName,partnerType,certFile)

引数

定義

partnerName

更新するパートナのID。

partnerType

パートナ・タイプ。有効な値は、idp、spです。

certFile

署名証明書を格納するファイルのフルパスと名前を指定します。証明書の形式は、PEMまたはDERのいずれかです。

例

setFederationPartnerSigningCert
(partnerName="customPartner", partnerType="idp",
certFile="/temp/signing_cert")

setIdPPartnerAttributeProfile

パートナ属性プロファイルを設定します。

説明

IdPパートナとのフェデレーション・シングル・サインオンの実行時に使用するIdPパートナ属性プロファイルを設定します。

構文

setIdPPartnerAttributeProfile(partnerName, attrProfileID)

引数

定義

partnerName

更新するパートナのID。

attrProfileID

設定するIdPパートナ属性プロファイルID。

例

setIdPPartnerAttributeProfile(partnerName="partnerID5", attrProfileID="idp-attribute-profile")

setIdPDefaultScheme

ユーザーのチャレンジに使用されるデフォルトのOAM認証スキームを設定します。

説明

ユーザーのチャレンジに使用されるデフォルトのOAM認証スキームを設定します。

構文

setIdPDefaultScheme(authnScheme, appDomain, hostID,
authzPolicy="ProtectedResourcePolicy")

引数

定義

authnScheme

OAM認証スキーム。

appDomain

オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。

hostID

オプション。基底のポリシー・オブジェクトの作成時に使用するHostID。

authzPolicy

オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシーの名前。

例

setIdPDefaultScheme('LDAPScheme')

WebSphereプラットフォームで実行されている場合、コマンドにfedを追加します。

setSPPartnerAttributeProfile

SPパートナ属性プロファイルをSPパートナに設定します。

説明

SPパートナで使用するSPパートナ属性プロファイルを設定します。

構文

setSPPartnerAttributeProfile(partnerName, attrProfileID)

引数

定義

partnerName

更新するパートナのID。

attrProfileID

設定するSPパートナ属性プロファイルのID。

例

setSPPartnerAttributeProfile(partnerName="partnerID5", attrProfileID="sp-attribute-profile")

setIdPPartnerAttributeProfileEntry

IdPフェデレーション・パートナ・プロファイルを設定します。

説明

IdPパートナ属性プロファイル内のエントリを更新します。

構文

setIdPPartnerAttributeProfileEntry(attrProfileID, messageAttributeName,
oamSessionAttributeName, requestFromIdP)

引数

定義

attrProfileID

IdPパートナ属性プロファイル。

messageAttributeName

メッセージ属性の名前。

oamSessionAttributeName

属性の名前(Access Managerセッションで表示される名前です)。

requestFromIdP

この属性をIdPパートナからリクエストする必要があるかどうかを決定します。

有効な値はtrue、falseです。

例

setIdPPartnerAttributeProfileEntry(attrProfileID="idp-attribute-profile", messageAttributeName="first_name",
oamSessionAttributeName="first_name", requestFromIdP="true")

setSPPartnerAttributeProfileEntry

SPフェデレーション・パートナ・プロファイルを設定します。

説明

SPパートナ属性プロファイル内のエントリを設定します。

構文

setSPPartnerAttributeProfileEntry(attrProfileID, messageAttributeName,
value, alwaysSend)

引数

定義

attrProfileID

エントリを設定するSPパートナ属性プロファイルを参照する識別子。

messageAttributeName

属性の名前(送信メッセージに表示される名前です)。

value

属性要素の値。静的な文字列、ユーザー属性、セッション属性またはそれらのタイプの組合せとすることができます。

alwaysSend

この属性を常にSPパートナに送信するかどうかを指定します。有効な値はtrue、falseです。falseの場合、SPパートナがリクエストした場合のみ送信されます(OpenIDがこれをサポートしています)。

例

setSPPartnerAttributeProfileEntry(attrProfileID="sp-attribute-profile",
messageAttributeName="first_name", value="$user.attr.givenname",
alwaysSend="true")

setIdPPartnerBasicAuthCredential

パートナの基本認証資格証明を設定します。

説明

フェデレーション・パートナのHTTP Basic認証資格証明を設定または更新します。

構文

setIdPPartnerBasicAuthCredential(partnerName,username,password)

引数

定義

partnerName

更新するパートナのID。

username

ユーザーのユーザーID。

password

usernameに対応するパスワード。

例

setIdPPartnerBasicAuthCredential(partnerName="partnerID4", username="user1")

setIdPPartnerMappingAttribute

パートナのアサーション・マッピング属性を設定します。

説明

ユーザーを識別するため、IdPから受信したOpenIDアサーションからの属性が、指定されたデータ・ストア属性にマップされることを指定します。

構文

setIdPPartnerMappingAttribute(partnerName,assertionAttr,userstoreAttr)

引数

定義

partnerName

更新するパートナのID。

assertionAttr

ユーザーをアイデンティティ・ストアにマップするために使用されるアサーション内の属性名。

userstoreAttr

アサーション属性値のマップ先となる、アイデンティティ・ストア内の属性の名前。

例

setIdPPartnerMappingAttribute(partnerName="partnerID",
assertionAttr="email", userstoreAttr="mail")

setIdPPartnerMappingAttributeQuery

ユーザーのアサーション・マッピングのパートナを属性問合せで更新します。

説明

アサーションをユーザー・ストアにマップする属性問合せを指定するパートナを設定または更新します。

構文

setIdPPartnerMappingAttributeQuery(partnerName,attrQuery)

引数

定義

partnerName

更新するパートナのID

attrQuery

使用する属性問合せ。LDAP問合せには、NameIDに加えて、SAMLアサーション内の属性を参照するプレースホルダーを含めることができます。SAMLアサーション内の属性は、その名前を%文字で囲むことで参照されます。たとえば、属性名がUserlastnameである場合、属性は%Userlastname%として参照されます。NameID値は、%fed.nameidvalue%として参照されます。

例

setIdPPartnerMappingAttributeQuery(partnerName="partnerID",
attrQuery="(&(sn=%Userlastname%)(givenname=%Userfirstname%))")

setIdPPartnerMappingNameID

パートナのマッピングnameIDを設定します。

説明

IdPフェデレーション・パートナのアサーション・マッピングnameID値を設定します。

構文

setIdPPartnerMappingNameID(partnerName,userstoreAttr)

引数

定義

partnerName

更新するパートナのID。

userstoreAttr

アサーションnameIDのマップ先となる、アイデンティティ・ストア内の属性名。

例

setIdPPartnerMappingNameID
(partnerName="partnerID", userstoreAttr="ldapattr")

setPartnerAlias

パートナの別名を設定します。

説明

フェデレーション・パートナの別名を設定または更新します。

構文

setPartnerAlias(partnerName,partnerType,partnerAlias)

引数

定義

partnerName

更新するパートナのID。

partnerType

パートナ・タイプを指定します。有効な値は、spまたはidpです。

partnerAlias

パートナの別名。

例

setPartnerAlias(partnerName="partnerID",
partnerType="sp", partnerAlias="tenant1")

setPartnerIDStoreAndBaseDN

パートナのアイデンティティ・ストアおよびベースDNを設定します。

説明

フェデレーション・パートナのアイデンティティ・ストアおよびベースDNを設定または更新します。

構文

setPartnerIDStoreAndBaseDN(partnerName,partnerType,storeName,searchBaseDN)

引数

定義

partnerName

更新するパートナのID。

partnerType

パートナ・タイプ。有効な値は、spまたはidpです。

storeName

アイデンティティ・ストアの名前。ブランクのままにすると、デフォルトのOAMアイデンティティ・ストアが使用されます。(オプション)

searchBaseDN

LDAPの検索ベースDN。ブランクのままにすると、アイデンティティ・ストアで構成されている検索ベースDNが使用されます。(オプション)

例

setPartnerIDStoreAndBaseDN(partnerName="partnerID",
partnerType="sp/idp", storeName="testldap",
searchBaseDN="dc=company,dc=com")

setSPSAMLPartnerNameID

アサーションの発行中にNameIDを設定してパートナを更新します。

説明

SAMLパートナのNameIDを設定します。

構文

setSPSAMLPartnerNameID(<partnerName>, <nameIDFormat>, <nameIDValue>)

引数

定義

partnerName

構成するパートナの名前。

nameIDFormat

使用するNameIDの形式。可能な値は次のとおりです。

- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddressのorafed-emailaddress

- urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectNameのorafed-x509

- urn:oasis:names:tc:SAML:2.0:nameid-format:Kerberosのorafed-kerberos

- urn:oasis:names:tc:SAML:2.0:nameid-format:transientのorafed-transient

- urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedNameのorafed-windowsnamequalifier

- urn:oasis:names:tc:SAML:2.0:nameid-format:persistentのorafed-persistent

- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecifiedのorafed-unspecified

- no NameIDのorafed-none

- 形式がその他の値に設定された場合、アサーションにはその値が移入されます。

nameIDValue

NameID要素の値。静的な文字列、ユーザー属性、セッション属性またはそれらのタイプの組合せとすることができます。

例

setSPSAMLPartnerNameID(partnerName="partnerID", nameIDFormat="emailAddress",
nameIDValue="$user.attr.mail")

updatePartnerMetadata

パートナ・メタデータを更新します。

説明

フェデレーション・パートナのメタデータを更新します。

構文

updatePartnerMetadata(partnerName,partnerType,metadataFile)

引数

定義

partnerName

更新するパートナのID

partnerType

パートナ・タイプを指定します。有効な値は、spまたはidpです。

metadataFile

メタデータ・ファイルの場所。完全なパスと名前を指定します。

例

updatePartnerMetadata(partnerName="partnerID",
partnerType="sp", metadataFile="/common/idm/abc_metadata_file")

updatePartnerProperty

パートナ・プロパティを更新します。

WLSTとSAML 1.1の使用に関する項も参照してください。

説明

フェデレーション・パートナの、指定されたプロパティを構成または更新します。

構文

updatePartnerProperty(partnerName,partnerType,propName,propValue,type)

引数

定義

partnerName

更新するパートナのID。

<partnerName>の値をパートナIDで置換し、includecertinsignatureパラメータを含めることによって、証明書は署名に含まれます。詳細は、WLSTとSAML 1.1の使用に関する項を参照してください。

partnerType

パートナ・タイプを指定します。有効な値は、spまたはidpです。

propName

構成するプロパティの名前。

propValue

設定するプロパティ値。

type

プロパティのデータ型。有効な値は、string、longまたはbooleanです。

例

updatePartnerProperty(partnerName="partnerID", partnerType="idp",
propName="providertrusted",
propValue="true",type="boolean")

Oracle Access Management Advanced Identity Federationコマンド

次のセクションのWLSTコマンドには、Oracle Access Managementコンソールの構成で該当する管理フィールドがありません。認証マッピングの管理とパートナ・プロファイルはWLSTコマンドを使用してのみ利用できます。

- フェデレーション・サービスとデータストアの構成

- フェデレーション・アクセスの構成

- 属性共有の構成

- 認証メソッドのマッピング管理でのWLSTの使用

- パートナ・プロファイル管理でのWLSTの使用

- WLSTとSAML 1.1の使用

注意:

Identity Federation WLSTコマンドはキーと値の組合せまたは値のみを取りますが、Access Managerはキーと値の組合せのみを取ります。このドキュメントのWLSTの例は、いずれの方法でも定義できます。このWLSTの例では、キーと値の組合せを使用します。

setIdPPartnerAttributeProfileEntry(attrProfileID="openid-idp-attribute-profile", messageAttributeName="http://axschema.org/namePerson", oamSessionAttributeName="name", requestFromIdP="true")

フェデレーション・サービスとデータストアの構成

次の項では、フェデレーションSSOの機能を構成するための一般的なコマンドの詳細を示します。

- configureFederationService

- setFederationStore

configureFederationService

Federation ServiceのAttributeRequesterまたはAttributeResponderを有効または無効にします。

説明

Federation Serviceの機能を有効または無効にします。

構文

configureFederationService(<serviceType>,<enabled>)

引数

定義

serviceType

値としてIDP、SP、AttributeResponderまたはAttributeRequesterを取ります。

enabled

値としてtrueまたはfalseを取ります。

例

configureFederationService("idp", "true")

configureFederationService("AttributeResponder", "true")

setFederationStore

フェデレーション・ストアでの使用を有効にして構成します。

説明

フェデレーション・レコードの格納に使用されるデータストアのjndi名を設定し、ストアをRDBMSとして設定します。

構文

setFederationStore (<enable>, <jndiname>)

引数

定義

enable

フェデレーション・データ・ストアを有効または無効にします。

jndiname

データストアのJNDI名を示します。

例

setFederationStore(enable="true", jndiname="jdbc/oamds")

フェデレーション・アクセスの構成

次の項では、フェデレーションSSOの機能を構成するための一般的なコマンドの詳細を示します。

- configureIdPAuthnRequest

- configureFedSSOAuthz

- useProxiedFedAuthnMethod

- configureFedDigitalSignature

- configureFedSignEncKey

configureIdPAuthnRequest

Force AuthenticationまたはIsPassive、あるいはその両方のIdPパートナまたはIdPパートナ・プロファイルを構成します。

説明

Force AuthenticationまたはIsPassive、あるいはその両方のIdPパートナまたはIdPパートナ・プロファイルを構成します。

構文

configureIdPAuthnRequest(<partner="">, <partnerProfile="">, <partnerType="">, <isPassive="false">, <forceAuthn="false">, <displayOnly="false">, <delete="false">)

引数

定義

partner

構成されるIdPパートナを示します。partnerとpartnerProfileは排他的であり、2つのうちいずれかが必須です。

partnerProfile

構成されるIdPパートナ・プロファイルを示します。partnerとpartnerProfileは排他的であり、2つのうちいずれかが必須です。

partnerType

パートナのタイプ(spまたはidp)。

isPassive

IdPパートナまたはIdPパートナ・プロファイルを構成するかどうかを示し、IdPに送信されたAuthn RequestメッセージはIdPがフェデレーションSSO中にユーザーと対話しないことを示すようにします。trueは、IdPがユーザーと対話しないことを示します。オプション。

forceAuthn

IdPパートナまたはIdPパートナ・プロファイルを構成するかどうかを示し、IdPに送信されたAuthn Requestメッセージは、有効なセッションが存在する場合でも、ユーザーにチャレンジすることを示すようにします。trueは、ユーザーにチャレンジすることを示します。オプション。

displayOnly

このコマンドがIs Passive設定およびForce Authn設定を表示するかどうかを示します。デフォルトはfalseです。オプション。

delete

このコマンドが指定されたパートナまたはパートナ・プロファイルからIs Passive設定およびForce Authn設定を削除するかどうかを示します。デフォルトはfalseです。オプション。

例

configureIdPAuthnRequest(partner="acme", isPassive="false", forceAuthn="true")

configureFedSSOAuthz

フェデレーションSSOの認可を有効にするかどうかを示すブール値。

説明

フェデレーションSSOの認可を有効または無効にします。デフォルトでは、フェデレーションSSOの認可機能は無効になります。

構文

configureFedSSOAuthz(enabled)

引数

定義

enabled

値としてtrueまたはfalseを取ります。

例

configureFedSSOAuthz("true")

configureFedDigitalSignature

デジタル署名で使用されるハッシュ・アルゴリズムの構成

説明

displayOnlyおよびdeleteパラメータがfalseの場合、このコマンドはアルゴリズムを設定します。

構文

configureFedDigitalSignature(<partner="">,
<partnerProfile="">, <partnerType="">, <default="false">,
<algorithm="SHA-256">, <displayOnly="false">, <delete="false">)

引数

定義

partner

SPパートナ・プロファイルのID。

partnerProfile

Access Managerの認証スキームがマップされるフェデレーション認証メソッド。

partnerType

フェデレーション認証メソッドがマップされるAccess Managerの認証スキーム。

default

オプション。SPがフェデレーション認証メソッドをリクエストするときに、指定されたAccess Managerの認証スキームを使用してユーザーにチャレンジするかどうかを示すブール値。

algorithm

オプション。セッションの認証レベルが認証スキーム・レベルと異なる場合に、マッピングで使用する認証レベルを示します。

displayOnly

オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。

delete

オプション。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。

例

configureFedDigitalSignature(default="true",
algorithm="SHA-256")

configureFedSignEncKey

デジタル署名および暗号化操作に使用する署名キー別名または暗号化キー別名、あるいはその両方を構成します。

説明

デジタル署名および暗号化操作に使用する署名キー別名または暗号化キー別名、あるいはその両方を構成します。

構文

configureFedSignEncKey(<partner="">, <partnerProfile="">, <partnerType="">, <default="false">, <signAlias="">, <encAlias="">, <displayOnly="false">, <delete="false">

引数

定義

partner

署名キー別名または暗号化キー別名、あるいはその両方を構成するパートナを示します。partner、partnerProfileおよびdefaultパラメータは排他的であり、3つのうちいずれかが必須です。

partnerProfile

署名キー別名または暗号化キー別名、あるいはその両方を構成するパートナ・プロファイルを示します。partner、partnerProfileおよびdefaultパラメータは排他的であり、3つのうちいずれかが必須です。

partnerType

署名キー別名または暗号化キー別名、あるいはその両方を構成するパートナ・タイプを示します。partnerまたはpartnerProfileを指定するときに必須です。有効な値は、spまたはidpです。

default

構成するグローバル・デフォルト署名キー別名または暗号化キー別名、あるいはその両方を示します。partner、partnerProfileおよびdefaultパラメータは排他的であり、3つのうちいずれかが必須です。

signAlias

署名キー別名。値を設定するときに必須です。

encAlias

暗号化キー別名。値を設定するときに必須です。

displayOnly

このコマンドが署名キー別名および暗号化キー別名を表示するかどうかを示します。デフォルトはfalseです。オプション。

delete

このコマンドが指定されたパートナまたはパートナ・プロファイルから署名キー別名または暗号化キー別名、あるいはその両方を削除するかどうかを示します。デフォルトはfalseです。オプション。

例

configureFedSignEncKey(default="true", signAlias="osts_signing")

属性共有の構成

すべての認証メソッド/スキーム/レベル・マッピングはWLSTコマンドを使用して構成されます。これはパートナ・レベルで行われます。パートナ・レベルで定義されていない場合、パートナ・プロファイル・レベルで行われます。詳細は、次の項で説明されています。

- configureAttributeSharingSPPartnerNameIDMapping

- configureAttributeSharingIdPPartner

- configureAttributeSharingUserDNToIdPPartnerMapping

- configureAttributeSharing

- removeAttributeSharingFromAuthnModule

- configureAttributeSharingPlugin

- insertAttributeSharingInToAuthnModule

configureAttributeSharingSPPartnerNameIDMapping

属性共有中に使用するNameIDからユーザー・ストア属性へのマッピングを構成します。

説明

displayOnlyがtrueの場合、コマンドはNameIDからuserstore属性へのマッピングを表示します。deleteがtrueの場合、コマンドは指定されたマッピングを削除します。それ以外の場合、有効なフラグを指定された値に設定し、nameidをuserstore属性マッピングに設定します。

構文

configureAttributeSharingSPPartnerNameIDMapping(<partner="">,
<partnerProfile="">, <enabled="true">, <nameidformat="">,
<userStoreAttribute="">, <displayOnly="false">, <delete="false">)

引数

定義

partner

構成中のパートナのID。オプション。partnerとpartnerProfileパラメータは排他的であり、2つのうちいずれかが必須です。

partnerProfile

マッピングを構成中のパートナ・プロファイルを示します。オプション。partnerとpartnerProfileパラメータは排他的であり、2つのうちいずれかが必須です。

enabled

nameIDからuserstore属性へのマッピングが有効になっているか、無効になっているかを示すブール値。オプション。デフォルト値はtrueです。

nameidformat

userStoreAttributeにマップされるNameID形式。オプション。削除および作成/更新操作で指定する必要があります。表示操作で指定されない場合、指定されたpartnerまたはpartnerprofileのすべてのマッピングは表示されません。許可されるNameID形式は次のとおりです。

- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddressのorafed-emailaddress

- urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectNameのorafed-x509

- urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedNameのorafed-windowsnamequalifier

- urn:oasis:names:tc:SAML:2.0:nameid-format:kerberosのorafed-kerberos

- urn:oasis:names:tc:SAML:2.0:nameid-format:transientのorafed-transient

- urn:oasis:names:tc:SAML:2.0:nameid-format:persistentのorafed-persistent

- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecifiedのorafed-unspecified

- カスタムnameid形式の<customnameidformaturi>

形式がその他の値に設定された場合、アサーションにはその値が移入されます。

userStoreAttribute

指定されたNameID形式がマップされるuserstore属性。オプション。作成操作または更新操作に対してのみ指定する必要があります。

displayOnly

このコマンドがNameIDからuserstore属性へのマッピングを表示するかどうかを示します。デフォルトはfalseです。オプション。trueに設定すると、マッピングが表示されます。NameIDパラメータを指定しない場合、すべてのマッピングが表示されます。

delete

このコマンドがNameIDからuserstore属性へのマッピングを削除するかどうかを示します。デフォルトはfalseです。オプション。

例

configureAttributeSharingSPPartnerNameIDMapping(partner="acme", nameidformat="orafed-emailaddress", userStoreAttribute="mail")

configureAttributeSharingSPPartnerNameIDMapping(partnerProfile="saml20-idp-partner-profile", nameidformat="orafed-emailaddress", userStoreAttribute="mail")

configureAttributeSharingSPPartnerNameIDMapping(partner="acme")

configureAttributeSharingSPPartnerNameIDMapping(partner="acme", enabled="false")

configureAttributeSharingSPPartnerNameIDMapping(partner="acme",
displayOnly="true")

configureAttributeSharingSPPartnerNameIDMapping(partner="acme",
nameidformat="orafed-emailaddress", delete="true")

configureAttributeSharingSPPartnerNameIDMapping(partner="acme",
nameidformat="orafed-emailaddress", displayOnly="true")

configureAttributeSharingIdPPartner

IdPパートナのデフォルトの属性共有nameidおよびnameid形式を構成します。

説明

IdPパートナのデフォルトの属性共有nameidおよびnameid形式を構成します。

構文

configureAttributeSharingIdPPartner(<partner="">, <partnerProfile="">,<nameidformat="">, <nameidattribute="">)

引数

定義

partner

構成中のパートナのID。オプション。partnerとpartnerProfileパラメータは排他的であり、2つのうちいずれかが必須です。

partnerProfile

マッピングを構成中のパートナ・プロファイルを示します。オプション。partnerとpartnerProfileパラメータは排他的であり、2つのうちいずれかが必須です。

nameidformat

userStoreAttributeにマップされるNameID形式。オプション。削除および作成/更新操作で指定する必要があります。表示操作で指定されない場合、指定されたpartnerまたはpartnerprofileのすべてのマッピングは表示されません。許可されるNameID形式は次のとおりです。

- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddressのorafed-emailaddress

- urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectNameのorafed-x509

- urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedNameのorafed-windowsnamequalifier

- urn:oasis:names:tc:SAML:2.0:nameid-format:kerberosのorafed-kerberos

- urn:oasis:names:tc:SAML:2.0:nameid-format:transientのorafed-transient

- urn:oasis:names:tc:SAML:2.0:nameid-format:persistentのorafed-persistent

- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecifiedのorafed-unspecified

- カスタムnameidのorafed-custom

nameIDAttribute

nameidとして使用するuserstoreの属性。オプション。

displayOnly

このコマンドがNameIDからuserstore属性へのマッピングを表示するかどうかを示します。デフォルトはfalseです。オプション。trueに設定すると、マッピングが表示されます。NameIDパラメータを指定しない場合、すべてのマッピングが表示されます。

例

configureAttributeSharingIdPPartner(partner="acme",
nameidformat="orafed-emailaddress", nameidattribute="mail")

configureAttributeSharingUserDNToIdPPartnerMapping

属性共有DNからIdPへのマッピングを構成します。

説明

displayOnlyがtrueに設定されている場合、構成が表示されます。deleteがtrueに設定されている場合、コマンドは指定されたマッピングを削除します。それ以外の場合、マッピングが作成または更新されます。

構文

configureAttributeSharingUserDNToIdPPartnerMapping(<dn="">,
<idp="">, <displayOnly="false">, <delete="false">)

引数

定義

dn

指定したIdPにマップするDN文字列。オプション。マッピングを削除し、マッピングを設定するために指定する必要があります。表示操作で指定された場合、このDNのマッピングが表示されます。

idp

指定されたDNの属性オーソリティとして使用するIdPのパートナID。オプション。マッピングを作成または更新するときのみ指定する必要があります。

displayOnly

このコマンドがNameIDからuserstore属性へのマッピングを表示するかどうかを示します。デフォルトはfalseです。オプション。trueに設定すると、マッピングが表示されます。NameIDパラメータを指定しない場合、すべてのマッピングが表示されます。

delete

このコマンドがNameIDからuserstore属性へのマッピングを削除するかどうかを示します。デフォルトはfalseです。オプション。

例

configureAttributeSharingUserDNToIdPPartnerMapping
(dn="dc=us,dc=oracle, dc=com", displayOnly="true")

configureAttributeSharingUserDNToIdPPartnerMapping(displayOnly="true")

configureAttributeSharingUserDNToIdPPartnerMapping(dn="dc=us,dc=oracle,dc=com",
delete="true")

configureAttributeSharingUserDNToIdPPartnerMapping(dn="dc=us,dc=oracle,dc=com",
idp="acme")

configureAttributeSharing

デフォルトの属性オーソリティを設定して属性共有機能を構成します。

説明

デフォルトの属性オーソリティを設定して属性共有機能を構成します。

構文

configureAttributeSharing(<defaultAttributeAuthority="">)

引数

定義

defaultAttributeAuthority

デフォルトの属性オーソリティとして使用するパートナのID。このサーバーがSPモードで機能している場合のみ使用されます。

例

configureAttributeSharing(defaultAttributeAuthority="acme")

configureAttributeSharing("acme")

removeAttributeSharingFromAuthnModule

認証モジュールから属性共有プラグインを削除します。

説明

指定されたパートナのフェデレーテッド認証メソッド・マッピングを一覧表示します。

構文

removeAttributeSharingFromAuthnModule(<authnModule>, <stepName="">)

引数

定義

authnModule

属性共有プラグインを削除するauthnModuleの名前。

stepName

削除する属性共有プラグイン・ステップのstepName。複数の属性共有ステップがある場合のみ必要です。オプション。

例

removeAttributeSharingFromAuthnModule(authnModule="LDAPPlugin")

removeAttributeSharingFromAuthnModule(authnModule="LDAPPlugin",
stepName="FedAttributeSharing")

configureAttributeSharingPlugin

特定のパートナ・プロファイルのフェデレーテッド認証メソッド・マッピングを一覧表示します。

説明

属性共有プラグインの入力パラメータを構成します。

構文

configureAttributeSharingPlugin(<authnModule>, <stepName=None>,
<nameIDVariable=None>, <idpVariable=None>, <defaultIdP=None>,
<nameIDFormatVariable=None>, <defaultNameIDFormat=None>,
<requestedAttributes=None>)

引数

定義

authnModule

属性共有プラグインを削除するauthnModuleの名前。

stepName

削除する属性共有プラグイン・ステップのstepName。複数の属性共有ステップがある場合のみ必要です。オプション。

nameIDVariable

ユーザーのnameIDを含むセッションまたはコンテキスト内の変数の名前。

idpVariable

属性リクエストの送信先のidp名を含むセッションまたはコンテキスト内の変数の名前。

defaultIdP

セッションまたはコンテキストからIdPを判断できない場合に、属性リクエストの送信先となるデフォルトのIdPの名前。

nameIDFormatVariable

属性リクエストで使用するnameID形式を含むセッションまたはコンテキスト内の変数の名前。

defaultNameIDFormat

セッションまたはコンテキストからnameid形式を判断できない場合に使用するデフォルトのNameID形式。許可されるNameID形式は次のとおりです。

- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddressのorafed-emailaddress

- urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectNameのorafed-x509

- urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedNameのorafed-windowsnamequalifier

- urn:oasis:names:tc:SAML:2.0:nameid-format:kerberosのorafed-kerberos

- urn:oasis:names:tc:SAML:2.0:nameid-format:transientのorafed-transient

- urn:oasis:names:tc:SAML:2.0:nameid-format:persistentのorafed-persistent

- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecifiedのorafed-unspecified

形式がその他の値に設定された場合、アサーションにはその値が移入されます。

requestedAttributes

IdPからリクエストする属性。この文字列はURL問合せ文字列形式です。

例

configureAttributeSharingPlugin(authnModule="LDAPPlugin",
nameIDVariable="dn", idpVariable="attr.idpname", defaultIdP="acme",
nameIDFormatVariable="attr.nameidformat", defaultNameIDFormat="orafed-x509",
requestedAttributes="mail&accessAllowed=allowed")

insertAttributeSharingInToAuthnModule

属性共有ステップを認証モジュール・フローに挿入します。

説明

認証モジュール・フローから属性共有ステップを削除するのにも使用できます。

構文

insertAttributeSharingInToAuthnModule(<authnModule>,
<fromStep=None>, <fromCond=None>, <toStep=None>, <toCond=None>, <stepName=None>)

引数

定義

authnModule

属性共有プラグインを挿入するauthnModuleの名前。

fromStep

その後で属性共有ステップ(または指定した名前のステップ)を挿入するステップの名前。

fromCond

fromStepの後で属性共有ステップ(または指定した名前のステップ)を呼び出す条件。OnSuccess、OnFailureまたはOnErrorのいずれかである必要があります。

toStep

属性共有ステップ(または指定した名前のステップ)の後で移動先となるステップの名前。

toCond

属性共有ステップ(または指定した名前のステップ)の後でtoStepを呼び出す条件。

stepName

フローに追加中のステップの名前。

例

insertAttributeSharingInToAuthnModule(authnModule="LDAPPlugin",
fromStep="stepUA", fromCond="OnSuccess")

insertAttributeSharingInToAuthnModule(authnModule="LDAPPlugin", fromStep="stepUA",
fromCond="OnSuccess", stepName="success")

認証メソッドのマッピング管理でのWLSTの使用

すべての認証メソッド/スキーム/レベル・マッピングはWLSTコマンドを使用して構成されます。これはパートナ・レベルで行われます。パートナ・レベルで定義されていない場合、パートナ・プロファイル・レベルで行われます。詳細は、次の項で説明されています。

- setSPPartnerAlternateScheme

- setSPPartnerDefaultScheme

- setSPPartnerProfileAlternateScheme

- setSPPartnerProfileDefaultScheme

- addSPPartnerAuthnMethod

- addSPPartnerProfileAuthnMethod

- addIdPPartnerAuthnMethod

- addIdPPartnerProfileAuthnMethod

- listPartnerAuthnMethods

- listPartnerProfileAuthnMethods

- removePartnerAuthnMethod

- removePartnerProfileAuthnMethod

- setIdPPartnerRequestAuthnMethod

- setIdPPartnerProfileRequestAuthnMethod

- useProxiedFedAuthnMethod

setSPPartnerAlternateScheme

別の認証スキームでクライアントを認証する方法を提供します。

説明

アイデンティティ・フェデレーションはHTTPヘッダーを評価し、このパートナに別の認証スキームを使用するかどうか判断します。

構文

setSPPartnerAlternateScheme(<partner>, <enabled="true">, <httpHeaderName="">,
<httpHeaderExpression="">, <authnScheme="">, <appDomain="IAM Suite">,
<hostID="IAMSuiteAgent">, <authzPolicy="Protected Resource Policy">,
<remove="false">)

引数

定義

partner

パートナのID。

enabled

アイデンティティ・フェデレーションがクライアントによって送信されたHTTPヘッダーを評価するかどうかを示します。

httpHeaderName

enabledがtrueの場合は必須で、評価するHTTPヘッダーです。重要: これはグローバル設定であり、すべてのパートナに影響します。

httpHeaderExpression

enabledがtrueの場合は必須で、HTTPヘッダーの値を評価するために使用される正規表現です。

authnScheme

enabledがtrueの場合は必須で、デフォルトのかわりに使用する別の認証スキームです。

appDomain

オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。

hostID

オプション。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。

authzPolicy

オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。

remove

オプション。trueに設定すると、パートナ構成の別のスキームのプロパティが削除されます。

注意:

この操作はポリシー・オブジェクトを作成するため、アプリケーション・ドメイン(デフォルト: IAM Suite)、HostID (デフォルト: IAMSuiteAgent)および認可ポリシー(デフォルト: Protected Resource Policy)の使用を指定できますが、デフォルト値を使用することもできます。

例

この例では、アイデンティティ・フェデレーションを構成してSPパートナAcmeのパートナ・レベルで別の認証スキームを有効にします。これは、ユーザーのブラウザがiPhone文字列を含めてHTTPヘッダーUser-Agentを送信するためです。文字列はデフォルトの認証スキームではなく認証に対してBasicSchemeをトリガーします。

setSPPartnerAlternateScheme("acmeSP", "true", httpHeaderName="User-Agent",
httpHeaderExpression=".*iPhone.*", authnScheme="BasicScheme")

setSPPartnerDefaultScheme

SPパートナのデフォルトの認証スキームを定義します。

説明

SPパートナのデフォルトの認証スキームを定義します。

構文

setSPPartnerDefaultScheme(<partner>, <authnScheme="">, <appDomain="IAM Suite">,
<hostID="IAMSuiteAgent">, <authzPolicy="Protected Resource Policy">)

引数

定義

partner

パートナのID。

authnScheme

使用するOAM認証スキーム。

appDomain

オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。

hostID

オプション。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。

authzPolicy

オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。

例

setSPPartnerDefaultScheme(partnerProfile="acmeSP",
authnScheme="BasicScheme")

setSPPartnerProfileAlternateScheme

別の認証スキームでクライアントを認証する方法を提供します。

説明

アイデンティティ・フェデレーションはHTTPヘッダーを評価し、このパートナ・プロファイルに割り当てられたパートナに別の認証スキームを使用するかどうか判断します。

構文

setSPPartnerProfileAlternateScheme(<partnerProfile>,
<enabled="true">, <httpHeaderName="">, <httpHeaderExpression="">,
<authnScheme="">, <appDomain="IAM Suite">, <hostID="IAMSuiteAgent">,
<authzPolicy="Protected Resource Policy">, <remove="false">)

引数

定義

partnerProfile

パートナ・プロファイルのID。

enabled

アイデンティティ・フェデレーションがクライアントによって送信されたHTTPヘッダーを評価するかどうかを示します。

httpHeaderName

enabledがtrueの場合は必須で、評価するHTTPヘッダーです。重要: これはグローバル設定であり、すべてのパートナに影響します。

httpHeaderExpression

enabledがtrueの場合は必須で、HTTPヘッダーの値を評価するために使用される正規表現です。

authnScheme

enabledがtrueの場合は必須で、デフォルトのかわりに使用する別の認証スキームです。

appDomain

オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。

hostID

オプション。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。

authzPolicy

オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。

注意:

この操作はポリシー・オブジェクトを作成するため、アプリケーション・ドメイン(デフォルト: IAM Suite)、HostID (デフォルト: IAMSuiteAgent)および認可ポリシー(デフォルト: Protected Resource Policy)の使用を指定できますが、デフォルト値を使用することもできます。

例

setSPPartnerProfileAlternateScheme("acmeSP", "true",
httpHeaderName="User-Agent", httpHeaderExpression=".*iPhone.*",
authnScheme="BasicScheme")

setSPPartnerProfileDefaultScheme

特定のSPパートナ・プロファイルのユーザーのチャレンジに使用されるデフォルトのOAM認証スキームを設定します。

説明

特定のSPパートナ・プロファイルのユーザーのチャレンジに使用されるデフォルトのOAM認証スキームを設定します。

構文

setSPPartnerProfileDefaultScheme(<partnerProfile>,
<authnScheme="">, <appDomain="IAM Suite">, <hostID="IAMSuiteAgent">,
<authzPolicy="Protected Resource Policy">)

引数

定義

partnerProfile

パートナ・プロファイルのID。

authnScheme

使用するOAM認証スキーム。

appDomain

オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。

hostID

オプション。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。

authzPolicy

オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。

例

setSPPartnerProfileDefaultScheme("saml20-sp-partner-profile",
"LDAPScheme")

addSPPartnerAuthnMethod

フェデレーテッド認証メソッドと特定のSPパートナのAccess Manager認証スキームの間のマッピングを定義します。

説明

SPパートナのAccess Manager認証スキームにフェデレーテッド認証メソッドをマップします。

構文

addSPPartnerAuthnMethod(partner, authnMethod, authnScheme,
isDefault="true", authnLevel="-1", appDomain="IAM Suite",
hostID="IAMSuiteAgent", <authzPolicy="Protected Resource Policy">)

引数

定義

partner

SPパートナのID。

authnMethod

Access Managerの認証スキームがマップされるフェデレーション認証メソッド。

authnScheme

フェデレーション認証メソッドがマップされるAccess Managerの認証スキーム。

isDefault

オプション。SPがフェデレーション認証メソッドをリクエストするときに、指定されたAccess Managerの認証スキームを使用してユーザーにチャレンジするかどうかを示すブール値。

authnLevel

オプション。セッションの認証レベルが認証スキーム・レベルと異なる場合に、マッピングで使用する認証レベルを示します。

appDomain

オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。

hostID

オプション。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。

authzPolicy

オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。

例

addSPPartnerAuthnMethod("acmeSP",
"urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport",
"LDAPScheme")

addSPPartnerProfileAuthnMethod

フェデレーテッド認証メソッドから特定のSPパートナ・プロファイルのAccess Manager認証スキームへのマッピングを定義します。

説明

SPパートナ・プロファイルのAccess Manager認証スキームにフェデレーテッド認証メソッドをマップします。

構文

addSPPartnerProfileAuthnMethod(partnerProfile, authnMethod,
authnScheme, isDefault="true", authnLevel="-1", appDomain="IAM Suite",
hostID="IAMSuiteAgent", <authzPolicy="Protected Resource Policy">)

引数

定義

partnerProfile

SPパートナ・プロファイルのID。

authnMethod

Access Managerの認証スキームがマップされるフェデレーション認証メソッド。

authnScheme

フェデレーション認証メソッドがマップされるAccess Managerの認証スキーム。

isDefault

オプション。SPがフェデレーション認証メソッドをリクエストするときに、指定されたAccess Managerの認証スキームを使用してユーザーにチャレンジするかどうかを示すブール値。

authnLevel

オプション。セッションの認証レベルが認証スキーム・レベルと異なる場合に、マッピングで使用する認証レベルを示します。

appDomain

オプション。基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。

hostID

オプション。基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。

authzPolicy

オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。

例

addSPPartnerProfileAuthnMethod("saml20-sp-partner-profile",
"urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport",
"LDAPScheme")

addIdPPartnerAuthnMethod

特定のIdPパートナのフェデレーテッド認証メソッドのセッションを作成するときに使用する認証レベルを設定します。

説明

このIdPパートナのユーザーが認証されるレベルを定義します。

構文

addIdPPartnerAuthnMethod(partner, authnMethod, authnLevel)

引数

定義

partner

SPパートナ・プロファイルのID。

authnMethod

フェデレーテッド認証メソッド。

authnLevel

指定されたフェデレーテッド認証メソッドのフェデレーションSSOフロー中にAccess Managerユーザー・セッションを作成するために使用するレベル。

例

addIdPPartnerAuthnMethod("acmeIdP",
"urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", "1")

addIdPPartnerProfileAuthnMethod

特定のIdPパートナ・プロファイルのフェデレーテッド認証メソッドのセッションを作成するときに使用する認証レベルを設定します。

説明

このIdPパートナ・プロファイルのユーザーが認証されるレベルを定義します。

構文

addIdPPartnerProfileAuthnMethod(partnerProfile, authnMethod,
authnLevel)

引数

定義

partnerProfile

SPパートナ・プロファイルのID。

authnMethod

フェデレーテッド認証メソッド。

authnLevel

指定されたフェデレーテッド認証メソッドのフェデレーションSSOフロー中にAccess Managerユーザー・セッションを作成するために使用するレベル。

例

addIdPPartnerProfileAuthnMethod("saml20-idp-partner-profile",
"urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport", "1")

listPartnerAuthnMethods

特定のパートナのフェデレーテッド認証メソッド・マッピングを一覧表示します。

説明

指定されたパートナのフェデレーテッド認証メソッド・マッピングを一覧表示します。

構文

listPartnerAuthnMethods(partner, partnerType)

引数

定義

partner

パートナのID

partnerType

パートナのタイプ(SPまたはIdP)

例

listPartnerAuthnMethods("acmeSP", "SP")

listPartnerProfileAuthnMethods

特定のパートナ・プロファイルのフェデレーテッド認証メソッド・マッピングを一覧表示します。

説明

指定されたパートナ・プロファイルのフェデレーテッド認証メソッド・マッピングを一覧表示します。

構文

listPartnerProfileAuthnMethods(partnerProfile, partnerType)

引数

定義

partnerProfile

パートナ・プロファイルのID

partnerType

パートナのタイプ(SPまたはIdP)

例

listPartnerProfileAuthnMethods("saml20-sp-partner-profile", "SP")

removePartnerAuthnMethod

フェデレーテッド認証メソッドと特定のパートナのAccess Manager認証スキームの間のマッピングを削除します。

説明

フェデレーテッド認証メソッドと指定したパートナのAccess Manager認証スキームの間のマッピングを削除します。

構文

removePartnerAuthnMethod(<partner>, <partnerType>, <authnMethod>)

引数

定義

partner

パートナのID

partnerType

パートナのタイプ(SPまたはIdP)

authnMethod

Access Manager認証スキーム。

例

removePartnerAuthnMethod("acmeSP", "SP",
"urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport")

removePartnerProfileAuthnMethod

フェデレーテッド認証メソッドと特定のパートナのAccess Manager認証スキームの間のマッピングを削除します。

説明

フェデレーテッド認証メソッドと指定したパートナのAccess Manager認証スキームの間のマッピングを削除します。

構文

removePartnerProfileAuthnMethod(<partnerProfile>,
<partnerType>, <authnMethod>)

引数

定義

partnerProfile

パートナ・プロファイルのID

partnerType

パートナのタイプ(SPまたはIdP)

authnMethod

フェデレーテッド認証メソッド。

例

removePartnerProfileAuthnMethod("saml20-sp-partner-profile",
"SP", "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport")

setIdPPartnerRequestAuthnMethod

特定のIdPパートナのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。

説明

指定したIdPパートナのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。

構文

setIdPPartnerRequestAuthnMethod(<partner>, <authnMethod>)

引数

定義

partner

IdPパートナのID

authnMethod

フェデレーテッド認証メソッド。

例

setIdPPartnerRequestAuthnMethod("acmeIdP",
"urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport")

setIdPPartnerProfileRequestAuthnMethod

指定したIdPパートナ・プロファイルのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。

説明

指定したIdPパートナ・プロファイルのフェデレーションSSO中にリクエストされるフェデレーテッド認証メソッドを設定します。

構文

setIdPPartnerProfileRequestAuthnMethod(<partnerProfile>,
<authnMethod>)

引数

定義

partnerProfile

IdPパートナ・プロファイルのID

authnMethod

フェデレーテッド認証メソッド。

例

setIdPPartnerProfileRequestAuthnMethod("saml20-idp-partner-profile",
"urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport")

useProxiedFedAuthnMethod

フェデレーションSSOを実行するときに、プロキシ処理されたフェデレーテッド認証メソッドを使用するアイデンティティ・プロバイダを構成します。

説明

サーバーがリモートIdPを使用してSPとして機能してユーザーを認証する場合、サーバーは別のフェデレーションSSO操作でアイデンティティ・プロバイダとして機能するときに、リモート・アイデンティティ・プロバイダによって送信されたフェデレーション認証メソッドを使用できます。サーバーは、指定したフェデレーション認証スキームの一覧に対して、プロキシ処理されたフェデレーション認証メソッドを送信します。サーバーがプロキシ処理されたフェデレーション認証メソッドを送信するのは、サーバーとサービス・プロバイダの間で使用されるフェデレーション・プロトコルが、サーバーとアイデンティティ・プロバイダの間で使用されるのと同じフェデレーション・プロトコルである場合のみです。

構文

useProxiedFedAuthnMethod(<enabled="false">,
<displayOnly="false">, <authnSchemeToAdd="">, <authnSchemeToRemove="">,
<appDomain="IAM Suite">, <hostID="IAMSuiteAgent">,
<authzPolicy="Protected Resource Policy">)

引数

定義

enabled

プロキシ処理されたフェデレーション認証メソッドを使用するかどうかを示します。デフォルトでは、機能が無効になります。オプション。

displayOnly

このコマンドが、サーバーがプロキシ処理されたフェデレーション認証メソッドを送信するフェデレーション・スキームを一覧表示するかどうかを示します。デフォルトはfalseです。オプション。

authnSchemeToAdd

サーバーがプロキシ処理されたフェデレーション認証メソッドを送信するスキームの一覧に追加するOAMフェデレーション認証スキーム。authnSchemeToAddおよびauthnSchemeToRemoveパラメータは排他的です。

authnSchemeToRemove

サーバーがプロキシ処理されたフェデレーション認証メソッドを送信するスキームの一覧から削除するOAMフェデレーション認証スキーム。authnSchemeToAddおよびauthnSchemeToRemoveパラメータは排他的です。

appDomain

基底のポリシー・コンポーネントが作成されるアプリケーション・ドメイン。オプション。

hostID

基底のリソース・ポリシー・オブジェクトの作成時に使用するHostID。オプション。

authzPolicy

オプション。作成中の基底のリソース・ポリシー・オブジェクトを保護するために使用する認可ポリシー名。

例

useProxiedFedAuthnMethod(enabled="true",
authnSchemeToAdd="FederationScheme")

パートナ・プロファイル管理でのWLSTの使用

すべてのパートナ・プロファイルの管理はWLSTコマンドを使用して行います。次の項では、具体的なコマンドの詳細について説明します。

- createFedPartnerProfileFrom

- deleteFedPartnerProfile

- displayFedPartnerProfile

- listFedPartnerProfiles

- listFedPartnersForProfile

- getFedPartnerProfile

- setFedPartnerProfile

createFedPartnerProfileFrom

指定した既存のプロファイルに基づいてフェデレーション・パートナ・プロファイルを作成します。

説明

指定した既存のパートナ・プロファイルに基づいて新しいパートナ・プロファイルを作成します。

構文

createFedPartnerProfileFrom(<newPartnerProfile>,
<existingPartnerProfile>)

引数

定義

newPartnerProfile

新しいパートナ・プロファイルのID。

existingPartnerProfile

既存のパートナ・プロファイルのID。

例

createFedPartnerProfileFrom("newAcmeSPProfile", "acmeSPProfile")

deleteFedPartnerProfile

指定したフェデレーション・パートナ・プロファイルを削除します。

説明

指定したパートナ・プロファイルを削除します。

構文

deleteFedPartnerProfile(<PartnerProfile>)

引数

定義

PartnerProfile

削除するパートナ・プロファイルのID。

例

deleteFedPartnerProfile("acmeSPProfile")

displayFedPartnerProfile

指定したフェデレーション・パートナ・プロファイルで定義されているプロパティを表示します。

説明

指定したフェデレーション・パートナ・プロファイルのプロパティを表示します。

構文

displayFedPartnerProfile(<PartnerProfile>)

引数

定義

PartnerProfile

パートナ・プロファイルのID。

例

displayFedPartnerProfile("saml20-idp-partner-profile")

listFedPartnerProfiles

既存のすべてのフェデレーション・パートナ・プロファイルを一覧表示します。

説明

既存のフェデレーション・パートナ・プロファイルを一覧表示します。

構文

listFedPartnerProfiles()

このコマンドには、引数はありません。

例

listFedPartnerProfiles()

listFedPartnersForProfile

指定したフェデレーション・パートナ・プロファイルにバインドされたパートナを一覧表示します。

説明

指定したフェデレーション・パートナ・プロファイルにバインドされたすべてのパートナを一覧表示します。

構文

listFedPartnersForProfile(<PartnerProfile>)

引数

定義

PartnerProfile

パートナ・プロファイルのID。

例

listFedPartnersForProfile("acmeSPProfile")

getFedPartnerProfile

指定したパートナにバインドされたパートナ・プロファイルのIDを取得します。

説明

指定したパートナにバインドされたパートナ・プロファイルのIDを取得します。

構文

getFedPartnerProfile(<partner>, <partnerType>)

引数

定義

partner

パートナのID。

partnerType

パートナのタイプ(spまたはidp)。

例

getFedPartnerProfile("acmeIDP", "idp")

setFedPartnerProfile

指定したパートナのフェデレーション・パートナ・プロファイルのIDを設定します。

説明

指定したパートナ・プロファイルのIDに基づいて指定したパートナ・プロファイルのパートナ・プロファイルを設定します。

構文

setFedPartnerProfile(<partner>, <partnerType>, <partnerProfile>)

引数

定義

partner

パートナのID。

partnerType

パートナのタイプ(spまたはidp)。

partnerProfile

パートナ・プロファイルのID。

例

setFedPartnerProfile("acmeIDP", "idp",
"saml20-idp-partner-profile")

WLSTとSAML 1.1の使用

次のSAML 1.1構成パラメータは、Oracle Access Managementコンソールからは公開されません。これらのパラメータの値は、次のWLSTコマンドを使用して変更できます。

- 「updatePartnerProperty」

- 「deletePartnerProperty」

- 「getPartnerProperty」

IDPパートナがSAML 1.1に対して構成されている場合、SSOプロセスを開始するために次のURLがSPによって使用されます。

http://idphost:idpport/ssourl?TARGET=targeturl&providerid=http://spproviderid

これらのWLSTコマンドに次のパラメータを追加することで、URLに該当する情報を移入できます。

- idpinitiatedssoprovideridparam

- idpinitiatedssotargetparam

idpinitiatedssoprovideridparam

idpinitiatedssoprovideridparamによって保持される値は、SPのプロバイダIDを識別するためにピア・プロバイダによって使用されます。

説明

SPのプロバイダIDを識別するために使用する値を設定します。

構文

updatePartnerProperty(partnerName, partnerType,
"idpinitiatedssoprovideridparam","providerid", "string")

引数

定義

partnerName

パートナのID

partnerType

値にidpまたはspを取ります。

propName

構成または変更するプロパティの名前。

propValue

構成するプロパティの値。OIFピアIDPの場合、パラメータ名はprovideridである必要があります。このプロパティを変更すると、上記のURLで使用されているパラメータ名が変更されます。

type

プロパティ値のデータ型。有効な値は、string、longまたはbooleanです。

例

updatePartnerProperty(partnerName, "idp",
"idpinitiatedssoprovideridparam","providerid", "string")

idpinitiatedssotargetparam

指定したSPパートナのターゲットURLを設定します。

説明

ターゲット・リソースを識別します。idpinitiatedssotargetparamによって保持される値は、必要なリソースを識別するためにピア・プロバイダによって使用されます。Oracle Identity Federationの場合はTARGETです。

構文

updatePartnerProperty(partnerName, partnerType,
"idpinitiatedssotargetparam", "TARGET", "string")

引数

定義

partnerName

パートナのID

partnerType

値にidpまたはspを取ります。

propName

構成または変更するプロパティの名前。

propValue

リソースの場所。デフォルト値はTARGETです。

type

プロパティ値のデータ型。有効な値は、string、longまたはbooleanです。

例

updatePartnerProperty(partnerName, "idp",
"idpinitiatedssotargetparam", "TARGET", "string")

注意:

証明書をSAML 1.1署名に含めることができます。<partnerName>の値をパートナIDで置換し、includecertinsignatureパラメータを含めることによって、証明書は署名に含まれます。例:

updatePartnerProperty("<partnerName>", "sp",
"includecertinsignature", "true", "boolean")

getPartnerProperty("<partnerName>", "sp", "includecertinsignature")

deletePartnerProperty("<partnerName>", "sp",
"includecertinsignature")

Oracle Access Management Mobile and Socialコマンド

この項に示されているWLSTコマンドを使用して、Oracle Access Management Mobile and Social (Mobile and Social)構成オブジェクトを管理します。

- モバイル・サービスとソーシャル・アイデンティティの詳細については、表4-8に一覧表示されているコマンドを参照してください。

- OAuthサービスの詳細については、表4-9に一覧表示されているコマンドを参照してください。

表4-8 モバイル・サービスとソーシャル・アイデンティティのWLSTモバイルおよびソーシャル・コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

システム構成コマンド

getRPSystemConfig

システム構成データを取得します。

オンライン

replaceRPSystemConfig

システム構成データを更新します。

オンライン

RPApplicationコマンド

getRPApplications

RPApplicationオブジェクトを取得します。

オンライン

removeRPApplication

指定されたRPApplicationオブジェクトを削除します。

オンライン

displayRPApplication

指定されたRPApplicationオブジェクトを表示します。

オンライン

createRPApplication

新しいRPApplicationオブジェクトを作成します。

オンライン

updateRPApplication

定義済のRPApplicationオブジェクトの値を更新します。

オンライン

ServiceProviderInterfaceコマンド

getServiceProviderInterfaces

RPApplicationオブジェクトを取得します。

オンライン

removeServiceProviderInterface

指定されたRPApplicationオブジェクトを削除します。

オンライン

displayServiceProviderInterface

指定されたRPApplicationオブジェクトを表示します。

オンライン

createServiceProviderInterface

新しいRPApplicationオブジェクトを作成します。

オンライン

updateServiceProviderInterface

定義済のRPApplicationオブジェクトの値を更新します。

オンライン

ソーシャル・アイデンティティ・プロバイダ・コマンド

getInternetIdentityProviders

ソーシャル・アイデンティティ・プロバイダ・オブジェクトを取得します。

オンライン

removeInternetIdentityProvider

指定されたソーシャル・アイデンティティ・プロバイダ・オブジェクトを削除します。

オンライン

displayInternetIdentityProvider

指定されたソーシャル・アイデンティティ・プロバイダ・オブジェクトを表示します。

オンライン

createInternetIdentityProvider

新しいソーシャル・アイデンティティ・プロバイダ・オブジェクトを作成します。

オンライン

updateInternetIdentityProvider

定義済のソーシャル・アイデンティティ・プロバイダ・オブジェクトの値を更新します。

オンライン

ユーザー属性マッピング・コマンド

getUserAttributeMappings

ユーザー属性マッピング・オブジェクトを取得します。

オンライン

removeUserAttributeMapping

指定されたユーザー属性マッピング・オブジェクトを削除します。

オンライン

displayUserAttributeMapping

指定されたユーザー属性マッピング・オブジェクトを表示します。

オンライン

updateUserAttributeMapping

定義済のユーザー属性マッピング・オブジェクトの値を更新します。

オンライン

ServiceProviderコマンド

createServiceProvider

ServiceProviderを作成します。

オンライン

updateServiceProvider

ServiceProviderを更新します

オンライン

addRelationshipToServiceProvider

サービス・プロバイダに関係を追加します。

オンライン

removeRelationshipFromServiceProvider

サービス・プロバイダから関係を削除します。

オンライン

getServiceProviders

ServiceProviderを取得します。

オンライン

removeServiceProvider

ServiceProviderオブジェクトを削除します。

オンライン

displayServiceProvider

ServiceProviderオブジェクトを表示します。

オンライン

ServiceProfileコマンド

createServiceProfile

サービス・オブジェクトを作成します。

オンライン

updateServiceProfile

サービス・オブジェクトを更新します。

オンライン

removeServiceProfile

サービス・オブジェクトを削除します。

オンライン

displayServiceProfile

サービス・オブジェクトを表示します。

オンライン

getServiceProfiles

すべてのサービス・オブジェクトを取得します。

オンライン

ApplicationProfileコマンド

getApplicationProfiles

すべてのApplicationProfileオブジェクトを一覧表示します。

オンライン

createApplicationProfile

ApplicationProfileを作成します。

オンライン

updateApplicationProfile

ApplicationProfileを更新します。

オンライン

removeApplicationProfile

ApplicationProfileを削除します。

オンライン

displayApplicationProfile

ApplicationProfileを表示します。

オンライン

ServiceDomainコマンド

createServiceDomain

ServiceDomainを作成します。

オンライン

updateServiceDomain

ServiceDomainを更新します。

オンライン

getServiceDomains

ServiceDomainを取得します。

オンライン

removeServiceDomain

ServiceDomainを削除します。

オンライン

displayServiceDomain

ServiceDomainを表示します。

オンライン

SecurityHandlerコマンド

createSecurityHandlerPlugin

SecurityHandlerPluginを作成します。

オンライン

updateSecurityHandlerPlugin

SecurityHandlerPluginを更新します。

オンライン

getSecurityHandlerPlugins

SecurityHandlerPluginを取得します。

オンライン

removeSecurityHandlerPlugin

SecurityHandlerPluginを削除します。

オンライン

displaySecurityHandlerPlugin

SecurityHandlerPluginを表示します。

オンライン

JailBreakingDetectionPolicyコマンド

createJailBreakingDetectionPolicy

JailBreakingDetectionPolicyを作成します。

オンライン

updateJailBreakingDetectionPolicy

JailBreakingDetectionPolicyを更新します。

オンライン

getJailBreakingDetectionPolicys

JailBreakingDetectionPolicyを取得します。

オンライン

removeJailBreakingDetectionPolicy

JailBreakingDetectionPolicyを削除します。

オンライン

displayJailBreakingDetectionPolicy

JailBreakingDetectionPolicyを表示します。

オンライン

表4-9 OAuthサービスのWLSTモバイルおよびソーシャル・コマンド

コマンド

用途

WLSTでの使用

OAuthアイデンティティ・ドメイン・コマンド

removeOAuthIdentityDomain

指定されたOAuthアイデンティティ・ドメインを削除します。

オンライン

createOAuthIdentityDomain

新しいOAuthアイデンティティ・ドメインを作成します。

オンライン

updateOAuthIdentityDomain

OAuthアイデンティティ・ドメインを更新します。

オンライン

OAuthシステム構成コマンド

updateOAuthSystemConfig

アイデンティティ・ドメインのOAuthシステム構成のデフォルトを更新します。

オンライン

OAuthシステム・コンポーネント・コマンド

removeOAuthSysComponent

指定されたOAuthシステム・コンポーネントを削除します。

オンライン

createOAuthSysComponent

指定されたOAuthシステム・コンポーネントを作成します。

オンライン

updateOAuthSysComponent

指定されたOAuthシステム・コンポーネントを更新します。

オンライン

OAuthサービス・プロバイダ・コマンド

removeOAuthServiceProvider

このコマンドは、OAuthサービス・プロバイダ・オブジェクトを削除します。

オンライン

createOAuthServiceProvider

OAuthサービス・プロバイダを作成します

オンライン

updateOAuthServiceProvider

OAuthサービス・プロバイダを更新します

オンライン

OAuthクライアント・コマンド

removeOAuthClient

OAuthクライアント・オブジェクトを削除します。

オンライン

createOAuthClient

OAuthクライアント・オブジェクトを作成します。

オンライン

updateOAuthClient

OAuthクライアント・オブジェクトを更新します。

オンライン

サービス・プロファイル・コマンド

removeOAuthServiceProfile

サービス・プロファイルを削除します。

オンライン

createOAuthServiceProfile

サービス・プロファイルを作成します。

オンライン

updateOAuthServiceProfile

サービス・プロファイルを更新します。

オンライン

OAuthアダプティブ・アクセス・プラグイン・コマンド

removeOAuthAdaptiveAccessPlugin

指定されたOAuthアダプティブ・アクセス・プラグインを削除します。

オンライン

createOAuthAdaptiveAccessPlugin

指定されたOAuthアダプティブ・アクセス・プラグインを作成します。

オンライン

updateOAuthAdaptiveAccessPlugin

指定されたOAuthアダプティブ・アクセス・プラグインを更新します。

オンライン

OAuthトークン属性プラグイン・コマンド

removeOAuthTokenAttributesPlugin

指定されたOAuthトークン属性プラグインを削除します。

オンライン

createOAuthTokenAttributesPlugin

指定されたOAuthトークン属性プラグインを作成します。

オンライン

updateOAuthTokenAttributesPlugin

指定されたOAuthトークン属性プラグインを更新します。

オンライン

OAuthリソース・サーバー・インタフェース・コマンド

removeOAuthResourceServerInterface

OAuthリソース・サーバー・インタフェースを削除します。

オンライン

updateOAuthResourceServerInterface

OAuthリソース・サーバー・インタフェースを更新します。

オンライン

createOAuthResourceServerInterface

OAuthリソース・サーバー・インタフェースを作成します。

オンライン

OAuthジェイルブレーク検出ポリシー・コマンド

updateOAuthJailBreakingDetectionPolicy

指定されたOAuthジェイルブレーク検出ポリシーを更新します。

オンライン

OAuthリソース・サーバー・インタフェース

removeOAuthUserProfileResourceServer

OAuthユーザー・プロファイル・リソース・サーバー・インタフェースを削除します。

オンライン

updateOAuthUserProfileResourceServer

OAuthユーザー・プロファイル・リソース・サーバー・インタフェースを更新します。

オンライン

createOAuthUserProfileResourceServer

OAuthユーザー・プロファイル・リソース・サーバー・インタフェースを作成します。

オンライン

取得/表示コマンド

getOAuthIdentityDomains

すべての既存のOAuthアイデンティティ・ドメインを取得します。

オンライン

displayOAuthIdentityDomain

指定されたOAuthアイデンティティ・ドメインを表示します。

オンライン

displayOAuthSystemConfig

指定されたOAuthシステム構成を表示します。

オンライン

getOAuthSysComponents

すべての既存のOAuthシステム・コンポーネントを取得します。

オンライン

displayOAuthSysComponent

指定されたOAuthシステム・コンポーネントを表示します。

オンライン

getOAuthServiceProviders

すべての既存のOAuthサービス・プロバイダを取得します。

オンライン

displayOAuthServiceProvider

指定されたOAuthサービス・プロバイダを表示します。

オンライン

getOAuthClients

すべての既存のOAuthクライアントを取得します。

オンライン

displayOAuthClient

指定されたOAuthクライアントを表示します。

オンライン

getOAuthAdaptiveAccessPlugins

すべての既存のOAuthアダプティブ・アクセス・プラグインを取得します。

オンライン

displayOAuthAdaptiveAccessPlugin

指定されたOAuthアダプティブ・アクセス・プラグインを表示します。

オンライン

getOAuthAuthzPlugin

すべての既存のOAuth認可プラグインを取得します。

オンライン

displayOAuthAuthzPlugin

指定されたOAuth認可プラグインを表示します。

オンライン

getOAuthTokenAttributesPlugins

すべての既存のOAuthトークン属性プラグインを取得します。

オンライン

displayOAuthTokenAttributesPlugin

指定されたOAuthトークン属性プラグインを表示します。

オンライン

getOAuthResourceServerInterfaces

すべての既存のOAuthリソース・サーバー・インタフェースを取得します。

オンライン

displayOAuthResourceServerInterface

指定されたOAuthリソース・サーバー・インタフェースを表示します。

オンライン

getOAuthUserProfileResourceServers

すべての既存のOAuthユーザー・プロファイル・リソース・サーバー・プラグインを取得します。

オンライン

displayOAuthUserProfileResourceServer

指定されたOAuthユーザー・プロファイル・リソース・サーバー・プラグインを表示します。

オンライン

getOAuthServiceProfiles

すべての既存のOAuthサービス・プロファイルを取得します。

オンライン

displayOAuthServiceProfile

指定されたOAuthサービス・プロファイルを表示します。

オンライン

getRPSystemConfig

getRPSystemConfig

説明

システム構成情報を取得します。

構文

getRPSystemConfig( )

このコマンドには、引数はありません。

例

getRPSystemConfig( )

replaceRPSystemConfig

replaceRPSystemConfig

説明

特定のシステム構成の値を置換します。

構文

replaceRPSystemConfig(hostURL, proxyProtocol, proxyHost, proxyPort, proxyUsername, proxyPassword, attributeList)

表4-10 replaceRPSystemConfigの引数

引数

定義

hostURL

Mobile and SocialサーバーをホストするマシンのURL。

proxyProtocol

プロキシ・プロトコル(HTTP/HTTPS)。

proxyHost

プロキシ・マシンのURL。

proxyPort

プロキシ・マシンのポート。

proxyUsername

プロキシにアクセスするユーザーの名前。

proxyPassword

プロキシにアクセスするユーザーのパスワード。

attributeList

JSON形式の属性のリスト。

[{idp:[{name:value},{name:value}],idp2:[{name:value},{name:value}]}]

例

replaceRPSystemConfig('http://515.server.com','http','server.com','18001','proxyUser','proxyPass','[{aas.rest.service:http://adc514:18001/aas_rest}]')

getRPApplications

getRPApplications

説明

RPApplicationオブジェクトを取得します。

構文

getRPApplications( )

このコマンドには、引数はありません。

例

getRPApplications( )

removeRPApplication

removeRPApplication

説明

指定されたRPApplicationオブジェクトを削除します。

構文

removeRPApplication(name)

ここで、nameは、RPApplicationオブジェクトの名前です。

例

removeRPApplication('TestApp')

displayRPApplication

displayRPApplication

説明

指定されたRPApplicationオブジェクトを表示します。

構文

displayRPApplication(name)

ここで、nameは、RPApplicationオブジェクトの名前です。

例

displayRPApplication('TestApp')

createRPApplication

createRPApplication

説明

新しいRPApplicationオブジェクトを作成します。

構文

createRPApplication(identityProviderNameList, sharedSecret, returnUrl, SPIBindingName, applicationAttributesList, userAttributeMappings, attributeList, mobileApplicationReturnUrl, name, description)

表4-11 createRPApplicationの引数

引数

定義

identityProviderNameList

アイデンティティ・プロバイダのリスト

sharedSecret

共有シークレット。

returnUrl

戻りURL。

SPIBindingName

SPIバインディング名。

applicationAttributesList

JSON形式で指定されるRPApplication属性のリスト。

[{name1:value1},{name2:value2}]

userAttributeMappings

JSON形式で指定されたユーザー属性マッピングのリスト。

[{idp:[{name:value},{name:value}],idp2:[{name:value},{name:value}]}]

attributeList

JSON形式で指定されるプロトコル属性のリスト。

[{name1:value1},{name2:value2}]

mobileApplicationReturnUrl

モバイル・アプリケーションの戻りURL。

name

作成するオブジェクトの名前。

description

作成するオブジェクトの説明。

例

createRPApplication('Yahoo,Facebook','mySecret','http://me.com',
'OAMServiceProviderInterface','[{pratname1:atval1},{pratname2:atval2}]',
'[{Yahoo:[{uid:email},{mail:email},{zip:postalCode},{country:country}]},
{Facebook:[{uid:email},{mail:email},{zip:postalCode},{country:country}]}]',
'[{atname1:atval2},{atname2:atval2}]','/oam/server','myApp','new Application')

updateRPApplication

updateRPApplication

説明

RPApplicationオブジェクトの特定の値を更新します。

構文

updateRPApplication(identityProviderNameList, sharedSecret, returnUrl, SPIBindingName, applicationAttributesList, userAttributeMappings, attributeList, mobileApplicationReturnUrl, name, description)

表4-12 updateRPApplicationの引数

引数

定義

identityProviderNameList

アイデンティティ・プロバイダのリスト

sharedSecret

共有シークレット。

returnUrl

戻りURL。

SPIBindingName

SPIバインディング名。

applicationAttributesList

JSON形式で指定されるRPApplication属性のリスト。

[{name1:value1},{name2:value2}]

userAttributeMappings

JSON形式で指定されたユーザー属性マッピングのリスト。

[{idp:[{name:value},{name:value}],idp2:[{name:value},{name:value}]}]

attributeList

JSON形式で指定されるプロトコル属性のリスト。

[{name1:value1},{name2:value2}]

mobileApplicationReturnUrl

モバイル・アプリケーションの戻りURL。

name

作成するオブジェクトの名前。

description

作成するオブジェクトの説明。

例

updateRPApplication('Facebook,Google','mySecret','http://me.com',
'OAMServiceProviderInterface','[{pratname1:atval1},{pratname2:atval2}]',
'userMap1,userMap2','[{atname1:atval2},{atname2:atval2}]','/oam/server','myApp',
'new Application')

getServiceProviderInterfaces

getServiceProviderInterfaces

説明

サービス・プロバイダ・インタフェース・オブジェクトを取得します。

構文

getServiceProviderInterfaces( )

このコマンドには、引数はありません。

例

getServiceProviderInterfaces( )

removeServiceProviderInterface

removeServiceProviderInterface

説明

指定されたサービス・プロバイダ・インタフェース・オブジェクトを削除します。

構文

removeServiceProviderInterface(name)

ここで、nameは、サービス・プロバイダ・インタフェース・オブジェクトの名前です。

例

removeServiceProviderInterface('TestApp')

displayServiceProviderInterface

displayServiceProviderInterface

説明

指定されたサービス・プロバイダ・インタフェース・オブジェクトを表示します。

構文

displayServiceProviderInterface(name)

ここで、nameは、サービス・プロバイダ・インタフェース・オブジェクトの名前です。

例

displayServiceProviderInterface('TestApp')

createServiceProviderInterface

createServiceProviderInterface

説明

新しいサービス・プロバイダ・インタフェース・オブジェクトを作成します。

構文

createServiceProviderInterface(idpSelectorImpl, postIDPSelectorImpl, idpInteractionProviderImpl, registrationStatusCheckImpl, registrationTaskFlowProviderImpl, sessionCreationProviderImpl, attributeList, name, description)

表4-13 createServiceProviderInterfaceの引数

引数

定義

idpSelectorImpl

postIDPSelectorImpl

idpInteractionProviderImpl

registrationStatusCheckImpl

registrationTaskFlowProviderImpl

sessionCreationProviderImpl

attributeList

JSON形式の属性のリスト。

[{idp:[{name:value},{name:value}],idp2:[{name:value},{name:value}]}]

name

作成するオブジェクトの名前。

description

作成するオブジェクトの説明。

例

createServiceProviderInterface('idp','postIDP','idpInteraction','regStatus',
'regTask','sessionPro','[{pratname1:atval1},{pratname2:atval2}]','mySPIBind',
'new SPI Binding')

updateServiceProviderInterface

updateServiceProviderInterface

説明

サービス・プロバイダ・インタフェース・オブジェクトの特定の値を更新します。

構文

updateServiceProviderInterface(idpSelectorImpl, postIDPSelectorImpl, idpInteractionProviderImpl, registrationStatusCheckImpl, registrationTaskFlowProviderImpl, sessionCreationProviderImpl, attributeList, name, description)

表4-14 updateServiceProviderInterfaceの引数

引数

定義

idpSelectorImpl

postIDPSelectorImpl

idpInteractionProviderImpl

registrationStatusCheckImpl

registrationTaskFlowProviderImpl

sessionCreationProviderImpl

attributeList

JSON形式の属性のリスト。

[{idp:[{name:value},{name:value}],idp2:[{name:value},{name:value}]}]

name

作成するオブジェクトの名前。

description

作成するオブジェクトの説明。

例

updateServiceProviderInterface('idp','postIDP','idpInteraction','regStatus',
'regTask','sessionPro','[{pratname1:atval1},{pratname2:atval2}]','mySPIBind',
'new SPI Binding')

getInternetIdentityProviders

getInternetIdentityProviders

説明

ソーシャル・アイデンティティ・プロバイダ・オブジェクトを取得します。

構文

getInternetIdentityProviders( )

このコマンドには、引数はありません。

例

getInternetIdentityProviders( )

removeInternetIdentityProvider

removeInternetIdentityProvider

説明

指定されたソーシャル・アイデンティティ・プロバイダ・オブジェクトを削除します。

構文

removeInternetIdentityProvider(name)

ここで、nameは、ソーシャル・アイデンティティ・プロバイダ・オブジェクトの名前です。

例

removeInternetIdentityProvider('TestApp')

displayInternetIdentityProvider

displayInternetIdentityProvider

説明

指定されたソーシャル・アイデンティティ・プロバイダ・オブジェクトを表示します。

構文

displayInternetIdentityProvider(name)

ここで、nameは、ソーシャル・アイデンティティ・プロバイダ・オブジェクトの名前です。

例

displayInternetIdentityProvider('TestApp')

createInternetIdentityProvider

createInternetIdentityProvider

説明

新しいソーシャル・アイデンティティ・プロバイダ・オブジェクトを作成します。

構文

createInternetIdentityProvider(icon, protocolType, protocolAttributeList, providerImplClass, attributeList, name, description)

表4-15 createInternetIdentityProviderの引数

引数

定義

icon

アイコンの名前。

protocolType

プロトコルのタイプはOpenID、OAuthまたはCustomのいずれかになります。

protocolAttributeList

JSON形式で指定されるプロトコル属性のリスト。

[{name1:value1},{name2:value2}]

providerImplClass

プロバイダの実装クラス。

attributeList

JSON形式で指定されるプロトコル属性のリスト。

[{name1:value1},{name2:value2}]

name

作成するプロバイダの名前。

description

作成するプロバイダの説明。

例

createInternetIdentityProvider('myIcon','myType','[{pratname1:atval1},
{pratname2:atval2}]','[{atname1:atval1},{atname2:atval2}]','class','myProvider',
'new Identity Provider')

注意:

createInternetIdentityProviderをスクリプトの中で使用してFoursquareおよびWindows Liveのプロバイダ構成を作成することもできます。次は、Foursquare用のスクリプトの例です。スクリプトを実行する前に、WebLogic Serverに接続するために使用するusernameとpassword、そしてコンシューマのキーとシークレット値(引用符で囲む)を更新してください:

url = 't3://localhost:7001'
username='xxxxxx'
password='xxxxxx'
connect(username,password,url)
domainRuntime()

print "Foursquare        OAuth"
print "---------------------"
createInternetIdentityProvider(
'Foursquare.gif',
'OAuth',
'[{oauth.authorization.url:
"https://foursquare.com/oauth2/authorize"},
{oauth.accesstoken.url:
"https://foursquare.com/oauth2/access_token"},
{oauth.profile.url: "https://api.foursquare.com/v2/users/self"},
{oauth.consumer.key:""}, {oauth.consumer.secret:""},
{oauth.rpinstance.name:""}, {oauth.rpinstance.url:""}]',
'[{id:id}, {firstname:firstname}, {lastname:lastname},
{contact.email:contact.email}, {homecity:homecity},
{gender:gender}, {photo:photo}]',
'oracle.security.idaas.rp.oauth.provider.FoursquareImpl',
'Foursquare', 'Foursquare OAuth Provider')

disconnect()
exit()

updateInternetIdentityProvider

updateInternetIdentityProvider

説明

ソーシャル・アイデンティティ・プロバイダ・オブジェクトの特定の値を更新します。

構文

updateInternetIdentityProvider(icon, protocolType, protocolAttributeList, attributeList, providerImplClass, name, description)

表4-16 updateInternetIdentityProviderの引数

引数

定義

icon

アイコンの名前。

protocolType

プロトコルのタイプはOpenID、OAuthまたはCustomのいずれかになります。

protocolAttributeList

JSON形式で指定されるプロトコル属性のリスト。

[{name1:value1},{name2:value2}]

providerImplClass

プロバイダの実装クラス。

attributeList

JSON形式で指定されるプロトコル属性のリスト。

[{name1:value1},{name2:value2}]

name

更新するプロバイダの名前。

description

更新するプロバイダの説明。

例

updateInternetIdentityProvider('myIcon','myType','[{pratname1:atval1},{pratname2:atval2}]','[{atname1:atval1},{atname2:atval2}]','class','myProvider','new Identity Provider')

getUserAttributeMappings

getUserAttributeMappings

説明

ユーザー属性マッピング・オブジェクトを取得します。

構文

getUserAttributeMappings( )

このコマンドには、引数はありません。

例

getUserAttributeMappings( )

removeUserAttributeMapping

removeUserAttributeMapping

説明

指定されたユーザー属性マッピング・オブジェクトを削除します。

構文

removeUserAttributeMapping(name)

ここで、nameは、ユーザー属性マッピング・オブジェクトの名前です。

例

removeUserAttributeMapping('TestApp')

displayUserAttributeMapping

displayUserAttributeMapping

説明

指定されたユーザー属性マッピング・オブジェクトを表示します。

構文

displayUserAttributeMapping(name)

ここで、nameは、ユーザー属性マッピング・オブジェクトの名前です。

例

displayUserAttributeMapping('TestApp')

updateUserAttributeMapping

updateUserAttributeMapping

説明

ユーザー属性・マッピング・オブジェクトの特定の値を更新します。

構文

updateUserAttributeMapping(application, idp, name, appProtocolAttributeList)

表4-17 updateUserAttributeMappingの引数

引数

定義

application

アプリケーション名。

idp

アイデンティティ・プロバイダの名前。

name

作成するオブジェクトの名前。

appProtocolAttributeList

JSON形式のプロトコル属性のリスト。

[{idp:[{name:value},{name:value}],idp2:[{name:value},{name:value}]}]

例

updateUserAttributeMapping('myApp','myProvider','myMap','[{pratname1:atval1},{pratname2:atval2}]')

createServiceProvider

createServiceProvider

説明

サービス・プロバイダを作成します。

構文

createServiceProvider(serviceProviderImpl, serviceProviderType, relationshipList, paramList, name, description)

表4-18 createServiceProviderの引数

引数

定義

serviceProviderImpl

サービス・プロバイダの実装。

serviceProviderType

サービス・プロバイダのタイプ。許容可能な値は、Authorization、AuthenticationまたはUserProfileのいずれかです。

relationshipList

JSON形式で指定されたこのサービス・プロバイダの関係: [{relationship:relname,description:descrip,directional1:{name:dirname,description:descrip,providerRelation:relname,entityURIAttrName:uri,scopeAllLevelAttrName:toTop},directional2:{name:dirname,description:descrip,providerRelation:relname,entityURIAttrName:uri,scopeAllLevelAttrName:toTop}}]

paramList

JSON形式で指定されたこのサービス・プロバイダのパラメータ: [{name1:value1},{name2:value2}...]

name

サービス・プロバイダの名前。

description

サービス・プロバイダの説明。

例

createServiceProvider('oracle.security.idaas.rest.provider.token.MobileOAMTokenSer
viceProvider', 'Authentication', '[]','[{OAM_VERSION:OAM_11G},{WEBGATE_
ID:accessgate-oic},{ENCRYPTED_PASSWORD:"password"},{DEBUG_VALUE:0},{TRANSPORT_
SECURITY:OPEN},{OAM_SERVER_1:"localhost:5575"},{OAM_SERVER_1_MAX_CONN:4},{OAM_
SERVER_2:"oam_server_2:5575"},{OAM_SERVER_2_MAX_CONN:4}]',
'MobileOAMAuthentication', 'Out Of The Box Mobile Oracle Access Manager (OAM)
Authentication Service Provider')

updateServiceProvider

updateServiceProvider

説明

サービス・プロバイダを更新します。

構文

updateServiceProvider(serviceProviderImpl, serviceProviderType, relationshipList, paramList, name, description)

表4-19 updateServiceProviderの引数

引数

定義

serviceProviderImpl

サービス・プロバイダの実装

serviceProviderType

サービス・プロバイダのタイプ - Authorization、Authentication、UserProfileのいずれか。

relationshipList

JSON形式で指定されたこのサービス・プロバイダの関係。

[{relationship:relname,description:descrip,
directional1:{name:dirname,description:descrip,provider
Relation:relname,entityURIAttrName:uri,scopeAllLevelAtt
rName:toTop},directional2:{name:dirname,description:des
crip,providerRelation:relname,entityURIAttrName:uri,sco
peAllLevelAttrName:toTop}}]

paramList

JSON形式で指定されたこのサービス・プロバイダのパラメータ。

[{name1:value1},{name2:value2}...]

name

サービス・プロバイダの名前。

description

サービス・プロバイダの説明。

例

updateServiceProvider('oracle.security.idaas.rest.provider.cruds.ids.
IDSCRUDSServiceProvider', 'UserProfile', '[{relationship:people_groups,
directional1:{name:memberOf, providerRelation:user_memberOfGroup,
entityURIAttrName:person-uri}, directional2:{name:members,
providerRelation:groupMember_user,entityURIAttrName:group-uri }},
{relationship:people_manager, directional1:{name:manager,providerRelation:manager,
entityURIAttrName:report-uri,scopeAllLevelAttrName:toTop},
directional2:{name:reports , providerRelation:reportee,
qntityURIAttrName:manager-uri, scopeAllLevelAttrName:all}},
{relationship:groupMemberOf_groupMembers , directional1:{name:groupMemberOf,
providerRelation:group_memberOfGroup,entityURIAttrName:member-uri},
directional2:{name:groupMembers, providerRelation:groupMember
_group,entityURIAttrName:group-uri }},{relationship:personOwner_ownerOf,
directional1:{name:ownerOf, providerRelation:user_
ownerOfGroup,entityURIAttrName:owner-uri},
directional2:{name:personOwner,providerRelation:groupOwner_
user,entityURIAttrName:group-uri}},{relationship:groupOwner_groupOwnerOf,
directional1:{name:groupOwner, providerRelation:group_
ownerOfGroup,entityURIAttrName:group-uri}, directional2:{name:groupOwnerOf,
providerRelation:groupOwner_group,entityURIAttrName:owner-uri
}}]','[{oracle.ids.name:userrole},{accessControl:false}]', 'UserProfile', 'Out Of
The Box User Profile Service Provider')

addRelationshipToServiceProvider

addRelationshipToServiceProvider

説明

サービス・プロバイダに関係を追加します。

構文

addRelationshipToServiceProvider(name, relationshipList)

表4-20 addRelationshipToServiceProviderの引数

引数

定義

name

サービス・プロバイダの名前。

relationshipList

JSON形式で指定されたこのサービス・プロバイダの関係。

[{relationship:relname,description:descrip,directional1:
{name:dirname,description:descrip,providerRelation:relname,
entityURIAttrName:uri,scopeAllLevelAttrName:toTop},
directional2:{name:dirname,description:descrip,
providerRelation:relname,entityURIAttrName:uri,
scopeAllLevelAttrName:toTop}}]

例

addRelationshipToServiceProvider('idsprovider1','[{relationship:relname,
description:descrip, directional1:{name:dirname,description:descrip,
providerRelation:relname,entityURIAttrName:uri,scopeAllLevelAttrName:toTop},
directional2:{name:dirname,description:descrip,
providerRelation:relname,entityURIAttrName:uri,scopeAllLevelAttrName:toTop}}]

removeRelationshipFromServiceProvider

removeRelationshipFromServiceProvider

説明

サービス・プロバイダから関係を削除します。

構文

removeRelationshipFromServiceProvider

表4-21 removeRelationshipFromServiceProviderの引数

引数

定義

name

サービス・ドメインの名前。

relationshipList

このサービス・プロバイダの関係名。

例

removeRelationshipFromServiceProvider('idsprovider1','relname')

getServiceProviders

getServiceProviders

説明

サービス・プロバイダを取得します。

構文

getServiceProviders()

このコマンドには、引数はありません。

例

getServiceProviders()

次に、サンプル出力を示します。

ServiceProvider: UserProfile1
ServiceProvider: JWTAuthentication
ServiceProvider: UserProfile
ServiceProvider: MobileOAMAuthentication
ServiceProvider: OAMAuthentication
ServiceProvider: MobileJWTAuthentication
ServiceProvider: sampleauthzserviceprovider
ServiceProvider: InternetIdentityAuthentication
ServiceProvider: OAMAuthorization

removeServiceProvider

removeServiceProvider

説明

このコマンドは、ServiceProviderオブジェクトを削除します。

構文

removeServiceProvider(name)

ここで、nameは、ServiceProviderオブジェクトの名前です。

例

removeServiceProvider('name')

displayServiceProvider

displayServiceProvider

説明

このコマンドは、ServiceProviderオブジェクトを表示します。

構文

displayServiceProvider(name)

ここで、nameは、ServiceProviderオブジェクトの名前です。

例

displayServiceProvider('OAMAuthentication')

次に、サンプル出力を示します。

Displaying: ServiceProvider : OAMAuthentication
ReadOnly = 0
Description = Out Of The Box Oracle Access Manager (OAM) Authentication Token Service Provider
Param = ...
eventProvider = 1
objectName = com.oracle.idaas:name=OAMAuthentication,type=Xml.ServiceProvider,Xml=MobileService
SystemMBean = 0
ServiceProviderType = Authentication
Name = OAMAuthentication
ConfigMBean = 1
ServiceProviderImpl =
oracle.security.idaas.rest.provider.token.OAMSDKTokenServiceProvider
Relationship = array(javax.management.openmbean.CompositeData,[])
eventTypes = array(java.lang.String,['jmx.attribute.change'])
RestartNeeded = 0

createServiceProfile

createServiceProfile

説明

サービスを作成します。

構文

createServiceProfile(serviceProvider, supportedTokenList, paramList, endPoint, name, description, enabled)

表4-22 createServiceProfileの引数

引数

定義

serviceProvider

サービス・プロバイダの名前。

supportedTokenList

JSON形式で指定されたサポート対象トークンのリスト。

{type,...}

ここで、typeは、CLIENTTOKEN、USERTOKEN、ACCESSTOKENまたはCLIENTREGHANDLEとして定義されます。

paramList

JSON形式で指定されたこのサービスのパラメータのリスト。

[{name1:value1},{name2:value2}...]

endPoint

サービス・エンドポイント。

name

サービスの名前。

description

サービスの説明。

enabled

サービスを有効にするか、無効にするかを示します。ブール・フラグ。

例

createServiceProfile('OAMAuthentication','CLIENTTOKEN,ACCESSTOKEN,USERTOKEN','[]',
'/oamauthentication','OAMAuthentication','Out Of The Box Oracle Access Manager
(OAM) Authentication Token Service',true)

updateServiceProfile

updateServiceProfile

説明

サービスを更新します。

構文

updateServiceProfile(serviceProvider, supportedTokenList, paramList, endPoint, name, description, enabled)

表4-23 updateServiceProfileの引数

引数

定義

serviceProvider

サービス・プロバイダの名前。

supportedTokenList

JSON形式で指定されたサポート対象トークンのリスト。

{type,...}

ここで、typeは、CLIENTTOKEN、USERTOKEN、ACCESSTOKENまたはCLIENTREGHANDLEとして定義されます。

paramList

JSON形式で指定されたこのサービスのパラメータのリスト。

[{name1:value1},{name2:value2}...]

endPoint

サービス・エンドポイント。

name

サービスの名前。

description

サービスの説明。

enabled

サービスを有効にするか、無効にするかを示します。ブール・フラグ。

例

updateServiceProfile('MobileJWTAuthentication','CLIENTREGHANDLE,
ACCESSTOKEN,USERTOKEN','[]','/mobilejwtauthentication','MobileJWTAuthentication',
'Out Of The Box Mobile Java Web Token (JWT) Authentication Service Provider',true)

removeServiceProfile

removeServiceProfile

説明

このコマンドは、サービス・オブジェクトを削除します。

構文

removeServiceProfile(name)

ここで、nameは、削除するサービスの名前です。

例

removeServiceProfile('myService')

displayServiceProfile

displayServiceProfile

説明

このコマンドは、サービス・オブジェクトを表示します。

構文

displayServiceProfile(name)

ここで、nameは、表示するサービス・プロファイルの名前です。

例

displayServiceProfile('OAMAuthorization')

次に、サンプル出力を示します。

Displaying: ServiceProfile : OAMAuthorization
ReadOnly = 0
Enabled = 1
Description = Out Of The Box Oracle Access Manager (OAM) Authorization Service Provider
Param = array(javax.management.openmbean.CompositeData,[])
eventProvider = 1
SystemMBean = 0
objectName =
com.oracle.idaas:name=OAMAuthorization,type=Xml.ServiceProfile,Xml=MobileService
SupportedToken = array(java.lang.String,[])
ServiceProviderType = Authorization
ServiceProviderName = OAMAuthorization
Name = OAMAuthorization
ConfigMBean = 1
ServiceEndPoint = /oamauthorization
eventTypes = array(java.lang.String,['jmx.attribute.change'])
RestartNeeded = 0

getServiceProfiles

getServiceProfiles

説明

すべてのサービス・オブジェクトを取得します。

構文

getServiceProfiles()

このコマンドには、引数はありません。

例

getServiceProfiles()

次に、サンプル出力を示します。

ServiceProfile: UserProfile1
ServiceProfile: OAMAuthenticatio
ServiceProfile: sampleauthzservice
ServiceProfile: JWTAuthentication
ServiceProfile: UserProfile
ServiceProfile: MobileOAMAuthentication
ServiceProfile: OAMAuthentication
ServiceProfile: MobileJWTAuthentication
ServiceProfile: InternetIdentityAuthentication
ServiceProfile: OAMAuthorization
ServiceProfile: JWTAuthentication1

getApplicationProfiles

getApplicationProfiles

説明

ApplicationProfileオブジェクトを一覧表示します。

構文

getApplicationProfiles()

このコマンドには、引数はありません。

例

getApplicationProfiles()

次に、サンプル出力を示します。

Contract: MobileExpenseReport1
Contract: MobileAgent2
Contract: MobileBusinessTestApp01
Contract: MobileAgent1
Contract: profileid1
Contract: samplemobileapp2
Contract: profileid2
Contract: samplemobileapp1

createApplicationProfile

createApplicationProfile

説明

ApplicationProfileを作成します。

構文

createApplicationProfile(paramList, mobileAppProfileStr, name, description)

表4-24 createApplicationProfileの引数

引数

定義

paramList

JSON形式で指定されたこのサービスのパラメータのリスト。

[{name1:value1},{name2:value2}...]

mobileAppProfileStr

JSON形式で指定されたモバイル・アプリケーション・プロファイル文字列。

[{clientAppConfigParam:[{name:value},{name:value}],
jailBreakingDetectionPolicyName:name}]

name

IDaaSクライアントの名前。

description

IDaaSクライアントの説明。

例

createApplicationProfile('[{Mobile.clientRegHandle.baseSecret:welcome1},]',
'[{clientAppConfigParam:[{Mobileparam1:Mobileparam1Value},
{IOSURLScheme:"samplemobileapp1://"},
{AndroidPackage:oracle.android.samplemobileapp1},
{AndroidAppSignature:samplemobileapp1signature}],
jailBreakingDetectionPolicyName:defaultJailBreakingDetectionPolicy}]',
'samplemobileapp1','Sample Mobile App 1')

createApplicationProfile('[{userId4BasicAuth:rest_client1},
{sharedSecret4BasicAuth:"9Qo9olLIl5gDwESYR0hOgw=="},
{signatureAlgorithm:SHA-1}]','','profileid1','OIC Application Profile 1')

updateApplicationProfile

updateApplicationProfile

説明

ApplicationProfileを更新します。

構文

updateApplicationProfile(paramList, mobileAppProfileStr, name, description)

表4-25 updateApplicationProfileの引数

引数

定義

paramList

JSON形式で指定されたこのサービスのパラメータのリスト。

[{name1:value1},{name2:value2}...]

mobileAppProfileStr

JSON形式で指定されたモバイル・アプリケーション・プロファイル文字列。

[{clientAppConfigParam:[{name:value},{name:value}],
jailBreakingDetectionPolicyName:name}]

clientAppConfigParamの値は、管理コンソールの「アプリケーション・プロファイル構成」ページで定義されているものと一致している必要があります。「構成設定」という見出しの下に指定されている項目は、WLST 'clientAppConfigParam'で設定されます。

name

IDaaS (Identity as a Service)クライアントの名前。

description

IDaaS (Identity as a Service)クライアントの説明。

例

updateApplicationProfile('[{Mobile.clientRegHandle.baseSecret:welcome1}]','
[{clientAppConfigParam:[{ProfileCacheDuration:60},
{AuthenticationRetryCount:3},{AllowOfflineAuthentication:false},
{ClaimAttributes:"oracle:idm:claims:client:geolocation,
oracle:idm:claims:client:imei,oracle:idm:claims:client:jailbroken,
oracle:idm:claims:client:locale,oracle:idm:claims:client:macaddress,
oracle:idm:claims:client:networktype,oracle:idm:claims:client:ostype,
oracle:idm:claims:client:osversion,oracle:idm:claims:client:phonecarriername,
oracle:idm:claims:client:phonenumber,oracle:idm:claims:client:sdkversion,
oracle:idm:claims:client:udid,oracle:idm:claims:client:vpnenabled"},
{RPWebView:Embedded},{URLScheme:"exp://"},
{IOSBundleID:com.oraclecorp.internal.ExpenseReportApp},
{AndroidAppSignature:"xmlns:xsi=\
'http://www.w3.org/2001/XMLSchema-instance\'
xsi:nil=\'true\'"},{AndroidPackage:"xmlns:xsi=\'
http://www.w3.org/2001/XMLSchema-instance\' xsi:nil=\'true\'"}],
jailBreakingDetectionPolicyName:DefaultJailBreakingDetectionPolicy}]',
'ExpenseApp','OIC Test Expense Sample App')

removeApplicationProfile

removeApplicationProfile

説明

このコマンドは、ApplicationProfileを削除します。

構文

removeApplicationProfile(name)

ここで、nameは、削除するApplicationProfileの名前です。

例

removeApplicationProfile('name')

displayApplicationProfile

displayApplicationProfile

説明

このコマンドは、指定されたApplicationProfileを表示します。

構文

dislayApplicationProfile(name)

ここで、nameは、削除するApplicationProfileの名前です。

例

displayApplicationProfile('MobileAgent1')

次に、サンプル出力を示します。

Displaying: ApplicationProfile : MobileAgent1
ReadOnly = 0
ConfigMBean = 1
Name = MobileAgent1
MobileAppProfile = None
Description = Mobile Agent App 1
Param =
array(javax.management.openmbean.CompositeData,[javax.management.openmbean.Composi
teDataSupport(compositeType=javax.management.openmbean.CompositeType(name=com.orac
le.xmlns.idm.idaas.idaas_config_11_1_2_0_0.Attribute,items=((itemName=name,
itemType=javax.management.openmbean.SimpleType(name=java.lang.String)),
(itemName=secretValue,itemType=javax.management.openmbean.ArrayType(name=[Ljava.
lang.Character;,dimension=1,elementType=javax.management.openmbean.SimpleType(name
=java.lang.Character),primitiveArray=false)),(itemName=value,itemType=javax.manage
ment.openmbean.SimpleType(name=java.lang.String)))),contents={name=Mobile.reauthnF
orRegNewClientApp, secretValue=null, value=true}),
javax.management.openmbean.CompositeDataSupport(compositeType=javax.management.ope
nmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.idaas_config_11_1_2_0_0.
Attribute,items=((itemName=name,itemType=javax.management.openmbean.SimpleType(nam
e=java.lang.String)),(itemName=secretValue,itemType=javax.management.openmbean.Arr
ayType(name=[Ljava.lang.Character;,dimension=1,elementType=javax.management.openmb
ean.SimpleType(name=java.lang.Character),primitiveArray=false)),(itemName=value,it
emType=javax.management.openmbean.SimpleType(name=java.lang.String)))),contents={n
ame=Mobile.clientRegHandle.baseSecret, secretValue=[Ljava.lang.Character;@11910bd,
value=idaas.ApplicationProfile[MobileAgent1].param[Mobile.clientRegHandle.baseSecr
et]})])
eventProvider = 1
SystemMBean = 0
objectName =
com.oracle.idaas:name=MobileAgent1,type=Xml.ApplicationProfile,Xml=MobileService
eventTypes = array(java.lang.String,['jmx.attribute.change'])
RestartNeeded = 0

createServiceDomain

createServiceDomain

説明

ServiceDomainを作成します。

構文

createServiceDomain(securityHandlerPlugin,serviceBindingList,
clientAppBindingList,mobileAuthStyle,serviceDomainType,name,description)

表4-26 createServiceDomainの引数

引数

定義

securityHandlerPlugin

securityHandlerPluginの名前。

serviceBindingList

ServiceBindingオブジェクトのリスト。形式は次のとおりです:

[{serviceName:UserProfile,allowRead:true,
allowWrite:true},{serviceName:UserProfile1,
allowRead:true,allowWrite:true,
requiredToken:[{tokenService:JWTAuthentication,
tokenType:{ACCESSTOKEN}}]},
{serviceName:usertokenserviceformobile,
requiredToken:[{tokenService:mobilesecurityservice1,
tokenType:{ACCESSTOKEN,CLIENTTOKEN}}]},
{serviceName:mobilesecurityservice1},
{serviceName:JWTAuthentication1},
{serviceName:OAMAuthorization}]

clientAppBindingList

次の形式で指定されたクライアント・アプリケーションのリスト。

[{appName:UserProfile,mobileBinding:
[{SSOinclusion:true,SSOpriority:4}]

mobileAuthStyle

モバイル認証スタイル。

serviceDomainType

サービス・ドメインのタイプ。

name

ServiceDomainの名前。

description

ServiceDomainの説明。

例

createServiceDomain('JunitDebugSecurityHandlerPlugin','[{serviceName:UserProfile,
allowRead:true,allowWrite:true},{serviceName:UserProfile1,allowRead:true,
allowWrite:true,requiredToken:[{tokenService:JWTAuthentication1,
tokenType:ACCESSTOKEN}]},{serviceName:JWTAuthentication},
{serviceName:OAMAuthentication},{serviceName:JWTAuthentication1},
{serviceName:OAMAuthorization,
allowRead:true,allowWrite:false,requiredToken:[{tokenService:OAMAuthentication,
tokenType:USERTOKEN}]}]','[{appName:MobileAgent1,mobileBinding:
[{SSOinclusion:true,SSOpriority:1}]},{appName:MobileBusinessTestApp01,
mobileBinding:[{SSOinclusion:true}]},{appName:MobileAgent2,mobileBinding:
[{SSOinclusion:true,SSOpriority:2}]},{appName:MobileExpenseReport1,
mobileBinding:[{SSOinclusion:false}]},{appName:profileid1}]','','DESKTOP',
'Default','DefaultService Domain ServiceBinding without any requiredToken')

updateServiceDomain

updateServiceDomain

説明

ServiceDomainを更新します。

構文

updateServiceDomain(securityHandlerPlugin, serviceBindingList, clientAppBindingList, mobileAuthStyle, serviceDomainType, name, description)

表4-27 createServiceDomainの引数

引数

定義

securityHandlerPlugin

SecurityHandlerPluginの名前。

serviceBindingList

ServiceBindingオブジェクトのリスト。形式は次のとおりです:

[{serviceName:UserProfile,allowRead:true,
allowWrite:true},{serviceName:UserProfile1,
allowRead:true,allowWrite:true,
requiredToken:[{tokenService:JWTAuthentication,
tokenType:{ACCESSTOKEN}}]},
{serviceName:usertokenserviceformobile,
requiredToken:[{tokenService:mobilesecurityservice1,
tokenType:{ACCESSTOKEN,CLIENTTOKEN}}]},
{serviceName:mobilesecurityservice1},
{serviceName:JWTAuthentication1},
{serviceName:OAMAuthorization}]

clientAppBindingList

次の形式で指定されたクライアント・アプリケーションのリスト。

[{appName:UserProfile,mobileBinding:
[{SSOinclusion:true,SSOpriority:4}]

mobileAuthStyle

モバイル認証スタイル。

serviceDomainType

サービス・ドメインのタイプ。

name

ServiceDomainの名前。

description

ServiceDomainの説明。

例

updateServiceDomain('JunitDebugSecurityHandlerPlugin','[{serviceName:UserProfile,
allowRead:true,allowWrite:true},{serviceName:UserProfile1,allowRead:true,
allowWrite:true,requiredToken:[{tokenService:JWTAuthentication1,
tokenType:ACCESSTOKEN}]},{serviceName:JWTAuthentication},
{serviceName:OAMAuthentication},{serviceName:JWTAuthentication1},
{serviceName:OAMAuthorization,allowRead:true,allowWrite:false,
requiredToken:[{tokenService:OAMAuthentication,tokenType:USERTOKEN}]}]',
'[{appName:MobileAgent1,mobileBinding:[{SSOinclusion:true,SSOpriority:1}]},
{appName:MobileBusinessTestApp01,mobileBinding:[{SSOinclusion:true}]},
{appName:MobileAgent2,mobileBinding:[{SSOinclusion:true,SSOpriority:2}]},
{appName:MobileExpenseReport1,mobileBinding:[{SSOinclusion:false}]},
{appName:profileid1}]','','DESKTOP','Default',
'Default Service Domain ServiceBinding without any requiredToken')

getServiceDomains

getServiceDomains

説明

ServiceDomainを取得します。

構文

getServiceDomains()

このコマンドには、引数はありません。

例

getServiceDomain()

次に、サンプル出力を示します。

ServiceDomain: MobileServiceDomainUTReg
ServiceDomain: MobileRPServiceDomain
ServiceDomain: Contract1
ServiceDomain: MobileJWTServiceDomain
ServiceDomain: MobileRPServiceDomainUTReg
ServiceDomain: MobileContract
ServiceDomain: Default
ServiceDomain: MobileServiceDomain

removeServiceDomain

removeServiceDomain

説明

ServiceDomainを削除します。

構文

removeServiceDomain(name)

ここで、nameは、削除するServiceDomainの名前です。

例

removeServiceDomain('name')

displayServiceDomain

displayServiceDomain

説明

ServiceDomainを表示します。

構文

displayServiceDomain(name)

例

displayServiceDomain('name')

次に、サンプル出力を示します。

Displaying: ServiceDomain : Contract1
ReadOnly = 0
Description = Service Domain 1 using HTTPBasic or Token based Client Token
eventProvider = 1
SystemMBean = 0
objectName =
com.oracle.idaas:name=Contract1,type=Xml.ServiceDomain,Xml=MobileService
MobileAuthStyle = None
ServiceBinding =
array(javax.management.openmbean.CompositeData,[javax.management.openmbean.
CompositeDataSupport(compositeType=javax.management.openmbean.CompositeType(name=
com.oracle.xmlns.idm.idaas.idaas_config_11_1_2_0_0.TServiceBinding,
items=((itemName=allowRead,itemType=javax.management.openmbean.SimpleType(name=
java.lang.Boolean)),(itemName=allowWrite,itemType=javax.management.openmbean.
SimpleType(name=java.lang.Boolean)),(itemName=requiredToken,itemType=javax.managem
ent.openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.idaas_config_11_1_2_0_
0.TRequiredToken,items=((itemName=tokenService,itemType=javax.management.openmbean
.SimpleType(name=java.lang.String)),(itemName=tokenType,itemType=javax.management.
openmbean.ArrayType(name=[Ljava.lang.String;,dimension=1,elementType=javax.managem
ent.openmbean.SimpleType(name=java.lang.String),primitiveArray=false))))),(itemNam
e=serviceName,itemType=javax.management.openmbean.SimpleType(name=java.lang.String
)))),contents={allowRead=true, allowWrite=true,
requiredToken=javax.management.openmbean.CompositeDataSupport(compositeType=javax.
management.openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.idaas_config_
11_1_2_0_0.TRequiredToken,
items=((itemName=tokenService,itemType=javax.management.openmbean.SimpleType(name=
java.lang.String)),(itemName=tokenType,itemType=javax.management.openmbean.
ArrayType(name=[Ljava.lang.String;,dimension=1,elementType=javax.management.
openmbean.SimpleType(name=java.lang.String),primitiveArray=false)))),
contents={tokenService=JWTAuthentication, tokenType=[Ljava.lang.String;@d0fbf2}),
serviceName=UserProfile}),
javax.management.openmbean.CompositeDataSupport(compositeType=javax.management.
openmbean.CompositeType(name=
com.oracle.xmlns.idm.idaas.idaas_config_11_1_2_0_0.TServiceBinding,
items=((itemName=allowRead,itemType=javax.management.openmbean.SimpleType(name=
java.lang.Boolean)),(itemName=allowWrite,itemType=javax.management.openmbean.
SimpleType(name=java.lang.Boolean)),(itemName=requiredToken,itemType=
javax.management.openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.idaas_
config_11_1_2_0_0.TRequiredToken,
items=((itemName=tokenService,itemType=javax.management.openmbean.SimpleType(name=
java.lang.String)),(itemName=tokenType,itemType=javax.management.openmbean.
ArrayType(name=[Ljava.lang.String;,dimension=1,elementType=javax.management.
openmbean.SimpleType(name=java.lang.String),primitiveArray=false))))),
(itemName=serviceName,itemType=javax.management.openmbean.SimpleType(name=
java.lang.String)))),contents={allowRead=null, allowWrite=null,
requiredToken=null, serviceName=JWTAuthentication})])
MobileCredLevelForRegApp = None
ServiceDomainType = DESKTOP
Name = Contract1
ConfigMBean = 1
ClientAppBinding =
array(javax.management.openmbean.CompositeData,
[javax.management.openmbean.CompositeDataSupport(compositeType=javax.management.
openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.idaas_config_11_1_2_0_0
TApplicationBinding,items=((itemName=appName,itemType=javax.management.openmbean.
SimpleType(name=java.lang.String)),(itemName=mobileBinding,itemType=javax.
management.openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.
idaas_config_11_1_2_0_0.TMobileBinding,items=((itemName=SSOinclusion,
itemType=javax.management.openmbean.SimpleType(name=java.lang.Boolean)),
(itemName=SSOpriority,itemType=javax.management.openmbean.SimpleType(name=
java.lang.Short))))))),contents={appName=profileid1, mobileBinding=null}),
javax.management.openmbean.CompositeDataSupport(compositeType=javax.management.
openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.idaas_config_11_1_2_0_0
.TApplicationBinding,items=((itemName=appName,itemType=javax.management.openmbean
.SimpleType(name=java.lang.String)),(itemName=mobileBinding,itemType=javax.manage
ment.openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas
.idaas_config_11_1_2_0_0.TMobileBinding,items=
((itemName=SSOinclusion,itemType=javax.management.openmbean.SimpleType(name=
java.lang.Boolean)),(itemName=SSOpriority,itemType=javax.management.openmbean.
SimpleType(name=java.lang.Short))))))),contents={appName=profileid2,
mobileBinding=null})])SecurityHandlerPluginName = None
eventTypes = array(java.lang.String,['jmx.attribute.change'])
RestartNeeded = 0

createSecurityHandlerPlugin

createSecurityHandlerPlugin

説明

SecurityHandlerPluginを作成します。

構文

createSecurityHandlerPlugin(securityHandlerClass, paramList, name, description)

表4-28 createSecurityHandlerPluginの引数

引数

定義

securityHandlerClass

セキュリティ・ハンドラ・クラスの名前。

paramList

パラメータのリスト。

name

SecurityHandlerPluginの名前。

description

SecurityHandlerPluginの説明。

例

createSecurityHandlerPlugin(
'oracle.security.idaas.rest.provider.plugin.impl.
DefaultMobileSecurityHandlerImpl','
[{allowJailBrokenDevices:false},{requiredHardwareIds:MAC_ADDRESS},
{requiredDeviceProfileAttrs:OSType OSVersion isJailBroken clientSDKVersion}]',
'DefaultSecurityHandlerPlugin','')

updateSecurityHandlerPlugin

updateSecurityHandlerPlugin

説明

SecurityHandlerPluginを更新します。

構文

updateSecurityHandlerPlugin(securityHandlerClass, paramList, name, description)

表4-29 createSecurityHandlerPluginの引数

引数

定義

securityHandlerClass

セキュリティ・ハンドラ・クラスの名前。

paramList

パラメータのリスト。

name

SecurityHandlerPluginの名前。

description

SecurityHandlerPluginの説明。

例

updateSecurityHandlerPlugin('oracle.security.idaas.rest.provider.plugin.impl.DefaultMobileSecurityHandlerImpl','[{allowJailBrokenDevices:false},{requiredHardwareIds:MAC_ADDRESS},{requiredDeviceProfileAttrs:OSType OSVersion isJailBroken clientSDKVersion}]','DefaultSecurityHandlerPlugin','')

getSecurityHandlerPlugins

getSecurityHandlerPlugins

説明

SecurityHandlerPluginを取得します。

構文

getSecurityHandlerPlugins()

このコマンドには、引数はありません。

例

getSecurityHandlerPlugins()

次に、サンプル出力を示します。

SecurityHandlerPlugin: JunitDebugSecurityHandlerPluginSecurityHandlerPlugin: OaamSecurityHandlerPluginSecurityHandlerPlugin: DefaultSecurityHandlerPlugin

removeSecurityHandlerPlugin

removeSecurityHandlerPlugin

説明

SecurityHandlerPluginを削除します。

構文

removeSecurityHandlerPlugin(name)

ここで、nameは、削除するSecurityHandlerPluginの名前です。

例

removeSecurityHandlerPlugin('name')

displaySecurityHandlerPlugin

displaySecurityHandlerPlugin

説明

SecurityHandlerPluginを表示します。

構文

displaySecrityHandlerPlugin(name)

ここで、nameは、表示するSecurityHandlerPluginの名前です。

例

displaySecurityHandlerPlugin('name')

createJailBreakingDetectionPolicy

createJailBreakingDetectionPolicy

説明

JailBreakingDetectionPolicyを作成します。

構文

createJailBreakingDetectionPolicy(enabled, statementList, name)

表4-30 createJailBreakingDetectionPolicyの引数

引数

定義

enabled

有効にします。

statementList

パラメータのリスト。

name

JailBreakingDetectionPolicyの名前。

例

createJailBreakingDetectionPolicy(true,
'[{minOSVersion:3.5,maxOSVersion:5.0,minClientSDKVersion:1.0,
maxClientSDKVersion:1.0,policyExpirationDurationInSec:3600,
autoCheckPeriodInMin:60,
detectionLocation:[{filePath:"/root",success:true,action:exists},
{filePath:"/opt",success:true,action:exists}]}]',
'defaultJailBreakingDetectionPolicy')

updateJailBreakingDetectionPolicy

updateJailBreakingDetectionPolicy

説明

JailBreakingDetectionPolicyを更新します。

構文

updateJailBreakingDetectionPolicy(enabled, statementList, name)

表4-31 updateJailBreakingDetectionPolicyの引数

引数

定義

enabled

有効にします。

statementList

パラメータのリスト。

name

JailBreakingDetectionPolicyの名前。

例

updateJailBreakingDetectionPolicy(true,'[{minOSVersion:3.5,maxOSVersion:5.0,minClientSDKVersion:1.0,maxClientSDKVersion:1.0,policyExpirationDurationInSec:3600,autoCheckPeriodInMin:60,detectionLocation:[{filePath:"/root",success:true,action:exists},{filePath:"/opt",success:true,action:exists}]}]','defaultJailBreakingDetectionPolicy')

getJailBreakingDetectionPolicys

getJailBreakingDetectionPolicys

説明

JailBreakingDetectionPolicyを取得します。

構文

getJailBreakingDetectionPolicys()

このコマンドには、引数はありません。

例

getJailBreakingDetectionPolicys()

次に、サンプル出力を示します。

JailBreakingDetectionPolicy: DefaultJailBreakingDetectionPolicy

removeJailBreakingDetectionPolicy

removeJailBreakingDetectionPolicy

説明

JailBreakingDetectionPolicyを削除します。

構文

removeJailBreakingDetectionPolicy(name)

ここで、nameは、JailBreakingDetectionPolicyの名前です。

例

removeJailBreakingDetectionPolicy('name')

displayJailBreakingDetectionPolicy

displayJailBreakingDetectionPolicy

説明

JailBreakingDetectionPolicyを表示します。

構文

displayJailBreakingDetectionPolicy(name)

ここで、nameは、JailBreakingDetectionPolicyの名前です。

例

displayJailBreakingDetectionPolicy('DefaultJailBreakingDetectionPolicy')

次に、サンプル出力を示します。

Displaying: JailBreakingDetectionPolicy : DefaultJailBreakingDetectionPolicy
ReadOnly = 0
ConfigMBean = 1
Name = DefaultJailBreakingDetectionPolicy
eventProvider = 1
SystemMBean = 0
objectName = com.oracle.idaas:name=DefaultJailBreakingDetectionPolicy,type=Xml.JailBreakingDetectionPolicy,Xml=MobileService
Enable = 1
JailBreakingDetectionPolicyStatement =
array(javax.management.openmbean.CompositeData,[javax.management.openmbean.
CompositeDataSupport(compositeType=javax.management.openmbean.CompositeType(name=
com.oracle.xmlns.idm.idaas.idaas_config_11_1_2_0_0.
TJailBreakingDetectionPolicyStatement,items=((itemName=autoCheckPeriodInMin,
itemType=javax.management.openmbean.SimpleType(name=java.lang.Long)),
(itemName=detectionLocation,itemType=javax.management.openmbean.ArrayType(name=
[Ljavax.management.openmbean.CompositeData;,dimension=1,elementType=
javax.management.openmbean.CompositeType(name=com.oracle.xmlns.idm.idaas.
idaas_config_11_1_2_0_0.
TDetectionLocation,items=((itemName=action,itemType=javax.management.openmbean.
SimpleType(name=java.lang.String)),(itemName=filePath,itemType=javax.management.
openmbean.SimpleType(name=java.lang.String)),(itemName=success,itemType=javax.
management.openmbean.SimpleType(name=java.lang.Boolean)))),primitiveArray=false)),
(itemName=enable,itemType=javax.management.openmbean.SimpleType(name=java.lang.
Boolean)),(itemName=maxClientSDKVersion,itemType=javax.management.openmbean.
SimpleType(name=java.lang.String)),(itemName=maxOSVersion,itemType=javax.
management.openmbean.SimpleType(name=java.lang.String)),(itemName=
minClientSDKVersion,itemType=javax.management.openmbean.SimpleType(name=
java.lang.String)),
(itemName=minOSVersion,itemType=javax.management.openmbean.SimpleType(name=
java.lang.String)),(itemName=policyExpirationDurationInSec,itemType=javax.
management.openmbean.SimpleType(name=java.lang.Long)))),contents=
{autoCheckPeriodInMin=60,detectionLocation=[Ljavax.management.openmbean.
CompositeData;@2dc906,enable=true,maxClientSDKVersion=11.1.2.0.0,
maxOSVersion=null, minClientSDKVersion=11.1.2.0.0, minOSVersion=1.0,
policyExpirationDurationInSec=3600})])
eventTypes = array(java.lang.String,['jmx.attribute.change'])
RestartNeeded = 0

removeOAuthIdentityDomain

removeOAuthIdentityDomain

説明

指定されたOAuthアイデンティティ・ドメインを削除します。

構文

removeOAuthIdentityDomain(name )

ここで、nameは、削除するOAuthアイデンティティ・ドメインの名前です。

例

removeOAuthIdentityDomain('myDomain' )

createOAuthIdentityDomain

createOAuthIdentityDomain

説明

新しいOAuthアイデンティティ・ドメインを作成します。

構文

createOAuthIdentityDomain(name, description, allowMultRS, enableMobile, globalUID )

表4-32 createOAuthIdentityDomainの引数

引数

定義

name

OAuthアイデンティティ・ドメインの名前。

description

OAuthアイデンティティ・ドメインの説明。[オプション]

allowMultRS

複数のリソース・サーバーを許可するブール値のセット。

enableMobile

(UIコンソールで使用される)モバイル・パラメータを有効にするブール値のセット。

globalUID

グローバル一意識別子。[オプション]

例

createOAuthIdentityDomain('myDomain', 'My Default Identity Domain', 'true', 'true', ' ')

updateOAuthIdentityDomain

updateOAuthIdentityDomain

説明

OAuthアイデンティティ・ドメインを更新します。

構文

updateOAuthIdentityDomain(name, newName, description, allowMultRS, enableMobile)

表4-33 updateOAuthIdentityDomainの引数

引数

定義

name

OAuthアイデンティティ・ドメインの名前。

NewName

OAuthアイデンティティ・ドメインの新しい名前。

description

OAuthアイデンティティ・ドメインの説明。[オプション]

allowMultRS

複数のリソース・サーバーを許可するブール値のセット。

enableMobile

(UIコンソールで使用される)モバイル・パラメータを有効にするブール値のセット。

例

updateOAuthIdentityDomain('myDomain','newDomain','My Default Identity Domain','true','true')

updateOAuthSystemConfig

updateOAuthSystemConfig

説明

アイデンティティ・ドメインのOAuthシステム構成のデフォルト値を更新します。

構文

updateOAuthSystemConfig(identityDomainName, proxyProtocol, proxyHost, proxyPort, proxyUser, minPool, maxPool, keepAlive, maxTokenSearchResult, paramList )

表4-34 updateOAuthSystemConfigの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

proxyProtocol

デフォルトのHTTPプロトコル。HTTPまたはHTTPS。[オプション]

proxyHost

デフォルトのHTTPプロキシ・ホスト。[オプション]

proxyPort

デフォルトのHTTPプロキシ・ポート。[オプション]

proxyUser

デフォルトのHTTPプロキシ・ユーザー。[オプション]

minPool

Apple Push Notificationのデフォルトの最小接続プール。

maxPool

Apple Push Notificationのデフォルトの最大接続プール。

KeepAlive

Apple Push NotificationのデフォルトのKeepAlive(秒単位)。

maxTokenSearchResult

トークン検索の最大の結果(秒単位)。

paramList

JSON形式で指定されたパラメータの一覧: [{name1:value1},{name2:value2}...]

例

updateOAuthSystemConfig('myDomain','HTTP','hostname', '4444', 'user', '1', '3', '300','55','[{param1:val1},{param2:val2}]')

removeOAuthSysComponent

removeOAuthSysComponent

説明

指定されたOAuthシステム・コンポーネントを削除します。

構文

removeOAuthSysComponent(identityDomainName, name )

表4-35 removeOAuthSysComponentの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthシステム・コンポーネントの名前。

例

removeOAuthSysComponent('myDomain','myComponent')

createOAuthSysComponent

createOAuthSysComponent

説明

指定されたOAuthシステム・コンポーネントを作成します。

構文

createOAuthSysComponent(identityDomainName, name, description, interClass, implClass, paramList)

表4-36 createOAuthSysComponentの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthシステム・コンポーネントの名前。

description

OAuthシステム・コンポーネントの説明。[オプション]

interClass

OAuthシステム・コンポーネントのインタフェース・クラス。

- 認可および承認プラグイン - oracle.security.idaas.oauth.consent.AuthorizationUserConsent

- クライアント・プラグイン - oracle.security.idaas.oauth.client.ClientSecurityManager

- リソース・サーバー・プラグイン - oracle.security.idaas.oauth.resourceserver.ResourceServerProfileService

implClass

OAuthシステム・コンポーネントの実装クラス。

paramList

JSON形式で指定されたパラメータの一覧: [{name1:value1},{name2:value2}...]

例

createOAuthSysComponent('myDomain','DefaultUserConsentService','Default User Consent Service','oracle.security.idaas.oauth.consent.AuthorizationUserConsent','oracle.security.idaas.oauth.consent.impl.LDAPAuthorizationUserConsentImpl','[{uc.ldap.username.attr:uid},{uc.ldap.consent.attr:postaladdress},{uc.ldap.userprofile.service:"/UserProfile"}]')

updateOAuthSysComponent

updateOAuthSysComponent

説明

指定されたOAuthシステム・コンポーネントを更新します。

構文

updateOAuthSysComponent(identityDomainName, name, description, interClass, implClass, paramList)

表4-37 updateOAuthSysComponentの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthシステム・コンポーネントの名前。

description

OAuthシステム・コンポーネントの説明。[オプション]

interClass

OAuthシステム・コンポーネントのインタフェース・クラス。

- 認可および承認プラグイン - oracle.security.idaas.oauth.consent.AuthorizationUserConsent

- クライアント・プラグイン - oracle.security.idaas.oauth.client.ClientSecurityManager

- リソース・サーバー・プラグイン - oracle.security.idaas.oauth.resourceserver.ResourceServerProfileService

implClass

OAuthシステム・コンポーネントの実装クラス。

paramList

JSON形式で指定されたパラメータの一覧: [{name1:value1},{name2:value2}...]

例

updateOAuthSysComponent('myDomain','DefaultUserConsentService','Default User Consent Service','oracle.security.idaas.oauth.consent.AuthorizationUserConsent','oracle.security.idaas.oauth.consent.impl.LDAPAuthorizationUserConsentImpl','[{uc.ldap.username.attr:uid},{uc.ldap.consent.attr:postaladdress},{uc.ldap.userprofile.service:"/UserProfile"}]')

removeOAuthServiceProvider

removeOAuthServiceProvider

説明

OAuthサービス・プロバイダ・オブジェクトを削除します。

構文

removeOAuthServiceProvider(identityDomainName, name )

表4-38 removeOAuthServiceProviderの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthサービス・プロバイダの名前。

例

removeOAuthServiceProvider('myDomain','myProvider')

createOAuthServiceProvider

createOAuthServiceProvider

説明

OAuthサービス・プロバイダを作成します

構文

createOAuthServiceProvider(identityDomainName, name, description, implClass, paramList)

表4-39 createOAuthServiceProviderの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthサービス・プロバイダの名前。

description

OAuthサービス・プロバイダの説明。[オプション]

implClass

OAuthサービス・プロバイダの実装クラス。

paramList

JSON形式で指定されたパラメータの一覧: [{name1:value1},{name2:value2}...]

例

createOAuthServiceProvider('myDomain','OAuthServiceProvider','OAuth Service Provider','oracle.security.idaas.oauth.token.jwtimpl.OAuthProvider', '[{oam.OAM_VERSION_disabled:OAM_11G},{oam.WEBGATE_ID:accessgate-oic},{oam.ENCRYPTED_PASSWORD:""},{oam.DEBUG_VALUE:0},{oam.TRANSPORT_SECURITY:OPEN},{oam.OAM_SERVER_1:"localhost:5575"},{oam.OAM_SERVER_1_MAX_CONN:4},{oam.OAM_SERVER_2:"oam_server_2:5575"},{oam.OAM_SERVER_2_MAX_CONN:4},{oam.AuthNURLForUID:"wl_authen://sample_ldap_no_pwd_protected_res"}]')

updateOAuthServiceProvider

updateOAuthServiceProvider

説明

OAuthサービス・プロバイダを更新します。

構文

updateOAuthServiceProvider(identityDomainName, name, description, implClass, paramList)

表4-40 updateOAuthServiceProviderの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthサービス・プロバイダの名前。

description

OAuthサービス・プロバイダの説明。[オプション]

implClass

OAuthサービス・プロバイダの実装クラス。

paramList

JSON形式で指定されたパラメータの一覧: [{name1:value1},{name2:value2}...]

例

updateOAuthServiceProvider('myDomain','OAuthServiceProvider','OAuth Service Provider','oracle.security.idaas.oauth.token.jwtimpl.OAuthProvider', '[{oam.OAM_VERSION_disabled:OAM_11G},{oam.WEBGATE_ID:accessgate-oic},{oam.ENCRYPTED_PASSWORD:"welcome"},{oam.DEBUG_VALUE:0},{oam.TRANSPORT_SECURITY:OPEN},{oam.OAM_SERVER_1:"localhost:5575"},{oam.OAM_SERVER_1_MAX_CONN:4},{oam.OAM_SERVER_2:"oam_server_2:5575"},{oam.OAM_SERVER_2_MAX_CONN:4},{oam.AuthNURLForUID:"wl_authen://sample_ldap_no_pwd_protected_res"}]')

updateOAuthServiceProviderParam

updateOAuthServiceProviderParam

説明

特定のパラメータを指定した新しい値で更新します。

構文

updateOAuthServiceProviderParam(identityDomainName, name, param, newvalue)

表4-41 updateOAuthServiceProviderParamの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthサービス・プロバイダの名前。

param

更新するパラメータ: name、description、implClass、paramList、paramListAdd (指定したパラメータを追加し、既存のパラメータを残します)

newvalue

パラメータの新しい値。

removeOAuthClient

removeOAuthClient

説明

OAuthClientオブジェクトを削除します。

構文

removeOAuthClient(identityDomainName, name )

表4-42 removeOAuthClientの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthクライアントの名前。

例

removeOAuthClient('myDomain','myClient')

createOAuthClient

createOAuthClient

説明

OAuthClientオブジェクトを作成します。

構文

createOAuthClient(identityDomainName, name, description, globalUID, secret, allowTokenAttrRetrieval, httpRedirectURIList, paramList, mobileRedirectURIList, mobileParams, claimList, minPool, maxPool, keepAlive, production, gcmAppSetting, scopeRequiresUserConsent, scopeInvokeUserConsent, allowAllScopes, resourceServerScopes, scopes, grantTypes, clientType)

表4-43 createOAuthClientの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthクライアントの名前。

description

OAuthクライアントの説明。

globalUID

グローバル一意識別子。[オプション]

secret

秘密鍵。

allowTokenAttrRetrieval

トークン属性の取得を有効、無効にするブール値。

httpRedirectList

JSON形式で指定された1つ以上のリダイレクトURIのリスト。

[{"uri":partial},{"uri2":partial}...]

paramList

JSON形式で指定されたパラメータのリスト。

[{name1:value1},{name2:value2}...]

mobileRedirectURIList

1つ以上のモバイル・リダイレクトURIのリスト。[オプション]

mobileParams

JSON形式で指定されたパラメータの一覧: [{name1:value1},{name2:value2}...]

claimList

クレーム属性のリスト。[オプション]

minPool

Apple Push Notificationのデフォルトの最小接続プール。[オプション]

maxPool

Apple Push Notificationのデフォルトの最大接続プール。[オプション]

KeepAlive

Apple Push NotificationのデフォルトのKeepAlive(秒単位)。[オプション]

production

productionまたはdevelopmentモードを設定するブール値。[オプション]

gcmAppSetting

Google Restricted Packageの名前。[オプション]

scopeRequiresUserConsent

ブール値

scopeInvokeUserConsent

ブール値

allowAllScopes

ブール値

resourceServerScopes

リソース・サーバー・スコープのリスト。この引数を使用して、リソース・サーバー・スコープ名の接頭辞を選択します。たとえば、userProfileでは、クライアントがすべてのuserProfileリソース・サーバー・スコープにアクセスすることを許可します。[オプション]

scope

スコープのリスト。この引数を使用して特定のスコープ名を選択します。たとえば、userProfile.me.readです。[オプション]

grantTypes

[オプション]付与タイプのリスト。

- authorization_code

- code

- token

- password

- client_credentials

- refresh_token

- oracle-idm:/oauth/grant-type/user-id-assertion

clientType

クライアントのタイプ: CONFIDENTIAL_CLIENTまたはMOBILE_CLIENT

例

createOAuthClient('myDomain','sampleOAuthMobileClient',
'sample client app','1234567890','quiet','true',
'[{"http://localhost:7005:/base_domain/domainRuntime":false}]','[{par1:val1}]',
'','[{mobpar1:mobval1}]',
'oracle:idm:claims:client:geolocation,oracle:idm:claims:client:imei,
oracle:idm:claims:client:jailbroken,oracle:idm:claims:client:locale,
oracle:idm:claims:client:macaddress,oracle:idm:claims:client:networktype,
oracle:idm:claims:client:ostype,oracle:idm:claims:client:osversion,
oracle:idm:claims:client:phonecarriername,oracle:idm:claims:client:phonenumber,
oracle:idm:claims:client:sdkversion,oracle:idm:claims:client:udid,
oracle:idm:claims:client:vpnenabled,oracle:idm:claims:client:fingerprint',
'1','3','300','false','gcm','true','false','true','','',
'authorization_code,client_credentials','MOBILE_CLIENT')

updateOAuthClient

updateOAuthClient

説明

OAuthClientを更新します。

構文

updateOAuthClient(identityDomainName, name, description, secret, allowTokenAttrRetrieval, httpRedirectURIList, paramList, mobileRedirectURIList, mobileParams, claimList, minPool, maxPool, keepAlive, production, gcmAppSetting, scopeRequiresUserConsent, scopeInvokeUserConsent, allowAllScopes, resourceServerScopes, scopes, grantTypes, clientType)

表4-44 updateOAuthClientの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthクライアントの名前。

description

OAuthクライアントの説明。

secret

秘密鍵。

allowTokenAttrRetrieval

トークン属性の取得を有効、無効にするブール値。

httpRedirectList

JSON形式で指定された1つ以上のリダイレクトURIのリスト。

[{"uri":partial},{"uri2":partial}...]

paramList

JSON形式で指定されたパラメータのリスト。

[{name1:value1},{name2:value2}...]

mobileRedirectURIList

1つ以上のモバイル・リダイレクトURIのリスト。[オプション]

mobileParams

JSON形式で指定されたパラメータの一覧: [{name1:value1},{name2:value2}...]

claimList

クレーム属性のリスト。[オプション]

minPool

Apple Push Notificationのデフォルトの最小接続プール。[オプション]

maxPool

Apple Push Notificationのデフォルトの最大接続プール。[オプション]

KeepAlive

Apple Push NotificationのデフォルトのKeepAlive(秒単位)。[オプション]

production

productionまたはdevelopmentモードを設定するブール値。[オプション]

gcmAppSetting

Google Restricted Packageの名前。[オプション]

scopeRequiresUserConsent

ブール値

scopeInvokeUserConsent

ブール値

allowAllScopes

ブール値

resourceServerScopes

リソース・サーバー・スコープのリスト。[オプション]

scope

スコープのリスト。[オプション]

grantTypes

[オプション]付与タイプのリスト。

- authorization_code

- code

- token

- password

- client_credentials

- refresh_token

- oracle-idm:/oauth/grant-type/user-id-assertion

clientType

クライアントのタイプ: CONFIDENTIAL_CLIENTまたはMOBILE_CLIENT ,ALL

例

updateOAuthClient('myDomain','sampleOAuthMobileClient',
'sample client app','quiet',
'[{"http://localhost:7005:/base_domain/domainRuntime":false}]',
'[{par1:val1}]','','[{mobpar1:mobval1}]','oracle:idm:claims:client:geolocation,
oracle:idm:claims:client:imei,oracle:idm:claims:client:jailbroken,
oracle:idm:claims:client:locale,oracle:idm:claims:client:macaddress,
oracle:idm:claims:client:networktype,oracle:idm:claims:client:ostype,
oracle:idm:claims:client:osversion,oracle:idm:claims:client:phonecarriername,
oracle:idm:claims:client:phonenumber,oracle:idm:claims:client:sdkversion,
oracle:idm:claims:client:udid,oracle:idm:claims:client:vpnenabled,
oracle:idm:claims:client:fingerprint','1','3','300','false','gcm','true','false',
'true','','','authorization_code,client_credentials','MOBILE_CLIENT')

updateOAuthClientParam

updateOAuthClientParam

説明

特定のパラメータを指定した新しい値で更新します。

構文

updateOAuthClient(identityDomainName, name, param, newvalue)

表4-45 updateOAuthClientParamの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthクライアントの名前。

param

更新するパラメータ: [name, description, secret, allowTokenAttrRetrieval, httpRedirectURIList, paramList, paramListAdd (指定されたパラメータを追加し、既存のパラメータを残します), mobileRedirectURIList]

newvalue

パラメータの新しい値。

例

updateOAuthClientParam('myDomain','sampleOAuthMobileClient','secret',
'xpalkdnwe3')

removeOAuthServiceProfile

removeOAuthServiceProfile

説明

サービス・プロファイルを削除します。

構文

removeOAuthServiceProfile(identityDomainName, name)

表4-46 removeOAuthServiceProfileの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthサービス・プロファイルの名前。

例

removeOAuthServiceProfile('myDomain','myServiceProfile')

createOAuthServiceProfile

createOAuthServiceProfile

説明

サービス・プロファイルを作成します。

構文

createOAuthServiceProfile(identityDomainName, name, description, adAccessPlugin, tokenAttrPlugin, clientPlugin, pluginMode, resourceServerProfilePlugin, authzUserConsentPlugin, allResourceServerInterfaces, resourceServers, allClients, clientAppBindings, preferredHardwareIdList, androidSender, androidSecurityLevel, iosSecurityLevel, otherSecurityLevel, consentServiceProtection, clientRegRequiresUserConsent, serviceProvider, endpoint, serviceEnable, mobilePreAuthzExpire, mobilePreAuthzEnable, authzExpire, authzEnable, clientExpire, clientEnable, clientRefreshExpire, clientRefreshEnable, userExpire, userEnable, userRefreshExpire, userRefreshEnable, accessExpire, accessEnable, accessRefreshExpire, accessRefreshEnable, paramList, mobParamList, userAuthenticator, tokenStatic, tokenDynamic)

表4-47 createOAuthServiceProfileの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthシステム・コンポーネントの名前。

description

OAuthサービス・プロファイルの説明。[オプション]

adAccessPlugin

アダプティブ・アクセス・プラグイン。[オプション]

tokenAttrPlugin

トークン属性プラグイン。[オプション]

clientPlugin

クライアント・プラグインの名前。

pluginMode

クライアント・プラグイン・モード。ALL_LOCAL_STORAGEまたはALL_PLUGIN_DELEGATION。

resourceServerProfilePlugin

リソース・サーバー・プロファイル・プラグイン。

authzUserConsentPlugin

認可ユーザー承諾プラグイン。

allResourceServerInterfaces

サービス・プロファイルが一般的な(false)インタフェースを含むことができるかどうかを示すブール値。

resourceServers

リソース・サーバーのリスト。

allClients

サービス・プロファイルがすべてのクライアントに適用されることを指定するブール値。

clientAppBindings

[オプション] JSON形式で指定されたクライアント・アプリケーション・バインディングのリスト。

[{client:client1,role:SSOAgent,priority:45,param:[{param1:value},{param2:value2}]}]

preferredHardwareIdList

カンマで区切られたハードウェアIDのリスト。

androidSender

GCM送信者のID。[オプション]

androidSecurityLevel

Androidセキュリティ・レベル: HIGHまたはMEDIUMまたはLOW。

iosSecurityLevel

iOSセキュリティ・レベル: HIGHまたはMEDIUMまたはLOW。

otherSecurityLevel

その他のセキュリティ・レベル: HIGHまたはMEDIUMまたはLOW。

consentServiceProtection

サービス保護モード: OAMまたはJWT_IDSまたはJWT_OAM。

clientRegRequiresUserConsent

クライアント登録でユーザー承諾が必要かどうかを指定するブール値。

serviceProvider

サービス・プロバイダ。

endpoint

サービス・エンドポイント。

serviceEnable

サービス・プロファイルを有効、無効にするブール値。trueまたはfalse。

mobilePreAuthzExpire

モバイル事前認可コードの有効期間の長さ(秒単位)。[オプション]

mobilePreAuthzEnable

モバイル事前認可コードを有効、無効にするブール値。[オプション] trueまたはfalse。

authzExpire

認可コードの有効期限(秒単位)。[オプション]

authzEnable

認可コードを有効、無効にするブール値。[オプション] trueまたはfalse。

clientExpire

クライアント・トークン認可コードの有効期限(秒単位)。[オプション]

clientEnable

クライアント・トークンを有効、無効にするブール値。[オプション] trueまたはfalse。

clientRefreshExpire

クライアント更新トークンの有効期限(秒単位)。[オプション]

clientRefreshEnable

クライアント更新トークンを有効、無効にするブール値。[オプション]

userExpire

ユーザー・トークンの有効期限(秒単位)。[オプション]

userEnable

ユーザー・トークンを有効、無効にするブール値。[オプション]

userRefreshExpire

ユーザー更新トークンの有効期限(秒単位)。[オプション]

userRefreshEnable

ユーザー更新トークンを有効、無効にするブール値。[オプション]

accessExpire

アクセス・トークンの有効期限(秒単位)。

accessEnable

アクセス・トークンが有効なブール値。

accessRefreshExpire

アクセス更新トークンの有効期限(秒単位)。

accessRefreshEnable

アクセス更新トークンが有効なブール値。

paramList

JSON形式で指定されたパラメータのリスト。

[{name1:value1},{name2:value2}...]

mobParamList

JSON形式で指定されたモバイル・クライアント・パラメータのリスト。

[{name1:value1},{name2:value2}...]

userAuthenticator

ユーザー・オーセンティケータ。IDSまたはOAM。

tokenStatic

[オプション] JSON形式で指定された静的トークン属性。

[{name1:value1},{name2:value2}...]

tokenDynamic

動的トークン属性リスト。[オプション]

例

createOAuthServiceProfile('myDomain', 'OAuthServiceProfile',
'OAuth Service Profile','sampleSecurityPlugin','defaultTokenAttrPlugin',
'DefaultClientSecurityManager','ALL_LOCAL_STORAGE',
'DefaultResourceServerProfilePlugin','AuthzUserConsentPlugin',
'false','sampleResourceServerInterface','false',
'[{client:sampleOAuthClient,role:SSOAgent,priority:45,param:[{param1:val1},
{param2:val2}]},{client:sampleOwsmOAuthClient,role:SSOAgent,priority:45,
param:[{param1:val1},{param2:val2}]}]','','GoogleCloudMessaging','HIGH','MEDIUM',
'LOW','OAM','true','OAuthServiceProvider','/oauthserv','true','150','false',
'900','true','28800','true','604800','true','28800','true','0','false','3600',
'true','28800','true','[{oracle.id.name:userrole},{jwt.CryptoScheme:RS512},
{jwt.issuer:www.oracle.example.com}]','[{mobileParamName:mobileParamValue}]',
'OAM','[{attr1:val1}]','attr1,attr2,attr3')

updateOAuthServiceProfile

updateOAuthServiceProfile

説明

サービス・プロファイルを更新します。

構文

updateOAuthServiceProfile(identityDomainName, name, description, adAccessPlugin, tokenAttrPlugin, clientPlugin, pluginMode, resourceServerProfilePlugin, authzUserConsentPlugin, allResourceServerInterfaces, resourceServers, allClients, clientAppBindings, preferredHardwareIdList,androidSender, androidSecurityLevel, iosSecurityLevel, otherSecurityLevel, consentServiceProtection, clientRegRequiresUserConsent, serviceProvider, endpoint, serviceEnable, mobilePreAuthzExpire, mobilePreAuthzEnable, authzExpire, authzEnable, clientExpire, clientEnable, clientRefreshExpire, clientRefreshEnable, userExpire, userEnable, userRefreshExpire, userRefreshEnable, accessExpire, accessEnable, accessRefreshExpire, accessRefreshEnable, paramList, mobParamList, userAuthenticator, tokenStatic, tokenDynamic)

表4-48 updateOAuthServiceProfileの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthサービス・プロファイルの名前。

description

OAuthサービス・プロファイルの説明。[オプション]

adAccessPlugin

アダプティブ・アクセス・プラグイン。[オプション]

tokenAttrPlugin

トークン属性プラグイン。[オプション]

clientPlugin

クライアント・プラグインの名前。

pluginMode

クライアント・プラグイン・モード。ALL_LOCAL_STORAGEまたはALL_PLUGIN_DELEGATION。

resourceServerProfilePlugin

リソース・サーバー・プロファイル・プラグイン。

authzUserConsentPlugin

認可ユーザー承諾プラグイン。

allResourceServerInterfaces

サービス・プロファイルが一般的な(false)インタフェースを含むことができるかどうかを示すブール値。

resourceServers

リソース・サーバーのリスト。

allClients

サービス・プロファイルがすべてのクライアントに適用されることを指定するブール値。

clientAppBindings

[オプション] JSON形式で指定されたクライアント・アプリケーション・バインディングのリスト。

[{client:client1,role:SSOAgent,priority:45,param:[{param1:value},{param2:value2}]}]

preferredHardwareIdList

カンマで区切られたハードウェアIDのリスト。

androidSender

GCM送信者のID。[オプション]

androidSecurityLevel

Androidセキュリティ・レベル: HIGHまたはMEDIUMまたはLOW。

iosSecurityLevel

iOSセキュリティ・レベル: HIGHまたはMEDIUMまたはLOW。

otherSecurityLevel

その他のセキュリティ・レベル: HIGHまたはMEDIUMまたはLOW。

consentServiceProtection

サービス保護モード: OAMまたはJWT_IDSまたはJWT_OAM。

clientRegRequiresUserConsent

クライアント登録でユーザー承諾が必要かどうかを指定するブール値。

serviceProvider

サービス・プロバイダ。

endpoint

サービス・エンドポイント。

serviceEnable

サービス・プロファイルを有効、無効にするブール値。trueまたはfalse。

mobilePreAuthzExpire

モバイル事前認可コードの有効期間の長さ(秒単位)。[オプション]

mobilePreAuthzEnable

モバイル事前認可コードを有効、無効にするブール値。[オプション] trueまたはfalse。

authzExpire

認可コードの有効期限(秒単位)。[オプション]

authzEnable

認可コードを有効、無効にするブール値。[オプション] trueまたはfalse。

clientExpire

クライアント・トークン認可コードの有効期限(秒単位)。[オプション]

clientEnable

クライアント・トークンを有効、無効にするブール値。[オプション] trueまたはfalse。

clientRefreshExpire

クライアント更新トークンの有効期限(秒単位)。[オプション]

clientRefreshEnable

クライアント更新トークンを有効、無効にするブール値。[オプション]

userExpire

ユーザー・トークンの有効期限(秒単位)。[オプション]

userEnable

ユーザー・トークンを有効、無効にするブール値。[オプション]

userRefreshExpire

ユーザー更新トークンの有効期限(秒単位)。[オプション]

userRefreshEnable

ユーザー更新トークンを有効、無効にするブール値。[オプション]

accessExpire

アクセス・トークンの有効期限(秒単位)。

accessEnable

アクセス・トークンが有効なブール値。

accessRefreshExpire

アクセス更新トークンの有効期限(秒単位)。

accessRefreshEnable

アクセス更新トークンが有効なブール値。

paramList

JSON形式で指定されたパラメータのリスト。

[{name1:value1},{name2:value2}...]

mobParamList

JSON形式で指定されたモバイル・クライアント・パラメータのリスト。

[{name1:value1},{name2:value2}...]

userAuthenticator

ユーザー・オーセンティケータ。IDSまたはOAM。

tokenStatic

[オプション] JSON形式で指定された静的トークン属性。

[{name1:value1},{name2:value2}...]

tokenDynamic

動的トークン属性リスト。[オプション]

例

updateOAuthServiceProfile('myDomain', 'OAuthServiceProfile', 'OAuth Service Profile','sampleSecurityPlugin','defaultTokenAttrPlugin','DefaultClientSecurityManager','ALL_LOCAL_STORAGE','DefaultResourceServerProfilePlugin','AuthzUserConsentPlugin','false','sampleResourceServerInterface','false','[{client:sampleOAuthClient,role:SSOAgent,priority:45,param:[{param1:val1},{param2:val2}]},{client:sampleOwsmOAuthClient,role:SSOAgent,priority:45,param:[{param1:val1},{param2:val2}]}]','oracle:idm:claims:client:iosidforvendor,oracle:idm:claims:client:macaddress,oracle:idm:claims:client:imei','GoogleCloudMessaging','HIGH','MEDIUM','LOW','OAM','true','OAuthServiceProvider','/oauthserv','true','150','false','900','true','28800','true','604800','true','28800','true','0','false','3600','true','28800','true','[{oracle.id.name:userrole},{jwt.CryptoScheme:RS512},{jwt.issuer:www.oracle.example.com}]','[{mobileParamName:mobileParamValue}]','OAM','[{attr1:val1}]','attr1,attr2,attr3')

updateOAuthServiceProfileParam

updateOAuthServiceProfileParam

説明

特定のパラメータを指定した新しい値で更新します。

構文

updateOAuthServiceProfileParam(identityDomainName, name, param, newvalue)

表4-49 updateOAuthServiceProfileの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthサービス・プロバイダの名前。

param

更新するパラメータ: [name, description, adAccessPlugin, tokenAttrPlugin, resourceServerProfilePlugin, authzUserConsentPlugin, allResourceServerInterfaces, resourceServers, allClients, clientAppBindings, serviceProvider, endpoint, serviceEnable, paramList, paramListAdd (指定されたパラメータを追加し、既存のパラメータを残します), userAuthenticator]

newvalue

パラメータの新しい値。

例

updateOAuthServiceProfileParam('myDomain', 'OAuthServiceProfile',
'serviceEnable','false')

removeOAuthAdaptiveAccessPlugin

removeOAuthAdaptiveAccessPlugin

説明

指定されたOAuthアダプティブ・アクセス・プラグインを削除します。

構文

removeOAuthAdaptiveAccessPlugin(identityDomainName,name)

表4-50 removeOAuthAdaptiveAccessPluginの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthシステム・コンポーネントの名前。

例

removeOAuthAdaptiveAccessPlugin('myDomain','myComponent')

createOAuthAdaptiveAccessPlugin

createOAuthAdaptiveAccessPlugin

説明

指定されたOAuthアダプティブ・アクセス・プラグインを作成します。

構文

createOAuthAdaptiveAccessPlugin(identityDomainName, name, description, implClass, paramList)

表4-51 createOAuthAdaptiveAccessPluginの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthプラグインの名前。

description

OAuthプラグインの説明。[オプション]

implClass

OAuthプラグインの実装クラス。

paramList

JSON形式で指定されたパラメータの一覧: [{name1:value1},{name2:value2}...]

例

createOAuthAdaptiveAccessPlugin('myDomain','sampleSecurityPlugin','sample adaptive access plugin', 'oracle.security.idaas.rest.provider.plugin.impl.DebugMobileSecurityHandlerImpl','[{OAUTH_TEST:true},{EMU_DEVICE_REG:true},{EMU_HANDLE:false}]')

updateOAuthAdaptiveAccessPlugin

updateOAuthAdaptiveAccessPlugin

説明

指定されたOAuthアダプティブ・アクセス・プラグインを更新します。

構文

updateOAuthAdaptiveAccessPlugin(identityDomainName, name, description, implClass, paramList)

表4-52 createOAuthAdaptiveAccessPluginの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthプラグインの名前。

description

OAuthプラグインの説明。[オプション]

implClass

OAuthプラグインの実装クラス。

paramList

JSON形式で指定されたパラメータの一覧: [{name1:value1},{name2:value2}...]

例

updateOAuthAdaptiveAccessPlugin('myDomain','sampleSecurityPlugin','sample adaptive access plugin','oracle.security.idaas.rest.provider.plugin.impl.DebugMobileSecurityHandlerImpl','[{OAUTH_TEST:true},{EMU_DEVICE_REG:true},{EMU_HANDLE:false}]')

removeOAuthTokenAttributesPlugin

removeOAuthTokenAttributesPlugin

説明

指定されたOAuthトークン属性プラグインを削除します。

構文

removeOAuthTokenAttributesPlugin(identityDomainName,name)

表4-53 removeOAuthTokenAttributesPluginの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthシステム・コンポーネントの名前。

例

removeOAuthTokenAttributesPlugin('myDomain','myComponent')

createOAuthTokenAttributesPlugin

createOAuthTokenAttributesPlugin

説明

指定されたOAuthトークン属性プラグインを作成します。

構文

createOAuthTokenAttributesPlugin(identityDomainName, name, description,implClass, paramList)

表4-54 createOAuthTokenAttributesPluginの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthプラグインの名前。

description

OAuthプラグインの説明。[オプション]

implClass

OAuthプラグインの実装クラス。

paramList

JSON形式で指定されたパラメータの一覧: [{name1:value1},{name2:value2}...]

例

createOAuthTokenAttributesPlugin('myDomain','testTokenAttributesPlugin','test token attributes plugin','oracle.security.idaas.rest.provider.plugin.impl.DebugTokenAttributesHandlerImpl','[{paramName:paramValue}]')

updateOAuthTokenAttributesPlugin

updateOAuthTokenAttributesPlugin

説明

指定されたOAuthトークン属性プラグインを更新します。

構文

updateOAuthTokenAttributesPlugin(identityDomainName, name, description, implClass, paramList)

表4-55 updateOAuthTokenAttributesPluginの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthプラグインの名前。

description

OAuthプラグインの説明。[オプション]

implClass

OAuthプラグインの実装クラス。

paramList

JSON形式で指定されたパラメータの一覧: [{name1:value1},{name2:value2}...]

例

updateOAuthTokenAttributesPlugin('myDomain','testTokenAttributesPlugin','test token attributes plugin', 'oracle.security.idaas.rest.provider.plugin.impl.DebugTokenAttributesHandlerImpl','[{paramName:paramValue}]')

removeOAuthResourceServerInterface

removeOAuthResourceServerInterface

説明

OAuthリソース・サーバー・インタフェースを削除します。

構文

removeOAuthResourceServerInterface(identityDomainName, name )

表4-56 removeOAuthResourceServerInterfaceの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthリソース・サーバー・インタフェースの名前。

例

removeOAuthResourceServerInterface('myDomain','myComponent')

updateOAuthResourceServerInterface

updateOAuthResourceServerInterface

説明

OAuthリソース・サーバー・インタフェースを更新します。

構文

updateOAuthResourceServerInterface(identityDomainName, name, description, secret, allowTokenAttrRetrieval, namespacePrefix, audienceClaim, scopeList, offlineScope, authzUserConsentPluginRef, overriddenAuthzExpire, overriddenAuthzEnable, overriddenAccessExpire, overriddenAccessEnable, overriddenAccessRefreshExpire, overriddenAccessRefreshEnable, tokenStatic, tokenDynamic)

表4-57 updateOAuthResourceServerInterfaceの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthリソース・サーバー・インタフェースの名前。

description

OAuthリソース・サーバー・インタフェースの説明。

secret

秘密鍵。

allowTokenAttrRetrieval

トークン属性の取得を有効、無効にするブール値。

namespacePrefix

名前空間の接頭辞。[オプション]

audienceClaim

オーディエンス要求のURI。[オプション]

scopeList

JSON形式で指定されたパラメータのリスト。

[{scopeName:myName,includedInDefault:true,userOffline:true,requiresConsent:true,scopeDesc:[{en-us:value},{en:value2}]}]

offlineScope

オフラインのスコープ。[オプション]

authzUserConsentPluginRef

認可ユーザー承諾プラグイン参照。

overriddenAuthzExpire

オーバーライドされた認可コードの有効期限(秒単位)。

overriddenAuthzEnable

認可オーバーライド・オプションを有効、無効にするブール値。

overriddenAccessExpire

オーバーライドされたアクセス・トークンの有効期限(秒単位)。

overriddenAccessEnable

アクセス・トークン・オーバーライド・オプションを有効、無効にするブール値。

overriddenAccessRefreshExpire

オーバーライドされたアクセス更新トークンの有効期限(秒単位)。

overriddenAccessRefreshEnable

アクセス更新オーバーライド・オプションを有効、無効にするブール値。

tokenStatic

JSON形式で指定された静的トークン属性のリスト: [{name1:value1},{name2:value2}...]

tokenDynamic

動的トークン属性リスト。

例

updateOAuthResourceServerInterface('myDomain','sampleResourceServerInterface','sample portal content resource server','secret','true','namespaceprefix.','audienceClaim','[{scopeName:samplePortalContentServer.portal.read,includedInDefault:false,userOffline:false,requiresConsent:true,scopeDesc:[{en-us:read portal content}]},{scopeName:samplePortalContentServer.portal.write,includedInDefault:false,userOffline:false,requiresConsent:true,scopeDesc:[{en-us:write portal content}]}]','offlineScope','AuthzUserConsentPlugin','1200','false','7200','false','28801','false','[]','')

updateOAuthResourceServerInterfaceParam

updateOAuthResourceServerInterfaceParam

説明

特定のパラメータを指定した新しい値で更新します。

構文

updateOAuthResourceServerInterfaceParam(identityDomainName, name, param, newvalue)

表4-58 updateOAuthResourceServerInterfaceの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthリソース・サーバー・インタフェースの名前。

param

更新するパラメータ: [name, description, secret, allowTokenAttrRetrieval, namespacePrefix, audienceClaim, scopeList, offlineScope, authzUserConsentPluginRef].

newvalue

パラメータの新しい値。

例

updateOAuthResourceServerInterfaceParam('myDomain',
'sampleResourceServerInterface','namespacePrefix','xyz.')

createOAuthResourceServerInterface

createOAuthResourceServerInterface

説明

OAuthリソース・サーバー・インタフェースを作成します。

構文

createOAuthResourceServerInterface(identityDomainName, name, description, globalUID, secret, allowTokenAttrRetrieval, namespacePrefix, audienceClaim, scopeList, offlineScope, authzUserConsentPluginRef, overriddenAuthzExpire, overriddenAuthzEnable, overriddenAccessExpire, overriddenAccessEnable, overriddenAccessRefreshExpire, overriddenAccessRefreshEnable, tokenStatic, tokenDynamic)

表4-59 createOAuthResourceServerInterfaceの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthリソース・サーバー・インタフェースの名前。

description

OAuthリソース・サーバー・インタフェースの説明。

globalUID

グローバル一意識別子。[オプション]

secret

秘密鍵。

allowTokenAttrRetrieval

トークン属性の取得を有効、無効にするブール値。

namespacePrefix

名前空間の接頭辞。[オプション]

audienceClaim

オーディエンス要求のURI。[オプション]

scopeList

JSON形式で指定されたパラメータのリスト。

[{scopeName:myName,includedInDefault:true,userOffline:true,requiresConsent:true,scopeDesc:[{en-us:value},{en:value2}]}]

offlineScope

オフラインのスコープ。[オプション]

authzUserConsentPluginRef

認可ユーザー承諾プラグイン参照。

overriddenAuthzExpire

オーバーライドされた認可コードの有効期限(秒単位)。

overriddenAuthzEnable

認可オーバーライド・オプションを有効、無効にするブール値。

overriddenAccessExpire

オーバーライドされたアクセス・トークンの有効期限(秒単位)。

overriddenAccessEnable

アクセス・トークン・オーバーライド・オプションを有効、無効にするブール値。

overriddenAccessRefreshExpire

オーバーライドされたアクセス更新トークンの有効期限(秒単位)。

overriddenAccessRefreshEnable

アクセス更新オーバーライド・オプションを有効、無効にするブール値。

tokenStatic

JSON形式で指定された静的トークン属性のリスト: [{name1:value1},{name2:value2}...]

tokenDynamic

動的トークン属性リスト。

例

createOAuthResourceServerInterface('myDomain','sampleResourceServerInterface',
'sample portal content resource server','','secret','true','namespaceprefix.',
'audienceClaim','[{scopeName:samplePortalContentServer.portal.read,
includedInDefault:false,userOffline:false,requiresConsent:true,
scopeDesc:[{en-us:read portal content}]},
{scopeName:samplePortalContentServer.portal.write,
includedInDefault:false,userOffline:false,requiresConsent:true,
scopeDesc:[{en-us:write portal content}]}]',
'offlineScope','AuthzUserConsentPlugin','1200','false','7200','false','28801',
'false','[]','')

updateOAuthJailBreakingDetectionPolicy

updateOAuthJailBreakingDetectionPolicy

説明

指定されたOAuthジェイルブレーク検出ポリシーを更新します。

構文

updateOAuthJailBreakingDetectionPolicy(identityDomainName, name, enabled, policyStatements)

表4-60 updateOAuthJailBreakingDetectionPolicyの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

ジェイルブレーク検出ポリシーの名前。

enabled

ジェイルブレーク検出ポリシーを有効、無効にするブール値。

policyStatements

JSON形式で指定されたポリシー文のリスト。

[{enable:true,minOS:1.0,maxOS:2.0,minSDK:0,maxSDK:4,policyExpire:28000, autoCheckPeriod:35,location:[{path:"/mydir",action:exists,success:true}]}]

例

updateOAuthJailBreakingDetectionPolicy('myDomain','sampleJailBreak','true',
'[{enable:true,minOS:1.0,maxOS:2.0,minSDK:0,maxSDK:4,policyExpire:28000,
autoCheckPeriod:35,location:[{path:"/mydir",action:exists,success:true}]}]')

removeOAuthUserProfileResourceServer

removeOAuthUserProfileResourceServer

説明

OAuthユーザー・プロファイル・リソース・サーバー・インタフェースを削除します。

構文

removeOAuthUserProfileResourceServer(identityDomainName, name)

表4-61 removeOAuthResourceServerInterfaceの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

name

OAuthユーザー・プロファイル・リソース・サーバー・インタフェースの名前。

例

removeOAuthUserProfileResourceServer('myDomain','myComponent')

updateOAuthUserProfileResourceServer

updateOAuthUserProfileResourceServer

説明

OAuthユーザー・プロファイル・リソース・サーバー・インタフェースを更新します。

構文

updateOAuthUserProfileResourceServer(identityDomainName, resName, resDesc, secret, namespacePrefix, authzPluginRef, scopeList, offlineScope, authzExpire, authzEnable, accessExpire, accessEnable, accessRefreshExpire, accessRefreshEnable, tokenStatic, tokenDynamic, endpoint, enabled, subResource, paramList)

表4-62 updateOAuthUserProfileResourceServerの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

resName

OAuthリソース・サーバー・インタフェースの名前。

resDesc

OAuthリソース・サーバー・インタフェースの説明。

secret

秘密鍵。

namespacePrefix

名前空間の接頭辞。

authzPluginRef

認可プラグイン参照。

scopeList

JSON形式で指定されたパラメータのリスト。

[{scopeName:myName,includedInDefault:true,userOffline:true,requiresConsent:true,scopeDesc:[{en-us:value},{en:value2}]}]

offlineScope

オフラインのスコープ。[オプション]

authzExpire

認可コードの有効期限(秒単位)。

authzEnable

認可コード・オプションを有効、無効にするブール値。

accessExpire

アクセス・トークンの有効期限(秒単位)。

accessEnable

アクセス・トークン・オプションを有効、無効にするブール値。

accessRefreshExpire

アクセス更新トークンの有効期限(秒単位)。

accessRefreshEnable

アクセス更新オプションを有効、無効にするブール値。

tokenStatic

JSON形式で指定された静的トークン属性のリスト: [{name1:value1},{name2:value2}...]

tokenDynamic

動的トークン属性リスト。

endpoint

サービス・エンドポイント。

enabled

有効、無効にするブール値。

subResource

JSON形式で指定:

[{endpoint:"/sub",enabled:true,implClass:com.oracle.impl,

entities:[{attributes:"at1,at2",

relationship:[{

name:people_groups,endpoint:memberOf,

srcEntity:person-uri,destEntity:group-uri}]}],

binding:[{method:GET,allow:true,scope:myscope,addScope:[{name:newscope,attr:"var1,var2"}],

param:[{param1:val1}]}]}]

paramList

JSON形式で指定されたパラメータの一覧: [{name1:value1},{name2:value2}...]

例

updateOAuthUserProfileResourceServer('myDomain','userProfile',
'Out Of The Box User Profile Resource Server','welcome1',
'[{scopeName:userProfile.users.read,includedInDefault:false,userOffline:false,
requiresConsent:false,scopeDesc:[{en-us:read any user default profile}]},
{scopeName:userProfile.users.write,includedInDefault:false,userOffline:false,
requiresConsent:false,scopeDesc:[{en-us:write any user default profile}]},
{scopeName:userProfile.group.read,includedInDefault:false,userOffline:false,
requiresConsent:false,scopeDesc:[{en-us:read any group default profile}]},
{scopeName:userProfile.group.write,includedInDefault:false,userOffline:false,
requiresConsent:false,scopeDesc:[{en-us:write any group default profile}]},
{scopeName:userProfile.me.read,includedInDefault:false,userOffline:false,
requiresConsent:true,scopeDesc:[{en-us:read my default profile}]},
{scopeName:userProfile.me.write,includedInDefault:false,userOffline:false,
requiresConsent:true,scopeDesc:[{en-us:write my default profile}]},
{scopeName:userProfile.me.password,includedInDefault:false,userOffline:false,
requiresConsent:true,scopeDesc:[{en-us:write my default password}]}]',
'namespace','userrole','defaultPlugin','900','true','604800','true','28800',
'true','/myuserprofile','false','[{accessControl:false},
{adminGroup:"cn=Administrators,ou=groups,ou=myrealm,dc=base_domain"},
{selfEdit:true}]','[{endpoint:"/me",
enabled:true,implClass:oracle.security.idaas.oauth.jaxrs.Me,
entities:[{attributes:"",relationship:[{name:people_groups,
endpoint:memberOf,srcEntity:person-uri,destEntity:group-uri,scopeNames:""},
{name:people_manager,endpoint:manager,srcEntity:report-uri,
destEntity:manager-uri,scopeNames:""}]}],binding:[{method:"GET",
allow:true,scope:myscope,addScope:[{name:userProfile.me.read,attr:"uid,mail,
description,commonname,firstname,lastname"},{name:userProfile.me.password,
attr:password}]},{method:"POST,PUT,DELETE",allow:true,scope:myscope,
addScope:[{name:userProfile.me.write,attr:"uid,mail,description,commonname,
firstname,lastname"},{name:userProfile.me.password,attr:password}]}],param:[]},
{endpoint:"/users",enabled:true,implClass:oracle.
security.idaas.oauth.jaxrs.Users,entities:[{attributes:"",
relationship:[{name:people_groups,endpoint:memberOf,srcEntity:person-uri,
destEntity:group-uri,scopeNames:""},{name:people_manager,endpoint:manager,
srcEntity:report-uri,destEntity:manager-uri,scopeNames:""}]}],
binding:[{method:"GET",allow:true,scope:myscope,
addScope:[{name:userProfile.users.read,attr:"uid,mail,description,commonname,
firstname,lastname"}]},{method:"POST,PUT,DELETE",allow:true,scope:myscope,
addScope:[{name:userProfile.users.write,attr:"uid,mail,description,commonname,
firstname,lastname"}]}],param:[]},{endpoint:"/groups",enabled:true,
implClass:oracle.security.idaas.oauth.jaxrs.Groups,entities:[{attributes:"",
relationship:[{name:groups_people,endpoint:memberOf,srcEntity:group-uri,
destEntity:person-uri,scopeNames:""}]}],binding:[{method:"GET",allow:true,
scope:myscope,addScope:[{name:userProfile.group.read,attr:"name,description"}]},
{method:"POST,PUT,DELETE",allow:true,scope:myscope,
addScope:[{name:userProfile.group . write,attr:"name,description"}]}],
param:[]}]','[{param1:val1},{param2:val2}]','attr1,attr2')

createOAuthUserProfileResourceServer

createOAuthUserProfileResourceServer

説明

OAuthユーザー・プロファイル・リソース・サーバー・インタフェースを作成します。

構文

createOAuthUserProfileResourceServer(identityDomainName, resName, resDesc, globalUID, secret, scopeList, namespacePrefix, idsName, authzPluginRef, authzExpire, authzEnable, accessExpire, accessEnable, accessRefreshExpire, accessRefreshEnable, endpoint, enabled, paramList, subResourceList, tokenStatic, tokenDynamic)

表4-63 createOAuthUserProfileResourceServerの引数

引数

定義

identityDomainName

OAuthアイデンティティ・ドメインの名前。

resName

OAuthリソース・サーバー・インタフェースの名前。

resDesc

OAuthリソース・サーバー・インタフェースの説明。

globalUID

グローバル一意識別子。(オプション)

secret

秘密鍵。

scopeList

JSON形式で指定されたパラメータのリスト。

[{scopeName:myName,includedInDefault:true,userOffline:true,requiresConsent:true,scopeDesc: [{en-us:value},{en:value2}]}]

namespacePrefix

名前空間の接頭辞。

idsName

アイデンティティ・ディレクトリ・サービス名。

authzPluginRef

認可プラグイン参照。

authzExpire

認可コードの有効期限(秒単位)。

authzEnable

認可コード・オプションを有効、無効にするブール値。

accessExpire

アクセス・トークンの有効期限(秒単位)。

accessEnable

アクセス・トークン・オプションを有効、無効にするブール値。

accessRefreshExpire

アクセス更新トークンの有効期限(秒単位)。

accessRefreshEnable

アクセス更新オプションを有効、無効にするブール値。

endpoint

サービス・エンドポイント。

enabled

有効、無効にするブール値。

paramList

JSON形式で指定されたパラメータの一覧: [{name1:value1},{name2:value2}...]

subResource

JSON形式で指定:

[{endpoint:"/sub",enabled:true,implClass:com.oracle.impl,

entities:[{attributes:"at1,at2",

relationship:[{

name:people_groups,endpoint:memberOf,

srcEntity:person-uri,destEntity:group-uri}]}],

binding:[{method:GET,allow:true,scope:myscope,addScope:[{name:newscope,attr:"var1,var2"}],

param:[{param1:val1}]}]}]

tokenStatic

JSON形式で指定された静的トークン属性のリスト: [{name1:value1},{name2:value2}...]

tokenDynamic

動的トークン属性リスト。

例

createOAuthUserProfileResourceServer('myDomain','userProfile',
'Out Of The Box User Profile Resource Server','555888','welcome1',
'[{scopeName:userProfile.users.read,includedInDefault:false,userOffline:false,
requiresConsent:false,scopeDesc:[{en-us:read any user default profile}]},
{scopeName:userProfile.users.write,includedInDefault:false,userOffline:false,
requiresConsent:false,scopeDesc:[{en-us:write any user default profile}]},
{scopeName:userProfile.group.read,includedInDefault:false,userOffline:false,
requiresConsent:false,scopeDesc:[{en-us:read any group default profile}]},
{scopeName:userProfile.group.write,includedInDefault:false,userOffline:false,
requiresConsent:false,scopeDesc:[{en-us:write any group default profile}]},
{scopeName:userProfile.me.read,includedInDefault:false,userOffline:false,
requiresConsent:true,scopeDesc:[{en-us:read my default profile}]},
{scopeName:userProfile.me.write,includedInDefault:false,userOffline:false,
requiresConsent:true,scopeDesc:[{en-us:write my default profile}]},
{scopeName:userProfile.me.password,includedInDefault:false,userOffline:false,
requiresConsent:true,scopeDesc:[{en-us:write my default password}]}]',
'namespace','userrole','defaultPlugin','900','true','604800','true','28800',
'true','/myuserprofile','false','[{accessControl:false},
{adminGroup:"cn=Administrators,ou=groups,ou=myrealm,dc=base_domain"},
{selfEdit:true}]','[{endpoint:"/me",enabled:true,
implClass:oracle.security.idaas.oauth.jaxrs.Me,entities:[{attributes:"",
relationship:[{name:people_groups,endpoint:memberOf,srcEntity:person-uri,
destEntity:group-uri,scopeNames:""},{name:people_manager,endpoint:manager,
srcEntity:report-uri,destEntity:manager-uri,scopeNames:""}]}],
binding:[{method:"GET",allow:true,scope:myscope,
addScope:[{name:userProfile.me.read,attr:"uid,mail,description,commonname,
firstname,lastname"},{name:userProfile.me.password,attr:password}]},
{method:"POST,PUT,DELETE",allow:true,scope:myscope,
addScope:[{name:userProfile.me.write,attr:"uid,mail,description,commonname,
firstname,lastname"},{name:userProfile.me.password,attr:password}]}],param:[]},
{endpoint:"/users",enabled:true,
implClass:oracle.security.idaas.oauth.jaxrs.Users,entities:[{attributes:"",
relationship:[{name:people_groups,endpoint:memberOf,srcEntity:person-uri,
destEntity:group-uri,scopeNames:""},{name:people_manager,endpoint:manager,
srcEntity:report-uri,destEntity:manager-uri,scopeNames:""}]}],
binding:[{method:"GET",allow:true,scope:myscope,
addScope:[{name:userProfile.users.read,attr:"uid,mail,description,commonname,
firstname,lastname"}]},{method:"POST,PUT,DELETE",allow:true,scope:myscope,
addScope:[{name:userProfile.users.write,attr:"uid,mail,description,commonname,
firstname,lastname"}]}],param:[]},{endpoint:"/groups",enabled:true,
implClass:oracle.security.idaas.oauth.jaxrs.Groups,
entities:[{attributes:"",relationship:[{name:groups_people,endpoint:memberOf,
srcEntity:group-uri,destEntity:person-uri,scopeNames:""}]}],
binding:[{method:"GET",allow:true,scope:myscope,
addScope:[{name:userProfile.group.read,attr:"name,description"}]},
{method:"POST,PUT,DELETE",allow:true,scope:myscope,
addScope:[{name:userProfile.group.write,attr: "name,description"}]}],
param:[]}]','[{param1:val1},{param2:val2}]','attr1,attr2')

getOAuthIdentityDomains

getOAuthIdentityDomains

説明

すべての既存のOAuthアイデンティティ・ドメインを取得します。

構文

getOAuthIdentityDomains

例

getOAuthIdentityDomains

displayOAuthIdentityDomain

displayOAuthIdentityDomain

説明

指定されたOAuthアイデンティティ・ドメインを表示します。

構文

displayOAuthIdentityDomain(uuid)

表4-64 displayOAuthIdentityDomainの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

例

displayOAuthIdentityDomain('12345678-1234-1234-1234-123456789012')

displayOAuthSystemConfig

displayOAuthSystemConfig

説明

指定されたOAuthシステム構成を表示します。

構文

displayOAuthSystemConfig(uuid)

表4-65 displayOAuthSystemConfigの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

例

displayOAuthSystemConfig('12345678-1234-1234-1234-123456789012')

getOAuthSysComponents

getOAuthSysComponents

説明

すべての既存のOAuthシステム・コンポーネントを取得します。

構文

getOAuthSysComponents(uuid)

表4-66 getOAuthSysComponentsの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

例

getOAuthSysComponents('12345678-1234-1234-1234-123456789012')

displayOAuthSysComponent

displayOAuthSysComponent

説明

指定されたOAuthシステム・コンポーネントを表示します。

構文

displayOAuthSysComponent(uuid,name)

表4-67 displayOAuthSysComponentの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

name

特定のシステム・コンポーネントの名前。

例

displayOAuthSysComponent('12345678-1234-1234-1234-123456789012','DefaultTokenLifeCycleService')

getOAuthServiceProviders

getOAuthServiceProviders

説明

すべての既存のOAuthサービス・プロバイダを取得します。

構文

getOAuthServiceProviders(uuid)

表4-68 getOAuthServiceProvidersの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

例

getOAuthServiceProviders('12345678-1234-1234-1234-123456789012')

displayOAuthServiceProvider

displayOAuthServiceProvider

説明

指定されたOAuthサービス・プロバイダを表示します。

構文

displayOAuthServiceProvider(uuid,name)

表4-69 getOAuthServiceProvidersの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

name

特定のサービス・プロバイダの名前。

例

displayOAuthServiceProvider('12345678-1234-1234-1234-123456789012','OAuthServiceProvider')

getOAuthClients

getOAuthClients

説明

すべての既存のOAuthクライアントを取得します。

構文

getOAuthClients(uuid)

表4-70 getOAuthClientsの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

例

getOAuthClients('12345678-1234-1234-1234-123456789012')

displayOAuthClient

displayOAuthClient

説明

指定されたOAuthクライアントを表示します。

構文

displayOAuthClient(uuid,name)

表4-71 displayOAuthClientの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

name

特定のクライアントの名前。

例

displayOAuthClient('12345678-1234-1234-1234-123456789012','sampleOAuthClient')

getOAuthAdaptiveAccessPlugins

getOAuthAdaptiveAccessPlugins

説明

すべての既存のOAuthアダプティブ・アクセス・プラグインを取得します。

構文

getOAuthAdaptiveAccessPlugins(uuid)

表4-72 getOAuthAdaptiveAccessPluginsの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

例

getOAuthAdaptiveAccessPlugins('12345678-1234-1234-1234-123456789012')

displayOAuthAdaptiveAccessPlugin

displayOAuthAdaptiveAccessPlugin

説明

指定されたOAuthアダプティブ・アクセス・プラグインを表示します。

構文

displayOAuthAdaptiveAccessPlugin(uuid,name)

表4-73 displayOAuthAdaptiveAccessPluginの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

name

特定のアダプティブ・アクセス・プラグインの名前。

例

displayOAuthAdaptiveAccessPlugin('12345678-1234-1234-1234-123456789012','sampleOAuthClient')

getOAuthAuthzPlugin

getOAuthAuthzPlugin

説明

すべての既存のOAuth認可プラグインを取得します。

構文

getOAuthAuthzPlugin(uuid)

表4-74 getOAuthAuthzPluginの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

例

getOAuthAuthzPlugin('12345678-1234-1234-1234-123456789012')

displayOAuthAuthzPlugin

displayOAuthAuthzPlugin

説明

指定されたOAuth認可プラグインを表示します。

構文

displayOAuthAuthzPlugin(uuid,name)

表4-75 displayOAuthAuthzPluginの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

name

特定の認可プラグインの名前。

例

displayOAuthAuthzPlugin('12345678-1234-1234-1234-123456789012','sampleOAuthClient')

getOAuthTokenAttributesPlugins

getOAuthTokenAttributesPlugins

説明

すべての既存のOAuthトークン属性プラグインを取得します。

構文

getOAuthTokenAttributesPlugins(uuid)

表4-76 getOAuthTokenAttributesPluginsの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

例

getOAuthTokenAttributesPlugins('12345678-1234-1234-1234-123456789012')

displayOAuthTokenAttributesPlugin

displayOAuthTokenAttributesPlugin

説明

指定されたOAuthトークン属性プラグインを表示します。

構文

displayOAuthTokenAttributesPlugin(uuid,name)

表4-77 displayOAuthTokenAttributesPluginの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

name

特定のトークン属性プラグインの名前。

例

displayOAuthTokenAttributesPlugin('12345678-1234-1234-1234-123456789012','sampleOAuthClient')

getOAuthResourceServerInterfaces

getOAuthResourceServerInterfaces

説明

すべての既存のOAuthリソース・サーバー・インタフェースを取得します。

構文

getOAuthResourceServerInterfaces(uuid)

表4-78 getOAuthResourceServerInterfacesの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

例

getOAuthResourceServerInterfaces('12345678-1234-1234-1234-123456789012')

displayOAuthResourceServerInterface

displayOAuthResourceServerInterface

説明

指定されたOAuthリソース・サーバー・インタフェースを表示します。

構文

displayOAuthResourceServerInterface(uuid,name)

表4-79 displayOAuthResourceServerInterfaceの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

name

特定のリソース・サーバー・インタフェースの名前。

例

displayOAuthResourceServerInterface('12345678-1234-1234-1234-123456789012','sampleOAuthClient')

getOAuthUserProfileResourceServers

getOAuthUserProfileResourceServers

説明

すべての既存のOAuthユーザー・プロファイル・リソース・サーバー・プラグインを取得します。

構文

getOAuthUserProfileResourceServers(uuid)

表4-80 getOAuthUserProfileResourceServersの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

例

getOAuthUserProfileResourceServers('12345678-1234-1234-1234-123456789012')

displayOAuthUserProfileResourceServer

displayOAuthUserProfileResourceServer

説明

指定されたOAuthユーザー・プロファイル・リソース・サーバー・プラグインを表示します。

構文

displayOAuthUserProfileResourceServer(uuid,name)

表4-81 displayOAuthUserProfileResourceServerの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

name

特定のユーザー・プロファイル・リソース・サーバー・プラグインの名前。

例

displayOAuthUserProfileResourceServer('12345678-1234-1234-1234-123456789012','UserProfile')

getOAuthServiceProfiles

getOAuthServiceProfiles

説明

すべての既存のOAuthサービス・プロファイルを取得します。

構文

getOAuthServiceProfiles(uuid)

表4-82 getOAuthServiceProfilesの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

例

getOAuthServiceProfiles('12345678-1234-1234-1234-123456789012')

displayOAuthServiceProfile

displayOAuthServiceProfile

説明

指定されたOAuthサービス・プロファイルを表示します。

構文

displayOAuthServiceProfile(uuid,name)

表4-83 displayOAuthServiceProfileの引数

引数

定義

uuid

アイデンティティ・ドメインの全体の一意識別子。

name

特定のサービス・プロファイルの名前。

例

displayOAuthServiceProfile('12345678-1234-1234-1234-123456789012','OAuthServiceProfile')

Oracle Access Managementセキュリティ・トークン・サービス

表4-84では、Oracle Access Managementセキュリティ・トークン・サービス(セキュリティ・トークン・サービス)で使用可能な、様々なタイプのWLSTコマンドについて説明します。

表4-84 WLSTセキュリティ・トークン・サービス・コマンド・グループ

OSTSコマンド・タイプ

説明

パートナ・コマンド

パートナに関するタスクに関連するWLSTコマンド。

リライイング・パーティ・パートナ・マッピング・コマンド

リライイング・パーティ・パートナ・マッピングに対するWS接頭辞は、WS-Trust RSTリクエストのAppliesToフィールドで指定されているサービスURLをリライイング・パーティ・タイプのパートナにマップするために使用されます。WS接頭辞文字列として、サービスURLそのもの、またはサービスURLへの親パスを持つURLを指定できます。たとえば、マッピングで、WS接頭辞(http://test.com/service)をリライイング・パーティ(RelyingPartyPartnerTest)にマップすると定義されている場合、次のサービスURLがそのリライイング・パーティにマップされます。http://test.com/service、http://test.com/service/calculatorService、http://test.com/service/shop/cart...

パートナ・プロファイル・コマンド

パートナ・プロファイルに関するタスクに関連するWLSTコマンド。

発行テンプレート・コマンド

発行テンプレートに関するタスクに関連するWLSTコマンド。

検証テンプレート・コマンド

検証テンプレートに関するタスクに関連するWLSTコマンド。

表4-85に示されているWLSTコマンドを使用して、セキュリティ・トークン・サービスを管理します。

表4-85 WLSTコマンド・セキュリティ・トークン・サービス

コマンド

用途

WLSTでの使用

パートナ・コマンド

getPartner

パートナおよび出力結果を取得します。

オンライン

getAllRequesterPartners

リクエスタ・パートナの名前を取得します。

オンライン

getAllRelyingPartyPartners

すべてのリライイング・パーティ・パートナの名前を取得します。

オンライン

getAllIssuingAuthorityPartners

すべての発行局パートナの名前を取得します。

オンライン

isPartnerPresent

セキュリティ・トークン・サービスを問い合せて、パートナがパートナ・ストア内に存在しているかどうかを判断します。

オンライン

createPartner

新しいパートナ・エントリを作成します。

オンライン

updatePartner

提供された情報に基づいて既存のパートナ・エントリを更新します。

オンライン

deletePartner

パートナ・エントリを削除します。

オンライン

getPartnerUsernameTokenUsername

パートナのユーザー名値を取得します。

オンライン

getPartnerUsernameTokenPassword

パートナのパスワード値を取得します。

オンライン

setPartnerUsernameTokenCredential

パートナ・エントリのユーザー名およびパスワード値を設定します。

オンライン

deletePartnerUsernameTokenCredential

パートナ・エントリからユーザー名およびパスワード値を削除します。

オンライン

getPartnerSigningCert

パートナのBase64エンコード署名証明書を取得します。

オンライン

getPartnerEncryptionCert

パートナのBase64エンコード暗号化証明書を取得します。

オンライン

setPartnerSigningCert

パートナ・エントリに署名証明書をアップロードします。

オンライン

setPartnerEncryptionCert

パートナ・エントリに暗号化証明書をアップロードします。

オンライン

deletePartnerSigningCert

パートナ・エントリから署名証明書を削除します。

オンライン

オフライン

deletePartnerEncryptionCert

パートナ・エントリから暗号化証明書を削除します。

オンライン

オフライン

getPartnerAllIdentityAttributes

トークンをリクエスタ・パートナにマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示します。

オンライン

オフライン

getPartnerIdentityAttribute

アイデンティティ・マッピング属性を取得して表示します。

オンライン

オフライン

setPartnerIdentityAttribute

リクエスタ・パートナのアイデンティティ・マッピング属性を設定します。

オンライン

オフライン

deletePartnerIdentityAttribute

リクエスタ・パートナのアイデンティティ・マッピング属性を削除します。

オンライン

オフライン

リライイング・パーティ・パートナ・マッピング・コマンド

getAllWSPrefixAndPartnerMappings

すべてのWS接頭辞を取得して表示します。

オンライン

オフライン

getWSPrefixAndPartnerMapping

指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示します。

オンライン

オフライン

createWSPrefixAndPartnerMapping

リライイング・パートナへの新しいWS接頭辞マッピングを作成します。

オンライン

オフライン

deleteWSPrefixAndPartnerMapping

リライイング・パートナへの既存のWS接頭辞マッピングを削除します。

オンライン

オフライン

パートナ・プロファイル・コマンド

getAllPartnerProfiles

既存のすべてのパートナ・プロファイルの名前を取得します。

オンライン

getPartnerProfile

パートナ・プロファイル構成データを取得します。

オンライン

createRequesterPartnerProfile

デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成します。

オンライン

createRelyingPartyPartnerProfile

デフォルトの構成データを使用して新しいリライイング・パーティ・パートナ・プロファイルを作成します。

オンライン

createIssuingAuthorityPartnerProfile

デフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成します。

オンライン

deletePartnerProfile

既存のパートナ・プロファイルを削除します。

オンライン

発行テンプレート・コマンド

getAllIssuanceTemplates

既存のすべての発行テンプレートの名前を取得します。

オンライン

オフライン

getIssuanceTemplate

特定の発行テンプレートの構成データを取得します。

オンライン

createIssuanceTemplate

デフォルトの構成データを使用して新しい発行テンプレートを作成します。

オンライン

deleteIssuanceTemplate

既存の発行テンプレートを削除します。

オンライン

オフライン

検証テンプレート・コマンド

getAllValidationTemplates

既存のすべての検証テンプレートの名前を取得します。

オンライン

オフライン

getValidationTemplate

特定の検証テンプレートの構成データを取得します。

オンライン

オフライン

createWSSValidationTemplate

デフォルトの構成データを使用して新しいWS-Security検証テンプレートを作成します。

オンライン

オフライン

createWSTrustValidationTemplate

デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成します。

オンライン

オフライン

deleteValidationTemplate

既存の発行テンプレートを削除します。

オンライン

オフライン

getPartner

パートナ・エントリを取得し、そのパートナの構成を出力するオンライン・コマンド。

説明

パートナ・エントリを取得し、そのパートナの構成を出力します。

構文

getPartner(partnerId)

引数

定義

partnerId

partnerId(パートナのID)を指定します。

例

次の呼出しは、パートナ・エントリを取得し、customPartnerの構成を出力します。

getPartner(partnerId="customPartner")

getAllRequesterPartners

リクエスタ・タイプのパートナを取得するオンライン・コマンド。

説明

リクエスタ・タイプのパートナを取得します。

構文

getAllRequesterPartners()

例

次の呼出しは、リクエスタ・タイプのパートナを取得します。

getAllRequesterPartners()

getAllRelyingPartyPartners

リライイング・パーティ・パートナを取得するオンライン・コマンド。

説明

リライイング・パーティ・パートナを取得します。

構文

getAllRelyingPartyPartners()

例

次の呼出しは、リライイング・パーティ・パートナを取得します。

getAllRelyingPartyPartners()

getAllIssuingAuthorityPartners

発行局パートナを取得し、結果を出力するオンライン・コマンド。

説明

発行局パートナを取得し、結果を出力します。

構文

getAllIssuingAuthorityPartners()

例

次の呼出しは、発行局パートナを取得し、その結果を出力します。

getAllIssuingAuthorityPartners()

isPartnerPresent

セキュリティ・トークン・サービスを問い合せて、指定されたパートナがパートナ・ストア内に存在しているかどうかを判断するオンライン・コマンド。

説明

セキュリティ・トークン・サービスを問い合せて、指定されたパートナがパートナ・ストア内に存在しているかどうかを判断し、結果を出力します。

構文

isPartnerPresent(partnerId)

引数

定義

partnerId

パートナのIDを指定します。

例

次の呼出しは、セキュリティ・トークン・サービスを問い合せて、customPartnerがパートナ・ストア内に存在しているかどうかを判断し、結果を出力します。

isPartnerPresent(partnerId="customPartner")

createPartner

新しいパートナ・エントリを作成するオンライン・コマンド。

説明

提供された情報に基づいて新しいパートナ・エントリを作成します。操作の結果を示すメッセージを表示します。

構文

createPartner(partnerId, partnerType, partnerProfileId, description,
bIsTrusted)

引数

定義

partnerId

作成する新しいパートナのIDを指定します。

partnerType

パートナのタイプを指定します。値として、次のいずれかを指定できます。

- リクエスタの場合は、STS_REQUESTER

- リライイング・パーティの場合は、STS_RELYING_PARTY

- 発行局の場合は、STS_ISSUING_AUTHORITY

partnerProfileId

このパートナに付加するプロファイルIDを指定します。これは、既存のパートナ・プロファイルを参照する必要があります。そのパートナ・プロファイルのタイプは、新しいパートナ・エントリのタイプに従う必要があります。

description

この新しいパートナ・エントリの説明(オプション)を指定します。

bIsTrusted

この新しいパートナを信頼するかどうかを示す値。値は次のいずれかです。

- 信頼する場合は、true

- 信頼しない場合は、false

例

次の呼出しは、STS_Requestorパートナ(customPartner, custom-partnerprofile、説明はcustom requester、信頼の値はtrue)を作成し、操作の結果を示すメッセージを表示します。

createPartner(partnerId="customPartner", partnerType="STS_REQUESTER",
partnerProfileId="custom-partnerprofile", description="custom requester",
bIsTrusted="true")

updatePartner

既存のパートナ・エントリを更新するオンライン・コマンド。

説明

提供された情報に基づいて既存のパートナ・エントリを更新します。操作の結果を示すメッセージを表示します。

構文

updatePartner(partnerId, partnerProfileId, description, bIsTrusted)

引数

定義

partnerId

更新する新しいパートナのIDを指定します。

partnerProfileId

パートナ・プロファイルIDを指定します。これは、既存のパートナ・プロファイルを参照する必要があります。そのパートナ・プロファイルのタイプは、新しいパートナ・エントリのタイプに従う必要があります。

description

この新しいパートナ・エントリの説明(オプション)を指定します。

bIsTrusted

この新しいパートナを信頼するかどうかを示す値。値は次のいずれかです。

- 信頼する場合は、true

- 信頼しない場合は、false

例

次の呼出しは、customPartnerを、新しいプロファイルID (x509-wss-validtemp)、説明(custom requester with new profile id)および信頼の値(false)で更新します。メッセージには、操作の結果が示されます。

updatePartner(partnerId="customPartner", partnerProfileId="x509-wss-validtemp",
description="custom requester with new profile id", bIsTrusted="false")

deletePartner

セキュリティ・トークン・サービスからパートナ・エントリを削除するオンライン・コマンド。

説明

セキュリティ・トークン・サービスから、partnerIdパラメータによって参照される既存のパートナ・エントリを削除し、操作の結果を出力します。

構文

deletePartner(partnerId)

引数

定義

partnerId

削除するパートナのIDを指定します。

例

次の呼出しは、セキュリティ・トークン・サービスから、partnerIdパラメータによって参照されるcustomPartnerパートナ・エントリを削除し、操作の結果を出力します。

deletePartner(partnerId="customPartner")

getPartnerUsernameTokenUsername

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナのユーザー名値を取得するオンライン・コマンド。

説明

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナのユーザー名値を取得し、値を表示します。

構文

getPartnerUsernameTokenUsername(partnerId)

引数

定義

partnerId

パートナのIDを指定します。

例

次の呼出しは、UNT資格証明パートナ検証またはマッピング操作に使用される、customPartnerパートナ・ユーザー名値を取得し、値を表示します。

getPartnerUsernameTokenUsername(partnerId="customPartner")

getPartnerUsernameTokenPassword

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナのパスワード値を取得するオンライン・コマンド。

説明

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナ・パスワード値を取得し、値を表示します。

構文

getPartnerUsernameTokenPassword(partnerId)

引数

定義

partnerId

パートナのIDを指定します。

例

次の呼出しは、UNT資格証明パートナ検証またはマッピング操作に使用される、customPartnerパートナ・パスワード値を取得し、値を表示します。

getPartnerUsernameTokenPassword(partnerId="customPartner")

setPartnerUsernameTokenCredential

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナ・エントリのユーザー名およびパスワード値を設定するオンライン・コマンド。

説明

UNT資格証明パートナ検証またはマッピング操作に使用される、パートナ・エントリのユーザー名およびパスワード値を設定します。操作の結果を表示します。

構文

setPartnerUsernameTokenCredential(partnerId, UTUsername, UTPassword)

引数

定義

partnerId

パートナのIDを指定します。

UTUsername

UNT資格証明検証またはマッピング操作に使用されるユーザー名値を指定します。

UTPassword

UNT資格証明検証またはマッピング操作に使用されるユーザー名値を指定します。

例

次の呼出しは、customPartnerパートナ・エントリのユーザー名およびパスワード値を設定し、操作の結果を表示します。

setPartnerUsernameTokenCredential(partnerId="customPartner", UTUsername="test", UTPassword="password")

deletePartnerUsernameTokenCredential

パートナ・エントリから、UNT資格証明パートナ検証またはマッピング操作に使用されるユーザー名およびパスワード値を削除し、操作の結果を表示するオンライン・コマンド。

説明

パートナ・エントリから、UNT資格証明パートナ検証またはマッピング操作に使用されるユーザー名およびパスワード値を削除し、操作の結果を表示します。

構文

deletePartnerUsernameTokenCredential(partnerId)

引数

定義

partnerId

削除するパートナのIDを指定します。

例

次の呼出しは、パートナ・エントリから、UNT資格証明パートナ検証またはマッピング操作に使用されるユーザー名およびパスワード値を削除し、操作の結果を表示します。

deletePartnerUsernameTokenCredential(partnerId="customPartner")

getPartnerSigningCert

partnerIdパラメータによって参照されるパートナのBase64エンコード署名証明書を取得し、その値をBase64エンコード文字列として表示するオンライン・コマンド。

説明

partnerIdパラメータによって参照されるパートナのBase64エンコード署名証明書を取得し、その値をBase64エンコード文字列として表示します。

構文

getPartnerSigningCert(partnerId)

引数

定義

partnerId

パートナのIDを指定します。

例

次の呼出しは、partnerIdパラメータによって参照されるパートナのBase64エンコード署名証明書を取得し、その値をBase64エンコード文字列として表示します。

getPartnerSigningCert(partnerId="customPartner")

getPartnerEncryptionCert

Base64エンコード暗号化証明書を取得し、その値をBase64エンコード文字列として表示するオンライン・コマンド。

説明

partnerIdパラメータによって参照されるパートナのBase64エンコード暗号化証明書を取得し、その値をBase64エンコード文字列として表示します。

構文

getPartnerEncryptionCert(partnerId)

引数

定義

partnerId

パートナのIDを指定します。

例

次の呼出しは、partnerIdパラメータによって参照されるパートナのBase64エンコード暗号化証明書を取得し、その値をBase64エンコード文字列として表示します。

getPartnerEncryptionCert(partnerId="customPartner")

setPartnerSigningCert

提供された証明書を署名証明書としてパートナ・エントリにアップロードするオンライン・コマンド。操作の結果を表示します。

説明

提供された証明書を署名証明書として(partnerIdパラメータによって参照される)パートナ・エントリにアップロードします。サポートされている証明書の形式は、DERおよびPEMです。操作の結果を表示します。

構文

setPartnerSigningCert(partnerId, certFile)

引数

定義

partnerId

パートナのIDを指定します。

certFile

ローカル・ファイル・システム上の証明書の場所を指定します。サポートされている証明書の形式は、DERおよびPEMです。

例

次の呼出しは、提供された証明書を署名証明書としてパートナ・エントリcustomPartnerにアップロードします。操作の結果を表示します。

setPartnerSigningCert(partnerId="customPartner", certFile="/temp/signing_cert")

setPartnerEncryptionCert

提供された証明書を暗号化証明書としてパートナ・エントリにアップロードするオンライン・コマンド。操作の結果を表示します。

説明

提供された証明書を暗号化証明書として(partnerIdパラメータによって参照される)パートナ・エントリにアップロードします。操作の結果を表示します。

構文

setPartnerEncryptionCert(partnerId, certFile)

引数

定義

partnerId

パートナのIDを指定します。

certFile

ローカル・ファイル・システム上の証明書の場所を指定します。サポートされている証明書の形式は、DERおよびPEMです。

例

次の呼出しは、提供された証明書を署名証明書としてパートナ・エントリcustomPartnerにアップロードします。操作の結果を表示します。

setPartnerSigningCert(partnerId="customPartner", certFile="/temp/signing_cert")

deletePartnerSigningCert

パートナ・エントリから暗号化証明書を削除し、操作の結果を表示するオンライン・コマンド。

説明

partnerIdパラメータによって参照されるパートナ・エントリから暗号化証明書を削除し、操作の結果を表示します。

構文

deletePartnerSigningCert(partnerId)

引数

定義

partnerId

パートナのIDを指定します。

例

次の呼出しは、パートナ・エントリcustomPartnerから暗号化証明書を削除し、操作の結果を表示します。

deletePartnerSigningCert(partnerId="customPartner")

deletePartnerEncryptionCert

パートナ・エントリから署名証明書を削除し、操作の結果を表示するオンライン・コマンド。

説明

partnerIdパラメータによって参照されるパートナ・エントリから署名証明書を削除し、操作の結果を表示します。

構文

deletePartnerEncryptionCert(partnerId)

引数

定義

partnerId

パートナのIDを指定します。

例

次の呼出しは、パートナ・エントリcustomPartnerから署名証明書を削除し、操作の結果を表示します。

deletePartnerEncryptionCert(partnerId="customPartner")

getPartnerAllIdentityAttributes

リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示するオンライン・コマンド。

説明

リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示します。

アイデンティティ・マッピング属性があるのは、リクエスタ・タイプのパートナのみです。

構文

getPartnerAllIdentityAttributes(partnerId)

引数

定義

partnerId

リクエスタ・パートナのIDを指定します。アイデンティティ・マッピング属性があるのは、リクエスタ・タイプのパートナのみです

例

次の呼出しは、リクエスタ・パートナcustomPartnerにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるすべてのアイデンティティ・マッピング属性を取得して表示します。

getPartnerAllIdentityAttributes(partnerId="customPartner")

getPartnerIdentityAttribute

リクエスタ・パートナにトークンまたはバインディング・データをマップするために使用されるアイデンティティ・マッピング属性を取得して表示するオンライン・コマンド。

説明

リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるアイデンティティ・マッピング属性を取得して表示します。

アイデンティティ・マッピング属性があるのは、リクエスタ・タイプのパートナのみです。

構文

getPartnerIdentityAttribute(partnerId, identityAttributeName)

引数

定義

partnerId

リクエスタ・パートナのIDを指定します。

IdentityAttributeName

取得および表示するアイデンティティ・マッピング属性の名前を指定します。たとえば、httpbasicusernameです。

例

次の呼出しは、identityAttributeNameによって指定されたidentityAttributeとその値を取得して表示します。

getPartnerIdentityAttribute(partnerId="customPartner", identityAttributeName="httpbasicusername")

setPartnerIdentityAttribute

リクエスタ・パートナのアイデンティティ・マッピング属性を設定するオンライン・コマンド。

説明

partnerIdパラメータによって指定されたリクエスタ・タイプのパートナに対して、identityAttributeNameによって指定されたアイデンティティ・マッピング属性を設定します。それらのアイデンティティ・マッピング属性があるのは、リクエスタ・パートナのみです。操作の結果を表示します。

構文

setPartnerIdentityAttribute(partnerId, identityAttributeName,
identityAttributeValue)

引数

定義

partnerId

リクエスタ・タイプのパートナのIDを指定します。

identityAttributeName

取得および表示するアイデンティティ・マッピング属性の名前を指定します。

identityAttributeValue

設定するアイデンティティ・マッピング属性の値を指定します。

例

次の呼出しは、partnerIdパラメータによって指定されたリクエスタ・タイプのリクエスタ・パートナに対して、identityAttributeNameによって指定されたアイデンティティ・マッピング属性を設定します。操作の結果を表示します。

setPartnerIdentityAttribute(partnerId="customPartner",
identityAttributeName="httpbasicusername",identityAttributeValue="test")

deletePartnerIdentityAttribute

アイデンティティ・マッピング属性を削除するオンライン・コマンド。

説明

identityAttributeNameによって指定されたアイデンティティ・マッピング属性を削除します。

リクエスタ・パートナにトークンまたはバインディング・データ(SSLクライアント証明書またはHTTP Basicユーザー名)をマップするために使用されるアイデンティティ・マッピング属性。それらの属性があるのは、リクエスタ・パートナのみです。

構文

deletePartnerIdentityAttribute(partnerId, identityAttributeName)

引数

定義

partnerId

パートナのIDを指定します。

identityAttributeName

削除するアイデンティティ・マッピング属性の名前を指定します。

例

次の呼出しは、リクエスタ・パートナcustomPartnerに対して、identityAttributeNameによって指定されたアイデンティティ・マッピング属性を削除します。

deletePartnerIdentityAttribute(partnerId="customPartner",
identityAttributeName="httpbasicusername")

getAllWSPrefixAndPartnerMappings

リライイング・パーティ・パートナ・マッピングに対するすべてのWS接頭辞を取得して表示するオンライン・コマンド。

説明

リライイング・パーティ・パートナ・マッピングに対するすべてのWS接頭辞を取得して表示します。

構文

getAllWSPrefixAndPartnerMappings()

例

次の呼出しは、WS接頭辞を取得して表示します。

getAllWSPrefixAndPartnerMappings()

getWSPrefixAndPartnerMapping

指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示するオンライン・コマンド(そのWS接頭辞に対するマッピングが存在する場合)。

説明

指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示します(そのWS接頭辞に対するマッピングが存在する場合)。

構文

getWSPrefixAndPartnerMapping(wsprefix)

引数

定義

wsprefix

取得および表示するWS接頭辞エントリを指定します。パスはオプションです。指定する場合は、次の形式である必要があります。

http_protocol://hostname_ip/path

例

次の呼出しは、指定されたwsprefixパラメータにマップされているリライイング・パーティ・パートナを取得して表示します(そのWS接頭辞に対するマッピングが存在する場合)。

getWSPrefixAndPartnerMapping(wsprefix="http://host1.example.com/path")

createWSPrefixAndPartnerMapping

リライイング・パートナへの新しいWS接頭辞マッピングを作成するオンライン・コマンド。

説明

partneridパラメータによって参照されるリライイング・パートナへの新しいWS接頭辞マッピングを作成し、操作の結果を表示します。

構文

createWSPrefixAndPartnerMapping(wsprefix, partnerid, description)

引数

定義

wsprefix

取得および表示するWS接頭辞エントリを指定します。パスはオプションです。指定する場合は、次の形式である必要があります。

http_protocol://hostname_ip/path

partnerId

パートナのIDを指定します。

description

説明を指定します(オプション)。

例

次の呼出しは、partneridパラメータによって参照されるリライイング・パートナへの新しいWS接頭辞マッピングを作成し、操作の結果を表示します。

createWSPrefixAndPartnerMapping(wsprefix="http://host1.example.com/path",
partnerid="customRPpartner", description="some description")

deleteWSPrefixAndPartnerMapping

リライイング・パートナへのWS接頭辞の既存のマッピングを削除するオンライン・コマンド。

説明

リライイング・パートナへのWS接頭辞の既存のマッピングを削除し、操作の結果を表示します。

構文

deleteWSPrefixAndPartnerMapping(wsprefix)

引数

定義

wsprefix

取得および表示するWS接頭辞エントリを指定します。パスはオプションです。指定する場合は、次の形式である必要があります。

http_protocol://hostname_ip/path

例

次の呼出しは、リライイング・パートナへのWS接頭辞の既存のマッピングを削除し、操作の結果を表示します。

deleteWSPrefixAndPartnerMapping(wsprefix="http://host1.example.com/path")

getAllPartnerProfiles

既存のすべてのパートナ・プロファイルの名前を取得し、それらを表示するオンライン・コマンド。

説明

既存のすべてのパートナ・プロファイルの名前を取得し、それらを表示します。

構文

getAllPartnerProfiles()

例

次の呼出しは、既存のすべてのパートナ・プロファイルの名前を取得し、それらを表示します。

getAllPartnerProfiles()

getPartnerProfile

特定のパートナ・プロファイルの構成データを取得し、そのプロファイルのコンテンツを表示するオンライン・コマンド。

説明

partnerProfileIdパラメータによって参照されるパートナ・プロファイルの構成データを取得し、そのプロファイルのコンテンツを表示します。

構文

getPartnerProfile(partnerProfileId)

引数

定義

partnerProfileId

パートナ・プロファイルの名前を指定します。

例

次の呼出しは、partnerProfileIdパラメータによって参照されるパートナ・プロファイルの構成データを取得し、そのプロファイルのコンテンツを表示します。

getPartnerProfile(partnerProfileId="custom-partnerprofile")

createRequesterPartnerProfile

デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成するオンライン・コマンド。

説明

デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成し、操作の結果を表示します。

表4-86では、このコマンドで作成されるデフォルト構成について説明します。

表4-86 デフォルト構成: createRequesterPartnerProfile

要素

説明

Return Error for Missing Claims

デフォルト: false

Allow Unmapped Claims

デフォルト: false

Token Type Configuration

「トークン・タイプ構成」表には、次のエントリが含まれます。WS-Trust検証テンプレートへのトークン・タイプのマッピングはありません。

- 次の外部URIにマップされているSAML 1.1トークン・タイプ:

http://docs.oasis-open.org/wss/oasis-wss-saml-
token-profile-1.1#SAMLV1.1

SAML 1.1トークン・タイプは、どのWS-Trust検証テンプレートにもマップされません。

- 次の外部URIにマップされているSAML 2.0トークン・タイプ:

http://docs.oasis-open.org/wss/oasis-wss-saml-
token-profile-1.1#SAMLV2.0

SAML 2.0トークン・タイプは、どのWS-Trust検証テンプレートにもマップされません。

- 次の外部URIにマップされているユーザー名トークン・タイプ:

http://docs.oasis-open.org/wss/2004/01/oasis-
200401-wss-username-token-profile-1.0#UsernameToken

ユーザー名トークン・タイプは、どのWS-Trust検証テンプレートにもマップされません。

注意: トークン・タイプ構成、および検証テンプレート・マッピングに対するトークン・タイプはいずれも空になります

Attribute Name Mapping

デフォルト: Attribute Name Mapping表は、デフォルトでは空です。

構文

createRequesterPartnerProfile(partnerProfileId, defaultRelyingPartyPPID,
description)

引数

定義

partnerProfileId

パートナ・プロファイルの名前を指定します。

defaultRelyingPartyPPID

RSTにAppliesToフィールドがない場合、またはAppliesToフィールドをリライイング・パーティ・パートナにマップできない場合に使用するリライイング・パーティ・パートナ・プロファイルを指定します。

description

このパートナ・プロファイルの説明(オプション)を指定します

例

次の呼出しは、デフォルトの構成データを使用して新しいリクエスタ・パートナ・プロファイルを作成し、操作の結果を表示します。デフォルト・データの説明については、表4-86を参照してください。

createRequesterPartnerProfile(partnerProfileId="custom-partnerprofile",
defaultRelyingPartyPPID="rpPartnerProfileTest", description="custom
partner profile")

createRelyingPartyPartnerProfile

デフォルトの構成データを使用して新しいリライイング・パーティ・パートナ・プロファイルを作成するオンライン・コマンド。

説明

デフォルトの構成データを使用して新しいリライイング・パーティ・パートナ・プロファイルを作成し、操作の結果を表示します。

表4-87では、このコマンドで作成されるデフォルト構成について説明します。

表4-87 デフォルト構成: createRelyingPartyPartnerProfile

要素

説明

ポリシーのダウンロード

デフォルト: false

マップされていない要求を許可

デフォルト: false

トークン・タイプ構成

「トークン・タイプ構成」には、次のような単一のエントリが含まれます。

- トークン・タイプが、defaultIssuanceTemplateIDによって参照される発行テンプレートのタイプに設定されている

- 発行テンプレートがdefaultIssuanceTemplateIDに設定されている

注意: defaultIssuanceTemplateIDによって参照される発行テンプレートのトークン・タイプは、発行テンプレートにリンクされますが、他のトークン・タイプは、どの発行テンプレートにもリンクされません。

defaultIssuanceTemplateIDによって参照される発行テンプレートがカスタム・トークン・タイプの発行テンプレートである場合、表には、外部URIとしてカスタム・トークン・タイプにマップされ、かつdefaultIssuanceTemplateIDによって参照される発行テンプレートにマップされている、カスタム・トークン・タイプの1つのエントリのみが含まれます

属性名マッピング

「属性名マッピング」表は、デフォルトでは空です。

構文

createRelyingPartyPartnerProfile(partnerProfileId, defaultIssuanceTemplateID,
description)

引数

定義

partnerProfileId

パートナ・プロファイルの名前を指定します。

defaultIssuanceTemplateID

RSTにトークン・タイプが指定されてない場合に発行される、デフォルトの発行テンプレートおよびトークン・タイプを指定します。

description

このパートナ・プロファイルの説明(オプション)を指定します

例

次の呼出しは、デフォルトの構成データを使用して新しいリライイング・パーティ・パートナ・プロファイルを作成し、操作の結果を表示します。

createRelyingPartyPartnerProfile(partnerProfileId="custom-partnerprofile",
defaultIssuanceTemplateID="saml11-issuance-template", description="custom partner profile")

createIssuingAuthorityPartnerProfile

デフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成するオンライン・コマンド。

説明

表4-88のデフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成し、操作の結果を表示します。

表4-88 デフォルト構成: createIssuingAuthorityPartnerProfile

要素

説明

サーバー・クロック・ドリフト

デフォルト: 600秒

トークン・マッピング

「トークン・マッピング」セクションは、次のように構成されます。

- 簡易ユーザー・マッピングのオーバーライド: false

- ユーザー名前IDマッピングのオーバーライド: false

- 属性ベース・ユーザー・マッピングのオーバーライド: false

- 簡易パートナ・マッピングのオーバーライド: false

- パートナ名前IDマッピングのオーバーライド: false

空のフィールド

- 簡易ユーザー・マッピング

- 属性ベース・ユーザー・マッピング

- 簡易パートナ・マッピング

パートナ名前IDマッピング

パートナ名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされます。ただし、データストア列内にデータがない場合、defaultIssuanceTemplateIDによって参照される発行テンプレートは、トークン・タイプがSAML 1.1、SAML 2.0またはユーザー名である発行テンプレートです。

この表には、次のエントリが含まれます。

- urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName

- urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName

- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

- urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos

- urn:oasis:names:tc:SAML:2.0:nameid-format:persistent

ユーザー名前IDマッピング

ユーザー名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされます。

- urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName、空のデータストア列

- urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName、データストア列で設定されているdn

- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress、データストア列で設定されているmail

- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified、空のデータストア列

- urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos、空のデータストア列

- urn:oasis:names:tc:SAML:2.0:nameid-format:persistent、空のデータストア列

属性マッピング

「属性値マッピング」および「属性名マッピング」表は、デフォルトでは空です。

構文

createIssuingAuthorityPartnerProfile(partnerProfileId, description)

引数

定義

partnerProfileId

パートナ・プロファイルの名前を指定します。

description

このパートナ・プロファイルの説明(オプション)を指定します

例

次の呼出しは、デフォルトの構成データを使用して新しい発行局パートナ・プロファイルを作成し、操作の結果を表示します。

createIssuingAuthorityPartnerProfile(partnerProfileId="custom-partnerprofile"
description="custom partner profile")

deletePartnerProfile

partnerProfileIdパラメータによって参照されるパートナ・プロファイルを削除するオンライン・コマンド。(WLSTとSAML 1.1の使用に関する項も参照してください。)

説明

partnerProfileIdパラメータによって参照されるパートナ・プロファイルを削除し、操作の結果を表示します。

構文

deletePartnerProfile(partnerProfileId)

引数

定義

partnerProfileId

削除するパートナ・プロファイルの名前を指定します。

例

次の呼出しは、partnerProfileIdパラメータによって参照されるパートナ・プロファイルを削除し、操作の結果を表示します。

deletePartnerProfile(partnerProfileId="custom-partnerprofile")

getAllIssuanceTemplates

既存のすべての発行テンプレートの名前を取得するオンライン・コマンド。

説明

既存のすべての発行テンプレートの名前を取得し、それらを表示します。

構文

getAllIssuanceTemplates

例

次の呼出しは、既存のすべての発行テンプレートの名前を取得し、それらを表示します。

getAllIssuanceTemplates

getIssuanceTemplate

特定の発行テンプレートの構成データを取得するオンライン・コマンド。

説明

issuanceTemplateIdパラメータによって参照される発行テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。

構文

getIssuanceTemplate(issuanceTemplateId)

引数

定義

issuanceTemplateId

発行テンプレートの名前を指定します。

例

次の呼出しは、issuanceTemplateIdパラメータによって参照される発行テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。

getIssuanceTemplate(issuanceTemplateId="custom-issuancetemp")

createIssuanceTemplate

デフォルトの構成データを使用して新しい発行テンプレートを作成するオンライン・コマンド。

説明

デフォルトの構成データを使用して新しい発行テンプレートを作成し、操作の結果を表示します。

表4-89では、このコマンドのデフォルト構成について説明します。

表4-89 デフォルト構成: createIssuanceTemplate

トークン・タイプ

説明

ユーザー名

発行テンプレートは、次のデフォルト値を使用して作成されます。

- 暗号化されたトークンの送信: false

- 名前IDユーザー属性: uid

- 名前IDユーザー属性ストア: ユーザー・ストア

- パスワード属性: (空)

- Nonceを含める: true

- タイムスタンプを含める: true

SAML 1.1

または

SAML 2.0

発行テンプレートは、次のデフォルト値を使用して作成されます。

- 暗号化されたトークンの送信: false

- アサーション発行者: Access Managerホスト名

- 名前IDフォーマット: 電子メール・アドレス

- 名前IDユーザー属性: mail

- 名前IDユーザー属性ストア: ユーザー・ストア

- 名前ID修飾子: (空)

- Authn文を含める: true

- Attr文を含める: true

- アサーションの署名: true

- 署名に証明書を含める: true

- 暗号化された名前IDの送信: false (SAML 2.0のみ)

- デフォルト・サブジェクト確認メソッド: 送信者保証

- HOK対称鍵の計算: true

- HOK対称鍵生成アルゴリズム: http://www.w3.org/2001/04/xmlenc#aes128-cbc

空の表: 属性名マッピング、属性値マッピングおよび属性値フィルタ

カスタム・タイプ

発行テンプレートは、次のデフォルト値を使用して作成されます。

- 暗号化されたトークンの送信: false

構文

createIssuanceTemplate(issuanceTemplateId, tokenType, signingKeyId,
description)

引数

定義

issuanceTemplateId

作成する発行テンプレートの名前を指定します。

tokenType

指定できる値は次のとおりです:

- username: トークン・タイプがUsernameTokenであることを示します

- saml11: トークン・タイプがSAML 1.1アサーションであることを示します

- saml20: トークン・タイプがSAML 2.0アサーションであることを示します

- <other>: この場合、トークン・タイプは、カスタム・トークン・タイプであると想定され、<other>によって参照されます(<other>は値で置換します)。

signingKeyId

送信SAMLアサーションに署名するために使用されるキー・エントリ(STS一般設定のUIセクションで定義されています)を参照するkeyIDを指定します。トークン・タイプがsaml11またはsaml20である場合のみ必須です。

description

説明(オプション)。

例

次の呼出しは、デフォルトの構成データを使用して新しい発行テンプレートを作成し、操作の結果を表示します。

createIssuanceTemplate(issuanceTemplateId="custom-issuancetemp", tokenType="saml20", signingKeyId="osts_signing", description="custom issuance template")

deleteIssuanceTemplate

issuanceTemplateIdパラメータによって参照される発行テンプレートを削除し、操作の結果を表示するオンライン・コマンド。

説明

issuanceTemplateIdパラメータによって参照される発行テンプレートを削除し、操作の結果を表示します。

構文

deleteIssuanceTemplate(issuanceTemplateId)

引数

定義

issuanceTemplateId

削除する既存の発行テンプレートの名前を指定します。

例

次の呼出しは、issuanceTemplateIdパラメータによって参照される発行テンプレートを削除し、操作の結果を表示します。

deleteIssuanceTemplate(issuanceTemplateId="custom-issuancetemp")

getAllValidationTemplates

既存のすべての検証テンプレートの名前を取得するオンライン・コマンド。

説明

既存のすべての検証テンプレートの名前を取得し、それらを表示します。

構文

getAllValidationTemplates()

例

次の呼出しは、既存のすべての検証テンプレートの名前を取得し、それらを表示します。

getAllValidationTemplates()

getValidationTemplate

特定の検証テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示するオンライン・コマンド。

説明

validationTemplateIdパラメータによって参照される検証テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。

構文

getValidationTemplate(validationTemplateId)

引数

定義

validationTemplateId

既存の検証テンプレートの名前を指定します。

例

次の呼出しは、特定の検証テンプレートの構成データを取得し、そのテンプレートのコンテンツを表示します。

getValidationTemplate(validationTemplateId="custom-wss-validtemp")

createWSSValidationTemplate

デフォルトの構成データを使用して新しい検証テンプレートを作成するオンライン・コマンド。

説明

デフォルトの構成データを使用して新しいWSS検証テンプレートを作成し、操作の結果を表示します。検証テンプレートは、トークン・タイプに応じて表4-90の値を使用して作成されます。

表4-90 デフォルト構成: createWSSValidationTemplate

トークン・タイプ

説明

ユーザー名

検証テンプレートは、次のデフォルト値を使用して作成されます。

- タイムスタンプの存続期間: 600秒

- 資格証明検証の有効化: true

- 検証ソース: パートナ

- トークン・マッピング: トークンの宛先パートナのマップ

- 簡易パートナ・マッピングの有効化: true

- パートナ・データストア属性: username

SAML 1.1

または

SAML 2.0

検証テンプレートは、次のデフォルト値を使用して作成されます。

- 認証タイムアウト: 3600秒

- タイムスタンプの存続期間: 3600秒

「トークン・マッピング」セクションは、次のデフォルト値を使用して作成されます。

- トークンのマップ: トークンの宛先パートナのマップ

- 簡易ユーザー・マッピングの有効化: false

- ユーザー名前IDマッピングの有効化: false

- 属性ベース・ユーザー・マッピングの有効化: false

- 簡易パートナ・マッピングの有効化: false

- パートナ名前IDマッピングの有効化: false

空のフィールド: ユーザー・トークン属性、ユーザー・データストア属性および属性ベース・ユーザー・マッピング

さらに:

- パートナ・トークン属性: NameID

- パートナ・データストア属性: username

パートナ名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされますが、データストア列内のデータは使用されません。

- urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName

- urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName

- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

- urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos

- urn:oasis:names:tc:SAML:2.0:nameid-format:persistent

ユーザー名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされます。

- urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName、空のデータストア列

- urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName、データストア列で設定されているdn

- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress、データストア列で設定されているmail

- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified、空のデータストア列

- urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos、空のデータストア列

- urn:oasis:names:tc:SAML:2.0:nameid-format:persistent、空のデータストア列

X.509

「トークン・マッピング」セクションは、次のデフォルト値を使用して作成されます。

- トークンのマップ: トークンの宛先パートナのマップ

- 簡易ユーザー・マッピングの有効化: false

- 属性ベース・ユーザー・マッピングの有効化: false

- 簡易パートナ・マッピングの有効化: true

空のフィールド: ユーザー・トークン属性、ユーザー・データストア属性および属性ベース・ユーザー・マッピング

さらに:

- パートナ・トークン属性: DN

- パートナ・データストア属性: sslclientcertdn

Kerberos

「トークン・マッピング」セクションは、次のデフォルト値を使用して作成されます。

- トークンのマップ: トークンの宛先ユーザーのマップ

- 簡易ユーザー・マッピングの有効化: true

- 属性ベース・ユーザー・マッピングの有効化: false

- 簡易パートナ・マッピングの有効化: false

空のフィールド: パートナ・トークン属性、パートナ・データストア属性および属性ベース・ユーザー・マッピング

さらに:

- ユーザー・トークン属性: TPE_KERBEROS_PRINCIPAL_FULL

- ユーザー・データストア属性: mail

構文

createWSSValidationTemplate(templateId, tokenType,
defaultRequesterPPID, description)

引数

定義

templateId

作成する検証テンプレートの名前を指定します。

tokenType

検証テンプレートのトークン・タイプを指定します。指定できる値は次のとおりです:

- username: トークン・タイプがUsernameTokenであることを示します

- saml11: トークン・タイプがSAML 1.1アサーションであることを示します

- saml20: トークン・タイプがSAML 2.0アサーションであることを示します

- x509: トークン・タイプがX.509証明書であることを示します

- kerberos: トークン・タイプがKerberosトークンであることを示します

- oam: トークン・タイプがAccess Managerであることを示します

defaultRequesterPPID

OSTSが着信メッセージをリクエスタにマップしないように構成されている場合に使用するリクエスタ・パートナ・プロファイルを指定します。

description

説明を指定します(オプション)。

例

次の呼出しは、デフォルトの構成データを使用して新しい検証テンプレートを作成し、操作の結果を表示します。

createWSSValidationTemplate(templateId="custom-wss-validtemp", tokenType="custom",
defaultRequesterPPID="requesterPartnerProfileTest", description="custom validation
template")

createWSTrustValidationTemplate

デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成するオンライン・コマンド。

説明

デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成し、操作の結果を表示します。WS-Trust検証テンプレートは、トークン・タイプに応じて表4-91の値を使用して作成されます。

表4-91 デフォルト構成: createWSTrustValidationTemplate

トークン・タイプ

説明

ユーザー名

WS-Trust検証テンプレートは、次のデフォルト値を使用して作成されます。

- タイムスタンプの存続期間: 600秒

- 資格証明検証の有効化: false

- 検証ソース: ユーザー・ストア

- トークン・マッピング: トークンの宛先ユーザーのマップ

- 簡易ユーザー・マッピングの有効化: true

- ユーザー・データストア属性: uid

SAML 1.1

または

SAML 2.0

WS-Trust検証テンプレートは、次のデフォルト値を使用して作成されます。

- 認証タイムアウト: 3600秒

- タイムスタンプの存続期間: 3600秒

「トークン・マッピング」セクションは、次のデフォルト値を使用して作成されます。

- トークンのマップ: トークンの宛先ユーザーのマップ

- 簡易ユーザー・マッピングの有効化: false

- ユーザー名前IDマッピングの有効化: true

- 属性ベース・ユーザー・マッピングの有効化: false

空のフィールド: ユーザー・データストア属性、属性ベース・ユーザー・マッピング

ユーザー名前IDマッピング表は、名前IDフォーマットとして次のエントリを使用してプロビジョニングされます。

- urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName、空のデータストア列

- urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName、データストア列で設定されているdn

- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress、データストア列で設定されているmail

- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified、空のデータストア列

- urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos、空のデータストア列

- urn:oasis:names:tc:SAML:2.0:nameid-format:persistent、空のデータストア列

X.509

WS-Trustトークン・マッピング・セクションは、次のデフォルト値を使用して作成されます。

- トークンのマップ: トークンの宛先ユーザーのマップ

- 簡易ユーザー・マッピングの有効化: true

- 属性ベース・ユーザー・マッピングの有効化: false

- 簡易パートナ・マッピングの有効化: true

- ユーザー・トークン属性: CN

- ユーザー・データストア属性: CN

- 属性ベース・ユーザー・マッピング(空)

Kerberos

WS-Trustトークン・マッピング・セクションは、次のデフォルト値を使用して作成されます。

- トークンのマップ: トークンの宛先ユーザーのマップ

- 簡易ユーザー・マッピングの有効化: true

- 属性ベース・ユーザー・マッピングの有効化: false

- 属性ベース・ユーザー・マッピング(空)

- ユーザー・トークン属性: TPE_KERBEROS_PRINCIPAL_FULL

- ユーザー・データストア属性: mail

OAM

WS-Trustトークン・マッピング・セクションは、次のデフォルト値を使用して作成されます。

- トークンのマップ: トークンの宛先ユーザーのマップ

- 簡易ユーザー・マッピングの有効化: true

- 属性ベース・ユーザー・マッピングの有効化: false

- 属性ベース・ユーザー・マッピング(空)

- ユーザー・トークン属性: TPE_NAME_ID

- ユーザー・データストア属性: uid

custom

WS-Trustトークン・マッピング・セクションは、次のデフォルト値を使用して作成されます。

- トークンのマップ: いずれの宛先にもマップしない

- 簡易ユーザー・マッピングの有効化: false

- 属性ベース・ユーザー・マッピングの有効化: false

- 属性ベース・ユーザー・マッピング(空)

- ユーザー・トークン属性: (空)

- ユーザー・データストア属性: (空)

構文

createWSTrustValidationTemplate(templateId, tokenType, description)

引数

定義

templateId

作成するWS-Trust検証テンプレートの名前を指定します。

tokenType

WS-Trust検証テンプレートのトークン・タイプを指定します。指定できる値は次のとおりです:

- username: トークン・タイプがUsernameTokenであることを示します

- saml11: トークン・タイプがSAML 1.1アサーションであることを示します

- saml20: トークン・タイプがSAML 2.0アサーションであることを示します

- x509: トークン・タイプがX.509証明書であることを示します

- kerberos: トークン・タイプがKerberosトークンであることを示します

- oam: トークン・タイプが(デフォルトでサポートされている)Access Managerトークンであることを示します

- <other>: この場合、トークン・タイプは、カスタム・トークン・タイプであると想定され、<other>によって参照されます(<other>は値で置換します)。

description

説明を指定します(オプション)。

例

次の呼出しは、デフォルトの構成データを使用して新しいWS-Trust検証テンプレートを作成し、操作の結果を表示します。

createWSTrustValidationTemplate(templateId="custom-wss-validtemp",
tokenType="custom", description="custom validation template")

deleteValidationTemplate

検証テンプレートを削除するオンライン・コマンド。

説明

validationTemplateIdパラメータによって参照される検証テンプレートを削除し、操作の結果を表示します。

構文

deleteValidationTemplate(validationTemplateId)

引数

定義

validationTemplateId

削除する検証テンプレートの名前を指定します。

例

次の呼出しは、validationTemplateIdパラメータによって参照される検証テンプレートを削除し、操作の結果を表示します。

deleteValidationTemplate(validationTemplateId="custom-wss-validtemp")

Oracleキーストア・サービス

この項では、OPSSキーストア・サービスで使用されるコマンドについて説明します。

注意:

キーストア・サービス・コマンドを使用するには、OPSSハンドルを取得する必要があります。詳細は、Oracle Fusion Middlewareセキュリティ・ガイドのキーストア・サービスでのキーと証明書の管理に関する項を参照してください。

表4-92では、キーストア・サービスを管理するために使用されるWLSTコマンドを示します。

表4-92 OPSSキーストア・サービス・コマンド

このコマンドを使用します...

次を行うには...

changeKeyPassword

キーのパスワードを変更します。

changeKeyStorePassword

キーストアのパスワードを変更します。

createKeyStore

キーストアを作成します。

deleteKeyStore

キーストアを削除します。

deleteKeyStoreEntry

キーストア内のエントリを削除します。

exportKeyStore

キーストアをファイルにエクスポートします。

exportKeyStoreCertificate

証明書をファイルにエクスポートします。

exportKeyStoreCertificateRequest

証明書リクエストをファイルにエクスポートします。

generateKeyPair

鍵ペアを生成します。

generateSecretKey

秘密鍵を生成します。

getKeyStoreCertificates

証明書または信頼できる証明書に関する情報を取得します。

getKeyStoreSecretKeyProperties

秘密鍵プロパティを取得します。

importKeyStore

ファイルからキーストアをインポートします。

importKeyStoreCertificate

証明書または他のオブジェクトをインポートします。

listExpiringCertificates

指定された期間内に期限切れとなる証明書を一覧表示します。

listKeyStoreAliases

キーストア内の別名を一覧表示します。

listKeyStores

ストライプ内のすべてのキーストアを一覧表示します。

changeKeyPassword

キーのパスワードを変更します。

説明

キーのパスワードを変更します。

構文

svc.changeKeyPassword(appStripe='stripe', name='keystore', password='password',
alias='alias', currentkeypassword='currentkeypassword',
newkeypassword='newkeypassword')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアを含むストライプの名前を指定します

name

キーストアの名前を指定します

password

キーストアのパスワードを指定します

alias

パスワードを変更するキー・エントリの別名を指定します

currentkeypassword

キーの現在のパスワードを指定します

newkeypassword

キーの新しいパスワードを指定します

例

この例では、キー・エントリorakeyのパスワードを変更します。

svc.changeKeyPassword(appStripe='system', name='keystore', password='password',
alias='orakey', currentkeypassword='currentkeypassword',
newkeypassword='newkeypassword')

changeKeyStorePassword

キーストアのパスワードを変更します。

説明

指定されたキーストアのパスワードを変更します。

構文

svc.changeKeyStorePassword(appStripe='stripe', name='keystore', currentpassword='currentpassword', newpassword='newpassword')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアを含むストライプの名前を指定します

name

キーストアの名前を指定します

currentpassword

キーストアの現在のパスワードを指定します

newpassword

キーストアの新しいパスワードを指定します

例

この例では、keystore2のパスワードを変更します。

svc.changeKeyStorePassword(appStripe='system', name='keystore2',
currentpassword='currentpassword', newpassword='newpassword')

createKeyStore

このキーストア・サービス・コマンドは、新しいキーストアを作成します。

説明

指定されたアプリケーション・ストライプに新しいキーストアを作成します。

構文

svc.createKeyStore(appStripe='stripe', name='keystore', password='password',permission=true|false)

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが作成されるストライプの名前を指定します。

name

新しいキーストアの名前を指定します。

password

キーストアのパスワードを指定します。

permission

キーストアがパーミッションによってのみ保護される場合、このパラメータはtrueです。パーミッションとパスワードの両方によって保護される場合はfalseです。

例

この例では、keystore1という名前のキーストアを作成します。

svc.createKeyStore(appStripe='system', name='keystore1', password='password', permission=true)

deleteKeyStore

指定されたキーストアを削除します。

説明

このキーストア・サービス・コマンドは、指定されたキーストアを削除します。

構文

svc.deleteKeyStore(appStripe='stripe', name='keystore', password='password')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

削除するキーストアの名前を指定します。

password

キーストアのパスワードを指定します。

例

この例では、keystore1という名前のキーストアを削除します。

svc.deleteKeyStore(appStripe='system', name='keystore1', password='password')

deleteKeyStoreEntry

キーストア・エントリを削除します。

説明

このコマンドは、キーストア内の指定されたエントリを削除します。

構文

svc.deleteKeyStoreEntry(appStripe='stripe', name='keystore',
password='password', alias='alias', keypassword='keypassword')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

alias

削除するエントリの別名を指定します

keypassword

削除するエントリのキー・パスワードを指定します

例

この例では、別名orakeyで表されるキーストア・エントリを削除します。

svc.deleteKeyStoreEntry(appStripe='system', name='keystore2', password='password', alias='orakey', keypassword='keypassword')

exportKeyStore

キーストアをファイルにエクスポートします。

説明

指定されたファイルにキーストアをエクスポートします。

構文

svc.exportKeyStore(appStripe='stripe', name='keystore', password='password',

aliases='comma-delimited-aliases', keypasswords='comma-delimited-keypasswords',
type='keystore-type', filepath='absolute_file_path')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

aliases

エクスポートする別名のカンマ区切りのリスト。

keypasswords

別名に対応するキー・パスワードのカンマ区切りのリスト。

type

エクスポートされるキーストアのタイプ。有効な値は、JKSまたはJCEKSです。

filepath

キーストアのエクスポート先となるファイルの絶対パス。

例

この例では、指定されたキーストアから2つの別名をエクスポートします。

svc.exportKeyStore(appStripe='system', name='keystore2',
password='password',aliases='orakey,seckey',
keypasswords='keypassword1,keypassword2',
type='JKS',filepath='/tmp/file.jks')

exportKeyStoreCertificate

証明書をエクスポートします。

説明

証明書、信頼できる証明書または証明書チェーンをエクスポートします。

構文

svc.exportKeyStoreCertificate(appStripe='stripe', name='keystore',
password='password', alias='alias', keypassword='keypassword',
type='entrytype',filepath='absolute_file_path')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

alias

エクスポートするエントリの別名を指定します

keypassword

キー・パスワードを指定します。

type

エクスポートするキーストア・エントリのタイプを指定します。有効な値は、Certificate、TrustedCertificateまたはCertificateChainです。

filepath

証明書、信頼できる証明書または証明書チェーンのエクスポート先となるファイルの絶対パスを指定します。

例

この例では、別名orakeyに対応する証明書をエクスポートします。

svc.exportKeyStoreCertificate(appStripe='system', name='keystore2',
password='password', alias='orakey', keypassword='keypassword',
type='Certificate', filepath='/tmp/cert.txt')

exportKeyStoreCertificateRequest

証明書リクエストをエクスポートします。

説明

証明書リクエストを生成し、キーストアからエクスポートします。

構文

svc.exportKeyStoreCertificateRequest(appStripe='stripe', name='keystore',
password='password', alias='alias', keypassword='keypassword',
filepath='absolute_file_path')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

alias

エントリの別名を指定します。

keypassword

キー・パスワードを指定します。

filepath

証明書リクエストのエクスポート先となるファイルの絶対パスを指定します。

例

この例では、別名orakeyに対応する証明書リクエストをエクスポートします。

svc.exportKeyStoreCertificateRequest(appStripe='system', name='keystore2',
password='password', alias='orakey', keypassword='keypassword',
filepath='/tmp/certreq.txt')

generateKeyPair

キーストアに鍵ペアを生成します。

説明

キーストアに鍵ペアを生成し、デモCA署名証明書にラップします。

構文

svc.generateKeyPair(appStripe='stripe', name='keystore', password='password',
dn='distinguishedname', keysize='keysize', alias='alias',
keypassword='keypassword')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

dn

鍵ペアをラップする証明書の識別名を指定します。

keysize

キー・サイズを指定します。

alias

鍵ペア・エントリの別名を指定します。

keypassword

キー・パスワードを指定します。

例

この例では、keystore2に鍵ペアを生成します。

svc.generateKeyPair(appStripe='system', name='keystore2', password='password', dn='cn=www.oracle.com', keysize='1024', alias='orakey', keypassword='keypassword')

generateSecretKey

秘密鍵を生成します。

説明

キーストアに対称鍵を生成します。

構文

svc.generateSecretKey(appStripe='stripe', name='keystore', password='password',
algorithm='algorithm', keysize='keysize', alias='alias',
keypassword='keypassword')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

algorithm

対称鍵のアルゴリズムを指定します。

keysize

キー・サイズを指定します。

alias

キー・エントリの別名を指定します。

keypassword

キー・パスワードを指定します。

例

この例では、keystore2にキー・サイズ128の鍵ペアを生成します。

svc.generateSecretKey(appStripe='system', name='keystore2', password='password',
algorithm='AES', keysize='128', alias='seckey', keypassword='keypassword')

getKeyStoreCertificates

キーストアから証明書を取得します。

説明

証明書または信頼できる証明書に関する情報を取得します。

構文

svc.getKeyStoreCertificates(appStripe='stripe', name='keystore',
password='password', alias='alias', keypassword='keypassword')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

alias

表示する証明書、信頼できる証明書または証明書チェーンの別名を指定します。

keypassword

キー・パスワードを指定します。

例

この例では、keystore3に関連付けられている証明書を取得します。

svc.getKeyStoreCertificates(appStripe='system', name='keystore3', password='password', alias='orakey', keypassword='keypassword')

getKeyStoreSecretKeyProperties

秘密鍵のプロパティを取得します。

説明

アルゴリズムなどの秘密鍵のプロパティを取得します。

構文

svc.getKeyStoreSecretKeyProperties(appStripe='stripe', name='keystore',
password='password', alias='alias', keypassword='keypassword')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

alias

プロパティを表示する秘密鍵の別名を指定します。

keypassword

秘密鍵のパスワードを指定します。

例

この例では、秘密鍵seckeyのプロパティを取得します。

svc.getKeyStoreSecretKeyProperties(appStripe='system', name='keystore3',
password='password', alias='seckey', keypassword='keypassword')

importKeyStore

ファイルからキーストアをインポートします。

説明

システム・ファイルからキーストアをインポートします。

構文

svc.importKeyStore(appStripe='stripe', name='keystore', password='password',
aliases='comma-delimited-aliases', keypasswords='comma-delimited-keypasswords',
type='keystore-type', permission=true|false, filepath='absolute_file_path')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

aliases

ファイルからインポートするエントリのカンマ区切りの別名を指定します。

keypasswords

ファイル内のキーのカンマ区切りのパスワードを指定します。

type

インポートされるキーストアのタイプを指定します。有効な値は、JKSまたはJCEKSです。

filepath

インポートするキーストア・ファイルの絶対パスを指定します。

permission

キーストアがパーミッションによってのみ保護される場合はtrue、パーミッションとパスワードの両方によって保護される場合はfalseを指定します。

例

この例では、keystore2にファイルをインポートします。

svc.importKeyStore(appStripe='system', name='keystore2',
password='password',aliases='orakey,seckey', keypasswords='keypassword1,
keypassword2', type='JKS', permission=true, filepath='/tmp/file.jks')

importKeyStoreCertificate

証明書または指定された他のオブジェクトをインポートします。

説明

証明書、信頼できる証明書または証明書チェーンをインポートします。

構文

svc.importKeyStoreCertificate(appStripe='stripe', name='keystore',
password='password', alias='alias', keypassword='keypassword',
type='entrytype',filepath='absolute_file_path')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

alias

インポートするエントリの別名を指定します。

keypassword

新たにインポートされるエントリのキー・パスワードを指定します。

type

インポートするキーストア・エントリのタイプを指定します。有効な値は、Certificate、TrustedCertificateまたはCertificateChainです。

filepath

証明書、信頼できる証明書または証明書チェーンのインポート元となるファイルの絶対パスを指定します。

例

この例では、keystore2に証明書をインポートします。

svc.importKeyStoreCertificate(appStripe='system', name='keystore2',
password='password', alias='orakey', keypassword='keypassword',
type='Certificate', filepath='/tmp/cert.txt')

listExpiringCertificates

期限切れになる証明書を一覧表示します。

説明

期限切れになる証明書を一覧表示し、オプションでそれらの期限を更新します。

構文

svc.listExpiringCertificates(days='days', autorenew=true|false)

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

days

日数を指定します。リストには、指定された日数内に期限切れとなる証明書のみが含まれます。

autorenew

期限切れとなる証明書を自動的に更新する場合はtrue、それらを一覧表示するのみの場合はfalseを指定します。

例

この例では、1年以内に期限切れとなる証明書を一覧表示し、それらの更新を要求します。

svc.listExpiringCertificates(days='365', autorenew=true)

listKeyStoreAliases

キーストア内の別名を一覧表示します。

説明

キーストア内の、指定されたエントリ・タイプの別名を一覧表示します。

構文

構文は次のとおりです:

svc.listKeyStoreAliases(appStripe='stripe', name='keystore',
password='password', type='entrytype')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアが存在するストライプの名前を指定します。

name

キーストアの名前を指定します。

password

キーストアのパスワードを指定します。

type

別名を一覧表示するエントリのタイプを指定します。有効な値は、Certificate、TrustedCertificate、SecretKeyまたは*です。

例

この例では、keystore2内の秘密鍵を一覧表示します。

svc.listKeyStoreAliases(appStripe='system', name='keystore2',
password='password', type='SecretKey')

listKeyStores

ストライプ内のすべてのキーストアを一覧表示します。

説明

指定されたストライプ内のすべてのキーストアを一覧表示します。

構文

svc.listKeyStores(appStripe='stripe')

引数

定義

svc

getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。

appStripe

キーストアを一覧表示するストライプの名前を指定します。

例

この例では、すべてのストライプ上のすべてのキーストアを一覧表示します。

svc.listKeyStores(appStripe='*')

アイデンティティ・ディレクトリ・サービス・コマンド

表4-93に示されているWLSTコマンドを使用して、アイデンティティ・ディレクトリ・サービス・エンティティ属性、エンティティ定義、関係およびデフォルトの操作構成を管理します。

表4-93 WLSTアイデンティティ・ディレクトリ・サービス・コマンド

コマンド

用途

WLSTでの使用

activateIDSConfigChanges

アイデンティティ・ディレクトリ・サービス構成を再ロードします

オンライン

addAttributeInEntityConfig

エンティティ構成に新しい属性を追加します

オンライン

addAttributeRefForEntity

指定されたエンティティに新しい属性を追加します

オンライン

addEntity

エンティティ構成に新しいエンティティを追加します

オンライン

addEntityRelation

エンティティ構成に新しいエンティティ関係を追加します

オンライン

addIdentityDirectoryService

構成に新しいアイデンティティ・ディレクトリ・サービスを追加します

オンライン

addOperationConfig

エンティティ構成に新しい操作構成を追加します

オンライン

addPropertyForOperationConfig

指定された操作構成に新しいプロパティを追加します

オンライン

deleteAttributeInEntityConfig

エンティティ構成から属性を削除します

オンライン

deleteEntity

エンティティ構成からエンティティを削除します

オンライン

deleteEntityRelation

指定されたエンティティ関係を削除します

オンライン

deleteIdentityDirectoryService

構成内の指定されたアイデンティティ・ディレクトリ・サービスを削除します

オンライン

deleteOperationConfig

エンティティ構成内の操作構成を削除します

オンライン

listAllAttributeInEntityConfig

エンティティ構成内のすべての属性を一覧表示します

オンライン

listAllEntityInEntityConfig

指定されたエンティティ構成内に定義されているすべてのエンティティを一覧表示します

オンライン

listAllIdentityDirectoryService

構成内のアイデンティティ・ディレクトリ・サービスをすべて削除します

オンライン

removeAttributeRefForEntity

指定されたエンティティから属性を削除します

オンライン

removePropertyForOperationConfig

指定された操作構成のプロパティを削除します

オンライン

activateIDSConfigChanges

activateIDSConfigChanges

説明

アイデンティティ・ディレクトリ・サービス構成を再ロードします

構文

activateIDSConfigChanges()

このコマンドには、引数はありません。

例

activateIDSConfigChanges()

addAttributeInEntityConfig

addAttributeInEntityConfig

説明

エンティティ構成に新しい属性を追加します

構文

addAttributeInEntityConfig(name, datatype, description, readOnly, pwdAttr, appName)

表4-94 addAttributeInEntityConfigの引数

引数

定義

name

追加する属性の名前

datatype

属性のタイプは、次のいずれかとして定義されます。

- binary

- boolean

- datetime

- double

- integer

- rfc822name

- string

- x500name

description

追加する属性の説明

readOnly

属性が読取り専用であるか、変更可能であるかを指定するフラグ

pwdAttr

属性でパスワードが定義されるかどうかを指定するフラグ

appName

アイデンティティ・ディレクトリ・サービスの名前

例

addAttributeInEntityConfig('commonname','string','common name',false,false,'userrole')

addAttributeRefForEntity

addAttributeRefForEntity

説明

指定されたエンティティに新しい属性を追加します

構文

addAttributeRefForEntity(name, attrRefName, attrRefFilter, attrRefDefaultFetch, appName)

表4-95 addAttributeRefForEntityの引数

引数

定義

name

属性の追加先となるエンティティの名前

attrRefName

エンティティに追加する属性の名前

attrRefFilter

属性で使用されるフィルタのタイプは、次のいずれかとして定義されます。

- beginswith

- contains

- doesnotcontain

- dynamic

- endswith

- equals

- greaterequal

- greaterthan

- lessequal

- lessthan

- none

- notequals

attrRefDefaultFetch

属性がデフォルトでフェッチされるかどうかを指定するフラグ

appName

アイデンティティ・ディレクトリ・サービスの名前

例

addAttributeRefForEntity('User','givenname','none','true','userrole')

addEntity

addEntity

説明

エンティティ構成に新しいエンティティを追加します

構文

addEntity(name, type, idAttr, create, modify, delete, search, attrRefNames, attrRefFilters, attrRefDefaultFetches, appName)

表4-96 addEntityの引数

引数

定義

name

属性の追加先となるエンティティの名前

type

エンティティに追加する属性の名前

idAttr

追加するエンティティのアイデンティティ属性

create

作成が許可されていることを指定するフラグ

modify

変更が許可されていることを指定するフラグ

delete

削除が許可されていることを指定するフラグ

search

検索が許可されていることを指定するフラグ

attrRefNames

属性名の配列

attrRefFilters

フィルタ・タイプ値の配列は、次のいずれかとして定義されます。

- beginswith

- contains

- doesnotcontain

- dynamic

- endswith

- equals

- greaterequal

- greaterthan

- lessequal

- lessthan

- none

- notequals

attrRefDefaultFetches

ブール文字列の配列(true、false)。

appName

アイデンティティ・ディレクトリ・サービスの名前

例

addEntity('Group','group','commonname',true,true,true,true,'name|commonname','none|none','true|false','userrole')

addEntityRelation

addEntityRelation

説明

エンティティ構成に新しいエンティティ関係を追加します

構文

addEntityRelation(name, type, fromEntity, fromAttr, toEntity, toAttr, recursive, appName)

表4-97 addEntityRelationの引数

引数

定義

name

指定された属性のエンティティ間の関係の名前

type

エンティティ関係のタイプ(ManyToMany、ManyToOne、OneToMany、OneToOne)。

fromEntity

関係元となるエンティティの名前

fromAttr

関係元となる属性の名前

toEntity

関係先となるエンティティの名前

toAttr

関係先となる属性の名前

recursive

エンティティ関係を再帰的として設定するフラグ

appName

アイデンティティ・ディレクトリ・サービスの名前

例

addEntityRelation('manager', 'ManyToOne', 'User', 'manager', 'User', 'principal', false, 'userrole')

addIdentityDirectoryService

addIdentityDirectoryService

説明

アイデンティティ・ディレクトリ・サービス構成に新しいIdentityStoreServiceを追加します

構文

addIdentityDirectoryService(name, description, propNames, propValues)

表4-98 addIdentityDirectoryServiceの引数

引数

定義

name

追加するIdentityStoreServiceの名前

description

IdentityStoreServiceの説明

propNames

IdentityStoreService構成に追加するプロパティ名の配列

propValues

IdentityStoreService構成に追加するプロパティ名に対して定義される値の配列

例

addIdentityDirectoryService('userrole', 'user role', 'ovd.context|entity.config', 'default|userrole')

addOperationConfig

addOperationConfig

説明

エンティティ構成に新しい操作構成を追加します

構文

addOperationConfig(entityName, propNames, propValues, appName)

表4-99 addOperationConfigの引数

引数

定義

entityName

操作構成の追加先となるエンティティの名前

propNames

操作構成に追加するプロパティ名の配列

propValues

操作構成に追加するプロパティのプロパティ値の配列

appName

アイデンティティ・ディレクトリ・サービスの名前

例

addOperationConfig('User', 'entity.searchbase', 'cn=users,dc=oracle,dc=com', 'userrole')

addPropertyForOperationConfig

addPropertyForOperationConfig

説明

指定された操作構成に新しいプロパティを追加します

構文

addPropertyForOperationConfig(entityName, propName, propValue, appName)

表4-100 addPropertyForOperationConfigの引数

引数

定義

entityName

操作構成の追加先となるエンティティの名前

propName

操作構成に追加するプロパティ名

propValue

操作構成に追加するプロパティの値

appName

アイデンティティ・ディレクトリ・サービスの名前

例

addPropertyForOperationConfig('User','entity.searchbase', 'cn=users,dc=oracle,dc=com', 'userrole')

deleteAttributeInEntityConfig

deleteAttributeInEntityConfig

説明

エンティティ構成から属性を削除します

構文

deleteAttributeInEntityConfig(name, appName)

表4-101 addPropertyForOperationConfigの引数

引数

定義

name

削除する属性の名前

appName

アイデンティティ・ディレクトリ・サービスの名前

例

deleteAttributeInEntityConfig('commonname', 'userrole')

deleteEntity

deleteEntity

説明

エンティティ構成からエンティティを削除します

構文

deleteEntity(name, appName)

表4-102 deleteEntityの引数

引数

定義

name

削除するエンティティの名前

appName

アイデンティティ・ディレクトリ・サービスの名前

例

deleteEntity('User', 'userrole')

deleteEntityRelation

deleteEntityRelation

説明

指定されたエンティティ関係を削除します

構文

deleteEntityRelation(name, appName)

表4-103 deleteEntityRelationの引数

引数

定義

name

指定された属性のエンティティ間の関係の名前

appName

アイデンティティ・ディレクトリ・サービスの名前

例

deleteEntityRelation('manager', 'userrole')

deleteIdentityDirectoryService

deleteIdentityDirectoryService'

説明

アイデンティティ・ディレクトリ・サービス構成内の指定されたIdentityStoreServiceを削除します

構文

deleteIdentityDirectoryService(name)

ここで、nameは、削除するIdentityStoreService構成の名前です。

例

deleteIdentityDirectoryService('ids1')

deleteOperationConfig

deleteOperationConfig

説明

エンティティ構成内の操作構成を削除します

構文

deleteOperationConfig(entityName, appName)

表4-104 deleteOperationConfigの引数

引数

定義

entityName

操作構成の削除元となるエンティティの名前

appName

アイデンティティ・ディレクトリ・サービスの名前

例

deleteOperationConfig('User','userrole')

listAllAttributeInEntityConfig

listAllAttributeInEntityConfig

説明

エンティティ構成内のすべての属性を一覧表示します

構文

listAllAttributeInEntityConfig(appName)

ここで、appNameは、属性のリストの取得元となるエンティティ構成を含むアイデンティティ・ディレクトリ・サービスの名前です。

例

listAllAttributeInEntityConfig('userrole')

listAllEntityInEntityConfig

listAllEntityInEntityConfig

説明

指定されたエンティティ構成内に定義されているすべてのエンティティを一覧表示します

構文

listAllEntityInEntityConfig(appName)

ここで、appNameは、エンティティのリストの取得元となるエンティティ構成を含むアイデンティティ・ディレクトリ・サービスの名前です。

例

listAllEntityInEntityConfig('userrole')

listAllIdentityDirectoryService

listAllIdentityDirectoryService

説明

アイデンティティ・ディレクトリ・サービス構成内のすべてのIdentityStoreServiceを一覧表示します

構文

listAllIdentityDirectoryService()

このコマンドには、引数はありません。

例

listAllIdentityDirectoryService()

removeAttributeRefForEntity

removeAttributeRefForEntity

説明

指定されたエンティティから属性を削除します

構文

removeAttributeRefForEntity(name, attrRefName, appName)

表4-105 removeAttributeRefForEntityの引数

引数

定義

name

属性の削除元となるエンティティの名前

attrRefName

削除する属性の名前

appName

アイデンティティ・ディレクトリ・サービスの名前

例

removeAttributeRefForEntity('User','givenname','userrole')

removePropertyForOperationConfig

removePropertyForOperationConfig

説明

指定された操作構成のプロパティを削除します

構文

removePropertyForOperationConfig(entityName, propName, appName)

表4-106 removePropertyForOperationConfigの引数

引数

定義

entityName

操作構成の追加先となるエンティティの名前

propName

操作構成に追加するプロパティ名

appName

アイデンティティ・ディレクトリ・サービスの名前

例

removePropertyForOperationConfig('User','entity.searchbase','userrole')

Oracle Virtual Directoryライブラリ(LibOVD)コマンド

表4-107に示されているWLSTコマンドを使用して、Oracle Virtual Directoryライブラリ(LibOVD) LDAPおよび結合アダプタ構成を管理します。これらのコマンドは、パラメータとして渡される特定のOPSSコンテキストに関連付けられているOVD構成で機能します。

表4-107 WLST LibOVDコマンド

使用するコマンド

目的

WLSTでの使用

activateLibOVDConfigChanges

LibOVD構成を再ロードします

オンライン

addAttributeExclusionRule

属性除外ルールを追加します

オンライン

addAttributeRule

新しい属性マッピング・ルールを追加します

オンライン

addDomainExclusionRule

ドメイン除外ルールを追加します

オンライン

addDomainRule

新しいドメイン・マッピング・ルールを追加します

オンライン

addJoinRule

指定されたOPSSコンテキストに関連付けられているOVDの既存の結合アダプタに結合ルールを追加します

オンライン

addLDAPHost

既存のLDAPアダプタに新しいリモート・ホストを追加します

オンライン

addMappingContext

新しいマッピング・コンテキストを作成します

オンライン

addPlugin

既存のアダプタに、またはグローバル・レベルでプラグインを追加します

オンライン

addPluginParam

既存のアダプタ・レベル・プラグインまたはグローバル・プラグインに新しいパラメータ値を追加します

オンライン

createJoinAdapter

指定されたOPSSコンテキストに関連付けられているOVDの新しい結合アダプタを作成します

オンライン

createLDAPAdapter

指定されたOPSSコンテキストに関連付けられているOVDの新しいLDAPアダプタを作成します

オンライン

deleteAdapter

指定されたOPSSコンテキストに関連付けられているOVDの既存のアダプタを削除します

オンライン

deleteAttributeExclusionRule

属性除外ルールを削除します

オンライン

deleteAttributeRule

属性マッピング・ルールを削除します

オンライン

deleteDomainExclusionRule

ドメイン除外ルールを削除します

オンライン

deleteDomainRule

ドメイン・マッピング・ルールを削除します

オンライン

deleteMappingContext

指定されたマッピング・コンテキストを削除します

オンライン

getAdapterDetails

指定されたOPSSコンテキストに関連付けられているOVDに対して構成されている既存のアダプタの詳細を表示します

オンライン

listAdapters

指定されたOPSSコンテキストに関連付けられているこのOVDに対して構成されているすべてのアダプタの名前とタイプを一覧表示します

オンライン

listAllMappingContextIds

すべてのマッピング・コンテキストを一覧表示します

オンライン

listAttributeRules

すべての属性ルールを一覧表示します

オンライン

listDomainRules

すべてのドメイン・ルールを一覧表示します

オンライン

modifyLDAPAdapter

既存のLDAPアダプタ構成を変更します

オンライン

removeJoinRule

指定されたOPSSコンテキストに関連付けられているこのOVDに対して構成されている結合アダプタから結合ルールを削除します

オンライン

removeLDAPHost

既存のLDAPアダプタ構成からリモート・ホストを削除します

オンライン

removePlugin

既存のアダプタから、またはグローバル・レベルでプラグインを削除します

オンライン

removePluginParam

構成済のアダプタ・レベル・プラグインまたはグローバル・プラグインから既存のパラメータを削除します

オンライン

activateLibOVDConfigChanges

activateLibOVDConfigChanges

説明

LibOVD構成を再ロードします。

構文

activateLibOVDConfigChanges(contextName)

ここで、contextNameは、OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前です。このオプションのパラメータのデフォルト値はdefaultです。

例

activateLibOVDConfigChanges('default')

addAttributeExclusionRule

addAttributeExclusionRule

説明

属性除外ルールを追加します。

構文

addAttributeExclusionRule(attribute, mappingContextId, contextName)

表4-108 addAttributeExclusionRuleの引数

引数

定義

attribute

除外リストに追加する属性の名前

mappingContextId

マッピング・コンテキストの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addAttributeExclusionRule('objectsid')

addAttributeRule

addAttributeRule

説明

新しい属性マッピング・ルールを追加します。

構文

addAttributeRule(srcAttrs, srcObjectClass, srcAttrType, dstAttr, dstObjectClass, dstAttrType, mappingExpression, direction, mappingContextId, contextName)

表4-109 addAttributeRuleの引数

引数

定義

mappingContextId

マッピング・コンテキストの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addAttributeRule('lastname','','','sn','','','','Inbound')

addDomainExclusionRule

addDomainExclusionRule

説明

ドメイン除外ルールを追加します。

構文

addDomainExclusionRule(domain, mappingContextId, contextName)

表4-110 addDomainExclusionRuleの引数

引数

定義

domain

除外リストに追加する属性の識別名(DN)

mappingContextId

マッピング・コンテキストの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addDomainExclusionRule('cn=group,dc=oracle,dc=com')

addDomainRule

addDomainRule

説明

新しいドメイン・マッピング・ルールを追加します。

構文

addDomainRule(srcDomain, destDomain, domainConstructRule, mappingContextId, contextName)

表4-111 deleteEntityRelationの引数

引数

定義

srcDomain

destDomain

domainConstructRule

除外リストに追加する属性の名前

mappingContextId

マッピング・コンテキストの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addDomainRule('dc=oracle,dc=com', 'dc=oracle,dc=com', '', 'defaultContext', 'default')

addJoinRule

addJoinRule

説明

指定されたOPSSコンテキストに関連付けられているOVDの既存の結合アダプタに結合ルールを追加します。

構文

addJoinRule(adapterName=<adapterName>, secondary=<secondary>, condition=<condition>, joinerType=<joinerType>, contextName=<contextName>)

表4-112 addJoinRuleの引数

引数

定義

adapterName

変更する結合アダプタの名前

secondary

結合先のアダプタの名前

condition

結合する属性

joinerType

結合のタイプを定義するオプションのパラメータ。許容される値は、Simple(デフォルト)、Conditional、OneToManyまたはShadowです。

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addJoinRule('join1','secondaryldap','cn=cn', 'Simple', 'default')addJoinRule('join1','secondaryldap','cn=cn', 'Conditional', 'default')addJoinRule(adapterName='join1', secondary='LDAP3', condition='uid=cn', JoinerType='OneToMany')addJoinRule(adapterName='join1', secondary='LDAP2',condition='uid=cn', contextName='myContext')

addLDAPHost

addLDAPHost

説明

既存のLDAPアダプタに新しいリモート・ホスト(host:portペア)を追加します。デフォルトでは、新しいホストは、読取り-書込みモード(パーセンテージは100に設定されます)で構成されます。

構文

addLDAPHost(adapterName=<adapterName>, host=<host>, port=<port>, contextName=<contextName>)

表4-113 addLDAPHostの引数

引数

定義

adapterName

変更する結合アダプタの名前

host

LDAPアダプタの通信先となるリモートLDAPホスト

port

リモートLDAPホストのポート

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addLDAPHost(adapterName='ldap1', host='myhost.example.com', port=389)addLDAPHost('ldap1', 'myhost.example.com','389', 'myContext')

addMappingContext

addMappingContext

説明

新しいマッピング・コンテキストを作成します。

構文

addMappingContext(mappingContextId, contextName)

表4-114 addMappingContextの引数

引数

定義

mappingContextId

マッピング・コンテキストの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addMappingContext('defaultContext','context)

addPlugin

addPlugin

説明

既存のアダプタに、またはグローバル・レベルでプラグインを追加します。i番目のキーはi番目の値に対応しています。プラグインは、デフォルト・チェーンに追加されます。

構文

addPlugin(pluginName=<pluginName>, pluginClass=<pluginClass>, paramKeys=<paramKeys>, paramValues=<paramValues>, adapterName=<adapterName>, contextName=<contextName>)

表4-115 addPluginの引数

引数

定義

pluginName

pluginName - 作成するプラグインの名前

pluginClass

プラグインのクラス

paramKeys

|で区切られた初期化パラメータ・キー。

paramValues

|で区切られた初期化パラメータ値。

adapterName

変更するアダプタの名前。指定しない場合、プラグインは、グローバル・レベルで追加されます。

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addPlugin(adapterName='ldap1', pluginName='VirtualAttr',pluginClass='oracle.ods.virtualization.engine.chain.plugins.virtualattr.VirtualAttributePlugin', paramKeys='AddAttribute | MatchFilter | ContainerDN', paramValues='cn=%uid% | objectclass=person | dc=oracle,dc=com')addPlugin(pluginName='VirtualAttr',pluginClass='oracle.ods.virtualization.engine.chain.plugins.virtualattr.VirtualAttributePlugin', paramKeys='AddAttribute | MatchFilter | ContainerDN', paramValues='cn=%uid% | objectclass=person | dc=oracle,dc=com'))

addPluginParam

addPluginParam

説明

既存のアダプタ・レベル・プラグインまたはグローバル・プラグインに新しいパラメータ値を追加します。パラメータがすでに存在している場合、既存の値のセットに新しい値が追加されます。i番目のキーはi番目の値に対応しています。

構文

addPluginParam(pluginName=<pluginName>, paramKeys=<paramKeys>, paramValues=<paramValues>, adapterName=<adapterName>, contextName=<contextName>)

表4-116 addPluginParamの引数

引数

定義

pluginName

pluginName - 変更するプラグインの名前

paramKeys

|で区切られた初期化パラメータ・キー。

paramValues

|で区切られた初期化パラメータ値。

adapterName

変更するアダプタの名前。指定しない場合、グローバル・プラグインが変更されます。

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

addPluginParam(adapterName='ldap1', pluginName='VirtualAttr', paramKeys='ReplaceAttribute | MatchFilter', paramValues='cn=%uid% | objectclass=person')addPluginParam(pluginName='VirtualAttr', paramKeys='ReplaceAttribute | MatchFilter', par)

createJoinAdapter

createJoinAdapter

説明

指定されたOPSSコンテキストに関連付けられているOVDの新しい結合アダプタを作成します。

構文

createJoinAdapter(contextName=<contextName>, adapterName=<adapterName>, root=<root>, primaryAdapter=<primaryAdapter>, bindAdapter=<bindAdapter>)

表4-117 createJoinAdapterの引数

引数

定義

adapterName

作成する結合アダプタの名前

mappingContextId

結合アダプタの仮想ネームスペース

primaryAdapter

プライマリ・アダプタ(結合操作で最初に検索されるアダプタ)の識別子を指定します。

root

bindAdapter

バインド・アダプタ(LDAP操作でそのプロキシ・アカウントがバインドに使用されるアダプタ)の識別子を指定します。デフォルトでは、primaryAdapterはbindAdapterに設定されます。

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

createJoinAdapter('join1','dc=join','primaryldap','myldap', 'myContext')createJoinAdapter(adapterName='join1', root='dc=join', primaryAdapter='myldap')

createLDAPAdapter

createLDAPAdapter

説明

指定されたOPSSコンテキストに関連付けられているOVDの新しいLDAPアダプタを作成します。

構文

createLDAPAdapter(adapterName=<adapterName>, root=<root>, host=<host>, port=<port>, remoteBase=<remoteBase>, isSecure=<true|false>, bindDN=<bindDN>, bindPasswd=<bindPasswd>, passCred=<passCred>, contextName=<contextName>)

表4-118 createLDAPAdapterの引数

引数

定義

adapterName

作成するLDAPアダプタの名前

root

LDAPアダプタの仮想ネームスペース

host

LDAPアダプタの通信先となるリモートLDAPホスト

port

リモートLDAPホストのポート番号

remoteBase

ルートが対応するリモートDIT内の場所。

isSecure

trueとして定義された場合、リモート・ホストへのセキュアなSSL/TLS接続を可能にするオプションのパラメータ。デフォルト値はfalseです。

bindDN

リモート・ホストとの通信に使用されるプロキシのBindDN。オプションのパラメータ(デフォルト値は"")。

bindPasswd

リモート・ホストとの通信に使用されるプロキシのBindPasswd。オプションのパラメータ(デフォルト値は"")。

passCred

このオプションのパラメータは、OVDがバックエンド(リモート・ホスト)LDAPサーバーにどのような資格証明を渡すかを制御します(資格証明がある場合)。値として、Always(デフォルト)、NoneまたはBindOnlyを指定できます。

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

createLDAPAdapter("testLDAP", "dc=us,dc=oracle,dc=com", "myhost.example.com", 3060, "dc=uk,dc=oid", false, "cn=testuser", "welcome1", "Always", "myContext")createLDAPAdapter(adapterName='ldap1', root='dc=com', host='myhost.example.com', port=5566, remoteBase='dc=oid')

deleteAdapter

deleteAdapter

説明

指定されたOPSSコンテキストに関連付けられているOVDの既存のアダプタを削除します。

構文

deleteAdapter(adapterName=<adapterName>, contextName=<contextName>)

表4-119 deleteAdapterの引数

引数

定義

adapterName

削除する結合アダプタの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

deleteAdapter(adapterName='join1')deleteAdapter('join1', 'default'))

deleteAttributeExclusionRule

deleteAttributeExlusionRule

説明

Delete an attribute exclusion rule.

構文

deleteAttributeExclusionRule(attribute, mappingContextId, contextName)

表4-120 deleteAttributeExclusionRuleの引数

引数

定義

attribute

除外リストから削除する属性の名前

mappingContextId

マッピング・コンテキストの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

deleteAttributeExclusionRule('objectsid')

deleteAttributeRule

deleteAttributeRule

説明

属性マッピング・ルールを削除します。

構文

deleteAttributeRule(srcAttrs, dstAttr, mappingContextId, contextName)

表4-121 deleteEntityRelationの引数

引数

定義

srcAttrs

dstAttr

mappingContextId

マッピング・コンテキストの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

deleteAttributeRule('lastname','sn')

deleteDomainExclusionRule

deleteDomainExclusionRule

説明

ドメイン除外ルールを削除します。

構文

deleteDomainExclusionRule(domain, mappingContextId, contextName)

表4-122 deleteEntityRelationの引数

引数

定義

domain

除外リストから削除するコンテナの識別名

mappingContextId

マッピング・コンテキストの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

deleteDomainExclusionRule('cn=group,dc=oracle,dc=com')

deleteDomainRule

deleteDomainRule

説明

ドメイン・マッピング・ルールを削除します。

構文

deleteDomainRule(srcDomain, destDomain, mappingContextId, contextName)

表4-123 deleteDomainRuleの引数

引数

定義

srcDomain

destDomain

mappingContextId

マッピング・コンテキストの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

deleteDomainRule('dc=oracle,dc=com','dc=oracle,dc=com')

deleteMappingContext

deleteMappingContext

説明

指定されたマッピング・コンテキストを削除します。

構文

deleteMappingContext(mappingContextId, contextName)

表4-124 deleteMappingContextの引数

引数

定義

mappingContextId

マッピング・コンテキストの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

deleteMappingContext('defaultContext','context)

getAdapterDetails

getAdapterDetails

説明

指定されたOPSSコンテキストに関連付けられているOracle Virtual Directoryに対して構成されている既存のアダプタの詳細を表示します。

構文

getAdapterDetails(adapterName=<adapterName>, contextName=<contextName>)

表4-125 getAdapterDetailsの引数

引数

定義

adapterName

表示する詳細を含むアダプタの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

getAdapterDetails(adapterName='ldap1', contextName='default')getAdapterDetails(adapterName='join1')

listAdapters

listAdapters

説明

指定されたOPSSコンテキストに関連付けられているOracle Virtual Directoryに対して構成されているすべてのアダプタの名前とタイプを一覧表示します。

構文

listAdapters(contextName='contextName')

表4-126 listAdaptersの引数

引数

定義

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

listAdapters()listAdapters(contextName='myContext')

listAllMappingContextIds

listAllMappingContextIds

説明

指定されたOPSSコンテキストに関連付けられているマッピング・コンテキストを一覧表示します。

構文

listAllMappingContextIds(contextName)

表4-127 listAllMappingContextIdsの引数

引数

定義

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

listAllMappingContextIds('default')

listAttributeRules

listAttributeRules

説明

SOURCE_ATTRIBUTE:DESTINATION_ATTRIBUTE:DIRECTIONという形式のすべての属性ルールを一覧表示します。

構文

listAttributeRules(mappingContextId, contextName)

表4-128 listAttributeRulesの引数

引数

定義

mappingContextId

マッピング・コンテキストの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

listAttributeRules('defaultContext','default)

listDomainRules

listDomainRules

説明

SOURCE_DOMAIN:DESTINATION_DOMAINという形式のすべてのドメイン・ルールを一覧表示します。

構文

listDomainRules(mappingContextId, contextName)

表4-129 listDomainRulesの引数

引数

定義

mappingContextId

マッピング・コンテキストの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

listDomainRules('defaultContext','default')

modifyLDAPAdapter

modifyLDAPAdapter

説明

このコマンドは、既存のLDAPアダプタで定義されている次のパラメータを変更するために使用されます。

- リモート・ベース

- ルート

- セキュア

- BindDN

- BindPassword

- PassCredentials

- MaxPoolSize

構文

modifyLDAPAdapter(adapterName=<adapterName>, attribute=<attribute>, value=<value>, contextName=<contextName>)

表4-130 modifyLDAPAdapterの引数

引数

定義

attribute

変更する属性の名前

value

属性の新しい値

adapterName

変更するLDAPアダプタの名前

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

modifyLDAPAdapter(adapterName='ldap1', attribute='Root', value='dc=us, dc=oracle, dc=com', contextName='mydefault')modifyLDAPAdapter(adapterName='ldap1', attribute='RemoteBase', value='dc=org')modifyLDAPAdapter(adapterName='ldap1', attribute='PassCredentials', value='BindOnly')modifyLDAPAdapter('ldap1', 'BindDN', 'cn=proxyuser,dc=com', 'mydefault')modifyLDAPAdapter(adapterName='ldap1', attribute='BindPassword', value='testwelcome123')modifyLDAPAdapter(adapterName='ldap1', attribute='Secure', value=true)modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolSize', value=500)

removeJoinRule

removeJoinRule

説明

指定されたOPSSコンテキストに関連付けられているOracle Virtual Directoryに対して構成されている結合アダプタから結合ルールを削除します。

構文

removeJoinRule(adapterName=<adapterName>, secondary=<secondary>, contextName=<contextName>)

表4-131 removeJoinRuleの引数

引数

定義

adapterName

変更する結合アダプタの名前

secondary

このセカンダリ・アダプタに対応する結合ルールが結合アダプタから削除されます

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

removeJoinRule('join1','secondaryldap1', 'default')removeJoinRule(adapterName='join1', secondary='LDAP3')

removeLDAPHost

removeLDAPHost

説明

既存のLDAPアダプタからリモート・ホスト(host:port)を削除します。

構文

removeLDAPHost(adapterName=<adapterName>, host=<host>, contextName=<contextName>)

表4-132 removeLDAPHostの引数

引数

定義

adapterName

変更するLDAPアダプタの名前

host

LDAPアダプタの通信先となるリモートLDAPホストの場所

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

removeLDAPHost(adapterName='ldap1', host='myhost.example.com')removeLDAPHost('ldap1', 'myhost.example.com', 'myContext')

removePlugin

removePlugin

説明

既存のアダプタから、またはグローバル・レベルでプラグインを削除します。

構文

removePlugin(pluginName=<pluginName>, adapterName=<adapterName>, contextName=<contextName>)

表4-133 removePluginの引数

引数

定義

pluginName

削除するプラグインの名前

adapterName

変更するアダプタの名前。指定しない場合、グローバル・プラグインが削除されます。

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

removePlugin(adapterName='ldap1', pluginName='VirtualAttr')removePlugin(pluginName='VirtualAttr')

removePluginParam

removePluginParam

説明

構成済のアダプタ・レベル・プラグインまたはグローバル・プラグインから既存のパラメータを削除します。このコマンドは、プラグインから特定のパラメータのすべての値を削除します。

構文

removePluginParam(pluginName=<pluginName>, paramKey=<paramKey>, adapterName=<adapterName>, contextName=<contextName>)

表4-134 removePluginParamの引数

引数

定義

pluginName

変更するプラグインの名前

paramKey

削除するパラメータ

adapterName

変更するアダプタの名前。指定しない場合、グローバル・プラグインが変更されます。

contextName

OVD構成の関連付け先となるOracle Platform Security Servicesコンテキストの名前。このオプションのパラメータのデフォルト値はdefaultです。

例

removePluginParam(adapterName='ldap1', pluginName='VirtualAttr', paramKey='ReplaceAttribute')removePluginParam(pluginName='VirtualAttr', paramKey='ReplaceAttribute')

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

表5-1に示されているUser Messaging Serviceコマンドを使用して、ユーザー・メッセージング・プリファレンスをバックエンドのデータベースからダウンロードします。

注意:

これらのコマンドを使用するには、コンポーネントがインストールされているOracleホームからWLSTを呼び出す必要があります。Oracle Fusion Middleware管理者ガイドのカスタムWLSTコマンドの使用に関する項を参照してください。

表5-1 WLST構成のUser Messaging Service

コマンド・カテゴリ

説明

UMS WLSTコマンド・グループ

Oracle Unified Messaging Serviceコマンドを管理します。

UMS WLSTコマンド・グループ

UMS WLSTコマンドは、「ums」コマンド・グループの下に一覧表示されます。

manageUserMessagingPrefs

コマンド・カテゴリ: UMS

WLSTでの使用: オフライン

説明

manageUserMessagingPrefsは、ユーザー・メッセージング・プリファレンスをバックエンドのデータベースから指定されたXMLファイルにダウンロードするために使用でき、またはユーザー・メッセージング・プリファレンスをXMLファイルからバックエンドのデータベースにアップロードするために使用できます。

構文

manageUserMessagingPrefs (operation=, filename, url, username, password,
[encoding], [guid], [merge] )

引数

定義

operation

実行するアップロードまたはダウンロード操作を指定します。

filename

ダウンロードするための、ユーザー・プリファレンスをダウンロードするユニークなファイル名(パス)。たとえば、/tmp/download.xml (Linux)またはC:\\temp\\download.xml (Windows)。

アップロードするための、ユーザー・プリファレンスをアップロードするファイル名(パス)。

url

ユーザー・メッセージング・サーバーにアクセスするJNDI URL。たとえば: t3://<hostname>:<port>

username

ユーザー・メッセージング・サーバーにアクセスするためのログイン・パーミッションを持つユーザー名。

password

ユーザー名のパスワード。

encoding

ユーザー・プリファレンスをダウンロードするために使用する文字エンコーディング。

guid

プリファレンスをダウンロードするユーザー・リストのグローバル一意識別子(guid)。guidが指定されていない場合は、すべてのユーザーのプリファレンスがダウンロードされます。

merge

このオプションは、アップロードでのみ使用します。有効な値は次のとおりです:

create_new(デフォルト): 新しいユーザー・デバイス、デバイス・アドレスやルール・セット・エンティティを作成します。同じ主キーのエンティティがすでに存在する場合は、例外が送出されて処理は終了します。

overwrite: ユーザーの既存のエンティティのすべてを削除し、新しいエンティティを作成します。

append: 既存に存在しないエンティティのみをアップロードします。

例

すべてのユーザーのユーザー・メッセージング・プリファレンスを指定されたファイルにダウンロードするには、次のコマンドを実行します。

wls:offline> manageUserMessagingPrefs(operation='download',
filename='download.xml', url='t3://localhost:8001', username='weblogic',
password='<password>')

すべてのユーザーのユーザー・メッセージング・プリファレンスを、UTF-8文字エンコーディングを使用されている指定したファイルにダウンロードするには、次のコマンドを実行します。

wls:offline> manageUserMessagingPrefs(operation='download',
filename='download.xml', url='t3://localhost:8001', username='weblogic',
password='<password>', encoding='UTF-8')

guid 「john.doe」のユーザーのユーザー・メッセージング・プリファレンスを指定したファイルにダウンロードするには、次のコマンドを実行します。

wls:offline> manageUserMessagingPrefs(operation='download',
filename='download.xml', url='t3://localhost:8001', username='weblogic',
password='<password>', guid='john.doe')

guid 「john.doe」および「jane.doe」を持つユーザーのユーザー・メッセージング・プリファレンスをUTF-8文字エンコーディングを使用している指定したファイルにダウンロードするには、次のコマンドを実行します。

wls:offline> manageUserMessagingPrefs(operation='download',
filename='download.xml', url='t3://localhost:8001', username='weblogic',
password='<password>', guid='john.doe,jane.doe', encoding='UTF-8')

指定したファイルからのユーザー・メッセージング・プリファレンスをバックエンドのデータベースにアップロードするには、次のコマンドを実行します。

wls:offline> manageUserMessagingPrefs(operation='upload', filename='upload.xml',
url='t3://localhost:8001', username='weblogic', password='<password>')

指定したファイルからのユーザー・メッセージング・プリファレンスをバックエンドのデータベースにアップロードして、既存のプリファレンスを上書きするには、次のコマンドを実行します。

wls:offline> manageUserMessagingPrefs(operation='upload', filename='upload.xml',
url='t3://localhost:8001', username='weblogic', password='<password>',
merge='overwrite')

deployUserMessagingDriver

コマンド・カテゴリ: UMS

WLSTでの使用: オンライン

説明

deployUserMessagingDriverは、ユーザー・メッセージング・ドライバの追加のインスタンスをデプロイするために使用します。ベース・ドライバ・タイプ(たとえば、email、xmpp、voicexml、およびその他)および新しいドライバ・デプロイメントの短い名前を指定します。usermessagingdriver文字列は、指定したアプリケーションの名前に追加されます。deployコマンドの任意の有効なパラメータを指定して、ドライバがデプロイされるときに渡すことができます。

構文

deployUserMessagingDriver(baseDriver, appName, [targets], [stageMode],
[options])

引数

定義

baseDriver

ベース・メッセージ・ドライバ・タイプを指定します。

「email」、「proxy」、「smpp」、「voicexml」、または「xmpp」のような既知のドライバ・タイプでなければなりません。

appName

新しいデプロイメントの短い名前。指定した値をusermessagingdriver-文字列の先頭に追加します。

targets

stageMode

options

オプション。デプロイ・コマンドの追加の有効な引数を指定して、新しいドライバがデプロイされるときに渡すことができます。

例

myEmail名前の電子メール・ドライバの第2インスタンスをデプロイするには、次のコマンドを実行します。

wls:base_domain/servereConfig> deployUserMessagingDriver(baseDriver='email',
appName='myEmail')

デプロイメント対象を指定し、電子メール・ドライバの第2インスタンスをデプロイするには、次のコマンドを実行します。

wls:base_domain/servereConfig> deployUserMessagingDriver(baseDriver='email',
appName='email2', targets='server1,server2')

6 DMSカスタムWLSTコマンド

表6-1のカテゴリのダイナミック・モニタリング・サービス(DMS)コマンドを使用して、パフォーマンス・メトリックの表示およびイベント・トレースの構成を行います。

注意:

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

表6-1 DMSコマンド・カテゴリ

コマンド・カテゴリ

説明

DMSメトリック・コマンド

パフォーマンス・メトリックに関する情報を表示します。

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

イベント・トレースを構成します

DMSメトリック・コマンド

表6-2のコマンドを使用して、特定のサーバーまたはコンポーネントに対する特定のパフォーマンス・メトリック、一連のパフォーマンス・メトリック、またはすべてのパフォーマンス・メトリックを表示します。

メトリックの詳細は、Oracle Fusion Middleware管理者ガイドのOracle Fusion Middlewareの監視に関する項および『Oracle Fusion Middlewareパフォーマンスおよびチューニング・ガイド』のDMSを使用したアプリケーションのインストゥルメント処理に関する付録を参照してください。

表6-2 DMSコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

displayMetricTableNames

使用可能なDMSメトリック表の名前を表示します。

オンライン

displayMetricTables

DMSメトリック表の内容を表示します。

オンライン

dumpMetrics

使用可能なメトリックを表示します。

オンライン

reloadMetricRules

メトリック・ルールをリロードします。

オンライン

displayMetricTableNames

コマンド・カテゴリ: DMSメトリック

WLSTでの使用: オンライン

説明

使用可能なDMSメトリック表の名前を表示します。戻り値は、メトリック表名のリストです。

構文

displayMetricTableNames([servers])

引数

定義

servers

オプション。メトリックを取得するサーバーを指定します。有効な値は、WebLogic Serverインスタンス名およびシステム・コンポーネント名のリストです。

1つのサーバーを指定するには、次の構文を使用します:

servers='servername'

複数のサーバーを指定するには、次のいずれかの構文オプションを使用します:

servers=['servername1', 'servername2', ...]
servers=('servername1', 'servername2', ...)

この引数を指定しない場合、コマンドは、すべてのWebLogicサーバーおよびシステム・コンポーネントのメトリック表名のリストを戻します。

例

次の例では、すべての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
.
.
.

次の例では、soa_server1というWebLogic管理対象サーバーのメトリック表名を一覧表示します。

displayMetricTableNames(servers='soa_server1')
ADF
JVM
JVM_ClassLoader
JVM_Compiler
JVM_GC
JVM_Memory
JVM_MemoryPool
JVM_MemorySet
JVM_OS
JVM_Runtime
.
.
.

次の例では、2つのWebLogic管理対象サーバーのメトリック表名を示します。

displayMetricTableNames(servers=['soa_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
.
.
.

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サーバーおよびシステム・コンポーネントのメトリック表のリストを戻します。

variables

オプション。メトリックの集約パラメータを定義します。有効な値は、名前と値のペアのセットです。次の構文を使用します:

variables={name1:value1, name2:value2, ...}

特定の名前と値のペアは、集約されたメトリック表によって異なります。集約されたメトリック表のすべては、変数名の特定のセットがあります。

例

次の例では、JVMおよびweblogic.management.runtime.WebAppComponentRuntimeMBeanメトリック表のデータを示し、soa_server1およびbam_server1から取得されたデータに制限されます。

displayMetricTables('JVM','weblogic.management.runtime.WebAppComponentRuntimeMBean',
servers=['soa_server1','bam_server1'])
.
.
.
ApplicationRuntime:     soa-infra
ComponentName:  /integration/services/IdentityService
ContextRoot:    /integration/services/IdentityService
DeploymentState:        2
FilterDispatchedRequestsEnabled:        false
IndexDirectoryEnabled:  false
JSPDebug:       false
JSPKeepGenerated:       false
JSPPageCheckSecs:       1
JSPVerbose:     true
ModuleId:       /integration/services/IdentityService
ModuleURI:      IdentityService.war
Name:   soa_server1_/integration/services/IdentityService
ObjectName:     com.bea:ApplicationRuntime=soa-infra,Name=soa_server1_/integration/services/IdentityService,
ServerRuntime=soa_server1,Type=WebAppComponentRuntime
OpenSessionsCurrentCount:       0
OpenSessionsHighCount:  0
.
.
.

次の例では、指定したメトリックの集約パラメータを持つ集約されたメトリック表を示します。

displayMetricTables('j2ee_application:webservices_port_rollup',
servers=['soa_server1','bam_server1'],
variables={'host':'hostname', 'servletName':'dms'})
----------------------------------------
j2ee_application:webservices_port_rollup
----------------------------------------

Faults: 0
Requests:       0
Requests.averageTime:   0.0
Requests.totalTime:     0.0
ServerName:     soa_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:     soa_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.us.example.com
JVM:    JVM
Name:   threads
Parent: /JVM/MxBeans
Process:        AdminServer:9001
ServerName:     AdminServer
contention.value:       enabled in JVM
daemon.value:   60      threads
deadlock.value: 0       threads
live.value:     61      threads
peak.value:     66      threads
started.value:  241     threads

Host:   hostname.us.example.com
JVM:    JVM
Name:   threads
Parent: /JVM/MxBeans
Process:        soa_server1:9001
ServerName:     soa_server1
contention.value:       enabled in JVM
daemon.value:   68      threads
deadlock.value: 0       threads
live.value:     74      threads
peak.value:     74      threads
started.value:  105     threads
.
.
.

dumpMetrics

コマンド・カテゴリ: DMSメトリック

WLSTでの使用: オンライン

説明

内部フォーマットまたはXMLで利用可能なメトリックを示します。戻り値は、テキスト・ドキュメントです。

構文

dumpMetrics([servers] [, format])

引数

定義

servers

オプション。メトリックを取得するサーバーを指定します。有効な値は、WebLogic Serverインスタンス名およびシステム・コンポーネント名のリストです。

1つのサーバーを指定するには、次の構文を使用します:

servers='servername'

複数のサーバーを指定するには、次のいずれかの構文オプションを使用します:

servers=['servername1', 'servername2', ...]
servers=('servername1', 'servername2', ...)

この引数を指定しない場合、コマンドは、すべてのWebLogicサーバーおよびシステム・コンポーネントのメトリック表のリストを戻します。

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='bam_server1' cacheable='false'>
<row cacheable='false'>
<column name='serverName'><![CDATA[bam_server1]]></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[bam_server1]]></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://10.229.149.27: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
.
.
.

次の例では、soa_server1およびbam_server1からのメトリックをXMLフォーマットで出力します。

dumpMetrics(servers=['soa_server1', 'bam_server1'], format='xml')
<table name='oracle_soainfra:high_latency_sync_composites' keys='ServerName
soainfra_composite soainfra_composite_revision soainfra_domain'
componentId='bam_server1' cacheable='false'>
</table>
<table name='weblogic_j2eeserver:ejb_transaction' keys='ServerName appName
ejbModuleName name serverName' componentId='bam_server1' cacheable='false'>
<row cacheable='false'>
<column name='serverName'><![CDATA[bam_server1]]></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[bam_server1]]></column>
<column name='ejbTransactionCommit.throughput' type='DOUBLE'>0.0</column>
<column name='ejbModuleName'><![CDATA[sdpmessagingclient-ejb-parlayx.jar]]></column>
</row>
.
.
.

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-oracle_eps_server-11.0.xml'
loaded 'server-weblogic_j2eeserver-11.0.xml'
loaded 'server-oracle_bamweb-11.0.xml'
loaded 'server-oracle_federation-11.0.xml'
loaded 'server-portal-11.0.xml'
loaded 'server-weblogic_j2ee_application_webcenter-11.0.xml
.
.
.

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

表6-3のコマンドを使用して、イベント・トレースを構成します。イベント・トレースでは、再起動せずにライブ・トレースを構成できます。Oracle Fusion Middleware製品を使用して更新されたDMSメトリックは、DMSイベント・トレース機能を使用してトレースできます。

DMSイベント・トレースの詳細は、『Oracle Fusion Middlewareパフォーマンスおよびチューニング・ガイド』のDMSトレースおよびイベントに関する項を参照してください。

表6-3 DMSトレース・コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

addDMSEventDestination

イベント・トレース構成に新しい宛先を追加します。

オンライン

addDMSEventFilter

イベント・トレース構成にフィルタを追加します。

オンライン

addDMSEventRoute

イベント・トレース構成に指定されたイベント・ルートを追加します

オンライン

enableDMSEventTrace

イベント・トレースを有効にし、指定された条件と宛先および有効なイベント・ルートでフィルタを作成します。

オンライン

listDMSEventConfiguration

イベント・トレース構成の概要を表示します。

オンライン

listDMSEventDestination

1つの宛先またはすべての宛先のリストに関する完全な構成を表示します。

オンライン

listDMSEventFilter

1つのフィルタまたはすべてのフィルタのリストの構成を表示します。

オンライン

listDMSEventRoutes

イベント・ルートおよびそのステータス(有効か無効か)を表示します。

オンライン

removeDMSEventDestination

指定された宛先を削除します。

オンライン

removeDMSEventFilter

指定されたフィルタを削除します。

オンライン

removeDMSEventRoute

指定されたイベント・ルートを削除します。

オンライン

updateDMSEventDestination

イベントの宛先の構成を更新します。

オンライン

updateDMSEventFilter

イベント・フィルタの構成を更新します。

オンライン

updateDMSEventRoute

イベント・ルートの構成を更新します。

オンライン

addDMSEventDestination

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレース構成に新しい宛先を追加します。同じIDの宛先がすでに存在している場合、その旨が報告され、宛先は追加されません。宛先を追加するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

addDMSEventDestination(id=id [, name=dest_name] ,class=class_name
[, props= {'name': 'value'...}] [,server=server_name])

引数

定義

id

指定された宛先の一意の識別子。

name

オプション。宛先の名前。

class

宛先の完全なクラス名。

使用可能なクラスのリストについては、表6-4を参照してください。

props

オプション。宛先に使用する名前/値プロパティ。プロパティが必要な宛先もあります。たとえば、LoggerDestinationクラスでは、loggerNameプロパティが必要です。

構文および許可されている値については、addDMSEventFilterを参照してください。

server

オプション。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

表6-4には、完全なランタイム・クラス名が示された組込みの宛先が記載されています。

表6-4 組込みの宛先

宛先のランタイム・クラス名

説明

oracle.dms.trace2.runtime.LoggerDestination

ODLを使用して、ログ・メッセージをファイルに送ります。

oracle.dms.event.HTTPRequestTrackerDestination

アクティブなHTTPリクエストのセットをダンプし、管理者がアクティビティのスナップショットを取得できるようにします。

oracle.dms.jrockit.jfr.JFRDestination

JRockit Mission Controlを使用してJRockit JVMおよびWLDFからの他のデータのコンテキストでイベントを表示できるように、JRockitフライト・レコーダにイベントを渡します。

oracle.dms.jmx.MetricMBeanFactory

ナウンをMBeanとして公開します。

oracle.dms.util.StackTraceCollatorDestination

特定のイベントが発生するたびに実行中のスタック・トレースを照合します。これは、主としてデバッグ・ツールです。

照合済のデータは、シャットダウン時に書き出されます。また、処理されているイベントが一定の時間内(デフォルトは1分間)に報告されなかった場合にも書き出されます。

例

次の例では、IDがjfr、名前がFlight-Recorder、クラスがoracle.dms.event.JRockitFlightRecorderである宛先を追加します。

addDMSEventDestination(id='jfr', name='Flight-Recorder',
class='oracle.dms.event.JRockitFlightRecorder')

Destination "jfr" added.

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

addDMSEventFilter

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレース構成にフィルタを追加します。同じIDのフィルタがすでに存在している場合、エラーが戻され、フィルタは追加されません。

イベント・フィルタを追加するには、管理サーバーに接続している必要があります。接続していないと、エラー・メッセージが報告されます。

構文

addDMSEventFilter(id=id [, name=name] [, etypes]
, props= {'prop-name': 'value'...}
[, server=server_name])

引数

定義

id

指定されたフィルタの一意の識別子。

name

オプション。フィルタの名前。

etypes

オプション。イベントとアクションのペアのカンマ区切りリストを含む文字列。この引数を条件とともに使用することで、よりきめ細かいフィルタを作成することが可能になります。より広範囲なメトリックを持つフィルタを作成することもできます。たとえば、すべてのナウン、またはアクションが作成されているすべてのナウンです。

props

prop-name: フィルタ・プロパティの名前。有効な唯一のプロパティは<condition>であり、指定できるのは1つの条件のみです。

value: フィルタのプロパティの値。

server

オプション。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

etypesの構文は次のとおりです:

<etypes>:==
<type>:[<action>]

有効なetypesは次のとおりです:

EXECUTION_CONTEXT
EXECUTION_CONTEXT:START
EXECUTION_CONTEXT:STOP
HTTP_REQUEST
HTTP_REQUEST:START
HTTP_REQUEST:STOP
NOUN
NOUN:CREATE
NOUN:DELETE
STATE_SENSOR
STATE_SENSOR:CREATE
STATE_SENSOR:DELETE

次に、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

オプション。これが指定された場合、値の大/小文字の区別は無視されます。

DATATYPE

オプション。有効な値は、string、longまたはdoubleです。デフォルトはstringです。

例

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

Filter "mds1" already exists. Unable to add this.

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

addDMSEventRoute

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレース構成に指定されたイベント・ルートを追加します。同じIDのイベント・ルートがすでに存在している場合、エラーが戻され、イベント・ルートは追加されません。

イベント・ルートを追加するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

addDMSEventRoute([filterid=filter_id], destinationid=destination_id, [enable=true|false] [,server=server_name])

引数

定義

filterid

オプション。フィルタの一意の識別子。

destinationid

特定の宛先の一意の識別子。この宛先が存在している必要があります。

enable

オプション。フィルタを有効にします。有効な値は、trueおよびfalseです。デフォルトはtrueです。

server

オプション。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、フィルタIDがmds1であり、宛先IDがjrfであるイベント・ルートを追加しようとしています:

addDMSEventRoute(filterid='mds1', destinationid='jfr', enable='false')
Event-route for filter "mds1", destination "jfr" added.

次の例では、すでに存在しているイベント・ルートを追加しようとしています:

addDMSEventRoute(filterid='mds1', destinationid='jfr', enable='false')
Event-route for filter "mds1", destination "jfr" already exists. Unable to add this.

enableDMSEventTrace

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレースを有効にし、指定された条件と宛先および有効なイベント・ルートでフィルタを作成します。これは、フィルタ、宛先およびイベント・ルートを明示的に作成せずにフィルタ処理を開始できるようにする簡単な方法ですが、構成オプションは少なくなります。指定された宛先が存在している必要があります。

DMSイベント・トレースを有効にするには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

より複雑な構成が必要な場合は、addDMSEventDestination、addDMSEventFilterおよびaddDMSEventRouteを使用します。

構文

enableDMSEventTrace(destinationid=destinationid [, etypes=etype]
[, condition=condition]  [, server=server_name])

引数

定義

destinationid

特定の宛先の一意の識別子。既存の宛先はいずれも有効です。

etypes

オプション。イベントとアクションのペアのカンマ区切りリストを含む文字列。使用可能なetypesのリストについては、addDMSEventFilterを参照してください。

condition

オプション。フィルタ処理する条件。条件の構文については、addDMSEventFilterを参照してください。

条件が指定されない場合、すべてのDMSイベントが渡されます

server

オプション。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、指定された条件を持つイベント・トレースを有効にします。

enableDMSEventTrace(condition='CONTEXT username EQUALS Joe AND CONTEXT ip EQUALS 192.168.1.5')

Filter "EventTrace9", using Destination "LoggerDestination" added, and event-route enabled.

listDMSEventConfiguration

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレース構成の概要を表示します。

構文

listDMSEventConfiguration([server=server_name]]

引数

定義

server

オプション。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、接続している管理対象サーバーの構成を一覧表示します。

listDMSEventConfiguration()

Event routes:
FILTER      DESTINATION
MyFilter    des1
MyFilter    des2
null        des3

Filters with no event route:
Fred

Destinations with no event route:
des4

listDMSEventDestination

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

特定の宛先について、完全な構成を表示します。宛先IDが指定されない場合、イベント・トレース構成内のすべての宛先の宛先IDおよび名前が示されます。

構文

listDMSEventDestination([id=id] [, server=server_name)

引数

定義

id

オプション。特定の宛先の一意の識別子。

server

オプション。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、接続している管理対象サーバーの宛先に関する情報を表示します。

listDMSEventDestination()
ID  : destination1
NAME: File-system
ID  : jrf
NAME: Flight-Recorder

次の例では、管理対象サーバーMS1の宛先に関する情報を表示します。

listDMSEventDestination(server='MS1')
ID        NAME
Network1  Send file over network
desman1   File-system

次の例では、宛先destination1に関する情報を表示します。

listDMSEventDestination(id='destination1')
ID: destination1
NAME: File-system
CLASS: oracle.dms.trace2.runtime.LoggerDestination
PROPERTIES:
NAME       VALUE
LoggerName trace2-logger

listDMSEventFilter

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

特定のフィルタについて、完全な構成を表示します。フィルタIDを指定しない場合、イベント・トレース構成内のすべてのフィルタのフィルタIDおよび名前が表示されます。

構文

listDMSEventFilter([id=id] [, server=server_name])

引数

定義

id

オプション。指定されたフィルタの一意の識別子。

server

オプション。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、イベント・トレース構成内のすべてのフィルタのリストを表示します。

listDMSEventFilter()

ID    NAME
mds1  MyFilter
mds2  MDS2Filter

次の例では、フィルタmds1の構成を表示します。

listDMSEventFilter(id='mds1')

ID  : mds1
NAME: MyFilter
PROPERTIES
CONDITION: NOUNTYPE equals MDS_Connections AND CONTEXT user equals
bruce IGNORECASE=false

listDMSEventRoutes

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

指定されたフィルタまたは宛先に関連付けられているイベント・ルートおよびそのステータス(有効か無効か)を一覧表示します。filteridまたはdestinationidを指定しない場合、イベント・トレース構成内のすべてのイベント・ルートが示されます。

構文

listDMSEventRoutes([filterid=filter_id] [, destinationid=destination_id]
[, server=server_name])

引数

定義

filterid

オプション。フィルタの一意の識別子。

destinationid

オプション。特定の宛先の一意の識別子。この宛先が存在している必要があります。

server

オプション。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、すべてのイベント・ルートを示します。

listDMSEventRoutes()
FILTER     : mdsbruce
DESTINATION: jfr
ENABLED    : false
FILTER     : null
DESTINATION: destination1
ENABLED    : true

次の例では、フィルタIDがfilter1であるイベント・ルートを一覧表示します。

listDMSEventRoutes(filterid='filter1')
FILTER     : filter1
DESTINATION: jfr
ENABLED    : true
FILTER     : filter1
DESTINATION: destination1
ENABLED    : true

次の例では、宛先IDがdestination1であるイベント・ルートを一覧表示します。

listDMSEventRoutes(destinationid='destination1')
FILTER     : filter1
DESTINATION: destination1
ENABLED    : true

removeDMSEventDestination

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレース構成から既存の宛先を削除します。宛先を削除できるのは、どのイベント・ルートもその宛先に依存していない場合のみです。その宛先に依存するイベント・ルートが存在する場合、警告が戻されます。

宛先を削除するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

removeDMSEventDestination(id=id [, server=server_name])

引数

定義

id

削除する宛先の一意の識別子。

server

オプション。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、宛先jfrを削除します。

removeDMSEventDestination(id='jfr')

Destination "jfr" removed.

次の例では、宛先styx.inpass.db1を削除しようとします。しかし、この宛先にはイベント・ルートが存在するため、エラーが戻されます。

removeDMSEventDestination(id='styx.inpass.db1')

Destination "'styx.inpass.db1'" cannot be removed. An event-route currently
exists for that destination. Remove the event-route first using the command
removeDMSEventRoute().

removeDMSEventFilter

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレース構成から既存のフィルタを削除します。フィルタを削除できるのは、どのイベント・ルートもそのフィルタに依存していない場合のみです。そのフィルタに依存するイベント・ルートが存在する場合、警告が戻されます。

イベント・フィルタを削除するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

removeDMSEventFilter(id=id [, server=server_name])

引数

定義

id

削除するフィルタの一意の識別子。

server

オプション。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、フィルタmds1を削除します。

removeDMSEventFilter(id='mds1')

Filter "mds1" removed.

次の例では、イベント・ルートが現在存在しているフィルタを削除しようとします。

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().

removeDMSEventRoute

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

指定されたイベント・ルートを削除します。イベント・ルートを追加するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

removeDMSEventRoute([filterid=filter_id] [, destinationid=destination_id]
[, server=server_name])

引数

定義

filterid

オプション。フィルタの一意の識別子。

destinationid

オプション。特定の宛先の一意の識別子。この宛先が存在している必要があります。

server

オプション。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、フィルタIDがmds1であり、宛先がjfrであるイベント・ルートを削除します。

removeDMSEventRoute(filterid='mds1', destinationid='jfr')
Event-route for filter "mds1", destination "jfr" removed

次の例では、宛先がdestination1であるイベント・ルートを削除します。

removeDMSEventRoute(destinationid='destination1')
Event-route for filter "None", destination "destination1" removed

updateDMSEventDestination

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

既存の宛先を更新します。このコマンドでは、指定された引数を更新できます。宛先を更新するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

updateDMSEventDestination(id=id [, name=dest_name], class=class_name
[,props= {'name': 'value'...}] [, server=server_name)

引数

定義

id

更新する宛先の一意の識別子。

name

オプション。宛先の名前。

class

宛先の完全なクラス名。

使用可能な宛先のリストについては、表6-4を参照してください。

props

オプション。宛先に使用する名前/値プロパティ。新しいプロパティを追加したり、既存のプロパティを更新または削除したりすることができます。プロパティを更新する場合は、すべてのプロパティを指定する必要があります。プロパティを省略すると、そのプロパティは削除されます。たとえば、ある宛先にプロパティLoggerNameおよびseverityが含まれている場合、severityを省略すると、severityはその宛先から削除されます。

構文および許可されている値については、addDMSEventFilterを参照してください。

server

オプション。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、宛先jfrの名前を更新します。

updateDMSEventDestination(id='jfr', name='Alternative Flight-Recorder')

Destination "jfr" updated.

次の例では、存在しない宛先を更新しようとします。このコマンドではエラーが戻されます。

updateDMSEventDestination(id='destination1',
props={'loggerName': 'MyNewTrace2-logger'})

Destination "destination1" does not yet exist. Unable to update this.

updateDMSEventFilter

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

イベント・トレース構成内の既存のフィルタを更新します。

イベント・フィルタを更新するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

updateDMSEventFilter(id=id [, name=name] [,etypes=etypes],
props= {'prop-name': 'value'...}
[,server=server_name])

引数

定義

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.

次の例では、存在しないフィルタを更新しようとします。

updateDMSEventFilter(id='Filter2')

Filter "Filter2" does not yet exist. Unable to update this.

updateDMSEventRoute

コマンド・カテゴリ: DMSイベント・トレース

WLSTでの使用: オンライン

説明

指定されたイベント・ルートを有効または無効にします。イベント・ルートを更新するには、管理サーバーに接続している必要があります。接続していないと、エラーが戻されます。

構文

updateDMSEventRoute([filterid=filter_id], destinationid=destination_id
[, enable=true|false] [, server=server_name])

引数

定義

filterid

オプション。フィルタの一意の識別子。

destinationid

オプション。特定の宛先の一意の識別子。この宛先が存在している必要があります。

enable

オプション。フィルタを有効にします。有効な値は、trueおよびfalseです。

server

オプション。この操作を実行する対象のサーバー。デフォルトは、接続しているサーバーです。

例

次の例では、filteridがmds1であり、destinationidがjfrであるイベント・ルートを無効にします。

updateDMSEventRoute(filterid='mds1', destinationid='jfr', enable='false')
Event-route for filter "mds1", destination "jfr" disabled .

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

ロギング・コマンドを使用して、ログ・ファイルの設定を構成、およびログ・ファイルを表示および検索します。表7-1では、ロギング・コマンドの各種カテゴリを説明します。

ログ・ファイルの構成および検索の詳細は、Oracle Fusion Middleware管理者ガイドのログ・ファイルと診断データの管理に関する項を参照してください。

注意:

これらのロギング・カスタムWLSTコマンドを使用するには、Oracle共通ホームからWLSTスクリプトを呼び出す必要があります。Oracle Fusion Middleware管理者ガイドのカスタムWLSTコマンドの使用に関する項を参照してください。

表7-1 ロギング・コマンドのカテゴリ

コマンド・カテゴリ

説明

ログの構成コマンド

ファイルに書き込まれる情報レベルやファイルの最大サイズなどのログ・ファイルの設定を構成します。

検索および表示コマンド

Oracle Fusion Middlewareログ・ファイルを表示し、特定のメッセージのログ・ファイルを検索します。

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

選択的トレースを構成および使用します。選択的トレースでは、メッセージが特定のサーバー、ロガーまたはユーザーについてトレースされることが指定されます。

ログの構成コマンド

表7-2のコマンドを使用して、ファイルに書き込まれる情報レベルやファイルの最大サイズなどのログ・ファイルの設定を構成します。WLST列で使用する場合は、オンラインとは、コマンドが実行中のサーバーに接続されている場合のみに使用されることを意味します。オフラインとは、コマンドが実行中のサーバーに接続されてない場合のみに使用されることを意味します。オンラインまたはオフラインとは、コマンドは両方の状況に使用できることを意味します。

表7-2 ロギング構成のコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

configureLogHandler

既存のログ・ハンドラを構成し、新しいハンドラを追加または既存ハンドラを削除します。

オンライン

getLogLevel

指定したロガーのレベルを取得します。

オンライン

listLoggers

ロガーの一覧および各ロガーのレベルを取得します。

オンライン

listLogHandlers

1つまたは複数のログ・ハンドラの構成を示します。

オンライン

setLogLevel

指定したロガーのレベルを設定します。

オンライン

configureLogHandler

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

WLSTでの使用: オンライン

説明

既存のJavaロギング・ハンドラを構成し、新しいハンドラを追加、既存のハンドラを削除します。ハンドラごとに1つのエントリを持つjava.util.Listを返します。各エントリは、ハンドラを記述するjavax.management.openmbean.CompositeDataオブジェクトです。

このコマンドを使用して、ログ・ファイルの場所、ログ・ファイルのローテーション頻度および他のログ・ファイルのプロパティを変更できます。

構文

configureLogHandler(options)

引数

定義

options

オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:

- target - WebLogic Serverインスタンスの名前、またはシステム・コンポーネントを記述する文字列。システム・コンポーネントの詳細は、コンポーネントのドキュメントを参照してください。
デフォルト値はWLSTが接続しているサーバーです。

- name - ログ・ハンドラの名前。このオプションは必須です。

- maxFileSize - ODLハンドラの最大ファイル・サイズの値。この値は数値を表す文字列で、オプションとしてサイズ単位を示す接尾辞(キロバイトはk、メガバイトはm、ギガバイトはg)が付加されます。
接尾辞を指定しない場合、値がバイト単位で返されます。

このオプションはQuickTraceハンドラには適用されないことに注意してください。

- maxLogSize - ODLハンドラの最大ログ・ファイル・サイズの値。この値は数値を表す文字列で、オプションとしてサイズ単位を示す接尾辞(キロバイトはk、メガバイトはm、ギガバイトはg)が付加されます。
このオプションはQuickTraceハンドラには適用されないことに注意してください。

- rotationFrequency - ODLハンドラのローテーション頻度の値。この値は数値を表す文字列で、オプションとして時間単位を示す接尾辞(分はm、時間はh、日はd)が付加されます。デフォルトの単位は分です。HOUR、HOURLY、DAY、DAILY、WEEK、WEEKLY、MONTH、MONTHLYの特定の値も使用でき、これらの値を分の数値に変換されます。
このオプションはQuickTraceハンドラには適用されないことに注意してください。

- baseRotationTime - rotationFrequencyオプションで使用する基本ローテーション時刻。値は、日付と時刻値を表す文字列である必要があります。これには、ISO 8601日付と時間フォーマットで完全な日付と時間、または時間数および分数のみが含まれる短縮形を使用できます。デフォルトのbaseRotationTimeは00:00です。
このオプションはQuickTraceハンドラには適用されないことに注意してください。

options (continued)

- retentionPeriod - ログ・ファイルが保持される時間。この値は数値を表す文字列である必要があり、オプションとして時間単位を示す接尾辞(分はm、時間はh、日はd)が付加されます。デフォルトの単位は分です。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管理者ガイドの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プロパティとmaxLogSizeプロパティも削除します。

configureLogHandler(name="odl-handler", rotationFrequency="daily",
retentionPeriod="week", removeProperty=['maxFileSize','maxLogSize'])

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

getLogLevel

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

WLSTでの使用: オンライン

説明

特定のJavaロガーのレベルを返します。

戻り値は、ロガーのレベルを示す文字列で、ロガーが存在しない場合はNoneです。空の文字列は、ロガー・レベルがNullになることを示します。

構文

getLogLevel(options)

引数

定義

options

オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:

- target - WebLogic Serverインスタンスの名前、またはシステム・コンポーネントを記述する文字列。システム・コンポーネントの詳細は、コンポーネントのドキュメントを参照してください。
デフォルト値はWLSTが接続しているサーバーです。

- logger - ロガー名。空の文字列はルート・ロガーを示します。
このオプションは必須で、デフォルト値はありません。

- runtime - 操作は実行時ロガーまたは構成ロガーをリストするかを決定するJythonブール値(0または1)。デフォルト値は1 (実行時)です。

例

次の例では、ロガーOracleのレベルを返します。

getLogLevel(logger='oracle')

次の例では、ラインタイム・ロガーではなく、構成ロガーのみを指定して、ロガーOracleのレベルを戻します。

getLogLevel(logger='oracle', runtime=0)

次の例では、Oracle WebLogic Server server2上のロガーOracleのレベルを返します。

getLogLevel(logger='oracle', target='server2')

listLoggers

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

WLSTでの使用: オンライン

説明

Javaロガーおよびそれらのレベルを示します。このコマンドは、キーはロガー名であり、関連付けられた値はロガー・レベルであるPyDictionaryオブジェクトを返します。空のレベルは、ロガーにレベル・セットはないことを示すために使用されます。

構文

listLoggers([options])

引数

定義

options

オプションのカンマ区切りのリスト(オプション)。名前と値のペアで指定します。有効なオプションは次のとおりです:

- target - WebLogic Serverインスタンスの名前、またはシステム・コンポーネントを記述する文字列。システム・コンポーネントの詳細は、コンポーネントのドキュメントを参照してください。
デフォルト値はWLSTが接続しているサーバーです。

- pattern - ロガー名をフィルタするために使用する正規表現パターン。デフォルト値はすべてのロガー名を返します。

- runtime - 操作は実行時ロガーまたは構成ロガーをリストするかを決定するJythonブール値(0または1)。デフォルト値は1 (実行時)です。

例

次の例では、すべてのロガーを示します。

listLoggers()

次の例では、「oracle.*」という名前で開始するすべてのロガーを表示します。

listLoggers(pattern="oracle.*")

次の例では、すべての構成ロガーを表示します。

listLoggers(runtime=0)

次の例では、WebLogic Server server1のすべてのロガーを一覧表示します。

listLoggers(target="server1")

listLogHandlers

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

WLSTでの使用: オンライン

説明

Javaログ・ハンドラ構成を示します。このコマンドは、ハンドラごとに1つのエントリを持つjava.util.Listを返します。各エントリは、ハンドラを記述するjavax.management.openmbean.CompositeDataオブジェクトです。

構文

listLogHandlers([options])

引数

定義

options

オプションのカンマ区切りのリスト(オプション)。名前と値のペアで指定します。有効なオプションは次のとおりです:

- target - WebLogic Serverインスタンスの名前、またはシステム・コンポーネントを記述する文字列。システム・コンポーネントの詳細は、コンポーネントのドキュメントを参照してください。
デフォルト値はWLSTが接続しているサーバーです。

- name - ログ・ハンドラの名前。名前を指定しない場合、すべてのハンドラを表示します。

例

次の例では、すべてのログ・ハンドラの一覧を表示します。

listLogHandlers()

次の例では、「odl-handler」という名前のログ・ハンドラをすべて表示します。

listLogHandlers(name="odl-handler")

次の例では、WebLogic Server server1のすべてのログ・ハンドラを一覧表示します。

listLogHandlers(target="server1")

setLogLevel

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

WLSTでの使用: オンライン

説明

特定のJavaロガーによってログ・ファイルに書き込まれた情報のレベルを設定します。

構文

setLogLevel(options)

引数

定義

options

オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:

- 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 (最低の重大度)までです。
このオプションは必須で、デフォルト値はありません。

- runtime - 操作は実行時ロガーまたは構成ロガーをリストするかを決定するJythonブール値(0または1)。デフォルト値は1 (実行時)です。ターゲットが、変化するランタイム・ロガーをサポートしないシステム・コンポーネントである場合、このオプションは無視されます。
注意: ランタイム・ロガーはガベージ・コレクションされる可能性があるため、ランタイム・ロガーのレベルの変更は、ロガーが存在しており、かつそのロガーへの強参照があることがわかっている場合にのみ行うようにしてください。ロガーがガベージ・コレクションされた場合、ランタイム・モードでロガー・レベルに加えられた永続的ではない変更は、すべて失われる可能性があります。

- persist - レベルを構成ファイルに保存する必要があるかを決定するJythonブール値(0または1)。デフォルト値は1です。

例

次の例では、ロガーoracle.my.loggerのためにログ・レベルをNOTIFICATION:1に設定します。

setLogLevel(logger="oracle.my.logger", level="NOTICATION: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-3のコマンドを使用して、Oracle Fusion Middlewareログ・ファイルを表示し、特定のメッセージのログ・ファイルを検索します。

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

このコマンドを使用します...

次を行うには...

WLSTの使用...

displayLogs

1つまたは複数のログを表示します。

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

listLogs

ログ・ファイルの内容を検索し、表示します。

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

displayLogs

コマンド・カテゴリ: 検索および表示

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

説明

診断ログ・ファイルの内容を検索し、表示します。コマンドは、returnDataオプションをtrueに設定した場合のみ値を返します。デフォルトでは、このコマンドによってデータは返されません。戻り値は使用するオプションによって異なります。

構文

displayLogs([searchString,][options])

引数

定義

searchString

オプションの検索文字列。指定した文字列(大文字と小文字は区別されない)を含むメッセージのみが返されます。

displayLogsコマンドでは、複数のフォーマットでログを読み込むことができ、ODLフォーマットにメッセージを変換できます。検索は、できるだけネイティブ・フォーマットで実行されます。それ以外の場合、検索がメッセージ・コンテンツ内に実行され、マークアップを除外する場合もあります。したがって、検索文字列でマークアップ文字の使用を避ける必要があります。

options

オプションのカンマ区切りのリスト(オプション)。名前と値のペアで指定します。有効なオプションは次のとおりです:

- target - WebLogic Serverインスタンスまたはシステム・コンポーネントの名前。
システム・コンポーネントの場合、ターゲットの構文は次のとおりです:

opmn:instance-name/component-name

接続モードでは、デフォルトのターゲットはWebLogicドメインです。接続解除モードでは、デフォルト値がない、ターゲット・オプションは必須です。

- oracleInstance - ORACLE_INSTANCEまたはWebLogicドメイン・ホームへのパスを定義します。このパラメータを使用すると、コマンドは接続解除モードで実行されます。

- log - ログ・ファイルのパス。コマンドは、指定したログ・ファイルからメッセージを読み込みます。ログ・ファイルのパスを指定しない場合、コマンドは、指定したターゲットに関連付けられるすべてのログを読み込みます。

options (continued)

- 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管理者ガイドを参照してください。

- groupBy - 文字列のリスト。groupByオプションを使用する場合、出力は文字列リストに定義された属性でグループしたログ・メッセージの数です。

- orderBy - 結果のソート順を定義する文字列のリスト。値はログ・メッセージ属性の名前です。必要に応じて、名前に「:asc」または「:desc」の接尾辞を追加することで昇順または降順のソートを指定できます。デフォルトのソート順を昇順です。
デフォルトでは、結果は時間でソートされます。

- returnData - Jythonブール値(0または1)。値がtrueの場合、コマンドによってデータが返されます。(たとえば、スクリプトで使用するデータ)。デフォルト値がfalseです。つまり、コマンドはデータを表示するだけで、戻しません。

options (continued)

- format - 出力形式を定義する文字列。有効な値は、ODL-Text、ODL-XML、ODL-completeおよびsimpleです。デフォルト形式はODL-Textです。

- exportFile - コマンドの出力が書き込まれるファイル名。デフォルトでは、出力は標準出力に書き込まれます。

- follow (f) - ログに新しいメッセージが追加されるとき、ログを引き続き読み込んでメッセージを表示するために、コマンドをfollowモードに設定します(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="opmn:instance1/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")

listLogs

コマンド・カテゴリ: 検索および表示

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

説明

Oracle Fusion Middlewareコンポーネントのログ・ファイルの一覧を表示します。このコマンドは、ログごとに1つの要素を含むPyArrayを返します。配列の要素は、各ログを記述するjavax.management.openmbean.CompositeDataオブジェクトです。

構文

listLogs([options]

引数

定義

options

オプションのカンマ区切りのリスト(オプション)。名前と値のペアで指定します。有効なオプションは次のとおりです:

- target - WebLogic ServerインスタンスまたはOracle Fusion Middlewareシステム・コンポーネントの名前。
システム・コンポーネントの場合、ターゲットの構文は次のとおりです:

opmn:instance-name/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="opmn:instance1/ohs1")

接続解除モードで使用される次の例では、WebLogic Server server1のログ・ファイルを一覧表示します。

listLogs(oracleInstance="/middleware/user_projects/domains/base_domain",
target="server1")

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

表7-4のコマンドを使用して、選択的トレースを構成および使用します。選択的トレースにより、指定されたユーザーまたはリクエストの他のプロパティに対するきめ細かいロギングを実行することができます。WLST列で使用する場合は、オンラインとは、コマンドが実行中のサーバーに接続されている場合のみに使用されることを意味します。

表7-4 トレース・コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

configureTracingLoggers

選択的トレースに対する1つ以上のロガーを構成します。

オンライン

listActiveTraces

アクティブなトレースを一覧表示します。

オンライン

listTracingLoggers

選択的トレースをサポートしているロガーを一覧表示します。

オンライン

startTracing

選択的トレース・セッションを開始します。

オンライン

stopTracing

1つ以上の選択的トレース・セッションを停止します。

オンライン

configureTracingLoggers

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

WLSTでの使用: オンライン

説明

選択的トレースに対する1つ以上のロガーを構成します。このコマンドはまた、選択的トレースに対するロガーを有効または無効にします。

構文

configureTracingLoggers([options])

引数

定義

options

オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:

- target - オプション。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ドメイン内の、JRFが有効なすべての実行中のサーバー・インスタンス上のロガーがトレースに対して構成されます。

- pattern - ロガー名をフィルタするために使用する正規表現パターン。デフォルト値は、すべてのトレース・ロガー名に一致します。

- action --- トレースに対するすべてのロガーを有効または無効にします。有効な値は、enableおよびdisableです。このオプションは必須で、デフォルト値はありません。

例

次の例では、oracle.securityで始まるすべてのロガーについて選択的トレースを構成します。

configureTracingLoggers(pattern='oracle.security.*', action="enable")
Configured 62 loggers

次の例では、すべてのロガーについて選択的トレースを無効にします。

configureTracingLoggers(action="disable")
Configured 1244 loggers

listActiveTraces

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

WLSTでの使用: オンライン

説明

アクティブなトレースを一覧表示します。

構文

listActiveTraces([options])

引数

定義

options

オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:

- target - オプション。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ドメイン内の、JRFが有効なすべての実行中のサーバー・インスタンス上のロガーが一覧表示されます。

例

次の例では、アクティブなトレースを一覧表示します。

listActiveTraces()
-------------------------------------+----------+-----------+------+-----------+-----------
Trace ID                             |Attr. Name|Attr. Value| Level| Exp. Time |Description
-------------------------------------+----------+-----------+------+-----------+-----------
a9580e65-13c4-420b-977e-5ba7dd88ca7f |USER_ID   |user1      | FINE |           |
a04b47f7-2830-4d80-92ee-ba160cdacf6b |USER_ID  | user2     | FINE |           |

listTracingLoggers

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

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

説明

選択的トレースをサポートしているロガーを一覧表示します。このコマンドは、ロガー名およびそのトレース・ステータスの表を表示します。ステータスenabledは、すべてのサーバー上のトレースでロガーが有効であることを意味します。ステータスdisabledは、すべてのサーバー上のトレースでロガーが無効であることを意味します。ステータスmixedは、一部のサーバー上のトレースではロガーが有効であり、他のサーバー上のトレースではロガーが無効であることを意味します。

構文

listTracingLoggers([options])

引数

定義

options

オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:

- target - オプション。WebLogic Serverインスタンスの名前、または1つ以上のターゲット名を含む文字列の配列。デフォルトでは、ドメイン内の、JRFが有効なすべての実行中のサーバー・インスタンス上のロガーが一覧表示されます。

- pattern - ロガー名をフィルタするために使用する正規表現パターン。デフォルト値は、すべてのトレース・ロガー名に一致します。

例

次の例では、oracle.securityで始まるすべてのトレース・ロガーを一覧表示します。

listTracingLoggers(pattern="oracle.security.*")
------------------------------------------------------------------+--------
Logger                                                            | Status
------------------------------------------------------------------+--------
oracle.security                                                   | enabled
oracle.security.audit.logger                                      | enabled
oracle.security.jps.az.common.util.JpsLock                        | enabled
.
.
.

startTracing

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

WLSTでの使用: オンライン

説明

指定されたユーザーまたはDMSコンテキスト属性に対する新しい選択的トレース・セッションを、指定されたトレース・レベルで開始します。

構文

startTracing([options])

引数

定義

options

オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:

- 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管理者ガイドのODL、Oracle WebLogic ServerおよびJava間のログ・レベルのマッピングに関する項の表を参照してください。

- desc - オプション。トレース・セッションの説明。

例

次の例では、user1に関連付けられているメッセージのトレースを開始し、情報のレベルをFINEに設定します。

startTracing(user="user1",level="FINE")
Started tracing with ID: 885649f7-8efd-4a7a-9898-accbfc0bbba3

stopTracing

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

WLSTでの使用: オンライン

説明

1つ以上の選択的トレース・セッションを停止します。

構文

stopTracing([options])

引数

定義

options

オプションのカンマ区切りのリスト。名前と値のペアで指定します。有効なオプションは次のとおりです:

- 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引数が指定されていない場合は必須。

例

次の例では、指定されたtraceIdを持つトレース・セッションを停止します。

stopTracing(traceId="a04b47f7-2830-4d80-92ee-ba160cdacf6b")
Stopped 1 traces

次の例では、すべてのトレース・セッションを停止します。

stopTracing(stopAll=1)
Stopped 1 traces

8 メタデータ・サービス(MDS)カスタムWLSTコマンド

表8-1のカテゴリのOracle メタデータ・サービス(MDS)のコマンドを使用して、MDSを管理します。

MDSリポジトリの作成および管理の詳細は、Oracle Fusion Middleware管理者ガイドのOracleメタデータ・リポジトリの管理に関する項を参照してください。各操作を実行するために必要なロールの詳細は、Oracle Fusion Middleware管理者ガイドのMDS操作の理解に関する項を参照してください。

注意:

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

表8-1 MDSコマンドのカテゴリ

コマンド・カテゴリ

説明

リポジトリ管理コマンド

MDSリポジトリを管理します。

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

MDSリポジトリのアプリケーション・メタデータを管理します。

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

MDSリポジトリ内のサンドボックスのメタデータを管理します。

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

アプリケーションのラベルを管理します。

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

アプリケーションのデプロイメントを管理します。

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

テナントを管理します。

リポジトリ管理コマンド

表8-2に示すMDSコマンドを使用して、MDSリポジトリを管理します。「WLSTでの使用」列で、オンラインとは、実行中の管理サーバーに接続されている場合にのみ、コマンドが使用可能であることを意味します。オフラインとは、コマンドが実行中のサーバーに接続されてない場合のみに使用されることを意味します。オンラインまたはオフラインとは、コマンドは両方の状況に使用できることを意味します。

表8-2 リポジトリ管理コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

createMetadataPartition

メタデータ・リポジトリ・パーティションを作成します。

オンライン

deleteMetadataPartition

メタデータ・リポジトリ・パーティションを削除します。

オンライン

deregisterMetadataDBRepository

データベース・ベースのMDSリポジトリを登録解除します。

オンライン

registerMetadataDBRepository

データベース・ベースのMDSリポジトリを登録します。

オンライン

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"

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

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.

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','x','server1, server2')
Executing operation: registerMetadataDBRepository.
Metadata DB repository "mds-myrepos" was registered successfully.
'mds-myrepos'

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

表8-3のコマンドを使用して、アプリケーション・メタデータを管理します。

表8-3 アプリケーション・メタデータ・コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

deleteMetadata

アプリケーション・リポジトリのメタデータを削除します。

オンライン

exportMetadata

アプリケーションのメタデータをエクスポートします。

オンライン

importMetadata

アプリケーションのメタデータをインポートします。

オンライン

purgeMetadata

メタデータをパージします。

オンライン

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

exportMetadata

コマンド・カテゴリ: アプリケーション・メタデータ

WLSTでの使用: オンライン

説明

アプリケーション・メタデータをエクスポートします。このコマンドおよびimportMetadataコマンドを使用して、アプリケーション・メタデータを、あるサーバー位置(たとえばテスト・システム)から別のサーバー位置(たとえば本番システム)に転送します。

このコマンドは、カスタマイズも含めてアプリケーション・メタデータをエクスポートします。ただし、デフォルトでは、adf.config.xmlのcust-config要素で定義されているカスタマイズ・クラスのカスタマイズのみがエクスポートされます。宣言されていないカスタマイズ・クラスのカスタマイズをエクスポートするには、restrictCustToオプションを使用します。

構文

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管理者ガイドのメタデータのテスト・システムから本番システムへの移動に関する項を参照してください。

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.

importMetadata

コマンド・カテゴリ: アプリケーション・メタデータ

WLSTでの使用: オンライン

説明

アプリケーション・メタデータをインポートします。exportMetadataコマンドおよびこのコマンドを使用して、アプリケーション・メタデータを、あるサーバー位置(たとえばテスト・システム)から別のサーバー位置(たとえば本番・システム)に転送します。

構文

importMetadata(application, server, fromLocation  [, docs]
[, restrictCustTo] [, excludeAllCust] [, excludeBaseDocs]
[, excludeExtendedMetadata] [, excludeUnmodifiedDocs]
[, cancelOnException] [, applicationVersion] [, remote] [, tenantName])

引数

定義

application

メタデータをインポートするアプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。

fromLocation

転送するドキュメントの選択元となるソース・ディレクトリまたはアーカイブ・ファイル。ディレクトリにエクスポートした場合、そのディレクトリは、アプリケーションが物理的にデプロイされているローカル・ディレクトリかネットワーク・ディレクトリまたはファイルである必要があります。アーカイブにエクスポートした場合、アプリケーションが物理的にデプロイされているローカル・ディレクトリかネットワーク・ディレクトリまたはファイルにあるアーカイブ、あるいはコマンドが実行されているシステムにあるアーカイブを指定できます。

この引数は、1つのサーバーから別のサーバーにメタデータを転送するときに一時ファイル・システム場所として使用できます。詳細は、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.

purgeMetadata

コマンド・カテゴリ: アプリケーション・メタデータ

WLSTでの使用: オンライン

説明

アプリケーションのリポジトリから、ラベルのないドキュメントの古い(ヒント以外の)バージョンをパージします。存続期間(olderThan引数)に基づいて、ラベルのない期限切れのドキュメントはすべてパージされます。このコマンドは、バージョニングをサポートするリポジトリ(つまり、データベース・ベースのリポジトリ)にのみ適用できます。

構文

purgeMetadata(application, server, olderThan [, applicationVersion])

引数

定義

application

パージ 操作が実行されるリポジトリでのパーティションを識別するために使用されるアプリケーションの名前。

server

このアプリケーションがデプロイされる対象サーバー。

olderThan

この値(秒単位)よりも古いドキュメント・バージョンがパージされます。

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.

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

表8-4のコマンドを使用して、サンドボックス内のメタデータを管理します。サンドボックスとは、本番システムに移動する前に変更をテストするための一時的な場所です。サンドボックスは、適用されるまでほとんどのユーザーからは見えません。

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

このコマンドを使用します...

次を行うには...

WLSTの使用...

exportSandboxMetadata

サンドボックスからメタデータをエクスポートします。

オンライン

importSandboxMetadata

サンドボックスにメタデータをインポートします。

オンライン

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リポジトリからサンドボックスをエクスポートします。

wls:/weblogic/serverConfig>exportSandboxMetadata('myapp', 'server1',
'/tmp/sandbox1.jar', 'sandbox1')

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のコンテンツをインポートします。

wls:/weblogic/serverConfig> importSandboxMetadata(application='myapp', 'server1'',
'/tmp/sandbox1.jar')

次の例では、サンドボックスsandbox1.jarを更新します。

wls:/weblogic/serverConfig>importSandboxMetadata('myapp', 'server1', '/tmp/sandbox1.jar', useExistingSandbox='true', sandboxName='sandbox1')

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

表8-5のコマンドを使用して、アプリケーションのラベルを管理します。

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

このコマンドを使用します...

次を行うには...

WLSTの使用...

createMetadataLabel

メタデータ・ラベルを作成します。

オンライン

deleteMetadataLabel

リポジトリ・パーティションからメタデータ・ラベルを削除します。

オンライン

listMetadataLabels

リポジトリ・パーティションのメタデータ・ラベルを示します。

オンライン

promoteMetadataLabel

ラベルに関連付けられるメタデータを先頭に昇格させます。

オンライン

purgeMetadataLabels

指定された条件に一致するラベルを削除します。

オンライン

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".

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".

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

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.

purgeMetadataLabels

コマンド・カテゴリ: アプリケーション・ラベル管理

WLSTでの使用: オンライン

説明

指定されたパターンまたは経過期間に一致するメタデータ・ラベルをパージまたは一覧表示しますが、ラベルの一部であったメタデータ・ドキュメントは削除しません。purgeMetadataコマンドを実行することで、ドキュメントを削除できます。

構文

purgeMetadataLabels(repository, partition [, namePattern] [, olderThanInMin]
[, infoOnly] [, tenantName])

引数

定義

repository

メタデータ・ラベルがパージまたは一覧表示されるパーティションを含むMDSリポジトリの名前。

partition

メタデータ・ラベルがパージまたは一覧表示されるパーティションの名前。

namePattern

オプション。ラベルの名前に一致するパターン。パターンには、次の特殊文字を含めることができます。

- パーセント(%)文字。これは、任意の数の文字に一致します。

- アンダースコア(_)文字。これは、正確に1つの任意の文字に一致します。

- バックスラッシュ(\)文字。これを使用すると、パーセント文字、アンダースコア文字、およびバックスラッシュ文字自体をエスケープして、それらが%、_、または\にのみ一致するようにすることができます。

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

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

表8-6のコマンドを使用して、デプロイメントを管理します。

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

このコマンドを使用します...

次を行うには...

WLSTの使用...

getMDSArchiveConfig

MDSArchiveConfigオブジェクトを返します。

オフライン

importMAR

MARをインポートします。

オンライン

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

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.

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

表8-7のコマンドを使用して、テナントを管理します。

表8-7 マルチテナンシ管理コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

deprovisionTenant

メタデータ・ストアからテナントをプロビジョニング解除します。

オンライン

listTenants

テナントを一覧表示します。

オンライン

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.

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

9 Oracle SOA SuiteカスタムWLSTコマンド

この章では、Oracle SOA SuiteのWLSTコマンドを説明します。これらのコマンドにより、WLSTを使用してSOAコンポジット・アプリケーションを構成できます。

注意:

これらのコマンドを使用するには、コンポーネントがインストールされているOracleホームからWLSTを呼び出す必要があります。Oracle Fusion Middleware管理者ガイドのカスタムWLSTコマンドの使用に関する項を参照してください。

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

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

- デプロイメント・コマンド

- SOAコンポジット・アプリケーション管理コマンド

- 構成プラン管理コマンド

- タスク検証コマンド

- SOAコンポジット・アプリケーション・コンパイルのコマンド

- SOAコンポジット・アプリケーション・パッケージ化のコマンド

- SOAコンポジット・アプリケーション・テスト・コマンド

- SOAコンポジット・アプリケーションのHTTPクライアント・ベースのエクスポートおよびインポート・コマンド

- SOAコンポジット・アプリケーションのMBeanベースのエクスポートおよびインポート・コマンド

- SOAコンポジット・アプリケーションのパーティション管理コマンド

デプロイメント、構成プランおよびテスト・スイートの詳細は、『Oracle Fusion Middleware Oracle SOA Suite開発者ガイド』を参照してください。

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

WLSTコマンドは表9-1に示すカテゴリに分かれています。

表9-1 Oracle SOA Suiteコマンド・カテゴリ

コマンド・カテゴリ

説明

デプロイメント・コマンド

SOAコンポジット・アプリケーションをデプロイおよびアンデプロイします。

SOAコンポジット・アプリケーション管理コマンド

デフォルトのリビジョン・バージョンの起動、停止、アクティブ化、リタイア、割当てを行ったり、デプロイされたSOAコンポジット・アプリケーションを一覧表示したりします。

構成プラン管理コマンド

SOAコンポジット・アプリケーションの構成プランを付加、抽出、生成および検証します。

タスク検証コマンド

人員のワークフロー・タスクを検証します。

SOAコンポジット・アプリケーション・コンパイルのコマンド

SOAコンポジット・アプリケーションをコンパイルします。

SOAコンポジット・アプリケーション・パッケージ化のコマンド

デプロイするアーカイブ・ファイルにSOAコンポジット・アプリケーションをパッケージ化します。

SOAコンポジット・アプリケーション・テスト・コマンド

本番環境へのデプロイメントの前にSOAコンポジット・アプリケーションをテストします。

SOAコンポジット・アプリケーションのHTTPクライアント・ベースのエクスポートおよびインポート・コマンド

HTTPクライアントに基づいてSOAコンポジット・アプリケーションをエクスポートおよびインポートします。

SOAコンポジット・アプリケーションのMBeanベースのエクスポートおよびインポート・コマンド

サーバー・ベースのコンポジット・ストアMBean (CompositeStoreMXBean)上でSOAコンポジット・アプリケーションをエクスポートおよびインポートします。

SOAコンポジット・アプリケーションのパーティション管理コマンド

SOAコンポジット・アプリケーションの様々なリビジョンを別々のセクションに論理的にグループ化します。

デプロイメント・コマンド

表9-2に示すデプロイメント・コマンドを使用して、SOAコンポジット・アプリケーションをデプロイおよびアンデプロイします。

表9-2 WLST構成のデプロイメント・コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

sca_deployComposite

SOAコンポジット・アプリケーションをデプロイします。

オフライン

sca_undeployComposite

SOAコンポジット・アプリケーションをアンデプロイします。

オフライン

sca_deployComposite

コマンド・カテゴリ: デプロイメント・コマンド

WLSTでの使用: オフライン

説明

Oracle WebLogic ServerにSOAコンポジット・アプリケーションをデプロイします。このコマンドは、デプロイメントのアプリケーションのアーティファクト・ファイルをパッケージ化しません。SOAコンポジット・アプリケーションのパッケージ化の詳細は、「SOAコンポジット・アプリケーション・パッケージ化のコマンド」を参照してください。

構文

sca_deployComposite(serverURL, sarLocation, [overwrite], [user], [password],
[forceDefault], [configplan], [partition])

引数

定義

serverURL

SOAインフラストラクチャ・アプリケーションをホストするサーバーのURL (たとえば、http://myhost10:7001)。

sarLocation

次のいずれかの絶対パス。

- SOAアーカイブ(SAR)ファイル。
SARファイルは、sca_という接頭辞(たとえばsca_HelloWorld_rev1.0.jar)を必要とする特殊なJARファイルです。SARファイルはデプロイメント・コマンド(sca_deployComposite()など)でデプロイできますが、通常の.jarファイルは特殊なSARファイルとしては扱われません。

- 複数のSAR、メタデータ・アーカイブ(MAR)、または両方を含むZIPファイル。

- SARファイルを含むエンタープライズ・アーカイブ(EAR)ファイル。

overwrite

オプション。既存のSOAコンポジット・アプリケーション・ファイルを上書きするかどうかを表します。

- false (デフォルト): ファイルは上書きされません。

- true: ファイルは上書きされます。

user

オプション。基本認証が構成される場合、コンポジット・デプロイヤ・サーブレットにアクセスするためのユーザー名。

password

オプション。基本認証が構成される場合、コンポジット・デプロイヤ・サーブレットにアクセスするためのパスワード。

forceDefault

オプション。デフォルトとして新しいコンポジットを設定するかどうかを表します。

- true (デフォルト): そのコンポジットをデフォルト・コンポジットにします。

- false: そのコンポジットをデフォルト・コンポジットにしません。

configplan

オプション。ZIPファイルに含まれる特定のSARファイルまたはすべてのSARファイルに適用される構成プランの絶対パス。

partition

オプション。SOAコンポジット・アプリケーションがデプロイされるパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、コンポジットはdefaultパーティションに自動的にデプロイされます。

注意:

タスク・マップ属性(以前はフレックス・フィールド・マッピングと呼ばれていました)やルール(たとえば休暇ルール)などのヒューマン・ワークフロー・アーティファクトは、タスク定義のネームスペースに基づいて定義されます。そのため、ヒューマン・ワークフロー・タスクのあるSOAコンポジット・アプリケーションを複数のパーティションにデプロイする場合は、次の問題が発生します。

- タスク定義タイプが同じ場合は、あるパーティションで定義されたマップ属性は他のパーティションでも参照できます。

- あるパーティションのタスク定義で定義されたルールは、他のパーティションの同じ定義に適用できます。

例

次の例では、HelloWorldアプリケーションをデプロイします。

wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost10:7001",
"/tmp/sca_HelloWorld_rev1.0.jar")

次の例では、デフォルト・バージョンとしてHelloWorldアプリケーションをデプロイします。

wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost10:7001",
"/tmp/sca_HelloWorld_rev1.0.jar", true)

次の例では、基本認証が構成された場合、ユーザー名を必要とするHelloWorldアプリケーションをデプロイします。次に、このユーザー名のパスワードを指定するように求められます。

wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost10:7001",
"/tmp/sca_HelloWorld_rev1.0.jar", user="weblogic")
Password:

次の例では、HelloWorldアプリケーションをデプロイし、deployplan.xmlという構成プランを適用します。

wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost10:7001",
"/tmp/sca_HelloWorld_rev1.0.jar", forceDefault=false,
configplan="/tmp/deployplan.xml")

次の例では、複数のSARまたはMAR、あるいはその両方を含むHelloWorld ZIPファイルをデプロイします。

wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost:7001",
"/tmp/HelloWorld.zip")

次の例では、HelloWorldアプリケーションをmyPartitionパーティションにデプロイします。

wls:/mydomain/ServerConfig> sca_deployComposite("http://stadp10:7001",
"/tmp/sca_HelloWorld_rev1.0.jar", partition="myPartition")

sca_undeployComposite

コマンド・カテゴリ: デプロイメント・コマンド

WLSTでの使用: オフライン

説明

現在デプロイされたSOAコンポジット・アプリケーションをアンデプロイします。

構文

sca_undeployComposite(serverURL, compositeName, revision, [user], [password], [partition])

引数

定義

serverURL

SOAインフラストラクチャ・アプリケーションをホストするサーバーのURL (たとえば、http://myhost10:7001)。

compositeName

SOAコンポジット・アプリケーションの名前。

revision

SOAコンポジット・アプリケーションのリビジョンID。

user

オプション。基本認証が構成される場合、コンポジット・デプロイヤ・サーブレットにアクセスするためのユーザー名。

password

オプション。基本認証が構成される場合、コンポジット・デプロイヤ・サーブレットにアクセスするためのパスワード。

partition

オプション。SOAコンポジット・アプリケーションが存在するパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、SOAコンポジット・アプリケーションのdefaultパーティションが検索されます。ただし、他のパーティションは検索されません。

例

次の例では、HelloWorldアプリケーションをアンデプロイします。

wls:/mydomain/ServerConfig> sca_undeployComposite("http://myhost10:7001",
"HelloWorld", "1.0")

次の例では、基本認証が構成された場合、ユーザー名を必要とするHelloWorldアプリケーションをアンデプロイします。次に、このユーザー名のパスワードを指定するように求められます。

wls:/mydomain/ServerConfig> sca_undeployComposite("http://myhost10:7001",
"HelloWorld", "1.0", user="weblogic")
Password:

次の例では、myPartitionパーティション内のHelloWorldアプリケーションをアンデプロイします。

wls:/mydomain/ServerConfig> sca_undeployComposite("http://stadp10:7001",
"HelloWorld", "1.0", partition='myPartition')

SOAコンポジット・アプリケーション管理コマンド

表9-3に示す管理コマンドを使用して、デフォルトのリビジョン・バージョンの起動、停止、アクティブ化、リタイア、割当てを行ったり、デプロイされたSOAコンポジット・アプリケーションを一覧表示したりします。

表9-3 WLST構成のSOAコンポジット・アプリケーション管理コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

sca_startComposite

以前に停止したSOAコンポジット・アプリケーションを起動します。

オフライン

sca_stopComposite

SOAコンポジット・アプリケーションを停止します。

オフライン

sca_activateComposite

以前にリタイアしたSOAコンポジット・アプリケーションをアクティブ化します。

オフライン

sca_retireComposite

SOAコンポジット・アプリケーションをリタイアします。

オフライン

sca_assignDefaultComposite

SOAコンポジット・アプリケーションにデフォルトのリビジョン・バージョンを割り当てます。

オフライン

sca_getDefaultCompositeRevision

指定されたコンポジット・シリーズのデフォルト・コンポジットのリビジョンを一覧表示します。

オフライン

sca_listDeployedComposites

デプロイされたSOAコンポジット・アプリケーションを示します。

オフライン

sca_startComposite

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オフライン

説明

以前に停止したSOAコンポジット・アプリケーションを起動します。

構文

sca_startComposite(host, port, user, password, compositeName, revision, [label], [partition])

引数

定義

host

Oracle WebLogic Serverのホスト名(たとえば、myhost)。

port

Oracle WebLogic Serverのポート(たとえば、7001)。

user

実行中のサーバーに接続しMBean情報を取得するためのユーザー名(たとえば、weblogic)。

password

ユーザー名のパスワード。

compositeName

SOAコンポジット・アプリケーションの名前。

revision

SOAコンポジット・アプリケーションのリビジョン。

label

オプション。SOAコンポジット・アプリケーションのラベル。ラベルは、アプリケーションに関連付けられるメタデータ・サービス(MDS)のアーティファクトを識別します。ラベルを指定しない場合、システムによって最新のラベルが取得されます。

partition

オプション。SOAコンポジット・アプリケーションが存在するパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、SOAコンポジット・アプリケーションのdefaultパーティションが検索されます。ただし、他のパーティションは検索されません。

例

次の例では、HelloWorldアプリケーションのリビジョン1.0を起動します。

wls:/mydomain/ServerConfig> sca_startComposite("myhost", "7001", "weblogic",
"welcome1", "HelloWorld", "1.0")

次の例では、パーティションmyPartition内のHelloWorldアプリケーションのリビジョン1.0を起動します。

wls:/mydomain/ServerConfig> sca_startComposite("stadp10", "7001", "weblogic",
"weblogic", "HelloWorld", "1.0", partition="myPartition")

sca_stopComposite

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オフライン

説明

現在実行中のSOAコンポジット・アプリケーションを停止します。

構文

sca_stopComposite(host, port, user, password, compositeName, revision, [label],
[partition])

引数

定義

host

Oracle WebLogic Serverのホスト名(たとえば、myhost)。

port

Oracle WebLogic Serverのポート(たとえば、7001)。

user

実行中のサーバーに接続しMBean情報を取得するためのユーザー名(たとえば、weblogic)。

password

ユーザー名のパスワード。

compositeName

SOAコンポジット・アプリケーションの名前。

revision

SOAコンポジット・アプリケーションのリビジョン。

label

オプション。SOAコンポジット・アプリケーションのラベル。ラベルは、アプリケーションに関連付けられるMDSアーティファクトを識別します。ラベルを指定しない場合、システムによって最新のラベルが取得されます。

partition

オプション。SOAコンポジット・アプリケーションが存在するパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、SOAコンポジット・アプリケーションのdefaultパーティションが検索されます。ただし、他のパーティションは検索されません。

例

次の例では、HelloWorldアプリケーションのリビジョン1.0を停止します。

wls:/mydomain/ServerConfig> sca_stopComposite("myhost", "7001", "weblogic",
"welcome1", "HelloWorld", "1.0")

次の例では、パーティションmyPartition内のHelloWorldアプリケーションのリビジョン1.0を停止します。

wls:/mydomain/ServerConfig> sca_stopComposite("stadp10", "7001", "weblogic",
"weblogic", "HelloWorld", "1.0", partition="myPartition")

sca_activateComposite

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オフライン

説明

リタイアされたSOAコンポジット・アプリケーションおよびそのインスタンスをアクティブ化します。その後、新しいインスタンスを作成できます。

構文

sca_activateComposite(host, port, user, password, compositeName, revision, [label], [partition])

引数

定義

host

Oracle WebLogic Serverのホスト名(たとえば、myhost)。

port

Oracle WebLogic Serverのポート(たとえば、7001)。

user

実行中のサーバーに接続しMBean情報を取得するためのユーザー名(たとえば、weblogic)。

password

ユーザー名のパスワード。

compositeName

SOAコンポジット・アプリケーションの名前。

revision

SOAコンポジット・アプリケーションのリビジョン。

label

オプション。SOAコンポジット・アプリケーションのラベル。ラベルは、アプリケーションに関連付けられるMDSアーティファクトを識別します。ラベルを指定しない場合、システムによって最新のラベルが取得されます。

partition

オプション。SOAコンポジット・アプリケーションが存在するパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、SOAコンポジット・アプリケーションのdefaultパーティションが検索されます。ただし、他のパーティションは検索されません。

例

次の例では、HelloWorldアプリケーションのリビジョン1.0をアクティブ化します。

wls:/mydomain/ServerConfig> sca_activateComposite("myhost", "7001", "weblogic",
"welcome1", "HelloWorld", "1.0")

次の例では、パーティションmyPartition内のHelloWorldアプリケーションのリビジョン1.0をアクティブ化します。

wls:/mydomain/ServerConfig> sca_activateComposite("stadp10", "7001", "weblogic",
"weblogic", "HelloWorld", "1.0", partition="myPartition")

sca_retireComposite

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オフライン

説明

SOAコンポジット・アプリケーションおよびそれらの実行中のすべてのインスタンスを停止およびリタイアします。プロセス・ライフサイクルがリタイアされている場合、新しいインスタンスを作成できません。既存インスタンスは正常に完了できます。

構文

sca_retireComposite(host, port, user, password, compositeName, revision, [label],
[partition])

引数

定義

host

Oracle WebLogic Serverのホスト名(たとえば、myhost)。

port

Oracle WebLogic Serverのポート(たとえば、7001)。

user

実行中のサーバーに接続しMBean情報を取得するためのユーザー名(たとえば、weblogic)。

password

ユーザー名のパスワード。

compositeName

SOAコンポジット・アプリケーションの名前。

revision

SOAコンポジット・アプリケーションのリビジョン。

label

オプション。SOAコンポジット・アプリケーションのラベル。ラベルは、アプリケーションに関連付けられるMDSアーティファクトを識別します。ラベルを指定しない場合、システムによって最新のラベルが取得されます。

partition

オプション。SOAコンポジット・アプリケーションが存在するパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、SOAコンポジット・アプリケーションのdefaultパーティションが検索されます。ただし、他のパーティションは検索されません。

例

次の例では、HelloWorldアプリケーションのリビジョン1.0をリタイアします。

wls:/mydomain/ServerConfig> sca_retireComposite("myhost", "7001", "weblogic",
"welcome1", "HelloWorld", "1.0")

次の例では、パーティションmyPartition内のHelloWorldアプリケーションのリビジョン1.0をリタイアします。

wls:/mydomain/ServerConfig> sca_retireComposite("stadp10", "7001", "weblogic",
"weblogic", "HelloWorld", "1.0", partition="myPartition")

sca_assignDefaultComposite

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オフライン

説明

SOAコンポジット・アプリケーションリビジョンをデフォルト・バージョンとして設定します。新しい要求が受信される場合に、このリビジョンはインスタンス化されます。

構文

sca_assignDefaultComposite(host, port, user, password, compositeName, revision, [partition])

引数

定義

host

Oracle WebLogic Serverのホスト名(たとえば、myhost)。

port

Oracle WebLogic Serverのポート(たとえば、7001)。

user

実行中のサーバーに接続しMBean情報を取得するためのユーザー名(たとえば、weblogic)。

password

ユーザー名のパスワード。

compositeName

SOAコンポジット・アプリケーションの名前。

revision

SOAコンポジット・アプリケーションのリビジョン。

partition

オプション。SOAコンポジット・アプリケーションが存在するパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、SOAコンポジット・アプリケーションのdefaultパーティションが検索されます。ただし、他のパーティションは検索されません。

例

次の例では、HelloWorldアプリケーションのリビジョン1.0をデフォルト・バージョンとして設定します。

wls:/mydomain/ServerConfig> sca_assignDefaultComposite("myhost", "7001",
"weblogic", "welcome1", "HelloWorld", "1.0")

次の例では、パーティションmyPartitionにあるHelloWorldアプリケーションのリビジョン1.0をデフォルト・バージョンとして設定します。

wls:/mydomain/ServerConfig> sca_assignDefaultComposite("stadp10", "7001",
"weblogic", "weblogic", "HelloWorld", "1.0", partition="myPartition")

sca_getDefaultCompositeRevision

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オフライン

説明

指定されたコンポジット・シリーズのデフォルト・コンポジットのリビジョンを一覧表示します。

構文

sca_getDefaultCompositeRevision(host, port, user, password, compositeName,
partition)

引数

定義

host

Oracle WebLogic Serverのホスト名(たとえば、myhost)。

port

Oracle WebLogic Serverのポート(たとえば、7001)。

user

実行中のサーバーに接続しMBean情報を取得するためのユーザー名(たとえば、weblogic)。

password

ユーザー名のパスワード。

compositeName

SOAコンポジット・アプリケーションの名前。

partition

オプション。SOAコンポジット・アプリケーションが存在するパーティションの名前。デフォルト値はdefaultです。パーティションを指定しないと、SOAコンポジット・アプリケーションのデフォルト・パーティションが検索されます。ただし、他のパーティションは検索されません。

例

次の例では、指定されたコンポジット・シリーズのデフォルト・コンポジットのリビジョンを戻します。

wls:/mydomain/ServerConfig> sca_getDefaultCompositeRevision("myhost", "7001",
"weblogic", "weblogic","HelloWorld")

次の例では、myPartitionというパーティション内の、指定されたコンポジット・シリーズのデフォルト・コンポジットのリビジョンを戻します。

wls:/mydomain/ServerConfig> sca_getDefaultCompositeRevision("myhost", "7001",
"weblogic", "weblogic", "HelloWorld", partition="myPartition")

sca_listDeployedComposites

コマンド・カテゴリ: アプリケーション管理コマンド

WLSTでの使用: オフライン

説明

SOAプラットフォームにデプロイされたすべてのSOAコンポジット・アプリケーションを示します。

構文

sca_listDeployedComposites(host, port, user, password)

引数

定義

host

Oracle WebLogic Serverのホスト名(たとえば、myhost)。

port

Oracle WebLogic Serverのポート(たとえば、7001)。

user

実行中のサーバーに接続しMBean情報を取得するためのユーザー名(たとえば、weblogic)。

password

ユーザー名のパスワード。

例

次の例では、サーバーmyhost上のデプロイされたすべてのSOAコンポジット・アプリケーションを示します。

wls:/mydomain/ServerConfig> sca_listDeployedComposites('myhost', '7001',
'weblogic', 'welcome1')

構成プラン管理コマンド

表9-4に示す構成プラン管理のコマンドを使用して、SOAコンポジット・アプリケーションの構成プランを付加、抽出、生成および検証します。

表9-4 WLST構成の構成プラン管理のコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

sca_attachPlan

SOAコンポジット・アプリケーションJARファイルに構成プラン・ファイルを付加します。

オフライン

sca_extractPlan

編集するためにJARファイルにパッケージ化された構成プランを抽出します。

オフライン

sca_generatePlan

編集の構成プランを生成します。

オフライン

sca_validatePlan

構成プランを検証します。

オフライン

sca_attachPlan

コマンド・カテゴリ: 構成プラン管理コマンド

WLSTでの使用: オフライン

説明

SOAコンポジット・アプリケーション・ファイルに構成プラン・ファイルを付加します。プランがファイルにすでに存在する場合、既存のプランは新しいプランで上書きされます。

構文

sca_attachPlan(sar, configPlan, [overwrite], [verbose])

引数

定義

sar

SARファイルの絶対パス。

configPlan

構成プラン・ファイルの絶対パス。

overwrite

オプション。SARファイルの既存の構成プランを上書きするかどうかを表します。

- false(デフォルト): プランは上書きされません。

- true: プランは上書きされます。

verbose

オプション。構成プラン添付ファイルに関する詳細な情報を出力するかどうかを表します。

- true(デフォルト): 詳細な情報を出力します。

- false: 詳細な情報を出力しません。

例

次の例では、HelloWorldアプリケーションにconfigplan.xml構成プラン・ファイルを付加します。

wls:/mydomain/ServerConfig> sca_attachPlan("/tmp/sca_HelloWorld_rev1.0.jar",
"/tmp/configplan.xml")

次の例では、HelloWorldアプリケーションの既存の構成プランをconfigplan.xmlファイルで上書きます。

wls:/mydomain/ServerConfig> sca_attachPlan("/tmp/sca_HelloWorld_rev1.0.jar", "/tmp/configplan.xml", overwrite=true)

sca_extractPlan

コマンド・カテゴリ: 構成プラン管理コマンド

WLSTでの使用: オフライン

説明

編集のために、SOAコンポジット・アプリケーション・ファイルにパッケージ化された構成プランを抽出します。これはオプションの手順です。プランが存在しない場合、これはsca_generatePlanで新しいファイルの作成と同じです。

構文

sca_extractPlan(sar, configPlan, [overwrite], [verbose])

引数

定義

sar

SARファイルの絶対パス。

configPlan

抽出する構成プラン・ファイルの絶対パス。

overwrite

オプション。SARファイルの既存の構成プラン・ファイルを上書きするかどうかを表します。

- false(デフォルト): プランは上書きされません。

- true: プランは上書きされます。

verbose

オプション。構成プラン抽出に関する詳細な情報を出力するかどうかを表します。

- true(デフォルト): 詳細な情報を出力します。

- false: 詳細な情報を出力しません。

例

次の例では、HelloWorldアプリケーションから編集するためにconfigplan.xmlファイルを抽出します。

wls:/mydomain/ServerConfig> sca_extractPlan("/tmp/sca_HelloWorld_rev1.0.jar",
"/tmp/configplan.xml")

次の例では、HelloWorldアプリケーションから編集するためにconfigplan.xmlファイルを抽出します。このコマンドによって、既存のプランも上書されます。

wls:/mydomain/ServerConfig> sca_extractPlan("/tmp/sca_HelloWorld_rev1.0.jar",
"/tmp/configplan.xml", overwrite=true)

sca_generatePlan

コマンド・カテゴリ: 構成プラン管理コマンド

WLSTでの使用: オフライン

説明

編集の構成プランを生成します。

構文

sca_generatePlan(configPlan, sar, composite, [overwrite], [verbose])

引数

定義

configPlan

生成する構成プラン・ファイルの絶対パス。

sar

SARファイルの絶対パス。

composite

展開された(解凍された) SARディレクトリにあるcomposite.xmlファイルの絶対パス。

overwrite

オプション。既存の構成プラン・ファイルを上書きするかどうかを表します。

- false(デフォルト): プランは上書きされません。

- true: プランは上書きされます。

verbose

プランの生成に関する詳細な情報を出力するかどうかを表します。

- true(デフォルト): 詳細な情報を出力します。

- false: 詳細な情報を出力しません。

例

次の例では、HelloWorldアプリケーションの構成プラン・ファイルmyplan.xmlを生成します。

wls:/mydomain/ServerConfig> sca_generatePlan("/tmp/myplan.xml",
sar="/tmp/sca_HelloWorld_rev1.0.jar")

次の例では、HelloWorldアプリケーションの構成プラン・ファイルmyplan2.xmlを生成します。myplan2.xmlファイルは既存のプランを上書きます。

wls:/mydomain/ServerConfig> sca_generatePlan("/tmp/myplan2.xml",
composite="/tmp/HelloWorld_rev1.0/composite.xml", overwrite=true)

sca_validatePlan

コマンド・カテゴリ: 構成プラン管理コマンド

WLSTでの使用: オフライン

説明

構成プランを検証します。このコマンドでは、デプロイメント時に行うすべての検索および置換の変更を示します。このオプションをデバッグのためにのみ使用します。

構文

sca_validatePlan(reportFile, configPlan, [sar], [composite], [overwrite], [verbose])

引数

定義

reportFile

生成するレポート・ファイルの絶対パス。検証の結果はこのファイルに書き込まれます。

configPlan

構成プラン・ファイルの絶対パス。

sar

オプション。SARファイルの絶対パス。

composite

オプション。展開された(解凍された) SARディレクトリにあるcomposite.xmlファイルの絶対パス。

overwrite

オプション。既存の構成プラン・ファイルを上書きするかどうかを表します。

- false(デフォルト): プランは上書きされません。

- true: プランは上書きされます。

verbose

オプション。構成プラン検証に関する詳細な情報を出力するかどうかを表します。

- true(デフォルト): 詳細な情報を出力します。

- false: 詳細な情報を出力しません。

例

次の例では、HelloWorldアプリケーションの構成プラン・ファイルconfigplan.xmlを検証します。

wls:/mydomain/ServerConfig> sca_validatePlan("/tmp/myreport.xml",
"/tmp/configplan.xml", sar="/tmp/sca_HelloWorld_rev1.0.jar")

次の例では、HelloWorldアプリケーションの構成プラン・ファイルconfigplan.xmlを検証します。configplan.xmlプランは既存のプランを上書きます。

wls:/mydomain/ServerConfig> sca_validatePlan("/tmp/myreport.xml",
"/tmp/configplan.xml",composite="/tmp/HelloWorld_rev1.0/composite.xml", overwrite=true)

タスク検証コマンド

表9-5に示すタスク検証のコマンドを使用して、人員のワークフロー・タスクを検証します。

表9-5 WLST構成のタスク検証コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

sca_validateTask

人員のワークフロー・タスクを検証します。

オフライン

sca_validateTask

コマンド・カテゴリ: タスク検証コマンド

WLSTでの使用: オフライン

説明

人員のタスク・エディタに人員のタスクを設計するときに作成された.taskファイルにある人員のワークフロー・タスクを検証します。

構文

sca_validateTask(taskFile, outXml, [displayLevel])

引数

定義

taskFile

タスク定義ファイルの絶対パス(.task)。

outXml

出力XMLファイルの絶対パス。

displayLevel

オプション。表示する情報レベル。デフォルト値は1です。

例

次の例では、人員のタスクのWFTaskDefinition.taskファイルを検証します。

wls:/mydomain/ServerConfig> sca_validateTask("/tmp/WFTaskDefinition.task",
"/tmp/out.xml", displayLevel=2)

SOAコンポジット・アプリケーション・コンパイルのコマンド

表9-6に示すコンパイルのコマンドを使用して、SOAコンポジット・アプリケーションをコンパイルします。

表9-6 WLST構成のSOAコンポジット・アプリケーション・コンパイルのコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

sca_setProp

JVMシステム・プロパティを設定します。

オフライン

sca_compile

SOAコンポジット・アプリケーションをコンパイルします。

オフライン

sca_setProp

コマンド・カテゴリ: アプリケーション・コンパイルのコマンド

WLSTでの使用: オフライン

説明

JVMシステム・プロパティを設定します。このコマンドは、SSL上にsca_deployCompositeおよびsca_undeployCompositeを使用する前に、セキュア・ソケット・レイヤー(SSL)システム・プロパティも設定できます。

構文

sca_setProp(propName, propValue)

引数

定義

propName

プロパティ名。

propValue

プロパティ値。

例

次の例では、プロパティ名およびプロパティ値を設定します。

wls:/mydomain/ServerConfig> sca_setProp("oracle.home",
"/scratch/myusername/beahome/AS11gR1SOA")

sca_compile

コマンド・カテゴリ: アプリケーション・コンパイルのコマンド

WLSTでの使用: オフライン

説明

SOAコンポジット・アプリケーションをコンパイルします。

注意:

sca_compileコマンドは、ant-sca-compile.xmlスクリプトを検索するためにoracle.homeプロパティが必要です。これは一度設定する必要があります。scac_setPropコマンドまたはoracleHomeプロパティを使用して、値を設定できます。

構文

sca_compile(composite, [outXml], [error], [appHome], [displayLevel], [oracleHome])

引数

定義

composite

展開された(解凍された) SARディレクトリにあるコンポジット・ファイルの絶対パス。

outXml

オプション。出力XMLファイルの絶対パス。

error

オプション。エラー・ファイルの絶対パス。

appHome

オプション。アプリケーション・ホーム・ディレクトリの絶対パス。データが共有される場合、このプロパティが必要です。

displayLevel

オプション。表示する情報レベル。デフォルト値は1です。

oracleHome

オプション。oracle.homeプロパティ。

例

次の例では、FirstCompositeアプリケーションをコンパイルします。

wls:/mydomain/ServerConfig> sca_compile("/tmp/FirstComposite_
rev1.0/composite.xml", displayLevel=2)

次の例では、FirstCompositeアプリケーションをコンパイルし、myout.xmlファイルに詳細をキャプチャします。エラーが発生する場合、error.outファイルにキャプチャします。

wls:/mydomain/ServerConfig> sca_compile("/tmp/FirstComposite_
rev1.0/composite.xml", outXml="/tmp/myout.xml", error="error.out")

次の例では、FirstCompositeアプリケーションをコンパイルします。ant-sca-compile.xmlスクリプトを検索するためにoracleHomeプロパティ設定します。

wls:/mydomain/ServerConfig> sca_compile("/tmp/FirstComposite_
rev1.0/composite.xml", displayLevel=2,
oracleHome="/scratch/myusername/beahome/AS11gR1SOA")

SOAコンポジット・アプリケーション・パッケージ化のコマンド

表9-7に示すパッケージ化のコマンドを使用して、コンポジットSARファイルにSOAコンポジット・アプリケーションをパッケージ化します。

表9-7 WLST構成のSOAコンポジット・アプリケーション・パッケージ化のコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

sca_package

コンポジットSARファイルにSOAコンポジット・アプリケーションをパッケージ化します。

オフライン

sca_package

コマンド・カテゴリ: アプリケーション・パッケージ化のコマンド

WLSTでの使用: オフライン

説明

コンポジットSARファイルにSOAコンポジット・アプリケーション・ファイルをパッケージ化します。このコマンドは、次の操作を実行します。

- ${compositeDir}にコンポジット・アーティファクトをコンパイルするためにsca_compileを呼び出します。

- ${compositeDir}/src内のソース・コードをコンパイルするためにjavacを呼び出します。

- ${compositeDir}/composite.xmlのリビジョンを置き換えます。

- ${compositeDir}/deployにsca_${compositeName}_rev${revision}.jarを作成するためにアーティファクトをパッケージ化します。

注意:

sca_packageコマンドは、ant-sca-package.xmlスクリプトを検索するためにoracle.homeが必要です。これは一度設定する必要があります。scac_setPropコマンドまたはoracleHomeプロパティを使用して、このプロパティを設定できます。

構文

sca_package(compositeDir, compositeName, revision, [appHome], [oracleHome])

引数

定義

compositeDir

コンポジット・アーティファクトを含むディレクトリの絶対パス。

compositeName

コンポジットの名前。

revision

コンポジットのリビジョンID。

appHome

オプション。アプリケーション・ホーム・ディレクトリの絶対パス。データが共有される場合、このプロパティが必要です。

oracleHome

オプション。oracle.homeプロパティ。

例

次の例では、OrderBookingCompositeアプリケーションをパッケージ化します。このアプリケーションでは共有データが使用されるので、appHomeプロパティを設定します。

wls:/mydomain/ServerConfig> sca_package("/tmp/app_data/OrderBookingComposite",
"OrderBookingComposite", "1.0", appHome="/tmp/app_data")

次の例では、HelloSOACompositeアプリケーションをパッケージ化します。

wls:/mydomain/ServerConfig> sca_package
("/tmp/HelloSOAApplication/HelloSOAComposite", "HelloSOAComposite", "1.0")

次の例では、HelloSOACompositeアプリケーションをパッケージ化します。ant-sca-compile.xmlスクリプトを検索するためにoracleHomeプロパティ設定します。

wls:/mydomain/ServerConfig> sca_package
("/tmp/HelloSOAApplication/HelloSOAComposite", "HelloSOAComposite", "1.0",
oracleHome="/scratch/myusername/beahome/AS11gR1SOA")

SOAコンポジット・アプリケーション・テスト・コマンド

表9-8に示すSOAコンポジット・アプリケーション・テストのコマンドを使用して、SOAコンポジット・アプリケーションをテストします。

表9-8 WLST構成のSOAコンポジット・アプリケーション・テストのコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

sca_test

デプロイされたSOAコンポジット・アプリケーションをテストします。

オフライン

sca_test

コマンド・カテゴリ: アプリケーション・テストのコマンド

WLSTでの使用: オフライン

説明

本番環境にデプロイする前に、デプロイされるSOAコンポジット・アプリケーションをテストします。Oracle JDeveloperにテストのスイートを作成します。sca_testコマンドはant-sca-test.xmlを呼び出します。

構文

sca_test('compositeName', 'revision', 'testsuiteName', 'jndiPropFile',
[oracleHome='oracleHome'], [javaHome='javaHome'])

引数

定義

compositeName

SOAコンポジット・アプリケーションの名前。

revision

SOAコンポジット・アプリケーションのリビジョンID。

testsuiteName

テスト・スイートの名前。

jndiPropFile

JNDIプロパティ・ファイルの絶対パス。

oracleHome

オプション。oracle.homeシステム・プロパティ。

javaHome

オプション。java.passed.homeシステム・プロパティ。

例

次の例では、OrderBookingMainTestsuiteテスト・スイートを実行します。

wls:/mydomain/ServerConfig> sca_test('OrderBookingComposite', '1.0',
'OrderBookingMainTestsuite', '/tmp/tmp-jndi.properties',
oracleHome='/scratch/<user>/beahome/AS11gR1SOA/',
javaHome='/scratch/<user>/beahome/jdk160_05')

SOAコンポジット・アプリケーションのHTTPクライアント・ベースのエクスポートおよびインポート・コマンド

表9-9に示されているSOAコンポジット・アプリケーション・コマンドを使用して、HTTPクライアントに基づいてSOAコンポジット・アプリケーションをエクスポートおよびインポートします。これらのコマンドを使用するには、SOAインフラストラクチャが実行されている必要があります。

表9-9 WLST構成のSOAコンポジット・アプリケーションのエクスポートおよびインポート・コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

sca_exportComposite

SOAコンポジット・アプリケーションをSARファイルにエクスポートします。

オフライン

sca_exportUpdates

SOAコンポジット・アプリケーションのデプロイ後の変更をJARファイルにエクスポートします。

オフライン

sca_importUpdates

SOAコンポジット・アプリケーションのデプロイ後の変更をインポートします。

オフライン

sca_exportSharedData

指定されたパターンの共有データをJARファイルにエクスポートします。

オフライン

sca_removeSharedData

最上位の共有データ・フォルダを削除します。

オフライン

sca_exportComposite

コマンド・カテゴリ: アプリケーションのエクスポートおよびインポート・コマンド

WLSTでの使用: オフライン

説明

SOAコンポジット・アプリケーションをSARファイルにエクスポートします。

構文

sca_exportComposite(serverURL, updateType, sarFile, compositeName, revision,
[user], [password], [partition])

引数

定義

serverURL

SOAインフラストラクチャ・アプリケーションをホストするサーバーのURL(たとえば、http://stabc:8001)。

updateType

エクスポートするデプロイ後の変更のタイプ。

- all: デプロイ後の変更をすべて含みます。

- property: プロパティのデプロイ後の変更のみを含みます(バインディング・コンポーネント・プロパティ、監査レベル設定やペイロード検証ステータスなどのコンポジット・プロパティ、およびポリシー・アタッチメント)。

- runtime: 実行時(ルール・ディクショナリおよびドメイン値マップ(DVM))およびメタデータのデプロイ後の変更のみを含みます。

- none: (プロパティの変更および実行時の変更も含めて)デプロイ後の変更を含まずに元のコンポジットをエクスポートします。

sarFile

生成するSARファイル(sca_で始まる.jarファイル)の絶対パス。

compositeName

エクスポートするコンポジットの名前。

revision

エクスポートするコンポジットのリビジョン。

user

オプション。サーバーにアクセスするためのユーザー名(基本構成が行われている場合)。この引数には次の構文を使用します:

user='username'

password

オプション。サーバーにアクセスするためのパスワード(基本構成が行われている場合)。この引数には次の構文を使用します:

password='password'

partition

オプション。SOAコンポジット・アプリケーションが存在するパーティションの名前。デフォルト値はdefaultです。

例

次の例では、デプロイ後の変更を含まずにコンポジットをエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001',
'none', '/tmp/sca_HelloWorld_rev1.0.jar', 'HelloWorld', '1.0')

次の例では、デプロイ後の更新をすべて含めてコンポジットをエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001',
'all', '/tmp/sca_HelloWorld_ rev1.0-all.jar', 'HelloWorld', '1.0')

次の例では、プロパティのデプロイ後の更新を含めてコンポジットをエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001',
'property', '/tmp/sca_HelloWorld_ rev1.0-prop.jar', 'HelloWorld', '1.0')

次の例では、実行時/メタデータのデプロイ後の更新を含めてコンポジットをエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001',
'runtime', '/tmp/sca_HelloWorld_ rev1.0-runtime.jar', 'HelloWorld', '1.0')

次の例では、デプロイ後の更新を含まずに、myPartitionパーティション内のコンポジットをエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001',
'none', '/tmp/sca_HelloWorld_rev1.0.jar', 'HelloWorld', '1.0',
partition='myPartition')

sca_exportUpdates

コマンド・カテゴリ: アプリケーションのエクスポートおよびインポート・コマンド

WLSTでの使用: オフライン

説明

SOAコンポジット・アプリケーションのデプロイ後の変更をJARファイルにエクスポートします。

構文

sca_exportUpdates(serverURL, updateType, jarFile, compositeName, revision,
[user], [password], [partition])

引数

定義

serverURL

SOAインフラストラクチャ・アプリケーションをホストするサーバーのURL(たとえば、http://stabc:8001)。

updateType

エクスポートするデプロイ後の変更のタイプ。

- all: デプロイ後の変更をすべて含みます。

- property: プロパティのデプロイ後の変更のみを含みます(バインディング・コンポーネント・プロパティ、監査レベル設定やペイロード検証ステータスなどのコンポジット・プロパティ、およびポリシー・アタッチメント)。

- runtime: 実行時(ルール・ディクショナリおよびドメイン値マップ(DVM))およびメタデータのデプロイ後の変更のみを含みます。

jarFile

生成するJARファイルの絶対パス。sca_exportUpdates()では、標準のデプロイメント・コマンドを使用してインポートすることができない標準の.jarファイルが作成されます。インポートするには、sca_importUpdates()を使用する必要があります。

compositeName

エクスポートするコンポジットの名前。

revision

エクスポートするコンポジットのリビジョン。

user

オプション。サーバーにアクセスするためのユーザー名(基本構成が行われている場合)。この引数には次の構文を使用します:

user='username'

password

オプション。サーバーにアクセスするためのパスワード(基本構成が行われている場合)。この引数には次の構文を使用します:

password='password'

partition

オプション。SOAコンポジット・アプリケーションが存在するパーティションの名前。デフォルト値はdefaultです。

例

次の例では、デプロイ後の更新をすべてエクスポートします。

wls:/offline/mydomain/ServerConfig>  sca_exportUpdates('http://stabc:8001', 'all',
'/tmp/all-HelloWorld_rev1.0.jar','HelloWorld', '1.0')

次の例では、プロパティのデプロイ後の更新をエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportUpdates('http://stabc:8001',
'property','/tmp/prop-HelloWorld_ rev1.0.jar', 'HelloWorld', '1.0')

次の例では、実行時/メタデータのデプロイ後の更新をエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportUpdates('http://stabc:8001',
'runtime','/tmp/runtime-HelloWorld_ rev1.0.jar', 'HelloWorld', '1.0')

次の例では、パーティションmyPartition内のコンポジットのデプロイ後の変更をJARファイルにエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportUpdates(serverURL, updateType,
jarFile, compositeName, revision, user=None, password=None,
partition='myPartition')

sca_importUpdates

コマンド・カテゴリ: アプリケーションのエクスポートおよびインポート・コマンド

WLSTでの使用: オフライン

説明

SOAコンポジット・アプリケーションのデプロイ後の変更をインポートします。

構文

sca_importUpdates(serverURL, jarFile, compositeName, revision, [user],
[password])

引数

定義

serverURL

SOAインフラストラクチャ・アプリケーションをホストするサーバーのURL(たとえば、http://stabc:8001)。

jarFile

デプロイ後の変更を含むJARファイルの絶対パス。

compositeName

デプロイ後の変更のインポート先となるコンポジットの名前。

revision

デプロイ後の変更のインポート先となるコンポジットのリビジョン。

user

オプション。サーバーにアクセスするためのユーザー名(基本構成が行われている場合)。この引数には次の構文を使用します:

user='username'

password

オプション。サーバーにアクセスするためのパスワード(基本構成が行われている場合)。この引数には次の構文を使用します:

password='password'

partition

オプション。SOAコンポジット・アプリケーションが存在するパーティションの名前。デフォルト値はdefaultです。

例

次の例では、SOAコンポジット・アプリケーションのデプロイ後の変更をインポートします。

wls:/offline/mydomain/ServerConfig> sca_importUpdates('http://stabc:8001',
'/tmp/all-HelloWorld_rev1.0.jar', 'HelloWorld', '1.0')

次の例では、パーティションmyPartition内のコンポジットのデプロイ後の変更をインポートします。

wls:/offline/mydomain/ServerConfig> sca_importUpdates(serverURL, jarFile,
compositeName, revision, user=None, password=None, partition='myPartition')

sca_exportSharedData

コマンド・カテゴリ: アプリケーションのエクスポートおよびインポート・コマンド

WLSTでの使用: オフライン

説明

指定されたパターンの共有データをJARファイルにエクスポートします。

構文

sca_exportSharedData(serverURL, jarFile, pattern, [user], [password])

引数

定義

serverURL

SOAインフラストラクチャ・アプリケーションをホストするサーバーのURL(たとえば、http://stabc:8001)。

jarFile

生成するJARファイルの絶対パス。

pattern

MDS転送APIによってサポートされているファイル・パターン。複数のパターンを指定する場合は、デリミタとしてセミコロン(;)を使用します。パターンでは、共有データ・ネームスペース/appsを除外します。例:

/Project1/**;/Project2/**

この例では、/apps/Project1および/apps/Project2にあるすべてのドキュメントをエクスポートします。

user

オプション。サーバーにアクセスするためのユーザー名(基本構成が行われている場合)。この引数には次の構文を使用します:

user='username'

password

オプション。サーバーにアクセスするためのパスワード(基本構成が行われている場合)。この引数には次の構文を使用します:

password='password'

例

次の例では、指定されたパターンの共有データをJARファイルにエクスポートします。

wls:/offline/mydomain/ServerConfig> sca_exportSharedData('http://stabc:8001',
'/tmp/MySharedData.jar', '/Project1/**')

sca_removeSharedData

コマンド・カテゴリ: アプリケーションのエクスポートおよびインポート・コマンド

WLSTでの使用: オフライン

説明

サービス・エンジン内にデプロイされたコンポジットが存在する場合でも、最上位の共有データ・フォルダを削除します。

構文

sca_removeSharedData(serverURL, folderName, [user], [password])

引数

定義

serverURL

SOAインフラストラクチャ・アプリケーションをホストするサーバーのURL(たとえば、http://stabc:8001)。

folderName

削除する最上位の共有データ・フォルダの名前。

user

オプション。サーバーにアクセスするためのユーザー名(基本構成が行われている場合)。この引数には次の構文を使用します:

user='username'

password

オプション。サーバーにアクセスするためのパスワード(基本構成が行われている場合)。この引数には次の構文を使用します:

password='password'

例

次の例では、最上位の共有データ・フォルダProject1を削除します。

sca_removeSharedData('http://stabc:8001', 'Project1')

SOAコンポジット・アプリケーションのMBeanベースのエクスポートおよびインポート・コマンド

表9-10に示されているデプロイメント・コマンドを使用して、サーバー・ベースのコンポジット・ストアMBean (CompositeStoreMXBean)上でSOAコンポジット・アプリケーションをエクスポートおよびインポートします。

表9-10 WLST構成のSOAコンポジット・アプリケーションのエクスポートおよびインポート・コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

sca_exportCompositeMb

SOAコンポジット・アプリケーションをSARファイルにエクスポートします。

オンライン

sca_exportUpdatesMb

SOAコンポジット・アプリケーションのデプロイ後の変更をJARファイルにエクスポートします。

オンライン

sca_importUpdatesMb

SOAコンポジット・アプリケーションのデプロイ後の変更をインポートします。

オンライン

sca_exportSharedDataMb

指定されたパターンの共有データをJARファイルにエクスポートします。

オンライン

このオプションを使用する場合、エクスポート・コマンドで生成されるファイルおよびインポート・コマンドで読み取られるファイルは、サーバーが実行されているホスト(Oracle WebLogic管理サーバーまたは管理対象SOAサーバーのいずれか)上に存在する必要があることに注意してください。

コンポジット・ストアMBeanは、SOAサーバーのサーバー実行時MBeanとOracle WebLogic管理サーバーのドメイン実行時MBeanの両方として登録されます。そのため、SOAサーバーが停止している間も、インポートとエクスポートを続行することが可能になります。コンポジット・ストアMBeanの使用では、WLSTコマンドのみが提供されています。antコマンドはありません。

connect()コマンドを実行して、SOAサーバーまたはOracle WebLogic管理サーバーのいずれかに接続する必要があります。

wls:offline>connect('weblogic', 'password', 't3://stabc:8001')

SOAサーバーの停止中にドメイン実行時MBeanを使用する場合、domainRuntime()コマンドを実行する必要があります。

wls:offline>connect('weblogic', 'password', 't3://stabc:7001')
wls:/soainfra/serverConfig>domainRuntime()

sca_exportCompositeMb

コマンド・カテゴリ: アプリケーションのエクスポートおよびインポート・コマンド

WLSTでの使用: オンライン

説明

SOAコンポジット・アプリケーションをSARファイルにエクスポートします。

構文

sca_exportCompositeMb(updateType, sarFile, compositeName, revision)

引数

定義

updateType

エクスポートするデプロイ後の変更のタイプ。

- all: デプロイ後の変更がすべて含まれます。

- property: プロパティの変更が含まれます(バインディング・コンポーネント・プロパティ、監査レベル設定やペイロード検証ステータスなどのコンポジット・プロパティ、およびポリシー・アタッチメント)。

- runtime: デプロイ後の実行時の変更が含まれます(ルール・ディクショナリおよびドメイン値マップ(DVM))。

sarFile

生成するSARファイルの絶対パス。

compositeName

エクスポートするコンポジットの名前。

revision

エクスポートするコンポジットのリビジョン。

例

この例では、デプロイ後の変更を含まずにコンポジットをエクスポートします。

wls:/mydomain/ServerConfig> sca_exportCompositeMb('none', '/tmp/sca_HelloWorld_
rev1.0.jar', 'HelloWorld', '1.0')

この例では、デプロイ後の更新をすべて含めてコンポジットをエクスポートします。

wls:/mydomain/ServerConfig> sca_exportCompositeMb('all', '/tmp/sca_HelloWorld_
rev1.0-all.jar', 'HelloWorld','1.0')

この例では、プロパティのデプロイ後の更新を含めてコンポジットをエクスポートします。

wls:/mydomain/ServerConfig> sca_exportCompositeMb('property', '/tmp/sca_
HelloWorld_rev1.0-prop.jar', HelloWorld', '1.0')

この例では、実行時/メタデータのデプロイ後の更新を含めてコンポジットをエクスポートします。

wls:/mydomain/ServerConfig> sca_exportCompositeMb('runtime', '/tmp/sca_HelloWorld_
rev1.0-runtime.jar','HelloWorld', '1.0')

sca_exportUpdatesMb

コマンド・カテゴリ: アプリケーションのエクスポートおよびインポート・コマンド

WLSTでの使用: オンライン

説明

SOAコンポジット・アプリケーションのデプロイ後の変更をJARファイルにエクスポートします。

構文

sca_exportUpdatesMb(updateType, jarFile, compositeName, revision)

引数

定義

updateType

エクスポートするデプロイ後の変更のタイプ: all、propertyまたはruntime

jarFile

生成するJARファイルの絶対パス。

compositeName

エクスポートするコンポジットの名前。

revision

エクスポートするコンポジットのリビジョン。

例

次の例では、デプロイ後の更新をすべてエクスポートします。

wls:/mydomain/ServerConfig>  sca_exportUpdatesMb('all',
'/tmp/all-HelloWorld_rev1.0.jar','HelloWorld', '1.0')

次の例では、プロパティのデプロイ後の更新をエクスポートします。

wls:/mydomain/ServerConfig> sca_exportUpdatesMB('property',
'/tmp/prop-HelloWorld_ rev1.0.jar', 'HelloWorld', '1.0')

次の例では、実行時/メタデータのデプロイ後の更新をエクスポートします。

wls:/mydomain/ServerConfig> sca_exportUpdatesMB('runtime',
'/tmp/runtime-HelloWorld_ rev1.0.jar', 'HelloWorld', '1.0')

sca_importUpdatesMb

コマンド・カテゴリ: アプリケーションのエクスポートおよびインポート・コマンド

WLSTでの使用: オンライン

説明

SOAコンポジット・アプリケーションのデプロイ後の変更をインポートします。

構文

sca_importUpdatesMb(jarFile, compositeName, revision)

引数

定義

jarFile

デプロイ後の変更を含むJARファイルの絶対パス。

compositeName

デプロイ後の変更のインポート先となるコンポジットの名前。

revision

デプロイ後の変更のインポート先となるコンポジットのリビジョン。

例

次の例では、SOAコンポジット・アプリケーションのデプロイ後の変更をインポートします。

wls:/mydomain/ServerConfig> sca_importUpdatesMb('/tmp/all-HelloWorld_rev1.0.jar',
'HelloWorld', '1.0')

sca_exportSharedDataMb

コマンド・カテゴリ: アプリケーションのエクスポートおよびインポート・コマンド

WLSTでの使用: オンライン

説明

指定されたパターンの共有データをJARファイルにエクスポートします。

構文

sca_exportSharedDataMb(jarFile, pattern)

引数

定義

jarFile

生成するJARファイルの絶対パス。

pattern

MDS転送APIによってサポートされているファイル・パターン。複数のパターンを指定する場合は、デリミタとしてセミコロン(;)を使用します。パターンでは、共有データ・ネームスペース/appsを除外します。例:

/Project1/**;/Project2/**

この例では、/apps/Project1および/apps/Project2にあるすべてのドキュメントをエクスポートします。

例

この例では、指定されたパターンの共有データをJARファイルにエクスポートします。

wls:/mydomain/ServerConfig> sca_exportSharedDataMb('/tmp/MySharedData.jar',
'/Project1/**')

SOAコンポジット・アプリケーションのパーティション管理コマンド

表9-11に示されているデプロイメント・コマンドを使用して、パーティションを管理します。パーティション化により、SOAコンポジット・アプリケーションの様々なリビジョンを別々のセクションに論理的にグループ化することが可能になります。これは、Oracle BPEL Process Managerの10.1.xリリースにおけるドメインのコンセプトに似ています。

表9-11 WLST構成のSOAコンポジット・アプリケーションのパーティション管理コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

sca_createPartition

パーティションを作成します。

オンライン

sca_deletePartition

パーティションを削除する前に、パーティション内のすべてのSOAコンポジット・アプリケーションをアンデプロイします。

オンライン

sca_startCompositesInPartition

パーティション内のすべてのSOAコンポジット・アプリケーションを起動します。

オンライン

sca_stopCompositesInPartition

パーティション内のすべてのSOAコンポジット・アプリケーションを停止します。

オンライン

sca_activateCompositesInPartition

パーティション内のすべてのSOAコンポジット・アプリケーションをアクティブ化します。

オンライン

sca_retireCompositesInPartition

パーティション内のすべてのSOAコンポジット・アプリケーションをリタイアします。

オンライン

sca_listPartitions

SOAインフラストラクチャ内のすべてのパーティションを一覧表示します。

オンライン

sca_listCompositesInPartition

特定のパーティション内のすべてのコンポジットを一覧表示します。

オンライン

sca_createPartition

コマンド・カテゴリ: アプリケーションのパーティション管理コマンド

WLSTでの使用: オンライン

説明

パーティションを作成します。

構文

sca_createPartition(partitionName)

引数

定義

partitionName

パーティションの名前。

例

この例では、myPartitionという名前のパーティションを作成します。

wls:/mydomain/ServerConfig> sca_createPartition('myPartition')

sca_deletePartition

コマンド・カテゴリ: アプリケーションのパーティション管理コマンド

WLSTでの使用: オンライン

説明

パーティションを削除する前に、パーティション内のすべてのコンポジットをアンデプロイします。

構文

sca_deletePartition(partitionName)

引数

定義

partitionName

パーティションの名前。

例

この例では、パーティションを削除する前に、myPartitionパーティション内のすべてのコンポジットをアンデプロイします。

wls:/mydomain/ServerConfig> sca_deletePartition('myPartition')

sca_startCompositesInPartition

コマンド・カテゴリ: アプリケーションのパーティション管理コマンド

WLSTでの使用: オンライン

説明

パーティション内のすべてのコンポジットを起動します。

構文

sca_startCompositesInPartition(partitionName)

引数

定義

partitionName

パーティションの名前。

例

この例では、myPartitionパーティション内のすべてのコンポジットを起動します。

wls:/mydomain/ServerConfig> sca_startCompositesInPartition('myPartition')

sca_stopCompositesInPartition

コマンド・カテゴリ: アプリケーションのパーティション管理コマンド

WLSTでの使用: オンライン

説明

パーティション内のすべてのコンポジットを停止します。

構文

sca_stopCompositesInPartition(partitionName)

引数

定義

partitionName

パーティションの名前。

例

この例では、myPartitionパーティション内のすべてのコンポジットを停止します。

wls:/mydomain/ServerConfig> sca_stopCompositesInPartition('myPartition')

sca_activateCompositesInPartition

コマンド・カテゴリ: アプリケーションのパーティション管理コマンド

WLSTでの使用: オンライン

説明

パーティション内のすべてのコンポジットをアクティブ化します。

構文

sca_activateCompositesInPartition(partitionName)

引数

定義

partitionName

パーティションの名前。

例

この例では、myPartitionパーティション内のすべてのコンポジットをアクティブ化します。

wls:/mydomain/ServerConfig> sca_activateCompositesInPartition('myPartition')

sca_retireCompositesInPartition

コマンド・カテゴリ: アプリケーションのパーティション管理コマンド

WLSTでの使用: オンライン

説明

パーティション内のすべてのコンポジットをリタイアします。

構文

sca_retireCompositesInPartition(partitionName)

引数

定義

partitionName

パーティションの名前。

例

この例では、myPartitionパーティション内のすべてのコンポジットをリタイアします。

wls:/mydomain/ServerConfig> sca_retireCompositesInPartition('myPartition')

sca_listPartitions

コマンド・カテゴリ: アプリケーションのパーティション管理コマンド

WLSTでの使用: オンライン

説明

SOAインフラストラクチャ内のすべてのパーティションを一覧表示します。

構文

sca_listPartitions()

例

この例では、SOAインフラストラクチャ内のすべてのパーティションを一覧表示します。

wls:/mydomain/ServerConfig> sca_listPartitions()

sca_listCompositesInPartition

コマンド・カテゴリ: アプリケーションのパーティション管理コマンド

WLSTでの使用: オンライン

説明

パーティション内のすべてのコンポジットを一覧表示します。

構文

sca_listCompositesInPartition(partitionName)

引数

定義

partitionName

パーティションの名前。

例

この例では、myPartitionパーティション内のすべてのコンポジットを一覧表示します。

sca_listCompositesInPartition(myPartition)

10 WebCenter PortalカスタムWLSTコマンド

この章では、Oracle WebCenterのWebLogic Scripting Tool (WLST)コマンドについて説明します。これらのコマンドを使用すると、コマンド行からWebCenter Portalアプリケーションおよびコンポーネントを構成できます。WebCenter Portalの構成の詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

注意:

これらのコマンドを使用するには、コンポーネントがインストールされているOracleホームからWLSTを呼び出す必要があります。Oracle Fusion Middleware管理者ガイドのカスタムWLSTコマンドの使用に関する項を参照してください。

WebCenter PortalのWLSTコマンドを使用して行った構成変更の大部分は、WebCenter Portalアプリケーションがデプロイされている管理対象サーバーを起動した後のみ有効になります。例外は、外部アプリケーション、ポートレット・プロデューサおよびWebCenter Portalのインポートとエクスポートに対するWLSTコマンドのみです。

次の項では、WebCenter PortalのWLSTコマンドについて説明します。

- WebCenter PortalのWLSTコマンド・カテゴリ

- 一般

- 分析

- アクティビティ・グラフ

- アクティビティ・ストリーム

- コンテンツ・リポジトリ

- ディスカッションおよび通知

- 外部アプリケーション

- インスタント・メッセージおよびプレゼンス

- メール

- 通知

- 個人イベント

- パーソナライズ

- ポートレット・プロデューサ

- RSSニュース・フィード

- 検索 - Oracle SES検索

- 検索 - Oracle SES検索クローラ

- 検索 - WebCenter Portal検索

- ワークリスト

- Spacesアプリケーション

- WebCenter Portalアイデンティティ・ストア

- WebCenter Portalのインポートとエクスポート

- WebCenter Portalアップグレード

WebCenter PortalのWLSTコマンド・カテゴリ

WebCenter PortalのWLSTコマンドは、次のカテゴリにグループ化されています(表10-1)。

WebCenter PortalのWLSTコマンドを使用して行った構成変更の大部分は、WebCenter Portalアプリケーションがデプロイされている管理対象サーバーを起動した後のみ有効になります。例外は、外部アプリケーション、ポートレット・プロデューサ、およびWebCenter PortalのインポートとエクスポートのWLSTコマンドのみです。

表10-1 WLSTコマンド・カテゴリ

コマンド・カテゴリ

説明

一般

WebCenter Portalの接続を管理します。

分析

分析コレクタの接続を管理し、分析コレクタを構成します(WC_Utilities上)。

アクティビティ・グラフ

アクティビティ・グラフ・メタデータおよびプロバイダ構成を管理します(WC_Utilities上)。

アクティビティ・ストリーム

WebCenter Portalアプリケーションに対して生成されたアクティビティ・ストリーム・データをアーカイブおよびリストアします。

コンテンツ・リポジトリ

コンテンツ・リポジトリの接続を管理し、ドキュメントのサービスを設定します。

ディスカッションおよび通知

ディスカッション・サーバーの接続を管理し、ディスカッション・サービスおよびお知らせサービスを構成します。

外部アプリケーション

外部アプリケーションの接続を管理します。

インスタント・メッセージおよびプレゼンス

インスタント・メッセージおよびプレゼンス・サーバーの接続を管理し、インスタント・メッセージおよびプレゼンス・サービスを構成します。

メール

メール・サーバーの接続を管理し、メール・サービスを構成します。

通知

通知サービスの設定を管理します。

個人イベント

個人イベント・サーバーの接続を管理します。

パーソナライズ

パーソナライズ・サーバーの接続を管理します。

ポートレット・プロデューサ

ポートレット・プロデューサを管理します。

RSSニュース・フィード

RSSサービスのプロキシ設定を管理します。

検索 - Oracle SES検索

Oracle Secure Enterprise Search (SES)の接続およびその他の検索関連プロパティを管理します。

検索 - Oracle SES検索クローラ

Oracle Secure Enterprise Search (SES)クローラを管理します。

検索 - WebCenter Portal検索

Spacesアプリケーションの検索クローラを管理します。

ワークリスト

BPELサーバーの接続を管理します。

Spacesアプリケーション

Spacesワークフロー設定およびスペースのメタデータを管理します。

WebCenter Portalアイデンティティ・ストア

WebCenter Portalアプリケーションのアイデンティティ・ストアを検索するためのオプションを構成します。

WebCenter Portalのインポートとエクスポート

Spacesアプリケーション、個々のスペースおよびスペース・テンプレートだけでなく、プロデューサ・メタデータもエクスポートおよびインポートします。

一般

表10-2に示す一般コマンドを使用して、WebCenter Portalの接続を管理します。

これらのWebCenter Portal WLSTコマンドを使用して行った構成変更は、WebCenter Portalアプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

表10-2 一般WLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

deleteConnection

任意のWebCenter Portal接続を削除します。

オンライン

setWebCenterServiceFrameworkConfig

WebCenter Portalサービス・フレームワーク構成プロパティを設定します。

オンライン

getWebCenterServiceFrameworkConfig

WebCenter Portalフレームワーク構成プロパティを返します。

オンライン

webcenterErrorOccurred

最後に実行したWebCenter Portalコマンドのステータス情報を返します。

オンライン

getWebCenterConnectionTypes

WebCenter Portalの接続タイプをすべて一覧表示します。

オンライン

cloneWebCenterManagedServer

WebCenter Portal管理対象サーバーをクローニングします。

オンライン

deleteConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定されたWebCenter Portal接続を削除します。

deleteConnectionを使用してWSRPまたはPDK-Javaプロデューサ接続(deregisterWSRPProducerまたはderegisterPDKJavaProducerではなく)を削除すると、削除する必要がある場合がある、未使用のセカンダリ接続がそのまま残ります。たとえば、WSRPプロデューサの接続を削除すると、それに関連付けられるWebサービス接続がそのまま残り、PDK-Javaプロデューサの接続を削除すると、それに関連付けられるURL接続がそのまま残ります。

deleteConnectionを使用して、パーソナライズ・サービスのためのWebCenter Portal接続を削除することはできません。かわりにdeleteWCPSCMISConnection、deleteWCPSActivityGraphConnection、deleteWCPSPeopleConnectionまたはdeleteWCPSCustomConnectionを使用します。

構文

deleteConnection(appName, name, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portal接続を削除します。

wls:/weblogic/serverConfig> deleteConnection(appName='webcenter', name='MyConnection')

setWebCenterServiceFrameworkConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalサービス・フレームワーク構成プロパティ(リソース・アクション・ハンドラ・クラスやポップアップ表示プロパティなど)を設定します。

構文

setWebCenterServiceFrameworkConfig(appName, [resourceActionHandlerClassName],
[resourceActionHandlerDisplayInPopup], [server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

resourceActionHandlerClassName

オプション。サービス・フレームワーク・リソース・アクション・ハンドラによって使用されるクラス。

resourceActionHandlerDisplayInPopup

オプション。リソース・アクション・ハンドラがリソースをポップアップとインラインのどちらで表示するのかを示します。有効なオプションは、1 (true)および0 (false)です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalサービス・フレームワーク・リソース・アクション・ハンドラ・クラスをmy.company.ResourceActionHandlerに設定します。

wls:/wc_domain/domainRuntime> setWebCenterServiceFrameworkConfig(appName='webcenter',
resourceActionHandlerClassName='my.company.ResourceActionHandler')
Successfully set the WebCenter Portal service framework configuration.
Resource Action Handler class: my.company.ResourceActionHandler
To effect connection changes, you must restart the managed server on which the
WebCenter Portal application is deployed.

次の例では、WebCenter Portalサービス・フレームワーク・リソース・アクション・ハンドラのポップアップ表示値を1 (true)に設定します(他のオプションの引数は設定しません)。

wls:/wc_domain/domainRuntime>
setWebCenterServiceFrameworkConfig(appName='webcenter', resourceActionHandlerDisplayInPopup=1)
Successfully set the WebCenter Portal service framework configuration.
Resource Action Handler Display In Popup: true
To effect connection changes, you must restart the managed server on which the WebCenter Portal application is deployed.

getWebCenterServiceFrameworkConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalサービス・フレームワーク構成プロパティの設定を次のように返します。

- resourceActionHandlerClassName: WebCenter Portalサービス・フレームワーク・リソース・アクション・ハンドラによって現在使用されているクラス

- resourceActionHandlerDisplayInPopup: リソース・アクション・ハンドラがリソースをポップアップとインラインのどちらで表示するのかを示します。有効なオプションは、1 (true)および0 (false)です。

構文

getWebCenterServiceFrameworkConfig(appName, [server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、指定されたアプリケーションに対して、サービス・フレームワーク・リソース・アクション・ハンドラ・クラスおよびポップアップ表示プロパティを返します。

wls:/weblogic/serverConfig>getWebCenterServiceFrameworkConfig(appName='webcenter')
Resource Action Handler Class: my.company.ResourceActionHandler
Resource Action Handler Display In Popup: true

webcenterErrorOccurred

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

最後に実行されたWebCenter Portalコマンドのステータスを返します。

webcenterErrorOccurredコマンドを使用して、最後に実行されたWebCenter Portalコマンドのステータスを判別します。エラーが発生した場合、このコマンドは1を返し、それ以外の場合は0を返します。

構文

webcenterErrorOccurred ()

例

次の例では、エラーが発生した場合は1を返します。

wls:/mydomain/serverConfig> webcenterErrorOccurred()

getWebCenterConnectionTypes

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalの接続タイプをすべて一覧表示します。

構文

getWebCenterConnectionTypes (appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のアプリケーションのWebCenter Portal接続タイプを返します。

wls:/mydomain/serverConfig> getWebCenterConnectionTypes(appName='webcenter')

cloneWebCenterManagedServer

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定されたベース管理対象サーバーと同じリソースを使用して、新しい管理対象サーバーを作成します。

構文

cloneWebCenterManagedServer(baseManagedServer, newManagedServer, newManagedServerPort, [verbose])

引数

定義

baseManagedServer

ベース管理対象サーバーの名前。

newManagedServer

新しいクローニングされた管理対象サーバーの名前。

newManagedServerPort

新しい管理対象サーバーのポート番号。

verbose

オプション。管理対象サーバーを冗長モードで作成します。有効な値は1および0です。

1に設定すると、作成プロセス中に、診断に役立つ追加の進捗情報が表示されます。

デフォルトは0です。

例

次の例では、WC_CustomPortal管理対象サーバーのクローンを作成します。新しい管理対象サーバーの名前は、WC_CustomPortal2になります。

wls:/weblogic/serverConfig> cloneWebCenterManagedServer(baseManagedServer='WC_CustomPortal', newManagedServer='WC_CustomPortal2', newManagedServerPort=1234)

分析

分析コレクタ接続

表10-3に示すコマンドを使用して、WebCenter Portalアプリケーション用の分析コレクタ接続を管理します。OpenUsage APIを使用してWebCenter Portalアプリケーションで発生したイベントは、分析サービスおよびアクティビティ・グラフ・サービスで使用するために分析コレクタに送信できます。

これらのWebCenter Portal WLSTコマンドを使用して行った接続構成変更は、WebCenter Portalアプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

表10-3 分析コレクタ接続WLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

createAnalyticsCollectorConnection

WebCenter Portalアプリケーション用の分析コレクタへの接続を作成します。

オンライン

setAnalyticsCollectorConnection

既存の分析コレクタ接続を編集します。

オンライン

listAnalyticsCollectorConnections

WebCenter Portalアプリケーションに対して構成されている分析コレクタのすべての接続を一覧表示します。

オンライン

setDefaultAnalyticsCollectorConnection

WebCenter Portalアプリケーション用のデフォルト(またはアクティブ)分析コレクタ接続を指定します。

オンライン

listDefaultAnalyticsCollectorConnection

WebCenter Portalアプリケーションによって使用されている分析コレクタの接続詳細を返します。

オンライン

分析コレクタとクラスタ構成

表10-4に示すコマンドを使用して、WC_Utilities管理対象サーバーにデプロイされている分析コレクタのイベント収集プロパティを構成します。

分析コレクタを再構成するか、クラスタ化を設定する場合、分析コレクタがデプロイされている管理対象サーバー(WC_Utilities)を再起動する必要があります。

表10-4 分析コレクタ構成WLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

setAnalyticsCollectorConfig

分析コレクタのオプションおよびクラスタのオプション(クラスタ化環境を稼働している場合)を設定します。

オンライン

listAnalyticsCollectorConfig

分析コレクタの設定を返します。

オンライン

listAnalyticsEventTypes

分析コレクタに現在登録されているイベントを一覧表示します。

オンライン

createAnalyticsCollectorConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定されたWebCenter Portalアプリケーション用の分析コレクタへの接続を作成します。

OpenUsage APIを使用してWebCenter Portalアプリケーションで発生したイベントは、分析サービスおよびアクティビティ・グラフ・サービスで使用するために分析コレクタに送信できます。

1つのWebCenter Portalアプリケーションに対して複数の分析コレクタ接続を登録できますが、使用される分析コレクタ接続は1つのみであり、default=1の場合、デフォルト(またはアクティブな)接続が使用されます。

構文

createAnalyticsCollectorConnection(appName, name, [isUnicast, collectorhost,
clusterName, collectorPort, isEnabled, timeout, default, server,
applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内ですべての接続タイプにわたって一意である必要があります。

isUnicast

オプション。クラスタ化された分析コレクタにイベントをマルチキャスト・モードで送信するか、ユニキャスト通信を使用する単一の分析コレクタが必要かを指定します。有効な値は、1 (true)および0 (false)です。デフォルト値は1 (ユニキャスト)です。

collectorHost

オプション。分析コレクタを実行しているホスト名。デフォルト値はlocalhostです。

ユニキャスト通信である場合、つまりisUnicast='1'である場合にのみ必要です。

clusterName

オプション。クラスタ化分析コレクタを実行しているクラスタの名前。

マルチキャスト通信である場合、つまりisUnicast=0である場合にのみ必要です。

collectorPort

オプション。分析コレクタがイベントをリスニングするポート。デフォルト値は31314です。

isEnabled

オプション。OpenUsage APIを使用して発生した分析イベントを分析コレクタに送信するかどうかを指定します。有効な値は、1 (true)および0 (false)です。デフォルト値は0です。

isEnabled=1およびdefault=1である場合、分析イベントは分析コレクタに送信されます。

timeout

オプション。分析コレクタからの応答を待つ時間の長さ(秒単位)。デフォルト値は30です。

マルチキャスト通信である場合、つまりisUnicast=0である場合にのみ必要です。

default

オプション。この接続が、WebCenter Portalアプリケーション用のデフォルト(またはアクティブ)分析コレクタ接続であるかどうかを示します。有効な値は、1 (true)および0 (false)です。1に設定した場合、WebCenter Portalアプリケーションはこの接続上でイベントを送信します。0に設定すると、その接続は使用されません。この引数のデフォルトは0です。

1つのWebCenter Portalアプリケーションに対して複数の分析コレクタ接続を登録できますが、分析およびアクティビティ・グラフ・サービスによって使用される接続は1つのみであり、デフォルト(またはアクティブな)接続が使用されます。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のWebCenter Portalアプリケーション用にMyAnalyticsCollectorという名前の接続を作成します。イベントは、ユニキャスト通信を使用する単一の分析コレクタに送信されます。

wls:/weblogic/serverConfig>createAnalyticsCollectorConnection(appName='webcenter', connectionName='MyAnalyticsCollector', isUnicast=1,
collectorHost='myhost.com', collectorPort=31314, isEnabled=1, timeout=30, default=1)

次の例では、webcenterという名前のWebCenter Portalアプリケーション用にMyAnalyticsCollectorという名前の接続を作成します。イベントは、マルチキャスト・モードでクラスタ化分析コレクタに送信されます

wls:/weblogic/serverConfig>createAnalyticsCollectorConnection(appName='webcenter',
connectionName='MyAnalyticsCollector', isUnicast=0, clusterName='collector-cluster',
ccollectorPort=31314, isEnabled=1, timeout=30, default=1)

setAnalyticsCollectorConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定されたWebCenter Portalアプリケーション用の既存の分析コレクタ接続を編集します。

OpenUsage APIを使用してWebCenter Portalアプリケーションで発生したイベントは、分析サービスおよびアクティビティ・グラフ・サービスで使用するために分析コレクタに送信できます。

1つのWebCenter Portalアプリケーションに対して複数の分析コレクタ接続を登録できますが、使用される分析コレクタ接続は1つのみであり、デフォルト(またはアクティブな)接続が使用されます。

構文

setAnalyticsCollectorConnection(appName, name, [isUnicast, collectorHost, clusterName, collectorPort, isEnabled, timeout, default, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

name

接続の名前を示します。名前は(WebCenter Portalアプリケーション内ですべての接続タイプにわたって)一意である必要があります。

isUnicast

オプション。クラスタ化された分析コレクタにイベントをマルチキャスト・モードで送信するか、ユニキャスト通信を使用する単一の分析コレクタが必要かを指定します。

collectorHost

オプション。分析コレクタを実行しているホスト名。デフォルト値はlocalhostです。

ユニキャスト通信である場合、つまりisUnicast=1である場合にのみ必要です。

clusterName

オプション。クラスタ化分析コレクタを実行しているクラスタの名前。

マルチキャスト通信である場合、つまりisUnicast=0である場合にのみ必要です。

collectorPort

オプション。分析コレクタがイベントをリスニングするポート。デフォルト値は31314です。

isEnabled

オプション。OpenUsage APIを使用して発生した分析イベントを分析コレクタに送信するかどうかを指定します。有効な値は、1 (true)および0 (false)です。デフォルト値はfalseです。

isEnabled=1およびdefault=1である場合、分析イベントは分析コレクタに送信されます。

timeout

オプション。分析コレクタからの応答を待つ時間の長さ(秒単位)。デフォルト値は30です。

マルチキャスト通信である場合、つまりisUnicast=0である場合にのみ必要です。

default

オプション。この接続が、WebCenter Portalアプリケーション用のデフォルト(またはアクティブ)分析コレクタ接続であるかどうかを示します。有効な値は、1 (true)および0 (false)です。1に設定した場合、WebCenter Portalアプリケーションはこの接続上でイベントを送信します。0に設定すると、その接続は使用されません。この引数のデフォルトは0です。

1つのWebCenter Portalアプリケーションに対して複数の分析コレクタ接続を登録できますが、分析およびアクティビティ・グラフ・サービスによって使用される接続は1つのみであり、デフォルト(またはアクティブな)接続が使用されます。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MyAnalyticsCollectorという名前の既存の分析コレクタ接続のホストおよびポートの詳細を更新します。この接続では、イベントは、ユニキャスト・モードで単一の分析コレクタに送信されます。

wls:/weblogic/serverConfig>setAnalyticsCollectorConnection(appName='webcenter', connectionName='MyAnalyticsCollector', collectorHost='myhost.com', collectorPort=31314)

次の例では、MyAnalyticsCollectorという名前の既存の分析コレクタ接続のクラスタ、ポートおよびタイムアウトの詳細を更新します。この接続では、イベントは、マルチキャスト・モードでクラスタ化分析コレクタに送信されます。

wls:/weblogic/serverConfig>setAnalyticsCollectorConnection(appName='webcenter',
connectionName='MyAnalyticsCollector', clusterName='collector-cluster', collectorPort=31314, timeout=60)

listAnalyticsCollectorConnections

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定されたWebCenter Portalアプリケーションに対して構成されているすべての分析コレクタ接続の接続名および詳細を一覧表示します。

構文

listAnalyticsCollectorConnections(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、現在、webcenterという名前のアプリケーションに対して構成されているすべての分析コレクタ接続の接続名と詳細を一覧表示します。

wls:/weblogic/serverConfig>listAnalyticsCollectorConnections(appName='webcenter')

setDefaultAnalyticsCollectorConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定されたWebCenter Portalアプリケーション用のデフォルト分析コレクタ接続を指定します。

デフォルト分析コレクタ接続は、OpenUsage APIを使用してWebCenter Portalアプリケーションで発生したイベントを分析サービスおよびアクティビティ・グラフ・サービスで使用するために分析コレクタに送信するのに使用されます。

1つのWebCenter Portalアプリケーションに対して複数の分析コレクタ接続を登録できますが、使用される分析コレクタ接続は1つのみであり、デフォルト(またはアクティブな)接続が使用されます。

構文

setDefaultAnalyticsCollectorConnection(appName, name, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存の分析コレクタ接続の名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のアプリケーションで発生したイベント用にMyAnalyticsCollectorという接続を構成します。

wls:/weblogic/serverConfig> setDefaultAnalyticsCollectorConnection
(appName='webcenter', name='myAnalyticsCollector')

listDefaultAnalyticsCollectorConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalアプリケーションに対して現在構成されている分析コレクタ接続に関する詳細を返します。

1つのWebCenter Portalアプリケーションに対して複数の分析コレクタ接続を登録できますが、使用される分析コレクタ接続は1つのみであり、デフォルト(またはアクティブな)接続が使用されます。

構文

listDefaultAnalyticsCollectorConnection(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のWebCenter Portalアプリケーションに対して現在構成されている分析コレクタ接続に関する詳細を返します。

wls:/weblogic/serverConfig>listDefaultAnalyticsCollectorConnection(appName='webcenter')

setAnalyticsCollectorConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WC_Utilities管理対象サーバーにデプロイされている分析コレクタを構成します。さらに、クラスタ化環境では、このコマンドを使用してクラスタ設定を設定します。

構文

setAnalyticsCollectorConfig(appName, [collectorHost, defaultPort, maxPort, broadcastType, clusterEnabled, clusterName, clusterBroadcastFrequency, server, applicationVersion])

引数

定義

appName

分析コレクタ・アプリケーションの名前。

collectorHost

オプション。分析コレクタが実行されているホストの名前。デフォルト値はlocalhostです。

defaultPort

オプション。分析コレクタがリスニングするデフォルト・ポート番号。デフォルト値は31314です。

maxPort

オプション。リスナーを割り当てるときに分析コレクタが使用できる最も大きいポート番号。

このプロパティは、多くの場合、複数のコレクタが同じボックス内で実行されているクラスタ化環境で使用されます。各コレクタは、指定されているポート範囲内の空きポートで受信UDPメッセージをリスニングします。範囲は、デフォルト・ポート番号からmaxPort番号までです。

broadcastType

オプション。分析コレクタがハートビートをブロードキャストして自分の場所をイベント・プロデューサに通知する際のネットワーク・チャネルを示します。有効な値は、BroadcastおよびMulticastです。

- Broadcast: 標準ネットワーク・ブロードキャスト・チャネルを使用します。

- Multicast: 特別な固定マルチキャスト・アドレスを使用します。

clusterEnabled

オプション。分析コレクタがクラスタ内にデプロイされているかどうかを示します。有効な値は、1 (true)および0 (false)です。

1に設定されている場合、clusterNameも定義する必要があります。

clusterName

オプション。分析コレクタ・クラスタの名前。

clusterEnabled=1の場合にのみ必要です。

clusterBroadcastFrequency

オプション。'n'秒ごとに分析コレクタ・リスニング情報をブロードキャストします。デフォルトの間隔は10秒です。

分析コレクタは、定期的にハートビートをブロードキャストして自分の場所(hostName)を通知します。クラスタ化環境では、WebCenter Portalアプリケーションは、ハートビートを使用して、どの分析コレクタが使用可能であるのか判別します。

server

オプション。分析コレクタがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、デフォルト・ポートを31315に変更します。

wls:/weblogic/serverConfig>setAnalyticsCollectorConnection(appName='analytics-collector', defaultPort=31315)

listAnalyticsCollectorConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

分析コレクタの設定を返します。

構文

listAnalyticsCollectorConfig(appName, [server, applicationVersion])

引数

定義

appName

分析コレクタ・アプリケーションの名前。

server

オプション。分析コレクタがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次のコマンドは、webcenterという名前のアプリケーションに対して構成されている分析コレクタの現在の設定を一覧表示します。

wls:/weblogic/serverConfig>listAnalyticsCollectorConfig(appName='analytics-collector')

次のものは、クラスタ化環境における分析コレクタのサンプル出力です。

CollectorHost = localhost
CollectorDefaultPort = 31314
CollectorMaximumPort = 31318
BroadcastType = Multicast
ClusterEnabled = 1
ClusterName = myCluster
ClusterBroadcastFrequency = 55

次のものは、スタンドアロン分析コレクタの場合のサンプル出力です。

CollectorHost = localhost
CollectorDefaultPort = 31314
CollectorMaximumPort = 31314
BroadcastType = Multicast
ClusterEnabled =
ClusterName =
ClusterBroadcastFrequency = 55

listAnalyticsEventTypes

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

分析コレクタに現在登録されているすべてのイベントを一覧表示します。

構文

listAnalyticsEventTypes(appName, [server, applicationVersion])

引数

定義

appName

分析コレクタ・アプリケーションの名前。

server

オプション。分析コレクタがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次のコマンドは、webcenterという名前のWebCenter Portalアプリケーションで使用するために、分析コレクタに現在登録されているイベントをすべて一覧表示します。

wls:/weblogic/serverConfig>listAnalyticsEventTypes(appName='webcenter')

サンプル出力:

{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}DISCUSSION_ANNOUNCEMENTEDIT
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}DISCUSSION_TOPICDELETE
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}PAGEEDIT
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}DOCLIB_DOCUMENTCREATE
{HTTP://WWW.ORACLE.COM/ANALYTICS/WC}LOGINS
...

アクティビティ・グラフ

表10-5に示すコマンドを使用して、アクティビティ・グラフ・システム・プロパティおよびメタデータを管理します。

setAGProperty WLSTコマンドを使用して行った構成変更は、アクティビティ・グラフ・アプリケーションがデプロイされている管理対象サーバー(WC_Utilities)を再起動した後にのみ有効になります。その他のすべてのコマンドでは、構成変更はただちに有効になります。

Oracle Fusion Middleware Oracle WebCenter管理者ガイドのアクティビティ・グラフ・サービスの管理に関する項も参照してください。

表10-5 アクティビティ・グラフWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

exportAGMetadata

アクティビティ・グラフ・メタデータ定義をXMLファイルにエクスポートします。

オンライン

importAGMetadata

アクティビティ・グラフ・メタデータ定義をXMLファイルからインポートします。

オンライン

exportAGProviderConfiguration

指定したプロバイダのプロバイダ構成を、アクティビティ・グラフ・メタデータ定義ファイルにエクスポートします。

オンライン

deleteAllAGMetadata

WebCenterアプリケーションに対して定義されているアクティビティ・グラフ・メタデータをすべて削除します。

オンライン

deleteAGAction

アクティビティ・グラフに登録されているアクションのメタデータを削除します。

オンライン

deleteAGNodeClass

アクティビティ・グラフに登録されているノード・クラスのメタデータを削除します。

オンライン

deleteAGSimilarityCalculation

アクティビティ・グラフに登録されている類似度計算のメタデータを削除します。

オンライン

deleteAGRankCalculation

アクティビティ・グラフに登録されているランク計算のメタデータを削除します。

オンライン

deleteAGProviderAssignment

アクティビティ・グラフに登録されているプロバイダ割当てのメタデータを削除します。

オンライン

deleteAGQRPPRegistration

アクティビティ・グラフに登録されているQRPPのメタデータを削除します。

オンライン

deleteAGProviderConfiguration

アクティビティ・グラフに登録されているプロバイダ構成のメタデータを削除します。

オンライン

renameAGAction

アクティビティ・グラフに登録されているアクションのURNを変更します。

オンライン

renameAGNodeClass

アクティビティ・グラフに登録されているノード・クラスのURNを変更します。

オンライン

setAGProperty

アクティビティ・グラフのシステム・プロパティを設定します。

オンライン

getAGProperty

指定されているアクティビティ・グラフ・プロパティの現在の設定を返します。

オンライン

setAGPasswordCredential

アクティビティ・グラフ・プロパティの資格証明(ユーザー名およびパスワード)を設定します。

オンライン

exportAGMetadata

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

アクティビティ・グラフ・メタデータ定義をXMLファイルにエクスポートします。

構文

exportAGMetadata(appName, directoryPath, definitionFileName,
includeProviderConfigurations,[server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

directoryPath

生成されるXMLファイルの宛先ディレクトリ。存在しないディレクトリを指定すると、それが作成されます。

definitionFileName

生成されるXMLファイルの名前。同じ名前を持つファイルが宛先ディレクトリに存在する場合、それが上書きされます。

includeProviderConfigurations

エクスポートにプロバイダ構成メタデータが含まれるかどうかを判別します。有効な値は、1 (true)および0 (false)です。

プロバイダ構成は、他のメタデータとは別に管理する必要があるアクティビティ・グラフ・メタデータのサブセットです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、指定された場所にあるag-metadata.xmlという名前のXMLファイルに、アクティビティ・グラフ・メタデータ定義をエクスポートします。

wls:/weblogic/serverConfig> exportAGMetadata(appName='activitygraph-engines',
directoryPath='/scratch/myAGmetadata', definitionFileName='ag-metadata.xml',
includeProviderConfigurations='1')

importAGMetadata

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

アクティビティ・グラフ・メタデータ定義をXMLファイルからインポートします。

インポート時に、新しいアクティビティ・グラフ定義が、ターゲットに作成され、既存の定義が上書きされます。

構文

importAGMetadata(appName, definitionFilePath, [server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

definitionFilePath

メタデータ定義が含まれているXMLファイルの相対パス。たとえば、metadata/import-metadata.xmlです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ファイル名import-metadata.xmlからアクティビティ・グラフ・メタデータ定義をインポートします。

wls:/weblogic/serverConfig> importAGMetadata(appName='activitygraph-engines', definitionFilePath='metadata/import-metadata.xml')

exportAGProviderConfiguration

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したプロバイダのプロバイダ構成を、アクティビティ・グラフ・メタデータ定義ファイルにエクスポートします。

構文

exportAGProviderConfiguration(appName, directoryPath, definitionFileName, urn, [server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

directoryPath

生成されるXMLファイルの宛先ディレクトリ。存在しないディレクトリを指定すると、それが作成されます。

definitionFilePath

生成されるXMLファイルの名前。同じ名前を持つファイルが宛先ディレクトリに存在する場合、それが上書きされます。例

urn

エクスポートするアクティビティ・グラフ・プロバイダのURN。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、指定された場所にある'ag-provider-config.xmlという名前のXMLファイルにアクティビティ・グラフ・プロバイダoracle.webcenter.activitygraph.analyticsの構成情報をエクスポートします。

wls:/weblogic/serverConfig> exportAGProviderConfiguration(appName='activitygraph-engines',
directoryPath='/scratch/myAGmetadata',
definitionFileName='ag-provider-config.xml',
urn='oracle.webcenter.activitygraph.analytics')

deleteAllAGMetadata

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalアプリケーションに対して定義されているアクティビティ・グラフ・メタデータをすべて削除します。削除操作はただちに実行され、元に戻すことはできません。

このコマンドを、WLSTコマンドimportAGMetadataと組み合せて使用すると、アクティビティ・グラフ・メタデータを完全に再インストールできます。

注意: 次回アクティビティ・グラフ・エンジンが実行されると、リレーション・ストア、類似度ストアおよびランク・ストア内のすべてのデータが削除されます。

構文

deleteAllAGMetadata(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、すべての既存のアクティビティ・グラフ・メタデータを削除します。

wls:/weblogic/serverConfig> deleteAllAGMetadata(appName='activitygraph-engines')

deleteAGAction

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

アクティビティ・グラフに現在登録されているアクションのメタデータを削除します。削除操作はただちに実行され、元に戻すことはできません。

注意:

次回アクティビティ・グラフ・エンジンが実行されるときに、このアクションに関連付けられている、リレーション・ストア内のすべてのデータが削除されます。

構文

deleteAGAction(appName, urn, [server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

urn

削除するアクティビティ・グラフ・アクションのURN。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、connectアクションのアクティビティ・グラフ・メタデータを削除します。

wls:/weblogic/serverConfig> deleteAGAction(appName='activitygraph-engines', urn='connect')

deleteAGNodeClass

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

アクティビティ・グラフに現在登録されているノード・クラスのメタデータを削除します。削除操作はただちに実行され、元に戻すことはできません。

注意:

次回アクティビティ・グラフ・エンジンが実行されるときに、このノード・クラスに関連付けられている、リレーション・ストア内のすべてのデータが削除されます。

構文

deleteAGNodeClass(appName, urn, [server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

urn

削除するアクティビティ・グラフ・ノード・クラスのURN。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ノード・クラスWC.wiki-pageアクションのアクティビティ・グラフ・メタデータを削除します。

wls:/weblogic/serverConfig> deleteAGNodeClass(appName='activitygraph-engines', urn='WC.wiki-page')

deleteAGSimilarityCalculation

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

アクティビティ・グラフに現在登録されている類似度計算のメタデータを削除します。削除操作はただちに実行され、元に戻すことはできません。

構文

deleteAGSimilarityCalculation(appName, urn, [server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

urn

削除するアクティビティ・グラフ類似度計算のURN。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、類似度計算item-editのアクティビティ・グラフ・メタデータを削除します。

wls:/weblogic/serverConfig> deleteAGSimilarityCalculation(appName='activitygraph-engines', urn='item-edit')

deleteAGRankCalculation

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

アクティビティ・グラフに現在登録されているランク計算のメタデータを削除します。削除操作はただちに実行され、元に戻すことはできません。

構文

deleteAGRankCalculation(appName, urn, [server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

urn

削除するアクティビティ・グラフ・ランク計算のURN。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、activity-rank計算のアクティビティ・グラフ・メタデータを削除します。

wls:/weblogic/serverConfig> deleteAGRankCalculation(appName='activitygraph-engines', urn='activity-rank')

deleteAGProviderAssignment

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

アクティビティ・グラフに現在登録されているプロバイダ割当て、つまり一意の3つの組合せ(action, sourceClass, trgClass)によって定義されたプロバイダ割当てのメタデータを削除します。削除操作はただちに実行され、元に戻すことはできません。

構文

deleteAGProviderAssignment(appName, actionURN, srcClasURN, trgClassURN [server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

actionURN

アクションのURN。

srcClassURN

ソース・ノード・クラスのURN。

trgClassURN

ターゲット・ノード・クラスのURN。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、指定されたプロバイダ割当て用のアクティビティ・グラフ・メタデータを削除します。

wls:/weblogic/serverConfig> deleteAGRProviderAssignment(appName='activitygraph-engines', actionURN='connect',
srcClassURN='WC.user', trgClassURN='WC.user')

deleteAGQRPPRegistration

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

アクティビティ・グラフに現在登録されているQRPP (Query Result Post Processor)のメタデータを削除します。削除操作はただちに実行され、元に戻すことはできません。

構文

deleteAGQRPPRegistration(appName, urn [server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

urn

削除するQRPPのURN。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Event store metadata QRPPという名前のQRPPのアクティビティ・グラフ・メタデータを削除します。

wls:/weblogic/serverConfig> deleteAGQRPPRegistration(appName='activitygraph-engines', urn='Event store metadata QRPP')

deleteAGProviderConfiguration

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

プロバイダ構成のメタデータを削除します。削除操作はただちに実行され、元に戻すことはできません。

構文

deleteAGProviderConfiguration(appName, urn [server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

urn

削除するアクティビティ・グラフ・プロバイダのURN。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、アクティビティ・グラフ・プロバイダoracle.webcenter.activitygraph.analyticsの構成情報を削除します。

wls:/weblogic/serverConfig> deleteAGProviderConfiguration(appName='activitygraph-engines', urn='oracle.webcenter.activitygraph.analytics')

renameAGAction

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

アクティビティ・グラフに現在登録されているアクションのURNを変更します。このアクションに関連付けられている、リレーション・ストア内のすべてのデータが保持されます。

注意:

このコマンドでは、アクションが削除されて別の名前を持つアクションが作成されることはなく、元のアクションに関連付けられているデータが削除されます。

構文

renameAGAction(appName, currentURN, newURN,[server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

currentURN

現在のアクションURN。

newURN

新しいアクションURN。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、connectアクションURNをpeople-connectに変更します。

wls:/weblogic/serverConfig> renameAGAction(appName='activitygraph-engines',  currentURN='connect', newURN='connect')

renameAGNodeClass

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

アクティビティ・グラフに現在登録されているノード・クラスのURNを変更します。このノード・クラスに関連付けられている、リレーション・ストア内のすべてのデータが保持されます。

注意:

このコマンドでは、ノード・クラスが削除されて別の名前を持つノード・クラスが作成されることはなく、元のノード・クラスと関連付けられているデータが削除されます。

構文

renameAGNodeClass(appName, currentURN, newURN,[server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

currentURN

現在のノード・クラスURN。

newURN

新しいノード・クラスURN。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WC.userノード・クラスURNをWC.peopleに変更します。

wls:/weblogic/serverConfig> renameAGNodeClass(appName='activitygraph-engines',  currentURN='WC.user', newURN='WC.people')

setAGProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

アクティビティ・グラフのシステム・プロパティを設定します。このコマンドは、プロパティのデータ型(文字列、整数、浮動小数、ブール)に基づいて値を設定します。

アクティビティ・グラフ・システム・プロパティには次の設定が含まれています。

- Oracle Secure Enterprise Search (SES)管理API Webサービス接続(oracle.webcenter.activitygraph.providers.datasources.ses.soap.admin.urlおよびoracle.webcenter.activitygraph.providers.datasources.ses.soap.query.url)

- エンジン構成(oracle.webcenter.activitygraph.rankengine.enabled)

システム・プロパティのリストおよびそれらのデータ型は、Oracle Fusion Middleware Oracle WebCenter管理者ガイドのアクティビティ・グラフ・サービスの管理に関する項も参照してください。

setAGProperty WLSTコマンドを使用して行った構成変更は、アクティビティ・グラフ・アプリケーションがデプロイされている管理対象サーバー(WC_Utilities)を再起動した後にのみ有効になります。

構文

setAGProperty(appName, propertyName, propertyValue, propertyType,[server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

propertyName

アクティビティ・グラフ・プロパティの名前。

propertyValue

アクティビティ・グラフ・プロパティの値。

propertyType

プロパティのデータ型。有効な値は、String、Int、FloatまたはBooleanです。

値では大/小文字が区別されます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ランク・エンジンを有効化します。

wls:/weblogic/serverConfig> setAGProperty(appName='activitygraph-engines',
propertyName='oracle.webcenter.activitygraph.rankengine.enabled',
propertyValue='true', propertyType='boolean')

getAGProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定されたアクティビティ・グラフ・プロパティの現在の設定を返します。

有効なシステム・プロパティのリストは、Oracle Fusion Middleware Oracle WebCenter管理者ガイドのアクティビティ・グラフ・サービスの管理に関する項も参照してください。

構文

getAGProperty(appName, propertyName, propertyType [server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

propertyName

アクティビティ・グラフ・プロパティの名前。

propertyType

プロパティのデータ型。有効な値は、String、Int、FloatまたはBooleanです。

値では大/小文字が区別されます。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、システム・プロパティoracle.webcenter.activitygraph.providers.datasources.ses.soap.admin.urlの現在の値を返します。

wls:/weblogic/serverConfig> getAGProperty(appName='activitygraph-engines',
propertyName='oracle.webcenter.activitygraph.providers.datasources.ses.soap.admin.url', propertyType='String')

setAGPasswordCredential

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

アクティビティ・グラフ資格証明プロパティの資格証明(ユーザー名およびパスワード)を設定します。

PasswordCredentialデータ型のプロパティ(たとえば、oracle.webcenter.activitygraph.providers.datasources.ses.soap.admin.credential)のリストは、Oracle Fusion Middleware Oracle WebCenter管理者ガイドのアクティビティ・グラフ・サービスの管理に関する項も参照してください。

構文

setAGPasswordCredentialProperty(appName, propertyName, userName, password,[server, applicationVersion])

引数

定義

appName

この操作を実行するアクティビティ・グラフ・アプリケーションの名前。常にactivitygraph-enginesです。

propertyName

資格証明を指定する(PasswordCredentialデータ型の)アクティビティ・グラフ・プロパティの名前。

userName

資格証明プロパティと関連付けられているユーザー名。

password

指定されたユーザー名と関連付けられているパスワード。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Utilitiesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アクティビティ・グラフ・アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Oracle SES管理ツールのユーザー名およびパスワード資格証明を設定します。

wls:/weblogic/serverConfig> setAGProperty(appName='activitygraph-engines',
propertyName='oracle.webcenter.activitygraph.providers.datasources.ses.soap.admin.credential',
userName='myname', password='GuessWhat')

アクティビティ・ストリーム

表10-6に示すコマンドを使用して、WebCenter Portalアプリケーションに対して生成されたアクティビティ・ストリーム・データをアーカイブおよびリストアします。

これらのWebCenter Portal WLSTコマンドを使用して行った構成変更は、WebCenter Portalアプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

表10-6 アクティビティ・ストリームWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

archiveASByDate

指定された日付よりも古いアクティビティ・ストリーム・データをアーカイブします。

オンライン

archiveASByDeletedObjects

削除されたオブジェクトに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

オンライン

archiveASByClosedSpaces

現在閉じられているスペースに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

オンライン

archiveASByInactiveSpaces

指定された日付以降非アクティブであったスペースに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

オンライン

restoreASByDate

指定された日付以降のアーカイブされたアクティビティ・ストリーム・データを本番表にリストアします。

オンライン

truncateASArchive

アクティビティ・ストリーム・アーカイブ・データを切り捨てます。

オンライン

archiveASByDate

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定された日付よりも古いアクティビティ・ストリーム・データをアーカイブします。

このコマンドは、本番表からアーカイブ表にデータを移動します。例外としては、WC_ACTOR_DETAILおよびWC_OBJECT_DETAILがあり、これらの表のデータは、アーカイブ表に移動ではなくコピーされます。

アクティビティ要素によって使用されていないWC_OBJECT_DETAIL内の行は削除されます。

構文

archiveASByDate(appName, year, month, day, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

year

ここで指定した年より前のアクティビティ・ストリーム・データがアーカイブされます。たとえば、2009です。

month

ここで指定した月より前のアクティビティ・ストリーム・データがアーカイブされます。たとえば、1月なら1、2月なら2のように入力します。

day

ここで指定した日付より前のアクティビティ・ストリーム・データがアーカイブされます。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、2009年10月1日より古いアクティビティ・ストリーム・データがアーカイブされます。

wls:/weblogic/serverConfig> archiveASByDate(appName='webcenter', year=2009, month=10, day=1)

archiveASByDeletedObjects

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

削除されたオブジェクトに関連付けられているアクティビティ・ストリーム・データをアーカイブします。このコマンドは、本番表のデータをアーカイブ表に移動します。ただし、WC_ACTOR_DETAILは除きます。この表のデータは、アーカイブ表に移動されるのではなくコピーされます。

基準(この場合、削除されたオブジェクト)を満たすWC_OBJECT_DETAIL内の行は削除されます。

構文

archiveASByDeletedObjects(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、削除されたオブジェクトに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

wls:/weblogic/serverConfig> archiveASByDeletedObjects(appName='webcenter')

archiveASByClosedSpaces

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

現在閉じられているスペースに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

このコマンドは、本番表のデータをアーカイブ表に移動します。ただし、WC_ACTOR_DETAILは除きます。この表のデータは、アーカイブ表に移動されるのではなくコピーされます。基準(この場合、閉じられたスペースのアクティビティに関連するオブジェクト)を満たすWC_OBJECT_DETAIL内の行は削除されます。

構文

archiveASByClosedSpaces(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、現在閉じられているスペースに関連付けられているアクティビティ・ストリーム・データをアーカイブします。

wls:/weblogic/serverConfig> archiveASByClosedSpaces(appName='webcenter')

archiveASByInactiveSpaces

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定された日付以降非アクティブであったスペースに関連付けられているアクティビティ・ストリーム・データをアーカイブします。非アクティブ・スペースとは、指定された日付以降アクティビティがなかった開いているまたは閉じられたスペースです。

このコマンドは、本番表のデータをアーカイブ表に移動します。ただし、WC_ACTOR_DETAILは除きます。この表のデータは、アーカイブ表に移動されるのではなくコピーされます。基準(この場合、指定された日付以降、非アクティブであったスペースのアクティビティに関連するオブジェクト)を満たすWC_OBJECT_DETAILの行が削除されます。

構文

archiveASByInactiveSpaces(appName, year, month, day, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

year

スペースが非アクティブになった年。たとえば、2009です。

month

スペースが非アクティブになった月。たとえば、1月なら1、2月なら2のように入力します。

day

スペースが非アクティブになった日付。

server

オプション。Spacesアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。Spacesアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、2009年10月1日以降、非アクティブであった(オープン・ステータスかクローズ・ステータスかに関係なくアクティビティが発生していない)スペースと関連付けられているアクティビティ・ストリーム・データをアーカイブします。

wls:/weblogic/serverConfig> archiveASByInactiveSpaces(appName='webcenter', year=2009, month=10, day=1)

restoreASByDate

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定された日付以降のアーカイブされたアクティビティ・ストリーム・データを本番表にリストアします。

このコマンドは、アーカイブ表のデータを本番表に移動します。ただし、WC_ACTOR_DETAILは除きます。この表のデータはリストアされません。アーカイブ・プロセス中にこの表からデータが削除されていないためです。

本番表にすでに存在している行は、リストア・プロセス中に変更されません。

構文

restoreASByDate(appName, year, month, day, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

year

ここで指定した年以降のアクティビティ・ストリーム・データがリストアされます。たとえば、2009です。

month

ここで指定した月以降のアクティビティ・ストリーム・データがリストアされます。たとえば、1月なら1、2月なら2のように入力します。

day

ここで指定した日付以降のアクティビティ・ストリーム・データがリストアされます。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、2009年10月1日以降にアーカイブされたアクティビティ・ストリーム・データがリストアされます。

wls:/weblogic/serverConfig>restoreASByDate(appName='webcenter', year=2009, month=10, day=1)

truncateASArchive

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

アクティビティ・ストリーム・アーカイブ・データを切り捨てます。

構文

truncateASArchive(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、アクティビティ・ストリーム・アーカイブ・データが切り捨てられます。

wls:/weblogic/serverConfig>truncateASArchive(appName='webcenter')

コンテンツ・リポジトリ

表10-7に示すコマンドを使用して、コンテンツ・リポジトリの接続を管理し、WebCenter Portalアプリケーション用のドキュメント・サービスを構成します。

これらのWebCenter Portal WLSTコマンドを使用して行った構成変更は、WebCenter Portalアプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

表10-7 コンテンツ・リポジトリWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

createJCRContentServerConnection

Oracle WebCenter Contentリポジトリへの接続を作成します。

オンライン

setJCRContentServerConnection

既存のOracle WebCenter Contentリポジトリ接続を編集します。

オンライン

listJCRContentServerConnections

WebCenter Portalアプリケーションに対して構成されている個々またはすべてのOracle WebCenter Contentリポジトリの接続を一覧表示します。

オンライン

createJCRPortalConnection

Oracleポータル・リポジトリの接続を作成します。

オンライン

setJCRPortalConnection

既存のOracleポータル・リポジトリの接続を編集します。

オンライン

listJCRPortalConnections

WebCenter Portalアプリケーションに対して構成されているすべてのOracle Portal接続を一覧表示します。

オンライン

createJCRFileSystemConnection

ファイル・システムへの接続を作成します。

オンライン

setJCRFileSystemConnection

既存のファイル・システム・リポジトリの接続を編集します。

オンライン

listJCRFileSystemConnections

WebCenter Portalアプリケーションに対して構成されている個々またはすべてのファイル・システム接続を一覧表示します。

オンライン

createJCRSharePointConnection

Microsoft SharePoint 2007リポジトリ接続を作成します。

オンライン

setJCRSharePointConnection

Microsoft SharePoint 2007リポジトリ接続を編集します。

オンライン

listJCRSharePointConnections

WebCenter Portalアプリケーションに対して構成されているすべてのMicrosoft SharePoint 2007接続を一覧表示します。

オンライン

listDocumentsSpacesProperties

Spacesアプリケーションで使用中のバックエンド・コンテンツ・サーバーのプロパティを一覧表示します。

オンライン

setDocumentsSpacesProperties

Spacesアプリケーションで使用されるバックエンド・コンテンツ・サーバーのプロパティを変更します。

オンライン

deleteDocumentsSpacesProperties

Spacesアプリケーションで使用されるバックエンド・コンテンツ・サーバーのプロパティを削除します。

オンライン

createJCRContentServerConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定されたWebCenter Portalアプリケーション用のOracle WebCenter Contentリポジトリへの接続を作成します。

構文

createJCRContentServerConnection(appName, name, socketType, [url, serverHost,
serverPort, keystoreLocation, keystorePassword, privateKeyAlias,
privateKeyPassword, webContextRoot, clientSecurityPolicy, cacheInvalidationInterval, binaryCacheMaxEntrySize,
adminUsername, adminPassword, extAppId, timeout, isPrimary, server,
applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

socketType

Oracle WebCenter Contentのコンテンツ・サーバーが、コンテンツ・サーバー・リスナー・ポートとWebサーバー・フィルタのどちらで接続するかおよびリスナー・ポートでSSLが有効になっているかどうかを指定します。有効な値は、socket、webおよびsocketsslです。このオプションは、デフォルト値はありません。

次の値から選択します。

- socket - intradocソケットの接続を使用してコンテンツ・サーバーに接続します。コンテンツ・サーバー内の認可されたアドレスのリストにクライアントIPアドレスを追加する必要があります。この場合は、Oracle WebCenterを実行しているマシンがクライアントになります。

- socketssl - intradocソケットの接続を使用して、SSLプロトコルを使用して保護されたコンテンツ・サーバーに接続します。接続できるようにするために、サーバーのトラスト・ストアにクライアント証明書をインポートする必要があります。これは、最も保護されたオプションであり、IDを伝播する必要がある場合にお薦めします(たとえば、Spacesアプリケーション内)。

- web - HTTP(S)接続を使用してコンテンツ・サーバーに接続します。Spacesアプリケーションの場合、このオプションはアクティブな接続(スペース固有のドキュメントおよびホーム・スペース・ドキュメントを格納するために使用されているバックエンド・コンテンツ・サーバー・リポジトリ)に適していません。それはIDの伝播を許可されていないためです。

- jaxws - Java API for XML Web Services接続を使用してコンテンツ・サーバーに接続します。

url

オプション。コンテンツ・サーバーのURL。socketTypeがwebまたはjaxwsに設定されている場合にのみ必要です。URLは、http://<hostname>:<port>/<web root>/<plugin root>のフォーマットである必要があります。

例: http://mycontentserver/cms/idcplg。

serverHost

オプション。Content Serverを実行しているマシンのホスト名。socketTypeがsocketまたはsocketsslに設定されている場合に必要になります。

serverPort

オプション。Content Serverがリスニングするポート。socketTypeがsocketまたはsocketsslに設定されている場合に必要になります。

- Socket - サーバー内のincomingプロバイダに対して指定するポート。

- Socket SSL - サーバー内のsslincomingプロバイダに対して指定するポート。

このプロパティは、Content Server構成ファイル内のIntradocServerPort設定に対応しています。これは、デフォルトでポート4444になります。

keystoreLocation

オプション。セキュリティ・アサーションに署名するために使用した秘密鍵を含むキー・ストアの場所を示します。socketTypeがsocketsslに設定されている場合にのみ必要です。

キー・ストアの場所は、絶対パスである必要があります。

keystorePassword

オプション。キー・ストアにアクセスするために必要なパスワードを示します。socketTypeがsocketsslに設定されている場合にのみ必要です。

privateKeyAlias

オプション。クライアントのキー・ストア内の秘密鍵別名を示します。このキーを使用すると、サーバーのメッセージに署名することができます。この秘密鍵に対応する公開鍵をサーバーのキーストアにインポートする必要があります。

socketTypeがsocketsslに設定されている場合にのみ必要です。この引数の値は、文字列であり、特殊文字もスペースも含まない必要があります。

privateKeyPassword

オプション。キー・ストア内の秘密鍵別名に使用するパスワードを示します。socketTypeがsocketsslに設定されている場合にのみ必要です。

webContextRoot

オプション。Content ServerのWebサーバー・コンテキスト・ルート。/<context_root>の形式を使用します。たとえば、/csです。

指定した場合、WebCenter PortalアプリケーションでiFrameに基づいたいくつかのOracle WebCenter Content機能が使用可能になります。これには、次のものがあります。

- Content Serverに新規または更新済ファイルをアップロードするときのファイルとコンテンツ・プロファイルの関連付け。
詳細は、Oracle Fusion Middleware Oracle WebCenterユーザーズ・ガイドの新規ファイルのアップロードに関する項および既存のファイルの新規バージョンのアップロードに関する項を参照してください。

- Oracle AutoVueで使用可能なドキュメント確認機能の使用。
詳細は、Oracle Fusion Middleware Oracle WebCenterユーザーズ・ガイドのAutoVueを使用したドキュメントの確認とドキュメントに対するコラボレーションに関する項を参照してください。

- 詳細なドキュメント・プロパティの編集。
詳細は、Oracle Fusion Middleware Oracle WebCenterユーザーズ・ガイドのファイル・プロパティの操作に関する項を参照してください。

- フォルダおよびファイル・ワークフローの詳細の表示。
詳細は、Oracle Fusion Middleware Oracle WebCenterユーザーズ・ガイドのワークフロー情報の表示に関する項を参照してください。

- スライド・ビューアでのファイルのプレビュー。
詳細は、Oracle Fusion Middleware Oracle WebCenterユーザーズ・ガイドのファイルのオープンに関する項を参照してください。

- Site Studioの統合
詳細は、Oracle Fusion Middleware Oracle WebCenterユーザーズ・ガイドを参照してください。

webContextRootは、認証にIDENTITY_PROPAGATIONが使用されている場合、つまり、extAppIdが空の文字列に設定されている場合にのみ適用できます。

注意: これらのOracle WebCenter Contentの機能を完全に有効にするには、Oracle HTTPS Server (OHS)を介してWebCenter Portalアプリケーションにアクセスし、コンテンツ・サーバーとWebCenter Portalアプリケーションを、同じホストおよびポートの下で公開する必要があります。WebCenter Portalアプリケーションとコンテンツ・サーバーの両方で、シングル・サインオンを使用することも必要です。WebCenter Portalアプリケーションのフロントエンド処理を行うためのOHSの設定の詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』のコンテンツ・サーバー - 構成に関する項を参照してください。

WebCenter Portalアプリケーションが複数のコンテンツ・サーバーに接続している場合、OHSのリダイレクトが適切に機能するように各コンテンツ・サーバーに一意のWebサーバー・コンテキスト・ルートを設定することをお薦めします。

clientSecurityPolicy

オプション。socketTypeがjaxwsである場合に使用されるクライアント・セキュリティ・ポリシー。例: oracle/wss11_saml_token_with_message_protection_service_policy

cacheInvalidationInterval

オプション。外部コンテンツ・サーバーのコンテンツの変更を確認する間隔(分単位)。WebCenter Portalは、変更されたアイテムをキャッシュから自動的にクリアします。デフォルトは0で、キャッシュの無効化は無効になります。最小の間隔は2分です。

binaryCacheMaxEntrySize

オプション。コンテンツ・サーバー・バイナリ・ドキュメントのキャッシュ可能な最大サイズ(バイト単位)。このサイズより大きいドキュメントは、WebCenter Portalによってキャッシュされません。デフォルトは102400バイト(100K)です。

この値は、ご使用のマシンのメモリー構成およびキャッシュする予定のバイナリ・ドキュメントのタイプに基づいて調整します。

adminUsername

オプション。このコンテンツ・サーバー・インスタンスの管理権限を持つユーザー名。このユーザーは、プロファイルに基づいてコンテンツ・タイプ情報をフェッチするため、およびキャッシュ無効化の目的でドキュメントの変更を追跡するために使用されます。デフォルトはsysadminです。

adminPassword

オプション。adminUsernameに指定されているContent Server管理者のパスワード。socketTypeがwebに設定されている場合に必要です。

extAppId

オプション。Content Serverに対してユーザーを認証するために使用される外部アプリケーション。この値は、既存の外部アプリケーション接続の名前と一致する必要があります。「listExtAppConnections」も参照してください。extAppIdを指定しない場合、認証メソッドまたは外部アプリケーションIDを変更しません。

extAppIdに空の文字列を設定すると、認証メソッドとして、IDENTITY_PROPAGATIONを使用します。このメソッドを使用すると、WebCenter Portalアプリケーションおよびコンテンツ・サーバーでは、同じアイデンティティ・ストアを使用してユーザーが認証されます。socketTypeがwebに設定されている場合は、extAppIDが必須になることに注意してください。

timeout

オプション。コンテンツ・サーバーへのログインが許可される時間の長さ(ミリ秒単位)。この時間が経過すると、接続タイムアウト・メッセージが発行されます。タイムアウトが設定されていない場合、ログイン操作の時間制限はありません。

isPrimary

オプション。有効な文字列値は、1 (true)および0 (false)です。1は、この接続がドキュメント・サービスによって使用されるプライマリ接続であることを示します。この引数のデフォルトは、0です。

Spacesアプリケーションでは、プライマリ接続はスペース固有のコンテンツおよびホーム・スペース・コンテンツの格納に使用されます。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ポート4444のmyhost.comで実行中のOracle WebCenter Contentリポジトリへのソケットベース接続を作成します。認証のために、myExtAppという名前の既存の外部アプリケーションを使用します。「createExtAppConnection」も参照してください。

wls:/weblogic/serverConfig> createJCRContentServerConnection(appName='webcenter',
name='myContentServerConnection', socketType='socket',
serverHost='myhost.com', serverPort='4444', extAppId='myExtApp',
isPrimary=1)

次の例では、Oracle WebCenter ContentリポジトリへのSSLソケットベース接続を作成します。

wls:/weblogic/serverConfig> createJCRContentServerConnection(appName='webcenter',
name='myContentServerConnection', socketType='socketssl',
serverHost='myhost.com', serverPort='4444', keystoreLocation='d:/keys/here', keystorePassword='AlphaSquad7',
privateKeyAlias='enigma', privateKeyPassword='S0larPl3x1s',
extAppId='myExtApp')

次の例では、Oracle WebCenter ContentリポジトリへのJAX-WS (Java API for XML Web Services)接続を作成します。

wls:/weblogic/serverConfig> createJCRContentServerConnection(appName='webcenter',
name='myContentServerConnection', socketType='jaxws', url='http://myhost.com:9044/idcnativews', clientSecurityPolicy='oracle/wss10_saml_token_client_policy')

setJCRContentServerConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

既存のOracle WebCenter Contentリポジトリ接続を編集します。このコマンドを使用すると、appNameとnameの値および1つの追加引数を指定する必要があります。

構文

setJCRContentServerConnection(appName, name, [socketType, url, serverHost,
serverPort, keystoreLocation, keystorePassword, privateKeyAlias,
privateKeyPassword, webContextRoot, clientSecurityPolicy,
cacheInvalidationInterval, binaryCacheMaxEntrySize, adminUsername, adminPassword,
extAppId, timeout, isPrimary, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のOracle WebCenter Contentリポジトリ接続の名前。

socketType

オプション。Oracle WebCenter Contentのコンテンツ・サーバーが、コンテンツ・サーバー・リスナー・ポートとWebサーバー・フィルタのどちらで接続するかおよびリスナー・ポートでSSLが有効になっているかどうかを指定します。有効な値は、socket、webおよびsocketsslです。このオプションは、デフォルト値はありません。

次の値から選択します。

- socket - intradocソケットの接続を使用してコンテンツ・サーバーに接続します。コンテンツ・サーバー内の認可されたアドレスのリストにクライアントIPアドレスを追加する必要があります。この場合は、Oracle WebCenterを実行しているマシンがクライアントになります。

- socketssl - intradocソケットの接続を使用して、SSLプロトコルを使用して保護されたコンテンツ・サーバーに接続します。接続できるようにするために、サーバーのトラスト・ストアにクライアント証明書をインポートする必要があります。これは、最も保護されたオプションであり、IDを伝播する必要がある場合にお薦めします(たとえば、Spacesアプリケーション内)。

- web - HTTP(S)接続を使用してコンテンツ・サーバーに接続します。Spacesアプリケーションの場合、このオプションはスペース固有のドキュメントおよびホーム・スペース・ドキュメントを格納するために使用されているバックエンド・コンテンツ・サーバー・リポジトリに適していません。それはIDの伝播を許可されていないためです。

- jaxws - Java API for XML Web Services接続を使用してコンテンツ・サーバーに接続します。

url

オプション。コンテンツ・サーバーのURL。socketTypeがwebまたはjaxwsに設定されている場合にのみ必要です。URLは、http://<hostname>:<port>/<web root>/<plugin root>のフォーマットである必要があります。

例: http://mycontentserver/cms/idcplg。

serverHost

オプション。Content Serverを実行しているマシンのホスト名。socketTypeがsocketまたはsocketsslに設定されている場合に必要になります。

serverPort

オプション。Content Serverがリスニングするポート。socketTypeがsocketまたはsocketsslに設定されている場合に必要になります。

- Socket - サーバー内のincomingプロバイダに対して指定するポート。

- Socket SSL - サーバー内のsslincomingプロバイダに対して指定するポート。

例: 4444。

keystoreLocation

オプション。セキュリティ・アサーションに署名するために使用した秘密鍵を含むキー・ストアの場所を示します。socketTypeがsocketsslに設定されている場合にのみ必要です。

キー・ストアの場所は、絶対パスである必要があります。

keystorePassword

オプション。キー・ストアにアクセスするために必要なパスワードを示します。socketTypeがsocketsslに設定されている場合にのみ必要です。

privateKeyAlias

オプション。クライアントのキー・ストア内の秘密鍵別名を示します。socketTypeがsocketsslに設定されている場合にのみ必要です。この引数の値は、文字列であり、特殊文字もスペースも含まない必要があります。

privateKeyPassword

オプション。キー・ストア内の秘密鍵別名に使用するパスワードを示します。socketTypeがsocketsslに設定されている場合にのみ必要です。

webContextRoot

オプション。Content ServerのWebサーバー・コンテキスト・ルート。/<context_root>の形式を使用します。たとえば、/csです。

指定した場合、WebCenter PortalアプリケーションでiFrameに基づいたいくつかのOracle WebCenter Content機能(スライド・ビューアでのファイルのプレビューなど)が使用可能になります。

注意: これらの機能を完全に有効にするには、Oracle HTTPS Server (OHS)を介してWebCenter Portalアプリケーションにアクセスし、コンテンツ・サーバーとWebCenter Portalアプリケーションを、同じホストおよびポートの下で公開する必要があります。さらに、WebCenter Portalアプリケーションとコンテンツ・サーバーの両方で、シングル・サインオンを使用することも必要です。WebCenter Portalアプリケーションのフロントエンド処理を行うためのOHSの設定の詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』のコンテンツ・サーバー - 構成に関する項を参照してください。

webContextRootは、認証にIDENTITY_PROPAGATIONが使用されている場合、つまり、extAppIdが空の文字列に設定されている場合にのみ適用できます。

clientSecurityPolicy

オプション。socketTypeがjaxwsである場合に使用されるクライアント・セキュリティ・ポリシー。例: oracle/wss11_saml_token_with_message_protection_service_policy

cacheInvalidationInterval

オプション。外部コンテンツ・サーバーのコンテンツの変更を確認する間隔(分単位)。WebCenter Portalは、変更されたアイテムをキャッシュから自動的にクリアします。デフォルトは0で、キャッシュの無効化は無効になります。最小の間隔は2分です。

binaryCacheMaxEntrySize

オプション。コンテンツ・サーバー・バイナリ・ドキュメントのキャッシュ可能な最大サイズ(バイト単位)。このサイズより大きいドキュメントは、WebCenter Portalによってキャッシュされません。デフォルトは102400バイト(100K)です。

この値は、ご使用のマシンのメモリー構成およびキャッシュする予定のバイナリ・ドキュメントのタイプに基づいて調整します。

adminUsername

オプション。このコンテンツ・サーバー・インスタンスの管理権限を持つユーザー名。このユーザーは、プロファイルに基づいてコンテンツ・タイプ情報をフェッチするため、およびキャッシュ無効化の目的でドキュメントの変更を追跡するために使用されます。デフォルトはsysadminです。

adminPassword

オプション。adminUsernameに指定されているContent Server管理者のパスワード。socketTypeがwebに設定されている場合に必要です。

extAppId

オプション。Content Serverに対してユーザーを認証するために使用される外部アプリケーション。この値は、既存の外部アプリケーション接続の名前と一致する必要があります。「listExtAppConnections」も参照してください。extAppIdを指定しない場合、認証メソッドまたは外部アプリケーションIDを変更しません。

extAppIdに空の文字列を設定すると、認証メソッドとして、IDENTITY_PROPAGATIONを使用します。このメソッドを使用すると、WebCenter Portalアプリケーションおよびコンテンツ・サーバーでは、同じアイデンティティ・ストアを使用してユーザーが認証されます。

timeout

オプション。コンテンツ・サーバーへのログインが許可される時間の長さ(ミリ秒単位)。この時間が経過すると、接続タイムアウト・メッセージが発行されます。タイムアウトが設定されていない場合、ログイン操作の時間制限はありません。

isPrimary

オプション。有効な文字列値は、1 (true)および0 (false)です。1は、この接続がドキュメント・サービスによって使用されるプライマリ接続であることを示します。この引数のデフォルトは、0です。

Spacesアプリケーションでは、プライマリ接続はスペース固有のコンテンツおよびホーム・スペース・コンテンツの格納に使用されます。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Oracle WebCenter Contentリポジトリへのソケットベース接続を編集します。

wls:/weblogic/serverConfig>setJCRContentServerConnection(appName='webcenter',
name='myContentServerConnection', socketType='socket',
serverHost='myhost.com',  serverPort='4444',
extAppId='myExtApp', isPrimary=1)

次の例では、Oracle WebCenter ContentリポジトリへのSSLソケットベース接続を編集します。

wls:/weblogic/serverConfig>setJCRContentServerConnection(appName='webcenter',
name='myContentServerConnection', socketType='socketssl',
serverHost='myhost.com', serverPort='8443',
keystoreLocation='d:/keys/here', keystorePassword='T0PS3CR3T',
privateKeyAlias='TekJansen', privateKeyPassword='LadyNocturne',
extAppId='myExtApp', isPrimary=1)

次の例では、Oracle WebCenter ContentリポジトリへのJAX-WS (Java API for XML Web Services)接続を編集します。

wls:/weblogic/serverConfig> setJCRContentServerConnection(appName='webcenter',
socketType='jaxws', url='http://myhost.com:9044/idcnativews',
clientSecurityPolicy='oracle/wss10_saml_token_client_policy')

listJCRContentServerConnections

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

引数を指定せずに、このコマンドを使用すると、指定されたWebCenter Portalアプリケーションに対して構成されているすべてのOracle WebCenter Contentリポジトリの接続が一覧表示されます。

構文

listJCRContentServerConnections(appName, [verbose],
[name, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

verbose

オプション。コンテンツ・リポジトリ接続の詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listJCRContentServerConnectionsによって、WebCenter Portalアプリケーションに対して構成されているすべてのOracle WebCenter Contentリポジトリの接続およびその詳細が一覧表示されます。0に設定すると、接続名のみが一覧表示されます。この引数のデフォルトは、0です。

name

オプション。既存のOracle WebCenter Contentリポジトリ接続の名前。指定した場合、特定のOracle WebCenter Contentリポジトリの接続に関する詳細を表示できます。nameの値を指定すると、verboseの値を指定する必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のアプリケーションに対して構成されているOracle WebCenter Contentリポジトリの接続を一覧表示します。

wls:/weblogic/serverConfig> listJCRContentServerConnections(appName='webcenter')

次の例では、myContentServerConnection1という名前のOracle WebCenter Contentリポジトリの接続のすべてのプロパティを一覧表示します。myContentServerConnection1という名前の接続が存在し、それがOracle WebCenter Contentリポジトリ接続である必要があります。たとえば、Oracleポータルの接続を指定すると、プロパティは表示されず、エラーが表示されます。

wls:/weblogic/serverConfig>listJCRContentServerConnections(appName='webcenter',
verbose=1, name='myContentServerConnection1')

createJCRPortalConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracleポータル・リポジトリ接続を作成します。

構文

createJCRPortalConnection(appName, name, dataSource, [extAppId, isPrimary, timeout, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

dataSource

ポータルに接続するために使用されるJNDI DataSourceの場所を示します。例: jdbc/MyPortalDS

データソースは、WebCenter Portalアプリケーションがデプロイされているサーバーに存在する必要があります。

extAppId

オプション。Oracle Portalに対してユーザーを認証するために使用される外部アプリケーション。この値は、既存の外部アプリケーション接続の名前と一致する必要があります。「listExtAppConnections」も参照してください。extAppIdを指定しない場合、認証メソッドまたは外部アプリケーションIDを変更しません。

extAppIdに空の文字列を設定すると、認証メソッドとして、IDENTITY_PROPAGATIONを使用します。このメソッドを使用すると、WebCenter PortalアプリケーションおよびOracle Portalでは、同じアイデンティティ・ストアを使用してユーザーが認証されます。

timeout

オプション。Oracle Portalへのログインが許可される時間の長さ(ミリ秒単位)。この時間が経過すると、接続タイムアウト・メッセージが発行されます。タイムアウトが設定されていない場合、ログイン操作の時間制限はありません。

isPrimary

オプション。有効な文字列値は、1 (true)および0 (false)です。1は、この接続がドキュメント・サービスによって使用されるプライマリ接続であることを示します。この引数のデフォルトは、0です。

Spacesアプリケーションでは、プライマリ接続はOracle WebCenter Contentリポジトリ接続である必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、データ・ソースjdbc/portalDSを使用してmyPortalConnectionという名前のOracleポータルの接続を作成し、認証のためにmyExtAppという名前の外部アプリケーションを使用することを指定します。

wls:/weblogic/serverConfig> createJCRPortalConnection(appName='myApp',
name='myPortalConnection', dataSource='jdbc/portalDS', extAppId='myExtApp',
isPrimary=1)

setJCRPortalConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

既存のOracleポータルの接続を編集します。このコマンドを使用すると、dataSourceまたはisPrimary引数の値を指定する必要があります。

構文

setJCRPortalConnection(appName, name, [dataSource, extAppId, timeout, isPrimary, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のOracleポータルの接続の名前を示します。

dataSource

オプション。ポータルに接続するために使用されるJNDI DataSourceの場所を示します。例: jdbc/MyPortalDS

データソースは、WebCenter Portalアプリケーションがデプロイされているサーバーに存在する必要があります。

extAppId

オプション。Oracle Portalに対してユーザーを認証するために使用される外部アプリケーション。この値は、既存の外部アプリケーション接続の名前と一致する必要があります。「listExtAppConnections」も参照してください。extAppIdを指定しない場合、認証メソッドまたは外部アプリケーションIDを変更しません。

extAppIdに空の文字列を設定すると、認証メソッドとして、IDENTITY_PROPAGATIONを使用します。このメソッドを使用すると、WebCenter PortalアプリケーションおよびOracle Portalでは、同じアイデンティティ・ストアを使用してユーザーが認証されます。

timeout

オプション。Oracle Portalへのログインが許可される時間の長さ(ミリ秒単位)。この時間が経過すると、接続タイムアウト・メッセージが発行されます。タイムアウトが設定されていない場合、ログイン操作の時間制限はありません。

isPrimary

オプション。有効な文字列値は、1 (true)および0 (false)です。1は、この接続がドキュメント・サービスによって使用されるプライマリ接続であることを示します。0に設定し、かつ指定した接続がドキュメント・サービスで使用されているプライマリ接続である場合、プライマリ接続がリセットされます。このパラメータを設定しない場合、ドキュメント・サービスで使用したプライマリ接続は変更しません。この引数は、デフォルト値はありません。

Spacesアプリケーションでは、プライマリ接続はOracle WebCenter Contentリポジトリ接続である必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、Oracleポータル・リポジトリ接続の詳細情報を編集します。

wls:/weblogic/serverConfig> setJCRPortalConnection(appName='webcenter',
name='myPortalConnection', dataSource='/newPortalDS', extAppId='myExtApp',
isPrimary=0)

listJCRPortalConnections

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

このコマンドは、引数を指定せずに使用すると、指定されたWebCenter Portalアプリケーションに対して構成されているすべてのOracle Portal接続を一覧表示します。

構文

listJCRPortalConnections(appName, [verbose, name, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

verbose

オプション。コンテンツ・リポジトリ接続の詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listJCRPortalConnectionsによって、WebCenter Portalアプリケーションに対して構成されているすべてのOracle Portal接続およびその詳細が一覧表示されます。0に設定すると、接続名のみが一覧表示されます。この引数のデフォルトは、0です。

name

オプション。既存のOracleポータルの接続の名前を示します。指定した場合、特定のOracleポータルの接続に関する詳細情報を表示できます。nameの値を指定すると、verboseの値を指定する必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalアプリケーションに対して構成されているすべてのOracle Portal接続を一覧表示します。

wls:/weblogic/serverConfig> listJCRPortalConnections(appName='webcenter',
verbose=1, name='myPortalConnection')

createJCRFileSystemConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

ファイル・システム・リポジトリへの接続を作成します。

注意:

本番またはエンタープライズ・アプリケーションのデプロイメントにファイル・システム接続を使用してはいけません。この機能は、開発のためにのみ提供されています。

構文

createJCRFileSystemConnection(appName, name, path, [isPrimary, server,
applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

path

このファイル・システムに接続して内容をエクスポーズする必要があるフォルダへの絶対パスを示します。たとえば、C:\ProjectDocumentsという名前のフォルダがあり、そのフォルダをドキュメント・サービスに使用する必要がある場合、このフォルダをこのコマンドへのパス引数として指定する必要があります。

isPrimary

オプション。有効な値は、1 (true)および0 (false)です。1は、この接続がドキュメント・サービスによって使用されるプライマリ接続であることを示します。0に設定し、かつ指定した接続がドキュメント・サービスで使用されているプライマリ接続である場合、プライマリ接続がリセットされます。このパラメータを設定しない場合、ドキュメント・サービスで使用したプライマリ接続は変更しません。この引数は、デフォルト値はありません。

Spacesアプリケーションでは、プライマリ接続はOracle WebCenter Contentリポジトリ接続である必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、ファイル・システム・リポジトリへの接続を作成します。

wls:/weblogic/serverConfig> createJCRFileSystemConnection(appName='webcenter',
name='FSAConnection', path='C:/ProjectDocuments')

setJCRFileSystemConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

既存のファイル・システム・リポジトリの接続を編集します。このコマンドを使用する場合、pathまたはisPrimary引数の値を指定する必要があります。

注意:

本番またはエンタープライズ・アプリケーションのデプロイメントにファイル・システム接続を使用してはいけません。この機能は、開発のためにのみ提供されています。

構文

setJCRFileSystemConnection(appName, name, [path, isPrimary, server,
applicationVersion])

引数

定義

appName

ドキュメント・サービス・プロパティを設定するアプリケーションの名前。

name

ドキュメント・サービスで使用する接続の名前を示します。

path

オプション。このファイル・システムに接続して内容をエクスポーズする必要があるフォルダへの絶対パスを示します。たとえば、C:\ProjectDocumentsという名前のフォルダがあり、そのフォルダをドキュメント・サービスに使用する必要がある場合、このフォルダをこのコマンドへのパス引数として指定する必要があります。

isPrimary

オプション。有効な値は、1 (true)および0 (false)です。1に設定すると、この接続がドキュメント・サービスによって使用されるプライマリ接続であることが指定されます。0に設定し、かつ指定した接続がドキュメント・サービスで使用されているプライマリ接続である場合、プライマリ接続がリセットされます。このパラメータを設定しない場合、ドキュメント・サービスで使用したプライマリ接続は変更しません。この引数は、デフォルト値はありません。

Spacesアプリケーションでは、プライマリ接続はOracle WebCenter Contentリポジトリ接続である必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

この例は、ファイル・システム・リポジトリの接続に関する詳細情報を編集します。

wls:/weblogic/serverConfig> setJCRFileSystemConnection(appName='webcenter',
name='FSAConnection', path='C:/ProjectDocuments')

listJCRFileSystemConnections

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

このコマンドは、引数を指定せずに使用すると、指定されたWebCenter Portalアプリケーションに対して構成されているすべてのファイル・システム接続を一覧表示します。

注意:

本番またはエンタープライズ・アプリケーションのデプロイメントにファイル・システム接続を使用してはいけません。この機能は、開発のためにのみ提供されています。

構文

listJCRFileSystemConnections(appName, [verbose, name, server,
applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

verbose

オプション。コンテンツ・リポジトリ接続の詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listJCRFileSystemConnectionsによって、WebCenter Portalアプリケーションに対して構成されているすべてのファイル・システム接続およびそれらの詳細が一覧表示されます。0に設定すると、接続名のみが一覧表示されます。この引数のデフォルトは、0です。

name

オプション。既存のファイル・システム接続の名前を示します。指定した場合、特定のファイル・システム接続に関する詳細情報を表示できます。nameの値を指定すると、verboseの値を指定する必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、webcenterという名前のアプリケーションに対して設定したすべてのファイル・システム接続を表示します。

wls:/weblogic/serverConfig> listJCRFileSystemConnections(appName='webcenter')

次の例は、冗長モードで設定したすべてのファイル・システム接続を表示します。

wls:/weblogic/serverConfig> listJCRFileSystemConnections(appName='webcenter',
verbose=1)

createJCRSharePointConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Microsoft SharePoint 2007リポジトリへの接続を作成します。

構文

createJCRSharePointConnection(appName, name, url, [likeLimit, extAppId, timeout, isPrimary, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

url

接続するSharePointサイトのWebアドレス。

たとえば、SharePointサイト・アドレスがhttp://mysharepoint.mycompany.comである場合、url引数にこの値を入力します。

likeLimit

オプション。LIKE演算子が照合する文字数。デフォルトは64です。

SharePoint問合せ言語は、検索パターンが一致するURL(ドキュメント・パス)による問合せを抑制するためにLIKEキーワードを使用します。デフォルトでは、LIKE演算子は、最大64文字の文字列に対するパターン照合をサポートしています。この引数を使用して、異なる文字制限(1から64までの任意の正の整数)を指定するか、likeLimit=0を入力してLIKE制限を無効化(Microsoft SharePointサーバーに完全な問合せ文字列を常に送信)します。

デフォルト値(64)をお薦めします。WLSTコマンドcreateJCRSharePointConnectionを使用して接続を作成する場合はこの引数を指定する必要はありません。

注意: ご使用のSharePointインスタンスで64文字を超えるURLのLIKE問合せがサポートされている場合のみ、64を超える値を指定します。

extAppId

オプション。SharePointリポジトリに対してユーザーを認証するために使用される外部アプリケーション。この値は、既存の外部アプリケーション接続の名前と一致する必要があります。「listExtAppConnections」も参照してください。

extAppIdが設定されていない場合、SharePointリポジトリ接続は機能しません。

extAppIdは、setJCRSharePointConnection コマンドを使用していつでも設定または変更できます。

timeout

オプション。SharePointリポジトリへのログインが許可される時間の長さ(ミリ秒単位)。この時間が経過すると、接続タイムアウト・メッセージが発行されます。タイムアウトが設定されていない場合、ログイン操作の時間制限はありません。

isPrimary

オプション。有効な値は、1 (true)および0 (false)です。1は、この接続がドキュメント・サービスによって使用されるプライマリ接続であることを示します。この引数のデフォルトは、0です。このパラメータを省略した場合、ドキュメント・サービスで使用されるプライマリ接続は変更されません。

Spacesアプリケーションでは、プライマリ接続はOracle WebCenter Contentリポジトリ接続である必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Microsoft SharePointサイトへの接続を作成します。

wls:/weblogic/serverConfig> createJCRSharePointConnection(appName='webcenter', name='MySPConnection', url='http://mysharepoint.mycompany.com', extAppId='myExtApp')

setJCRSharePointConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

既存のMicrosoft SharePoint 2007リポジトリ接続を編集します。このコマンドでは、appNameとnameの値および少なくとも1つの追加引数を指定する必要があります。

構文

setJCRSharePointConnection(appName, name, [url, likeLimit, extAppId, timeout, isPrimary, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のSharePoint接続の名前。

url

オプション。接続するSharePointサイトのWebアドレス。

たとえば、SharePointサイト・アドレスがhttp://mysharepoint.mycompany.comである場合、url引数にこの値を入力します。

likeLimit

オプション。LIKE演算子が照合する文字数。デフォルトは64です。

SharePoint問合せ言語は、検索パターンが一致するURL(ドキュメント・パス)による問合せを抑制するためにLIKEキーワードを使用します。デフォルトでは、LIKE演算子は、最大64文字の文字列に対するパターン照合をサポートしています。この引数を使用して、異なる文字制限(1から64までの任意の正の整数)を指定するか、likeLimit=0を入力してLIKE制限を無効化(Microsoft SharePointサーバーに完全な問合せ文字列を常に送信)します。

デフォルト値(64)をお薦めします。このデフォルトは、ほとんどのインスタンスに適しており、通常、新しい値を設定する必要はありません。デフォルトをリセットするには、likeLimit=''またはlikeLimit=64を指定します。

注意: ご使用のSharePointインスタンスで64文字を超えるURLのLIKE問合せがサポートされている場合のみ、64を超える値を指定します。

extAppId

オプション。SharePointリポジトリに対してユーザーを認証するために使用される外部アプリケーション。この値は、既存の外部アプリケーション接続の名前と一致する必要があります。「listExtAppConnections」も参照してください。extAppIdが設定されていない場合、現在の外部アプリケーションIDは変更されません。

外部アプリケーションが設定されていない場合、SharePoint接続は機能しません。

timeout

オプション。SharePointリポジトリへのログインが許可される時間の長さ(ミリ秒単位)。この時間が経過すると、接続タイムアウト・メッセージが発行されます。タイムアウトが設定されていない場合、ログイン操作の時間制限はありません。

isPrimary

オプション。有効な値は、1 (true)および0 (false)です。1は、この接続がドキュメント・サービスによって使用されるプライマリ接続であることを示します。0に設定し、かつ指定した接続がドキュメント・サービスで使用されているプライマリ接続である場合、プライマリ接続がリセットされます。このパラメータを設定しない場合、ドキュメント・サービスで使用したプライマリ接続は変更しません。この引数は、デフォルト値はありません。

Spacesアプリケーションでは、プライマリ接続はOracle WebCenter Contentリポジトリ接続である必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、SharePointリポジトリ接続の詳細を編集します。

wls:/weblogic/serverConfig> setJCRSharePointConnection(appName='webcenter', name='MySPConnection', url='http://mysharepoint.mycompany.com', extAppId='myExtApp')

listJCRSharePointConnections

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

このコマンドは、引数を指定せずに使用すると、指定されたWebCenter Portalアプリケーションに対して構成されているすべてのSharePoint接続を一覧表示します。

構文

listJCRSharePointConnections(appName, [verbose, name, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

verbose

オプション。SharePoint接続の詳細を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listJCRSharePointConnectionsによって、WebCenter Portalアプリケーションに対して構成されているすべてのSharePoint接続およびそれらの詳細が一覧表示されます。0に設定すると、接続名のみが一覧表示されます。この引数のデフォルトは、0です。

name

オプション。既存のSharePoint接続の名前。指定した場合、特定のSharePoint接続の接続詳細を表示できます。nameの値を指定すると、verboseの値を指定する必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のアプリケーションに対して構成されているすべてのSharePoint接続の名前を一覧表示します。

wls:/weblogic/serverConfig> listJCRSharePointConnections(appName='webcenter')

次の例では、構成されているすべてのSharePoint接続の接続詳細を一覧表示します。

wls:/weblogic/serverConfig> listJCRSharePointConnections(appName='webcenter', verbose=1)

listDocumentsSpacesProperties

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

スペース固有ドキュメントおよびホーム・スペース・ドキュメントを格納するためにSpacesアプリケーションによって使用されているバックエンドOracle WebCenter Contentリポジトリのプロパティを一覧表示します。このコマンドは、Spacesアプリケーションにのみ有効です。

構文

listDocumentsSpacesProperties(appName, [server, applicationVersion])

引数

定義

appName

この操作を行うSpacesアプリケーションの名前。常にwebcenterです。

server

オプション。Spacesアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。Spacesアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、スペース固有ドキュメントおよびホーム・スペース・ドキュメントを格納するために(webcenterという名前の)Spacesアプリケーションによって使用されているバックエンドOracle WebCenter Contentリポジトリのプロパティを一覧表示します。

wls:/weblogic/serverConfig> listDocumentsSpacesProperties(appName='webcenter')

The Documents Spaces container is "/WebCenter1109"
The Documents repository administrator is "sysadmin"
The Documents Spaces container is "/WebCenter1109"The Documents primary connection is "myOCSConnection"

setDocumentsSpacesProperties

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

スペース関連データを格納するためにSpacesアプリケーションによって使用されているバックエンドOracle WebCenter Contentリポジトリのプロパティを変更します。このコマンドは、Spacesアプリケーションにのみ有効です。

構文

setDocumentsSpacesProperties(appName, [spacesRoot, adminUserName,
applicationName, server, applicationVersion])

引数

定義

appName

この操作を行うSpacesアプリケーションの名前。常にwebcenterです。

spacesRoot

オプション。Spacesアプリケーション・コンテンツが格納されているルート・フォルダ。この引数の値は、/<foldername>の形式を使用する必要があります。たとえば、/WebCenterまたは/WebCenterSpaces。spacesRootは、/ではなく、ルート自体であり、アプリケーションの間にユニークである必要があります。指定したフォルダは存在しない場合、そのフォルダが作成されます。

この引数の値を指定した場合、adminUserNameおよびapplicationName引数の値を指定する必要があります。

adminUserName

オプション。コンテンツ・リポジトリ管理者のユーザー名を示します。例: sysadmin。このユーザーは、Spacesアプリケーション・コンテンツのフォルダの作成と維持や、コンテンツ・アクセス権限の管理に使用されます。

Spacesユーザーの代理として操作を行えるように、この接続には管理権限が必要です。

この引数の値を指定した場合、spacesRootおよびapplicationName引数の値を指定する必要があります。

applicationName

オプション。一意のスペース・・アプリケーション識別子。この名前は、複数のSpacesアプリケーションが同じコンテンツ・リポジトリを共有している場合にデータを分離するために使用され、アプリケーション間で一意である必要があります。

この引数の値は、文字で始まる必要があります。文字の後に英数字またはアンダースコアを続けます。文字列には、30次の文字を入力ことができます。この引数の値を指定した場合、spacesRootおよびadminUserName引数の値を指定する必要があります。

ここで指定する名前は、次のようにドキュメント関連のワークフローに名前を付けるためにも使用されます。

<applicationName><WorkflowName>

<applicationName><WorkflowStepName>

ワークフローに名前を付ける場合、アプリケーション名の最初の14文字のみが使用されます。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、スペース固有ドキュメントおよびホーム・スペース・ドキュメントを格納するためにSpacesアプリケーションによって使用されているバックエンドOracle WebCenter Contentリポジトリの接続プロパティを変更します。

wls:/weblogic/serverConfig> setDocumentsSpacesProperties(appName='webcenter',
spacesRoot='/AccountingSpaces', adminUserName='admin',
applicationName='WCAccounting')

次の例では、スペース固有ドキュメントおよびホーム・スペース・ドキュメントを格納するためにSpacesアプリケーションによって使用されているバックエンドOracle WebCenter Contentリポジトリの管理者のユーザー名を変更します。

wls:/weblogic/serverConfig> setDocumentsSpacesProperties(appName='webcenter',
adminUserName='sysadmin')

deleteDocumentsSpacesProperties

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Spacesアプリケーションによって使用されているバックエンドOracle WebCenter ContentリポジトリのadminUserName、applicationNameおよびspacesRootのプロパティを削除します。このコマンドは、Spacesアプリケーションにのみ有効です。

構文

deleteDocumentsSpacesProperties(appName, [server, applicationVersion])

引数

定義

appName

この操作を行うSpacesアプリケーションの名前。常にwebcenterです。

server

オプション。WebCenterアプリケーションがデプロイされている管理対象サーバーの名前を示します。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Spacesアプリケーションによって使用されているバックエンドOracle WebCenter Contentリポジトリの接続プロパティ(adminUserName、applicationName、spacesRoot)を削除します。

wls:/weblogic/serverConfig> deleteDocumentsSpacesProperties(appName='webcenter')

ディスカッションおよび通知

表10-8に示すコマンドを使用して、WebCenter Portalアプリケーションのディスカッション・サーバー接続を管理します。

これらのWebCenter Portal WLSTコマンドを使用して行った構成変更は、WebCenter Portalアプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

表10-8 ディスカッションおよび通知WLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

createDiscussionForumConnection

WebCenter Portalアプリケーションの新しいディスカッション・サーバー接続を作成します。

オンライン

setDiscussionForumConnection

既存のディスカッション・サーバー接続を編集します。

オンライン

setDefaultDiscussionForumConnection

ディスカッション・サービスおよびお知らせサービスのデフォルト接続を指定します。

オンライン

listDiscussionForumConnections

アプリケーションに対して設定したすべてのディスカッション・サーバー接続プロパティを表示します。

オンライン

listDefaultDiscussionForumConnection

アプリケーションのデフォルト・ディスカッション・サーバー接続を表示します。

オンライン

setDiscussionForumConnectionProperty

追加のディスカッション・サーバー接続プロパティを設定します。

オンライン

deleteDiscussionForumConnectionProperty

ディスカッション・サーバー接続プロパティを削除します。

オンライン

setDiscussionForumServiceProperty

ディスカッション・サービスのデフォルトを指定します。

オンライン

removeDiscussionForumServiceProperty

ディスカッション・サービスのデフォルトを削除します。

オンライン

listDiscussionForumServiceProperties

ディスカッション・サービス・プロパティを表示します。

オンライン

setAnnouncementServiceProperty

お知らせサービスのデフォルトを指定します。

オンライン

removeAnnouncementServiceProperty

お知らせサービスのデフォルトを削除します。

オンライン

listAnnouncementServiceProperties

お知らせサービス・プロパティを表示します。

オンライン

addDiscussionsServerAdmin

ユーザーまたはグループにディスカッション・サーバーのシステム管理者パーミッションを付与します。

オンライン

syncDiscussionServerPermissions

親からセキュリティを継承するサブスペースのディスカッション・サーバー・パーミッションを同期します。

オンライン

setDiscussionsServerProperty

ディスカッション・サーバーのプロパティを設定します。

オンライン

getDiscussionsServerProperty

ディスカッション・サーバーのプロパティ値を返します。

オンライン

removeDiscussionsServerProperty

現在のディスカッション・サーバーのプロパティ値を削除します。

オンライン

createDiscussionForumConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションの新しいディスカッション・サーバー接続を作成します。

ディスカッション・サービスおよびお知らせサービスの両方のサービスの場合は、ディスカッション・サーバーの接続が必要です。両方のサービスでは、同じディスカッション・サーバー接続が使用されます。

1つのWebCenter Portalアプリケーションに対して複数のディスカッション・サーバー接続を登録できますが、ディスカッション・サービスおよびお知らせサービスに対して使用される接続は1つのみであり、デフォルト(またはアクティブ)接続が使用されます。

構文

createDiscussionForumConnection(appName, name, url, adminUser,
[timeout, default, policyURIForAuthAccess, policyURIForPublicAccess, recipientKeyAlias])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

url

ディスカッション・フォーラムおよび通知をホストしているディスカッション・サーバーのURLを示します。例: http://myhost:8888/owc_discussions。

adminUser

ディスカッション・サーバー管理者の名前を示します。ディスカッションとお知らせサービスでは、このアカウントを使用して、WebCenter Portalユーザーの代理として管理操作が行われます。

このアカウントは、多くの場合、Spacesアプリケーションにおいてディスカッションとお知らせを管理するために使用されます。このユーザーは、super adminである必要はありません。ただし、このユーザーは、Spacesアプリケーションの現在のアプリケーション・ルート・カテゴリ、つまり、すべてのスペース関連のディスカッションとお知らせが格納されている(ディスカッション・サーバー上の)カテゴリに対する管理権限を持っている必要があります。

policyURIForAuthAccess

オプション。ディスカッション・サーバーWebサービスへの認証アクセスに必要なSAMLトークン・ベース・ポリシーへのURI。

指定するクライアント・ポリシーには、ディスカッション・サーバーでOWCDiscussionsServiceAuthenticatedエンドポイント用に構成されているサービス・ポリシーとの互換性が必要です。初期の設定では、デフォルト・サービス・ポリシーはWSS 1.0 SAMLトークン・サービス・ポリシー(oracle/wss10_saml_token_service_policy)です。

有効なクライアント・ポリシー値には次のようなものがあります。

- oracle/wss10_saml_token_client_policy (WSS 1.0 SAMLトークン・クライアント・ポリシー)

- oracle/wss11_saml_token_with_message_protection_client_policy (メッセージ保護クライアント・ポリシー付きWSS 1.1 SAMLトークン)

- GPA (グローバル・ポリシー・アタッチメント) - グローバル・ポリシー・アタッチメントがサポートされている環境の場合には、GPAを使用します。さらに、WLSTコマンドdetachWebServicePolicyまたはEnterprise Managerを使用して、デフォルト・ポリシーがディスカッション・サーバーのOWCDiscussionsServiceAuthenticatedエンドポイントからデタッチされていることを確認します。

Oracle Fusion Middleware Oracle WebCenter管理者ガイドのディスカッションとお知らせサービスの管理に関する項も参照してください。

policyURIForPublicAccess

オプション。ディスカッション・サーバーWebサービスへのパブリック・アクセスに対して、メッセージ・セキュリティおよび整合性を強制するために必要なポリシーへのURI。

デフォルト値は、oracle/no_authentication_client_policyです。

指定するクライアント・ポリシーには、ディスカッション・サーバーでOWCDiscussionsServicePublicエンドポイント用に構成されているサービス・ポリシーとの互換性が必要です。初期の設定では、サービス・ポリシーは、パブリック・アクセス(oracle/no_authentication_client_policy)用に構成されていません。

有効なクライアント・ポリシー値には次のようなものがあります。

- oracle/no_authentication_client_policy (なし)

- oracle/wss11_with_message_protection_client_policy (WSS 1.1メッセージ保護クライアント・ポリシー)

- GPA (グローバル・ポリシー・アタッチメント) - グローバル・ポリシー・アタッチメントがサポートされている環境の場合には、GPAを使用します。さらに、ディスカッション・サーバーにおけるOWCDiscussionsServicePublicエンドポイントにアタッチされているデフォルト・ポリシーが、oracle/no_authentication_service_policyに設定されていることも確認する必要があります。

recipientKeyAlias

オプション。メッセージ保護ポリシーに使用される受信者キー別名(OWCDiscussionsServicePublicおよびOWCDiscussionsServiceAuthenticatedエンドポイントに適用可能)。これは、構成されているキーストア内のディスカッション・サーバーの公開鍵を含む証明書の別名です。デフォルトは、nullです。

Oracle Fusion Middleware Oracle WebCenter管理者ガイドのWebCenter Portalアプリケーションおよびコンポーネント用のWS-Securityの構成に関する項も参照してください。

timeout

オプション。接続タイムアウト・メッセージを出す前にディスカッション・サーバーからの応答を受信する間のディスカッション・サービスの待機時間(秒の単位)の長さを示します。この引数のデフォルトは、-1です。-1に設定すると、サービスのデフォルト値(10秒)が適用されます。

default

オプション。この接続は、ディスカッション・サービスおよびお知らせサービスのデフォルト接続であることを示します。

有効なオプションは、1 (true)および0 (false)です。1に設定した場合、ディスカッション・サービスもお知らせサービスもこの接続を使用します。0に設定すると、その接続は使用されません。デフォルトは0です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalアプリケーションのディスカッション・サーバー接続を作成します。

wls:/weblogic/serverConfig> createDiscussionForumConnection(appName='webcenter',
name='MyDiscussionServer', url='http://myhost.com:8888/owc_discussions',
adminUser='admin', policyURIForAuthAccess='oracle/wss10_saml_token_client_policy', default=0)

setDiscussionForumConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

既存のディスカッション・サーバー接続を編集します。このコマンドを使用して、接続の属性を更新します。

createDiscussionForumConnectionコマンドを使用して、接続が作成されます。

構文

setDiscussionForumConnection(appName, name, [url, adminUser, policyURIForAuthAccess, policyURIForPublicAccess, recipientKeyAlias, timeout, default, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のディスカッション・サーバー接続の名前を示します。

url

オプション。ディスカッション・サーバーへのURLを示します。

adminUser

オプション。ディスカッション・サーバー管理者の名前を示します。ディスカッション・サービスでは、このアカウントを使用して、WebCenter Portalユーザーの代理として管理操作が行われます。

このアカウントは、多くの場合、Spacesアプリケーションにおいてディスカッションとお知らせを管理するために使用されます。このユーザーは、super adminである必要はありません。ただし、このユーザーは、Spacesアプリケーションの現在のルート・カテゴリ、つまり、すべてのSpacesディスカッション・フォーラムが格納されている(ディスカッション・サーバー上の)カテゴリに対する管理権限を持っている必要があります。

policyURIForAuthAccess

オプション。ディスカッション・サーバーWebサービスへの認証アクセスに必要なSAMLトークン・ベース・ポリシーへのURI。

指定するクライアント・ポリシーには、ディスカッション・サーバーでOWCDiscussionsServiceAuthenticatedエンドポイント用に構成されているサービス・ポリシーとの互換性が必要です。初期の設定では、デフォルト・サービス・ポリシーはWSS 1.0 SAMLトークン・サービス・ポリシー(oracle/wss10_saml_token_service_policy)です。

有効なクライアント・ポリシー値には次のようなものがあります。

- oracle/wss10_saml_token_client_policy (WSS 1.0 SAMLトークン・クライアント・ポリシー)

- oracle/wss11_saml_token_with_message_protection_client_policy (メッセージ保護クライアント・ポリシー付きWSS 1.1 SAMLトークン)

- GPA (グローバル・ポリシー・アタッチメント) - グローバル・ポリシー・アタッチメントがサポートされている環境の場合には、GPAを使用します。さらに、WLSTコマンドdetachWebServicePolicyまたはEnterprise Managerを使用して、デフォルト・ポリシーがディスカッション・サーバーのOWCDiscussionsServiceAuthenticatedエンドポイントからデタッチされていることを確認します。

Oracle Fusion Middleware Oracle WebCenter管理者ガイドのディスカッションとお知らせサービスの管理に関する項も参照してください。

policyURIForPublicAccess

オプション。ディスカッション・サーバーWebサービスへのパブリック・アクセスに対して、メッセージ・セキュリティおよび整合性を強制するために必要なポリシーへのURI。

デフォルト値は、oracle/no_authentication_client_policyです。

指定するクライアント・ポリシーには、ディスカッション・サーバーでOWCDiscussionsServicePublicエンドポイント用に構成されているサービス・ポリシーとの互換性が必要です。初期の設定では、サービス・ポリシーは、パブリック・アクセス(oracle/no_authentication_client_policy)用に構成されていません。

有効なクライアント値は次のとおりです:

- oracle/no_authentication_client_policy (なし)

- oracle/wss11_with_message_protection_client_policy (WSS 1.1メッセージ保護クライアント・ポリシー)

- GPA (グローバル・ポリシー・アタッチメント) - グローバル・ポリシー・アタッチメントがサポートされている環境の場合には、GPAを使用します。さらに、ディスカッション・サーバーにおけるOWCDiscussionsServicePublicエンドポイントにアタッチされているデフォルト・ポリシーが、oracle/no_authentication_service_policyに設定されていることも確認する必要があります。

recipientKeyAlias

オプション。メッセージ保護ポリシー認証に使用される受信者キー別名。ディスカッション・サーバー接続が、認証のためにメッセージ保護ベースのセキュリティ・ポリシーを使用している場合にのみ必要です。デフォルトは、nullです。

Oracle Fusion Middleware Oracle WebCenter管理者ガイドのWebCenter Portalアプリケーションおよびコンポーネント用のWS-Securityの構成に関する項も参照してください。

timeout

オプション。接続タイムアウト・メッセージを出す前に ディスカッション・サーバーからの応答を受信する間のディスカッション・サービスおよびお知らせサービスの待機時間(秒の単位)の長さを示します。この引数のデフォルトは、-1です。-1に設定すると、サービスのデフォルト値(10秒)が適用されます。

default

オプション。この接続は、ディスカッション・サービスおよびお知らせサービスのデフォルト接続であることを示します。1つまたは複数の接続が定義されている場合のみ必要です。

有効なオプションは、1 (true)および0 (false)です。1に設定した場合、ディスカッション・サービスおよびお知らせサービスにこの接続が使用されます。0に設定すると、その接続は使用されません。デフォルトは0です。

ディスカッションとお知らせサービスでこの接続を使用することを指定するには、値を0から1に変更します。

この接続を無効に設定するには、removeDiscussionForumServicePropertyコマンドを使用します。

removeDiscussionForumServiceProperty('appName='webcenter', property='selected.connection')

注意: 1つのWebCenter Portalアプリケーションに対して複数のディスカッション・サーバー接続を登録できますが、ディスカッションとお知らせサービスに対して使用される接続は1つのみであり、デフォルト(またはアクティブ)接続が使用されます。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MyDiscussionsServerという名前のセキュアなディスカッション・サーバー接続の属性を更新します。

wls:/weblogic/serverConfig> setDiscussionForumConnection(appName='webcenter',
name='MyDiscussionServer', url='http://myhost.com:7786/owc_discussions',
adminUser='admin', policyURIForAuthAccess='oracle/wss10_saml_token_client_policy', default=1)

setDiscussionForumConnectionProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

ディスカッション・サーバー接続プロパティを設定します。使用しているディスカッション・サーバーに接続するために追加のパラメータを使用する必要がある場合、このコマンドを使用します。

このコマンドは、キーおよび値を使用して任意の接続プロパティを追加する拡張可能な方法を提供します。(createDiscussionForumConnectionおよびsetDiscussionForumConnectionに指定した接続プロパティを必ず使用しなければならないというわけではありません。)

注意:

createDiscussionForumConnectionまたはsetDiscussionForumConnectionを使用して、利用可能な接続プロパティを設定するためにsetDiscussionForumConnectionPropertyを使用しないでください。それを試みても、効果はありません。

既知および追加のすべての接続プロパティを表10-9「追加のディスカッション接続プロパティ」に示します。

表10-9 追加のディスカッション接続プロパティ

追加の接続プロパティ

説明

application.root.category.id

(Spacesアプリケーションのみ)すべてのディスカッション・フォーラムが格納されているディスカッション・サーバー上のアプリケーション・ルート・カテゴリID。たとえば、3に設定すると、すべてのフォーラムがカテゴリ3内に格納されます。

構文

setDiscussionForumConnectionProperty(appName, name, key, value, [secure, server,
applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のディスカッション・サーバー接続の名前を示します。

key

接続プロパティの名前を示します。

value

プロパティの値を示します。キーおよび値を持つ接続上の任意のプロパティを変更できます。

secure

オプション。暗号化を使用してプロパティの値を安全に格納するかどうかを示します。有効なオプションは、1 (true)および0 (false)です。1の場合、値が暗号化されます。デフォルト・オプションは0です。

パスワードを格納する場合は、1に設定します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MyDiscussionServerという名前のディスカッション・サーバー接続のキーストア証明書の場所を構成します。

wls:/weblogic/serverConfig> setDiscussionForumConnectionProperty
(appName='webcenter', name='MyDiscussionServer', key='application.root.category.id', value='3')

次の例は、myProperty1というカスタム・ディスカッション・サーバー接続プロパティをpropertyValue1の値を付けて追加します。

wls:/weblogic/serverConfig> setDiscussionForumConnectionProperty
(appName='webcenter', name='MyDiscussionServer', key='myProperty1',
value='propertyValue1')

次の例では、値secureValueを指定してsecuredPropertyというセキュアなディスカッション・サーバー接続プロパティを追加します。

wls:/weblogic/serverConfig> setDiscussionForumConnectionProperty
(appName='webcenter', name='MyDiscussionServer', key='securedProperty',
value='secureValue', secure=1)

deleteDiscussionForumConnectionProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

ディスカッション・サーバー接続プロパティを削除します。接続プロパティを削除した結果、設定が無効になる場合、希望したとおりに接続されない可能性があるので、接続プロパティを削除するときに注意してください。

このコマンドを使用すると、setDiscussionForumConnectionPropertyコマンドを使用して追加したadditional接続プロパティのみ削除できます。

構文

deleteDiscussionForumConnectionProperty(appName, name, key, [server,
applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のディスカッション・サーバー接続の名前を示します。

key

削除する接続プロパティの名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、myProperty1という名前のディスカッション・サーバー接続プロパティを削除します。

wls:/weblogic/serverConfig> deleteDiscussionForumConnectionProperty
(appName='webcenter', name='MyDiscussionServer', key='myProperty1')

listDiscussionForumConnections

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションに対して構成されているすべてのディスカッション・サーバー接続を一覧表示します。

構文

listDiscussionForumConnections(appName, [verbose, name, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

verbose

オプション。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listDiscussionForumConnectionsによって、WebCenter Portalアプリケーションに対して構成されているすべてのディスカッション・サーバー接続およびそれらの詳細が一覧表示されます。0に設定すると、接続名のみが一覧表示されます。この引数のデフォルトは、0です。

name

オプション。既存のディスカッション・サーバー接続の名前を示します。この引数を使用して、特定のディスカッション・サーバーの接続に関する詳細情報を表示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、現在、webcenterという名前のアプリケーションに対して設定したディスカッション・サーバーのすべての接続の名前を表示します。

wls:/weblogic/serverConfig>listDiscussionForumConnections(appName='webcenter')

次の例は、現在、webcenterという名前のアプリケーションに対して設定したディスカッション・サーバーのすべての接続の名前とその詳細情報を表示します。

wls:/weblogic/serverConfig>listDiscussionForumConnections(appName='webcenter',
verbose=1)

この例は、myDiscussionsServerという名前のディスカッション・サーバーの接続に関する詳細情報を表示します。

wls:/weblogic/serverConfig> listDiscussionForumConnections(appName='webcenter',
name='myDiscussionsServer')

listDefaultDiscussionForumConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションで、ディスカッション・サービスとお知らせサービスが使用するディスカッション・サーバー接続の名前を示します。1つのWebCenter Portalアプリケーションに対して複数のディスカッション・サーバー接続を登録できますが、ディスカッションとお知らせサービスに対して使用される接続は、デフォルト(またはアクティブ)接続と呼ばれる1つのみです。

構文

listDefaultDiscussionForumConnection(appName, [verbose, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

verbose

オプション。有効なオプションは、1 (true)および0 (false)です。1に設定すると、ディスカッション・サーバー接続の名前および詳細が一覧表示されます。0に設定すると、接続の名前のみ表示されます。この引数のデフォルトは、0です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、ディスカッション・サービス/お知らせサービスが使用しているディスカッション・サーバー接続の名前をwebcenterというアプリケーションに表示します。

wls:/weblogic/serverConfig> listDefaultDiscussionForumConnection(appName='webcenter')

次の例は、ディスカッション・サービス/お知らせサービスが使用しているディスカッション・サーバー接続の名前とその詳細情報を表示します。

wls:/weblogic/serverConfig> listDefaultDiscussionForumConnection(appName='webcenter', verbose=1)

setDefaultDiscussionForumConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションにおけるディスカッション・サービスとお知らせサービスのデフォルト・ディスカッション・サーバー接続を指定します。

1つのWebCenter Portalアプリケーションに対して複数のディスカッション・サーバー接続を登録できますが、ディスカッションとお知らせサービスに対して使用される接続は、デフォルト(またはアクティブ)接続と呼ばれる1つのみです。

構文

setDefaultDiscussionForumConnection(appName, name, [server,
applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のディスカッション・サーバー接続の名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、ディスカッション・サービスおよびお知らせサービスのmyDiscussionServerという名前のデフォルト(またはアクティブ)接続を作成します。

wls:/weblogic/serverConfig> setDefaultDiscussionForumConnection
(appName='webcenter', name='myDiscussionServer')

setDiscussionForumServiceProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

ディスカッション・サービスのデフォルト値を指定します。

ディスカッション・サービスの構成可能なプロパティは、表10-10「ディスカッション・サービスの構成プロパティ」に一覧表示します。

表10-10 ディスカッション・サービスの構成プロパティ

構成プロパティ

説明

topics.fetch.size

ディスカッション・サービスによって検索してトピック・ビューに表示されるトピックの最大数を示します。

forums.fetch.size

ディスカッション・サービスによって検索してフォーラム・ビューに表示されるフォーラムの最大数を示します。

recentTopics.fetch.size

ディスカッション・サービスによって検索して最新トピック・ビューに表示されりトピックの最大数を示します。

watchedTopics.fetch.size

ディスカッション・サービスによって検索して表示済トピック・ビューに表示されるトピックの最大数を示します。

watchedForums.fetch.size

ディスカッション・サービスによって検索して表示済フォーラム・ビューに表示されるフォーラムの最大数を示します。

application.root.category.id

すべてのディスカッション・フォーラムが格納されているディスカッション・サーバー上のアプリケーション・ルート・カテゴリIDを示します。たとえば、3に設定すると、すべてのフォーラムがカテゴリ3内に格納されます。

ForumGatewayManager.AUTO_START

メール配信リストによる通信は、ディスカッション・フォーラム投稿として公開できます。このパラメータによって、この通信のゲートウェイを起動または停止します。

Spacesアプリケーションの場合、デフォルト値は1であり、その場合、管理を介してメール・サーバー設定を構成するとただちにゲートウェイが起動します。ゲートウェイを停止してこの機能を無効化するには、これを0に設定し、管理対象サーバーを再起動します。

WebCenter Portalアプリケーションの場合、デフォルト値は0です。ゲートウェイを起動してこの機能を有効化するには、これを1に設定し、管理対象サーバーを再起動します。

構文

setDiscussionForumServiceProperty(appName, property, value, [server,
applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

property

構成プロパティの名前を示します。

value

プロパティの値を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、トピック・ビューに表示されるトピックのデフォルト数を変更します。

wls:/weblogic/serverConfig>setDiscussionForumServiceProperty
(appName='webcenter', property='topics.fetch.size', value='30')

removeDiscussionForumServiceProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

ディスカッション・サービス・プロパティに設定されている現在の値を削除します。このコマンドを使用して、表10-10「ディスカッション・サービスの構成プロパティ」に一覧表示されている任意のプロパティを削除します。

これらのプロパティの値を削除すると予期しない動作を引き起こす可能性があるので、このコマンドを使用するときは注意してください。

注意:

このコマンド構文を使用して、現在、ディスカッション・サービスおよびお知らせサービスのために使用している接続を無効に設定します。

removeDiscussionForumServiceProperty('appName='webcenter', property='selected.connection')

このコマンドを使用すると、default接続引数が0に設定されます。「setDiscussionForumConnection」も参照してください。

構文

removeDiscussionForumServiceProperty(appName, property, [server,
applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

property

構成プロパティの名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、ディスカッション・サービスの現在のtopics.fetch.sizeプロパティをwebcenterという名前のアプリケーションからクリアします。

wls:/weblogic/serverConfig> removeDiscussionForumServiceProperty
(appName='webcenter', property='topics.fetch.size')

listDiscussionForumServiceProperties

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

ディスカッション・サービスのすべての設定可能なプロパティを表示します。

構文

listDiscussionForumServiceProperties(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、ディスカッション・サービスの構成プロパティをwebcenterという名前のアプリケーションに表示します。

wls:/weblogic/serverConfig> listDiscussionForumServiceProperties(appName='webcenter')

setAnnouncementServiceProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

お知らせサービスのデフォルト値を指定します。

お知らせサービスの設定可能なプロパティは、表10-11 「お知らせサービスの構成プロパティ」に表示されています。

表10-11 お知らせサービスの構成プロパティ

構成プロパティ

説明

miniview.page_size

通知の小型ビューに表示される通知の最大数を示します。

mainview.page_size

通知のメイン・ビューに表示される通知の最大数を示します。

linksview.page_size

通知のリンク・ビューに表示される通知の最大数を示します。

announcements.expiration.days

通知の有効期限を示します。

構文

setAnnouncementServiceProperty(appName, property, value, [server, applicationVersion})

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

property

構成プロパティの名前を示します。

value

プロパティ値。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、webcenterという名前のアプリケーションで通知を表示されるデフォルト日数を変更します。

wls:/weblogic/serverConfig> setAnnouncementServiceProperty(appName='webcenter',
property='announcements.expiration.days', value='21')

removeAnnouncementServiceProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

お知らせサービス・プロパティに設定されている現在の値を削除します。このコマンドを使用して、表10-11「お知らせサービスの構成プロパティ」に一覧表示されている任意のプロパティを削除します。

これらのプロパティの値を削除すると予期しない動作を引き起こす可能性があるので、このコマンドを使用するときは注意してください。

構文

removeAnnouncementServiceProperty(appName, property, [server,
applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

property

構成プロパティの名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、お知らせサービスのannouncements.expiration.daysプロパティをwebcenterという名前のアプリケーションからクリアします。

wls:/weblogic/serverConfig> removeAnnouncementServiceProperty
(appName='webcenter', property='announcements.expiration.days')

listAnnouncementServiceProperties

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

お知らせサービスのすべての設定可能なプロパティを表示します。

構文

listAnnouncementServiceProperties(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、お知らせサービスの構成プロパティをwebcenterという名前のアプリケーションに表示します。

wls:/weblogic/serverConfig> listAnnouncementServiceProperties(appName='webcenter')

addDiscussionsServerAdmin

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

ユーザーまたはグループにディスカッション・サーバーのシステム管理者パーミッションを付与します。このコマンドは、現在の管理者のいずれも含まない新しいアイデンティティ・ストアにディスカッション・サーバーを接続する際に役立ちます。

構文

addDiscussionsServerAdmin(appName, name, [type, server, applicationVersion])

引数

定義

appName

この操作を実行するディスカッション・サーバー・アプリケーションの名前。たとえば、owc_discussionsです。

name

ディスカッション・サーバーの管理者として追加するユーザーまたはグループの名前。

type

オプション。アイデンティティのタイプを識別します。有効な値は、USERおよびGROUPです。デフォルト値はUSERです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Collaborationです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ユーザーweblogicにディスカッション・サーバーのシステム管理者パーミッションを付与します。

addDiscussionsServerAdmin(appName='owc_discussions', name='weblogic', type='USER')

次の例では、Administratorsユーザー・グループのすべてのユーザーにディスカッション・サーバーのシステム管理者パーミッションを付与します。

addDiscussionsServerAdmin(appName='owc_discussions', name='Administrators', type='GROUP')

syncDiscussionServerPermissions

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

(Spacesアプリケーションのみ)親からセキュリティを継承するサブスペースのディスカッション・サーバー・パーミッションを同期します。

Spacesアプリケーション内のスペース階層のディスカッションまたはお知らせパーミッションを更新しても、サブスペースはWebCenter Portalのディスカッション・サーバー上の対応するパーミッションの変更を自動的に継承しません。したがって、変更が行われた場合、このコマンドを実行して、サブスペースが親と同じディスカッション・サーバー・パーミッションを継承するように、スペース階層内のディスカッションおよびお知らせパーミッションを同期する必要があります。

注意:

syncDiscussionServerPermissionsなどのディスカッション・サーバーWLSTコマンドを実行するには、管理サーバーに接続するために使用するユーザーがディスカッション・サーバーの管理パーミッションも持っている必要があります。

構文

syncDiscussionServerPermissions(appName, [server, applicationVersion])

引数

定義

appName

この操作を行うSpacesアプリケーションの名前。常にwebcenterです。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Spacesアプリケーションのディスカッションおよびお知らせパーミッションを同期します。つまり、サブスペースが親と同じディスカッション・サーバー・パーミッションを継承します。

wls:/weblogic/serverConfig> syncDiscussionServerPermissions(appName='webcenter')

setDiscussionsServerProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

ディスカッション・サーバー・プロパティを設定します。

このコマンドを使用して、ディスカッション・サーバーのシステム・プロパティを設定します。

注意:

setDiscussionsServerPropertyなどのディスカッション・サーバーWLSTコマンドを実行するには、管理サーバーに接続するために使用するユーザーがディスカッション・サーバーの管理権限も持っている必要があります。

構文

setDiscussionsServerProperty(appName, key, value, [server, applicationVersion])

引数

定義

appName

この操作を実行するディスカッション・サーバー・アプリケーションの名前。たとえば、owc_discussionsです。

key

ディスカッション・サーバー・プロパティの名前。

value

ディスカッション・サーバー・プロパティの値。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Collaborationです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、SSOのディスカッション・サーバーを構成するプロパティを設定します。example.com:8890/owc_discussionsはディスカッション・サーバーがデプロイされるWeb層のベースURLです。

wls:/weblogic/serverConfig>
setDiscussionsServerProperty(appName='owc_discussions', key='owc_discussions.sso.mode', value='true')
setDiscussionsServerProperty(appName='owc_discussions', key='jiveURL', value='example.com:8890/owc_discussions')

getDiscussionsServerProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

ディスカッション・サーバー・プロパティの現在の値を返します。

注意:

getDiscussionsServerPropertyなどのディスカッション・サーバーWLSTコマンドを実行するには、管理サーバーに接続するために使用するユーザーがディスカッション・サーバーの管理権限も持っている必要があります。

構文

getDiscussionsServerProperty(appName, key, [server, applicationVersion])

引数

定義

appName

この操作を実行するディスカッション・サーバー・アプリケーションの名前。たとえば、owc_discussionsです。

key

ディスカッション・サーバー・プロパティの名前。たとえば、owc_discussions.sso.mode、AuthFactory.className, UserManager.className、GroupManager.className、owc_discussions.setup.complete_11.1.1.2.0などです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Collaborationです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、いくつかの主要なディスカッション・サーバー・プロパティの現在の値を返します。

wls:/weblogic/serverConfig> getDiscussionsServerProperty
(appName='owc_discussions', key='AuthFactory.className')
getDiscussionsServerProperty
(appName='owc_discussions', key='UserManager.className')
getDiscussionsServerProperty
(appName='owc_discussions', key='GroupManager.className')
getDiscussionsServerProperty
(appName='owc_discussions', key=', )

removeDiscussionsServerProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

ディスカッション・サーバー・プロパティに設定されている現在の値を削除します。

注意:

removeDiscussionsServerPropertyなどのディスカッション・サーバーWLSTコマンドを実行するには、管理サーバーに接続するために使用するユーザーがディスカッション・サーバーの管理権限も持っている必要があります。

構文

removeDiscussionsServerProperty(appName, key, [server, applicationVersion])

引数

定義

appName

この操作を実行するディスカッション・サーバー・アプリケーションの名前。たとえば、owc_discussionsです。

key

ディスカッション・サーバー・プロパティの名前。たとえば、owc_discussions.sso.mode、AuthFactory.className, UserManager.className、GroupManager.className、owc_discussions.setup.complete_11.1.1.2.0などです。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Collaborationです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ディスカッション・サーバーの'SSO mode'プロパティの現在の値を削除します。

wls:/weblogic/serverConfig> removeDiscussionsServerProperty
(appName='owc_discussions', key='owc_discussions.sso.mode')

外部アプリケーション

表10-12に示すコマンドを使用して、WebCenter Portalアプリケーションの外部アプリケーション接続を管理します。

これらのWebCenter Portal WLSTコマンドを使用して行った構成変更は、WebCenter Portalアプリケーションでただちに有効になります。

表10-12 外部アプリケーションWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

createExtAppConnection

指定したWebCenter Portalアプリケーションの外部アプリケーション接続を作成します。

オンライン

setExtAppConnection

既存の外部アプリケーション接続を編集します。

オンライン

listExtAppConnections

特定のWebCenter Portalアプリケーションに対して構成されている個々またはすべての外部アプリケーションを表示します。

オンライン

addExtAppField

特定の外部アプリケーション接続の別のログイン・フィールドを追加します。

オンライン

setExtAppField

特定の外部アプリケーション・ログイン・フィールドの値およびdisplay-to-user設定を編集します。

オンライン

removeExtAppField

外部アプリケーション・ログイン・フィールドを削除します。

オンライン

addExtAppCredential

外部アプリケーションの共有資格証明またはパブリック資格証明を指定します。

オンライン

setExtAppCredential

外部アプリケーションの共有資格証明またはパブリック資格証明を編集します。

オンライン

removeExtAppCredential

現在、外部アプリケーションに対して設定されている共有資格証明またはパブリック資格証明を削除します。

オンライン

createExtAppConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションの外部アプリケーション接続を作成します。

構文

createExtAppConnection(appName, name, [displayName, url, authMethod,
userFieldName, pwdFieldName, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

displayName

オプション。外部アプリケーション表示名を示します。アプリケーションの、WebCenter Portalユーザーにとってわかりやすいユーザー・フレンドリな名前。表示名は、WebCenter Portalアプリケーション内のすべての外部アプリケーション間で一意である必要があります。

url

オプション。外部アプリケーションのログインURLを示します。

アプリケーションのURLを確定するには、アプリケーションのログイン・ページに移動して、そのページのURLを記録します。例: http://login.yahoo.com/config/login

authMethod

オプション。外部アプリケーションで使用される認証メソッドを示します。有効なオプションは、GET、POSTおよびBASIC。この引数のデフォルトは、POSTです。

userFieldName

オプション。外部アプリケーション・ログイン・フォーム上のユーザー名フィールドまたはユーザーIDフィールドを識別する名前を示します。この名前を探すには、ログイン・ページのHTMLソースを参照します。この引数は、ユーザー資格証明を指定しません。

authMethodがGETまたはPOST であり、ログインurlが指定されている場合は必須です。BASIC認証メソッドが選択されている場合は、不要です。

pwdFieldName

オプション。外部アプリケーション・ログイン・フォーム上のパスワード・フィールドを識別する名前を示します。この名前を探すには、ログイン・ページのHTMLソースを参照します。この引数は、ユーザー資格証明を指定しません。

authMethodがGETまたはPOST であり、ログインurlが指定されている場合は必須です。BASIC認証メソッドが選択されている場合は、不要です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter PortalアプリケーションにMy Yahoo!という名前の外部アプリケーションの接続を作成します。

wls:/weblogic/serverConfig> createExtAppConnection(appName='webcenter',
name='yahoo', displayName='My Yahoo!', url='http://login.yahoo.com/config/login',
authMethod='POST', userFieldName='login', pwdFieldName='passwd')

setExtAppConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

既存の外部アプリケーション接続を編集します。

構文

setExtAppConnection(appName, name, [displayName], [url], [authMethod],
[userFieldName], [pwdFieldName], [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存の外部アプリケーション接続の名前を示します。

displayName

オプション。外部アプリケーション表示名を示します。アプリケーションの、WebCenter Portalユーザーにとってわかりやすいユーザー・フレンドリな名前。表示名は、WebCenter Portalアプリケーション内のすべての外部アプリケーション間で一意である必要があります。

url

オプション。外部アプリケーションのログインURLを示します。アプリケーションのURLを確定するには、アプリケーションのログイン・ページに移動して、そのページのURLを記録します。

authMethod

オプション。外部アプリケーションで使用される認証メソッドを示します。有効なオプションは、GET、POSTおよびBASIC。この引数のデフォルトは、POSTです。

userFieldName

オプション。外部アプリケーション・ログイン・フォーム上のユーザー名フィールドまたはユーザーIDフィールドを識別する名前を示します。この名前を探すには、ログイン・ページのHTMLソースを参照します。この引数は、ユーザー資格証明を指定しません。

authMethodがGETまたはPOSTであり、ログインURLが指定されている場合は必須ですが、BASIC認証メソッドを選択した場合、空のままにできます。

pwdFieldName

オプション。外部アプリケーション・ログイン・フォーム上のパスワード・フィールドを識別する名前を示します。この名前を探すには、ログイン・ページのHTMLソースを参照します。この引数は、ユーザー資格証明を指定しません。

authMethodは、GETまたはPOSTの場合、この引数を指定する必要があります。ただし、BASIC認証メソッドを選択した場合、空に設定できます。

server

オプション。WebCenterアプリケーションがデプロイされている管理対象サーバーの名前を示します。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。この引数は、WebCenterアプリケーションの1つまたは複数のバージョンがデプロイされている場合に必要になります。

例

次の例は、yahooという名前の外部アプリケーションの表示名属性を更新します。

wls:/weblogic/serverConfig> setExtAppConnection(appName='webcenter',
name='yahoo', displayName='My Favorite Yahoo!')

listExtAppConnections

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

appName引数のみを指定して、このコマンドを使用すると、現在、特定のWebCenterアプリケーションに対して設定したすべての外部アプリケーションの名前が表示されます。

構文

listExtAppConnections(appName, [verbose, name, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenterアプリケーションの名前。

verbose

オプション。外部アプリケーションの詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listExtAppConnectionsによって、WebCenterアプリケーションに対して構成されているすべての外部アプリケーションおよびその詳細が一覧表示されます。0に設定した場合、listExtAppConnectionsによって、外部アプリケーションの名前のみが一覧表示されます。この引数のデフォルトは、0です。

この引数を0に設定した場合、name引数を指定しないでください。

name

オプション。既存の外部アプリケーション接続の名前を示します。この引数を使用して、特定の接続の詳細情報を表示できます。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のWebCenter Portalアプリケーションで現在使用されているすべての外部アプリケーションの名前を一覧表示します。

wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter')
app1
app2
app3

次の例は、外部アプリケーションのapp1、app2およびapp3の詳細情報を表示します。

wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter', verbose=1)
----
app1
----
Name: app1
Display Name: Application1
Login URL: http://app1
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Shared Credential: Disabled
Public Credential: Disabled
----
app2
----
Name: app2
Display Name: Application2
Login URL: http://app2
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Additional Fields: {Account1:1, Accout2:DefVal:0}
Shared Credential: Disabled
Public Credential: Enabled
----
app3
----
Name: app3
Display Name: Application3
Authentication Method: POST
Shared Credential: Enabled
Public Credential: Enabled

次の例は、外部アプリケーションapp1のみの詳細情報を表示します。

wls:/weblogic/serverConfig> listExtAppConnections(appName='webcenter', verbose=1, name='app1')
----
app1
----
Name: app1
Display Name: Application1
Login URL: http://app1
Authentication Method: POST
User Field Name: login
Password Field Name: passwd
Shared Credential: Disabled
Public Credential: Disabled

addExtAppField

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

特定の外部アプリケーション接続の別のログイン・フィールドを追加します。たとえば、外部アプリケーションでは、ユーザー名およびパスワードの他に、HostおよびMailAddressなどその他のログイン条件も入力する必要がある場合があります。

オプションで、ユーザーが追加ログイン・フィールを指定できるように外部アプリケーションのログインに表示されます。

別のログイン・フィールドを追加し、かつ外部アプリケーションで共有またはパブリック資格証明を使用する場合、WLSTコマンドaddExtAppCredentialおよびsetExtAppCredentialを使用して、共有またはパブリック資格証明を更新できます「addExtAppCredential」および「setExtAppCredential」を参照してください。

構文

addExtAppField(appName, name, fieldName, [fieldValue], [displayToUser], [server,
applicationVersion])

引数

定義

appName

この操作を実行するWebCenterアプリケーションの名前。

name

既存の外部アプリケーション接続の名前を示します。

fieldName

ログイン・フィールド名を示します。HTMLログイン・フォーム上のフィールドを識別する名前を示します。アプリケーションでは、認証メソッドとしてBASICを使用している場合、このフィールドを該当しません。

fieldValue

オプション。ログイン・フィールド値を示します。ログイン・フィールドにデフォルト値を入力するか、または、ユーザーが値を入力できるようにフィールドを空に設定します。デフォルトで、この引数は空です。

displayToUser

オプション。外部アプリケーションのログイン画面にログイン・フィールドが表示されるかどうかを指定します。有効なオプションは、1 (true)および0 (false)です。この引数のデフォルトは、0です。

この引数を0に設定した場合、fieldValueを指定する必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

この例は、ABCという外部アプリケーションにusername.default.exampleのデフォルト値でAccountという名前の追加フィールドを作成します。このフィールドは、ABCのログイン・ページに表示されます。

wls:/weblogic/serverConfig> addExtAppField(appName='webcenter', name='ABC',
fieldName='Account', fieldValue='username.default.example',
displayToUser=1)

setExtAppField

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

現在、外部アプリケーションに対して設定されている1つまたは複数のログイン・フィールドのフィールド値およびdisplay-to-user設定を変更します。外部アプリケーションの名前およびログイン・フィールド名とともにfieldValueまたはdisplayToUserを指定する必要があります。fieldValueおよびdisplayToUser引数は、オプションです。

このコマンドを使用すると、この外部アプリケーションに対して作成された共有資格証明またはパブリック資格証明を使用する必要があります。displayToUserを1に変更すると、場合によっては、既存の共有ユーザー資格証明またはパブリック・ユーザー資格証明を更新することも必要です。「setExtAppCredential」も参照してください。

構文

setExtAppField(appName, name, fieldName, [fieldValue], [displayToUser], [server,
applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存の外部アプリケーション接続の名前を示します。

fieldName

既存のログイン・フィールドの名前を示します。

fieldValue

オプション。新しいまたは変更したログイン・フィールド値を示します。

ログイン・フィールドにデフォルト値を入力するか、または、ユーザーが値を入力できるようにフィールドを空に設定します。デフォルトで、この引数は空です。

displayToUser

オプション。外部アプリケーションのログイン画面にログイン・フィールドが表示されるかどうかを指定します。有効なオプションは、1 (true)および0 (false)です。

0に設定した場合、fieldValueを指定する必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、Accountというログイン・フィールドのデフォルト値を指定し、外部アプリケーションの資格証明配信画面にそのフィールドを表示します。

wls:/weblogic/serverConfig> setExtAppField(appName='webcenter', name='ABC',
fieldName='Account', fieldValue='admin', displayToUser=1)

removeExtAppField

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

外部アプリケーション接続からログイン・フィールドを削除します。

このコマンドを使用すると、この外部アプリケーションに対して作成された任意の共有資格証明またはパブリック資格証明の使用を考慮する必要があります。つまり、共有ユーザー資格証明またはパブリック・ユーザー資格証明からログイン・フィールドを削除する必要があります。

必要に応じて、setExtAppCredentialコマンドを使用して、ログイン・フィールドを削除できます。たとえば、外部アプリケーションのmyAppには、Accountという追加フィールドがあり、次のコマンドを使用してパブリック資格証明が前に指定されています。

addExtAppCredential(appName='webcenter', name='myApp', type='PUBLIC',
username='admin', password='mypublic.password', field='Account:admin@myhost.com')

Accountフィールドを削除すると、次のコマンドを実行して、資格証明を変更できます。

setExtAppCredential(appName='webcenter', name='myApp', type='PUBLIC',
username='admin', password='mypublic.password')

setExtAppCredentialの使用に関する詳細情報については、「setExtAppCredential」を参照してください。

構文

removeExtAppField(appName, name, fieldName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenterアプリケーションの名前。

name

接続の名前を示します。

fieldName

削除するログイン・フィールドを示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、ABCという外部アプリケーションからAccountという名前の追加ログイン・フィールドを削除します。

wls:/weblogic/serverConfig> removeExtAppField(appName='webcenter, name='ABC',
fieldName='Account')

addExtAppCredential

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

特定の外部アプリケーションの共有ユーザー資格証明またはパブリック・ユーザー資格証明を設定します。

共有資格証明を指定すると、ここで定義したユーザー名およびパスワードを使用して、WebCenter Portalアプリケーションにアクセスするすべてのユーザーが認証されます。WebCenter Portalユーザーには、ログイン・フォームは表示されません。

WebCenter Portalを使用してこのアプリケーションにアクセスするパブリック・ユーザーは、ここで定義したパブリック資格証明を使用してログインします。

すでに資格証明が存在する場合は、setExtAppCredentialコマンドを使用する必要があることを示す報告メッセージが表示されます。

構文

addExtAppCredential(appName, name, type, username, password, [field, server,
applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存の外部アプリケーション接続の名前を示します。

type

資格証明のタイプを示します。有効な値は、SHAREDおよびPUBLICです。

username

共有ユーザーまたはパブリック・ユーザーの名前を示します。

password

共有ユーザーまたはパブリック・ユーザーのパスワードを示します。

field

オプション。追加のログイン・フィールドの値を示します。形式として、FieldName:FieldValueを使用します。ここで、FieldNameは、displayToUser=1で構成した追加ログイン・フィールドの名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、外部アプリケーションABCのパブリック資格証明を指定します。パブリック・ユーザー名は、mypublic.usernameで、パスワードは、mypublic.passwordであり、Accountという追加フィールド名が存在します。

wls:/weblogic/serverConfig> addExtAppCredential(appName='webcenter', name='ABC',
type='PUBLIC', username='mypublic.username', password='mypublic.password',
field='Account:username.example')

setExtAppCredential

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

現在、外部アプリケーションに対して設定した共有ユーザー資格証明またはパブリック・ユーザー資格証明を変更します。すでに資格証明が指定されていない場合は、addExtAppCredentialを使用する必要があることを示す報告メッセージが表示されます。「addExtAppCredential」を参照してください。

setExtAppCredentialは、既存の資格証明のみ計算するので、usernameおよびpasswordの引数をオプションです。パラメータusername、passwordまたはfieldの少なくとも1つを指定する必要があります。

数日当たりにパスワードを変更する必要があるシステムのパスワードを更新するには、setExtAppCredentialコマンドを使用できます。

構文

setExtAppCredential(appName, name, type, [username], [password], [field],
[server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存の外部アプリケーション接続の名前を示します。

type

資格証明のタイプを示します。有効な値は、SHAREDおよびPUBLICです。

username

オプション。共有ユーザーまたはパブリック・ユーザーのユーザー名を示します。

password

オプション。共有ユーザーまたはパブリック・ユーザーのパスワードを示します。

field

オプション。追加のログイン・フィールドの値を示します。形式として、FieldName:FieldValueを使用します。ここで、FieldNameは、displayToUser=1で構成した追加ログイン・フィールドの名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、外部アプリケーションABCのパブリック・ユーザーのログイン資格証明を変更します。

wls:/weblogic/serverConfig> setExtAppCredential(appName='webcenter',name='ABC',
type='PUBLIC', username='username.example', password='password.example',
field='Account:username.example')

removeExtAppCredential

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

現在、外部アプリケーションに対して設定した共有ユーザー資格証明またはパブリック・ユーザー資格証明を削除します。

資格証明が存在しない場合、エラーが表示されます。

構文

removeExtAppCredential(appName, name, type, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存の外部アプリケーション接続の名前を示します。

type

資格証明のタイプを示します。有効な値は、SHAREDおよびPUBLICです。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、外部アプリケーションABCに対して指定した共有資格証明を削除します。

wls:/weblogic/serverConfig> removeExtAppCredential(appName='webcenter',
name='ABC', type='SHARED')

インスタント・メッセージおよびプレゼンス

表10-13に指定されているコマンドを使用して、インスタント・メッセージおよびプレゼンス・サーバー接続を管理します。

これらのWebCenter Portal WLSTコマンドを使用して行った構成変更は、WebCenter Portalアプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

表10-13 インスタント・メッセージおよびプレゼンスWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

createIMPConnection

WebCenter Portalアプリケーションの新しいインスタント・メッセージおよびプレゼンス・サーバー接続を作成します。

オンライン

setIMPConnection

既存のインスタント・メッセージおよびプレゼンス・サーバー接続を編集します。

オンライン

setIMPConnectionProperty

インスタント・メッセージおよびプレゼンス・サーバー接続を変更します。

オンライン

deleteIMPConnectionProperty

インスタント・メッセージおよびプレゼンス・サーバー接続プロパティを削除します。

オンライン

listIMPAdapters

WebCenter Portalアプリケーションでサポートされるプレゼンス・サーバーを表示します。

オンライン

listIMPConnections

アプリケーションに対して設定したすべてのインスタント・メッセージおよびプレゼンス・サーバー接続を表示します。

オンライン

listDefaultIMPConnection

アプリケーションに対して設定したデフォルト・インスタント・メッセージおよびプレゼンス・サーバー接続を表示します。

オンライン

setDefaultIMPConnection

指定した接続をデフォルト・インスタント・メッセージおよびプレゼンス・サーバー接続として設定します。

オンライン

setIMPServiceProperty

インスタント・メッセージおよびプレゼンス・サービスのデフォルトを指定します。

オンライン

removeIMPServiceProperty

インスタント・メッセージおよびプレゼンス・サービスのデフォルトを削除します。

オンライン

listIMPServiceProperties

インスタント・メッセージおよびプレゼンス・サービスのプロパティを表示します。

オンライン

createIMPExtAppConnection

インスタント・メッセージおよびプレゼンス・サーバー接続に適した外部アプリケーションを作成します。

オンライン

createIMPConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションのインスタント・メッセージおよびプレゼンス・サーバー接続を作成します。

サポートされているインスタント・メッセージおよびプレゼンス・サーバーのタイプを探すには、listIMPAdaptersコマンドを使用します。初期の設定では、WebCenter PortalアプリケーションはMicrosoft Live Communications Server 2005 (LCS)、Microsoft Communications Server 2007 (OCS)およびMicrosoft Lync 2010をサポートしています。

1つのWebCenter Portalアプリケーションに対して複数のプレゼンス・サーバー接続を登録できますが、インスタント・メッセージおよびプレゼンス・サービスに対して使用される接続は1つのみであり、デフォルト(またはアクティブ)接続が使用されます。

構文

createIMPConnection(appName, name, adapter, url, [appId, poolName,
userDomain, timeout, default, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

adapter

アダプタ名。インスタント・メッセージおよびプレゼンス・サーバーに一致するアダプタを指定します。有効な値は、LCSおよびOCSです。

Microsoft Live Communication Server 2005の場合、LCSを選択します。

Microsoft Office Communications Server 2007およびMicrosoft Lyncの場合、OCS2007を選択します。

url

インスタント・メッセージおよびプレゼンス・サービスをホストしているサーバーのURLを示します。

例: http://myocshost.com:8888

domain

非推奨です。

setIMPServicePropertyコマンドを使用して、IMアドレスを解決します。

appId

オプション。プレゼンス・サーバー接続に関連付けられる外部アプリケーションを示します。

指定した場合、LCS、OCSまたはLyncサーバーに対してユーザーの認証を行うために外部アプリケーション資格証明情報が使用されます。LCS、OCSおよびLyncサーバー接続の場合は、この引数は必須です。

インスタント・メッセージおよびプレゼンス・サービスに対して構成する外部アプリケーションでは、authMethod=POSTを使用して、fieldName='Account'およびdisplaytoUser=1で追加フィールドを指定する必要があります。外部アプリケーションがまだ存在していない場合、WLSTコマンドcreateIMPExtAppConnectionを使用して、必要な追加フィールドすべてを自動的に持つ外部アプリケーションを作成します。

「addExtAppField」および「setExtAppField」も参照してください。

poolName

オプション。LCS、OCSまたはLync接続を作成するために必要なプール名。プール名の詳細は、Microsoft Live Communications Server、Microsoft Office Communications ServerまたはMicrosoft Lync Serverのドキュメントを参照してください。

LCS、OCSおよびLyncサーバー接続の場合は、この引数は必須です。

userDomain

オプション。(OCSおよびLync接続のみ。)OCSまたはLyncサーバー上のActive Directoryドメイン。

OCSまたはLyncサーバー接続の場合、この引数は必須です。

timeout

オプション。接続タイムアウト・メッセージを出す前にプレゼンス・サーバーからの応答を受信する間のインスタント・メッセージおよびプレゼンス・サービスの待機時間(秒の単位)の長さを示します。この引数のデフォルトは、-1です。-1に設定すると、サービスのデフォルト値(10秒)が適用されます。

default

オプション。この接続は、インスタント・メッセージおよびプレゼンス・サービスのデフォルト接続であるかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、インスタント・メッセージおよびプレゼンス・サーバー接続に適した外部アプリケーションを作成し、次に、Microsoft Live Communications ServerへのmyLCSPresenceServerという名前の接続を作成します。

wls:/weblogic/serverConfig> createIMPExtApp(appName='webcenter', name='LCSExtApp', displayName='IMP Ext App')
wls:/weblogic/serverConfig> createIMPConnection(appName='webcenter',
name='myLCSPresenceServer', adapter='LCS', url='http://mylcshost.com/owc/lcs',
appId='LCSExtApp', poolName='pool1.myhost.com', timeout=60,
default=1)

次の例では、myOCSPresenceServerという名前のMicrosoft Office Communications Serverへのインスタント・メッセージおよびプレゼンス・サーバー接続を作成します。

wls:/weblogic/serverConfig> createIMPConnection(appName='webcenter',
name='myOCSPresenceServer', adapter='OCS2007', url='http://myocshost.com/owc/ocs',
appId='OCSExtApp', userDomain='OCS', poolName='pool01.myocshost.com', timeout=60, default=1)

次の例では、myLyncServerという名前のMicrosoft Lync Serverへのインスタント・メッセージおよびプレゼンス・サーバー接続を作成します。

wls:/weblogic/serverConfig>createIMPConnection(appName='webcenter',
name='myLyncServer', adapter='OCS2007',
url='http://mylynchost.com:8888' appId='LyncExtApp', userDomain='LYNC', poolName='pool05.mylynchost.com', timeout=60, default=1))

setIMPConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

既存のインスタント・メッセージおよびプレゼンス・サーバーの接続を編集します。このコマンドを使用して、接続の属性を更新します。

createIMPConnectionコマンドを使用して、接続が作成されます。

構文

setIMPConnection(appName, name, [adapter, url, appId, poolName,
userDomain, timeout, default, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のプレゼンス・サーバー接続の名前を示します。

adapter

オプション。アダプタ名。インスタント・メッセージおよびプレゼンス・サーバーに一致するアダプタを指定します。有効な値は、LCSおよびOCS2007です。

Microsoft Live Communications Serverの場合、LCSを選択します。

Microsoft Office Communications ServerおよびMicrosoft Lync Serverの場合、OCS2007を選択します。

url

オプション。インスタント・メッセージおよびプレゼンス・サービスをホストしているサーバーのURLを示します。

domain

非推奨です。

setIMPServicePropertyコマンドを使用して、IMアドレスを解決します。

appId

オプション。プレゼンス・サーバー接続に関連付けられる外部アプリケーションを示します。

指定した場合、LCS、OCSまたはLyncサーバーに対してユーザーの認証を行うために外部アプリケーション資格証明情報が使用されます。LCS、OCSおよびLyncサーバー接続の場合は、この引数は必須です。

インスタント・メッセージおよびプレゼンス・サービスに対して構成する外部アプリケーションでは、authMethod=POSTを使用して、fieldName='Account'およびdisplaytoUser=1で追加フィールドを指定する必要があります。外部アプリケーションがまだ存在していない場合、WLSTコマンドcreateIMPExtAppConnectionを使用して、必要な追加フィールドすべてを自動的に持つ外部アプリケーションを作成します。

「addExtAppField」および「setExtAppField」も参照してください。

poolName

オプション。(LCS、OCSおよびLync) LCS、OCSまたはLync接続を作成するために必要なプール名。プール名の詳細は、Microsoft Live Communications Server、Microsoft Office Communications ServerまたはMicrosoft Lync Serverのドキュメントを参照してください。

LCS、OCSおよびLyncサーバー接続の場合は、この引数は必須です。

userDomain

オプション。(OCSおよびLyncのみ。)OCSサーバー上のActive Directoryドメイン。

OCSまたはLyncサーバー接続の場合、この引数は必須です。

timeout

オプション。接続タイムアウト・メッセージを出す前にプレゼンス・サーバーからの応答を受信する間のインスタント・メッセージおよびプレゼンス・サービスの待機時間(秒の単位)の長さを示します。この引数のデフォルトは、-1です。-1に設定すると、サービスのデフォルト値(10秒)が適用されます。

default

オプション。この接続は、インスタント・メッセージおよびプレゼンス・サービスのデフォルト接続であるかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

インスタント・メッセージおよびプレゼンス・サービスで、この接続を使用することを指定するには、値を0から1に変更します。

この接続を無効に設定するには、removeIMPServicePropertyコマンドを使用します。

removeIMPServiceProperty('appName='webcenter', property='selected.connection')

1つのWebCenter Portalアプリケーションに対して複数のプレゼンス・サーバー接続を登録できますが、インスタント・メッセージおよびプレゼンス・サービスに対して使用される接続は1つのみであり、デフォルト(またはアクティブ)接続が使用されます。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、既存のインスタント・メッセージおよびプレゼンス・サーバー接続の属性を設定します。

wls:/weblogic/serverConfig>setIMPConnection(appName='webcenter',
name='myOCSPresenceServer', adapter='OCS2007', url='http://myocshost.com/owc/ocs',
timeout=120, default=0)

次の例は、既存のインスタント・メッセージおよびプレゼンス・サーバー接続の属性を設定します。

wls:/weblogic/serverConfig>setIMPConnection(appName='webcenter',
name='myLCSPresenceServer', adapter='LCS', url='http://mylcshost.com/owc/lcs',
appId='LCSExtApp', poolName='pool3.myhost.com')

setIMPConnectionProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

インスタント・メッセージおよびプレゼンス・サーバー接続プロパティを設定します。使用しているプレゼンス・サーバーに接続するために追加のパラメータを使用する必要がある場合、このコマンドを使用します。これは、キーおよび値を使用して任意の接続プロパティを追加する拡張可能な方法です。(createIMPConnectionおよびsetIMPConnectionに指定した接続プロパティを必ず使用しなければならないというわけではありません。)

setIMPConnectionPropertyを使用して、createIMPConnectionまたはsetIMPConnectionの利用可能なプロパティを設定しないでください。それを試みても、効果はありません。

構文

setIMPConnectionProperty(appName, name, key, value, [secure, server,
applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のプレゼンス・サーバー接続の名前を示します。

key

接続プロパティの名前を示します。

value

プロパティの値を示します。キーおよび値を持つ接続上の任意のプロパティを変更できます。

secure

オプション。暗号化を使用してプロパティの値を安全に格納するかどうかを示します。有効なオプションは、1 (true)および0 (false)です。1の場合、値が暗号化されます。デフォルト・オプションは0です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、デフォルト値のadminでadmin.userというカスタム・インスタント・メッセージおよびプレゼンス・サーバー接続プロパティを追加します。

wls:/weblogic/serverConfig> setIMPConnectionProperty(appName='webcenter',
name='MyLCSPresenceServer', key='admin.user', value='admin')

deleteIMPConnectionProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

インスタント・メッセージおよびプレゼンス・サーバー接続プロパティを削除します。接続プロパティを削除した結果、設定が無効になる場合、希望したとおりに接続されない可能性があるので、接続プロパティを削除するときに注意してください。

このコマンドを使用すると、setIMPConnectionPropertyコマンドを使用して追加したadditional接続プロパティのみ削除できます。

構文

deleteIMPConnectionProperty(appName, name, key, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のプレゼンス・サーバー接続の名前を示します。

key

削除する接続プロパティの名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、admin.userという名前のインスタント・メッセージおよびプレゼンス・サーバー接続プロパティを削除します。

wls:/weblogic/serverConfig> deleteIMPConnectionProperty(appName='webcenter',
name='MyLCSPresenceServer', key='admin.user')

listIMPAdapters

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalでサポートされるインスタント・メッセージおよびプレゼンス・サーバーのタイプを一覧表示します。初期の設定では、WebCenter Portalアプリケーションは、Microsoft Live Communications Server 2005 (LCS)、Microsoft Office Communications Server 2007 (OCS)およびMicrosoft Lync 2010をサポートします。

構文

listIMPAdapters()

例

次の例は、サポートされるプレゼンス・サーバーを指定します。

wls:/weblogic/serverConfig> listIMPAdapters()

listIMPConnections

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションに対して構成されているすべてのインスタント・メッセージおよびプレゼンス・サーバー接続を一覧表示します。

構文

listIMPConnections(appName,[verbose], [name], [server, applicationVersion)

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

verbose

オプション。プレゼンス・サーバー接続の詳細情報を冗長モードで表示します。有効な値は、1 (true)および0 (false)です。1に設定した場合、listIMPConnectionsによって、WebCenter Portalアプリケーションに対して構成されているすべてのプレゼンス・サーバー接続およびそれらの詳細が一覧表示されます。0に設定すると、接続名のみが一覧表示されます。この引数のデフォルトは、0です。

name

オプション。既存のプレゼンス・サーバー接続の名前を示します。この引数を使用して、特定のプレゼンス・サーバーの接続に関する詳細情報を表示します。verbose引数を1に設定したとき、name引数を使用すると、verbose引数が無視されることに注意します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、webcenterという名前のアプリケーションに対して設定したすべてのインスタント・メッセージおよびプレゼンス・サーバー接続を表示します。

wls:/weblogic/serverConfig> listIMPConnections(appName='webcenter')

次の例は、verboseモードのアプリケーションに対して設定したすべてのインスタント・メッセージおよびプレゼンス・サーバー接続を表示します。

wls:/weblogic/serverConfig> listIMPConnections(appName='webcenter', verbose=1)

次の例は、impConnection1という名前のインスタント・メッセージおよびプレゼンス・サーバーの接続に関する詳細情報を指定します。

wls:/weblogic/serverConfig> listIMPConnections(appName='webcenter', name='impConnection1')

listDefaultIMPConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションで、インスタント・メッセージおよびプレゼンス・サービスによって使用される接続が一覧表示されます。1つのWebCenter Portalアプリケーションに対して複数のプレゼンス・サーバー接続を登録できますが、インスタント・メッセージおよびプレゼンス・サービスに対して使用される接続は、デフォルト(またはアクティブ)接続の1つのみです。

利用可能なプレゼンス・サーバー接続が、1つのみ存在する場合は、その接続がデフォルト接続と想定されます。

構文

listDefaultIMPConnection(appName, verbose, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

verbose

オプション。利用可能であれば、デフォルト・プレゼンス・サーバー接続が冗長モードで表示されます。有効なオプションは、1 (true)および0 (false)です。1に設定すると、プレゼンス・サーバー接続の名前および詳細が一覧表示されます。0に設定すると、接続の名前のみ表示されます。この引数のデフォルトは、0です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、webcenterという名前のアプリケーションでインスタント・メッセージおよびプレゼンス・サービスによって使用される接続の名前および詳細情報を表示します。

wls:/weblogic/serverConfig>listDefaultIMPConnection(appName='webcenter', verbose=1)

setDefaultIMPConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーション内のインスタント・メッセージおよびプレゼンス・サービスのデフォルト接続を指定します。1つのWebCenter Portalアプリケーションに対して複数のプレゼンス・サーバー接続を登録できますが、インスタント・メッセージおよびプレゼンス・サービスに対して使用される接続は、デフォルト(またはアクティブ)接続の1つのみです。

利用可能なプレゼンス・サーバー接続が、1つのみ存在する場合は、その接続がデフォルト接続と想定されます。

構文

setDefaultIMPConnection(appName, name, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のインスタント・メッセージおよびプレゼンス接続の名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、インスタント・メッセージおよびプレゼンス・サービスのmyPresenceServerという名前のデフォルト(またはアクティブ)接続を作成します。

wls:/weblogic/serverConfig>setDefaultIMPConnection(appName='webcenter', name='myPresenceServer')

setIMPServiceProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

インスタント・メッセージおよびプレゼンス・サービスのデフォルト値を指定します。

インスタント・メッセージおよびプレゼンス・サービスの設定可能なプロパティは、表10-14 「インスタント・メッセージおよびプレゼンス・サービスの構成プロパティ」に表示されています。

表10-14 インスタント・メッセージおよびプレゼンス・サービスの構成プロパティ

構成プロパティ

説明

selected.connection

インスタント・メッセージおよびプレゼンス・サービスによって使用される接続を示します。

rtc.cache.time

インスタント・メッセージおよびプレゼンス・データのキャッシュ・タイムアウトを示します。デフォルトでは60秒です。

resolve.display.name.from.user.profile

ユーザー表示名は、欠落している場合、表示する項目を確定します。0に設定しており、表示名情報が利用不可能な場合、アプリケーション内にユーザー名のみ表示されます。1に設定しており、表示名情報が利用不可能な場合、表示名がユーザー・プロファイル・データから読み込まれます。このオプションを1に設定すると、パフォーマンスに影響があります。デフォルト設定は0です。

表示名は、プレゼンス・データでは、必須ではありません。WebCenter Portalアプリケーションで表示名がデフォルトで提供されないことがあり、なおかつその情報が重要と思われる場合、表示名が常に表示されるように、resolve.display.name.from.user.profileを1に設定します。

im.address.resolver.class

ユーザー名をIMアドレスに、IMアドレスをユーザー名にマップするために使用されるリゾルバの実装。

デフォルト設定は、oracle.webcenter.collab.rtc.IMPAddressResolverImplです。この実装では、次の場所で、指定された順序でIMアドレスが検索されます。

- ユーザー・プリファレンス

- ユーザー資格証明

- ユーザー・プロファイル

im.address.profile.attribute

ユーザーのIMアドレスを決定するために使用されるユーザー・プロファイル属性。デフォルト設定は、BUSINESS_EMAILです。

構文

setIMPServiceProperty(appName, property, value, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

property

構成プロパティの名前を示します。

value

プロパティの値を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、webcenterという名前のアプリケーション内のインスタント・メッセージおよびプレゼンス・データのデフォルト・キャッシュ・タイムアウトを変更します。

wls:/weblogic/serverConfig>setIMPServiceProperty(appName='webcenter',
property='rtc.cache.time', value='30')

removeIMPServiceProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

インスタント・メッセージおよびプレゼンス・サービス・プロパティに設定されている現在の値を削除します。このコマンドを使用して、表10-14「インスタント・メッセージおよびプレゼンス・サービスの構成プロパティ」に一覧表示されている任意のプロパティを削除します。

これらのプロパティの値を削除すると予期しない動作を引き起こす可能性があるので、このコマンドを使用するときは注意してください。

注意:

このコマンドの構文を使用して、現在、インスタント・メッセージおよびプレゼンス・サービスによって使用されている接続を無効に設定します。

removeIMPServiceProperty('appName='webcenter', property='selected.connection')

このコマンドを使用すると、default接続引数が0に設定されます。「setIMPConnection」も参照してください。

構文

removeIMPServiceProperty(appName, property, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

property

構成プロパティの名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のアプリケーション内のインスタント・メッセージおよびプレゼンス・サービスのキャッシュ有効期限値をクリアします。

wls:/weblogic/serverConfig> removeIMPServiceProperty(appName='webcenter',
property='rtc.cache.time')

listIMPServiceProperties

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

インスタント・メッセージおよびプレゼンス・サービスの設定可能なプロパティをすべて表示します。

構文

listIMPServiceProperties(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、webcenterという名前のアプリケーションでインスタント・メッセージおよびプレゼンス・サービスの構成プロパティを表示します。

wls:/weblogic/serverConfig> listIMPServiceProperties(appName='webcenter')

createIMPExtAppConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

インスタント・メッセージおよびプレゼンス・サーバー接続に適した外部アプリケーションを作成します。外部アプリケーションは、必須の追加プロパティauthMethod=POST、および追加フィールドfieldName='Account'とdisplaytoUser=1で構成されます。

構文

createIMPExtAppConnection(appName, name, [displayName, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

displayName

オプション。外部アプリケーション表示名を示します。アプリケーションの、WebCenter Portalユーザーにとってわかりやすいユーザー・フレンドリな名前。表示名は、WebCenter Portalアプリケーション内のすべての外部アプリケーション間で一意である必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、インスタント・メッセージおよびプレゼンス・サーバー接続に適したIMPxAppという名前の外部アプリケーションを作成します。

wls:/weblogic/serverConfig> createIMPExtAppConnection(appName='webcenter',
name='IMPxApp', displayName='IMP Ext App')

メール

表10-15に示すコマンドを使用して、WebCenter Portalアプリケーションのメール・サーバー接続を管理します。

複数のメール・サーバー接続を登録できます。

- Spacesアプリケーションでは、複数のメール接続がサポートされています。default=1を使用して構成されたメール接続は、Spacesアプリケーション内のメール・サービスのデフォルト接続です。追加のすべての接続が代理接続として提供されます。スペース・ユーザーはユーザー・プリファレンスを使用して利用する接続を選択できます。

- Frameworkアプリケーションでは、default=1を使用して構成した1つのメール接続のみ使用されます。追加の接続があれば、無視されます。

これらのWebCenter Portal WLSTコマンドを使用して行った構成変更は、WebCenter Portalアプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

表10-15 メールWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

createMailConnection

WebCenter Portalアプリケーションのメール・サーバー接続を作成します。

オンライン

setMailConnection

既存のメール・サーバー接続を編集します。

オンライン

setMailConnectionProperty

メール・サーバー接続プロパティを設定します。

オンライン

deleteMailConnectionProperty

メール・サーバー接続プロパティを削除します。

オンライン

listMailConnections

アプリケーションに対して設定したすべてのメール・サーバー接続プロパティを表示します。

オンライン

listDefaultMailConnection

アプリケーションに対して設定したデフォルト・メール・サーバー接続を表示します。

オンライン

setDefaultMailConnection

指定した接続をデフォルト・メール・サーバー接続として設定します。

オンライン

setMailServiceProperty

メール・サービスのデフォルトを指定します。

オンライン

removeMailServiceProperty

メール・サービスのデフォルトを削除します。

オンライン

listMailServiceProperties

メール・サービス・プロパティを表示します。

オンライン

createMailExtApp

メール接続に適した外部アプリケーションを作成します。

オンライン

createMailConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalアプリケーションのメール・サーバー接続を作成します。

WebCenter Portalアプリケーションでは、Microsoft ExchangeサーバーまたはIMAP4およびSMTPをサポートする任意のメール・サーバーがサポートされています。メール・サーバー接続の重要な属性として、imapHost、imapPort、imapSecured、smtpHost、smtpPortおよびsmtpSecuredがあります。

複数のメール・サーバー接続を登録できます。

- Spacesアプリケーションでは、複数のメール接続がサポートされています。default=1を使用して構成したメール接続は、スペース内のメール・サービスのデフォルト接続です。追加のすべての接続が代理接続として提供されます。スペース・ユーザーはユーザー・プリファレンスを使用して利用する接続を選択できます。

- Frameworkアプリケーションでは、default=1を使用して構成した1つのメール接続のみ使用されます。追加の接続があれば、無視されます。

構文

createMailConnection(appName, name, [imapHost, imapPort, smtpHost, smtpPort,
imapSecured, smtpSecured, appId, timeout, default, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

imapHost

オプション。IMAPサービスが実行しているマシンのホスト名を示します。

imapPort

オプション。IMAPサービスのリスン先ポートを示します。

smtpHost

オプション。SMTPサービスが実行しているマシンのホスト名を示します。

smtpPort

オプション。SMTPサービスのリスン先ポートを示します。

imapSecured

オプション。IMAPサーバーに接続したメール・サーバーでSSLが有効になっているかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

smtpSecured

オプション。SMTPサーバーが保護されているかどうかを指定します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

appId

メール・サーバー接続に関連付けられる外部アプリケーションを示します。

外部アプリケーション資格証明情報を使用して、IMAPおよびSMTPサーバーに対応するユーザーが認証されます。同じ資格証明を指定して、IMAPおよびSMTPサーバーの両方のサーバー上のユーザーが認証されます。

メール・サービスに対して構成する外部アプリケーションでは、authMethod=POSTを使用し、いくつかの追加ログイン・フィールドを指定する必要があります。

fieldName='Email Address'およびdisplaytoUser=1

fieldName='Your Name'およびdisplaytoUser=1

fieldName='Reply-To Address'およびdisplaytoUser=1

外部アプリケーションがまだ存在していない場合、WLSTコマンドcreateMailExtAppを使用して、必要な追加フィールドすべてを自動的に持つ外部アプリケーションを作成します。

「createExtAppConnection」も参照してください。

timeout

オプション。終了する前にをするまでのサービスの待機時間(秒の単位)の長さを示します。この引数のデフォルトは、-1です。-1に設定すると、サービスのデフォルト値(10秒)が適用されます。

default

オプション。この接続は、メール・サービスのデフォルト接続であるかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは、0です。

- Spacesでは、複数のメール接続がサポートされています。default=1を使用して構成されたメール接続は、Spacesアプリケーション内のメール・サービスのデフォルト接続です。default=0で構成した追加の接続が代理接続として提供されます。Spacesユーザーはユーザー・プリファレンスを使用して利用する接続を選択できます。

- Frameworkアプリケーションでは、default=1を使用して構成した1つのメール接続のみ使用されます。追加の接続があれば、無視されます。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、メール・サーバー接続に適した外部アプリケーションを作成し、次に、myMailConnectionという名前のメール・サーバー接続を作成します。

wls:/weblogic/serverConfig> createMailExtApp(appName='webcenter', name='extApp_Mail', displayName='Mail Ext App')
wls:/weblogic/serverConfig> createMailConnection(appName='webcenter' ,
name='myMailConnection' , imapHost='myimaphost.com', imapPort=143 ,
smtpHost='mysmtphost.com' , smtpPort=25 , imapSecured=0, smtpSecured=0,
appId='extApp_Mail', timeout=60, default=1)

setMailConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

既存のメール接続を編集します。このコマンドを使用して、接続の属性を更新します。

createMailConnectionコマンドを使用して、接続が作成されます。

(Spacesアプリケーションのみ。)このコマンドを使用すると、createMailConnectionを使用して設定できない追加および任意のLDAPサーバーの属性を設定できます。LDAP詳細が定義されている場合、メール・サービスによって、Spacesアプリケーション用のspacedistributionリストが作成、編集および削除されます。配信リストは、それらのスペースにちなんで名付けられ(非Java識別子は除く)、ドメインが割り当てられます(@mycompany.comなど、domain属性から導出されます)。LDAPの詳細を提供しない場合、spacedistributionリストは作成も保持もされません。メール・サーバーとしてMicrosoft Exchange Serverを指定する必要があります。

構文

setMailConnection(appName, name, [imapHost, imapPort, smtpHost, smtpPort,
imapSecured, smtpSecured, appId, default, ldapHost, ldapPort, ldapBaseDN,
ldapAdminUser, ldapAdminPassword, ldapSecured, domain, defaultUser, timeout,
server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のメール・サーバー接続の名前を示します。

imapHost

オプション。IMAPサービスが実行しているマシンのホスト名を示します。

imapPort

オプション。IMAPサービスのリスン先ポートを示します。

smtpHost

オプション。SMTPサービスが実行しているマシンのホスト名を示します。

smtpPort

オプション。SMTPサービスのリスン先ポートを示します。

imapSecured

オプション。IMAPサーバーへの接続は、SSLが有効になっているかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

smtpSecured

オプション。SMTPサーバーへの接続は、SSLが有効になっているかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

appId

オプション。メール・サーバー接続に関連付けられる外部アプリケーションを示します。

外部アプリケーション資格証明情報を使用して、IMAPおよびSMTPサーバーに対応するユーザーが認証されます。同じ資格証明を指定して、IMAPおよびSMTPサーバーの両方のサーバー上のユーザーが認証されます。

メール・サービスに対して構成する外部アプリケーションでは、authMethod=POSTを使用し、いくつかの追加ログイン・フィールドを指定する必要があります。

fieldName='Email Address'およびdisplaytoUser=1

fieldName='Your Name'およびdisplaytoUser=1

fieldName='Reply-To Address'およびdisplaytoUser=1

外部アプリケーションがまだ存在していない場合、WLSTコマンドcreateMailExtAppを使用して、必要な追加フィールドすべてを自動的に持つ外部アプリケーションを作成します。

「createExtAppConnection」も参照してください。

ldapHost

オプション。LDAPディレクトリ・サーバーが実行中であるマシンのホスト名を示します。

ldapPort

オプション。LDAPディレクトリ・サーバーのリスン先ポートを示します。

ldapBaseDN

オプション。LDAPスキーマのベースによって識別した名前を示します。例: CN=Users,DC=oracle,DC=com。

ldapAdminUser

オプション。LDAPディレクトリ・サーバー管理者のユーザー名を示します。LDAPスキーマに値を入力する権限を持つ有効な管理者を示します。

ldapAdminPassword

オプション。LDAPディレクトリ・サーバー管理者のパスワードを示します。このパスワードは、保護したストアに保存されます。

ldapSecured

オプション。LDAPサーバーへの接続は、SSLが有効になっているかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。すべてのLDAP通信でSSLを使用するには、これを1に設定します。

domain

オプション。spacedistributionリストに追加したドメイン名。たとえば、ドメイン属性をmycompany.comに設定すると、Finance Projectスペースでは、FinanceProject@oracle.comという名前の配信リストが保持されます。

defaultUser

オプション。管理に関する機能を付与する必要があるユーザーのカンマ区切りのリストを示します。これらのユーザーは、作成されたすべてのspacedistributionリストのメンバーになります。指定したユーザーは、ベースLDAPスキーマ(ldapBaseDN引数に指定した)に存在する必要があります。

timeout

オプション。終了する前にをするまでのサービスの待機時間(秒の単位)の長さを示します。この引数のデフォルトは、-1です。-1に設定すると、サービスのデフォルト値(10秒)が適用されます。

default

オプション。この接続は、メール・サービスのデフォルト(またはアクティブ)接続であるかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。1を設定すると、この接続は、メール・サービスのデフォルト接続であることを示します。

- Spacesでは、複数のメール接続がサポートされています。default=1を使用して構成されたメール接続は、Spacesアプリケーション内のメール・サービスのデフォルト接続です。default=0で構成した追加の接続が代理接続として提供されます。Spacesユーザーはユーザー・プリファレンスを使用して利用する接続を選択できます。

- Frameworkアプリケーションでは、default=1を使用して構成した1つのメール接続のみ使用されます。追加の接続があれば、無視されます。

default値を0から1に変更すると、接続はメール・サービスのデフォルト接続になります。

デフォルト接続を使用しないようにするには、次に示すようにremoveMailServicePropertyコマンドを使用します。

removeMailServiceProperty('appName='webcenter', property='selected.connection')

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、メール・サーバーに接続する個別の属性を設定します。

wls:/weblogic/serverConfig>setMailConnection(appName='webcenter',
name='myMailConnection', imapHost='myimaphost.com', imapPort=143,
smtpHost='mysmtphost.com' , smtpPort=25 , imapSecured=0, smtpSecured=0,
appId='extApp_Mail', timeout=60, default=1)

次の例は、メール・サーバーに接続する個別の属性を設定します。

wls:/weblogic/serverConfig>setMailConnection(appName='webcenter',
name='myMailConnection', imapPort=993, imapSecured=1, smtpPort=465 ,
smtpSecured=1)

次の例は、メール・サーバーに接続するLDAPの属性を設定します。

wls:/weblogic/serverConfig>setMailConnection(appName='webcenter',
name='myMailConnection', domain='ORACLE.COM', defaultUser='admin',
imapHost='myimaphost.com', imapPort=143, smtpHost='mysmtphost.com',
imapSecured=0, smtpSecured=0, smtpPort=25, appId='extApp_Mail',
default=1, ldapHost='myldaphost.com', ldapPort=389,
ldapBaseDN='CN=Users,DC=exchange,DC=uk,DC=com', ldapAdminUser='administrator',
ldapAdminPassword='adminpswd', ldapSecured=0, timeout=60)

setMailConnectionProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

メール・サーバー接続プロパティを設定します。使用しているメール・サーバーに接続するために追加のパラメータを使用する必要がある場合、このコマンドを使用します。これは、キーおよび値を使用して任意の接続プロパティを追加する拡張可能な方法です。(createMailConnectionおよびsetMailConnectionに指定した接続プロパティを必ず使用しなければならないというわけではありません。)

既知および追加のすべての接続プロパティが表10-16 「メールに接続する追加のプロパティ」に指定されています。

表10-16 メールに接続する追加のプロパティ

追加の接続プロパティ

説明

charset

接続のために使用される文字セットを示します。

デフォルト文字セットはUTF-8です。ISO-8859-1など、別の文字セットを使用するには、charset接続プロパティを設定します。

様々なIMAPプロパティ

任意の有効なIMAP接続プロパティ例: mail.imap.connectionpoolsize。

有効なIMAPプロパティに関する情報は、http://www.oracle.com/technetwork/java/javamail/index-141777.htmlで入手できます。

様々なSMTPプロパティ

任意の有効なSMTP接続プロパティ例: mail.smtp.timeout。

有効なSMTPプロパティに関する情報は、http://www.oracle.com/technetwork/java/javamail/index-141777.htmlで入手できます。

注意:

setMailConnectionPropertyを使用して、createMailConnectionまたはsetMailConnectionで利用可能な接続プロパティを設定しないでください。それを試みても、効果はありません。

構文

setMailConnectionProperty(appName, name, key, value, [secure], [server],
[applicationVersion])

引数

定義

appName

この操作を実行するWebCenterアプリケーションの名前。

name

既存のメール・サーバー接続の名前を示します。

key

接続プロパティの名前を示します。

value

プロパティの値を示します。キーおよび値を持つ接続上の任意のプロパティを変更できます。

secure

オプション。暗号化を使用してプロパティの値を安全に格納するかどうかを示します。有効なオプションは、1 (true)および0 (false)です。1の場合、値が暗号化されます。デフォルト・オプションは0です。

server

オプション。WebCenterアプリケーションがデプロイされている管理対象サーバーの名前を示します。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。この引数は、WebCenterアプリケーションの1つまたは複数のバージョンがデプロイされている場合に必要になります。

例

次の例は、デフォルト値propertyValue1でmyProperty1というカスタム・メール・サーバー接続プロパティを追加します。

wls:/weblogic/serverConfig> setMailConnectionProperty(appName='webcenter',
name='myMailServer', key='myProperty1', value='propertyValue1')

deleteMailConnectionProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

メール・サーバー接続プロパティを削除します。接続プロパティを削除した結果、設定が無効になる場合、希望したとおりに接続されない可能性があるので、接続プロパティを削除するときに注意してください。

このコマンドを使用すると、setMailConnectionPropertyコマンドを使用して追加したadditional接続プロパティのみ削除できます。

構文

deleteMailConnectionProperty(appName, name, key, [server],
[applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のメール・サーバー接続の名前を示します。

key

削除する接続プロパティの名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、mailProperty1という名前のメール・サーバー接続プロパティを削除します。

wls:/weblogic/serverConfig> deleteMailConnectionProperty(appName='webcenter',
name='myMailServer', key='mailProperty1')

listMailConnections

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションに対して構成されているすべてのメール・サーバー接続を一覧表示します。

構文

listMailConnection(appName, [verbose, name, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

verbose

オプション。メール・サーバー接続の詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listMailConnectionsによって、WebCenter Portalアプリケーションに対して構成されているすべてのメール・サーバー接続およびその詳細が表示されます。0に設定すると、接続名のみが一覧表示されます。この引数のデフォルトは、0です。

name

オプション。既存のメール・サーバー接続の名前を示します。この引数を使用して、特定のメール・サーバーの接続に関する詳細情報を表示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、現在、webcenterという名前のアプリケーションに対して設定したメール・サーバーのすべての接続の名前を表示します。

wls:/weblogic/serverConfig> listMailConnections(appName='webcenter')

次の例は、現在、webcenterという名前のアプリケーションに対して設定したメール・サーバーのすべての接続の名前とその詳細情報を表示します。

wls:/weblogic/serverConfig> listMailConnections(appName='webcenter', verbose=1)

この例は、mailConnection1という名前のメール・サーバー接続の詳細情報を表示します。

wls:/weblogic/serverConfig> listMailConnections(appName='webcenter', name='mailConnection1')

listDefaultMailConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションでメール・サービスによって使用されているデフォルト・メール・サーバー接続を一覧表示します。

複数メール・サーバーを登録できますが、デフォルト接続は、1つのみ存在します。

- Spacesアプリケーションでは、複数のメール接続がサポートされています。default=1を使用して構成されたメール接続は、Spacesアプリケーション内のメール・サービスのデフォルト接続です。追加のすべての接続が代理接続として提供されます。Spacesユーザーはユーザー・プリファレンスを使用して利用する接続を選択できます。

- Frameworkアプリケーションでは、default=1を使用して構成した1つのメール接続のみ使用されます。追加の接続があれば、無視されます。

構文

listDefaultMailConnection(appName,[verbose], [server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

verbose

オプション。利用可能であれば、デフォルト・メール・サーバー接続が冗長モードで表示されます。有効なオプションは、1 (true)および0 (false)です。1に設定すると、メール・サーバー接続の名前および詳細が一覧表示されます。0に設定すると、接続の名前のみ表示されます。この引数のデフォルトは、0です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、webcenterという名前のアプリケーションでメール・サービスによって使用される接続の名前およびその詳細情報を表示します。

wls:/weblogic/serverConfig> listDefaultMailConnection(appName='webcenter', verbose=1)

setDefaultMailConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションにおけるメール・サービスのデフォルトメール・サーバー接続を指定します。

複数メール・サーバーを登録できますが、デフォルト接続は、1つのみ存在します。

- Spacesアプリケーションでは、複数のメール接続がサポートされています。default=1を使用して構成されたメール接続は、Spacesアプリケーション内のメール・サービスのデフォルト接続です。追加のすべての接続が代理接続として提供されます。Spacesユーザーはユーザー・プリファレンスを使用して利用する接続を選択できます。

- Frameworkアプリケーションでは、default=1を使用して構成した1つのメール接続のみ使用されます。追加の接続があれば、無視されます。

構文

setDefaultMailConnection(appName, name, [server], [applicationVersion])

引数

説明

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のメール接続の名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、myMailServerという名前の接続を使用するためのメール・サービスを設定します。

wls:/weblogic/serverConfig>setDefaultMailConnection(appName='webcenter', name='myMailServer')

setMailServiceProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

メール・サービスのデフォルト値を指定します。

メール・サービスの設定可能なプロパティは、表10-17 「メール・サービスの構成プロパティ」に表示されています。

表10-17 メール・サービスの構成プロパティ

構成プロパティ

説明

address.delimiter

複数のメール・アドレスを区切るために使用するデミリタを定義します。デフォルトではカンマを使用します。

いくつかのメール・サーバーでは、lastname, firstnameの形式のメール・アドレスを必要とします。その場合、セミコロンが必要です。

mail.emailgateway.polling.frequency

新しい受信電子メールについて、spacedistributionリストを確認する頻度(秒単位)。デフォルトは、1800秒(30分)です。

spacedistributionリストによる電子メール通信は、ディスカッション・サーバー上でディスカッション・フォーラム投稿として公開できます。詳細は、Oracle Fusion Middleware Oracle WebCenterユーザーズ・ガイドのディスカッション・フォーラムにおけるスペース・メールの公開に関する項を参照してください。

mail.messages.fetch.size

メールの受信トレーに表示されるメッセージの最大数を示します。

resolve.email.address.to.name

LDAPが構成されている場合に、ユーザー電子メール・アドレスがWebCenter Portalユーザー名に解決されるかどうかを決定します。有効な値は、1 (true)および0 (false)です。デフォルト値は0です。

1に設定すると、メール・タスク・フローに電子メール・アドレスのかわりにWebCenter Portalユーザー名が表示されます。

メール・サービスが電子メール・アドレスを提供するときにプレゼンス情報を取得できないため、インスタント・メッセージおよびプレゼンス・サービスがプレゼンス・ステータスを取得するためにユーザー名を必要とする場合は、このプロパティを1に設定します。この値を1に設定すると、アプリケーションのパフォーマンスに影響与えます。したがって、このプロパティを設定する場合はそれを考慮する必要があります。

構文

setMailServiceProperty(appName, property, value, [server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

property

構成プロパティの名前を示します

value

プロパティの値を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、webcenterという名前のアプリケーションでメールの受信トレーに表示されるメッセージのデフォルト数を100個に増加します。

wls:/weblogic/serverConfig>setMailServiceProperty(appName='webcenter',
property='mail.messages.fetch.size', value='100')

removeMailServiceProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

メール・サービス・プロパティに設定されている現在の値を削除します。このコマンドを使用して、表10-17「メール・サービスの構成プロパティ」に一覧表示されている任意のプロパティを削除します。

これらのプロパティの値を削除すると予期しない動作を引き起こす可能性があるので、このコマンドを使用するときは注意してください。

注意:

このコマンド構文を使用すると、メール・サービスで現在のデフォルト接続を使用することができなくなります。

removeMailServiceProperty('appName='webcenter', property='selected.connection')

このコマンドを使用すると、default接続引数が0に設定されます。「setMailConnection」も参照してください。

構文

removeMailServiceProperty(appName, property, [server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

property

構成プロパティの名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、webcenterという名前のアプリケーションでメール・サービスの現在のmail.messages.fetch.sizeプロパティをクリアします。

wls:/weblogic/serverConfig>removeMailServiceProperty(appName='webcenter', property='mail.messages.fetch.size')

listMailServiceProperties

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

メール・サービスのすべての設定可能なプロパティを表示します。

構文

listMailServiceProperties(appName, [server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、webcenterという名前のアプリケーションでメール・サービスの構成プロパティを表示します。

wls:/weblogic/serverConfig>listMailServiceProperties(appName='webcenter')

createMailExtApp

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

メール・サーバー接続に適した外部アプリケーションを作成します。外部アプリケーションは、必須の追加プロパティauthMethod=POSTおよび次のいくつかの追加ログイン・フィールドで構成されます。

fieldName='Email Address'およびdisplaytoUser=1

fieldName='Your Name'およびdisplaytoUser=1

fieldName='Reply-To Address'およびdisplaytoUser=1

構文

createMailExtAppConnection(appName, name, [displayName, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

displayName

オプション。外部アプリケーション表示名を示します。アプリケーションの、WebCenter Portalユーザーにとってわかりやすいユーザー・フレンドリな名前。表示名は、WebCenter Portalアプリケーション内のすべての外部アプリケーション間で一意である必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、メール・サーバー接続に適したMailxAppという名前の外部アプリケーションを作成します。

wls:/weblogic/serverConfig> createMailExtAppConnection(appName='webcenter', name='MailxApp', displayName='Mail Ext App')

通知

表10-18に示すコマンドを使用して、WebCenter Portalアプリケーションにおける通知サービスの設定を管理します。

これらのWebCenter Portal WLSTコマンドを使用して行った構成変更は、WebCenter Portalアプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

表10-18 通知WLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

setNotificationsConfig

WebCenter Portalアプリケーションで発生した通知のルーティングに使用する接続を指定します。

オンライン

getNotificationsConfig

WebCenter Portalアプリケーションで発生した通知の送信に使用する接続に関する詳細を返します。

オンライン

setNotificationsConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalアプリケーションで発生した通知のルーティングに使用する接続を指定します。

既存のメール・サーバーまたはBPELサーバー接続を使用します。WebCenter PortalアプリケーションをBPELサーバーに接続している場合は、メール、ワークリスト、SMSなど複数メッセージング・チャネルを通じた通知のルーティングにOracle User Messaging Service (UMS)を使用できます。通知サービスでBPELサーバー接続を使用するように構成すると、使用可能な各メッセージング・チャネルに対して送信者の'From'アドレスを指定できます。つまり、送信者メール・アドレスとSMSアドレスを指定できます。

または、メール・サーバーを介して通知メッセージをルーティングすることもできます。通知サービスがメール・サーバー接続を使用するように構成する場合、メール・サーバー接続に関連付けられている外部アプリケーションに共有資格証明が含まれている必要があります。共有資格証明は、アプリケーション全体の通知をルーティングするために必要です。

構文

setNotificationsConfig(appName, type, name, [senderMailAddress, senderSMSAddress, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

type

通知の送信に使用する接続のタイプ。有効な値は、MAILおよびBPELです。

name

既存の接続の名前。

次の点を考慮してください。

- メール・サーバー接続 - メール・サーバー接続に関連付けられている外部アプリケーションに共有資格証明が含まれている必要があります。

- BPELサーバー接続 - Oracle User Messaging Service (UMS)がBPELサーバー上で使用可能である必要があります。

senderMailAddress

オプション。すべてのメール通知の送信元となるメール・アドレス。

次の形式を使用します。

<email_alias><<email_address>>または<email address>。

たとえば、WebCenter Notification<notifications@webcenter.com>またはnotifications@webcenter.comです。

この引数は、BPELサーバーを介してルーティングされる通知に適用されます。BPELサーバーが使用されており、UMSが複数の電子メール・ドライバで構成されている場合は、このアドレスは適切な電子メール・ドライバを識別するためにも使用されます。

メール・サーバーが使用される場合、送信者アドレスは、関連付けられている外部アプリケーションの共有資格証明に対して指定されているものと同じユーザーです。

senderSMSAddress

オプション。すべてのSMS通知の送信元となるSMS番号。

通常、SMSアドレスの形式は、4-6桁の数字(-、空白または他の文字を含まない)です。(28734など)。

この引数は、BPELサーバーを介してルーティングされる通知に適用されます。BPELサーバーが使用されており、UMSが複数のSMSドライバで構成されている場合は、このアドレスは適切なSMSドライバを識別するためにも使用されます。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、通知サービスでWebCenter-Worklistという名前のBPELサーバー接続が使用されることを指定し、さらにすべての通知の送信元となるメール・アドレスおよびSMSアドレスを定義します。

wls:/weblogic/serverConfig>setNotificationsConfig(appName='webcenter', type='BPEL',
name='WebCenter-Worklist', senderMailAddress='WebCenter Notification<notifications@webcenter.com',
senderSMSAddress='28734')

getNotificationsConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalアプリケーションで発生した通知の送信に使用する接続に関する詳細を返します。

構文

getNotificationsConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Spacesアプリケーションで通知サービスによって使用される接続に関する詳細を返します。

wls:/weblogic/serverConfig>getNotificationsConfig(appName='webcenter')

ConnectionType:    BPEL
ConnectionName:    WebCenter-Worklist
SenderMailAddress: notifications@webcenter.com
SenderSMSAddress:  28776

個人イベント

表10-19に示すコマンドを使用して、WebCenter Portalアプリケーションの個人イベント・サーバー接続を管理します。

これらのWebCenter Portal WLSTコマンドを使用して行った構成変更は、WebCenter Portalアプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

表10-19 個人イベントWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

createPersonalEventConnection

指定したWebCenter Portalアプリケーションの個人イベント・サーバー接続を作成します。

オンライン

setPersonalEventConnection

既存の個人イベント・サーバー接続を編集します。

オンライン

listPersonalEventConnections

指定したWebCenter Portalアプリケーションに対して構成されているすべての個人イベント・サーバー接続を一覧表示します

オンライン

createPersonalEventConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションの個人イベント・サーバー接続を作成します。

個人イベント・サービスは、Microsoft Exchange Server 2003およびMicrosoft Exchange Server 2007への接続をサポートしています。1つのWebCenter Portalアプリケーションに対して複数の個人イベント接続を登録できますが、個人イベント・サービスに対して使用される接続は、デフォルト(またはアクティブ)接続の1つのみです。

構文

createPersonalEventConnection(appName, name, webServiceUrl, adapterName, appId, [default, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

webServiceUrl

イベント・アプリケーションを公開するWebサービスのURL。

<protocol>://<host>:<port>/<appWebServiceInterface>/<WSName>の形式を使用します。

adapterName

個人イベント・サーバーに一致するアダプタを指定します。有効な値は、MSEx2003およびMSEx2007です。Microsoft Exchange Server 2003の場合はMSEx2003を、Microsoft Exchange Server 2007の場合はMSEx2007を選択します。

各アダプタは、認証およびデータ交換のための独自のメカニズムを備えています

appId

個人イベント・サービスを提供するMicrosoft Exchange Serverに関連付けられている外部アプリケーション。指定した場合、Microsoft Exchange Serverに対してユーザーの認証を行うために外部アプリケーション資格証明情報が使用されます。

default

オプション。この接続が、個人イベント・サービスのデフォルト接続であるかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

個人イベント・サービスでこの接続を使用することを指定するには、値を1に設定します。

1つのWebCenterアプリケーションに対して複数の接続を登録できますが、個人イベント・サービスに対して使用される接続は1つのみであり、デフォルト(またはアクティブ)接続が使用されます。

server

オプション。WebCenterアプリケーションがデプロイされている管理対象サーバーの名前を示します。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。この引数は、WebCenterアプリケーションの1つまたは複数のバージョンがデプロイされている場合に必要になります。

例

次の例では、Spacesアプリケーション(appName='webcenter')に対してMyPEConnectionという名前の接続を作成します。この接続は、Microsoft Exchange Server 2007を指し、個人イベント・サービスのデフォルト接続として指定されています。

wls:/weblogic/serverConfig>createPersonalEventConnection(appName='webcenter',
name='MyPEConnection', webServiceUrl='http://myexchange.com/EWS/Services.wsdl',
adapterName='MSEx2007', appId='ExtPEApp', default=1)

次の例では、Spacesアプリケーションに対してMyPEConnectionという名前の接続を作成します。この接続は、Microsoft Exchange Server 2003を指します。

wls:/weblogic/serverConfig>createPersonalEventConnection(appName='webcenter',
name='MyPEConnection',webServiceUrl='http://myexchange.com/ExchangeWS/PersonalEventsWebService.asmx', adapterName='MSEx2003',  appId='ExtPEApp')

setPersonalEventConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションの個人イベント・サーバー接続を編集します。

構文

setPersonalEventConnection(appName, name, [webServiceUrl, adapterName, appId, default, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

name

既存の個人イベント・サーバー接続の名前。

webServiceUrl

オプション。イベント・アプリケーションを公開するWebサービスのURL。

<protocol>://<host>:<port>/<appWebServiceInterface>/<WSName>の形式を使用します。

adapterName

オプション。個人イベント・サーバーに一致するアダプタを指定します。有効な値は、MSEx2003およびMSEx2007です。Microsoft Exchange Server 2003の場合はMSEx2003を、Microsoft Exchange Server 2007の場合はMSEx2007を選択します。

各アダプタは、認証およびデータ交換のための独自のメカニズムを備えています

appId

オプション。個人イベント・サービスを提供するMicrosoft Exchange Serverに関連付けられている外部アプリケーション。指定した場合、Microsoft Exchange Serverに対してユーザーの認証を行うために外部アプリケーション資格証明情報が使用されます。

default

オプション。この接続が、個人イベント・サービスのデフォルト接続であるかどうかを示します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

個人イベント・サービスでこの接続を使用することを指定するには、値を1に設定します。

1つのWebCenter Portalアプリケーションに対して複数の接続を登録できますが、個人イベント・サービスに対して使用される接続は1つのみであり、デフォルト(またはアクティブ)接続が使用されます。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MyPEConnectionという名前の接続のWebサービスURLを更新します。

wls:/weblogic/serverConfig>setPersonalEventConnection(appName='webcenter', name='MyPEConnection', webServiceUrl='http://myexchange.com/EWS/Services.wsdl')

次の例では、MyPEConnectionという名前の接続を、Spacesアプリケーションの個人イベント・サービスのデフォルト接続にします。

wls:/weblogic/serverConfig>setPersonalEventConnection(appName='webcenter', name='MyPEConnection', default=1)

listPersonalEventConnections

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションに対して構成されているすべての個人イベント・サーバー接続を一覧表示します。

構文

listPersonalEventConnections(appName, [verbose, name, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

verbose

オプション。冗長モードの個人イベント・サービスの接続詳細を表示します。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listPersonalEventConnectionsによって、WebCenter Portalアプリケーションに対して構成されているすべての個人イベント・サーバー接続およびそれらの詳細が一覧表示されます。0に設定すると、接続名のみが一覧表示されます。この引数のデフォルトは、0です。

0に設定した場合、name引数を指定しないでください。

name

オプション。既存の個人イベント接続の名前。この引数を使用して、特定の個人イベント・サーバーに関する接続詳細を表示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Spacesアプリケーションに対して現在構成されているすべての個人イベント・サーバー接続の接続名および詳細を表示します。

wls:/weblogic/serverConfig>listPersonalEventConnections(appName='webcenter', verbose=1)

次の例では、MyPEConnectionという名前の個人イベント・サーバー接続の接続詳細を表示します。

wls:/weblogic/serverConfig>listPersonalEventConnections(appName='webcenter', verbose=1, name='MyPEConnection')

パーソナライズ

表10-20に示すコマンドを使用して、WebCenter Portalアプリケーションのパーソナライズ接続を管理します。

これらのWebCenter Portal WLSTコマンドを使用して行った構成変更は、WebCenter Portalのパーソナライズ・サービスがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

表10-20 パーソナライズWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

createWCPSCMISConnection

WebCenter Portalのパーソナライズ・サービスのCMIS接続を作成します。

オンライン

createWCPSActivityGraphConnection

WebCenter Portalのパーソナライズ・サービスのアクティビティ・グラフ接続を作成します。

オンライン

createWCPSPeopleConnection

WebCenter Portalのパーソナライズ・サービスのピープル・コネクションを作成します。

オンライン

createWCPSCustomConnection

WebCenter Portalのパーソナライズ・サービスのカスタム接続を作成します。

オンライン

setWCPSConnectionProperty

WebCenter Portalのパーソナライズ・サービスの既存の接続のプロパティを変更します。

オンライン

listWCPSCMISConnection

WebCenter Portalのパーソナライズ・サービス用に構成されているCMIS接続を一覧表示します。

オンライン

listWCPSActivityGraphConnection

WebCenter Portalのパーソナライズ・サービス用に構成されているアクティビティ・グラフ接続を一覧表示します。

オンライン

listWCPSPeopleConnection

WebCenter Portalのパーソナライズ・サービス用に構成されているピープル・コネクションを一覧表示します。

オンライン

listWCPSCustomConnection

WebCenter Portalのパーソナライズ・サービス用に構成されているカスタム接続を一覧表示します。

オンライン

deleteWCPSCMISConnection

WebCenter Portalのパーソナライズ・サービスのCMIS接続を作成します。

オンライン

deleteWCPSActivityGraphConnection

WebCenter Portalのパーソナライズ・サービスのアクティビティ・グラフ接続を作成します。

オンライン

deleteWCPSPeopleConnection

WebCenter Portalのパーソナライズ・サービスのピープル・コネクションを作成します。

オンライン

deleteWCPSCustomConnection

WebCenter Portalのパーソナライズ・サービスのカスタム接続を作成します。

オンライン

createWCPSCMISConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

パーソナライズ・サービスのCMIS (Content Management Interoperability Service)接続を作成します。

構文

createWCPSCMISConnection(name, repositoryId, host, port, [scheme, namespace,
isDefault, path, pathPrepend, servletPathPart, rewriteUrls, pathTrim,
timeoutInMillisecs, propagateTimeoutExceptions, server])

引数

定義

name

接続の名前を示します。名前は、ネームスペース内でこの接続タイプに対して一意である必要があります。

repositoryId

CMISリポジトリID。

通常は、Oracle WebCenter Contentリポジトリ接続の名前です。

host

CMIS RESTサービスをホストしているサーバーのホスト名。

通常は、WC_Spaces管理対象サーバーのマシン名です。

port

CMIS RESTサービスをホストしているサーバーのポート。

通常は、WC_Spaces管理対象サーバーのポート番号です。

scheme

オプション。CMIS RESTサービスにアクセスするためのHTTPスキーム。有効なオプションは、httpおよびhttpsです。デフォルトはhttpです。

namespace

オプション。その接続用のWebCenter Portalのパーソナライズ接続ネームスペース。指定しないかnoneに設定した場合、その接続はすべてのネームスペースで使用可能になります。

isDefault

オプション。この接続がデフォルトCMIS接続であるかどうかを示します。有効な値は、1 (true)または0 (false)です。デフォルトは0です。

path

オプション。CMISサービスのURLパス。デフォルトは、/api/cmis/repository/<repositoryId>です。

pathPrepend

オプション。servletPathPartおよびpathの先頭に追加するベースCMISサービスのURLパス。デフォルトは/restです。

servletPathPart

オプション。CMISサービスのURLパスのサーブレット・セクション。

rewriteUrls

オプション。CMIS RESTサービスから返されるURLを書き換える方法を指定します。有効なオプションは、producer、consumerおよびnoneです。デフォルトはnoneです。

詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』のWebCenter Portalのパーソナライズの管理に関する項を参照してください。

pathTrim

オプション。CMIS RESTサービスから返されるURLからトリミングするパス部分を指定します。デフォルトはNoneです。

詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』のWebCenter Portalのパーソナライズの管理に関する項を参照してください。

timeoutInMillisecs

オプション。CMISコールからの戻りを待機するタイムアウト(ミリ秒)(文字列)、またはNone(タイムアウトなしの場合)。デフォルトはNoneです。

propagateTimeoutExceptions

オプション。有効な値は、1 (true)および0 (false)です。1に設定した場合、CMISコールのタイムアウトで例外が発生します。0に設定すると、例外は発生しません。

server

オプション。WebCenter Portalのパーソナライズ・サービスをホストする管理対象サーバーの名前。

このパラメータは、デフォルト以外のデプロイメント構成の場合にのみ必要です。WC_Utilitiesサーバーがパーソナライズ・サービスをホストするデフォルトのデプロイメントの場合、値は必要ありません。

例

次の例では、CMIS接続を作成します。

wls:/weblogic/serverConfig>createWCPSCMISConnection(name='Repos1CMISConnection',
repositoryId='ucm11g-server', host='myhost.com', port=8888, scheme='http', isDefault=1)

createWCPSActivityGraphConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

パーソナライズ・サービス用のアクティビティ・グラフ接続を作成します。

構文

createWCPSActivityGraphConnection(name, host, port, [scheme], [namespace],  [isDefault], [restResourceIndex], [rewriteUrls], [pathTrim], [server])

引数

定義

name

接続の名前を示します。ネームスペース内でこの接続タイプに対して一意である必要があります。

host

アクティビティ・グラフRESTサービスをホストしているサーバーのホスト名。

通常は、WC_Spaces管理対象サーバーのマシン名です。

port

アクティビティ・グラフ・サービスをホストしているサーバーのポート。

通常は、WC_Spaces管理対象サーバーのポート番号です。

scheme

オプション。アクティビティ・グラフ・サービスにアクセスするためのHTTPスキーム。有効なオプションは、httpおよびhttpsです。デフォルトはhttpです。

namespace

オプション。その接続用のWebCenter Portalのパーソナライズ接続ネームスペース。指定しないかnoneに設定した場合、その接続はすべてのネームスペースで使用可能になります。

isDefault

オプション。この接続がデフォルト・アクティビティ・グラフ接続であるかどうかを示します。有効な値は、1 (true)または0 (false)です。デフォルトは0です。

restResourceIndex

オプション。RESTサーバーのresourceIndexのURLパス。デフォルトは/rest/api/resourceIndexです。

rewriteUrls

オプション。アクティビティ・グラフRESTサービスから返されるURLを書き換える方法を指定します。有効なオプションは、producer、consumerおよびnoneです。デフォルトはnoneです。

詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』のWebCenter Portalのパーソナライズの管理に関する項を参照してください。

pathTrim

オプション。アクティビティ・グラフRESTサービスから返されるURLからトリミングするパス部分を指定します。デフォルトはNoneです。

詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』のWebCenter Portalのパーソナライズの管理に関する項を参照してください。

server

オプション。WebCenter Portalのパーソナライズ・サービスをホストする管理対象サーバーの名前。

このパラメータは、デフォルト以外のデプロイメント構成の場合にのみ必要です。WC_Utilitiesサーバーがパーソナライズ・サービスをホストするデフォルトのデプロイメントの場合、値は必要ありません。

例

次の例では、特定のネームスペースにアクティビティ・グラフ接続を作成します。

wls:/weblogic/serverConfig> createWCPSActivityGraphConnection(name='AGConnection', host='myhost.com', port=8888, namespace='myNamespace')

createWCPSPeopleConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

パーソナライズ・サービスのピープル・コネクションを作成します。

構文

createWCPSPeopleConnection(name, host, port, [scheme], [namespace],  [isDefault], [restResourceIndex], [rewriteUrls], [pathTrim], [server])

引数

定義

name

接続の名前を示します。ネームスペース内でこの接続タイプに対して一意である必要があります。

host

ピープル・コネクションRESTサービスをホストしているサーバーのホスト名。

通常は、WC_Spaces管理対象サーバーのマシン名です。

port

ピープル・コネクション・サービスをホストしているサーバーのポート。

通常は、WC_Spaces管理対象サーバーのポート番号です。

scheme

オプション。ピープル・コネクション・サービスにアクセスするためのHTTPスキーム。有効なオプションは、httpおよびhttpsです。デフォルトはhttpです。

namespace

オプション。その接続用のWebCenter Portalのパーソナライズ接続ネームスペース。指定しないかnoneに設定した場合、その接続はすべてのネームスペースで使用可能になります。

isDefault

オプション。この接続がデフォルト・ピープル・コネクションであるかどうかを示します。有効な値は、1 (true)または0 (false)です。デフォルトは0です。

restResourceIndex

オプション。RESTサーバーのresourceIndexのURLパス。デフォルトは/rest/api/resourceIndexです。

rewriteUrls

オプション。ピープル・コネクションRESTサービスから返されるURLを書き換える方法を指定します。有効なオプションは、producer、consumerおよびnoneです。デフォルトはnoneです。

詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』のWebCenter Portalのパーソナライズの管理に関する項を参照してください。

pathTrim

オプション。ピープル・コネクション・サービスから返されるURLからトリミングするパス部分を指定します。デフォルトはNoneです。

詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』のWebCenter Portalのパーソナライズの管理に関する項を参照してください。

server

オプション。WebCenter Portalのパーソナライズ・サービスをホストする管理対象サーバーの名前。

このパラメータは、デフォルト以外のデプロイメント構成の場合にのみ必要です。WC_Utilitiesサーバーがパーソナライズ・サービスをホストするデフォルトのデプロイメントの場合、値は必要ありません。

例

次の例では、デフォルト・ネームスペースにピープル・コネクションを作成します。

wls:/weblogic/serverConfig> createWCPSPeopleConnection(name='PeopleConnection', host='myhost.com', port=8888)

createWCPSCustomConnection

WLSTでの使用: オンライン

説明

パーソナライズ・サービスの特定のタイプの接続を作成します。

カスタム接続タイプは、カスタム・データ・プロバイダおよびプロパティ・ロケータとともに使用されます。

構文

createWCPSCustomConnection(name, type, [namespace], [properties], [server])

引数

定義

name

接続の名前を示します。ネームスペース内でこの接続タイプに対して一意である必要があります。

type

カスタム・データ・プロバイダまたはプロパティ・ロケータ実装に固有のカスタム接続タイプ。

namespace

オプション。その接続用のWebCenter Portalのパーソナライズ接続ネームスペース。指定しないかnoneに設定した場合、その接続はすべてのネームスペースで使用可能になります。

properties

オプション。接続プロパティおよび値のディクショナリ。

プロパティのセットは、接続タイプに固有です。ディクショナリ内の値はすべて文字列である必要があります。

server

オプション。WebCenter Portalのパーソナライズ・サービスをホストする管理対象サーバーの名前。

このパラメータは、デフォルト以外のデプロイメント構成の場合にのみ必要です。WC_Utilitiesサーバーがパーソナライズ・サービスをホストするデフォルトのデプロイメントの場合、値は必要ありません。

例

次の例では、特定のネームスペースにアクティビティ・グラフ接続を作成します。

wls:/weblogic/serverConfig> createWCPSCustomConnection(name='CustomConnection', type='my.connection.type', properties={ 'prop1': 'value1', 'prop2', value2' })

listWCPSCMISConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

パーソナライズ・サービス用に構成されているすべてのCMIS (Content Management Interoperability Service)接続を一覧表示するか、単一の接続を一覧表示します。

構文

listWCPSCMISConnections([server], [verbose], [name], [namespace])

引数

定義

server

オプション。WebCenter Portalのパーソナライズ・サービスをホストする管理対象サーバーの名前。

このパラメータは、デフォルト以外のデプロイメント構成の場合にのみ必要です。WC_Utilitiesサーバーがパーソナライズ・サービスをホストするデフォルトのデプロイメントの場合、値は必要ありません。

verbose

オプション。詳細出力または簡易出力を制御します。有効なオプションは、1および0です。1に設定すると、このコマンドによってCMIS接続およびそれらのプロパティが一覧表示されます。0に設定すると、このコマンドによって接続名のみ一覧表示されます。デフォルトは1です。

name

オプション。既存の接続の名前。指定しないかNoneに設定した場合、すべての接続が一覧表示されます。

namespace

オプション。一覧表示する接続用のWebCenter Portalのパーソナライズ接続ネームスペース。指定しないかnoneに設定した場合、このコマンドによって、すべてのネームスペースで使用できるように構成された接続が一覧表示されます。

例

次の例では、すべてのCMIS接続の名前を一覧表示します。

wls:/weblogic/serverConfig> listWCPSCMISConnections(verbose=0)

Repos1CMISConnection
Repos2CMISConnection

次の例では、1つのCMIS接続の詳細を一覧表示します。

wls:/weblogic/serverConfig> listWCPSCMISConnections(name='Repos1CMISConnection')

----------------------
Repos1CMISConnection (type=cmis.provider.connection, namespace=*)
----------------------
host: myhost.com
isDefault: false
path: /api/cmis/repository/repo1
pathPrepend: /rest
port: 8888
repositoryId: ucm11g-server
rewriteUrls: none
scheme: http

listWCPSActivityGraphConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

パーソナライズ・サービス用に構成されているすべてのアクティビティ・グラフ接続を一覧表示するか、単一の接続を一覧表示します。

構文

listWCPSActivityGraphConnections([server], [verbose], [name], [namespace])

引数

定義

server

オプション。WebCenter Portalのパーソナライズ・サービスをホストする管理対象サーバーの名前。

このパラメータは、デフォルト以外のデプロイメント構成の場合にのみ必要です。WC_Utilitiesサーバーがパーソナライズ・サービスをホストするデフォルトのデプロイメントの場合、値は必要ありません。

verbose

オプション。詳細出力または簡易出力を制御します。有効なオプションは、1および0です。1に設定すると、このコマンドによってアクティビティ・グラフ接続およびそれらのプロパティが一覧表示されます。0に設定すると、このコマンドによって接続名のみ一覧表示されます。デフォルトは1です。

name

オプション。既存の接続の名前。指定しないかNoneに設定した場合、すべての接続が一覧表示されます。

namespace

オプション。一覧表示する接続用のWebCenter Portalのパーソナライズ接続ネームスペース。指定しないかnoneに設定した場合、このコマンドによって、すべてのネームスペースで使用できるように構成された接続が一覧表示されます。

例

次の例では、すべてのアクティビティ・グラフ接続の名前を一覧表示します。

wls:/weblogic/serverConfig> listWCPSActivityGraphConnections(verbose=0)

AG1Connection
AG2Connection

次の例では、1つのアクティビティ・グラフ接続の詳細を一覧表示します。

wls:/weblogic/serverConfig> listWCPSActivityGraphConnections(name='AG1Connection')

----------------------
AG1Connection (type=activity.provider.connection, namespace=*)
----------------------
host: myhost.com
isDefault: false
port: 8888
restResourceIndex: /rest/api/resourceIndex
rewriteUrls: producer
scheme: http

listWCPSPeopleConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

パーソナライズ・サービス用に構成されているすべてのピープル・コネクションを一覧表示するか、単一の接続を一覧表示します。

構文

listWCPSPeopleConnections([server], [verbose], [name], [namespace])

引数

定義

server

オプション。WebCenter Portalのパーソナライズ・サービスをホストする管理対象サーバーの名前。

このパラメータは、デフォルト以外のデプロイメント構成の場合にのみ必要です。WC_Utilitiesサーバーがパーソナライズ・サービスをホストするデフォルトのデプロイメントの場合、値は必要ありません。

verbose

オプション。詳細出力または簡易出力を制御します。有効なオプションは、1および0です。1に設定すると、このコマンドによってピープル・コネクションおよびそれらのプロパティが一覧表示されます。0に設定すると、このコマンドによって接続名のみ一覧表示されます。デフォルトは1です。

name

オプション。既存の接続の名前。指定しないかNoneに設定した場合、すべての接続が一覧表示されます。

namespace

オプション。一覧表示する接続用のWebCenter Portalのパーソナライズ接続ネームスペース。指定しないかnoneに設定した場合、このコマンドによって、すべてのネームスペースで使用できるように構成された接続が一覧表示されます。

例

次の例では、すべてのピープル・コネクションの名前を一覧表示します。

wls:/weblogic/serverConfig> listWCPSPeopleConnections(verbose=0)

People1Connection
People2Connection

次の例では、1つのピープル・コネクションの詳細を一覧表示します。

wls:/weblogic/serverConfig> listWCPSPeopleConnections(name='PeopleConnection')

----------------------
PeopleConnection (type=people.service.connection, namespace=*)
----------------------
host: myhost.com
isDefault: false
port: 8888
restResourceIndex: /rest/api/resourceIndex
rewriteUrls: producer
scheme: http

listWCPSCustomConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

パーソナライズ・サービス用に構成されている特定のタイプのすべての接続を一覧表示するか、単一の接続を一覧表示します。

カスタム接続タイプは、カスタム・データ・プロバイダおよびプロパティ・ロケータとともに使用されます。

構文

listWCPSCustomConnections(type, [server], [verbose], [name], [namespace])

引数

定義

type

カスタム・データ・プロバイダまたはプロパティ・ロケータ実装に固有のカスタム接続タイプ。

server

オプション。WebCenter Portalのパーソナライズ・サービスをホストする管理対象サーバーの名前。

このパラメータは、デフォルト以外のデプロイメント構成の場合にのみ必要です。WC_Utilitiesサーバーがパーソナライズ・サービスをホストするデフォルトのデプロイメントの場合、値は必要ありません。

verbose

オプション。詳細出力または簡易出力を制御します。有効なオプションは、1および0です。1に設定すると、このコマンドによって接続およびそれらのプロパティが一覧表示されます。0に設定すると、このコマンドによって接続名のみ一覧表示されます。デフォルトは1です。

name

オプション。既存の接続の名前。指定しないかNoneに設定した場合、すべての接続が一覧表示されます。

namespace

オプション。一覧表示する接続用のWebCenter Portalのパーソナライズ接続ネームスペース。指定しないかnoneに設定した場合、このコマンドによって、すべてのネームスペースで使用できるように構成された接続が一覧表示されます。

例

次の例では、タイプmy.connection.typeを持つすべての接続の名前を一覧表示します。

wls:/weblogic/serverConfig> listWCPSCustomConnections(type='my.connection.type', verbose=0)

Custom1Connection
Custom2Connection

次の例では、1つのカスタム接続の詳細を一覧表示します。

wls:/weblogic/serverConfig> listWCPSPeopleConnections(type='my.connection.type', name='CustomConnection')

----------------------
CustomConnection (type=my.connection.type, namespace=*)
----------------------
host: myhost.com
isDefault: false
port: 8888
customConnectionProperty: someValue
scheme: http

deleteWCPSCMISConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

パーソナライズ・サービス用に構成されているCMIS (Content Management Interoperability Service)接続を削除します。

構文

deleteWCPSCMISConnection(name, [namespace, server])

引数

定義

name

接続の名前を示します。

namespace

オプション。削除する接続用のWebCenter Portalのパーソナライズ接続ネームスペース。指定しないかnoneに設定した場合、このコマンドによって、すべてのネームスペースで使用できるように構成された接続が削除されます。

server

オプション。WebCenter Portalのパーソナライズ・サービスをホストする管理対象サーバーの名前。

このパラメータは、デフォルト以外のデプロイメント構成の場合にのみ必要です。WC_Utilitiesサーバーがパーソナライズ・サービスをホストするデフォルトのデプロイメントの場合、値は必要ありません。

例

次の例では、CMIS接続を削除します。

wls:/weblogic/serverConfig>deleteWCPSCMISConnection(name='ReposCMISConnection')

deleteWCPSActivityGraphConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

パーソナライズ・サービス用に構成されているアクティビティ・グラフ接続を削除します。

構文

deleteWCPSActivityGraphConnection(name, [namespace, server])

引数

定義

name

接続の名前を示します。

namespace

オプション。削除する接続用のWebCenter Portalのパーソナライズ接続ネームスペース。指定しないかnoneに設定した場合、このコマンドによって、すべてのネームスペースで使用できるように構成された接続が削除されます。

server

オプション。WebCenter Portalのパーソナライズ・サービスをホストする管理対象サーバーの名前。

このパラメータは、デフォルト以外のデプロイメント構成の場合にのみ必要です。WC_Utilitiesサーバーがパーソナライズ・サービスをホストするデフォルトのデプロイメントの場合、値は必要ありません。

例

次の例では、アクティビティ・グラフ接続を削除します。

wls:/weblogic/serverConfig>deleteWCPSActivityGraphConnection(name='AGConnection')

deleteWCPSPeopleConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

パーソナライズ・サービス用に構成されているピープル・コネクションを削除します。

構文

deleteWCPSPeopleConnection(name, [namespace, server])

引数

定義

name

接続の名前を示します。

namespace

オプション。削除する接続用のWebCenter Portalのパーソナライズ接続ネームスペース。指定しないかnoneに設定した場合、このコマンドによって、すべてのネームスペースで使用できるように構成された接続が削除されます。

server

オプション。WebCenter Portalのパーソナライズ・サービスをホストする管理対象サーバーの名前。

このパラメータは、デフォルト以外のデプロイメント構成の場合にのみ必要です。WC_Utilitiesサーバーがパーソナライズ・サービスをホストするデフォルトのデプロイメントの場合、値は必要ありません。

例

次の例では、ピープル・コネクションを削除します。

wls:/weblogic/serverConfig>deleteWCPSPeopleConnection(name='PeopleConnection')

deleteWCPSCustomConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

ポータルのパーソナライズ・サービス用に構成されているカスタム接続を削除します。

構文

deleteWCPSCustomConnection(name, type, [namespace, server])

引数

定義

name

接続の名前を示します。

type

カスタム接続タイプ。

namespace

オプション。削除する接続用のWebCenter Portalのパーソナライズ接続ネームスペース。指定しないかnoneに設定した場合、このコマンドによって、すべてのネームスペースで使用できるように構成された接続が削除されます。

server

オプション。WebCenter Portalのパーソナライズ・サービスをホストする管理対象サーバーの名前。

このパラメータは、デフォルト以外のデプロイメント構成の場合にのみ必要です。WC_Utilitiesサーバーがパーソナライズ・サービスをホストするデフォルトのデプロイメントの場合、値は必要ありません。

例

次の例では、カスタム接続を削除します。

wls:/weblogic/serverConfig>deleteWCPSCustomConnection(name='CustomConnection', type='my.connection.type')

setWCPSConnectionProperty

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

パーソナライズ・サービスの既存の接続のプロパティを追加、変更または削除します。接続によってサポートされるプロパティは、接続タイプに固有です。

- CMIS接続では、次のプロパティがサポートされます。repositoryId、host、port、scheme、path、pathPrepend、servletPathPart、rewriteUrls、pathTrim、isDefault、timeoutInMillisecs、propagateTimeoutException
「createWCPSCMISConnection」も参照してください。

- アクティビティ・グラフおよびピープル・コネクションでは次のプロパティがサポートされます。host, port, scheme, restResourceIndex, rewriteUrls, pathTrim, isDefault
「createWCPSActivityGraphConnection」および「createWCPSPeopleConnection」も参照してください。

構文

setWCPSConnectionProperty(connectionName, connectionType, propertyName,
propertyValue, [namespace], [server])

引数

定義

connectionName

接続の名前を示します。

connectionType

接続タイプ。CMIS、アクティビティ・グラフおよびピープル・コネクションに対して有効な値は、それぞれ、WCPS_CMIS_CONNECTION_TYPE、WCPS_AG_CONNECTION_TYPEおよびWCPS_PC_CONNECTION_TYPEです。

任意の有効なカスタム接続タイプを指定することもできます

propertyName

プロパティ名。

propertyValue

文字列としてのプロパティ値。接続からプロパティ値を削除するにはNoneを使用してください。

namespace

オプション。変更する接続用のWebCenter Portalのパーソナライズ接続ネームスペース。指定しないかnoneに設定した場合、このコマンドによって、すべてのネームスペースで使用できるように構成された接続のプロパティが変更されます。

server

オプション。WebCenter Portalのパーソナライズ・サービスをホストする管理対象サーバーの名前。

このパラメータは、デフォルト以外のデプロイメント構成の場合にのみ必要です。WC_Utilitiesサーバーがパーソナライズ・サービスをホストするデフォルトのデプロイメントの場合、値は必要ありません。

例

次の例では、CMIS接続のプロパティを変更または追加します。

wls:/weblogic/serverConfig> setWCPSConnectionProperty(connectionName='ReposCMISConnection',
connectionType=WCPS_CMIS_CONNECTION_TYPE,
propertyName='propagateTimeoutExceptions', propertyValue=0)

次の例では、カスタム接続からプロパティを削除します。

wls:/weblogic/serverConfig> setWCPSConnectionProperty(connectionName='CustomConnection',
connectionType='my.connection.type', propertyName='prop2', propertyValue=None)

ポートレット・プロデューサ

表10-21に示すコマンドを使用して、WebCenter Portalアプリケーションで使用されるポートレット・プロデューサを管理します。

これらのWebCenter Portal WLSTコマンドを使用して行ったすべての構成変更は、WebCenter Portalアプリケーションでただちに有効になります。

表10-21 プロデューサWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

registerWSRPProducer

WSRPプロデューサを作成し登録します。

オンライン

setWSRPProducer

WSRPプロデューサの登録に関する詳細情報を編集します。

オンライン

listWSRPProducers

WSRPプロデューサの登録に関する詳細情報を表示します。

オンライン

deregisterWSRPProducer

WSRPプロデューサを登録解除し、関連付けられるWSRPおよびWebサービス接続を削除します。

オンライン

listWSRPProducerRegistrationProperties

WSRPプロデューサによってサポートされる登録プロパティを表示します。

オンライン

listWSRPProducerUserCategories

WSRPプロデューサでサポートされる可能性がある任意のユーザー・カテゴリを表示します。

オンライン

mapWSRPProducerUserCategory

WSRPプロデューサによってサポートされるユーザー・カテゴリに、指定したアプリケーションで定義されているロールをマップします。

オンライン

registerPDKJavaProducer

Oracle PDK-Javaプロデューサを作成し登録します。

オンライン

setPDKJavaProducer

PDK-Javaプロデューサの登録に関する詳細情報を編集します。

オンライン

listPDKJavaProducers

登録済のOracle PDK-Javaプロデューサを表示します。

オンライン

deregisterPDKJavaProducer

Oracle PDK-Javaプロデューサを登録解除し、関連付けられる接続を削除します。

オンライン

registerPageletProducer

ページレット・プロデューサを作成し登録します。

オンライン

setPageletProducer

ページレット・プロデューサの登録に関する詳細を編集します。

オンライン

listPageletProducers

ページレット・プロデューサの登録に関する詳細を一覧表示します。

オンライン

deregisterPageletProducer

ページレット・プロデューサを登録解除し、関連付けられている接続を削除します。

オンライン

refreshProducer

現在、名前付きのプロデューサによって提供されたポートレットが反映されるようにそのプロデューサに対して格納したメタデータを最新の状態にします。

オンライン

registerOOTBProducers

Oracle WebCenterの初期状態のプロデューサを登録します。

オンライン

deregisterOOTBProducers

Oracle WebCenterの初期状態のプロデューサを登録解除します。

オンライン

registerSampleProducers

Oracle WebCenterのサンプル・プロデューサを登録します。

オンライン

deregisterSampleProducers

サンプル・プロデューサを登録解除します。

オンライン

registerWSRPProducer

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WSRPポートレット・プロデューサへの接続を作成し、WRSPプロデューサを、指定したWebCenter Portalアプリケーションに登録します。WSRPプロデューサ接続を作成すると、<name>-wsconnという名前のWebサービス接続も作成されます。ここで、<name>は、name引数に対して指定した値を示します。

構文

registerWSRPProducer(appName, name, url, [proxyHost], [proxyPort],
[timeout],[externalApp],[registrationProperties],[tokenType],[issuer],[defUser],
[keyStorePath],[keyStorePswd],[sigKeyAlias],[sigKeyPswd],[encKeyAlias],
[encKeyPswd],[recptAlias], [enforcePolicyURI], [server],[applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

ここで指定した名前は、Oracle Composer (Portletsフォルダの下)に表示されます。

url

プロデューサWSDL URL。構文は、WSRPの実装によって異なります。例:

http://host_name:port_number/context_root/portlets/wsrp2?WSDL

http://host_name:port_number/context_root/portlets/wsrp1?WSDL

http://host_name:port_number/context_root/portlets/?WSDL (後方互換性用WSRP 1.0)

ここで:

- host_nameは、プロデューサがデプロイされているサーバーを示します

- port_numberは、HTTPリスナー・ポート番号を示します

- context_rootは、Webアプリケーションのコンテキスト・ルートを示します

- portlets[/wsrp(1|2)]?WSDLは、静的テキストを示します。ここで入力したテキストは、プロデューサのデプロイ方法によって異なります。

例:

http://myhost.com:7778/MyPortletApp/portlets/wsrp2?WSDL

proxyHost

オプション。プロキシ・サーバーのホスト名またはIPアドレスを示します。

プロキシは、WebCenter Portalアプリケーションおよびリモート・ポートレット・プロデューサがファイアウォールで離れている場合に必要です。HTTPプロキシは、プロデューサと通信するために必要です。

proxyPort

オプション。プロキシ・サーバーのリスン先のポート番号を示します。

timeout

オプション。プロデューサと通信するために秒の単位で指定するタイムアウトを示します。たとえば、プロデューサによってWebCenter Portalページ上にポートレットを登録、登録解除および表示するために必要な最大時間です。この引数のデフォルトは、30です。

個々のポートレットは、その自体のタイムアウト時間を定義する場合があります。このタイムアウト値は、ここで指定されている値よりも優先されます。

registrationProperties

オプション。登録プロパティとその値のリストを示します。有効な登録プロパティを指定する場合、カンマ区切りのフォーマットを使用する必要があります。各プロパティの後には、等号および値が続きます。例: name=Producer,key=123。プロデューサの登録プロパティは、listWSRPProducerRegistrationPropertiesを使用して表示できます。「listWSRPProducerRegistrationProperties」を参照してください。

tokenType

オプション。このWSRPプロデューサで認証するために使用するトークン・プロファイルのタイプを示します。

引数がenforcePolicyURI=1である場合、有効な値は次のとおりです:

- USERNAME_WITHOUT_PASSWORD
(oracle/wss10_username_id_propagation_with_msg_protection_client_policy) - このポリシーは、WS-Security 1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージ保護(整合性と機密性)およびIDの伝播を提供します。資格証明(user nameのみ)は、WS-Security UsernameTokenヘッダーを介してアウトバウンドSOAPリクエスト・メッセージに組み込まれています。パスワードは組み込まれません。
非対称の主要技術のWS-Security 1.0 Basic128スイートを使用することでメッセージ保護を提供します。具体的には、メッセージ機密性のためのRSAキー・メカニズム、メッセージ整合性のためのSHA-1ハッシュ・アルゴリズム、およびAES-128ビット暗号化です。

- USERNAME_WITH_PASSWORD
(oracle/wss10_username_token_with_message_protection_client_policy) - このポリシーは、WS-Security v1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージ保護(整合性と機密性)および認証を提供します。プレーン・テキストとダイジェストの両方のメカニズムがサポートされます。
このポリシーは、非対称鍵テクノロジのWS-SecurityのBasic128スイートを使用します。具体的には、メッセージ機密性のためのRSAキー・メカニズム、メッセージ整合性のためのSHA-1ハッシュ・アルゴリズム、およびAES-128ビット暗号化です。

WSRPプロデューサには、別のIDストアがある場合、このトークン・プロファイルを使用します。プロデューサに関連する外部アプリケーションを定義し、その外部アプリケーションをこのプロデューサと関連付ける必要があります。

- SAML_TOKEN_WITH_MSG_INTEGRITY
(wss10_saml_token_with_message_integrity_client_policy) - このポリシーは、WS-Security 1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージレベルの整合性保護およびSAMLベースの認証を提供します。SOAPメッセージに組み込まれているSAMLトークンは、送信者保証確認付きSAMLベース認証で使用されます。
このポリシーは、WS-Securityの非対称鍵テクノロジのBasic 128スイートおよびメッセージの整合性のためにはSHA-1ハッシュ・アルゴリズムを使用します。

このポリシーを選択する場合は、受信者キー別名(recptAlias)を無効に設定する必要があります。

- SAML_TOKEN_WITH_MSG_PROTECTION
(oracle/wss10_saml_token_with_message_protection_client_policy) - このポリシーは、WS-Security 1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージレベルの保護(整合性と機密性)およびSAMLベースの認証を提供します。Webサービス・コンシューマによって、SOAPヘッダーにSAMLトークンが組み込まれ、確認タイプはsender-vouchesです。
このポリシーは、非対称鍵テクノロジのWS-SecurityのBasic128スイートを使用します。具体的には、メッセージ機密性のためのRSAキー・メカニズム、メッセージ整合性のためのSHA-1ハッシュ・アルゴリズム、およびAES-128ビット暗号化です。

tokenType
continued...

- WSS11_SAML_TOKEN_WITH_MSG_PROTECTION
(oracle/wss11_saml_token_with_message_protection_client_policy) - このポリシーは、WS-Security 1.1標準に従って、アウトバウンドSOAPリクエストに対するメッセージレベルの保護(整合性と機密性)およびSAMLトークンの移入を提供します。SOAPメッセージに組み込まれているSAMLトークンは、送信者保証確認付きSAMLベース認証で使用されます。このポリシーは、署名および暗号化のために対称鍵テクノロジを、署名の承認のために非対称鍵テクノロジのWS-SecurityのBasic 128スイートを使用します。

- WSS10_SAML_TOKEN_ONLY (oracle/wss10_saml_token_client_policy) - このポリシーは、WS-Security 1.0標準に従って、アウトバウンドSOAPリクエスト・メッセージに対するSAMLベースの認証を提供します。このポリシーでは、ユーザーのアイデンティティが伝播されます。通常、これはメッセージ保護および整合性チェックが不要な内部部門でのデプロイメントに使用されます。
このポリシーでは、キーストアの構成は不要です。

引数がenforcePolicyURI=0である場合、tokenType引数には、任意の有効な Oracle Web Services Manager (OWSM)ポリシーURIを指定できます。

issuer

オプション。トークンの発行者の名前を示します。発行者名は、テーマの検証を保証する要素です。たとえば、www.oracle.comです。

この引数は、トークン・タイプがSAML_TOKEN_WITH_MSG_PROTECTION、SAML_TOKEN_WITH_MSG_INTEGRITY、WSS10_SAML_TOKEN_ONLY、WSS11_SAML_TOKEN_WITH_MSG_PROTECTIONである場合にのみ適用されます。

defUser

オプション。WebCenter Portalアプリケーションでユーザーが認証されていない場合、リモート・プロデューサにアサートするユーザー名。

認証されていない場合、アイデンティティanonymousがアプリケーション・ユーザーに関連付けられます。場合によっては、値anonymousはリモート・プロデューサに対して不適切であるため、かわりのアイデンティティをここで指定する必要があります。ただし、この場合、WebCenter Portalアプリケーションによってそのユーザーは認証されていないため、指定したデフォルト・ユーザーは、リモート・プロデューサにおいて権限が低いユーザーであることに注意してください。そのユーザーがアプリケーションに対して認証済である場合、デフォルト・ユーザーではなく、そのユーザーのアイデンティティがアサートされます。

この引数は、トークン・タイプがUSERNAME_WITHOUT_PASSWORD、SAML_TOKEN_WITH_MSG_PROTECTION、SAML_TOKEN_WITH_MSG_INTEGRITY、WSS10_SAML_TOKEN_ONLY、WSS11_SAML_TOKEN_WITH_MSG_PROTECTIONである場合にのみ適用されます。

extApp

オプション。この引数は、tokenTypeがUSERNAME_WITH_PASSWORDの場合、適用できます。このプロデューサは、外部アプリケーションによって認証用ユーザー資格証明を格納および提供する場合、この引数を使用して、関連付けられる外部アプリケーションの名前を指定します。

keyStorePath

オプション。SOAPメッセージのセキュリティ・トークンおよびSOAPメッセージの本体など一部にサインするために使用される秘密鍵および証明書を含むキー・ストアへの絶対パスを示します。選択したファイルは、Javaキー・ツールを使用して作成したキー・ストアである必要があります。

keyStorePswd

オプション。キー・ストアの作成時に設定されていたキー・ストアのパスワードを示します。

sigKeyAlias

オプション。サインするために使用した秘密鍵に関連付けられる証明書の識別子を示します。

sigKeyPswd

オプション。sigKeyAlias引数を使用して指定した別名によって識別したキーにアクセスするパスワードを示します。

encKeyAlias

オプション。暗号化のために使用されるキー別名を示します。有効な値は、指定したキー・ストアにあるキー別名の1つです。

encKeyPswd

オプション。暗号化キーにアクセスするパスワードを示します。

recptAlias

オプション。プロデューサの証明者に関連付けられるキー・ストア別名を示します。この証明者を使用して、プロデューサへのメッセージを暗号化します。

tokenTypeは、SAML_TOKEN_WITH_MSG_INTEGRITYの場合、受信者キー別名を指定しません。

enforcePolicyURI

オプション。有効な値は、1 (true)および0 (false)です。1に設定した場合、ユーザーは、tokenType引数に次のトークン・プロファイルのうちの1つを指定する必要があります。USERNAME_WITHOUT_PASSWORD、USERNAME_WITH_PASSWORD、SAML_TOKEN_WITH_MSG_PROTECTION、SAML_TOKEN_WITH_MSG_INTEGRITY、WSS11_SAML_TOKEN_WITH_MSG_PROTECTION、WSS10_SAML_TOKEN_ONLY

0に設定した場合、ユーザーは、任意のOracle Web Services Manager (OWSM)ポリシーURIを指定できます。ユーザーは、指定したOWSMポリシーが有効であることを確認する必要があります。

デフォルト値は1です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、WSRPSamplesという名前のWSRPプロデューサを登録し、webcenterという名前のアプリケーションにWSRPプロデューサを登録します。

wls:/weblogic/serverConfig> registerWSRPProducer(appName='webcenter',
name='WSRPSamples', url='http://myhost.com:9999/
portletapp/portlets/wsrp2?WSDL')

次の例は、保護されたWSRPプロデューサを登録します。

wls:/weblogic/serverConfig> registerWSRPProducer(appName='webcenter',
name='WSRPSamples2', url='http://myhost.com:8899/portletapp/portlets/wsrp2?WSDL',
tokenType='WSS11_SAML_TOKEN_WITH_MSG_PROTECTION', issuer='www.oracle.com',  defUser='anonymous', keyStorePath='/keys/mykeystore.jks', keyStorePswd='Test1',
sigKeyAlias='mysigalias',sigKeyPswd='mysigpswd', encKeyAlias='myencalias',
encKeyPswd='myencpswd', recptAlias='myrcptalias')

setWSRPProducer

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

既存のWSRPプロデューサの登録に関する詳細情報を編集します。

構文

setWSRPProducer(appName, name, [url], [proxyHost], [proxyPort], [timeout],
[externalApp], [tokenType],[issuer], [defUser], [keyStorePath], [keyStorePswd]
[sigKeyAlias], [sigKeyPswd], [encKeyAlias], [encKeyPswd], [recptAlias],
[enforcePolicyURI], [server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のWSRPプロデューサの名前を示します。

url

オプション。WSRPプロデューサURL。構文は、WSRPの実装によって異なります。例:

http://host_name:port_number/context_root/portlets/wsrp2?WSDL

http://host_name:port_number/context_root/portlets/wsrp1?WSDL

http://host_name:port_number/context_root/portlets/?WSDL (後方互換性用WSRP 1.0)

ここで:

- host_nameは、プロデューサがデプロイされているサーバーを示します

- port_numberは、HTTPリスナー・ポート番号を示します

- context_rootは、Webアプリケーションのコンテキスト・ルートを示します

- portlets[/wsrp(1|2)]?WSDLは、静的テキストを示します。ここで入力したテキストは、プロデューサのデプロイ方法によって異なります。

例:

http://myhost:7778/MyPortletApp/portlets/wsrp2?WSDL

proxyHost

オプション。プロキシ・サーバーのホスト名またはIPアドレスを示します。

プロキシは、WebCenter Portalアプリケーションおよびリモート・ポートレット・プロデューサがファイアウォールで離れている場合に必要です。HTTPプロキシは、プロデューサと通信するために必要です。

proxyPort

オプション。プロキシ・サーバーのリスン先のポート番号を示します。

timeout

オプション。プロデューサと通信するために秒の単位で指定するタイムアウトを示します。たとえば、プロデューサによってWebCenter Portalページ上にポートレットを登録、登録解除および表示するために必要な最大時間です。

この引数のデフォルトは、30です。

個々のポートレットは、その自体のタイムアウト時間を定義する場合があります。このタイムアウト値は、ここで指定されている値よりも優先されます。

extApp

オプション。この引数は、tokenTypeがUSERNAME_WITH_PASSWORDの場合、適用できます。このプロデューサは、外部アプリケーションによって認証用ユーザー資格証明を格納および提供する場合、この引数を使用して、関連付けられる外部アプリケーションの名前を指定します。

tokenType

オプション。このWSRPプロデューサで認証するために使用するトークン・プロファイルのタイプを示します。

引数がenforcePolicyURI=1である場合、有効な値は次のとおりです:

- USERNAME_WITHOUT_PASSWORD
(oracle/wss10_username_id_propagation_with_msg_protection_client_policy) - このポリシーは、WS-Security 1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージ保護(整合性と機密性)およびアイデンティティの伝播を提供します。資格証明(user nameのみ)は、WS-Security UsernameTokenヘッダーを介してアウトバウンドSOAPリクエスト・メッセージに組み込まれています。パスワードは組み込まれません。

非対称鍵テクノロジのWS-Security 1.0 Basic 128スイートを使用することでメッセージ保護を提供します。具体的には、メッセージ機密性のためのRSAキー・メカニズム、メッセージ整合性のためのSHA-1ハッシュ・アルゴリズム、およびAES-128ビット暗号化です。

- USERNAME_WITH_PASSWORD
(oracle/wss10_username_token_with_message_protection_client_policy) - このポリシーは、WS-Security v1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージ保護(整合性と機密性)および認証を提供します。プレーン・テキストとダイジェストの両方のメカニズムがサポートされます。

このポリシーは、非対称鍵テクノロジのWS-SecurityのBasic128スイートを使用します。具体的には、メッセージ機密性のためのRSAキー・メカニズム、メッセージ整合性のためのSHA-1ハッシュ・アルゴリズム、およびAES-128ビット暗号化です。

WSRPプロデューサには、別のIDストアがある場合、このトークン・プロファイルを使用します。プロデューサに関連する外部アプリケーションを定義し、その外部アプリケーションをこのプロデューサと関連付ける必要があります。

- SAML_TOKEN_WITH_MSG_INTEGRITY
(wss10_saml_token_with_message_integrity_client_policy) - このポリシーは、WS-Security 1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージレベルの整合性およびSAMLベースの認証を提供します。SOAPメッセージに組み込まれているSAMLトークンは、送信者保証確認付きSAMLベース認証で使用されます。

このポリシーは、WS-Securityの非対称鍵テクノロジのBasic 128スイートおよびメッセージの整合性のためにはSHA-1ハッシュ・アルゴリズムを使用します。

このポリシーを選択する場合は、受信者キー別名(recptAlias)を無効に設定する必要があります。

- SAML_TOKEN_WITH_MSG_PROTECTION
(oracle/wss10_saml_token_with_message_protection_client_policy) - このポリシーは、WS-Security v1.0標準に従って、アウトバウンドSOAPリクエストに対するメッセージレベルの保護(整合性と機密性)およびSAMLベースの認証を提供します。Webサービス・コンシューマによって、SOAPヘッダーにSAMLトークンが組み込まれ、確認タイプはsender-vouchesです。

このポリシーは、非対称鍵テクノロジのWS-SecurityのBasic128スイートを使用します。具体的には、メッセージ機密性のためのRSAキー・メカニズム、メッセージ整合性のためのSHA-1ハッシュ・アルゴリズム、およびAES-128ビット暗号化です。

tokenType
continued...

- WSS11_SAML_TOKEN_WITH_MSG_PROTECTION
(oracle/wss11_saml_token_with_message_protection_client_policy) - このポリシーは、WS-Security 1.1標準に従って、アウトバウンドSOAPリクエストに対するメッセージレベルの保護(整合性と機密性)およびSAMLトークンの移入を有効化します。SOAPメッセージに組み込まれているSAMLトークンは、送信者保証確認付きSAMLベース認証で使用されます。このポリシーは、署名および暗号化のために対称鍵テクノロジを、署名の承認のために非対称鍵テクノロジのWS-SecurityのBasic 128スイートを使用します。

- WSS10_SAML_TOKEN_ONLY
(oracle/wss10_saml_token_client_policy) - このポリシーは、WS-Security 1.0標準に従って、アウトバウンドSOAPリクエスト・メッセージにSAMLトークンを組み込みます。このポリシーでは、ユーザーのアイデンティティが伝播されます。通常、これはメッセージ保護および整合性チェックが不要な内部部門でのデプロイメントに使用されます。

このポリシーでは、キーストアの構成は不要です。

引数がenforcePolicyURI=0である場合、tokenType引数には、任意の有効な Oracle Web Services Manager (OWSM)ポリシーURIを指定できます。

issuer

オプション。トークンの発行者の名前を示します。発行者名は、テーマの検証を保証する要素です。たとえば、www.oracle.comです。

この引数は、トークン・タイプがSAML_TOKEN_WITH_MSG_PROTECTION、SAML_TOKEN_WITH_MSG_INTEGRITY、WSS10_SAML_TOKEN_ONLY、WSS11_SAML_TOKEN_WITH_MSG_PROTECTIONである場合にのみ適用されます。

defUser

オプション。WebCenter Portalアプリケーションでユーザーが認証されていない場合、リモート・プロデューサにアサートするユーザー名。

認証されていない場合、アイデンティティanonymousがアプリケーション・ユーザーに関連付けられます。場合によっては、値anonymousはリモート・プロデューサに対して不適切であるため、かわりのアイデンティティをここで指定する必要があります。ただし、この場合、WebCenter Portalアプリケーションによってそのユーザーは認証されていないため、指定したデフォルト・ユーザーは、リモート・プロデューサにおいて権限が低いユーザーであることに注意してください。そのユーザーがアプリケーションに対して認証済である場合、デフォルト・ユーザーではなく、そのユーザーのアイデンティティがアサートされます。

この引数は、トークン・タイプがUSERNAME_WITHOUT_PASSWORD、SAML_TOKEN_WITH_MSG_PROTECTION、SAML_TOKEN_WITH_MSG_INTEGRITY、WSS10_SAML_TOKEN_ONLY、WSS11_SAML_TOKEN_WITH_MSG_PROTECTIONである場合にのみ適用されます。

keyStorePath

オプション。SOAPメッセージのセキュリティ・トークンおよびSOAPメッセージの本体など一部にサインするために使用される秘密鍵および証明書を含むキー・ストアへの絶対パスを示します。選択したファイルは、Javaキー・ツールを使用して作成したキー・ストアである必要があります。

keyStorePswd

オプション。キー・ストアの作成時に設定されていたキー・ストアのパスワードを示します。

sigKeyAlias

オプション。サインするために使用した秘密鍵に関連付けられる証明書の識別子を示します。

sigKeyPswd

オプション。sigKeyAlias引数を使用して指定した別名によって識別したキーにアクセスするパスワードを示します。

encKeyAlias

オプション。戻りメッセージを暗号化するためにプロデューサによって使用されるキーの別名。有効な値は、指定したキー・ストアにあるキー別名の1つです。指定しない場合、プロデューサでは、戻りメッセージの暗号化のために署名鍵を使用します。

encKeyPswd

オプション。暗号化キーにアクセスするパスワードを示します。

recptAlias

オプション。プロデューサの証明者に関連付けられるキー・ストア別名を示します。この証明書を使用して、プロデューサへのアウトバウンド・メッセージを暗号化します。

tokenTypeは、SAML_TOKEN_WITH_MSG_INTEGRITYの場合、受信者キー別名を指定しません。

enforcePolicyURI

オプション。有効な値は、1 (true)および0 (false)です。1に設定した場合、ユーザーは、tokenType引数に次のトークン・プロファイルのうちの1つを指定する必要があります。USERNAME_WITHOUT_PASSWORD、USERNAME_WITH_PASSWORD、SAML_TOKEN_WITH_MSG_PROTECTION、SAML_TOKEN_WITH_MSG_INTEGRITY、WSS11_SAML_TOKEN_WITH_MSG_PROTECTION、WSS10_SAML_TOKEN_ONLY

0に設定した場合、ユーザーは、任意のOracle Web Services Manager (OWSM)ポリシーURIを指定できます。ユーザーは、指定したOWSMポリシーが有効であることを確認する必要があります。

デフォルト値は1です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

この例では、WSRPSamplesのプロデューサのタイムアウトを60秒に増加します。

wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter', name='WSRPSamples', timeout=60)

この例は、保護されたWSRPプロデューサ上のセキュリティ・プロパティを更新します。

wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter',
name='WSRPSamples2', tokenType='WSS11_SAML_TOKEN_WITH_MSG_PROTECTION', issuer='www.oracle.com',  defUser='anonymous',
keyStorePath='/keys/mykeystore.jks', keyStorePswd='Test1',
sigKeyAlias='mysigalias', sigKeyPswd='mysigpswd',encKeyAlias='myencalias',
encKeyPswd='myencpswd', recptAlias='myrcptalias')

この例は、保護されたWSRPプロデューサ上に設定したセキュリティ・プロパティをすべて削除します。

wls:/weblogic/serverConfig>setWSRPProducer(appName='webcenter',
name='WSRPSamples2', tokenType='')

listWSRPProducers

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WSRPプロデューサの登録に関する詳細情報を表示します。

構文

listWSRPProducers(appName,[name],[verbose], [server], [applicationVersion])

引数

定義

appName

1つまたは複数のWSRPプロデューサが登録されているアプリケーションの名前を示します。

name

オプション。既存のWSRPプロデューサの名前を示します。指定しない場合、このWebCenter Portalアプリケーションに対して構成されているWSRPプロデューサすべての接続詳細が一覧表示されます。

verbose

オプション。WSRPプロデューサの接続に関する詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listWSRPProducersによって、すべての接続プロパティが一覧表示されます。0に設定した場合、listWSRPProducersによって、接続名のみ一覧表示されます。この引数のデフォルトは、1です。

この引数を0に設定した場合、names引数を指定しないでください。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myAppという名前のアプリケーションに登録されているWSRPプロデューサをすべて一覧表示します。

wls:/weblogic/serverConfig> listWSRPProducers(appName='myApp', verbose=0)

----------------------
WSRPSamples-connection
----------------------

次の例では、myAppという名前のアプリケーションに、WSRPSamples-connectionとして登録されているWSRPプロデューサの詳細な接続情報を一覧表示します。

wls:/weblogic/serverConfig> listWSRPProducers(appName='myApp', name='WSRPSamples-connection', verbose=1)

----------------------
WSRPSamples-connection
----------------------
Connection Name: WSRPSamples-connection
Web Service Connection Name: WSRPSamples-connection-wsconn
Proxy Host: None
Proxy Port: None
Timeout: 0
WSDL URL: http://pspencer-lnx.uk.oracle.com:7777/portletapp/portlets/wsrp2?WSDL

deregisterWSRPProducer

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WSRPプロデューサを登録解除し、関連付けられるWSRPおよびWebサービス接続を削除します。

構文

deregisterWSRPProducer(appName, name, [server], [applicationVersion])

引数

定義

appName

プロデューサが登録されているWebCenter Portalアプリケーションの名前。

name

既存のWSRPプロデューサの名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、webcenterという名前のアプリケーション内のWSRPSamplesプロデューサを登録解除します。

wls:/weblogic/serverConfig> deregisterWSRPProducer(appName='webcenter',
name='WSRPSamples')

listWSRPProducerRegistrationProperties

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WSRPポートレット・プロデューサによってサポートされる登録プロパティを表示します。

構文

listWSRPProducerRegistrationProperties(appName, url,[proxyHost, [proxyPort],
[server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

url

WSRPプロデューサURL。構文は、WSRPの実装によって異なります。例:

http://host_name:port_number/context_root/portlets/wsrp2?WSDL

http://host_name:port_number/context_root/portlets/wsrp1?WSDL

http://host_name:port_number/context_root/portlets/?WSDL (後方互換性用WSRP 1.0)

ここで:

- host_nameは、プロデューサがデプロイされているサーバーを示します

- port_numberは、HTTPリスナー・ポート番号を示します

- context_rootは、Webアプリケーションのコンテキスト・ルートを示します

- portlets[/wsrp(1|2)]?WSDLは、静的テキストを示します。ここで入力したテキストは、プロデューサのデプロイ方法によって異なります。

例:

http://myhost:7778/MyPortletApp/portlets/wsrp2?WSDL

proxyHost

オプション。プロキシ・サーバーのホスト名またはIPアドレスを示します。

プロキシは、WebCenter Portalアプリケーションおよびリモート・ポートレット・プロデューサがファイアウォールで離れている場合に必要です。HTTPプロキシは、プロデューサと通信するために必要です。

proxyPort

オプション。プロキシ・サーバーのリスン先のポート番号を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、WSRPプロデューサの有効な登録プロパティおよび指定したWSDL URLを表示します。

wls:/weblogic/serverConfig> listWSRPProducerRegistrationProperties
(appName='webcenter', url='http://myhost:9999/portletapp/portlets/wsrp2?WSDL')
Registration Property hint : hint text
Registration Property label : label text
Registration Property language : en
Registration Property name : {urn:xyz:wlp:prop:reg:registration}consumerRole
Registration Property value : None

listWSRPProducerUserCategories

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WSRPプロデューサでサポートされる可能性がある任意のユーザー・カテゴリを表示します。WebCenter Portalユーザーは、WLSTコマンドのmapWSRPProducerUserCategoryを使用して、アプリケーションのロールをプロデューサのユーザー・カテゴリにマップできます。

構文

listWSRPProducerUserCategories(appName, name, [server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のWSRPプロデューサの名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、WSRPSamplesという名前のWSRPプロデューサに関連付けられるカテゴリを表示します。

wls:/weblogic/serverConfig> listWSRPProducerUserCategories(appName='webcenter',
name='WSRPSamples')
User Category Name : categoryTwo
User Category Description : Custom role two.
User Category Mapped Local Roles : None

User Category Name : categoryOne
User Category Description : Custom role one.
User Category Mapped Local Roles : None

mapWSRPProducerUserCategory

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションに定義したロールを、WSRPプロデューサによってサポートされるユーザー・カテゴリにマップします。listWSRPProducerUserCategoriesを使用して、ユーザー・カテゴリを検索可能です。

構文

mapWSRPProducerUserCategory(appName, name, localRole, producerUserCategory,
[server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のWSRPプロデューサの名前を示します。

localRole

WebCenter Portalアプリケーションのマップするロールの名前。

producerUserCategory

WebCenter PortalロールをマップするWSRPプロデューサのユーザー・カテゴリ。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、アプリケーション・ロールadminをWSRPユーザー・カテゴリwrsp-adminにマップします。

wls:/weblogic/serverConfig> mapWSRPProducerUserCategory(appName='webcenter',
name='WSRPProducer1', localRole='admin', producerUserCategory='wsrp-admin')

registerPDKJavaProducer

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle PDK-Javaポートレット・プロデューサへの接続を作成し、Oracle PDK-Javaプロデューサを、指定したWebCenter Portalアプリケーションに登録します。

構文

registerPDKJavaProducer(appName, name, url, [serviceId], [proxyHost,
[proxyPort]], [subscriberId], [sharedKey], [timeout],
[establishSession],[externalApp], [mapUser], [server], [applicationVersion])

引数

定義

appName

この操作を実行する対象のWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

url

Oracle PDK-JavaプロデューサのURLを示します。次の構文を使用します:

http://host_name:port_number/context_root/providers

ここで:

- host_nameは、プロデューサがデプロイされているサーバーを示します

- port_numberは、HTTPリスナー・ポート番号を示します

- context_rootは、Webアプリケーションのコンテキスト・ルートを示します。

- providersは、静的テキストを示します。ここで入力したテキストは、プロデューサのデプロイ方法によって異なります。

例:

http://myHost:7778/myEnterprisePortlets/providers

serviceId

オプション。プロデューサのサービスIDを示します。

PDK-Javaを使用すると、1つのアダプタ・サーブレットの下に複数のプロデューサをデプロイできます。プロデューサは、それらのユニークなサービスIDで識別されます。サービスIDがURLのエンド・ポイントに追加されていないときにのみ、指定する必要があります。

たとえば、次のURLのエンドポイントには、サービスIDとしてsampleを指定する必要があります。

http://host.domainexample.com:7778/axyz/providers

ただし、次のURLのエンドポイントには、サービスIDを指定する必要はありません。

http://host.domainexample.com:7778/axyz/providers/sample

サービスIDを使用して、<service_id>.propertiesというファイルを参照できます。このファイルには、プロデューサのテスト・ページを表示するかどうかなど、プロデューサの特性が定義されています。任意の値を使用してサービスIDを作成します。

proxyHost

オプション。プロキシ・サーバーのホスト名またはIPアドレスを示します。

プロキシは、WebCenter Portalアプリケーションおよびリモート・ポートレット・プロデューサがファイアウォールで離れている場合には、必要です。HTTPプロキシは、プロデューサと通信するために必要です。

proxyPort

オプション。プロキシ・サーバーのリスン先のポート番号を示します。この引数のデフォルトは、80です。

sharedKey

オプション。リモート・プロデューサのメッセージを認証するために使用する共有キーを示します。メッセージを認証すると、受信メッセージが共有キーを持つホストから送信されます。この引数のデフォルトはnullです。

共有キーは、10文字から20文字までの英数字を含むことができます。

subscriberId

オプション。必要に応じて、コンシューマの識別子を示します。

アプリケーションにプロデューサを登録すると、プロデューサに呼出しが行われます。コール中、コンシューマが(このインスタンスの場合は、WebCenter Portalアプリケーション)サブスクライバIDの値をプロデューサに渡します。サブスクライバIDを使用するためにプロデューサがコード化される可能性があります。

timeout

オプション。プロデューサと通信するために秒の単位で指定するタイムアウトを示します。たとえば、プロデューサによってWebCenter Portalページ上にポートレットを登録、登録解除および表示するために必要な最大時間です。

この引数のデフォルトは、30です。

個々のポートレットは、その自体のタイムアウト時間を定義する場合があります。このタイムアウト値は、ここで指定されている値よりも優先されます。

establishSession

オプション。このプロデューサからポートレットを実行するときには、ユーザー・セッションを有効にします。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは0です。

セッションを有効に(1に設定)すると、サーバーでは、ユーザー名などセッション固有の情報が保持されます。セッションを使用してメッセージを認証するので、共有キーが指定されている場合、このオプションも有効に設定する必要があります。プロデューサとサーバーの間でセッションレス通信を行う場合は、0を指定します。

externalApp

オプション。プロデューサに関連付けられるために使用する外部アプリケーションの名前を示します。プロデューサのポートレットの1つを認証する必要がある場合、必須です。

mapUser

オプション。外部アプリケーションからマップしたユーザー名をプロデューサへに渡す必要があるかどうかを示すフラグ。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは、1です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、webcenterという名前のアプリケーションのJPDKSamplesという名前のOracle PDK-Javaプロデューサを作成し登録します。

wls:/weblogic/serverConfig> registerPDKJavaProducer(appName='webcenter',
name='JPDKSamples', url='http://myhost:9999/jpdk/providers/sample')

setPDKJavaProducer

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

既存のPDK-Javaプロデューサの登録に関する詳細情報を編集します。

構文

setPDKJavaProducer(appName, name, url, [serviceId], [proxyHost, [proxyPort]],
[subscriberId], [sharedKey], [timeout], [establishSession], [externalApp],
[mapUser], [server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のPDK-Javaプロデューサの名前を示します。

url

Oracle PDK-JavaプロデューサのURLを示します。次の構文を使用します:

http://host_name:port_number/context_root/providers

ここで:

- host_nameは、プロデューサがデプロイされているサーバーを示します

- port_numberは、HTTPリスナー・ポート番号を示します

- context_rootは、Webアプリケーションのコンテキスト・ルートを示します。

- providersは、静的テキストを示します。ここで入力したテキストは、プロデューサのデプロイ方法によって異なります。

例:

http://myHost:7778/myEnterprisePortlets/providers

serviceId

オプション。プロデューサのサービスIDを示します。

PDK-Javaを使用すると、1つのアダプタ・サーブレットの下に複数のプロデューサをデプロイできます。プロデューサは、それらのユニークなサービスIDで識別されます。サービスIDがURLのエンド・ポイントに追加されていないときにのみ、指定する必要があります。

たとえば、次のURLのエンドポイントには、サービスIDとしてsampleを指定する必要があります。

http://host.domainexample.com:7778/axyz/providers

ただし、次のURLのエンドポイントには、サービスIDを指定する必要はありません。

http://host.domainexample.com:7778/axyz/providers/sample

サービスIDを使用して、<service_id>.propertiesというファイルを参照できます。このファイルには、プロデューサのテスト・ページを表示するかどうかなど、プロデューサの特性が定義されています。任意の値を使用してサービスIDを作成します。

proxyHost

オプション。プロキシ・サーバーのホスト名またはIPアドレスを示します。

プロキシは、WebCenter Portalアプリケーションおよびリモート・ポートレット・プロデューサがファイアウォールで離れている場合には、必要です。HTTPプロキシは、プロデューサと通信するために必要です。

proxyPort

オプション。プロキシ・サーバーのリスン先のポート番号を示します。

subscriberId

オプション。必要に応じて、コンシューマの識別子を示します。

アプリケーションにプロデューサを登録すると、プロデューサに呼出しが行われます。コール中、コンシューマが(このインスタンスの場合は、WebCenter Portalアプリケーション)サブスクライバIDの値をプロデューサに渡します。プロデューサは、サブスクライバIDの希望する値を表示しない場合、登録の呼出しを拒否する可能性があります。

sharedKey

オプション。共有キーを使用して、リモート・プロデューサのメッセージを認証します。メッセージを認証すると、受信メッセージが共有キーを持つホストから送信されます。sharedKey引数およびestablishSession引数を使用してセッションを有効にする必要があります。

timeout

オプション。プロデューサと通信するために秒の単位で指定するタイムアウトを示します。たとえば、プロデューサによってWebCenter Portalページ上にポートレットを登録、登録解除および表示するために必要な最大時間です。

個々のポートレットは、その自体のタイムアウト時間を定義する場合があります。このタイムアウト値は、ここで指定されている値よりも優先されます。

establishSession

オプション。このプロデューサからポートレットを実行するときには、ユーザー・セッションを有効にします。有効な値は、1 (true)および0 (false)です。establishSession引数およびsharedKey引数を使用してセッションを有効にする必要があります。

セッションを有効に(1に設定)すると、サーバーでは、ユーザー名などセッション固有の情報が保持されます。セッションを使用してメッセージを認証するので、共有キーが指定されている場合、このオプションも有効に設定する必要があります。プロデューサとサーバーの間でセッションレス通信を行う場合は、0に設定します。

externalApp

オプション。このプロデューサに関連付けられる外部アプリケーションの名前を示します。

mapUser

オプション。外部アプリケーションからマップしたユーザー名をプロデューサに渡す必要があるかどうかを示すフラグ。有効な値は、1 (true)および0 (false)です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、プロキシ・サーバーを使用するためにMyAppに登録されたPDK-Javaプロデューサを変更します。

wls:/weblogic/serverConfig> setPDKJavaProducer(appName='MyApp',
name='MyProducer', url='http://myhost.com/jpdk/providers/sample',
proxyHost='myproxy.com', proxyPort=80)

deregisterPDKJavaProducer

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle PDK-Javaプロデューサを登録解除し、指定したWebCenter Portalアプリケーションの関連付けられている接続を削除します。

構文

deregisterPDKJavaProducer(appName, name, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のPDK-Javaプロデューサの名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、wc-WebClippingプロデューサを登録解除し、関連付けられる接続を削除します。

wls:/weblogic/serverConfig> deregisterPDKJavaProducer(appName='webcenter',
name='wc-WebClipping')
Already in Domain Runtime Tree
Producer wc-WebClipping has been deregistered.
Already in Domain Runtime Tree
"wc-WebClipping" successfully deleted
Already in Domain Runtime Tree
"wc-WebClipping-urlconn" successfully deleted

listPDKJavaProducers

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションに登録された1つまたは複数のOracle PDK-Javaプロデューサの詳細を一覧表示します。

構文

listPDKJavaProducers(appName, [name],[verbose], [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

オプション。既存のPDK-Javaポートレット・プロデューサの名前を示します。指定しない場合、このWebCenter Portalアプリケーションに対して構成されているすべてのPDK-Javaプロデューサの接続詳細が一覧表示されます。

verbose

オプション。PDK-Javaプロデューサの接続に関する詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listPDKJavaProducersによって、すべての接続プロパティが表示されます。0に設定した場合、listPDKJavaProducersによって、接続名のみが一覧表示されます。この引数のデフォルトは、1です。

この引数を0に設定した場合、name引数を指定しないでください。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、JPDKSamplesプロデューサのすべての接続プロパティ(冗長モード)を表示します。

wls:/weblogic/serverConfig> listPDKJavaProducers(appName='webcenter',
name='JPDKSamples', verbose=1)
----------------------
wc-WebClipping
----------------------
Service Id: None
Shared Key: None
External Application Id: None
Subscriber Id: None
URL: http://myhost.com:9999/portalTools/webClipping/providers/webClipping
----------------------
wc-OmniPortlet
----------------------
Service Id: None
Shared Key: None
External Application Id: None
Subscriber Id: None
URL: http://myhost:9999/portalTools/omniPortlet/providers/omniPortlet

registerPageletProducer

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションに、ページレット・プロデューサを登録します。

構文

registerPageletProducer(appName, name, url, [server, applicationVersion])

引数

定義

appName

この操作を実行する対象のWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

ここで指定する名前は、デフォルトではComposer (Mash-ups >Pagelet Producersフォルダの下)に表示されます。

url

WebCenter Portalのページレット・プロデューサへのアクセスに必要なURL。次の構文を使用します。

protocol://host.domain:port_number/pagelets

URLには、完全修飾ドメイン名を含める必要があります。例:

http://myhost.example.com:7778/pagelets

ページレットがセキュアなデータを伝送する場合、登録されるURLはhttpsプロトコルを使用する必要があります。例:

https://myhost.com:7779/pagelets

注意: Spacesアプリケーションでは、ページレット・プロデューサURLがOracle Access Management Access Managerによって保護されている場合、ページレット・カタログのURLを除外する(アクセス制御を使用しないで直接マップする)必要があります。そのようにしない場合、RESTを使用したときにカタログが空で表示されます。ページレット・カタログURLは、http://<proxy_host>:<proxy_port>/api/v2/ensemble/pageletsです。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のアプリケーションにページレット・プロデューサを登録します。

wls:/weblogic/serverConfig> registerPageletProducer(appName='webcenter',
name='MyPageletProducer', url='http://myhost.com:7001/pagelets')

setPageletProducer

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

既存のページレット・プロデューサの接続詳細を編集します。

構文

setPageletProducer(appName, name, [url, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のページレット・プロデューサ接続の名前。

url

オプション。WebCenter Portalのページレット・プロデューサへのアクセスに必要なURL。次の構文を使用します。

protocol://host.domain:port_number/pagelets

URLには、完全修飾ドメイン名を含める必要があります。例:

http://myhost.example.com:7778/pagelets

注意: Spacesアプリケーションでは、ページレット・プロデューサURLがOracle Access Management Access Managerによって保護されている場合、ページレット・カタログのURLを除外する(アクセス制御を使用しないで直接マップする)必要があります。そのようにしない場合、RESTを使用したときにカタログが空で表示されます。ページレット・カタログURLは、http://<proxy_host>:<proxy_port>/api/v2/ensemble/pageletsです。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MyPageletProducerという名前の既存のページレット・プロデューサの管理者ユーザー名およびパスワード詳細を更新します。

wls:/weblogic/serverConfig> setPageletProducer(appName='webcenter',
name='MyPageletProducer', url='http://mypagelethost.com:7778/pagelets')

listPageletProducers

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションに登録されている1つまたはすべてのページレット・プロデューサの接続詳細を一覧表示します。

構文

listPageletProducers(appName, [name],[verbose], [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

オプション。既存のページレット・プロデューサ接続の名前。この引数を使用して、特定のページレット・プロデューサの接続詳細を表示します。

指定しない場合、このWebCenter Portalアプリケーションに対して構成されているページレット・プロデューサすべての接続詳細が一覧表示されます。

verbose

オプション。ページレット・プロデューサの接続詳細を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listPageletProducersによって、すべての接続プロパティが一覧表示されます。0に設定した場合、listPageletProducersによって、接続名のみが一覧表示されます。この引数のデフォルトは、1です。

この引数を0に設定した場合、name引数を指定しないでください。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MyWebCenterAppという名前のWebCenter Portalアプリケーションに対して現在登録されているすべてのページレット・プロデューサの接続名および詳細を一覧表示します。

wls:/weblogic/serverConfig> listPageletProducers(appName='MyWebCenterApp', verbose=1)
----------------------
MyPageletProducer
----------------------
URL: http://myhost.com:7001/pagelets
----------------------
TestPageletProducer
----------------------
URL: http://testhost.com:7002/pagelets
----------------------

次の例では、MyPageletProducerという名前の1つのページレット・プロデューサ接続の詳細を表示します。

wls:/weblogic/serverConfig> listPageletProducers(appName='webcenter',
name='MyPageletProducer', verbose=1)
----------------------
MyPageletProducer
----------------------
URL: http://myhost.com:7001/pagelets

deregisterPageletProducer

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーションに現在登録されているページレット・プロデューサを登録解除します。

構文

deregisterPageletProducer(appName, name, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のページレット・プロデューサ接続の名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MyWebCenterAppという名前のWebCenter Portalアプリケーションに対して現在構成されているMyPageletProducerという名前のページレット・プロデューサ接続を登録解除します。

wls:/weblogic/serverConfig> deregisterPageletProducer(appName='MyWebCenterApp',
name='MyPageletProducer')

refreshProducer

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

名前付きのプロデューサによって提供されたポートレットが反映されるようにそのプロデューサに対して格納したメタデータを最新の状態にします。

構文

refreshProducer(appName, producerName, [server, applicationVersion])

引数

定義

appName

プロデューサが登録されているWebCenter Portalアプリケーションの名前。

producerName

既存のプロデューサの名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、webcenterという名前のアプリケーション内のWSRPSamplesプロデューサを最新の状態にします。

wls:/weblogic/serverConfig> refreshProducer(appName='webcenter',
producerName='WSRPSamples')
Producer WSRPSamples has been refreshed.

registerOOTBProducers

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle WebCenterで提供されているいくつかの初期状態のプロデューサ(OmniPortlet、Web ClippingおよびWSRP Tools)を登録します。

構文

registerOOTBProducers(producerHost, producerPort, appName, [server,
applicationVersion])

引数

定義

producerHost

初期状態のプロデューサをホストするサーバーのホスト名およびIPアドレスを示します。

ロード・バランサによってフロント処理されるクラスタでは、そのロード・バランサのホスト名を入力します。

producerPort

初期状態のプロデューサをホストするサーバーのポート番号を示します。

ロード・バランサによってフロント処理されるクラスタでは、そのロード・バランサのポート番号を入力します。

appName

初期状態のプロデューサを登録するWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myAppという名前のWebCenter Portalアプリケーションに初期状態のプロデューサを登録します。

wls:/weblogic/serverConfig> registerOOTBProducers(producerHost='myhost.com',
producerPort=9999, appName='myApp')

Registering Out-of-the-Box Producers
Registering producers at http://myhost.com:9999

Registering Omniportlet
Created connection wc-OmniPortlet-urlconn
Created connection wc-OmniPortlet
Producer connection wc-OmniPortlet has been registered.

Registering WebClipping
Created connection wc-WebClipping-urlconn
Created connection wc-WebClipping
Producer connection wc-WebClipping has been registered.

Registering WSRP Tools
Created connection wc-WSRPTools-wsconn
Created connection wc-WSRPTools
Producer connection wc-WSRPTools has been registered.

deregisterOOTBProducers

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle WebCenterで提供されている初期状態のプロデューサ(OmniPortlet、Web ClippingおよびWSRP Tools)を登録解除します。

構文

deregisterOOTBProducers(appName, [server, applicationVersion])

引数

定義

appName

初期状態のプロデューサが現在登録されているWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、初期状態のWebCenter Portalプロデューサを登録解除し、myAppという名前のアプリケーション内のそれらに関連付けられている接続を削除します。

wls:/weblogic/serverConfig> deregisterOOTBProducers(appName='myApp')

Deregistering Out-of-the-Box Producers

Deregistering Omniportlet
Producer wc-OmniPortlet has been deregistered.
wc-OmniPortlet successfully deleted
wc-OmniPortlet-urlconn successfully deleted

Deregistering WebClipping
Producer wc-WebClipping has been deregistered.
wc-WebClipping successfully deleted
wc-WebClipping-urlconn successfully deleted

Deregistering WSRP Tools
Producer wc-WSRPTools has been deregistered.
wc-WSRPTools successfully deleted
wc-WSRPTools-wsconn successfully deleted

registerSampleProducers

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle WebCenterで提供されているサンプル・プロデューサを、指定したWebCenter Portalアプリケーションに登録します。WSRPサンプル およびJPDKサンプルの2つのサンプル・プロデューサがあります。

構文

registerSampleProducers(producerHost, producerPort, appName, [server,
applicationVersion])

引数

定義

producerHost

サンプル・プロデューサをホストするサーバーのホスト名およびIPアドレスを示します。

producerPort

サンプル・プロデューサをホストするサーバーのポート番号を示します。

appName

サンプル・プロデューサを登録するWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、Oracle WebCenterのサンプル・プロデューサをmyAppという名前のアプリケーションに登録します。

wls:/weblogic/serverConfig> registerSampleProducers(producerHost='myhost.com',
producerPort=9999, appName='myApp')

deregisterSampleProducers

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle WebCenterサンプル・プロデューサ(WSRP SamplesおよびJPDK Samples)を、指定したWebCenter Portalアプリケーションから登録解除します。

構文

deregisterSampleProducers(appName, [server, applicationVersion])

引数

定義

appName

サンプル・プロデューサが現在登録されているWebCenter Portalアプリケーションの名前。値を指定しない場合、この引数のデフォルトは、webcenterです。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myAppという名前のWebCenter Portalアプリケーションからサンプル・プロデューサを登録解除します。

wls:/weblogic/serverConfig> deregisterSampleProducers(appName='myApp')

RSSニュース・フィード

表10-22に示すコマンドを使用して、RSSサービスのプロキシ設定を管理します。

これらのWebCenter Portal WLSTコマンドを使用して行った構成変更は、WebCenter Portalアプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

表10-22 RSS WLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

getRssProxyConfig

RSSサービスによって使用されるプロキシ・ホストおよびプロキシ・ポートを返します。

オンライン

setRssProxyConfig

RSSサービスによって使用されるプロキシ・ホストおよびプロキシ・ポートを指定します。

オンライン

unsetRssProxyConfig

プロキシ・ホストおよびプロキシ・ポート設定を削除します。

オンライン

getRssProxyConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

RSSサービスによって使用されるプロキシ・ホストおよびプロキシ・ポートを返します。ネットワーク構成によっては、ご使用のWebCenter Portalアプリケーションで外部RSSニュース・フィードを表示するために、プロキシ詳細が必要な場合があります。

構文

getRssProxyConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、RSSサービスによって使用されるプロキシ・ホストおよびプロキシ・ポートを、webcenterという名前のWebCenter Portalアプリケーションに返します。

wls:/weblogic/serverConfig> getRssProxyConfig(appName='webcenter')

setRssProxyConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

RSSサービスのプロキシ・ホストおよびプロキシ・ポートを指定します。ネットワーク構成によっては、ご使用のWebCenter Portalアプリケーションで外部RSSニュース・フィードを表示するために、プロキシ詳細が必要な場合があります。

構文

setRssProxyConfig(appName, proxyHost, proxyPort, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

proxyHost

プロキシ・サーバーのホスト名を示します。

proxyPort

プロキシ・サーバーが実行しているポートを示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のWebCenter Portalアプリケーションで、RSSサービスによって使用されるプロキシ・ホストおよびプロキシ・ポートを設定します。

wls:/weblogic/serverConfig> setRssProxyConfig(appName='webcenter',
proxyHost='www-proxy.example.com', proxyPort='80')

unsetRssProxyConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

現在のプロキシ・ホストおよびプロキシ・ポート設定を削除します。

構文

unsetRssProxyConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のWebCenter Portalアプリケーションの、RSSサービスによって使用されるプロキシ・ホストおよびプロキシ・ポート設定を削除します。

wls:/weblogic/serverConfig> unsetRssProxyConfig(appName='webcenter')

検索 - Oracle SES検索

表10-23に示すコマンドを使用して、WebCenter PortalアプリケーションのためのOracle Secure Enterprise Search (SES)接続および他のOracle SES検索関連プロパティを管理します。

これらのWebCenter Portal WLSTコマンドを使用して行った構成変更は、WebCenter Portalアプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

表10-23 検索 - Oracle SES WLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

createSESConnection

WebCenter Portalアプリケーション用のOracle SESインスタンスへの接続を作成します。

オンライン

setSESConnection

既存のOracle SES検索接続を編集します。

オンライン

listSESConnections

特定のWebCenter Portalアプリケーションに対して構成されている個々またはすべてのOracle SES検索接続を一覧表示します。

オンライン

setSearchSESConfig

既存のOracle SES検索接続の検索設定を構成します。

オンライン

listSearchSESConfig

WebCenter Portalアプリケーション用のOracle SESプロパティを一覧表示します。

オンライン

createFederationTrustedEntity

Oracle (SES)インスタンス上にフェデレーション・トラステッド・エンティティを作成します。

オンライン

createSESConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter PortalアプリケーションのOracle Secure Enterprise Search (SES)インスタンスへの接続を作成します。

構文

createSESConnection(appName, name, url, appUser, appPassword,[default],
[server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

url

Oracle Secure Enterprise Searchによって検索の要求を有効にするためにエクスポーズしたWebサービスのURLを示します。

使用するフォーマットは、http://<host>:<port>/search/query/OracleSearchです。

appUser

WebCenter Portalユーザーのかわりに検索を実行できるよう、Oracle Secure Enterprise Searchに対して信頼されるアプリケーションとして自身を認証するために、WebCenter Portalアプリケーションで使用するユーザー名。

指定されたユーザーは、WebCenter Portalアプリケーション用に構成されたOracle Identity ManagementサーバーおよびOracle SES用に構成されたOracle Identity Managementサーバーの両方に存在する必要があります。

appPassword

指定したユーザーのパスワードを示します。

default

オプション。検索接続を積極的に使用するためにWebCenter Portal検索サービスを構成します。有効なオプションは、1 (true)および0 (false)です。

1に設定すると、使用されているその他の検索接続が置き換えられます。0に設定すると、現在の検索サービス構成は変更されません。この引数のデフォルトは、0です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、SESインスタンスhttp://myhost.com:7777/search/query/OracleSearchを指す新しい検索接続を作成し、この接続を、app1という名前のWebCenter PortalアプリケーションのアクティブなSES検索接続として設定します。

wls:/weblogic/serverConfig> createSESConnection(appName='app1', name='SESConn1',
url='http://myhost.com:7777/search/query/OracleSearch', appUser='wpadmin',
appPassword='password', default=1)

setSESConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

既存のOracle Secure Enterprise Search (SES)検索接続を編集します。

構文

setSESConnection(appName, name, [url], [appUser],[appPassword],[default],
[server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存の検索接続の名前を示します。

url

オプション。Oracle Secure Enterprise Searchによって検索の要求を有効にするためにエクスポーズしたWebサービスのURLを示します。

使用するフォーマットは、http://<host>:<port>/search/query/OracleSearchです。

appUser

オプション。WebCenter Portalユーザーのかわりに検索を実行できるよう、WebCenter PortalアプリケーションでOracle Secure Enterprise Searchにログインするために使用するユーザー名。

appPassword

オプション。WebCenter Portalユーザーのかわりに検索を実行できるよう、WebCenter PortalアプリケーションでOracle Secure Enterprise Searchにログインするために使用するパスワード。

default

オプション。検索接続を積極的に使用するためにWebCenter Portal検索サービスを構成します。有効なオプションは、1 (true)および0 (false)です。

1に設定すると、使用されているその他の検索接続が置き換えられます。0に設定すると、現在の検索サービス構成は変更されません。この引数のデフォルトは、0です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、SESConn1という名前の検索接続のURLを変更し、この接続をapp1という名前のWebCenter PortalアプリケーションのアクティブなSES検索接続として設定します。

wls:/weblogic/serverConfig> setSESConnection(appName='app1', name='SESConn1',
url='http://myhost.com:7777/search/query/OracleSearch', appUser='wpadmin',
appPassword='password', default=1)

listSESConnections

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalアプリケーションに対して構成されているすべてのOracle Secure Enterprise Search (SES)検索接続の名前を一覧表示します。

構文

listSESConnections(appName, [verbose], [name], [server], [applicationVersion])

引数

定義

appName

この操作を実行する対象のWebCenter Portalアプリケーションの名前。

verbose

オプション。検索接続に関する詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listSESConnectionsによって、WebCenter Portalアプリケーションに対して構成されているすべてのSES検索接続およびその詳細が一覧表示されます。0に設定した場合、listSESConnectionsによって、接続名のみ一覧表示されます。この引数のデフォルトは、0です。

この引数を0に設定した場合、name引数を指定しないでください。

name

オプション。既存の検索接続の名前を示します。この引数を使用して、特定の接続の詳細情報を表示できます。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenterAppという名前のWebCenter Portalアプリケーションに対して構成されているすべてのSES検索接続の接続詳細を表示します。

wls:/weblogic/serverConfig> listSESConnections(appName='WebCenterApp', verbose=1)

次の例では、SESConn1という名前のSES検索接続の接続詳細を表示します。

wls:/weblogic/serverConfig> listSESConnections(appName='WebCenterApp',
verbose=1, name='SESConn1')

setSearchSESConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

既存のOracle Secure Enterprise Search (SES)検索接続の検索設定を設定します。パラメータを指定しない場合、検索設定が変更されません。

構文

setSearchSESConfig(appName,[connectionName],[dataGroup],[topNRows], [server],
[applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

connectionName

オプション。検索サービスで使用する必要がある検索接続の名前を指定します。

dataGroup

オプション。検索を行うSecure Enterpriseの検索データ・グループの名前を指定します。値を指定しない場合、Oracle Secure Enterprise Searchインスタンス中のすべての項目が検索されます。

topNRows

オプション。調整されたデータを収集するために検索結果の一番上のN行数を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、検索サービスがSESConn1という名前のSES検索接続を使用してgroup2という名前のデータ・グループを検索することを指定します。

wls:/weblogic/serverConfig> setSearchSESConfig
(appName='webcenter',connectionName='SESConn1', dataGroup='group2',
topNRows=200);

次の例は、検索サービスにより返される検索結果の最大数を変更します。この例では、接続の名前が指定されていないので、設定に関する変更が現在のデフォルト(またはアクティブ)接続に適用されます。

wls:/weblogic/serverConfig> setSearchSESConfig(appName='webcenter', topNRows=500);
Already in Domain Runtime Tree
Restart is needed for the service connection changes to take effect.

listSearchSESConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter PortalアプリケーションのSES検索設定を一覧表示します。

構文

listSearchSESConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行する対象のWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のWebCenter PortalアプリケーションのSES検索構成情報を表示します。

wls:/weblogic/serverConfig> listSearchSESConfig(appName='webcenter')
Already in Domain Runtime Tree
-----------------
Search SES Config
-----------------
connectionName:  SESConn1
dataGroup:  group2
topNRows:  200

createFederationTrustedEntity

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定されたエンティティ名およびパスワードに対するフェデレーション・トラステッド・エンティティをOracle Secure Enterprise Search (SES)インスタンス上に作成します。

構文

createFederationTrustedEntity(appName, sesUrl, sesPassword, entityName, entityPassword, desc,  [server], [applicationVersion])

引数

定義

appName

この操作を実行する対象のWebCenter Portalアプリケーションの名前。

sesUrl

Oracle SES管理APIのWebサービスURL。

http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

entityName

エンティティ名。

entityPassword

エンティティ・パスワード。

desc

エンティティの簡単な説明。

または、空の文字列''を指定します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myentityという名前のフェデレーション・トラステッド・エンティティをOracle SESインスタンスhttp://myseshost.com:7777上に作成します。

wls:/weblogic/serverConfig> createFederationTrustedEntity(appName='webcenter',
sesUrl='http://myseshost.com:7777/search/api/admin/AdminService',
sesPassword='password', entityName='myentity', entityPassword='password', desc='This is a sample entity')

検索 - Oracle SES検索クローラ

表10-24に示すコマンドを使用して、WebCenter PortalアプリケーションのOracle Secure Enterprise Search (SES)クローラを管理します。

クローラWLSTコマンドを実行した後に、WebCenter Portalアプリケーションを再起動する必要はありません。

表10-24 検索 - Oracle SESクローラWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

createSpacesCrawler

Oracle SESインスタンス上にSpacesオブジェクトのクローラを作成します。

オンライン

createDocumentsCrawler

WebCenter Portalアプリケーション用のドキュメント・クローラをOracle SESインスタンス上に作成します。

オンライン

createDiscussionsCrawler

WebCenter Portalアプリケーション用のディスカッション・クローラとお知らせクローラをOracle SESインスタンス上に作成します。

オンライン

listSpacesCrawler

Oracle SESインスタンス上でSpacesアプリケーションに対して構成されているSpacesクローラを返します。

オンライン

listDocumentsCrawler

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているドキュメント・クローラを返します。

オンライン

listDiscussionsCrawler

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを返します。

オンライン

startSpacesCrawler

Oracle SESインスタンス上でSpacesアプリケーションに対して構成されているSpacesクローラを起動します。

オンライン

startDocumentsCrawler

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているドキュメント・クローラを起動します。

オンライン

startDiscussionsCrawler

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを起動します。

オンライン

stopSpacesCrawler

Oracle SESインスタンス上でSpacesアプリケーションに対して構成されているSpacesクローラを停止します。

オンライン

stopDocumentsCrawler

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているドキュメント・クローラを停止します。

オンライン

stopDiscussionsCrawler

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを停止します。

オンライン

deleteSpacesCrawler

Oracle SESインスタンス上でSpacesアプリケーションに対して構成されているSpacesクローラを削除します。

オンライン

deleteDocumentsCrawler

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているドキュメント・クローラを削除します。

オンライン

deleteDiscussionsCrawler

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを削除します。

オンライン

createSpacesCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上にSpacesオブジェクトのクローラを作成します。このコマンドは、WebCenter Portalデータソースを作成し、Spacesオブジェクト(スペース、リスト、ページ、ピープルなど)をクロールするためのスケジュールを指定します。

構文

createSpacesCrawler(appName,  host, port, sesUrl, sesPassword, crawlUser,
crawlPassword, scratchDir, authUserIdFormat, crawlingMode, recrawlPolicy,
freqType, startHour, hoursBetweenLaunches, startDayOfWeek, startDayOfMonth,
daysBetweenLaunches, weeksBetweenLaunches, monthsBetweenLaunches, [server,
applicationVersion])

引数

定義

appName

この操作を実行するSpacesアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

host

Spacesアプリケーションを実行しているマシンのホスト名。

port

Spacesアプリケーションにアクセスするために使用されるポート番号。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

crawlUser

Spacesアプリケーションのクロール管理ユーザー。

このユーザーは、Spacesアプリケーションとバックエンドのアイデンティティ管理サーバーに存在する必要があり、適切なパーミッションとロールが付与されている必要があります。たとえば、mycrawladminです。

crawlPassword

crawlUser引数で指定されているSpacesユーザーのパスワード。

scratchDir

Oracle SESが一時ステータス・ログを書き込めるローカル・ディレクトリ。このディレクトリは、Oracle SESがインストールされているシステム上に存在する必要があります。

authUserIdFormat

アクティブ・アイデンティティ・プラグインのユーザーIDの形式。たとえば、ユーザー名、電子メール、ニックネーム、user_name。

crawlingMode

ソース内のURLをクロールするためのモード。デフォルト・モードは、ACCEPT_ALLです。有効な値は、ACCEPT_ALL、INDEX_ONLY、EXAMINE_URLです。

ACCEPT_ALL: 索引付けのためにすべてのURLを自動的に受け入れます。ソース内のすべてのURLをクロールおよび索引付けします。それらのURL内で見つかったすべてのリンクの抽出および索引付けも行います。前にクロールされたURLは、それらが変更されていた場合にのみ再索引付けされます。

EXAMINE_URL: 索引付けする前にURLを確認します。ソース内のすべてのURLをクロールしますが、索引付けは行いません。それらのURL内で見つかったすべてのリンクのクロールも行います。

INDEX_ONLY: 索引付けのみ行います。ソース内のすべてのURLをクロールし、索引付けします。それらのURL内で見つかったどのリンクも抽出しません。このオプションは、前にEXAMINE_URLを使用してクロールされたソースに対して選択します。

recrawlPolicy

すべてのドキュメントをクロールするか、変更されたドキュメントのみクロールするのかを指定します。有効な値は、PROCESS_ALLおよびPROCESS_CHANGEDです。

PROCESS_ALL - すぺてのドキュメントがクロールされます。このオプションは、フル・クロールを強制するために使用します。

PROCESS_CHANGED - 前回のクロール以降に変更されたドキュメントのみクロールします。この設定で、クローリング・プロセスを大幅に高速化できます。

freqType

スケジュール済クロールの頻度。有効な値は、MANUAL、MONTHLY、WEEKLY、DAILY、HOURLYです。

クロールをMONTHLY、WEEKLY、DAILYまたはHOURLYにスケジュールするには、追加の引数を次のように指定します。

MONTHLY: startHour、startDayOfTheMonth、monthsBetweenLaunches

WEEKLY: startHour、startDayOfTheWeek、weeksBetweenLaunches

DAILY: startHour、daysBetweenLaunches

HOURLY: hoursBetweenLaunches

定期的なクロールが不要な場合は、MANUALを選択し、startSpacesCrawlerコマンドを使用して、クロールを手動で開始します。

startHour

クロールを開始する時刻。1と24の間の任意の数字。

たとえば、2:00amであれば2、2:00pmであれば14を入力します。

hoursBetweenLaunches

クロール間の時間数。

freqType='HOURLY'の場合にのみ有効です。

startDayOfWeek

週ごとのクロールを開始する曜日。たとえば、MONDAY、TUESDAYなどです。

freqType='WEEKLY'の場合にのみ有効です。

startDayOfMonth

月ごとのクロールを開始する日。たとえば、1日の場合は1、2日の場合は2のように入力します。

freqType='MONTHLY'の場合にのみ有効です。

daysBetweenLaunches

クロール間の日数。

freqType='DAILY'の場合にのみ有効です。

weeksBetweenLaunches

クロール間の週数。

freqType='WEEKLY'の場合にのみ有効です。

monthsBetweenLaunches

クロール間の月数。

freqType='MONTHLY'の場合にのみ有効です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してSESインスタンスhttp://myseshost.com:7777上にSpacesクローラを作成します。

createSpacesCrawler(appName='webcenter', host='myhost.com', port='8888',
sesUrl='http://myseshost.com:7777/search/api/admin/AdminService',
sesPassword='sespassword', crawlUser='mycrawladmin', crawlPassword='password',
scratchDir'/tmp', authUserIdFormat='username', crawlingMode='ACCEPT_ALL',
recrawlPolicy= 'PROCESS_ALL', freqType='MANUAL', startHour=1,
hoursBetweenLaunches=1, startDayOfWeek='MONDAY', startDayOfMonth=1, daysBetweenLaunches =1, weeksBetweenLaunches=1, monthsBetweenLaunches=1)

createDocumentsCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalアプリケーション用のドキュメント・クローラをOracle SESインスタンス上に作成します。

このコマンドは、Oracle WebCenter Contentリポジトリ・データソースを作成し、Oracle WebCenter Contentリポジトリ内のドキュメントをクロールするスケジュールを指定します。

構文

createDocumentsCrawler(appName,  host, port, sesUrl, sesPassword, configUrl,
user, password, scratchDir, httpEndpoint, displayUrl, realm, authUserIdFormat,
pipelineName, crawlingMode, recrawlPolicy, freqType, startHour,
hoursBetweenLaunches, startDayOfWeek, startDayOfMonth,
daysBetweenLaunches, weeksBetweenLaunches, monthsBetweenLaunches,
[server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

host

WebCenter Portalアプリケーションを実行しているマシンのホスト名。

port

WebCenter Portalアプリケーションにアクセスするために使用されるポート番号。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

configUrl

データ・フィード・タイプ、場所、セキュリティ属性などソースの詳細を提供するXML構成ファイルのURL。http://<host>:<port>/cs
/idcplg? IdcService=SES_CRAWLER_DOWNLOAD_CONFIG
&source=<sourcename>のURL形式を使用します。

user

Oracle WebCenter ContentのContent Serverの管理ユーザー。たとえば、sysadminです。

認証タイプがOracle SSOである場合、Oracle SSOによってフロント処理されているアイデンティティ管理サーバーにユーザーのユーザーID(およびパスワード)を入力します。このユーザーには、sysadminと同じパーミッションを付与する必要があります。それらのパーミッションを付与できない場合は、Content Serverでこのユーザーに対応するリモート・ユーザーを削除し、Content Serverにそのユーザー(同じ名前)のローカル・バージョンを作成します。

password

指定した管理ユーザーのパスワード。

scratchDir

Oracle SESが一時ステータス・ログを書き込めるローカル・ディレクトリ。このディレクトリは、Oracle SESがインストールされているシステム上に存在する必要があります。

httpEndpoint

コンテンツ・サーバー認可のためのHTTPエンドポイント。例: http://<host>:<port>/idc/idcplg

displayUrl

相対アクセスURLの前に付けて完全な表示URLを形成するHTTPホスト情報文字列。例: http://<host>:<port>/idc

realm

制御およびデータ・フィードを提供するアプリケーションのレルム。このパラメータは、フィードにHTTPを介してアクセスしている場合に適しており、認証タイプがBASICである場合に必須です。

たとえば、jazn.comです。

authUserIdFormat

Content Server認可APIによって使用される(アクティブ・アイデンティティ・プラグイン内の)ユーザーIDの形式。たとえば、ユーザー名、電子メール、ニックネーム、user_name。

pipelineName

Oracle SES内で、このソースに対して作成されるドキュメント・サービス・パイプライン。

crawlingMode

ソース内のURLをクロールするためのモード。デフォルト・モードは、ACCEPT_ALLです。有効な値は、ACCEPT_ALL、INDEX_ONLY、EXAMINE_URLです。

ACCEPT_ALL: 索引付けのためにすべてのURLを自動的に受け入れます。ソース内のすべてのURLをクロールおよび索引付けします。それらのURL内で見つかったすべてのリンクの抽出および索引付けも行います。前にクロールされたURLは、それらが変更されていた場合にのみ再索引付けされます。

EXAMINE_URL: 索引付けする前にURLを確認します。ソース内のすべてのURLをクロールしますが、索引付けは行いません。それらのURL内で見つかったすべてのリンクのクロールも行います。

INDEX_ONLY: 索引付けのみ行います。ソース内のすべてのURLをクロールし、索引付けします。それらのURL内で見つかったどのリンクも抽出しません。このオプションは、前にEXAMINE_URLを使用してクロールされたソースに対して選択します。

recrawlPolicy

すべてのドキュメントをクロールするか、変更されたドキュメントのみクロールするのかを指定します。有効な値は、PROCESS_ALLおよびPROCESS_CHANGEDです。

PROCESS_ALL - すぺてのドキュメントがクロールされます。このオプションは、フル・クロールを強制するために使用します。

PROCESS_CHANGED - 前回のクロール以降に変更されたドキュメントのみクロールします。この設定で、クローリング・プロセスを大幅に高速化できます。

freqType

スケジュール済クロールの頻度。有効な値は、MANUAL、MONTHLY、WEEKLY、DAILY、HOURLYです。

クロールをMONTHLY、WEEKLY、DAILYまたはHOURLYにスケジュールするには、追加の引数を次のように指定します。

MONTHLY: startHour、startDayOfTheMonth、monthsBetweenLaunches

WEEKLY: startHour、startDayOfTheWeek、weeksBetweenLaunches

DAILY: startHour、daysBetweenLaunches

HOURLY: hoursBetweenLaunches

定期的なクロールが不要な場合は、MANUALを選択し、startDocumentsCrawlerコマンドを使用して、クロールを手動で開始します。

startHour

クロールを開始する時刻。1と24の間の任意の数字。

たとえば、2:00amであれば2、2:00pmであれば14を入力します。

hoursBetweenLaunches

クロール間の時間数。

freqType='HOURLY'の場合にのみ有効です。

startDayOfWeek

週ごとのクロールを開始する曜日。たとえば、MONDAY、TUESDAYなどです。

freqType='WEEKLY'の場合にのみ有効です。

startDayOfMonth

月ごとのクロールを開始する日。たとえば、1日の場合は1、2日の場合は2のように入力します。

freqType='MONTHLY'の場合にのみ有効です。

daysBetweenLaunches

クロール間の日数。

freqType='DAILY'の場合にのみ有効です。

weeksBetweenLaunches

クロール間の週数。

freqType='WEEKLY'の場合にのみ有効です。

monthsBetweenLaunches

クロール間の月数。

freqType='MONTHLY'の場合にのみ有効です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上にドキュメント・クローラを作成します。

createDocumentsCrawler(appName='webcenter', host='myhost.com', port='8888',
sesUrl='http://myseshost.com:7777/search/api/admin/AdminService',
sesPaswword='password',
configUrl='http://myucmhost.com:9044/cs/idcplg?IdcService=SES_CRAWLER_DOWNLOAD_ CONFIG&source=mysource',
user='adminuser', password='password', scratchDir='/scratch',
httpEndpoint='http://myucmhost.com:9044/cs/idcplg',
displayUrl='http://myucmhost:9044/cs', realm='jazn.com', authUserIdFormat='username',
pipelineName='My UCM Pipeline', crawlingMode='ACCEPT_ALL',
recrawlPolicy='PROCESS_ALL', freqType='MANUAL', startHour=1,
hoursBetweenLaunches=1, startDayOfWeek='MONDAY', startDayOfMonth=1,
daysBetweenLaunches=1, weeksBetweenLaunches=1, monthsBetweenLaunches=1)

createDiscussionsCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle Secure Enterprise Search (SES)インスタンス上で、WebCenter Portalアプリケーションに対してディスカッション・フォーラム・クローラおよびお知らせクローラを作成します。

このコマンドは、2つのOracle SESデータベース・ソース(ディスカッション・フォーラム用に1つと、お知らせ用に1つ)を作成し、クロール・スケジュールを指定します。ディスカッション・フォーラム・ソースは、<appname_host_port>_forumsという名前で、FORUMCRAWLER_VWというビューがあり、お知らせソースは<appname_host_port>_announcementsという名前で、ANNOUNCEMENTS_VWというビューがあります。

構文

createDiscussionsCrawler(appName,  host, port, sesUrl, sesPassword,
dbConnString, user, password, authUserIdFormat, crawlingMode,
recrawlPolicy, freqType, startHour, hoursBetweenLaunches, startDayOfWeek,
startDayOfMonth, daysBetweenLaunches, weeksBetweenLaunches,
monthsBetweenLaunches, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

host

WebCenter Portalアプリケーションを実行しているマシンのホスト名。

port

WebCenter Portalアプリケーションにアクセスするために使用されるポート番号。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

dbConnString

WebCenter Portalのディスカッション・サーバーがインストールされているデータベースの接続URL。次の形式を使用します。

Oracle: jdbc:oracle:thin:@<host>:<port>/<oracle-sid>

IBM DB2: jdbc:db2://<host>:<port>/<database_name>

Microsoft SQL Server: jdbc:sqlserver://<host_or_IP_address>:<port>/<database_name>

user

WebCenter Portalのディスカッション・サーバーがインストールされているデータベースの管理ユーザー。

Oracle: WebCenter Portalのディスカッション・サーバーのインストール中にユーザーMyPrefix_DISCUSSIONS_CRAWLERが作成されます。

IBM DB2: WebCenter Portalのディスカッション・サーバーのインストール中にユーザーMyPrefix_DCが作成されます(MyPrefixは5文字です)。

Microsoft SQL Server: WebCenter Portalのディスカッション・サーバーのインストール中にユーザーMyPrefix_DISCUSSIONS_CRAWLERが作成されます。

password

指定したディスカッション・サーバー管理ユーザーのパスワード。

authUserIdFormat

ディスカッション・サーバー認可APIによって使用される(アクティブ・アイデンティティ・プラグイン内の)ユーザーIDの形式。たとえば、ユーザー名、電子メール、ニックネーム、user_name。

crawlingMode

ソース内のURLをクロールするためのモード。デフォルト・モードは、ACCEPT_ALLです。有効な値は、ACCEPT_ALL、INDEX_ONLY、EXAMINE_URLです。

ACCEPT_ALL: 索引付けのためにすべてのURLを自動的に受け入れます。ソース内のすべてのURLをクロールおよび索引付けします。それらのURL内で見つかったすべてのリンクの抽出および索引付けも行います。前にクロールされたURLは、それらが変更されていた場合にのみ再索引付けされます。

EXAMINE_URL: 索引付けする前にURLを確認します。ソース内のすべてのURLをクロールしますが、索引付けは行いません。それらのURL内で見つかったすべてのリンクのクロールも行います。

INDEX_ONLY: 索引付けのみ行います。ソース内のすべてのURLをクロールし、索引付けします。それらのURL内で見つかったどのリンクも抽出しません。このオプションは、前にEXAMINE_URLを使用してクロールされたソースに対して選択します。

recrawlPolicy

すべてのドキュメントをクロールするか、変更されたドキュメントのみクロールするのかを指定します。有効な値は、PROCESS_ALLおよびPROCESS_CHANGEDです。

PROCESS_ALL - すぺてのドキュメントがクロールされます。このオプションは、フル・クロールを強制するために使用します。

PROCESS_CHANGED - 前回のクロール以降に変更されたドキュメントのみクロールします。この設定で、クローリング・プロセスを大幅に高速化できます。

freqType

スケジュール済クロールの頻度。有効な値は、MANUAL、MONTHLY、WEEKLY、DAILY、HOURLYです。

クロールをMONTHLY、WEEKLY、DAILYまたはHOURLYにスケジュールするには、追加の引数を次のように指定します。

MONTHLY: startHour、startDayOfTheMonth、monthsBetweenLaunches

WEEKLY: startHour、startDayOfTheWeek、weeksBetweenLaunches

DAILY: startHour、daysBetweenLaunches

HOURLY: hoursBetweenLaunches

定期的なクロールが不要な場合は、MANUALを選択し、startDiscussionsCrawlerコマンドを使用して、クロールを手動で開始します。

startHour

クロールを開始する時刻。1と24の間の任意の数字。

たとえば、2:00amであれば2、2:00pmであれば14を入力します。

hoursBetweenLaunches

クロール間の時間数。

freqType='HOURLY'の場合にのみ有効です。

startDayOfWeek

週ごとのクロールを開始する曜日。たとえば、MONDAY、TUESDAYなどです。

freqType='WEEKLY'の場合にのみ有効です。

startDayOfMonth

月ごとのクロールを開始する日。たとえば、1日の場合は1、2日の場合は2のように入力します。

freqType='MONTHLY'の場合にのみ有効です。

daysBetweenLaunches

クロール間の日数。

freqType='DAILY'の場合にのみ有効です。

weeksBetweenLaunches

クロール間の週数。

freqType='WEEKLY'の場合にのみ有効です。

monthsBetweenLaunches

クロール間の月数。

freqType='MONTHLY'の場合にのみ有効です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上にディスカッション・フォーラム・クローラおよびお知らせクローラを作成します。

createDiscussionsCrawler(appName='webcenter', host='myhost.com', port='8888',
sesUrl='http://myseshost.com:7777/search/api/admin/AdminService',
sesPaswword='password', dbConnString='jdbc:oracle:thin:@myjivedbhost.com:1521/mysid',
user='app_discussions_crawler', password='password',
authUserIdFormat='nickname', crawlingMode='ACCEPT_ALL',
recrawlPolicy='PROCESS_ALL', freqType='MANUAL', startHour=1,
hoursBetweenLaunches=1,startDayOfWeek='MONDAY',
startDayOfMonth=1, daysBetweenLaunches=1,
weeksBetweenLaunches=1, monthsBetweenLaunches=1)

listSpacesCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でSpacesアプリケーションに対して構成されているSpacesクローラを返します。

構文

listSpacesCrawler(appName, sesUrl, sesPassword, host, port, [verbose],
[server], [applicationVersion]

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

Spacesアプリケーションを実行しているマシンのホスト名。

port

Spacesアプリケーションにアクセスするために使用されるポート番号。

verbose

オプション。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listSpacesCrawlersによって、Oracle SESでSpacesアプリケーションに対して構成されているSpacesクローラおよび詳細が返されます。0に設定すると、ソース名のみが一覧表示されます。この引数のデフォルトは、0です。

server

オプション。Spacesアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777内で構成されているSpacesクローラを返します。

listSpacesCrawler(appName='webcenter',
sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesPassword'password', host='myhost.com', port='8888')

Already in Domain Runtime Tree
-----------------
Spaces Crawlers
-----------------
webcenter_myhost.com_8888_spaces

listDocumentsCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているドキュメント・クローラを返します。

構文

listDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [verbose],
[server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

WebCenter Portalアプリケーションを実行しているマシンのホスト名。

port

WebCenter Portalアプリケーションにアクセスするために使用されるポート番号。

verbose

オプション。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listDocumentsCrawlersによって、Oracle SESでWebCenter Portalアプリケーションに対して構成されているドキュメント・クローラおよび詳細が返されます。0に設定すると、ソース名のみが一覧表示されます。この引数のデフォルトは、0です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777内で構成されているドキュメント・クローラを返します。

listDocumentsCrawler(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesPassword'password', host='myhost.com', port='8888')

Already in Domain Runtime Tree
-----------------
Documents Crawlers
-----------------
webcenter_myhost.com_8888_documents

listDiscussionsCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを返します。

構文

listDiscussionsCrawler(appName, sesUrl, sesPassword, host, port,
[verbose],  [server], [applicationVersion]

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

WebCenter Portalアプリケーションを実行しているマシンのホスト名。

port

WebCenter Portalアプリケーションにアクセスするために使用されるポート番号。

verbose

オプション。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listDocumentsCrawlersによって、Oracle SESでWebCenter Portalアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラおよび詳細が返されます。0に設定すると、ソース名のみが一覧表示されます。この引数のデフォルトは、0です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777内で構成されているディスカッション・クローラとお知らせクローラを返します。

listDiscussionsCrawler(appName='webcenter', sesUrl='http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')

Already in Domain Runtime Tree
-----------------
Discussions Crawler
-----------------
webcenter_myhost.com_8888_forums
webcenter_myhost.com_8888_announcements

startSpacesCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でSpacesアプリケーションに対して構成されているSpacesクローラを起動します。

構文

startSpacesCrawler(appName, sesUrl, sesPassword, host, port, [server],
[applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

Spacesアプリケーションを実行しているマシンのホスト名。

port

Spacesアプリケーションにアクセスするために使用されるポート番号。

server

オプション。Spacesアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。Spacesアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているSpacesクローラを起動します。

startSpacesCrawler(appName='webcenter',
sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')

startDocumentsCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているドキュメント・クローラを起動します。

構文

startDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [server],
[applicationVersion]

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

WebCenter Portalアプリケーションを実行しているマシンのホスト名。

port

WebCenter Portalアプリケーションにアクセスするために使用されるポート番号。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているドキュメント・クローラを起動します。

startDocumentsCrawler(appName='webcenter',
sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')

startDiscussionsCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを起動します。

構文

startDiscussionsCrawler(appName, sesUrl, sesPassword, host, port,  [server],
[applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

WebCenter Portalアプリケーションを実行しているマシンのホスト名。

port

WebCenter Portalアプリケーションにアクセスするために使用されるポート番号。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているディスカッション・クローラとお知らせクローラを起動します。

startDiscussionsCrawler(appName='webcenter',
sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')

stopSpacesCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でSpacesアプリケーションに対して構成されているSpacesクローラを停止します。

構文

stopSpacesCrawler(appName, sesUrl, sesPassword, host, port, [server],
[applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

Spacesアプリケーションを実行しているマシンのホスト名。

port

Spacesアプリケーションにアクセスするために使用されるポート番号。

server

オプション。Spacesアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。Spacesアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているSpacesクローラを停止します。

stopSpacesCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')

stopDocumentsCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているドキュメント・クローラを停止します。

構文

stopDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [server],
[applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

WebCenter Portalアプリケーションを実行しているマシンのホスト名。

port

WebCenter Portalアプリケーションにアクセスするために使用されるポート番号。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているドキュメント・クローラを停止します。

stopDocumentsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')

stopDiscussionsCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを停止します。

構文

stopDiscussionsCrawler(appName, sesUrl, sesPassword, host, port,
[server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

WebCenter Portalアプリケーションを実行しているマシンのホスト名。

port

WebCenter Portalアプリケーションにアクセスするために使用されるポート番号。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているディスカッション・クローラとお知らせクローラを停止します。

stopDiscussionsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')

deleteSpacesCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でSpacesアプリケーションに対して構成されているSpacesクローラを削除します。

構文

deleteSpacesCrawler(appName, sesUrl, sesPassword, host, port,[server],[applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

Spacesアプリケーションを実行しているマシンのホスト名。

port

Spacesアプリケーションにアクセスするために使用されるポート番号。

server

オプション。アプリケーションがデプロイされている管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。アプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているSpacesクローラを削除します。

deleteSpacesCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')

deleteDocumentsCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているドキュメント・クローラを削除します。

構文

deleteDocumentsCrawler(appName, sesUrl, sesPassword, host, port, [server],
[applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

WebCenter Portalアプリケーションを実行しているマシンのホスト名。

port

WebCenter Portalアプリケーションにアクセスするために使用されるポート番号。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているドキュメント・クローラを削除します。

deleteDocumentsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')

deleteDiscussionsCrawler

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Oracle SESインスタンス上でWebCenter Portalアプリケーションに対して構成されているディスカッション・クローラとお知らせクローラを削除します。

構文

deleteDiscussionsCrawler(appName, sesUrl, sesPassword, host, port,  [server],
[applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

sesUrl

Oracle SES管理APIのWebサービスURL。http://<host>:<port>/search/api/admin/AdminServiceの形式を使用します。

sesPassword

Oracle SES管理ユーザー(eqsys)のパスワード。

host

WebCenter Portalアプリケーションを実行しているマシンのホスト名。

port

WebCenter Portalアプリケーションにアクセスするために使用されるポート番号。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、http://myhost.com:8888/webcenter/spacesにあるSpacesアプリケーション(webcenter)に対してOracle SESインスタンスhttp://myseshost.com:7777上で構成されているディスカッション・クローラとお知らせクローラを削除します。

deleteDiscussionsCrawler(appName='webcenter',sesUrl'http://myseshost.com:7777/search/api/admin/AdminService', sesPassword='password', host='myhost.com', port='8888')

検索 - WebCenter Portal検索

表10-25に示すコマンドを使用して、Spacesアプリケーションおよびその他のWebCenter Portalアプリケーションに対する検索設定およびクロール・オプションを管理します。

これらのWebCenter Portal WLSTコマンドを使用して行った構成変更は、ただちに有効になります。再起動は不要です。

表10-25 WebCenter Portal検索WLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

setSearchConfig

WebCenter Portalアプリケーションの検索設定を変更します。

オンライン

listSearchConfig

WebCenter Portalアプリケーションの検索プロパティを一覧表示します。

オンライン

setSpacesCrawlProperties

WebCenter Portalアプリケーションのクロール・プロパティを指定します。

オンライン

getSpacesCrawlProperties

WebCenter Portalアプリケーションの現在のクロール設定を返します。

オンライン

setSearchConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalアプリケーションの検索設定を変更します。パラメータを指定しない場合、検索設定が変更されません。

構文

setSearchConfig(appName,[numSavedSearches],[numResultsRegion],[numResultsMain],
[executionTimeout],[prepareTimeout],[showAllExecutionTimeout],
[server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

numSavedSearches

オプション。保存済検索項目のドロップ・ダウン(メイン検索ページ)に表示する保存済検索項目数を示します。

numResultsRegion

オプション。保存済検索タスク・フローに表示される保存済検索項目数を示します。

numResultsMain

オプション。メイン検索ページから提出された検索項目に対して、サービスごとに表示される検索結果の数を示します。

executionTimeout

オプション。サービスで検索を許可されている最大時間(msの単位)を示します。この引数の値は、有効な値である必要があります。

prepareTimeout

オプション。サービスで検索の起動を許可されている最大時間(msの単位)を示します。この引数の値は、有効な値である必要があります。

showAllExecutionTimeout

オプション。サービスで検索結果の表示を許可されている最大時間(msの単位)を示します。この引数の値は、有効な値である必要があります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、保存済の検索には、サービスごとに5個の検索結果が表示されることを示します。また、検索を行うために必要なタイムアウト時間は、7秒です。

wls:/weblogic/serverConfig> setSearchConfig(appName='webcenter',
numResultsRegion=5, executionTimeout=7000);

次の例では、保存済検索ドロップダウン・リストの保存済検索の数値を8に増やします。

wls:/weblogic/serverConfig> setSearchConfig(appName='webcenter', numSavedSearches=8);

次の例は、検索を実行するタイムアウトを5秒に設定し、各サービスで、タイムアウト前に15秒まで検索結果を表示できます。

wls:/weblogic/serverConfig> setSearchConfig(appName='webcenter',
executionTimeout=5000, showAllExecutionTimeout=15000);

listSearchConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalアプリケーションの検索設定を一覧表示します。

構文

listSearchConfig(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行する対象のWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のWebCenter Portalアプリケーションの検索構成情報を表示します。

wls:/weblogic/serverConfig> listSearchConfig(appName='webcenter')

setSpacesCrawlProperties

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalアプリケーションのクロール・プロパティを指定します。

WebCenter PortalアプリケーションをOracle SESがクロールすることにより、WebCenter Portalオブジェクト(具体的にはスペース、リスト、ページ、ピープル(プロファイル)、Wiki、ブログ、ドキュメント、ディスカッションおよびお知らせ)にわたる、より高度に統合された、より高速な検索エクスペリエンスを実現できます。これは、次の3種類のクローラによって可能になります。

- Spacesクローラ(スペース、リスト、ページおよびピープル用)

- ドキュメント・クローラ(ドキュメント、Wiki、ブログ用)

- ディスカッション・クローラ(ディスカッションとお知らせ用)

このコマンドを使用して、WebCenter PortalアプリケーションのOracle SESクローラを有効化または無効化します。

- Spacesアプリケーション - SpacesアプリケーションでOracle SESクローラを使用するには、3つのクローラをすべて有効化する必要があります。

- Frameworkアプリケーション - WebCenter PortalアプリケーションでOracle SESクローラを使用するには、ドキュメントとディスカッションの両方のクローラを有効化する必要があります。Spacesクローラは該当しません。

(Spacesアプリケーションのみ)このコマンドを使用して、Spacesクローラに対してフル・クロールを実行する間隔を指定することもできます。フル・クロール中に、Spacesクローラのコンテンツがすべて再読取りされます。初期の設定では、Spacesクローラのフル・クロールは7日間ごとに実行されますが、ご使用のインストールに合せて異なる頻度を指定できます。

3種類のすべてのクローラにおいて、増分クロールは、Oracle SESから実行されるスケジューラ主導になります。これらの増分クロール中は、前回のクロール以降に追加または更新されたコンテンツのみが処理されます。

構文

setSpacesCrawlProperties(appName, [fullCrawlIntervalInHours, spacesCrawlEnabled, documentCrawlEnabled, discussionsCrawlEnabled, server, applicationVersion])

引数

定義

appName

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

fullCrawlIntervalInHours

オプション。(Spacesアプリケーションのみ)フル・クロール間の時間数。デフォルトは168時間、つまり7日間です。

spacesCrawlEnabled

オプション。SpacesクローラをOracle SESで有効化するかどうかを指定します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは、0です。

0に設定した場合、WebCenter Portalの内部検索アダプタが検索結果を返します。

documentCrawlEnabled

オプション。ドキュメント・クローラをOracle SESで有効化するかどうかを指定します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは、0です。

0に設定した場合、WebCenter Portalの内部検索アダプタが検索結果を返します。

discussionsCrawlEnabled

オプション。ディスカッション・クローラをOracle SESで有効化するかどうかを指定します。有効な値は、1 (true)および0 (false)です。この引数のデフォルトは、0です。

0に設定した場合、WebCenter Portalの内部検索アダプタが検索結果を返します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、SpacesアプリケーションにおけるOracle SESクローラを有効化し、SpacesアプリケーションがSpacesクローラを使用したフル・クロールを8日ごとに実行するように指定します。

wls:/weblogic/serverConfig>setSpacesCrawlProperties(appName='webcenter', fullCrawlIntervalInHours=192, spacesCrawlEnabled=1, documentCrawlEnabled=1, discussionsCrawlEnabled=1)

getSpacesCrawlProperties

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

フル・クロール間の時間数(Spacesクローラ)、Oracle SESクローラが有効かどうかなど、WebCenter Portalアプリケーションの現在のクロール設定を返します。

構文

getSpacesCrawlProperties(appName, [server, applicationVersion])

引数

定義

appName

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

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Spacesアプリケーションの現在のクロール設定を返します。

wls:/weblogic/serverConfig>getSpacesCrawlProperties(appName='webcenter')

Spaces Crawl Properties:-----------------fullCrawlIntervalInHours: 124spacesCrawlEnabled:       1documentCrawlEnabled:     1discussionsCrawlEnabled:  1

ワークリスト

表10-26に示すコマンドを使用して、WebCenter PortalアプリケーションのBPELサーバー接続を管理します。

これらのWebCenter Portal WLSTコマンドを使用して行った構成変更は、WebCenter Portalアプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

表10-26 ワークリスト・コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

createBPELConnection

WebCenter Portalアプリケーション用のBPELサーバーへの接続を作成します。

オンライン

setBPELConnection

既存のBPELサーバー接続を編集します。

オンライン

listBPELConnections

WebCenter Portalアプリケーションに対して構成されているBPELサーバーのすべての接続を一覧表示します。

オンライン

addWorklistConnection

ワークリスト・サービスの 既存のBPELサーバー接続を有効に設定します。

オンライン

removeWorklistConnection

現在、ワークリスト・サービスで使用中のBPELサーバー接続を無効に設定します。

オンライン

listWorklistConnections

ワークリスト・サービスに対して設定した個々またはすべてのBPELサーバー接続を表示します。

オンライン

createBPELConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したWebCenter Portalアプリケーション用のBPELサーバーへの接続を作成します。アプリケーションのワークリスト・サービスおよびSpacesワークフローでBPELサーバーの接続を使用できます。

新しいBPELサーバー接続をアクティブに使用できるように、ワークリスト・サービスを設定するには、addWorklistConnectionコマンドを使用します。「addWorklistConnection」を参照してください。

Spacesがその内部ワークフローのために使用するBPELサーバー接続を指定するには、setSpacesWorkflowConnectionNameコマンドを使用します。「setSpacesWorkflowConnectionName」を参照してください。

構文

createBPELConnection(appName, name, url, [policy, recipientKeyAlias, linkUrl, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

接続の名前を示します。名前は、WebCenter Portalアプリケーション内で(すべての接続タイプにわたって)一意である必要があります。

url

BPELサーバーにアクセスするために必要なURLを示します。

protocol://host:portの形式を使用します。

BPELサーバーのURLは、WebCenter Portalアプリケーション内で一意である必要があります。

policy

オプション。この接続は、認証のために使用するSAMLトークン・ポリシーを示します。任意の有効なポリシーを入力します。有効な値は次のとおりです:

- oracle/wss10_saml_token_client_policy - デフォルトのメッセージ保護されていないポリシーでBPELサーバーにアクセスする場合に使用します。

- oracle/wss10_saml_token_with_message_protection_client_policy - メッセージ保護されたポリシーでBPELサーバーにアクセスする場合に使用します。選択した場合は、WebCenter PortalアプリケーションとBPELアプリケーションの両方にキーストアを構成する必要があります。

- GPA - グローバル・ポリシー・アタッチメント(GPA)がサポートされている環境の場合に使用します。

この引数を指定しない場合、接続はデフォルトでoracle/wss10_saml_token_client_policyになります。

recipientKeyAlias

オプション。メッセージ保護SAMLポリシー認証に使用される受信者キー別名。BPELサーバー接続が認証用にSAMLトークン・ポリシーを使用しており、アプリケーションのワークリスト・サービスが複数のBPELサーバー接続を使用している場合にのみ必要です。

デフォルトは、nullです。

Oracle Fusion Middleware Oracle WebCenter管理者ガイドのWebCenter Portalアプリケーションおよびコンポーネント用のWS-Securityの構成に関する項も参照してください。

linkUrl

オプション。BPELサーバーにリンクするために使用されるURL。url引数と異なる場合にのみ必要です。たとえば、SSOまたはHTTPSが構成されている場合です。

protocol://host:portの形式を使用します。

デフォルトは、nullです。

パフォーマンス上の理由から、HTTPSまたはSSO環境では、linkUrlには、HTTPSまたはSSO Webサーバーを介したBPELワークリスト・アイテムへのユーザー・アクセスを指定し、urlには、HTTPSまたはSSO Webサーバーを介したリダイレクションを使用しないBPEL Webサービスへの直接アクセスを指定します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、デフォルト・セキュリティ・ポリシーを使用するWebCenter Worklistという名前の接続を作成します。

wls:/weblogic/serverConfig> createBPELConnection(appName='webcenter',
name='WebCenter Worklist', url='http://myhost.com:8001',
policy='oracle/wss10_saml_token_client_policy)

次の例では、メッセージ保護されたセキュリティ・ポリシーを使用する接続を作成し、特定のリンクURLを定義します。

wls:/weblogic/serverConfig> createBPELConnection(appName='webcenter',
name='WebCenter Worklist',url='http://myhost.com:8001', policy='oracle/wss10_
saml_token_with_message_protection_client_policy', recipientKeyAlias='myalias', linkUrl='http://mySSO.com:7777')

次の例では、グローバル・ポリシー・アタッチメント(GPA)をサポートする環境で使用される接続を作成します。

wls:/weblogic/serverConfig> createBPELConnection(appName='webcenter',
name='WebCenter Worklist', url='http://myhost.com:8001' policy='GPA')

setBPELConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

既存のBPELサーバー接続を編集します。

既存のBPELサーバー接続をアクティブに使用できるように、ワークリスト・サービスを設定するには、addWorklistConnectionコマンドを使用します。「addWorklistConnection」を参照してください。

Webcenter Spacesワークフローに対して使用されるBPELサーバー接続を指定するには、setSpacesWorkflowConnectionNameコマンドを使用します。「setSpacesWorkflowConnectionName」を参照してください。

構文

setBPELConnection(appName, name, [url, policy, recipientKeyAlias, linkUrl, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のBPELサーバー接続の名前を示します。

url

オプション。BPELサーバーにアクセスするために必要なURLを示します。

使用するフォーマットは、<protocol>://<host>:<port>です。

BPELサーバーのURLは、WebCenter Portalアプリケーション内で一意である必要があります。

policy

オプション。この接続は、認証のために使用するSAMLトークン・ポリシーを示します。任意の有効なポリシーを入力します。有効な値は次のとおりです:

- oracle/wss10_saml_token_client_policy - デフォルトのメッセージ保護されていないポリシーでBPELサーバーにアクセスする場合に使用します。

- oracle/wss10_saml_token_with_message_protection_client_policy - メッセージ保護されたポリシーでBPELサーバーにアクセスする場合に使用します。選択した場合は、WebCenter PortalアプリケーションとBPELアプリケーションの両方にキーストアを構成する必要があります。

- GPA - グローバル・ポリシー・アタッチメント(GPA)がサポートされている環境の場合に使用します。

この引数を指定しない場合、接続はデフォルトでoracle/wss10_saml_token_client_policyになります。

recipientKeyAlias

オプション。メッセージ保護SAMLポリシー認証に使用される受信者キー別名。BPELサーバー接続が認証用にSAMLトークン・ポリシーを使用しており、アプリケーションのワークリスト・サービスが複数のBPELサーバー接続を使用している場合にのみ必要です。

デフォルトは、nullです。

Oracle Fusion Middleware Oracle WebCenter管理者ガイドのWebCenter Portalアプリケーションおよびコンポーネント用のWS-Securityの構成に関する項も参照してください。

linkUrl

オプション。BPELサーバーにリンクするために使用されるURL。url引数と異なる場合にのみ必要です。たとえば、SSOまたはHTTPSが構成されている場合です。protocol://host:portの形式を使用します。

たとえば、http://mySSO.host.com:7777です。

デフォルトは、nullです。

パフォーマンス上の理由から、HTTPSまたはSSO環境では、Link URLには、HTTPSまたはSSO Webサーバーを介したBPELワークリスト・アイテムへのユーザー・アクセスを指定し、BPEL SOAP URLには、HTTPSまたはSSO Webサーバーを介したリダイレクションを使用しないBPEL Webサービスへの直接アクセスを指定します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Worklistという名前の接続のBPELサーバーURL、セキュリティ・ポリシー、受信者キー別名およびリンクURLを更新します。

wls:/weblogic/serverConfig> setBPELConnection(appName='webcenter',
name='WebCenter Worklist',url='http://myhost.com:6666', policy='oracle/wss10_
saml_token_with_message_protection_client_policy', recipientKeyAlias='myalias', linkUrl='http://mySSO.com:7777')

次の例では、グローバル・ポリシー・アタッチメント(GPA)を使用するようにセキュリティ・ポリシーを変更します。

wls:/weblogic/serverConfig> setBPELConnection(appName='webcenter',
name='WebCenter Worklist', policy='GPA')

listBPELConnections

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

このコマンドは、引数を指定せずに使用すると、特定のWebCenter Portalアプリケーションに対して構成されているすべてのBPEL接続を一覧表示します。現在、接続を使用していない場合も、すべてのBPEL接続が指定されます。

構文

listBPELConnections(appName, [verbose], [name], [server], [applicationVersion])

引数

定義

appName

BPELサーバー接続を一覧表示するWebCenter Portalアプリケーションの名前。

verbose

オプション。BPELサーバー接続の詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listBPELConnectionsによって、構成されているすべてのBPELサーバー接続およびそれらの詳細が一覧表示されます。0に設定した場合、listBPELConnectionsによって、接続名のみ一覧表示されます。この引数のデフォルトは、0です。

この引数を0に設定した場合、name引数を指定しないでください。

name

オプション。既存のBPELサーバー接続の名前を示します。この引数を使用して、特定の接続の詳細情報を表示できます。

すべての接続を表示するには、name引数を省略します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、WebCenter Portalアプリケーションに対して構成されているすべてのBPELサーバー接続の名前を一覧表示します。

wls:/weblogic/serverConfig> listBPELConnections(appName='webcenter')
------------------
WebCenter Worklist
------------------
------------------
Human Resources Worklist
------------------

次の例では、WebCenter Portalアプリケーションに対して構成されているすべてのBPELサーバー接続の名前および詳細を一覧表示します。

wls:/weblogic/serverConfig> listBPELConnections(appName='webcenter', verbose=1)
------------------
WebCenter Worklist
------------------
Connection Name: WebCenter Worklist
PolicyURI:oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8001
------------------
Human Resources Worklist
------------------
Connection Name: Human Resources Worklist
PolicyURI:oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8888
------------------

addWorklistConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

ワークリスト・サービスの 既存のBPELサーバー接続を有効に設定します。ワークリスト・サービスは、複数の接続をサポートしているので、WebCenter Portalユーザーは様々なBPELサーバーからの割当ておよび通知を監視および管理できます。

名前には、既存のBPELサーバー接続を指定する必要があります。

構文

addWorklistConnection(appName, name,[verbose, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のBPELサーバー接続の名前を示します。

verbose

オプション。一致するBPELサーバー接続が存在するかどうかを示す出力を表示し、接続詳細を表示します。1では冗長モードがオンになり、0では冗長モードがオフになります。この引数のデフォルトは、0です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、ワークリスト・サービスのHuman Resources Worklist接続を有効に設定します。

wls:/weblogic/serverConfig> addWorklistConnection(appName='webcenter',
name='Human Resources Worklist', verbose=1)
Human Resources Worklist successfully added to WorkList
------------------
Human Resources Worklist
------------------
Connection Name: Human Resources Worklist
PolicyURI:oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8888

次の例も、ワークリスト・サービスのHuman Resources Worklist接続を有効に設定します。

wls:/weblogic/serverConfig> addWorklistConnection(appName='webcenter',
name='Human Resources Worklist', verbose=1)
Human Resources Worklist successfully added to WorkList
------------------
Human Resources Worklist
------------------
Connection Name: Human Resources Worklist
PolicyURI:oracle/oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8888

removeWorklistConnection

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

現在、ワークリスト・サービスで使用中のBPELサーバー接続を無効に設定します。接続に関する情報が保持されますが、ワークリスト・サービスには、指定した接続を使用できなくなっています。

構文

removeWorklistConnection(appName, name, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

name

既存のBPELサーバー接続の名前を示します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、ワークリスト・サービスのWebCenter Worklistという名前のBPELサーバー接続を無効に設定します。

wls:/weblogic/serverConfig> removeWorklistConnection(appName='webcenter',
name='WebCenter Worklist')
WebCenter Worklist successfully removed from WorkList

listWorklistConnections

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

このコマンドは、引数を指定せずに使用すると、指定したWebCenter Portalアプリケーションのワークリスト・サービスに対して構成されているすべてのBPELサーバー接続を一覧表示します。

構文

listWorklistConnections(appName, [verbose],[name], [server],
[applicationVersion])

引数

定義

appName

この操作を実行する対象のWebCenter Portalアプリケーションの名前。

verbose

オプション。BPELサーバー接続の詳細情報を冗長モードで表示します。有効なオプションは、1 (true)および0 (false)です。1に設定した場合、listWorklistConnectionsによって、ワークリスト・サービスに対して構成されているBPELサーバーのすべての接続およびその詳細が一覧表示されます。0に設定した場合、listWorklistConnectionsによって、接続名のみ一覧表示されます。この引数のデフォルトは、0です。

この引数を0に設定した場合、name引数を指定しないでください。

name

オプション。既存のBPELサーバー接続の名前を示します。この引数を使用して、特定の接続の詳細情報を表示できます。

すべての接続を表示するには、name引数を省略します。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例は、ワークリスト・サービスに対して設定したすべてのBPELサーバー接続の名前を表示します。

wls:/weblogic/serverConfig> listWorklistConnections(appName='webcenter')
------------------
WebCenter Worklist
------------------

次の例は、ワークリスト・サービスに対して設定したすべてのBPELサーバー接続の名前および接続に関する詳細情報を表示します。

wls:/weblogic/serverConfig> listWorklistConnections(appName='webcenter', verbose=1)
------------------
WebCenter Worklist
------------------
Connection Name: WebCenter Worklist
PolicyURI:oracle/wss10_saml_token_client_policy
URL:http://myhost.com:8001

次の例は、MyWorklistという名前のBPELサーバー接続の詳細情報を表示します。現在、ワークリスト・サービスでは、MyWorklistを使用するように設定していないので、適当なメッセージが表示されます。

wls:/weblogic/serverConfig> listWorklistConnections(appName='webcenter',
verbose=1, name='MyWorklist')
------------------
The following connection is not in the ADF Worklist:MyWorklist

Spacesアプリケーション

表10-27に示すコマンドを使用して、Spacesアプリケーションに対するワークフロー設定およびメタデータを管理します。

表10-27 SpacesアプリケーションWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

getSpacesWorkflowConnectionName

Spacesアプリケーションが内部ワークフローに対して使用しているBPELサーバー接続の名前を返します。

オンライン

setSpacesWorkflowConnectionName

Spacesワークフローに対して使用されるBPELサーバー接続を指定します。

オンライン

refreshGroupSpaceCache

個々のスペースのメタデータ(MDS内)およびスペース・セキュリティ・データを「Spacesキャッシュ」に移行します。

オンライン

refreshSpaceTemplateCache

個々のスペース・テンプレートのメタデータ(MDS内)およびスペース・テンプレート・セキュリティ・データをスペース・テンプレート・キャッシュに移行します。

オンライン

getSpacesWorkflowConnectionName

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Spacesアプリケーションが内部ワークフロー(spacemembership通知、spacesubscriptionリクエストなど)に対して現在使用しているBPELサーバー接続の名前を返します。

構文

getSpacesWorkflowConnectionName(appName, [server, applicationVersion])

引数

定義

appName

Spacesアプリケーションの名前。常にwebcenterです。

server

オプション。Spacesアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。Spacesアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Spacesアプリケーションが内部ワークフローに対して現在使用しているBPELサーバー接続の名前を示します。

wls:/weblogic/serverConfig> getSpacesWorkflowConnectionName(appName='webcenter')
WorkflowConfigConnectionName: WebCenter-Worklist

setSpacesWorkflowConnectionName

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Spacesアプリケーションが内部ワークフローに対して使用するBPELサーバー接続を指定します。Spacesアプリケーションは、内部ワークフロー(spacemembership通知、spacesubscriptionリクエストなど)をホストするために、Oracle SOA Suiteに組み込まれているBPELサーバーを使用します。ここで指定された接続の名前は、有効なBPELサーバー接続である必要があります。

注意:

このWLSTコマンドを使用して行った構成変更は、Spacesアプリケーションがデプロイされている管理対象サーバーを再起動した後のみ有効になります。詳細は、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』を参照してください。

構文

setSpacesWorkflowConnectionName(appName, name, [server, applicationVersion])

引数

定義

appName

Spacesアプリケーションの名前。常にwebcenterです。

name

既存のBPEL接続の名前を示します。

server

オプション。Spacesアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。Spacesアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Spacesアプリケーションが、その内部ワークフローのためにWebCenter-Worklistという名前のBPELサーバー接続を使用することを指定します。

wls:/weblogic/serverConfig>setSpacesWorkflowConnectionName(appName='webcenter',
name='WebCenter-Worklist')

refreshGroupSpaceCache

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

個々のスペースのメタデータ(MDS内)およびスペース・セキュリティ・データ(ポリシー・ストア内)を「Spacesキャッシュ」に移行します。

WebCenter Spaces 11.1.1.2.0 (およびそれ以降)では、Spacesメタデータおよびセキュリティ関連データを格納するために表(Spacesキャッシュと呼ぶ)を使用します。WebCenter Spacesを11.1.1.1.0から11.1.1.2.0に移行する場合、refreshGroupSpaceCacheコマンドを実行して、既存のSpacesデータがすべて新しい「Spacesキャッシュ」に移行されるようにする必要があります。

構文

refreshGroupSpaceCache(appName, [spaceNames, syncMode, updateType, cleanCache])

引数

定義

appName

Spacesアプリケーションの名前。常にwebcenterです。

spaceNames

オプション。リフレッシュする1つ以上のスペース(グループ・スペース)の名前。

MDS内のすべてのスペースをリフレッシュするには、spaceNames= ''と入力します。

選択したスペースをリフレッシュするには、1つ以上のスペース名をカンマで区切って入力します。例: spaceNames='MyGroupSpace1,MyGroupSpace'

updateType

オプション。リフレッシュするデータのタイプを示します。有効な値は、security、metadata、allです。デフォルト値はsecurityです。

- security: ポリシー・ストアに格納されているセキュリティ・データでキャッシュをリフレッシュします。格納されているセキュリティ・データには、そのスペースのメンバー・データ、スペースがパブリックかどうか、およびAuthenticated-Userロール(前のリリースでは、このロールはSpaces-Userという名前でした)を割り当てられているユーザーがスペースにアクセスできるかどうかが含まれます。

- metadata: MDSに格納されているスペース関連メタデータでキャッシュをリフレッシュします。格納されるデータには、表示名、キーワード、アイコン、ロゴなどメタデータ情報が含まれます。

- all: MDSおよびポリシー・ストアに格納されているデータでキャッシュをリフレッシュします。

syncMode

オプション。Spacesアプリケーションを同期モードと非同期モードのいずれでリフレッシュするのかを示します。

有効な値は1および0です。デフォルト値は1です。

1に設定した場合、リフレッシュ・プロセスは同期モードで実行されます。

0に設定した場合、リフレッシュは非同期です。つまり、新しいスレッドがリフレッシュ・プロセスのために生成されます。

同期モードをお薦めします。

cleanCache

オプション。Spacesキャッシュをクリアするかどうかを示します。有効な値は1および0です。デフォルト値は0です。

0に設定した場合、リフレッシュ操作中にSpacesアプリケーションの内容はクリアされません。

移行の場合、この値は常に0に設定します。

1の値は、アプリケーション全体をインポートする場合にのみ使用します。その場合、Spacesキャッシュで使用可能なデータ全体が上書きされます。

例

次の例では、同期モードですべてのスペース関連のメタデータ(MDS内)およびセキュリティ・データ(ポリシー・ストア内)を含めるようにキャッシュを更新します。

wls:/weblogic/serverConfig>refreshGroupSpaceCache(appName='webcenter',
spaceNames='', syncMode=1, updateType='all', cleanCache=0)

wls:/weblogic/serverConfig>refreshGroupSpaceCache(appName='webcenter')

次の例では、MyGroupSpace1とMyGroupSpace2という2つのスペースのスペース関連のメタデータ(MDS内)およびセキュリティ・データ(ポリシー・ストア内)を含めるようにSpacesキャッシュを更新します。キャッシュは同期モードでリフレッシュされます。

wls:/weblogic/serverConfig>refreshGroupSpaceCache(appName='webcenter',
spaceNames='MyGroupSpace1,MyGroupSpace2')

refreshSpaceTemplateCache

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

個々のスペース・テンプレートのメタデータ(MDS内)およびテンプレート・セキュリティ・データ(ポリシー・ストア内)をスペース・テンプレート・キャッシュに移行します。

WebCenter Spaces 11.1.1.2.0 (およびそれ以降)では、スペース・テンプレート・メタデータおよびセキュリティ関連データを格納するために表(スペース・テンプレート・キャッシュと呼ぶ)を使用します。WebCenter Spaces 11.1.1.1.0から11.1.1.2.0に移行する場合、refreshSpaceTemplateCacheコマンドを実行して、既存のテンプレート・データがすべて新しいスペース・テンプレート・キャッシュに移行されるようにする必要があります。

構文

refreshSpaceTemplateCache(appName, [spaceTemplateNames, syncMode, updateType, cleanCache])

引数

定義

appName

Spacesアプリケーションの名前。常にwebcenterです。

spaceNames

オプション。リフレッシュする1つ以上のスペース・テンプレートの名前。

MDS内のすべてのスペース・テンプレートをリフレッシュするには、spaceTemplateNames= ''と入力します。

選択したスペース・テンプレートをリフレッシュするには、1つ以上のテンプレート名をカンマで区切って入力します。例: spaceNames='MySpaceTemplate1,MySpaceTemplate'

updateType

オプション。リフレッシュするデータのタイプを示します。有効な値は、security、metadata、allです。デフォルト値はsecurityです。

- security: ポリシー・ストアに格納されているセキュリティ・データでキャッシュをリフレッシュします。格納されているセキュリティ・データには、そのスペース・テンプレートのメンバー・データ、スペース・テンプレートがパブリックかどうか、およびAuthenticated-Userロール(前のリリースでは、このロールはSpaces-Userという名前でした)を割り当てられているユーザーがスペース・テンプレートにアクセスできるかどうかが含まれます。

- metadata: MDSに格納されているスペース・テンプレート関連メタデータでキャッシュをリフレッシュします。格納されるデータには、表示名、キーワード、アイコン、ロゴなどメタデータ情報が含まれます。

- all: MDSおよびポリシー・ストアに格納されているデータでスペース・テンプレート・キャッシュをリフレッシュします。

syncMode

オプション。Spacesアプリケーションを同期モードと非同期モードのいずれでリフレッシュするのかを示します。

有効な値は1および0です。デフォルト値は1です。

1に設定した場合、リフレッシュ・プロセスは同期モードで実行されます。

0に設定した場合、リフレッシュは非同期です。つまり、新しいスレッドがリフレッシュ・プロセスのために生成されます。

同期モードをお薦めします。

cleanCache

オプション。スペース・テンプレート・キャッシュをクリアするかどうかを示します。有効な値は1および0です。デフォルト値は0です。

0に設定した場合、リフレッシュ操作中にSpacesアプリケーションの内容はクリアされません。

移行の場合、この値は常に0に設定します。

1の値は、アプリケーション全体をインポートする場合にのみ使用します。その場合、スペース・テンプレート・キャッシュで使用可能なデータ全体が上書きされます。

例

次の例では、同期モードですべてのスペース・テンプレート関連のメタデータ(MDS内)およびセキュリティ・データ(ポリシー・ストア内)を含めるようにキャッシュを更新します。

wls:/weblogic/serverConfig>refreshSpaceTemplateCache(appName='webcenter',
spaceTemplateNames='', syncMode=1, updateType='all', cleanCache=0)

wls:/weblogic/serverConfig>refreshSpaceTemplateCache(appName='webcenter')

次の例では、MySpaceTemplate1とMySpaceTemplate2という2つのスペース・テンプレートのスペース・テンプレート関連のメタデータ(MDS内)およびセキュリティ・データ(ポリシー・ストア内)を含めるようにスペース・テンプレート・キャッシュを更新します。キャッシュは同期モードでリフレッシュされます。

wls:/weblogic/serverConfig>refreshSpaceTemplateCache(appName='webcenter',
spaceNames='MySpaceTemplate1,MySpaceTemplate2')

WebCenter Portalアイデンティティ・ストア

表10-28に示すコマンドを使用して、WebCenter Portalアプリケーションのアイデンティティ・ストアを検索するためのオプションを構成します。

表10-28 WebCenter Portalアイデンティティ・ストアWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

setWebCenterIdStoreSearchConfig

WebCenter Portalアプリケーションのアイデンティティ・ストアを検索するための構成オプションを変更します。

オンライン

listWebCenterIdStoreSearchConfig

WebCenter Portalアプリケーションのアイデンティティ・ストアを検索するための現在の構成オプションを一覧表示します。

オンライン

startSyncProfiles

LDAPストア内のプロファイル情報を、WebCenter Portalデータベース・スキーマと同期します。

オンライン

stopSyncProfiles

プロファイル同期プロセスを停止します。

オンライン

isSyncProfilesRunning

プロファイルの同期が進行中かどうかを確認します。

オンライン

syncProfile

特定のユーザーのプロファイル情報を同期します。

オンライン

setProfileCacheNumberOfObjects

キャッシュするプロファイル・オブジェクトの数を設定します。

オンライン

setProfileSyncLDAPReadBatchSize

プロファイル同期LDAPバッチ読取りサイズを設定します。

オンライン

setProfileCacheTimeToLive

プロファイルをプロファイル・キャッシュに保持する時間を分単位で設定します。

オンライン

printProfileConfig

プロファイル・キャッシュ構成値を出力します。

オンライン

renameUsersInWebCenterApplication

WebCenter Portalアプリケーションのユーザーの名前を変更します。

オンライン

synchronizeUserInformation

WebCenter Portalアプリケーションのユーザーを同期します。

オンライン

setWebCenterIdStoreSearchConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalアプリケーションのアイデンティティ・ストアを検索するための構成オプションを変更します。これらの設定を使用して、WebCenter Portalアプリケーションでのアイデンティティ・ストアの(ユーザーおよびロールの)検索を最適化します。

アイデンティティ・ストアの検索パラメータはadf-config.xmlに格納されています。検索パラメータを指定しない場合、それは変更されません。

構文

setWebCenterIdStoreSearchConfig(appName,[narrowSearchTimeout, broadSearchTimeout, maxSearchFilters, maxFetchRecords, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

narrowSearchTimeout

オプション。アイデンティティ・ストアから単一のユーザーをフェッチするなど、小さい単純な検索に対して許容される最大時間(ミリ秒単位)。初期状態でのデフォルトは30000ミリ秒です。

broadSearchTimeout

オプション。名前パターンに一致するユーザーおよびロールを返すなど、大きな結果セットを返すために許容される最大時間(ミリ秒単位)。初期状態でのデフォルトは60000です。

maxSearchFilters

オプション。WebCenter Portalアプリケーションのアイデンティティ・ストアに許容される検索フィルタの数。初期状態では最大許容数は100です。

いくつかのアイデンティティ・ストアの検索は、LDAP検索コールに変換される検索フィルタを使用して実行されます。関連付けられているLDAPサーバーによって検索条件が制限される場合は、そのLDAPサーバー設定に一致するようにmaxSearchFiltersプロパティを設定できます。

maxFetchRecords

オプション。各検索問合せから返されるレコードの最大数。初期状態でのデフォルトは100です。

この設定の値は、LDAPサーバーのパフォーマンスに影響を与えるため、この検索結果制限を増やす場合はそれを考慮してください。

LDAPサーバーではそれ自体の検索結果制限が適用されるため、実際に使用される制限は、2つの値のうち、より小さい方になります。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、両方のアイデンティティ・ストア検索タイムアウトを増やします。

wls:/weblogic/serverConfig>setWebCenterIdStoreSearchConfig(appName='webcenter', narrowSearchTimeout=60000, broadSearchTimeout=100000);

次の例では、返されるレコードの最大数を100に制限します。

wls:/weblogic/serverConfig>setWebCenterIdStoreSearchConfig(appName='webcenter', maxFetchRecords=100);

listWebCenterIdStoreSearchConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalアプリケーションのアイデンティティ・ストアを検索するための現在の構成オプションを一覧表示します。

アイデンティティ・ストアの検索パラメータはadf-config.xmlに格納されています。

構文

listWebCenterIdStoreSearchConfig(appName,[server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のWebCenter Portalアプリケーションのアイデンティティ・ストア検索構成情報を表示します。

wls:/weblogic/serverConfig>listWebCenterIdStoreSearchConfig(appName='webcenter');

-----------------
User role search configuration parameters
-----------------
Narrow search timeout    : 30000
Broad search timeout     : 60000
Maximum search filters   : 100
Maximum records to fetch : 200

startSyncProfiles

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

LDAPストア内のプロファイル情報を、WebCenter Portalデータベース・スキーマと同期します。

構文

startSyncProfiles(appName)

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

例

次の例では、webcenterという名前のアプリケーションのユーザー・プロファイルを同期します。

wls:/weblogic/serverConfig>startSyncProfiles(appName='webcenter')

stopSyncProfiles

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

プロファイル同期プロセスが現在進行中の場合は、それを停止します。

構文

stopSyncProfiles(appName)

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

例

次の例では、webcenterという名前のアプリケーションのプロファイル同期プロセスを停止します。

wls:/weblogic/serverConfig>stopSyncProfiles(appName='webcenter')

isSyncProfilesRunning

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

プロファイルの同期が進行中かどうかを確認します。

構文

isSyncProfilesRunning(appName)

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

例

次の例では、webcenterという名前のアプリケーションに対して、プロファイル同期が進行中かどうかを確認します。

wls:/weblogic/serverConfig>isSyncProfilesRunning(appName='webcenter')

syncProfile

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

LDAPストア内の特定のユーザーのプロファイル情報を、WebCenter Portalスキーマと同期します。

構文

syncProfile(appName, userName)

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

userName

プロファイル情報を同期するユーザーの名前。

例

次の例では、montyという名前のユーザーのプロファイル情報を同期します。

wls:/weblogic/serverConfig>syncProfile(appName='webcenter', userName='monty')

setProfileCacheNumberOfObjects

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

プロファイル・キャッシュにキャッシュするプロファイル・オブジェクトの最大数を設定します。

構文

setProfileCacheNumberOfObjects(appName, noOfObjects)

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

noOfObjects

キャッシュするプロファイル・オブジェクトの数。デフォルト値は1000です。

例

次の例では、キャッシュのサイズを2000プロファイルに増やします。

wls:/weblogic/serverConfig>setProfileCacheNumberOfObjects(appName='webcenter', noOfObjects=2000)

setProfileSyncLDAPReadBatchSize

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

プロファイル同期LDAPバッチ読取りサイズを設定します。

構文

setProfileSyncLDAPReadBatchSize(appName, batchSize)

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

batchSize

LDAPバッチ読取りサイズ。デフォルト値は1000です。

例

次の例では、バッチ・サイズを2000LDAPプロファイルに増やします。

wls:/weblogic/serverConfig>setProfileSyncLDAPReadBatchSize(appName='webcenter', batchSize=2000)

setProfileCacheTimeToLive

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

プロファイルをプロファイル・キャッシュに保持する時間を分単位で設定します。

構文

setProfileCacheTimeToLive(appName, timeToLive)

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

timeToLive

プロファイル・キャッシュでのプロファイル・オブジェクトの存続時間(分単位)。デフォルト値は、60分です。

例

次の例では、プロファイル・オブジェクトがキャッシュされる時間の長さを減らします。

wls:/weblogic/serverConfig>setProfileCacheTimeToLive(appName='webcenter', timeToLive=30)

printProfileConfig

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

プロファイル・キャッシュ構成値を出力します。

構文

printProfileConfig(appName)

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

例

次の例では、webcenterという名前のアプリケーションの現在のプロファイル・キャッシュ構成を表示します。

wls:/weblogic/serverConfig>printProfileConfig(appName='webcenter')

renameUsersInWebCenterApplication

モジュール: Oracle WebCenter

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

説明

WebCenter Portalアプリケーションのポリシー・ストアおよびWebCenter Portalアプリケーション表内の不適切なユーザー名を変更します。

構文

renameUsersInWebCenterApplication(appName, names, component, [dbVendor, dbHostNPort, dbName, dbUserName, verbose])

注意: このコマンドは、PolicyStore以外のすべてのコンポーネントに対してオフライン・モードで実行できます。

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

names

名前を変更する必要があるユーザーのカンマ区切りリスト。oldName=newNameの形式を使用します。

component

ユーザーの名前を変更する特定のWebCenter Portalコンポーネント。

有効な値は、PolicyStore、Spaces、UCMおよびJIVEです。

dbVendor

オプション。データベース・ベンダー。

有効な値は、Oracle、MSSQLおよびIBMDB2です。

component=PolicyStoreの場合は、不要です。

dbHostNPort

オプション。データベース・ホストおよびポート。host:portの形式を使用します。

component=PolicyStoreの場合は、不要です。

dbName

オプション。データベース名またはsid。

component=PolicyStoreの場合は、不要です。

dbUserName

オプション。WebCenter Portalデータベース・スキーマ名。

component=PolicyStoreの場合は、不要です。

verbose

オプション。サマリー(0)または詳細な出力(1)を生成します。デフォルト値は0です。

例

次の例では、Spacesアプリケーション表内のユーザーの名前を変更します。

wls:/weblogic/serverConfig>
renameUsersInWebCenterApplication(appName='webcenter',names='myOldname=myNewName,
myOldName1=myNewname1', component='Spaces', dbVendor='Oracle',
dbHostNPort='myDbHost.example.com:1521',dbName='myDb1',
dbUserName='webcenterUser1', verbose=1)

次の例では、Spacesアプリケーションのポリシー・ストア内のユーザーの名前を変更します。

wls:/weblogic/serverConfig>
renameUsersInWebCenterApplication(appName='webcenter',names='myOldname=myNewName,
myOldName1=myNewname1', component='PolicyStore', verbose=1)

synchronizeUserInformation

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

WebCenter Portalアプリケーションのポリシー・ストアとWebCenter Portalアプリケーション表のユーザー詳細を同期します。

構文

synchronizeUserInformation(appName, operationType, fileName, component, [dbVendor, dbHostNPort, dbName, dbUserName, verbose])

注意: このコマンドは、PolicyStore以外のすべてのコンポーネントに対してオフライン・モードで実行できます。

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

operationType

操作のタイプ。有効な値は、RENAME_GUID、RENAME_USERNAME、DELETE_USERです。

- RENAME GUID: 1人以上のユーザーに関連付けられているGUIDを変更します

- RENAME_USERNAME: 1人以上のユーザーの名前を変更します

- DELETE_USER: 1人以上のユーザーを削除します

fileName

変更または削除対象のユーザーのリストを含むファイルの完全修飾パス(ファイル名を含む)。

component

ユーザーを名前変更または削除するWebCenter Portalコンポーネント。

有効な値は、PolicyStore、Spaces、UCM、DISCUSSION、ALLです。

dbVendor

オプション。データベース・ベンダー。

有効な値は、Oracle、MSSQLおよびIBMDB2です。

component=PolicyStoreの場合は、不要です。

dbHostNPort

オプション。データベース・ホストおよびポート。host:portの形式を使用します。

component=PolicyStoreの場合は、不要です。

dbName

オプション。データベース名またはsid。

component=PolicyStoreの場合は、不要です。

dbSchemaName

オプション。WebCenter Portalデータベース・スキーマ名。

verbose

オプション。サマリー(0)または詳細な出力(1)を生成します。

デフォルト値は0です。

例

次の例では、次のようにrenamesusers.propertiesにリストされたWebCenter Portalユーザーの名前を変更します。

- monty=monty1

- pat=pat1

wls:/weblogic/serverConfig>
synchronizeUserInformation(appName='webcenter', operationType='RENAME_USERNAME',fileName='/home/mydir/renameusers.properties', component='Spaces',
dbVendor='Oracle', dbHostNPort='myDbHost.example.com:1521',dbName='myDb1',
dbSchemaName='webcenterUser1', verbose=1)

次の例では、delete.propertiesにリストされているユーザーのWebCenter Portalユーザー参照を削除します。

- monty=monty1

- pat=pat1

wls:/weblogic/serverConfig>
synchronizeUserInformation(appName='webcenter',operationType='DELETE_USERNAME',fileName='/home/mydir/delete.properties', component='Spaces',
dbVendor='Oracle', dbHostNPort='myDbHost.example.com:1521',dbName='myDb1',
dbSchemaName='webcenterUser1', verbose=1)

WebCenter Portalのインポートとエクスポート

表10-29に示すコマンドを使用して、Frameworkアプリケーションと関連付けられているSpacesアプリケーションおよびプロデューサ・メタデータをエクスポートおよびインポートします。

表10-29 インポートとエクスポートWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

exportWebCenterApplication

Spacesアプリケーションをエクスポート・アーカイブにエクスポートします。

オンライン

importWebCenterApplication

Spacesアプリケーションをエクスポート・アーカイブからインポートします。

オンライン

exportGroupSpaces

1つ以上のスペースをエクスポート・アーカイブにエクスポートします。

オンライン

exportGroupSpaceTemplates

1つ以上のスペース・テンプレートをエクスポート・アーカイブにエクスポートします。

オンライン

importGroupSpaces

1つ以上のスペースまたはスペース・テンプレートをエクスポート・アーカイブからインポートします。

オンライン

setSpaceState

スペースをオフラインにするか、スペースをオンラインにします。

オンライン

exportWebCenterResource

ポータル・リソースをエクスポート・アーカイブ(.EAR)にエクスポートします。

オンライン

importWebCenterResource

ポータル・リソースをエクスポート・アーカイブ(.EAR)からインポートします。

オンライン

exportPortletClientMetadata

(Frameworkアプリケーションのみ。)エクスポート・アーカイブにポートレット・クライアント・メタデータおよびプロデューサのカスタマイズとパーソナライズをエクスポートします。

オンライン

importPortletClientMetadata

(Frameworkアプリケーションのみ。)エクスポート・アーカイブからポートレット・クライアント・メタデータおよびプロデューサのカスタマイズとパーソナライズをインポートします。

オンライン

importWebCenterTranslations

Spacesアプリケーションに対する変換をインポートします。

オンライン

showProducerImportFailures

メタデータのインポートが失敗したプロデューサの名前およびそれらの失敗の理由を表示します

オンライン

retryAllFailedProducerImports

残りのプロデューサ・メタデータのインポートを試行します

オンライン

exportWebCenterApplication

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

(Spacesアプリケーションのみ)指定したファイル名を使用して、Spacesアプリケーションをエクスポート・アーカイブ( .EAR)にエクスポートします。

構文

exportWebCenterApplication(appName, fileName, [exportCustomizations, exportData, server, applicationVersion])

引数

定義

appName

この操作を実行するSpacesアプリケーションの名前。

fileName

エクスポートを書き込む必要があるエクスポート・アーカイブEARファイルの名前を示します。

exportCustomizations

オプション。有効な値は、1 (true)および0 (false)です。1に設定すると、すべてのアプリケーションのカスタマイズがエクスポートされます。0に設定すると、アプリケーションのカスタマイズはエクスポートされません。つまり、デフォルト・タスク・フローがカスタマイズを行わずにエクスポートされます。この引数のデフォルトは、1です。

exportData

オプション。有効な値は、1 (true)および0 (false)です。1に設定すると、Spacesデータベースに格納されているデータ(アクティビティ・ストリーム、イベント、フィードバック、リスト、リンク、メッセージ・ボード、ピープル・コネクション、プロファイルおよびタグ)がエクスポートされます。MDSリポジトリに格納されているデータもエクスポートされます。0に設定すると、このデータは、エクスポートされません。この引数のデフォルトは、0です。

server

オプション。Spacesアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。Spacesアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Spacesアプリケーションおよびすべての可能なデータをmyExport.earという名前のファイルにエクスポートします。

wls:/weblogic/serverConfig> exportWebCenterApplication(appName='webcenter',
fileName='myExport.ear', exportCustomizations=1, exportData=1)

次の例では、テスト・アプリケーションをエクスポートします。この場合、テスト時に作成したデータ(リスト、スペース・イベント、リンク、タグなど)は不要です。

wls:/weblogic/serverConfig> exportWebCenterApplication(appName='webcenter',
fileName='export.ear')

importWebCenterApplication

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

(Spacesアプリケーションのみ)Spacesアプリケーションをエクスポート・アーカイブ・ファイルからサーバーにインポートします。

Spacesアプリケーションのインポート後、アプリケーションがデプロイされている管理対象サーバーを再起動する必要があります。

構文

importWebCenterApplication(appName, fileName, [server, applicationVersion])

引数

定義

appName

この操作を実行するSpacesアプリケーションの名前。

fileName

インポートする必要があるエクスポート・アーカイブの名前。

server

オプション。Spacesアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。Spacesアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、エクスポート・アーカイブmyExport.earからSpacesアプリケーションをインポートします。

wls:/weblogic/serverConfig> importWebCenterApplication(appName='webcenter',
fileName='myExport.ear')

exportGroupSpaces

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

(Spacesアプリケーションのみ)指定したファイル名を使用して、1つ以上の指定したスペースをエクスポート・アーカイブ(.EAR)にエクスポートします。

スペース関連データ*、アプリケーションのカスタマイズ、およびセキュリティ情報がエクスポート・アーカイブに含まれています。

*Spacesデータベースに格納されている内部スペース関連データのみがエクスポートされます。たとえば、アクティビティ・ストリーム、イベント、フィードバック、リスト、リンク、メッセージ・ボード、ピープル・コネクション、プロファイル、タグなど、WebCenter Portalサービスに関連付けられているデータです。

エクスポート・プロセス中にデータの競合が発生しないように、一時的でも、Spacesをオフラインにする必要があります。

注意:

このコマンドを使用してホーム・スペースをエクスポートすることはできません。

構文

exportGroupSpaces(appName, fileName, names, [forceOffline, exportContentDirectory,  server, applicationVersion])

引数

定義

appName

この操作を行うSpacesアプリケーションの名前。常にwebcenterです。

fileName

エクスポートを書き込むローカル・ファイルの名前を示します。

names

エクスポートするスペースの名前。複数のスペース名をカンマで区切ります。

例: names='sales, finance'

注意: ここに表示名を入力しないてください。スペースURLに指定されているスペース名を入力する必要があります。スペース名は「スペースについて」ダイアログで確認できます。

forceOffline

オプション。エクスポート・プロセスを開始する前にスペースをオフラインにするかどうかを指定します。有効な値は1および0です。

- 1は、エクスポート・プロセスを開始する前にスペースをオフラインにします。

- 0は、スペースのエクスポートを試行します。現在1つ以上のスペースがオンラインの場合、情報メッセージによってスペースをオフラインにするように要求されます。

デフォルトは0です。

exportContentDirectory

オプション。ポータル・リソース用のコンテンツ・ディレクトリ・ファイルをエクスポートするかどうかを示します。有効な値は1および0です。

- 1 ポータル・リソースに関連付けられているコンテンツ・ディレクトリ全体をエクスポートします

- 0 すべてのポータル・リソース・コンテンツ・ディレクトリを除外します。除外した場合は、選択したスペースで使用するポータル・リソースのファイルを手動で移行できます。

デフォルトは0です。

注意: Spacesアプリケーションでは、ポータル・リソース・コンテンツを1つの共有コンテンツ・ディレクトリ(oracle\webcenter\siteresources\scopedMD\shared)に格納します。このディレクトリ全体がエクスポートされます。選択したスペースに固有のコンテンツをインポートすることはできません。

server

オプション。Spacesアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。Spacesアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、2つのスペース(mySpace1およびmySpace2)をwebcenterという名前のSpacesアプリケーションからエクスポートします。

wls:/weblogic/serverConfig> exportGroupSpaces(appName='webcenter',
fileName='myExport.ear', names='mySpace1, mySpace2')

次の例では、mySpace1およびmySpace2をオフラインにして、両方のスペースを、それらのポータル・リソースに関連付けられているコンテンツとともに、myExport.earという名前のアーカイブにエクスポートします。

wls:/weblogic/serverConfig> exportGroupSpaces(appName='webcenter',
fileName='myExport.ear', names='mySpace1, mySpace2', forceOffline=1, exportContentDirectory=1)

exportGroupSpaceTemplates

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

(Spacesアプリケーションのみ)指定したファイル名を使用して、1つ以上のスペース・テンプレートをエクスポート・アーカイブ(.EAR)にエクスポートします。

構文

exportGroupSpaceTemplates(appName, fileName, names, [exportContentDirectory,  server, applicationVersion])

引数

定義

appName

この操作を行うSpacesアプリケーションの名前。常にwebcenterです。

fileName

エクスポートを書き込むローカル・ファイルの名前を示します。

names

エクスポートするスペース・テンプレートの名前。複数のテンプレート名をカンマで区切ります。

exportContentDirectory

オプション。ポータル・リソース用のコンテンツ・ディレクトリ・ファイルをエクスポートするかどうかを示します。有効な値は1および0です。

- 1 ポータル・リソースに関連付けられているコンテンツ・ディレクトリ全体をエクスポートします

- 0 すべてのポータル・リソース・コンテンツ・ディレクトリを除外します。除外した場合は、選択したスペース・テンプレートで使用するポータル・リソースのファイルを手動で移行できます。

デフォルトは0です。

注意: Spacesアプリケーションでは、ポータル・リソース・コンテンツを1つの共有コンテンツ・ディレクトリ(oracle\webcenter\siteresources\scopedMD\shared)に格納します。このディレクトリ全体がエクスポートされます。選択したスペース・テンプレートに固有のコンテンツをインポートすることはできません。

server

オプション。Spacesアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。Spacesアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、2つのスペース・テンプレート(mySpaceTemplate1およびmySpaceTemplate2)をそれらのポータル・リソースに関連付けられているコンテンツとともに、myExport.earという名前のアーカイブにエクスポートします。

wls:/weblogic/serverConfig> exportGroupSpaceTemplates(appName='webcenter',
fileName='myExport.ear', names='mySpaceTemplate1, mySpaceTemplate2', exportContentDorectory=1)

importGroupSpaces

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

(Spacesアプリケーションのみ)1つ以上のスペースまたはスペース・テンプレートをエクスポート・アーカイブからインポートします。

注意: インポート・プロセス中にデータの競合が発生しないように、一時的でも、既存のスペースをオフラインにする必要があります。

構文

importGroupSpaces(appName, fileName, [importCustomizations,importSecurity, importData, parentSpace, forceOffline, overwriteContentDirectory, server, applicationVersion])

引数

定義

appName

この操作を行うSpacesアプリケーションの名前。常にwebcenterです。

fileName

インポートするアーカイブ・ファイルの名前。

importCustomizations

オプション。エクスポート・アーカイブからスペース・カスタマイズをインポートするかどうかを示します。有効な値は1および0です。

0に設定した場合:

- 新しいスペースはカスタマイズなしでインポートされます(つまり、デフォルト・タスク・フローがカスタマイズなしでインポートされ、デフォルトのスペース設定が使用されます)。

- ターゲット上にすでにI存在しているスペースをインポートする場合、そのターゲット上の既存のカスタマイズが保持されます。

この引数のデフォルトは、1です。

注意: ポートレットおよびページのカスタマイズは、常にインポートされます。

インポートにおいてどのカスタマイズがオプションであるかについては、『Oracle Fusion Middleware Oracle WebCenter管理者ガイド』のスペースのエクスポートおよびインポートの理解に関する項を参照してください。

importSecurity

オプション。エクスポート・アーカイブからスペース・メンバー詳細をインポートするかどうかを示します。有効な値は1および0です。

1に設定すると、スペースのロールおよびパーミッションが、メンバー詳細およびそれらのロール割当てとともにインポートされます。

0に設定すると、ロールおよびパーミッションのみがインポートされます。このオプションは、ステージ環境と本番環境の間を移行する場合や、テスト・フェーズ中に追加されたメンバー詳細が不要になった場合に便利です。この引数のデフォルトは、1です。

importData

オプション。エクスポート・アーカイブからデータをインポートするかどうかを示します。有効な値は1および0です。

1に設定すると、様々なWebCenter PortalサービスのSpacesデータベースに格納されているスペース関連のデータ(アクティビティ・ストリーム、イベント、フィードバック、リスト、リンク、メッセージ・ボード、ピープル・コネクション、プロファイルおよびタグ)がインポートされます。

0に設定すると、このデータは、インポートされません。このオプションは、ステージ環境と本番環境の間を移行する場合や、テスト・データが不要になった場合に便利です。この引数のデフォルトは、1です。

forceOffline

オプション。インポートする前にスペースをオフラインにします。有効な値は1および0です。

1に設定すると、すべてのスペースがオフラインになります。

この引数のデフォルトは、0です。

parentSpace

オプション。アーカイブでスペースを下に配置する親スペースの名前。指定した場合、インポートされたスペースはその親スペースの子になります。

この引数のデフォルトはnullです。親を指定しない場合、アーカイブされたスペースはルート・スペースとしてインポートされます。注意: アーカイブにスペース・テンプレートが含まれている場合、この引数は無視されます。

overwriteContentDirectory

オプション。アーカイブ内のファイルで、ターゲット内の既存のコンテンツ・ディレクトリ・ファイル(ポータル・リソースによって使用される)を上書きするかどうかを指定します。有効な値は1および0です。

- 1 アーカイブ内のファイルで、ターゲット内のコンテンツ・ディレクトリ・ファイルを上書きします

- 0 新しいファイル、つまり、ターゲット・コンテンツ・ディレクトリに存在しないファイルのみをインポートします。

デフォルトは0です。

注意: Spacesアプリケーションでは、ポータル・リソース・コンテンツを1つの共有コンテンツ・ディレクトリ(oracle\webcenter\siteresources\scopedMD\shared)に格納します。このディレクトリ全体がエクスポートされます。選択したスペース・テンプレートに固有のコンテンツをインポートすることはできません。

server

オプション。Spacesアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。Spacesアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myExport.earという名前のアーカイブからwebcenterという名前のSpacesアプリケーションにスペースまたはスペース・テンプレートをインポートします。

wls:/weblogic/serverConfig> importGroupSpaces(appName='webcenter',
fileName='myExport.ear')

次の例では、myExport.earのターゲット内の既存のスペースをすべてオフラインにし、myExport.ear内のすべてのスペースをSalesスペースの子としてインポートします。スペース・カスタマイズは、ポータル・リソースに関連付けられているコンテンツとともに、ターゲットにインポートされます。テスト・データおよびセキュリティ詳細は不要です。

wls:/weblogic/serverConfig> importGroupSpaces(appName='webcenter',
fileName='myExport.ear', importCustomizations=1, importSecurity=0, importData=0, parentSpace="Sales", forceOffline=1, overwriteContentDirectory=1)

exportWebCenterResource

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したファイル名を使用して、1つのポータル・リソースをエクスポート・アーカイブ(.EAR)にエクスポートします。

構文

exportWebCenterResource(appName, fileName, resourceType, resourceGUID,
[spaceName, exportContentDirectory, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

fileName

エクスポートを書き込むローカル・ファイルの名前を示します。

resourceType

エクスポートするリソースのタイプ。有効な値は、pageTemplate、contentPresenter、pageStyle、navigation、resourceCatalog、skin、taskFlow、mashupStyleです。

resourceGUID

エクスポートするリソースの一意のID (GUID)。

spaceName

オプション。(Spacesアプリケーションのみ)エクスポートするリソースを含むスペースの名前。この引数を使用して、特定のスペースによって所有されているリソースをエクスポートします。Spacesアプリケーションのアプリケーションレベル・リソースをエクスポートする場合、またはWebCenter Portalアプリケーションのリソースをエクスポートする場合は、この引数を省略します。

この引数のデフォルトは、nullです(アプリケーションレベル・リソースがエクスポートされます)。

exportContentDirectory

オプション。このポータル・リソースと関連付けられているコンテンツ・ディレクトリをエクスポートするかどうかを示します。有効な値は1および0です。

- 1 ポータル・リソースによって参照されるコンテンツをエクスポートします。個々のファイルではなく、ディレクトリ全体がエクスポートされます。ポータル・リソースが複数のディレクトリの場所のコンテンツを使用する場合、すべてのディレクトリがエクスポートされます。
たとえば、スキンによって2つのファイル(...\shared\skins\logos\mylogo.gifおよび...\shared\skins\icons\myicon.gif)が参照されている場合、\logosおよび\iconsのコンテンツ全体がエクスポートされます。

- 0 リソースによって参照されるコンテンツを除外します。除外した場合は、このリソースによって使用されるコンテンツ・ディレクトリまたは個々のファイルを手動で移行できます。

デフォルトは0です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、ページ・テンプレートをMySpaceから、myPageTemplateExport.earというローカル・ファイルにエクスポートします。

wls:/weblogic/serverConfig> exportWebCenterResource(appName='webcenter',
fileName='myPageTemplateExport.ear', resourceType='pageTemplate',
resourceGUID='gsr47d9a5ac_7398_439a_97d2_8b54ce905f7e, spaceName='MySpace')

次の例では、スキンを、myPortalAppというWebCenter PortalアプリケーションからmySkinExport.earというローカル・ファイルにエクスポートします。スキンによって参照されるコンテンツ・ディレクトリもエクスポートされます。

wls:/weblogic/serverConfig> exportWebCenterResource(appName='myPortalApp',
fileName='mySkinExport.ear', resourceType='skin',
resourceGUID='gsr47d9a5ac_7398_439a_97d2_8b54ce905f7e, exportContentDirectory=1)

importWebCenterResource

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したファイル名を使用して、1つのポータル・リソースをエクスポート・アーカイブ(.EAR)からインポートします。

構文

importWebCenterResource(appName, fileName, resourceType, [spaceName, server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。

fileName

インポートするアーカイブ・ファイルの名前。

resourceType

インポートするリソースのタイプ。有効な値は、pageTemplate、contentPresenter、pageStyle、navigation、resourceCatalog、skin、taskFlow、mashupStyleです。

spaceName

オプション。(Spacesアプリケーションのみ)リソースのインポート先のスペースの名前。

Spacesアプリケーションのアプリケーションレベル・リソースをインポートする場合、またはWebCenter Portalアプリケーションのリソースをインポートする場合は、この引数を省略します。この引数のデフォルトは、nullです(アプリケーションレベル・リソースがインポートされます)。

overwriteContentDirectory

オプション。アーカイブ内のファイルで、ターゲット内の既存のコンテンツ・ディレクトリ(ポータル・リソースによって使用される)を上書きするかどうかを指定します。有効な値は1および0です。

- 1 アーカイブ内のファイルで、ターゲット内のリソース・コンテンツ・ディレクトリ・ファイルを上書きします

- 0 新しいファイル、つまり、ターゲット・コンテンツ・ディレクトリに存在しないファイルのみをインポートします。

デフォルトは0です。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myPageTemplateExport.earという名前のアーカイブから、Spacesアプリケーション内のMySpaceにページ・テンプレートをインポートします。

wls:/weblogic/serverConfig> importWebCenterResource(appName='webcenter',fileName='myPageTemplateExport.ear', spaceName='MySpace', resourceType='pageTemplate')

次の例では、mySkinExport.earという名前のアーカイブからmyPortalAppという名前のWebCenter Portalアプリケーションにスキンをインポートします。インポート時に、スキンによって参照されるコンテンツ・ディレクトリが上書きされます。

wls:/weblogic/serverConfig> importWebCenterResource(appName='myPortalApp',fileName='mySkinExport.ear', resourceType='skin', overwriteContentDirectory=1)

exportPortletClientMetadata

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Frameworkアプリケーションのポートレット・クライアント・メタデータおよびプロデューサのカスタマイズとパーソナライズをエクスポートします。このコマンドは、指定したエクスポート・アーカイブ(.EARファイル)に、すべてのアプリケーションのプロデューサのメタデータをエクスポートします。特定のプロデューサを選択してメタデータをエクスポートすることはできません。

JDeveloperでWebCenter Portal: Frameworkを使用して開発されたWebCenter Portalアプリケーションに関連付けられているプロデューサ・データを移行する場合のみ、このコマンドを使用します。このコマンドはSpacesアプリケーションには使用しないでください。

構文

exportPortletClientMetadata(appName, fileName, [exportPersonalizations, server, applicationVersion])

引数

定義

appName

この操作を実行するFrameworkアプリケーションの名前。

fileName

エクスポートを書き込む必要があるエクスポート・アーカイブ( .EAR)の名前を示します。

exportPersonalizations

オプション。有効な値は、1 (true)および0 (false)です。1に設定すると、すべてのプロデューサのパーソナライズがエクスポートされます。0に設定すると、パーソナライズはエクスポートされません。この引数のデフォルトは、1です。

server

オプション。Frameworkアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。Frameworkアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myExport.earという名前のエクスポート・アーカイブにポートレット・クライアント・メタデータおよびプロデューサのカスタマイズをエクスポートします。パーソナライズはエクスポートされません。

wls:/weblogic/serverConfig> exportPortletClientMetadata(appName='myApp',
fileName='myExport.ear', exportPersonalizations=0)

importPortletClientMetadata

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定したエクスポート・アーカイブからポートレット・クライアント・メタデータおよびプロデューサのカスタマイズとパーソナライズをインポートします。

プロデューサのパーソナライズをエクスポートするかどうかはオプションです。指定されたエクスポート・アーカイブにパーソナライズが含まれている場合には、プロデューサのパーソナライズもインポートされます。

JDeveloperでWebCenter Portal: Frameworkを使用して開発されたWebCenter Portalアプリケーションのプロデューサ・データを移行する場合のみ、このコマンドを使用します。このコマンドはSpacesアプリケーションには使用しないでください。

構文

importPortletClientMetadata(appName, fileName, [server, applicationVersion])

引数

定義

appName

この操作を実行するFrameworkアプリケーションの名前。

fileName

インポートする必要があるエクスポート・アーカイブの名前。

server

オプション。Frameworkアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。Frameworkアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、myExport.earという名前のWebCenterエクスポート・アーカイブからポートレット・クライアント・メタデータおよびプロデューサのカスタマイズとパーソナライズをインポートします。

wls:/weblogic/serverConfig> importPortletClientMetadata(appName='app1',
fileName='myExport.ear')

importWebCenterTranslations

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Spacesアプリケーションのみ。Spacesアプリケーションで使用するための変換済コンテンツ(XLFファイル)をMDSおよびWebCenterリポジトリにインポートします。

構文

importWebCenterTranslations(appName, server, mdsRootDir, [applicationVersion])

引数

定義

appName

この操作を行うSpacesアプリケーションの名前。常にwebcenterです。

server

Spacesアプリケーションのデプロイ先のターゲット管理対象サーバーの名前。たとえば、WC_Spacesです。

mdsRootDir

変換済XLFファイルが含まれるファイル・システム上のMDSルート・ディレクトリ。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。この引数は、WebCenterアプリケーションの1つまたは複数のバージョンがデプロイされている場合に必要になります。

例

次の例では、ディレクトリ/scratch/shared/newmd内の 変換済コンテンツをMDSおよびWebCenter Portalリポジトリにインポートします。

wls:/weblogic/serverConfig> importWebCenterTranslations(appName='webcenter',
server='WC_Spaces', mdsRootDir='/scratch/shared/newmd')

setSpaceState

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

(Spacesアプリケーションのみ)スペースをオフラインにするか、スペースをオンラインにします。

構文

setSpaceState(appName, spaceName, offline, [server, applicationVersion])

引数

定義

appName

この操作を実行するアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

spaceName

オフラインまたはオンラインにするスペースの名前。

offline

スペースをオフラインにするか、オンラインに戻すかを指定します。有効な値は1および0です。

- 1はスペースをオフラインにします

- 0はスペースをオンラインにします

server

オプション。Spacesアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。Spacesアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、MySpaceをオフラインにします。

wls:/weblogic/serverConfig> setSpaceState(appName='webcenter', spaceName='MySpace', offline=1)

showProducerImportFailures

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

指定されたWebCenter Portalアプリケーション用の残りのプロデューサのインポートを一覧表示します。デプロイメント後に最初にアプリケーションを起動したときに、アプリケーションによって使用されるプロデューサを使用できない場合、プロデューサのインポートは失敗します。

構文

showProducerImportFailures(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

server

アプリケーションがデプロイされている管理対象サーバーの名前。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のアプリケーションに対するインポートの失敗を表示します。

wls:/weblogic/serverConfig> showProducerImportFailures(appName='webcenter')

retryAllFailedProducerImports

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

残りのプロデューサ・メタデータをインポートします。デプロイメント後に最初にアプリケーションを起動したときに、アプリケーションによって使用されるプロデューサを使用できない場合、プロデューサのインポートが失敗することがあります。このコマンドを使用して、前にメタデータのインポートが失敗したプロデューサのメタデータをインポートします。

構文

retryAllFailedProducerImports(appName, [server, applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

server

WebCenter Portalアプリケーションがデプロイされている管理対象サーバーの名前。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、webcenterという名前のアプリケーションの欠落しているプロデューサ・メタデータをインポートします。

wls:/weblogic/serverConfig> retryAllFailedProducerImports(appName='webcenter')

WebCenter Portalアップグレード

前のWebCenter Portalリリースからアップグレードする場合は、表10-30に示すコマンドを使用します。

Oracle Fusion Middleware Oracle SOA Suite、WebCenterおよびADFアップグレード・ガイドも参照してください。

表10-30 WebCenter PortalアップグレードWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

upgradeWebCenterDomain

WebCenter Portalドメインをアップグレードします。

オフライン

upgradeWebCenterPermissions

WebCenter Portalパーミッションをアップグレードします。

オンライン

upgradeWebCenterApplication

WebCenter Portalアプリケーションをアップグレードします。

オンライン

upgradeWebCenterDomain

モジュール: Oracle WebCenter

WLSTでの使用: オフライン

説明

WebCenter Portalドメインを、11.1.1.2.0または11.1.1.3.0から11.1.1.4.0にアップグレードします

構文

upgradeWebCenterDomain(domainDirName, [oracleHome], [upgradeCustomSpaces])

引数

定義

domainDirName

ドメインのホーム・ディレクトリのフル・パス。

たとえば、/home/Oracle/Domains/wc_domainです。

oracleHome

オプション。WebCenter PortalのOracleホーム・ディレクトリのパス。

たとえば、/home/Oracle/Middleware/Oracle_WCです。

upgradeCustomSpaces

オプション。custom.webcenter.spaces共有ライブラリをアップグレードするかどうかを決定します。有効な値は、1 (true)および0 (false)です。

Spacesアプリケーションをカスタマイズしており、アップグレードするときにそのカスタマイズを組み込む場合は、1に設定します。

デフォルト値は0です。

例

次の例では、base_domainという名前のWebCenter Portalドメインをアップグレードします。

wls:/weblogic/serverConfig> upgradeWebCenterDomain(domainDirName='/mw_home/user_project/domains/base_domain');

upgradeWebCenterPermissions

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Spacesアプリケーションに対するパーミッションをアップグレードします。

このコマンドは、Spaces 11.1.1.4.0に必要な追加のアプリケーション・ロールを作成し、いくつかの追加のパーミッションを付与します。

構文

upgradeWebCenterPermissions()

例

次の例では、Spacesアプリケーションに対するパーミッションをアップグレードします。

wls:/weblogic/serverConfig> upgradeWebCenterPermissions();

upgradeWebCenterApplication

モジュール: Oracle WebCenter

WLSTでの使用: オンライン

説明

Spacesアプリケーションを11.1.1.2.0または11.1.1.3.0から11.1.1.4.0にアップグレードします。

構文

upgradeWebCenterApplication(appName, [server], [applicationVersion])

引数

定義

appName

この操作を実行するWebCenter Portalアプリケーションの名前。Spacesアプリケーションの場合、名前は常にwebcenterです。

server

オプション。WebCenter Portalアプリケーションのデプロイ先の管理対象サーバーの名前。たとえば、WC_Spacesです。

この引数は、同じ名前のアプリケーションが別のサーバーにデプロイされている場合およびクラスタを持っている場合に必要になります。

applicationVersion

オプション。デプロイされたアプリケーションのバージョン番号を示します。WebCenter Portalアプリケーションの複数のバージョンがデプロイされている場合に必要です。

例

次の例では、Spacesアプリケーションをアップグレードします。

wls:/weblogic/serverConfig> upgradeWebCenterApplication(appName='webcenter');

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

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

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

- ADF固有のWLSTコマンド

注意:

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

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

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

ADF固有のWLSTコマンド

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

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

このコマンドを使用します...

次を行うには...

WLSTの使用...

adf_createFileUrlConnection

新しいADFファイル接続を作成します。

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

adf_createHttpUrlConnection

新しいADF URL接続を作成します。

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

adf_setURLConnectionAttributes

新しく作成したADF接続または既存のADF接続の属性を設定および編集します。

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

adf_listUrlConnection

新しいURL接続を一覧表示します。

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

getADFMArchiveConfig

指定したアーカイブのADFMArchiveConfigオブジェクトにハンドルを返します。

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

adf_createFileUrlConnection

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

説明

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

構文

adf_createFileURLConnection(appName, name, URL)

引数

定義

appName

接続が作成されるアプリケーション名

name

新しい接続の名前

URL

この接続に関連するURL

例

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

adf_createHttpUrlConnection

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

説明

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

構文

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

引数

定義

appName

接続が作成されるアプリケーション名

name

新しい接続の名前

url

(オプション)この接続に関連するURL

authenticationType

(オプション)デフォルトは「基本」です。

realm

(オプション)この接続は、認証のために使用する場合、これを設定する必要があります。デフォルトは「基本」です。

user

(オプション)

password

(オプション)

例

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

adf_setURLConnectionAttributes

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

説明

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

構文

adf_setURLConnectionAttributes(appname, connectionname, attributes)

引数

定義

appname

接続が作成されるアプリケーション名

connectionname

新しい接続の名前

attributes

キーと値のペアに設定する属性を含む配列。

例

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

adf_listUrlConnection

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

説明

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

構文

adf_listURLConnection(appname)

引数

定義

appname

アプリケーション名

例

adf_listURLConnection ('myapp')

getADFMArchiveConfig

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

説明

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

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

- setDatabaseJboSQLBuilder([value]) - データベースjbo.SQLBuilder属性を設定します。

- getDatabaseJboSQLBuilder() - jbo.SQLBuilder属性の現在の値を返します。

- setDatabaseJboSQLBuilderClass([value]) - データベースjbo.SQLBuilderClass属性を設定します。値は、カスタム・ビルダー・クラスのフルネームです。

- getDatabaseJboSQLBuilderClass() - jbo.SQLBuilderClass属性の現在の値を返します。

- setDefaultRowLimit([value]) - デフォルトrowLimit属性を設定します。値は、行制限を指定するlongです(デフォルト-1)。

- getDefaultRowLimit() - rowLimit属性の現在の値を返します。

- save([toLocation]) - toLocationを指定する場合、変更はターゲット・アーカイブ・ファイルに格納され、元のファイルは変更されないままです。それ以外の場合、変更は元のファイル自体に保存されます。

構文

archiveConfigObject = ADFMAdmin.getADFMArchiveConfig(fromLocation)

引数

定義

fromLocation

完全パスを含むearファイルの名前。

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

archiveConfigObject.setDatabaseJboSQLBuilder([value])

引数

定義

value

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

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

archiveConfigObject.getDatabaseJboSQLBuilder()

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

archiveConfigObject.setDatabaseJboSQLBuilderClass([value])

引数

定義

value

jbo.SQLBuilderClass属性の値。

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

archiveConfigObject.getDatabaseJboSQLBuilderClass()

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

archiveConfigObject.setDefaultRowLimit([value])

引数

定義

value

rowLimit属性の値。

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

archiveConfigObject.getDefaultRowLimit([value])

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

archiveConfigObject.save([toLocation])

引数

定義

toLocation

変更が保存先ファイルの絶対パスを含む名前。

例

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

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

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

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

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

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

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

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

12 ポータル・カスタムWLSTコマンド

ポータル・カスタムWLSTコマンドは、WLSTコマンドの拡張機能であり、Oracle Portal固有のものです。表12-1では、ポータル・カスタムWLSTコマンドのカテゴリを示します。

ポータルの管理と構成の詳細は、『Oracle Portalの構成ガイド』を参照してください。

注意:

これらのコマンドを使用するには、コンポーネントがインストールされているOracleホームからWLSTを呼び出す必要があります。Oracle Fusion Middleware管理者ガイドのカスタムWLSTコマンドの使用に関する項を参照してください。

表12-1 ポータルWLSTコマンド・カテゴリ

コマンド・カテゴリ

説明

データベース・アクセス記述子コマンド

一般的なDADまたはPortal DADを作成、編集または削除します。

構成コマンド

構成コマンドは:

- WebCache構成およびOracle Internet Directoryデータを表示し、更新します

- ポータル・キャッシュ、ポータル・ページ・エンジン、およびポータル中間層を構成します

- ポータル・サイトの構成の一覧を示します。

データベース・アクセス記述子コマンド

データベース・アクセス記述子(DAD)は、HTTPリクエストを処理するためにアプリケーションがOracleデータベースに接続する方法を指定する値のセットです。DADの情報には、データベースのユーザー名(スキーマと権限も指定する)、パスワード、接続文字列、およびグローバリゼーション・サポート言語が含まれています。

DADには、一般的なDADとPortal DADの2つの種類があります。Oracle Portal中層はPortal DADを使用して、Oracleメタデータ・リポジトリにアクセスします。一般的なDADの詳細は、『Oracle Fusion Middleware Oracle HTTP Server管理者ガイド』を参照してください。

表12-2で示したデータベース・アクセス記述子コマンドを使用して、WLSTコマンド行スクリプト・インタフェースからPortal DADを作成、編集または削除します。アクションに基づいてportal_dads.confファイルが更新されます。

表12-2 ポータルWLST構成のデータベース・アクセス記述子コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

listDads

構成するためにデータベース・アクセス記述子が使用するパラメータの一覧を表示します。

オンライン

createPortalDad

ポータル・データベース・アクセス記述子を作成します。

オンライン

updatePortalDad

ポータル・データベース・アクセス記述子の属性を更新します。

オンライン

deletePortalDad

ポータル・データベース・アクセス記述子を削除します。

オンライン

listDads

コマンド・カテゴリ: データベース・アクセス記述子コマンド

WLSTでの使用: オンライン

説明

すべてのデータベース・アクセス記述子(一般的なDADおよびPortal DADの両方)で指定したパラメータの一覧を表示します。

構文

listDads ()

例

次の例では、ドメイン内の様々なDADを表示します。

listDads()
------------
/pls/portal1
Schema: h1user
Connect String: foo.oracle.com:1521:orcl
NLS Language: "AMERICAN_AMERICA.AL32UTF8"

createPortalDad

コマンド・カテゴリ: データベース・アクセス記述子コマンド

WLSTでの使用: オンライン

説明

ポータル・データベース・アクセス記述子を作成します。

構文

createPortalDad (name, schema, password, [connect_string], nls_language)

引数

定義

name

データベース・アクセス記述子の名前。

schema

ポータル・データベース・アカウントのユーザー名。

password

ポータル・データベース・アカウントのパスワード。

connect_string

オプション。リモート・データベースに接続するために使用する接続文字列。

接続文字列は、ホスト名:ポート番号:接続文字列で構成される場合があります。接続文字列は、ServiceNameFormat (host:port:database_service_name)、SIDFormat (host:port:database_sid)またはTNSFormat (TNS別名または全体のTNSエントリ)の形式である場合もあります。

nls_language

このDADで表現されるポータル・データベースのグローバライゼーション・サポート言語。この設定は、データベース・セッションのNLS_LANG環境変数をオーバーライドし、応答文字セットを含む応答のいくつかの重要なグローバライゼーション・サポート・プロパティを定義します。

この言語設定がバックエンド・データベースのNLS_LANGに一致することを確認します。

例

次の例では、指定された引数に基づいてportal1 Portal DADを作成します。

createPortalDad(name='portal1',schema='schema',password='welcome1',connect_
string='foo.oracle.com:1521:orcl',nls_language='AMERICAN_AMERICA.AL32UTF8')

updatePortalDad

コマンド・カテゴリ: データベース・アクセス記述子コマンド

WLSTでの使用: オンライン

説明

ポータル・データベース・アクセス記述子の属性を更新します。

構文

updatePortalDad (name, [schema], [password], [connect_string], [nls_language])

引数

定義

name

データベース・アクセス記述子の名前。この名前は更新中に変更できません。

schema

オプション。ポータル・データベース・アカウントのユーザー名。

password

オプション。ポータル・データベース・アカウントのパスワード。

connect_string

オプション。リモート・データベースに接続するために使用する接続文字列。

接続文字列は、ホスト名:ポート番号:接続文字列で構成される場合があります。接続文字列は、ServiceNameFormat (host:port:database_service_name)、SIDFormat (host:port:database_sid)またはTNSFormat (TNS別名または全体のTNSエントリ)の形式である場合もあります。

nls_language

オプション。このDADで表現されるポータル・データベースのグローバライゼーション・サポート言語。この設定は、データベース・セッションのNLS_LANG環境変数をオーバーライドし、応答文字セットを含む応答のいくつかの重要なグローバライゼーション・サポート・プロパティを定義します。この言語設定がバックエンド・データベースのNLS_LANGに一致することを確認します。

例

次の例では、指定された引数に基づいてportal1 Portal DADを更新します。

updatePortalDad(name='portal1',schema='user1',password='welcome2',connect_
string='foo.oracle.com:1521:orcl',nls_language='AMERICAN_AMERICA.AL32UTF8')

deletePortalDad

コマンド・カテゴリ: データベース・アクセス記述子コマンド

WLSTでの使用: オンライン

説明

ポータル・データベース・アクセス記述子を削除します。

構文

deletePortalDad(name)

引数

定義

name

ポータル・データベース・アクセス記述子の名前。

例

次の例では、portal_dads.confファイルからportal1 Portal DADエントリを削除します。

deletePortalDad(name='portal1')

構成コマンド

表12-3に示す構成コマンドを使用して、ポータル・キャッシュ、WebCache、Oracle Internet Directoryデータなどを表示および構成します。

表12-3 ポータルWLST構成の構成コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

configurePortalCache

ポータル・キャッシュの属性を更新します。

オンライン

configurePortalPageEngine

ポータル中間層の属性を更新します。

オンライン

listPortalWebcacheConfigAttributes

WebCache構成の属性を一覧表示します。

オンライン

listPortalSiteConfigAttributes

ポータル・サイトの構成の属性を一覧表示します。

オンライン

listPortalOIDConfigAttributes

Oracle Internet Directory構成の属性を一覧表示します。

オンライン

setPortalWebcacheConfig

WebCache構成の属性を更新します。

オンライン

setPortalOIDConfig

Oracle Internet Directory構成の属性を更新します。

オンライン

setPortalMidtierConfig

ポータル中間層構成の属性を更新します。

オンライン

configurePortalCache

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

WLSTでの使用: オンライン

説明

ポータル・キャッシュは、Oracle Portalページおよびポートレットに対するファイル・システム・ベースのキャッシュです。ポータル・キャッシュは、検証ベースのキャッシングおよび期限ベースのキャッシングをサポートします。ポータル・キャッシュは、ポータルのコンテンツ・キャッシュおよびセッション・キャッシュの両方で構成されています。

このコマンドは、ポータル・キャッシュの属性を更新します。これらの構成の詳細は、<Middleware Home>/user_projects/domains/<DOMAIN_HOME>/servers/WLS_PORTAL/stage/portal/portal/configuration/portal_cache.confファイルに格納されます。

構文

configurePortalCache([enable], [directory], [total_size], [max_size],
[cleanup_time], [max_age])

引数

定義

enable

オプション。ポータルのコンテンツ・キャッシングおよびセッション・キャッシングを有効(On)または無効(Off)にします。

directory

オプション。キャッシュされるコンテンツが格納されるディレクトリ。

このディレクトリは存在し、読込みアクセス権および書込みアクセス権があることを確認します。

total_size

オプション。ポータル・キャッシュが使用できるディスク・スペースの総量(MB単位)。指定できる最大値は4 GBです。

max_size

オプション。キャッシュされたすべてのファイルの最大サイズ(バイト単位)。最大許容値は4 GBです。この制限を超える動的に生成されるコンテンツがキャッシュされません。

cleanup_time

オプション。キャッシュ・ストレージのクリーンアップを開始する時刻。クリーンアップを開始する日時を正確に定義するには、「Sunday-Saturday, Everyday, Everymonth」「hh:mm」の書式を使用します。

max_age

オプション。キャッシュされた単一のドキュメントの最大存続期間。この設定にすると、キャッシュ・システムが古いコンテンツを含まないようになります。新しいキャッシュ・ファイル用にスペースを作り出すために、古いキャッシュ・ファイルが削除されます。デフォルト値は30日です。

例

次の例では、ポータル・キャッシュを構成します。

configurePortalCache(enable=true,directory='/scratch/user/installs/Inst_1
/cache/PortalComponent/portal',total_size=10101010,max_size=12300033,cleanup_
time='Everyday 11:00',max_age=20)

configurePortalPageEngine

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

WLSTでの使用: オンライン

説明

Oracle Fusion Middleware Portalアーキテクチャは、3層アーキテクチャで設計されており、任意のブラウザから接続できます。この柔軟なアーキテクチャにより、必要に応じて各構成要素(ブラウザ、Oracle HTTP Serverリスナー、Oracle Database 11gおよびOracle Portal)を個別にアップグレードできます。

Oracle Portal中間層の一部であるPPE (Parallel Page Engine)は、Oracle Containers for Java EEおよびサービス・ページのリクエスト内で実行されるサーブレットです。PPEによって、ページ・メタデータの読込み、ポートレット・コンテンツに対応するプロバイダのコール、プロバイダのレスポンスの受入れ、および指定されたページ・レイアウトに従ったリクエストされたページの作成が行われます。

このコマンドは、ポータル中間層リポジトリ・サーブレットで使用される構成ファイルappConfig.xmlのプロパティを更新します。この構成ファイルは、$MWHOME/user_projects/domains/AllClassicDomain/servers/WLS_PORTAL/stage/portal/portal/configuration/ディレクトリにあります。

構文

configurePortalPageEngine([encrypt_key], [resource_url_key], [use_port], [use_
scheme], [x509certfile])

引数

定義

encrypt_key

オプション。WebCacheでキャッシュするために使用するヘッダーを暗号化するHMCAキーを指定します。これにより、キャッシュ・キーのセキュリティが向上し、不正なリクエストがキャッシュされたオブジェクトを取得する可能性が低くなります。

resource_url_key

オプション。このキーは、WSRPリソースおよびJPDKリソースのプロキシ処理によってリクエストされたURLに対してチェックサムを計算するためにPPEサーブレットで使用されます。WSRPリソースのプロキシ処理を機能させるには、キーの値に10文字以上の英数字値を設定する必要があります。また、JPDKのプロキシ処理では、プロバイダに対してJNDI環境変数(resourceUrlKeyとも呼ばれる)を設定する必要があります。

use_port

オプション。PPEがポータルにリクエストするときに使用されるポートをオーバーライドします。指定しない場合、デフォルトで、ページ・リクエストのポートが使用されます。useSchemeを設定する場合、usePort引数も設定する必要があります。

このオプションは、他の理由のためにも使用できますが、ほとんどはSSLがブラウザおよびPPEの間で実行されるがPPEおよびポータルの間で実行されないときに使用されます。この場合は、ループバック・リクエストの非SSLポートは、ブラウザで使用されるSSLポートと異なります。

use_scheme

オプション。PPEがポータルにリクエストを行うときに使用されるスキーム(HTTPまたはHTTPS)をオーバーライドします。指定しない場合、デフォルトでページ・リクエストのスキームが使用されます。useSchemeを設定する場合、usePort引数も設定する必要があります。

x509certfile

オプション。HTTPClientが暗黙的に信頼する証明書のリストを含むファイルを指定します。これらの証明書は、SSLを使用するHTTPClientによって行われたすべての接続に対するトラスト・ポイントとして追加されます。

例

次の例では、指定された引数に基づいてポータル・ページ・エンジンを更新します。

configurePortalPageEngine(encrypt_key='encryption key',resource_url_
key='foo.oracle.com',use_port=9999,use_scheme='page_engine_1',
x509certfile='file')

listPortalWebcacheConfigAttributes

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

WLSTでの使用: オンライン

説明

Portalリポジトリで使用されるWebCache構成の属性を一覧表示します。

構文

listPortalWebcacheConfigAttributes ([dad_name])

引数

定義

dad_name

オプション。データベース・アクセス記述子の名前。デフォルトのDAD名は、「portal」です。

例

次の例では、Portalリポジトリで使用されるWebCache構成を示します。無効化メッセージが送信されるWebCacheホスト名、無効化ユーザー名、パスワードおよび無効化メッセージの送信先の無効化ポートが表示されます。

listPortalWebcacheConfigAttributes(dad_name='portal1')listPortalWebcacheConfigAttributes('portal1')
---------------
WebCacheConfig
---------------
WebCache Host: foo.oracle.com
WebCache Invalidation Password: invalidator
WebCache Invalidation Port: 6523
WebCache Invalidation User: invalidator

listPortalSiteConfigAttributes

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

WLSTでの使用: オンライン

説明

ポータル・サイトの構成の属性を示します。

構文

listPortalSiteConfigAttributes ([dad_name])

引数

定義

dad_name

オプション。データベース・アクセス記述子の名前。デフォルトのDAD名は、「portal」です。

例

次の例では、ポータル・サイトの構成を示します。サイト・プロトコルはtrueまたはfalseに設定できます。サイト・プロトコルにfalseが設定される場合、HTTPはプロトコルで、サイト・プロトコルにtrueが設定される場合、HTTPSはプロトコルです。サイト・ホスト名およびポート番号も示します。

listPortalSiteConfigAttributes(dad_name='portal1')
listPortalSiteConfigAttributes('portal1')

---------------
SiteConfig
---------------
Site Protocol: false
Site Host: foo.oracle.com
Site Port: 8090

listPortalOIDConfigAttributes

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

WLSTでの使用: オンライン

説明

Oracle Internet Directory構成の属性を一覧表示します。

構文

listPortalOIDConfigAttributes ([dad_name])

引数

定義

dad_name

オプション。データベース・アクセス記述子の名前。デフォルトのDAD名は、「portal」です。

例

次の例では、Oracle Internet Directoryホスト名およびポート番号を含むOracle Internet Directoryデータを示します。

listPortalOIDConfigAttributes(dad_name='portal1')
listPortalOIDConfigAttributes('portal1')

---------------
OidConfig
---------------
OID Port: 13060
OID Host: foo.oracle.com

setPortalWebcacheConfig

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

WLSTでの使用: オンライン

説明

WebCacheでは、キャッシング、ページの組立ておよび圧縮機能が提供されています。Oracle WebCacheでは、静的なWebコンテンツと動的なWebコンテンツの両方の配信が高速化され、Oracle Fusion Middlewareのロード・バランシングおよびフェイルオーバーの機能が提供されます。

このコマンドはWebCache構成を更新します。

構文

setPortalWebcacheConfig([dad_name], [host], [inv_port], [inv_user],
[inv_passwd])

引数

定義

dad_name

オプション。データベース・アクセス記述子の名前。デフォルトのDAD名は、「portal」です。

host

オプション。無効化メッセージが送信されるWebCacheホストの名前。

inv_port

オプション。無効化メッセージが送信されるWebCacheポート番号。

inv_user

オプション。無効化メッセージの送信に使用されるユーザー名。

inv_password

オプション。WebCache無効化パスワード。

例

次の例では、指定された値に基づいてWebCache構成を更新します。

setPortalWebcacheConfig(dad_name='portal1',host='foo.oracle.com',
inv_port= '6523',inv_user= 'invalidator',inv_passwd=' invalidator')

setPortalOIDConfig

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

WLSTでの使用: オンライン

説明

Oracle Internet Directory構成の属性を更新します。

構文

setPortalOIDConfig ([dad_name], [host], [port], [protocol], [admin_user],
[admin_passwd])

引数

定義

dad_name

オプション。データベース・アクセス記述子の名前。デフォルトのDAD名は、「portal」です。

host

オプション。Oracle Internet Directoryのホスト名。

port

オプション。Oracle Internet Directoryのポート番号。

protocol

オプション。Oracle Internet Directoryのプロトコル。

admin_user

オプション。Oracle Internet Directory管理者の名前。

admin_passwd

オプション。Oracle Internet Directory管理者のパスワード。

例

次の例では、指定された値に基づいてOID構成を更新します。

setPortalOIDConfig(dad_name='portal1',
host='foo.oracle.com',port='13060',protocol=false,
admin_user='cn=orcladmin',admin_passwd='oracle1')

setPortalMidtierConfig

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

WLSTでの使用: オンライン

説明

最新のポータル中間層構成でポータル・リポジトリを更新します。

構文

setPortalMidtierConfig([dad_name], [ohs_host], [ohs_port], [ohs_protocol],
[webcache_host], [webcache_inv_user], [webcache_inv_port],
[webcache_inv_passwd])

引数

定義

dad_name

オプション。データベース・アクセス記述子の名前。デフォルトのDAD名は、「portal」です。

ohs_host

オプション。Oracle HTTP Serverホスト名。

ohs_port

オプション。Oracle HTTP Serverポート番号。

ohs_protocol

オプション。Oracle HTTP Serverプロトコル。

webcache_host

オプション。無効化メッセージが送信されるWebCacheホストの名前。

webcache_inv_user

オプション。無効化メッセージを送信するために使用するWebCacheユーザー名。

webcache_inv_port

オプション。無効化メッセージが送信されるWebCacheポート番号。

webcache_inv_passwd

オプション。WebCache無効化パスワード。

例

次の例では、指定された値に基づいてポータル中間層構成を更新します。

setPortalMidtierConfig(dad_name='portal1',ohs_host='foo.oracle.com',
ohs_port='8090',ohs_protocol=false,webcache_host='foo.oracle.com',
webcache_inv_user= 'invalidator',webcache_inv_port='6523',
webcache_inv_passwd='invalidator')

13 Java Required FilesカスタムWLSTコマンド

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

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

Java Required Filesコマンド

Java Required Files (JRF)アプリケーションおよびサービスで、管理対象サーバーまたはクラスタを構成する、および1つの管理対象サーバーまたはクラスタからアプリケーションおよびサービスをコピーし、別の管理対象サーバーまたはクラスタに適用するには、表13-1に指定されているコマンドを使用します。

WLST列で使用する場合は、オンラインとは、コマンドが実行中のサーバーに接続されている場合のみに使用されることを意味します。オフラインとは、コマンドが実行中のサーバーに接続されてない場合のみに使用されることを意味します。オンラインまたはオフラインとは、コマンドは両方の状況に使用できることを意味します。

注意:

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

表13-1 JRFコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

applyJRF

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

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

cloneDeployments

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

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

applyJRF

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

説明

Java Required Files (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')

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

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

次の項では、Oracle Fusion MiddlewareインフラストラクチャWebサービス(SOAコンポジット、ADFビジネス・コンポーネントおよびWebCenterサービスを含む)用のWebLogic Scripting Tool (WLST)コマンドについて説明します。これらのコマンドを使用して、コマンド行からWebサービスを管理できます。

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

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

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

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

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

- Oracle WSMリポジトリ管理のコマンド

- デプロイメント・ディスクリプタ移行のコマンド

Webサービスに対するこれらのWLSTコマンドの使用方法の詳細は、『Webサービスのためのセキュリティおよび管理者ガイド』を参照してください。

注意:

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

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

ポリシー・セット管理およびOracle WSMリポジトリ管理のコマンドのヘルプを表示するには、実行中のサーバー・インスタンスに接続し、help('wsmManage')と入力します。

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

WebサービスWLSTコマンドをオンライン・モードで使用して、次のことを実行できます。

- Webサービスの構成およびOracle WSMのポリシー管理タスクを実行します

- Oracle WSMリポジトリを各リリースでの新しい事前定義済ポリシーでアップグレードします

- ADFビジネス・コンポーネントおよびWebCenterサービスの固有デプロイメント記述子(PDD)ファイル内で永続化されているデプロイメント後のポリシー変更を移行し、ドメイン内のすべてのサーバー・インスタンスにポリシー変更を伝播します。

WebサービスWLSTコマンドによって、デプロイ済、アクティブ、および実行中のWebサービス・アプリケーションを管理します。それらは、WLSTオンライン・モードでどの場所でも実行できます。例:

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

WebサービスWLST構成およびポリシー管理コマンドは、Fusion Middleware Controlを使用して行えるものと同じ管理機能の多くを実行します。WLSTコマンドを使用して、ADFまたはWebCenterアプリケーションのWebサービスを管理する場合、特定のサーバー上の1つのアプリケーションにデプロイされているWebサービスにのみ変更を適用できます。アプリケーションがクラスタまたはマルチサーバー環境にデプロイされている場合、アプリケーションがデプロイされているサーバーそれぞれに同じ変更を行う必要があります。さらに、ADF、WebCenter Webサービスおよびクライアント・アプリケーションでアタッチ・ポリシーを設定または変更する場合、その変更を有効にするには、アプリケーションを再起動する必要があります。

対照的に、WLSTコマンドを使用してSOAコンポジットを管理する場合は、コマンドを発行する必要があるのは一度のみで、変更はコンポジット内のすべてのサーバー・インスタンスに伝播されます。SOAコンポジットでアタッチ・ポリシーを設定または変更する場合、再起動する必要はありません。SOAファブリック・ランタイム・エンジンによって、ポリシー管理の変更はすべて内部で実装されます。

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

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

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

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

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

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

/soainfra/AdminServer/HelloWorld#1_0
/soainfra/server1/HelloWorld#1_0

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

HelloWorld#1_0

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

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

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

SOAコンポジット名の指定

1つのドメイン内に複数のSOAパーティション・フォルダがある場合、次の形式を使用してパーティション名およびコンポジット名を指定する必要があります。

partition/composite[version]

次の例は、SOAコンポジット・アプリケーション名の形式の例を示しています。

default/myComposite[1.0]

1つのドメイン内に1つのSOAサーバー(非クラスタ化)および1つのみのSOAパーティション・フォルダがある場合、次の例に示すように、partitionパラメータを省略できます。

myComposite[1.0]

サービス名の指定

Webサービス名の複数のバージョン(ネームスペース)がある場合、次の形式を使用してネームスペースおよびサービス名を指定する必要があります。

{http://namespace/}serviceName

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

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

- ポリシー・セット管理コマンドの場合、ネームスペースとサービス名の両方が必要です。

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

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

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

コマンド・カテゴリ

定義

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

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

ポリシー管理のコマンド

サービスおよびクライアントに対して直接アタッチされているポリシーを表示および管理します。

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

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

Oracle WSMリポジトリ管理のコマンド

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

デプロイメント・ディスクリプタ移行のコマンド

クラスタ内でのデプロイ後のポリシー構成変更のスケーリングのため、またはドメイン内のアプリケーションのすべてのサーバー・インスタンスへの変更の伝播のために固有デプロイメント記述子を移行します。

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

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

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

このコマンドを使用します...

次を行うには...

WLSTの使用...

listWebServices

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

オンライン

listWebServicePorts

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

オンライン

listWebServiceConfiguration

アプリケーションまたはSOAコンポジットのWebサービスおよびポート構成を一覧表示します。

オンライン

setWebServiceConfiguration

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

オンライン

listWebServiceClients

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

オンライン

listWebServiceClientPorts

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

オンライン

listWebServiceClientStubProperties

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

オンライン

setWebServiceClientStubProperty

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

オンライン

setWebServiceClientStubProperties

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

オンライン

listWebServices

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

WLSTでの使用: オンライン

説明

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

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

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

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

/domain/server/application#version_number:
moduleName=helloModule, moduleType=web, serviceName={http://namespace/}service
/soainfra/AdminServer/soa-infra:
compositeName=default/HelloWorld[1.0],  moduleType=soa, serviceName=service

注意:

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

PS5より前にアセンブルされたアプリケーションの場合、ネームスペースはserviceNameの出力に表示されません。

構文

listWebServices (application,composite,[detail])

引数

定義

application

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

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

composite

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

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

detail

オプション。Webサービスのポートおよびポリシー詳細を一覧表示するかどうかを指定します。

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

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

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

例

次の例では、ドメイン内のすべてのアプリケーションおよびコンポジットのすべてのWebサービスを一覧表示します。この例ではサンプル出力を示します。

wls:/soainfra/serverConfig> listWebServices()
/soainfra/AdminServer/soa-infra :
compositeName=default/HelloWorld[1.0], moduleType=soa, serviceName=service
compositeName=default/Project1[1.0], moduleType=soa, serviceName=bpelprocess1_client_ep

/soainfra/AdminServer/HelloWorld#1_0 :
moduleName=j2wbasicPolicy, moduleType=web, serviceName=WssUsernameService

次の例では、detail引数をtrueに設定します。この例ではサンプル出力を示します。直接アタッチされているポリシーは、アプリケーションjaxws-sutのエンドポイントTestPortに対して有効ではありせん。

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

/jrfServer_domain/jrfServer_admin/jaxws-sut-no-policy :
moduleName=jaxws-service, moduleType=web, serviceName={http://namespace/}TestService
enableTestPage: true
enableWSDL: true

TestPort        http://host.domainexample.com:9315/jaxws-service/TestService
enable: true
enableREST: false
enableSOAP: true
maxRequestSize: -1
loggingLevel: NULL
wsat.flowOption: NEVER
wsat.version: DEFAULT
Constraint: No Constraint
(global) security : oracle/wss_saml_or_username_token_service_policy, enabled=true
/policysets/global/all-domains-default-web-service-policies : Domain("*")
reference.priority=1
Constraint: HTTPHeader('VIRTUAL_HOST_TYPE','external')
(global) security : oracle/wss10_message_protection_service_policy, enabled=true
/policysets/global/domainExternal : Domain("*")
Attached policy or policies are valid; endpoint is secure.

/jrfServer_domain/jrfServer_admin/jaxws-sut :
moduleName=jaxws-sut-service, moduleType=web, serviceName={http://namespace/}TestService
enableTestPage: true
enableWSDL: true

TestPort        http://host.domainexample.com:9315/jaxws-sut-service/TestService
enable: true
enableREST: false
enableSOAP: true
maxRequestSize: -1
loggingLevel: NULL
wsat.flowOption: NEVER
wsat.version: DEFAULT
management : oracle/log_policy, enabled=true
security : oracle/wss_username_token_service_policy , enabled=true , effective=false
Constraint: No Constraint
(global) security : oracle/wss_saml_or_username_token_service_policy, enabled=true
/policysets/global/all-domains-default-web-service-policies : Domain("*")
reference.priority=1
Constraint: HTTPHeader('VIRTUAL_HOST_TYPE','external')
(global) security : oracle/wss10_message_protection_service_policy, enabled=true
/policysets/global/domainExternal : Domain("*")
Attached policy or policies are valid; endpoint is secure.

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

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

- web - Webモジュール(EJB Webサービスを含む)で使用します

- soa - SOAコンポジットに必要です。

serviceName

ポート情報を一覧表示するアプリケーションまたはSOAコンポジットのWebサービスの名前。例: {http://namespace/}serviceName

例

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

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

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

listWebServiceConfiguration

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

WLSTでの使用: オンライン

説明

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

出力には、Webサービス・ポートの構成情報が表示されます。例:

enableREST: false
maxRequestSize: -1

構文

listWebServiceConfiguration(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

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

- web - Webモジュールで使用します(EJB Webサービスを含む)。

- soa - SOAコンポジットに必要です。

serviceName

ポート構成を一覧表示するアプリケーションまたはSOAコンポジットのWebサービスの名前。例: {http://namespace/}serviceName

subjectName

オプション。構成情報を一覧表示するポリシー・サブジェクト、ポートまたは操作。

例

次の例では、ドメインsoainfraにあるサーバーsoa1のアプリケーションHelloWorld#1_0のWebサービスおよびポート構成情報を一覧表示します。この例では、Webモジュール名はj2wbasicPolicyであり、サービス名はWssUsernameServiceであり、サブジェクトはJRFWssUsernamePortという名前のポートです。

wls:/wls-domain/serverConfig>listWebServiceConfiguration
('/soainfra/soa1/HelloWorld#1_0','j2wbasicPolicy','web',
'{http://namespace/}WssUsernameService','JRFWssUsernamePort')

setWebServiceConfiguration

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

WLSTでの使用: オンライン

説明

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

このコマンドの使用方法の詳細は、『Webサービスのためのセキュリティおよび管理者ガイド』のWebサービス・エンドポイントの構成に関する項に記載されています。

構文

setWebServiceConfiguration(application,moduleOrCompName,moduleType,serviceName,
subjectName,itemProperties)

引数

定義

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モジュールで使用します(EJB Webサービスを含む)。

- soa - SOAコンポジットに必要です。

serviceName

ポート構成を設定または変更するアプリケーションまたはSOAコンポジットのWebサービスの名前。例: {http://namespace/}serviceName

subjectName

構成情報を設定または変更するポリシー・サブジェクト、ポートまたは操作名。

itemProperties

設定または変更できる構成可能プロパティ。次の形式を使用してプロパティを指定します。

("name","value")

有効なポート構成の名前と値のペアは次のとおりです:

- enable - trueまたはfalse。デフォルトはtrueです。

- enableTestPage - trueまたはfalse。デフォルトはtrueです。

- enableWSDL - trueまたはfalse。デフォルトはtrueです。

- enableREST - trueまたはfalse。デフォルトはfalseです。

- maxRequestSize - long整数、値を設定しない場合は-1。デフォルトは-1です。

- loggingLevel - NULL、FINEST...SEVERE (java.util.logging.Level)。デフォルトはNULLです。

- wsat.flowOption - 原子性トランザクション・フロー・オプション。有効な値はNEVERです - トランザクションの調整コンテキストをエクスポートしません。(これはデフォルトです)SUPPORTS - トランザクションが使用可能である場合にトランザクションの調整コンテキストをエクスポートします。MANDATORY - トランザクションの調整コンテキストをエクスポートします。アクティブなトランザクションがない場合は、例外がスローされます。このプロパティは、SOAサービスに対してのみ有効です。

- wsat.version - 原始性トランザクション・バージョン。有効な値は、WSAT10、WSAT11、WSAT12およびDEFAULTです。このプロパティは、SOAサービスに対してのみ有効です。

原始性トランザクション・プロパティの詳細は、『Webサービスのためのセキュリティおよび管理者ガイド』のWebサービス原始性トランザクションの構成に関する項を参照してください。

注意: 構成アイテムに認識されないプロパティ名または無効な値が含まれている場合、この設定コマンドは拒否され、エラー・メッセージが表示されます。

例

次の例では、Webモジュールj2wbasicPolicyのサービスWssUsernameServiceのポートJRFWssUsernamePortを有効化します。このサービスは、ドメインsoainfraにあるサーバーsoa1のアプリケーションHelloWorld#1_0にあります。

wls:/wls-domain/serverConfig>setWebServiceConfiguration
('/soainfra/soa1/HelloWorld#1_0','j2wbasicPolicy','web',
'{http://namespace/}WssUsernameService','JRFWssUsernamePort',[("enable", "true")])

listWebServiceClients

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

WLSTでの使用: オンライン

説明

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

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

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

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

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

/soa_domain/soa_server1/soa-infra :        compositeName=default/Basic_SOA_Client[1.0], moduleType=soa, serviceRefName=Service1
Basic_soa_service_pt    serviceWSDLURI=http://host.domainexample.com:38001/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.

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

/soa_domain/soa_server1/AsynchronizedBC_asyncbc :        moduleName=Asychronized-AsynchronizedBC-context-root, moduleType=web, serviceRefName=callback
owsm.qa.server.serviceinterface.AppModule_asyncServiceImpl/_oracleAsyncResponseClient
Constraint: No Constraint
(global) security : oracle/wss_username_token_client_policy, enabled=true
/policysets/global/web_callback_add_1 : Module("*")
Attached policy or policies are valid; endpoint is secure.

/soa_domain/soa_server1/ADF_DC_4 :        moduleName=wsdl, moduleType=wsconn, serviceRefName=TestService
TestPort        serviceWSDLURI=http://host.domainexample.com:12345/jaxws-sut-service/TestService?wsdl
security : oracle/wss_username_token_client_policy, enabled=true, effective=false
Constraint: No Constraint
(global) security : oracle/wss11_username_token_with_message_protection_client_policy, enabled=true
/policysets/global/PolicySet-Testport : port('TestPort')                        reference.priority=1
Attached policy or policies are valid; endpoint is secure.

/soa_domain/AdminServer/adf_dc_to_bc :        moduleName=ADF_BC, moduleType=wsconn, serviceRefName=AppModuleService
AppModuleServiceSoapHttpPort    serviceWSDLURI=http://host.domainexample.com:12345/ADF_BC-ADF_BC-context-root/AppModuleService?wsdl
Constraint: No Constraint
(global) security : oracle/wss11_username_token_with_message_protection_client_policy, enabled=true
/policysets/global/web_reference_add_1 : Domain("soa_domain")
Attached policy or policies are valid; endpoint is secure.

構文

listWebServiceClients(application,composite,[detail])

引数

定義

application

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

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

composite

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

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

detail

オプション。Webサービス・クライアントのポートおよびポリシー詳細を一覧表示するかどうかを指定します。

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

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

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

例

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

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

次の例では、ドメインsoainfraにあるサーバーsoa1のアプリケーションjwsclient_1#1.10のWebサービス・クライアントを一覧表示します。

wls:/wls-domain/serverConfig>listWebServiceClients('soainfra/soa1/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)

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

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

- web - 非同期Webサービス・コールバック・クライアントで使用します。

- soa - SOAコンポジットに必要です。

- wsconn - ADF DC Webサービス・クライアント、ADF JAX-WS間接プロキシまたはWebCenterクライアントなど接続ベースのWebサービス・クライアントで使用します。

serviceRefName

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

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

例

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

wls:/soainfra/serverConfig> listWebServiceClientPorts
('/soainfra/soa1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient')

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

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

listWebServiceClientStubProperties

コマンド・カテゴリ: 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

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

- web - 非同期Webサービス・コールバック・クライアントで使用します。

- soa - SOAコンポジットに必要です。

- wsconn - ADF DC Webサービス・クライアント、ADF JAX-WS間接プロキシまたはWebCenterクライアントなど接続ベースのWebサービス・クライアントで使用します。

serviceRefName

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

portInfoName

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

例

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

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

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

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

- web - 非同期Webサービス・コールバック・クライアントで使用します。

- soa - SOAコンポジットに必要です。

- wsconn - ADF DC Webサービス・クライアント、ADF JAX-WS間接プロキシまたはWebCenterクライアントなど接続ベースのWebサービス・クライアントで使用します。

serviceRefName

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

portInfoName

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

propName

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

propValue

オプション。スタブ・プロパティ値。たとえば、'orakey'です。

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

例

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

wls:/soainfra/serverConfig>setWebServiceClientStubProperty
('/soainfra/soa1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort','keystore.recipient.alias','oracle')

setWebServiceClientStubProperties

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

WLSTでの使用: オンライン

説明

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

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

構文

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

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

- web - 非同期Webサービス・コールバック・クライアントで使用します。

- soa - SOAコンポジットに必要です。

- wsconn - ADF DC Webサービス・クライアント、ADF JAX-WS間接プロキシまたは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参照のみ

構成可能なプロパティの完全なリストは、『Webサービスのためのセキュリティおよび管理者ガイド』のWebサービス・クライアントの構成に関する項を参照してください。

例

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

wls:/soainfra/serverConfig>setWebServiceClientStubProperties('/soainfra/soa1/jwsclient_1#1.1.0',
'WssUsernameClient','wsconn','WssUsernameClient','JRFWssUsernamePort',
[("wsat.flowOption","SUPPORTS"),("wsat.Version","DEFAULT")] )

ポリシー管理のコマンド

表14-3に示すWLSTコマンドを使用して、直接アタッチされたOracle WSM Webサービスおよびクライアント・ポリシーを管理します。

ADF、WebCenter Webサービスおよびクライアント・アプリケーションでアタッチされたポリシーを設定または変更する場合、その変更を有効にするには、アプリケーションを再起動する必要があります。ポリシーの変更が完了した後、アラーム・メッセージが表示され、アプリケーションを再起動するように求められます。標準のstopApplicationおよびstartApplication WLSTコマンドを使用してアプリケーションを停止および再起動できます。これらのコマンドの詳細は、「デプロイメント・コマンド」を参照してください。

表14-3 WebサービスのWLSTの直接アタッチされたポリシーの管理コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

listAvailableWebServicePolicies

すべての使用可能なOracle Web Services Manager (WSM)ポリシーのリストをカテゴリまたはサブジェクト・タイプ別に表示します。

オンライン

listWebServicePolicies

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

オンライン

attachWebServicePolicy

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

オンライン

attachWebServicePolicies

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

オンライン

enableWebServicePolicy

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

オンライン

enableWebServicePolicies

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

オンライン

detachWebServicePolicy

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

オンライン

detachWebServicePolicies

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

オンライン

listWebServiceClientPolicies

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

オンライン

attachWebServiceClientPolicy

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

オンライン

attachWebServiceClientPolicies

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

オンライン

enableWebServiceClientPolicy

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

オンライン

enableWebServiceClientPolicies

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

オンライン

detachWebServiceClientPolicy

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

オンライン

detachWebServiceClientPolicies

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

オンライン

setWebServicePolicyOverride

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

オンライン

listAvailableWebServicePolicies

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

WLSTでの使用: オンライン

説明

すべての使用可能なOracle Web Services Manager (WSM)ポリシーのリストをカテゴリまたはサブジェクト・タイプ別に表示します。

構文

listAvailableWebServicePolicies([category],[subject])

引数

定義

category

オプション。ポリシー・カテゴリ。たとえば、'security'、'management'です。

subject

オプション。ポリシー・サブジェクト・タイプ。たとえば、'server'または'client'です。

例

次の例では、ドメイン内の使用可能なOracle WSMサーバー・セキュリティ・ポリシーをすべて一覧表示します。

wls:/wls-domain/serverConfig>listAvailableWebServicePolicies('security','server')

listWebServicePolicies

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

WLSTでの使用: オンライン

説明

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

この出力では、Webサービス・ポート名、それにアタッチされているOWSMポリシー、および該当する場合は、ポリシー・オーバーライド・プロパティを表示します。例:

HelloWorldPort:
security : oracle/wss_username_token_service_policy , enabled=true

構文

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

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

- web - Webサービス・アプリケーションで使用します(EJB Webサービスを含む)。

- soa - SOAコンポジットに必要です。

serviceName

ポート・ポリシー情報を一覧表示するアプリケーションまたはSOAコンポジットのWebサービスの名前。例: {http://namespace/}serviceName

subjectName

ポリシー・サブジェクト、ポートまたは操作名。

例

次の例では、ドメインsoainfraにあるサーバーsoa1のアプリケーションHelloWorld#1_0のWebサービス・ポート・ポリシー情報を一覧表示します。この例では、Webモジュール名はj2wbasicPolicyであり、サービス名はWssUsernameServiceであり、サブジェクトはJRFWssUsernamePortという名前のポートです。

wls:/wls-domain/serverConfig>listWebServicePolicies
('/soainfra/soa1/HelloWorld#1_0','j2wbasicPolicy','web',
'{http://namespace/}WssUsernameService','JRFWssUsernamePort')

次の例では、SOAコンポジットdefault/HelloWorld[1.0]のポート・ポリシー情報を一覧表示します。moduleTypeがSOAに設定されており、サービス名がHelloServiceであり、サブジェクトがHelloWorld_ptというポートであることに注意してください。

wls:/wls-domain/serverConfig>listWebServicePolicies
(None, 'default/HelloWorld[1.0]','soa','{http://namespace/}HelloService','HelloWorld_pt')

attachWebServicePolicy

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

WLSTでの使用: オンライン

説明

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

wsm-pmアプリケーションがWebLogic Serverにインストールされていて、使用可能になっている場合、policyURIはOracle WSM Policy Manager APIを介して検証されます。このコマンドで指定するPolicyURIが、すでにアタッチされているか存在している場合、そのポリシーが無効化されていると、このコマンドによってそれが有効化されます。

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

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。ADFおよびWebCenterアプリケーションの場合、アプリケーションの再起動を促すメッセージが表示されます。

構文

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

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

- web - Webサービス・アプリケーションで使用します(EJB Webサービスを含む)。

- soa - SOAコンポジットに必要です。

serviceName

アプリケーションまたはSOAコンポジットのWebサービスの名前。例: {http://namespace/}serviceName

subjectName

ポリシー・サブジェクト、ポートまたは操作の名前。

policyURI

Oracle WSMポリシー名URI。たとえば、'oracle/log_policy'です。

subjectType

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

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

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

例

次の例では、WebモジュールWssUsernameServiceのポートJRFWssUsernamePortにポリシーoracle/wss_username_token_service_policyをアタッチします。このWebサービスは、ドメインsoainfraにあるサーバーsoa1のアプリケーションHelloWorld#1_0の一部です。

wls:/wls-domain/serverConfig>attachWebServicePolicy
('/soainfra/soa1/HelloWorld#1_0','j2wbasicPolicy','web',
'{http://namespace/}WssUsernameService','JRFWssUsernamePort','oracle/wss_username_token_service_policy')

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

wls:/wls-domain/serverConfig>attachWebServicePolicy(None, 'default/HelloWorld[1.0]',
'soa','{http://namespace/}HelloService','HelloWorld_pt','oracle/log_policy')

attachWebServicePolicies

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

WLSTでの使用: オンライン

説明

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

wsm-pmアプリケーションがWebLogic Serverにインストールされていて、使用可能になっている場合、policyURIはOracle WSM Policy Manager APIを介して検証されます。このコマンドで指定するポリシーのいずれかが、すでにアタッチされているか存在している場合、このコマンドによって、すでにアタッチされているポリシーが有効化され(そのポリシーが無効化されている場合)、その他のものはアタッチされます。

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

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。ADFおよびWebCenterアプリケーションの場合、アプリケーションの再起動を促すメッセージが表示されます。

構文

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

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

- web - Webサービス・アプリケーションで使用します(EJB Webサービスを含む)。

- soa - SOAコンポジットに必要です。

serviceName

アプリケーションまたはSOAコンポジットのWebサービスの名前。例: {http://namespace/}serviceName

subjectName

ポリシー・サブジェクト、ポートまたは操作の名前。

policyURIs

Oracle WSMポリシー名URIのリスト。たとえば、["oracle/log_policy","oracle/wss_username_token_service_policy"]です。

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

subjectType

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

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

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

例

次の例では、WebモジュールWssUsernameServiceのポートJRFWssUsernamePortにポリシー"oracle/log_policy", "oracle/wss_username_token_service_policy"をアタッチします。このWebサービスは、ドメインsoainfraにあるサーバーsoa1のアプリケーションHelloWorld#1_0の一部です。

wls:/wls-domain/serverConfig>attachWebServicePolicies
('/soainfra/soa1/HelloWorld#1_0','j2wbasicPolicy','web',
'{http://namespace/}WssUsernameService','JRFWssUsernamePort',
["oracle/log_policy", "oracle/wss_username_token_service_policy"])

enableWebServicePolicy

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

WLSTでの使用: オンライン

説明

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

このコマンドで指定するポリシーがポートにアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。ADFおよびWebCenterアプリケーションの場合、アプリケーションの再起動を促すメッセージが表示されます。

構文

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

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

- web - Webサービス・アプリケーションで使用します(EJB Webサービスを含む)。

- soa - SOAコンポジットに必要です。

serviceName

アプリケーションまたはSOAコンポジットのWebサービスの名前。例: {http://namespace/}serviceName

subjectName

ポリシー・サブジェクト、ポートまたは操作の名前。

policyURI

Oracle WSMポリシー名URI。たとえば、'oracle/log_policy'です。

指定するポリシーがアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

enable

オプション。ポリシーを有効化するのか無効化するのかを指定します。有効なオプションは次のとおりです:

- true - ポリシーを有効化します。デフォルトはtrueです。

- false - ポリシーを無効化します。

この引数を省略した場合、ポリシーが有効化されます。

subjectType

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

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

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

例

次の例では、WebモジュールWssUsernameServiceのポートJRFWssUsernamePortにアタッチされているポリシーoracle/wss_username_token_service_policyを有効化します。このWebサービスは、ドメインsoainfraにあるサーバーsoa1のアプリケーションHelloWorld#1_0の一部です。

wls:/wls-domain/serverConfig>enableWebServicePolicy
('/soainfra/soa1/HelloWorld#1_0','j2wbasicPolicy','web',
'{http://namespace/}WssUsernameService','JRFWssUsernamePort',"oracle/wss_username_token_service_policy",true)

次の例では、SOAコンポジットdefault/HelloWorld[1.0]のサービスHelloServiceのポートHelloWorld_ptにアタッチされているポリシーoracle/log_policyを有効化します。

wls:/wls-domain/serverConfig>enableWebServicePolicy(None, 'default/HelloWorld[1.0]',
'soa','{http://namespace/}HelloService','HelloWorld_pt','oracle/log_policy')

次の例では、SOAコンポジットdefault/HelloWorld[1.0]のサービスHelloServiceのポートHelloWorld_ptにアタッチされているポリシーoracle/log_policyを無効化します。

wls:/wls-domain/serverConfig>enableWebServicePolicy(None, 'default/HelloWorld[1.0]',
'soa','{http://namespace/}HelloService','HelloWorld_pt','oracle/log_policy',false)

enableWebServicePolicies

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

WLSTでの使用: オンライン

説明

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

このコマンドで指定するpolicyURIsがポートにアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。ADFおよびWebCenterアプリケーションの場合、アプリケーションの再起動を促すメッセージが表示されます。

構文

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

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

- web - Webサービス・アプリケーションで使用します(EJB Webサービスを含む)。

- soa - SOAコンポジットに必要です。

serviceName

アプリケーションまたはSOAコンポジットのWebサービスの名前。例: {http://namespace/}serviceName

subjectName

ポリシー・サブジェクト、ポートまたは操作の名前。

policyURIs

Oracle WSMポリシー名URIのリスト。たとえば、["oracle/log_policy","oracle/wss_username_token_service_policy"]です。

指定するpolicyURIsがアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

enable

オプション。ポリシーを有効化するのか無効化するのかを指定します。有効なオプションは次のとおりです:

- true - ポリシーを有効化します。デフォルトはtrueです。

- false - ポリシーを無効化します。

この引数を省略した場合、ポリシーが有効化されます。

subjectType

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

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

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

例

次の例では、WebモジュールWssUsernameServiceのポートJRFWssUsernamePortにアタッチされているポリシー["oracle/log_policy","oracle/wss_username_token_service_policy"]を有効化します。このWebサービスは、ドメインsoainfraにあるサーバーsoa1のアプリケーションHelloWorld#1_0の一部です。

wls:/wls-domain/serverConfig>enableWebServicePolicy
('/soainfra/soa1/HelloWorld#1_0','j2wbasicPolicy','web',
'{http://namespace/}WssUsernameService','JRFWssUsernamePort',["oracle/log_policy",
"oracle/wss_username_token_service_policy"],true)

detachWebServicePolicy

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

WLSTでの使用: オンライン

説明

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

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。ADFおよびWebCenterアプリケーションの場合、アプリケーションの再起動を促すメッセージが表示されます。

構文

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

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

- web - Webサービス・アプリケーションで使用します(EJB Webサービスを含む)。

- soa - SOAコンポジットに必要です。

serviceName

アプリケーションまたはSOAコンポジットのWebサービスの名前。例: {http://namespace/}serviceName

subjectName

ポリシー・サブジェクト、ポートまたは操作の名前。

policyURI

Oracle WSMポリシー名URI。たとえば、'oracle/log_policy'です。

指定するポリシーがアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

subjectType

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

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

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

例

次の例では、WebモジュールWssUsernameServiceのポートJRFWssUsernamePortからポリシーoracle/wss_username_token_service_policyをデタッチします。このWebサービスは、ドメインsoainfraにあるサーバーsoa1のアプリケーションHelloWorld#1_0の一部です。

wls:/wls-domain/serverConfig>detachWebServicePolicy
('/soainfra/soa1/HelloWorld#1_0','j2wbasicPolicy','web',
'{http://namespace/}WssUsernameService','JRFWssUsernamePort','oracle/wss_username_token_service_policy')

次の例では、ポリシーoracle/log_policyを、SOAコンポジットdefault/HelloWorld[1.0]のサービスHelloServiceのポートHelloWorld_ptからデタッチします。

wls:/wls-domain/serverConfig>detachWebServicePolicy(None, 'default/HelloWorld[1.0]',
'soa','{http://namespace/}HelloService','HelloWorld_pt','oracle/log_policy')

detachWebServicePolicies

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

WLSTでの使用: オンライン

説明

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

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

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。ADFおよびWebCenterアプリケーションの場合、アプリケーションの再起動を促すメッセージが表示されます。

構文

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

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

- web - Webサービス・アプリケーションで使用します(EJB Webサービスを含む)。

- soa - SOAコンポジットに必要です。

serviceName

アプリケーションまたはSOAコンポジットのWebサービスの名前。例: {http://namespace/}serviceName

subjectName

ポリシー・サブジェクト、ポートまたは操作の名前。

policyURIs

Oracle WSMポリシー名URIのリスト。たとえば、["oracle/log_policy","oracle/wss_username_token_service_policy"]です。

指定するpolicyURIがアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

subjectType

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

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

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

例

次の例では、WebモジュールWssUsernameServiceのポートJRFWssUsernamePortからポリシー"oracle/log_policy", "oracle/wss_username_token_service_policy"をデタッチします。このWebサービスは、ドメインsoainfraにあるサーバーsoa1のアプリケーションHelloWorld#1_0の一部です。

wls:/wls-domain/serverConfig>detachWebServicePolicies
('/soainfra/soa1/HelloWorld#1_0','j2wbasicPolicy','web',
'{http://namespace/}WssUsernameService','JRFWssUsernamePort',
["oracle/log_policy","oracle/wss_username_token_service_policy"])

listWebServiceClientPolicies

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

WLSTでの使用: オンライン

説明

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

この出力では、Webサービス・クライアント/参照ポート名、およびそれにアタッチされているOracle WSMポリシーを表示します。例:

test-port:
security: oracle/wss_username_token_client_policy, enabled=true

構文

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

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

- web - 非同期Webサービス・コールバック・クライアントで使用します。

- soa - SOAコンポジットに必要です。

- wsconn - ADF DC Webサービス・クライアント、ADF JAX-WS間接プロキシまたはWebCenterクライアントなど接続ベースのWebサービス・クライアントで使用します。

serviceRefName

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

portInfoName

クライアント・ポート名。

例

次の例では、ドメインsoainfraにあるサーバーsoa1のアプリケーションjwsclient_1#1.1.0のWebサービス・クライアント・ポート・ポリシー情報を一覧表示します。この例では、Webモジュール名はWssUsernameClientであり、モジュール・タイプはwsconnであり、サービス参照名はWssUsernameClientであり、クライアント・ポート名はJRFWssUsernamePortです。

wls:/wls-domain/serverConfig>listWebServiceClientPolicies
('/soainfra/soa1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort')

attachWebServiceClientPolicy

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

WLSTでの使用: オンライン

説明

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

wsm-pmアプリケーションがWebLogic Serverにインストールされていて、使用可能になっている場合、policyURIはOracle WSM Policy Manager APIを介して検証されます。このコマンドで指定するPolicyURIが、すでにアタッチされているか存在している場合、そのポリシーが無効化されていると、このコマンドによってそれが有効化されます。

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

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。ADFおよびWebCenterアプリケーションの場合、アプリケーションの再起動を促すメッセージが表示されます。

構文

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

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

- web - 非同期Webサービス・コールバック・クライアントで使用します。

- soa - SOAコンポジットに必要です。

- wsconn - ADF DC Webサービス・クライアント、ADF JAX-WS間接プロキシまたはWebCenterクライアントなど接続ベースのWebサービス・クライアントで使用します。

serviceRefName

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

portInfoName

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

policyURI

Oracle WSMポリシー名URI。たとえば、oracle/wss_username_token_client_policy"です。

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

subjectType

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

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

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

例

次の例では、WebモジュールWssUsernameClientのポートJRFWssUsernamePortにクライアント・ポリシーoracle/wss_username_token_client_policyをアタッチします。このWebサービスは、ドメインsoainfraにあるサーバーsoa1のアプリケーションjwsclient_1#1.1.0の一部です。

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

次の例では、クライアント・ポリシー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')

attachWebServiceClientPolicies

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

WLSTでの使用: オンライン

説明

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

wsm-pmアプリケーションがWebLogic Serverにインストールされていて、使用可能になっている場合、policyURIはOracle WSM Policy Manager APIを介して検証されます。このコマンドで指定するポリシーが、すでにアタッチされているか存在している場合、このコマンドによって、すでにアタッチされているポリシーが有効化され(そのポリシーが無効化されている場合)、その他のものはアタッチされます。

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

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。ADFおよびWebCenterアプリケーションの場合、アプリケーションの再起動を促すメッセージが表示されます。

構文

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

引数

定義

application

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

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

moduleOrCompName

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

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

moduleType

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

- web - 非同期Webサービス・コールバック・クライアントで使用します。

- soa - SOAコンポジットに必要です。

- wsconn - ADF DC Webサービス・クライアント、ADF JAX-WS間接プロキシまたはWebCenterクライアントなど接続ベースのWebサービス・クライアントで使用します。

serviceRefName

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

portInfoName

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

policyURI

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

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

subjectType

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

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

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

例

次の例では、WebモジュールWssUsernameClientのポートJRFWssUsernamePortにポリシーoracle/wss_username_token_client_policyをアタッチします。このWebサービスは、ドメインsoainfraにあるサーバーsoa1のアプリケーションjwsclient_1#1.1.0の一部です。

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

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

enableWebServiceClientPolicy

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

WLSTでの使用: オンライン

説明

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

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。ADFおよびWebCenterアプリケーションの場合、アプリケーションの再起動を促すメッセージが表示されます。

構文

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

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

- web - 非同期Webサービス・コールバック・クライアントで使用します。

- soa - SOAコンポジットに必要です。

- wsconn - ADF DC Webサービス・クライアント、ADF JAX-WS間接プロキシまたはWebCenterクライアントなど接続ベースのWebサービス・クライアントで使用します。

serviceRefName

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

portInfoName

Oracle WSMクライアント・ポリシーをアタッチするクライアント・ポートの名前。

policyURI

Oracle WSMポリシー名URI。たとえば、oracle/wss_username_token_client_policy"です。

enable

オプション。ポリシーを有効化するのか無効化するのかを指定します。有効なオプションは次のとおりです:

- true - ポリシーを有効化します。デフォルトはtrueです。

- false - ポリシーを無効化します。

この引数を省略した場合、ポリシーが有効化されます。

subjectType

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

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

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

例

次の例では、WebモジュールWssUsernameClientのポートJRFWssUsernamePortのクライアント・ポリシーoracle/wss_username_token_client_policyを有効化します。このWebサービスは、ドメインsoainfraにあるサーバーsoa1のアプリケーションjwsclient_1#1.1.0の一部です。

wls:/wls-domain/serverConfig>enableWebServiceClientPolicy
('/soainfra/soa1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort', "oracle/wss_username_token_client_policy",true)

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

enableWebServiceClientPolicies

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

WLSTでの使用: オンライン

説明

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

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。ADFおよびWebCenterアプリケーションの場合、アプリケーションの再起動を促すメッセージが表示されます。

構文

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

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

- web - 非同期Webサービス・コールバック・クライアントで使用します。

- soa - SOAコンポジットに必要です。

- wsconn - ADF DC Webサービス・クライアント、ADF JAX-WS間接プロキシまたはWebCenterクライアントなど接続ベースのWebサービス・クライアントで使用します。

serviceRefName

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

portInfoName

Oracle WSMクライアント・ポリシーをアタッチするクライアント・ポートの名前。

policyURIs

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

enable

オプション。ポリシーを有効化するのか無効化するのかを指定します。有効なオプションは次のとおりです:

- true - ポリシーを有効化します。デフォルトはtrueです。

- false - ポリシーを無効化します。

この引数を省略した場合、ポリシーが有効化されます。

subjectType

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

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

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

例

次の例では、WebモジュールWssUsernameClientのポートJRFWssUsernamePortのクライアント・ポリシーoracle/log_policyおよびoracle/wss_username_token_client_policyを有効化します。このWebサービスは、ドメインsoainfraにあるサーバーsoa1のアプリケーションjwsclient_1#1.1.0の一部です。

wls:/wls-domain/serverConfig>enableWebServiceClientPolicies
('/soainfra/soa1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort',
["oracle/log_policy", "oracle/wss_username_token_client_policy"], true )

detachWebServiceClientPolicy

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

WLSTでの使用: オンライン

説明

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

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。ADFおよびWebCenterアプリケーションの場合、アプリケーションの再起動を促すメッセージが表示されます。

構文

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

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

- web - 非同期Webサービス・コールバック・クライアントで使用します。

- soa - SOAコンポジットに必要です。

- wsconn - ADF DC Webサービス・クライアント、ADF JAX-WS間接プロキシまたはWebCenterクライアントなど接続ベースのWebサービス・クライアントで使用します。

serviceRefName

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

portInfoName

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

policyURI

Oracle WSMポリシー名URI。たとえば、oracle/wss_username_token_client_policy"です。

指定するポリシーがアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

subjectType

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

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

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

例

次の例では、WebモジュールWssUsernameClientのポートJRFWssUsernamePortからクライアント・ポリシーoracle/wss_username_token_client_policyをデタッチします。このWebサービスは、ドメインsoainfraにあるサーバーsoa1のアプリケーションjwsclient_1#1.1.0の一部です。

wls:/wls-domain/serverConfig>detachWebServiceClientPolicy
('/soainfra/soa1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort','oracle/wss_username_token_client_policy')

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

detachWebServiceClientPolicies

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

WLSTでの使用: オンライン

説明

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

注意:

このWLSTコマンドを使用して行ったポリシー変更は、ご使用のアプリケーションを再起動した後のみ有効になります。ADFおよびWebCenterアプリケーションの場合、アプリケーションの再起動を促すメッセージが表示されます。

構文

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

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

- web - 非同期Webサービス・コールバック・クライアントで使用します。

- soa - SOAコンポジットに必要です。

- wsconn - ADF DC Webサービス・クライアント、ADF JAX-WS間接プロキシまたはWebCenterクライアントなど接続ベースのWebサービス・クライアントで使用します。

serviceRefName

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

portInfoName

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

policyURI

Oracle WSMポリシー名URI。たとえば、oracle/wss_username_token_client_policy"です。

指定するポリシーがアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

subjectType

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

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

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

例

次の例では、WebモジュールWssUsernameClientのポートJRFWssUsernamePortからクライアント・ポリシーoracle/log_policyおよびoracle/wss_username_token_client_policyをデタッチします。このWebサービスは、ドメインsoainfraにあるサーバーsoa1のアプリケーションjwsclient_1#1.1.0の一部です。

wls:/wls-domain/serverConfig>detachWebServiceClientPolicies
('/soainfra/soa1/jwsclient_1#1.1.0','WssUsernameClient','wsconn',
'WssUsernameClient','JRFWssUsernamePort',
["oracle/log_policy","oracle/wss_username_token_client_policy"])

setWebServicePolicyOverride

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

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サービス・アプリケーションで使用します。

- soa - SOAコンポジットに必要です。

serviceName

アプリケーションまたはSOAコンポジットのWebサービスの名前。例: {http://namespace/}serviceName

subjectName

ポリシー・サブジェクト、ポートまたは操作の名前。

policyURI

Oracle WSMポリシー名URI。たとえば、オーバーライド・プロパティが適用される'oracle/log_policy'です。

指定するポリシーがアタッチされていない場合、エラー・メッセージの表示または例外のスロー、あるいはその両方が実行されます。

properties

ポリシー・オーバーライド・プロパティ。次の形式を使用してプロパティを指定する必要があります。

[("name","value")]

例: [("myprop","myval")]

この引数をNoneに設定すると、すべてのポリシー・オーバーライドが削除されます。

例

次の例では、WebモジュールWssUsernameServiceのポートJRFWssUsernamePortのポリシーoracle/wss10_message_protection_service_policyのオーバーライド・プロパティを構成します。このWebサービスは、ドメインsoainfraにあるサーバーsoa1のアプリケーションHelloWorld#1_0の一部です。

wls:/wls-domain/serverConfig>setWebServicePolicyOverride
('/soainfra/soa1/HelloWorld#1_0','j2wbasicPolicy',
'web','{http://namespace/}WssUsernameService','JRFWssUsernamePort',
"oracle/wss10_message_protection_service_policy",
[("keystore.sig.csf.key","sigkey")])

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

ポリシー・セットは、1つ以上のポリシーをサブジェクト・タイプにグローバルにアタッチするメカニズムを提供することで、エンタープライズのセキュリティおよび管理性を向上します。ポリシー・セットを使用すると、管理者は、何も直接アタッチすることなく、強制するポリシーのデフォルト・セットを指定できます。ポリシー・セットをアタッチできるリソースのタイプおよび範囲の決定の詳細は、『Webサービスのためのセキュリティおよび管理者ガイド』のポリシー・セットの作成と管理に関する項を参照してください。

すべてのポリシー・セットの作成、変更または削除コマンドは、リポジトリ・セッションのコンテキストで実行する必要があります。リポジトリ・セッションは、1つのドキュメント上でのみ機能できます。

注意:

この章の手順は、Oracle Infrastructure Web Serviceにのみ適用されます。

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

表14-4に示すWLSTコマンドを使用して、グローバルに使用可能なWSM Webサービス・ポリシー・セットを管理します。

表14-4 WebサービスのWLSTのグローバルに使用可能なポリシー・セット管理コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

beginRepositorySession

Oracle WSMリポジトリを変更するセッションを開始します。

オンライン

commitRepositorySession

Oracle WSMリポジトリに現在のセッションのコンテンツを書き込みます。

オンライン

describeRepositorySession

現在のリポジトリ・セッションのコンテンツを記述します。

オンライン

abortRepositorySession

現在のOracle WSMリポジトリ変更セッションを中止し、そのセッション中にリポジトリに対して行われた変更をすべて破棄します。

オンライン

createPolicySet

新しい空のポリシー・セットを作成します。

オンライン

listPolicySets

リポジトリ内のポリシー・セットを一覧表示します。

オンライン

clonePolicySet

既存のポリシー・セットから新しいポリシー・セットをクローニングします。

オンライン

displayPolicySet

指定したポリシー・セットの構成を表示します。

オンライン

modifyPolicySet

現在のセッションで変更する既存のポリシー・セットを指定します。

オンライン

setPolicySetPolicyOverride

現在のポリシー・セットのポリシー参照に構成オーバーライドを追加します。

オンライン

setPolicySetConstraint

セッション内で選択されたポリシー・セットのための実行時制約値を指定します。

オンライン

enablePolicySet

ポリシー・セットを有効化または無効化します。

オンライン

enablePolicySetPolicy

ポリシーのURIを使用してポリシー・セットのポリシー・アタッチメントを有効化または無効化します。

オンライン

setPolicySetDescription

セッション内で選択されたポリシー・セットのための説明を指定します。

オンライン

validatePolicySet

リポジトリ内またはセッション内の既存のポリシー・セットを検証します。

オンライン

deletePolicySet

指定したポリシー・セットを削除します。

オンライン

deleteAllPolicySets

Oracle WSMリポジトリ内からすべてのポリシー・セットまたは選択したポリシー・セットを削除します。

オンライン

attachPolicySet

指定されたリソース範囲にポリシー・セットをアタッチします。

オンライン

attachPolicySetPolicy

ポリシーのURIを使用してポリシー・セットにポリシーをアタッチします。

オンライン

detachPolicySetPolicy

ポリシーのURIを使用してポリシー・セットからポリシーをデタッチします。

オンライン

migrateAttachments

直接ポリシー・アタッチメントをグローバル・ポリシー・アタッチメントに(それらが同一である場合)移行します。

オンライン

beginRepositorySession

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

WLSTでの使用: オンライン

説明

Oracle WSMリポジトリを変更するセッションを開始します。リポジトリ・セッションは、1つのドキュメント上でのみ機能できます。すでに現在のセッションがある場合、エラーが表示されます。

構文

beginRepositorySession()

例

次の例では、Oracle WSMリポジトリの変更セッションを開始します。

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

commitRepositorySession

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

WLSTでの使用: オンライン

説明

Oracle WSMリポジトリに現在のセッションのコンテンツを書き込みます。何がコミットされたのかを示すメッセージが表示されます。現在のセッションがない場合、エラーが表示されます。

構文

commitRepositorySession()

例

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

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

describeRepositorySession

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

WLSTでの使用: オンライン

説明

現在のセッションのコンテンツを記述します。これは、セッションが空であることを示すか、更新されるドキュメントの名前を、更新のタイプ(作成、変更または削除)とともに一覧表示します。現在のセッションがない場合、エラーが表示されます。

構文

describeRepositorySession()

例

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

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

abortRepositorySession

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

WLSTでの使用: オンライン

説明

現在のOracle WSMリポジトリ変更セッションを中止し、そのセッション中にリポジトリに対して行われた変更をすべて破棄します。

構文

abortRepositorySession()

例

次の例では、現在のOracle WSMリポジトリ・セッションを中止します。

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

createPolicySet

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

WLSTでの使用: オンライン

説明

リポジトリ・セッション内に新規の空のポリシー・セットを作成します。新規ポリシー・セットを作成する際には、ポリシー・セットの適用先のポリシー・サブジェクトのタイプを指定して、サポートされる形式で有効なリソース・スコープを定義するサポートされる式を指定する必要があります。

このコマンドをリポジトリ・セッション外で発行するとエラーになります。

構文

createPolicySet(name, type,attachTo,[description=None],[enable='true'])

引数

定義

name

新規の空のポリシー・セットの名前。

type

新規ポリシー・セットが適用されるポリシー・サブジェクトのタイプ。ポリシー・サブジェクトのタイプは、次の値のいずれかにする必要があります。

- sca-component - SOAコンポーネント

- sca-reference - SOA参照

- sca-service - SOAサービス

- ws-service - Webサービス・エンドポイント

- ws-client - Webサービス・クライアント

- ws-connection - Webサービス接続

- ws-callback - 非同期コールバック・クライアント

attachTo

指定されたリソース・スコープにポリシー・セットをアタッチする式。リソース・スコープの式の指定の詳細は、『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')

listPolicySets

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

WLSTでの使用: オンライン

説明

リポジトリ内のポリシー・セットを一覧表示します。このコマンドによって、現在のセッション内で作成、変更または削除されるポリシー・セットも表示されます。すべてのポリシー・セットを一覧表示することも、特定のポリシー・サブジェクト・リソース・タイプに適用されるもののみを含むように表示を制限することもできます。

構文

listPolicySets([type=None])

引数

定義

type=None

オプション。表示するポリシー・セットのタイプを指定します。ポリシー・サブジェクト・リソース・タイプは、次の値の1つにする必要があります。

- sca-component - SOAコンポーネント

- sca-reference - SOA参照

- sca-service - SOAサービス

- ws-service - Webサービス・エンドポイント

- ws-client - Webサービス・クライアント

- ws-connection - Webサービス接続

- ws-callback - 非同期コールバック・クライアント

この引数をNoneに設定すると、リポジトリに格納されているすべてのポリシー・セットが一覧表示されます。

例

最初の2つの例では、sca-referenceとws-clientのいずれかのリソース・タイプでポリシー・セットを一覧表示します。一方、3番目の例では、リポジトリ内に格納されているすべてのポリシー・セットを一覧表示します。

wls:/wls-domain/serverConfig>listPolicySets('sca-reference')
wls:/wls-domain/serverConfig>listPolicySets('ws-client')
wls:/wls-domain/serverConfig>listPolicySets()

clonePolicySet

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

WLSTでの使用: オンライン

説明

リポジトリ・セッション内で、既存のポリシー・セットから新規のポリシー・セットをクローニングします。既存のポリシー・セットをクローニングする際には、ソース・ポリシー・セットのすべての値とアタッチメントが新規ポリシー・セットにコピーされます。ただし、リソース・スコープを指定する別の式を指定することもできます。この式は、サポートされる形式で有効なリソース・スコープを定義する必要があります。

このコマンドをリポジトリ・セッション外で発行するとエラーになります。

構文

clonePolicySet(name, source,[attachTo=None],[description=None],[enable='true'])

引数

定義

name

新規ポリシー・セットのクローンの名前。

source

クローニングされるソース・ポリシー・セットの名前。

attachTo=None

オプション。指定されたリソース・スコープにポリシー・セットをアタッチする式。リソース・スコープの式の指定の詳細は、『Webサービスのためのセキュリティおよび管理者ガイド』のリソース・スコープに関する項を参照してください。

この引数をNoneに設定すると、リソース・スコープを指定するためにソース・ポリシー・セットで使用されている式が保持されます。

description=None

オプション。新規ポリシー・セットの説明。

この引数をNoneに設定すると、ソース・ポリシー・セットで使用されている説明が保持されます。

enable='true'

オプション。ポリシー・セットを有効にするか無効にするかを指定します。有効なオプションは次のとおりです:

- true - ポリシー・セットを有効にします。デフォルトはtrueです。

- false - ポリシー・セットを無効にします。

この引数を省略した場合、ポリシー・セットが有効になります。

例

最初の例では、既存のmyPolicySetポリシー・セットをクローニングして新しいmynewPolicySetを作成することでポリシー・セットを作成します。2番目の例でも、ポリシー・セットを作成しますが、リソース・スコープをドメイン内の指定されたsoa_server1サーバーのポリシー・サブジェクトに絞り込みます。

wls:/wls-domain/serverConfig>clonePolicySet('myNewPolicySet','myPolicySet')
wls:/wls-domain/serverConfig>clonePolicySet('myNewPolicySet','myPolicySet','Server("soa_server1")')

displayPolicySet

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

WLSTでの使用: オンライン

説明

指定したポリシー・セットの構成を表示します。現在のセッションでポリシー・セットが変更されている場合、そのバージョンが表示されます。それ以外の場合は、リポジトリ内の最新バージョンが表示されます。ポリシー・セットが存在しない場合、エラーが表示されます。

このコマンドは、リポジトリ・セッションの外で発行できます。

構文

displayPolicySet([name])

引数

定義

name

オプション。表示されるポリシー・セットの名前。

名前が指定されていない場合、現在のセッションのポリシー・セットの構成(存在する場合)が表示されるか、エラー・メッセージが表示されます。

例

次の例では、myPolicySetポリシー・セットの構成が表示されます。

wls:/wls-domain/serverConfig>displayPolicySet('myPolicySet')

modifyPolicySet

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

WLSTでの使用: オンライン

説明

現在のリポジトリ・セッションで変更する既存のポリシー・セットを指定します。指定したポリシー・セットの最新バージョンが現在のセッションにロードされます。別のポリシー・セットがセッションにすでに含まれている場合は、エラーが表示されます。指定したポリシー・セットがすでにセッションに含まれている場合、アクションは実行されません。この後、指定したポリシー・セットを変更しようとすると、セッションにある現在のバージョンが表示されます。

このコマンドをリポジトリ・セッション外で発行するとエラーになります。

構文

modifyPolicySet(name)

引数

定義

name

現在のセッションで変更するポリシー・セットの名前。

例

次の例では、現在のセッションで変更するためにmyPolicySetポリシー・セットを開きます。

wls:/wls-domain/serverConfig>modifyPolicySet('myPolicySet')

setPolicySetPolicyOverride

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

WLSTでの使用: オンライン

説明

現在のポリシー・セット内のアタッチされたポリシー参照に、nameとvalueのペアで記述される構成オーバーライドを追加します。value引数はオプションです。value引数を省略すると、name引数で指定されたプロパティが、ポリシー・セットのポリシー参照から削除されます。name引数で指定されたプロパティがすでに存在しており、value引数が指定されている場合、現在の値がvalue引数で指定されている新しい値で上書きされます。

作成または変更中のポリシー・セットを含むリポジトリ・セッションの外でこのコマンドを発行すると、エラーになります。

構文

setPolicySetPolicyOverride(uri,name,[value=None])

引数

定義

URI

Oracle WSMポリシーURIを表す文字列。たとえば、オーバーライド・プロパティを適用する'oracle/wss10_saml_token_service_policy'。

name

オーバーライド・プロパティの名前を表す文字列。

例: ['reference.priority']

value

オプション。プロパティの値を表す文字列。この引数を指定しない場合、name引数で指定されているプロパティがあると、それが削除されます。

例

次の例では、oracle/wss10_saml_token_service_policyのreference.priorityプロパティの構成オーバーライドを1の値に指定します。

setPolicySetPolicyOverride('oracle/wss10_saml_token_service_policy', 'reference.priority','1')

次の例では、ポリシー・セットのoracle/wss10_saml_token_service_policyからプロパティreference.priorityを削除します。

setPolicySetPolicyOverride('oracle/wss10_saml_token_service_policy', 'reference.priority')

setPolicySetConstraint

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

WLSTでの使用: オンライン

説明

セッション内で選択されたポリシー・セットのための実行時制約値を指定します。作成または変更中のポリシー・セットを含むリポジトリ・セッションの外でこのコマンドを発行すると、エラーになります。

詳細は、『Webサービスのためのセキュリティおよび管理者ガイド』のポリシー・セットの実行時制約の指定に関する項を参照してください。

構文

setPolicySetConstraint(constraint)

引数

定義

constraint

ポリシー・セットが適用される実行時コンテキストを指定する式。指定しない場合、そのポリシー・セットがすべての実行時コンテキストに適用されます。

例

次の例では、ポリシー・セットを外部クライアントからのリクエストにのみ適用することを指定します。

setPolicySetConstraint('HTTPHeader("VIRTUAL_HOST_TYPE","external")')

次の例では、ポリシー・セットを外部以外のクライアントからのリクエストにのみ適用することを指定します。

setPolicySetConstraint('!HTTPHeader("VIRTUAL_HOST_TYPE","external")')

enablePolicySet

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

WLSTでの使用: オンライン

説明

リポジトリ・セッション内の現在のポリシー・セットを有効化または無効化します。指定しない場合、このコマンドによってポリシー・セットが有効化されます。

作成または変更中のポリシー・セットを含むリポジトリ・セッションの外でこのコマンドを発行すると、エラーになります。

構文

enablePolicySet([enable=True])

引数

定義

enable

オプション。ポリシー・セットを有効にするか無効にするかを指定します。有効なオプションは次のとおりです:

- true - ポリシー・セットを有効にします。デフォルトはtrueです。

- false - ポリシー・セットを無効にします。

この引数を省略した場合、ポリシー・セットが有効になります。

例

次の例では、現在のポリシー・セットを有効化します。

wls:/wls-domain/serverConfig>enablePolicySet(true)

enablePolicySetPolicy

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

WLSTでの使用: オンライン

説明

リポジトリ・セッション内で、現在のポリシー・セット内の指定されたURIで特定されるポリシー・アタッチメントを有効化または無効化します。指定しない場合、このコマンドによってポリシー・セットが有効化されます。特定されたポリシーがそのポリシー・セットに現在アタッチされていない場合は、エラーが表示されます。

作成または変更中のポリシー・セットを含むリポジトリ・セッションの外でこのコマンドを発行すると、エラーになります。

構文

enablePolicySetPolicy(uri,[enable=true])

引数

定義

uri

ポリシー・セット内のポリシー・アタッチメントを指定するURI。

enable

オプション。ポリシー・セット内のURIで指定されるポリシー・アタッチメントを有効化するか無効化するかを指定します。有効なオプションは次のとおりです:

- true - ポリシー・セット内の指定したポリシー・アタッチメントを有効化します。デフォルトはtrueです。

- false - ポリシー・セット内の指定したポリシー・アタッチメントを無効化します。

この引数を省略した場合、ポリシー・セット・アタッチメントが有効になります。

例

次の例では、現在のポリシー・セット内の指定したロギング・ポリシー・アタッチメントを無効化します。

wls:/wls-domain/serverConfig>enablePolicySetPolicy('/oracle/log_policy',false)

setPolicySetDescription

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

WLSTでの使用: オンライン

説明

セッション内で選択されたポリシー・セットのための説明を指定します。

作成または変更中のポリシー・セットを含むリポジトリ・セッションの外でこのコマンドを発行すると、エラーになります。

構文

setPolicySetDescription(description)

引数

定義

description

ポリシー・セットを説明します。

例

次の例では、ポリシー・セットの説明を作成します。

wls:/wls-domain/serverConfig>setPolicySetDescription('PolicySetDescription')

validatePolicySet

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

WLSTでの使用: オンライン

説明

既存のポリシー・セットを検証します。ポリシー・セット名を指定すると、指定されたポリシー・セットが検証されます。ポリシー・セット名を指定しないと、現在のリポジトリ・セッション内のポリシー・セットが検証されます。

ポリシー・セットが存在しない場合、名前が指定されておらず、セッションがアクティブでない場合または適切なポリシー・セットがOracle WSMリポジトリに含まれていない場合は、エラー・メッセージが表示されます。

構文

validatePolicySet([name=None])

引数

定義

name

オプション。検証するポリシー・セットの名前。名前が指定されていない場合、現在のセッション内で作成中または変更中のポリシー・セットが検証されます。

例

最初の例では、現在のセッションのポリシー・セットが検証されます。2番目の例では、指定されたmyPolicySetポリシー・セットが検証されます。

wls:/wls-domain/serverConfig>validatePolicySet()
wls:/wls-domain/serverConfig>validatePolicySet('myPolicySet')

deletePolicySet

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

WLSTでの使用: オンライン

説明

リポジトリ・セッション内の指定されたポリシー・セットを削除します。セッションにすでに別のポリシー・セットが含まれている場合は、エラーが表示されます。セッションに、指定したポリシー・セットがすでに含まれている場合、作成は行われず、変更は削除に変換されます。

このコマンドをリポジトリ・セッション外で発行するとエラーになります。

構文

deletePolicySet(name)

引数

定義

name

削除されるポリシー・セットの名前。

例

次の例では、指定されたmyPolicySetポリシー・セットが削除されます。

wls:/wls-domain/serverConfig>deletePolicySet('myPolicySet')

deleteAllPolicySets

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

WLSTでの使用: オンライン

説明

Oracle WSMリポジトリ内からすべてのポリシー・セットまたは選択したポリシー・セットを削除します。すべてのポリシー・セットを強制的に削除するか、削除するポリシー・セットを個別に選択するようプロンプト表示するかを指定できます。いずれかのポリシー・セットの削除が失敗すると、この操作で例外がスローされます。いずれのポリシー・セットも削除されません。

構文

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.

attachPolicySet

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

WLSTでの使用: オンライン

説明

リポジトリ・セッション内で、指定したリソース・スコープにポリシー・セットをアタッチする式を設定します。この式は、サポートされる形式で有効なリソース・スコープを定義する必要があります。

作成または変更中のポリシー・セットを含むリポジトリ・セッションの外でこのコマンドを発行すると、エラーになります。

構文

attachPolicySet(expression)

引数

定義

expression

指定されたリソース・スコープにポリシー・セットをアタッチする式。

リソース・スコープの式の指定の詳細は、『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")')

attachPolicySetPolicy

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

WLSTでの使用: オンライン

説明

リポジトリ・セッション内で、指定されたURIで特定されるポリシーを現在のポリシー・セットにアタッチします。

作成または変更中のポリシー・セットを含むリポジトリ・セッションの外でこのコマンドを発行すると、エラーになります。

構文

attachPolicySetPolicy(uri)

引数

定義

uri

現在のポリシー・セットにアタッチするポリシーを指定するURI。たとえば、'oracle/log_policy'です。

例

次の例では、現在のポリシー・セットにOracle WSMロギング・ポリシーをアタッチします。

wls:/wls-domain/serverConfig>attachPolicySetPolicy('oracle/log_policy')

detachPolicySetPolicy

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

WLSTでの使用: オンライン

説明

リポジトリ・セッション内で、指定されたURIで特定されるポリシーを現在のポリシー・セットからデタッチします。

作成または変更中のポリシー・セットを含むリポジトリ・セッションの外でこのコマンドを発行すると、エラーになります。

構文

detachPolicySetPolicy(uri)

引数

定義

uri

現在のポリシー・セットからデタッチするポリシーを指定するURI。たとえば、oracle/log_policy'です。

例

次の例では、現在のポリシー・セットからOracle WSMロギング・ポリシーをデタッチします。

wls:/wls-domain/serverConfig>detachPolicySetPolicy('oracle/log_policy')

migrateAttachments

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

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

Oracle WSMリポジトリ管理のコマンド

表14-5に示すコマンドを使用して、Oracle WSMリポジトリに格納されているWSMドキュメントを管理します。Oracle WSMリポジトリ内のドキュメントのアップグレードまたは移行の詳細は、『Webサービスのためのセキュリティおよび管理者ガイド』のリポジトリ内のOracle WSMポリシーのアップグレードに関する項を参照してください。

追加のMDS WLSTコマンドは、第8章「メタデータ・サービス(MDS)カスタムWLSTコマンド」で説明します。

表14-5 ポリシー・リポジトリ管理コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

upgradeWSMPolicyRepository

Oracle Fusion Middlewareソフトウェアの最新インストールで提供されている新しい事前定義済ポリシーでOracle WSMリポジトリに格納されているOracle WSM事前定義済ポリシーをアップグレードします。

オンライン

resetWSMPolicyRepository

Oracle WSMリポジトリに格納されている既存のポリシーを削除し、それをOracle Fusion Middlewareソフトウェアの新しいインストールで提供されている事前定義済ポリシーの最新セットでリフレッシュします。

オンライン

exportRepository

サポートされているZIPアーカイブに、リポジトリから一連のドキュメントをエクスポートします。指定されているアーカイブがすでに存在している場合、アーカイブを上書きするか、ドキュメントを既存のアーカイブにマージするのかを選択できます。

オンライン

importRepository

サポートされているZIPアーカイブからリポジトリに一連のドキュメントをインポートします。ソース環境からターゲット環境に物理情報をマップする方法を記述するファイルの場所を指定できます。

オンライン

upgradeWSMPolicyRepository

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

WLSTでの使用: オンライン

説明

Oracle Fusion Middlewareソフトウェアの最新インストールで提供されている新しい事前定義済ポリシーでOracle WSMリポジトリに格納されているOracle WSM事前定義済ポリシーをアップグレードします。リポジトリが空である場合、インストールに含まれている事前定義済ポリシーのすべてがリポジトリにロードされます。

このコマンドで、リポジトリ内の既存の事前定義済ポリシーおよびユーザー定義カスタム・ポリシーが削除されることはありません。事前定義済ポリシーが後続のリリースで変更されたか廃止された場合、次のいずれかになります。

- 廃止されたポリシーの場合、廃止されたポリシーを一覧表示するメッセージが表示されます。この場合、それらのポリシーの参照を停止し、Oracle Enterprise Managerを使用してそれらを削除することをお薦めします。

- 後続のリリースで変更されたポリシーの場合、変更されたポリシーを一覧表示するメッセージが表示されます。この場合、Oracle Enterprise Managerを使用してそれらのポリシーの最新バージョンをインポートすることをお薦めします。

構文

upgradeWSMPolicyRepository()

例

次の例では、最新のリリースで提供されているポリシーで、既存のインストールをアップグレードします。

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

resetWSMPolicyRepository

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

WLSTでの使用: オンライン

説明

Oracle WSMリポジトリに格納されている既存のポリシーを削除し、それをOracle Fusion Middlewareソフトウェアの新しいインストールで提供されている事前定義済ポリシーの最新セットでリフレッシュします。新しい事前定義済ポリシーをロードする前に、clearStore引数を使用して、Oracle WSMリポジトリから、カスタム・ユーザー・ポリシーを含めて、すべてのポリシーを削除するかどうかを指定できます。

構文

resetWSMPolicyRepository([clearStore='false'])

引数

定義

clearStore='false'

削除するポリシー・セット。有効な値は次のとおりです:

- true - リポジトリ内の、カスタム・ユーザー・ポリシーを含むすべてのポリシーが削除されます。

- false - オラクル社によって提供される事前定義済ポリシーのみが削除されます。デフォルトはfalseです。

例

次の例では、リポジトリ内のすべてのポリシーが、ユーザー・ポリシーも含めて削除され、現在の製品インストールで提供される事前定義済ポリシーが追加されます。

wls:/wls-domain/serverConfig>resetWSMPolicyRepository(true)

exportRepository

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

WLSTでの使用: オンライン

説明

サポートされているZIPアーカイブに、Oracle WSMリポジトリから一連のドキュメントをエクスポートします。指定されているアーカイブがすでに存在している場合、次のオプションが提示されます。

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],[expandReferences='false'])

引数

定義

archive

アーカイブ・ファイルの名前。指定されているアーカイブがすでに存在している場合、アーカイブを上書きするか、ドキュメントを既存のアーカイブにマージするのかを選択できます。

オーバーライド中に、元のアーカイブがバックアップされ、メッセージにバックアップ・アーカイブの場所が示されます。

documents=None

オプション。アーカイブにエクスポートするドキュメント。ドキュメントを指定しない場合、すべてのアサーション・テンプレート、インテント、ポリシーおよびポリシー・セットがエクスポートされます。エクスポートするドキュメントのリストを指定できます。または、検索式を使用してリポジトリ内の特定のドキュメントを見つけることもできます。

expandReferences='false'

オプション。ポリシー参照をエクスポート中に拡張するかどうかを指定します。

例

次の例では、リポジトリ・エクスポート・セッションを示します。最初の例では、すべてのOracle WSMドキュメントをpolicies.zipファイルにエクスポートします。

wls:/wls-domain/serverConfig>exportRepository("/tmp/policies.zip")

この例では、sca-component、sca-reference、およびsca-serviceポリシー・セットのみが、policies.jarファイルにエクスポートされ、エクスポート・プロセス中にすべてのポリシー参照出力が拡張されます。

wls:/wls-domain/serverConfig>exportRepository("/tmp/policies.jar",
["/policysets/sca_component,/policysets/sca_reference,/policysets/sca_service]", 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)

importRepository

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

WLSTでの使用: オンライン

説明

サポートされているZIPアーカイブからOracle WSMリポジトリに一連のドキュメントをインポートします。map引数を使用して、ソース環境からターゲット環境に物理情報をマップする方法を記述するファイルの場所を指定できます。たとえば、マップ・ファイルを使用して、ポリシー・セット・ドキュメント内のアタッチメント式がDomain("foo")=Domain("bar")などのようにターゲット環境に一致するように更新されるようにすることができます。

構文

importRepository(archive,[map=None],[generateMapFile='false'])

引数

定義

archive

アーカイブ・ファイルの名前。

map=None

オプション。ソース環境からターゲット環境に物理情報をマップする方法を記述するサンプル・マップ・ファイルの場所。generateMapFile引数をtrueに設定することで新しいマップ・ファイルを生成できます。

generateMapFile引数をtrueに設定しないでマップ・ファイルを指定し、そのファイルが存在しない場合、操作は失敗し、エラーが表示されます。

generateMapFile=false

オプション。マップ引数で指定されている場所にサンプル・マップ・ファイルを作成するかどうかを指定します。この引数をtrueに設定すると、どのドキュメントもインポートされません。デフォルトはfalseです。

ファイルが作成されたら、任意のテキスト・エディタを使用してそれを編集できます。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')

デプロイメント・ディスクリプタ移行のコマンド

表14-6に示すコマンドを使用して、ADFビジネス・コンポーネントおよびWebCenterサービス固有デプロイメント記述子(PDD)ファイルを、テストから本番など環境間で移行します。

これらのコマンドの使用方法の詳細は、『Webサービスのためのセキュリティおよび管理者ガイド』の環境間のアプリケーションの移行の管理に関する項を参照してください。

表14-6 デプロイメント・ディスクリプタ移行のコマンド

このコマンドを使用します...

次を行うには...

WLSTでの使用

exportJRFWSApplicationPDD

ADFビジネス・コントロールまたはWebCenterアプリケーション・デプロイメント・ディスクリプタをJavaアーカイブ(JAR)ファイルにエクスポートします。

オンライン

importJRFWSApplicationPDD

ADFビジネス・コントロールまたはWebCenter Webサービス・アプリケーション・デプロイメント・ディスクリプタをエクスポートされたJARファイルから新しい環境、たとえば、本番環境や、クラスタ内のスケーリングされたサーバー・インスタンスにインポートします。

オンライン

savePddToAllAppInstancesInDomain

ADF BCまたはWebCenter Webサービス・アプリケーション・デプロイメント・ディスクリプタを、エクスポートされたJARファイルから、接続されているドメイン内のすべてのサーバー・インスタンスにインポートします。

オンライン

exportJRFWSApplicationPDD

コマンド・カテゴリ: デプロイメント・ディスクリプタの移行

WLSTでの使用: オンライン

説明

ADFビジネス・コントロールまたはWebCenterアプリケーション・デプロイメント・ディスクリプタをJavaアーカイブ(JAR)ファイルにエクスポートします。JARファイルの名前を指定しない場合、出力では、JARファイルのデフォルト名およびパスが表示されます。

構文

exportJRFWSApplicationPDD(application,pddJarFileName=None)

引数

定義

application

構成情報をエクスポートするアプリケーションの名前とパス。たとえば、/domain/server/application#versionです。

pddJarFileName

オプション。JARファイルのユーザー指定の名前。デフォルトは、Noneです。たとえば、/tmp/myPDD.jarです。

例

次の例では、アプリケーションADFBCHelloWorldのWebサービスPDDをexportPDD.jarという名前のJARファイルにエクスポートします。

wls:/wls-domain/serverConfig>exportJRFWSApplicationPDD
('/wls-domain/ManagedServer/ADFBCHelloWorld','/tmp/exportPDD.jar')

/tmp/exportPDD.jar

importJRFWSApplicationPDD

コマンド・カテゴリ: デプロイメント・ディスクリプタの移行

WLSTでの使用: オンライン

説明

ADFビジネス・コントロールまたはWebCenter Webサービス・アプリケーション・デプロイメント・ディスクリプタをエクスポートされたJARファイルから新しい環境、たとえば、本番環境や、クラスタ内のスケーリングされたサーバー・インスタンスにインポートします。

注意:

このWLSTコマンドを使用して行った変更は、ご使用のアプリケーションを再起動した後のみ有効になります。デプロイメント・ディスクリプタをインポートした後、アプリケーションの再起動を促すメッセージが表示されます。

構文

importJRFWSApplicationPDD(application,pddJarFileName)

引数

定義

application

構成情報をインポートするアプリケーションの名前と完全修飾パス。たとえば、/domain/server/application#versionです。

pddJarFileName

インポートするPDDファイルを含むJARファイルの名前。たとえば、/tmp/myPDD.jarです。

例

次の例では、サーバーManagedServer2に移行済のADFBCHelloWorldアプリケーションのWebサービス・アプリケーション・デプロイメント・ディスクリプタをインポートします。このコマンドでは、exportJRFWSApplicationPDDコマンドの実行時に生成されたJARファイルの名前を使用します。

wls:/wls-domain/serverConfig>importJRFWSApplicationPDD
('/wls-domain/ManagedServer2/ADFBCHelloWorld', '/tmp/exportPDD.jar')

application  /wls-domain/ManagedServer2/ADFBCHelloWorld PDD has been reset,
please restart application now to uptake changes!

savePddToAllAppInstancesInDomain

コマンド・カテゴリ: デプロイメント・ディスクリプタの移行

WLSTでの使用: オンライン

説明

ADF BCまたはWebCenter Webサービス・アプリケーション・デプロイメント・ディスクリプタを、エクスポートされたJARファイルから、接続されているドメイン内のすべてのサーバー・インスタンスにインポートします。オプションのrestartApp引数を使用して、アプリケーションを自動的に再起動することもできます。

構文

savePddToAllAppInstancesInDomain(applicationName,pddJarFileName,restartApp=true)

引数

定義

applicationName

構成情報をインポートするアプリケーションの名前。たとえば、application#versionです。

pddJarFileName

インポートするPDDファイルを含むJARファイルの名前。たとえば、/tmp/myPDD.jarです。

restartApp

オプション。アプリケーションを再起動します。有効な値は次のとおりです:

- true - アプリケーションを自動的に再起動します。デフォルトはtrueです。

- false - アプリケーションを自動的に再起動しません。

例

次の例では、ドメイン内のすべてのサーバーに事前にエクスポートされたADFBCHelloWorldアプリケーションのWebサービス・アプリケーション・デプロイメント・ディスクリプタをインポートし、アプリケーションを再起動します。

wls:/wls-domain/serverConfig>savePddToAllAppInstancesInDomain
'ADFBCHelloWorld', '/tmp/exportPDD.jar' , true

saving pdd to  com.bea:ServerRuntime=ManagedServer,Name=ADFBCHelloWorld,
Location=ManagedServer,Type=ApplicationRuntime
saving pdd to  com.bea:ServerRuntime=ManagedServer2,Name=ADFBCHelloWorld,
Location=ManagedServer2,Type=ApplicationRuntime
restarting application  ADFBCHelloWorld
Stopping application ADFBCHelloWorld.
<Mar 24, 2010 10:50:07 AM PDT> <Info> <J2EE Deployment SPI> <BEA-260121> <Initiating stop operation for application, ADFBCHelloWorld
[archive: null], to Cluster-1 .>
.Completed the stop of Application with status completed
Current Status of your Deployment:
Deployment command type: stop
Deployment State       : completed
Deployment Message     : no message
Starting application ADFBCHelloWorld.
<Mar 24, 2010 10:50:11 AM PDT> <Info> <J2EE Deployment SPI> <BEA-260121> <Initiating start operation for application, ADFBCHelloWorld
[archive: null], to Cluster-1 .>
.Completed the start of Application with status completed
Current Status of your Deployment:
Deployment command type: start
Deployment State       : completed
Deployment Message     : no message

次の例では、ドメイン内のすべてのサーバーに事前にエクスポートされたADFBCHelloWorldアプリケーションのWebサービス・アプリケーション・デプロイメント・ディスクリプタをインポートしますが、アプリケーションを自動的に再起動することはありません。この例では、アプリケーションを手動で再起動するために入力する必要があるコマンドを示します。

wls:/wls-domain/serverConfig>savePddToAllAppInstancesInDomain
('ADFBCHelloWorld', '/tmp/exportPDD.jar', false)

saving pdd to  com.bea:ServerRuntime=ManagedServer,Name=ADFBCHelloWorld,
Location=ManagedServer,Type=ApplicationRuntime
saving pdd to  com.bea:ServerRuntime=ManagedServer2,Name=ADFBCHelloWorld,
Location=ManagedServer2,Type=ApplicationRuntime
application  ADFBCHelloWorld  PDD has been reset, please restart application now to uptake changes!

wls:/wls-domain/serverConfig> stopApplication('ADFBCHelloWorld')
wls:/wls-domain/serverConfig> startApplication('ADFBCHelloWorld')

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

診断フレームワークによって、クリティカル・エラーについて関連する診断を適時に捕捉できます。診断は、詳細に分析するためにOracleサポートに送信できます。診断フレームワークのコマンドを使用して、インシデントを生成し、既存のインシデントを問い合せ、個別の診断ダンプを実行して特定の診断データを収集します。

診断フレームワークの使用方法の詳細は、Oracle Fusion Middleware管理者ガイドの問題の診断に関する項を参照してください。

注意:

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

表15-1は、診断フレームワークのコマンドの様々なカテゴリを示しています。

表15-1 診断コマンドのカテゴリ

コマンド・カテゴリ

説明

インシデント・コマンド

問題およびインシデントを表示し、インシデントを作成します。

診断ダンプ・コマンド

ダンプに関する情報を表示し、ダンプを実行します。

インシデント・コマンド

表15-2のコマンドを使用して、問題およびインシデントを表示し、インシデントを作成します。

表15-2 インシデント・コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

createIncident

診断インシデントを作成します。

オンライン

getIncidentFile

指定したインシデント・ファイルの内容を取得します。

オンライン

listADRHomes

一連のADRホームのパスを一覧表示します。

オンライン

listIncidents

一連の診断インシデントを一覧表示します。

オンライン

listProblems

一連の診断問題を一覧表示します。

オンライン

showIncident

指定したインシデントの詳細を表示します。

オンライン

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: 55
Problem Id: 4
Problem Key: MDS-50400 [MANUAL]
Incident Time: 25th March 2010 11:55:45 GMT
Error Message Id: MDS-50400
Flood Controlled: false

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

listADRHomes

WLSTでの使用: オンライン

説明

サーバーのすべてのADRホームのパスを一覧表示します。

構文

listADRHomes([server])

引数

定義

server

情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、ADRホームのパスを一覧表示します。

listADRHomes()
diag/ofm/base_domain/WLS_Spaces

diag/ofm/fusionapps/GeneralLedger

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   Problem Key                                 Incident Time
10   MDS-50300 [WLS_Spaces] [oracle.mds.repos]   Mon Mar 15 11:22:12 PDT 2010
24   MDS-50300 [WLS_Spaces] [oracle.mds.repos]   Thu Mar 11 15:11:35 PDT 2010

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-50300 [WLS_Spaces] [oracle.mds.repos]
2        JOC-38922 [AdminServer] [oracle.cache.network]

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: 1
Problem Key: MDS-50300 [WLS_Spaces] [oracle.mds.repos]
Incident Time: 25th March 2010 10:12:15 GMT
Error Message Id: MDS-50300
Execution Context: 0000ICK4rbYC8xT6uBf9EH1AX1qF000000
Flood Controlled: false
Dump Files :
dms_ecidctx1_i1.dmp
jvm_threads2_i1.dmp
dms_metrics3_i1.dmp
odl_logs4_i1.dmp
diagnostic_image_AdminServer_2010_03_25_11_12_15.zip
readme.txt

診断ダンプ・コマンド

表15-3のコマンドを使用して、ダンプに関する情報を表示し、ダンプを実行します。

表15-3 診断ダンプ・コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

describeDump

指定した診断ダンプの説明を表示します。

オンライン

executeDump

指定した診断ダンプを実行します。

オンライン

listDumps

実行できる一連の診断ダンプを表示します。

オンライン

describeDump

WLSTでの使用: オンライン

説明

指定した診断ダンプの説明を表示します。

構文

describeDump(name [,appName] [.server])

引数

定義

name

情報を表示するダンプの名前。

appName

情報を収集するデプロイされたアプリケーションの名前。

たとえば、複数のADFアプリケーションをデプロイした場合、それぞれがadf.dumpというダンプを登録することがあります。このコマンドを特定のアプリケーションに対して実行するには、そのアプリケーション名を指定する必要があります。

server

情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、odl.logsという名前のダンプに関する情報を表示します。listDumpsコマンドを使用して、使用可能なダンプのリストを取得します。

describeDump(name="odl.logs")
Name: odl.logs
Description: Dumps recent ODL logs, or logs correlated by ECID
Manadatory Arguments:
Optional Arguments:
Name       Type      Description
ECID       String    Execution Context Id to correlate log entries with
timestamp  String    Timestamp to query logs 5 minutes before/after

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(name="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"})

listDumps

WLSTでの使用: オンライン

説明

実行できる一連の診断ダンプを表示します。

構文

listDumps([appName] [,server])

引数

定義

appName

診断を収集する対象となるデプロイされたアプリケーションの名前。

たとえば、複数のADFアプリケーションをデプロイした場合、それぞれがadf.dumpというダンプを登録することがあります。このコマンドを特定のアプリケーションに対して実行するには、そのアプリケーション名を指定する必要があります。

この引数を指定した場合、指定されたアプリケーションのダンプが返されます。この引数を指定しない場合、システム・ダンプが返されます。

server

情報の収集元となる管理対象サーバーの名前。この引数は、管理サーバーに接続している場合にのみ有効です。

例

次の例では、使用可能なすべてのダンプを一覧表示します。

listDumps()
dms.metrics
jvm.classhistogram
jvm.threads
odl.logs

Use the command describeDump(name=<dumpName>) for help on a specific dump.

16 Information Rights ManagementカスタムWLSTコマンド

次の項では、Oracle Fusion Middleware Information Rights ManagementカスタムWLSTコマンドについて詳しく説明します。次のトピックがあります。

- WLST IRMコマンドの概要

- 一般サーバー・コマンド

- 移行コマンド

- テスト・コンテンツ・コマンド

- 言語サポート・コマンド

- Oracle IRM Desktopインストーラ・コマンド

Oracle Information Rights Managementの詳細は、Oracle IRM管理者ガイドを参照してください。

注意:

これらのコマンドを使用するには、コンポーネントがインストールされているOracleホームからWLSTを呼び出す必要があります。Oracle Fusion Middleware管理者ガイドのカスタムWLSTコマンドの使用に関する項を参照してください。

WLST IRMコマンドの概要

WLST IRMコマンドは次のカテゴリに分かれています。

表16-1 WLST IRMコマンド・カテゴリ

コマンド・カテゴリ

説明

一般サーバー・コマンド

Oracle IRM Serverの設定に一般的な変更を行います。

移行コマンド

Oracle IRM Serverのユーザー・データをバックアップおよび移行します。

テスト・コンテンツ・コマンド

Oracle IRM Desktopのユーザー向けのテスト・コンテンツを設定します。

言語サポート・コマンド

Oracle IRM Serverのユーザー向けの言語サポートを設定します。

Oracle IRM Desktopインストーラ・コマンド

Oracle IRM Desktop向けのソフトウェア・インストール・サポートを設定します。

一般サーバー・コマンド

表16-2に示すWLSTコマンドを使用して、Oracle IRM Serverの設定に一般的な変更を行います。

表16-2 WLST一般サーバー・コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

addIRMRefreshPeriod

新しいリフレッシュ期間を作成します。

オンライン

getIRMRefreshPeriod

既存のリフレッシュ期間を表示します。

オンライン

getIRMRefreshPeriods

すべてのリフレッシュ期間を表示します。

オンライン

removeIRMRefreshPeriod

既存のリフレッシュ期間を削除します。

オンライン

updateIRMRefreshPeriod

既存のリフレッシュ期間を更新します。

オンライン

addIRMSyncWindow

新規の同期ウィンドウを追加します。

オンライン

getIRMSyncWindow

既存の同期ウィンドウを追加します。

オンライン

getIRMSyncWindows

すべての同期ウィンドウを表示します。

オンライン

removeIRMSyncWindow

既存の同期ウィンドウを削除します。

オンライン

updateIRMSyncWindow

既存の同期ウィンドウを更新します。

オンライン

getIRMCryptoSchema

暗号化アルゴリズムを表示します。

オンライン

setIRMCryptoSchema

暗号化アルゴリズムを設定します。

オンライン

getIRMDeviceCount

デバイス数を表示します。

オンライン

setIRMDeviceCount

デバイス数を設定します。

オンライン

getIRMJournalCleanUp

現在のレポート・レコード・クリーンアップ値を表示します。

オンライン

setIRMJournalCleanUp

レポート・レコード・クリーンアップ値を設定します。

オンライン

getIRMLicenseStateCleanUp

ライセンス状態クリーンアップ頻度を表示します。

オンライン

setIRMLicenseStateCleanUp

ライセンス状態クリーンアップ頻度を設定します。

オンライン

getIRMPrivacyURL

プライバシ・ステートメント・ページのURLを表示します。

オンライン

setIRMPrivacyURL

プライバシ・ステートメント・ページのURLを設定します。

オンライン

getIRMKeyStore

Oracle IRMキーストアのタイプおよび場所を表示します。

オンライン

setIRMKeyStore

Oracle IRMキーストアのタイプおよび場所を設定します。

オンライン

addIRMRefreshPeriod

新しいリフレッシュ期間を作成するオンライン・コマンド。

説明

このコマンドは、リフレッシュ期間を作成します。リフレッシュ期間とは、権限がサーバーによってリフレッシュされる前にユーザーがその権限を使用できる時間の長さです。

構文

addIRMRefreshPeriod(duration,dtype)

引数

定義

duration

リフレッシュ期間の値を指定します。整数。

dtype

リフレッシュ期間の単位を指定します。'MINUTES'、'HOURS'、'DAYS'、'MONTHS'、'YEARS'です。

例

次の例では、5時間のリフレッシュ期間を作成します。

wls:/base_domain/serverConfig> addIRMRefreshPeriod(5,\"HOURS\")

次の例では、50分間のリフレッシュ期間を作成します。

wls:/base_domain/serverConfig> addIRMRefreshPeriod(50,\"MINUTES\")

getIRMRefreshPeriod

既存のリフレッシュ期間を表示するオンライン・コマンド。

説明

このコマンドは、指定された索引にあるリフレッシュ期間を表示します。リフレッシュ期間とは、権限がサーバーによってリフレッシュされる前にユーザーがその権限を使用できる時間の長さです。

構文

getIRMRefreshPeriod(pindex)

引数

定義

pindex

リフレッシュ期間の索引を指定します。

例

次の例では、索引ゼロにあるリフレッシュ期間を表示します。

wls:/base_domain/serverConfig> getIRMRefreshPeriod(0)

次の例では、索引1にあるリフレッシュ期間を表示します。

wls:/base_domain/serverConfig> getIRMRefreshPeriod(1)

getIRMRefreshPeriods

既存のリフレッシュ期間をすべて表示するオンライン・コマンド。

説明

このコマンドは、既存のリフレッシュ期間をすべて表示します。リフレッシュ期間とは、権限がサーバーによってリフレッシュされる前にユーザーがその権限を使用できる時間の長さです。

構文

getIRMRefreshPeriods()

例

wls:/base_domain/serverConfig> getIRMRefreshPeriods()

removeIRMRefreshPeriod

既存のリフレッシュ期間を削除するオンライン・コマンド。

説明

このコマンドは、指定された索引にあるリフレッシュ期間を削除します。リフレッシュ期間とは、権限がサーバーによってリフレッシュされる前にユーザーがその権限を使用できる時間の長さです。

構文

removeIRMRefreshPeriod(pindex)

引数

定義

pindex

リフレッシュ期間の索引を指定します。

例

次の例では、索引ゼロにあるリフレッシュ期間を削除します。

wls:/base_domain/serverConfig> removeIRMRefreshPeriod(0)

次の例では、索引1にあるリフレッシュ期間を削除します。

wls:/base_domain/serverConfig> removeIRMRefreshPeriod(1)

updateIRMRefreshPeriod

既存のリフレッシュ期間を更新するオンライン・コマンド。

説明

このコマンドは、既存のリフレッシュ期間を更新します。リフレッシュ期間とは、権限がサーバーによってリフレッシュされる前にユーザーがその権限を使用できる時間の長さです。

構文

updateIRMRefreshPeriod(pindex,duration,dtype)

引数

定義

pindex

リフレッシュ期間の索引を指定します。

duration

リフレッシュ期間の値を指定します。整数。

dtype

リフレッシュ期間の単位を指定します。'MINUTES'、'HOURS'、'DAYS'、'MONTHS'または'YEARS'です。

例

次の例では、索引ゼロにあるリフレッシュ期間が5時間に設定されるように更新します。

wls:/base_domain/serverConfig> updateIRMRefreshPeriod(0,5,\"HOURS\")

次の例では、索引ゼロにあるリフレッシュ期間が50分間に設定されるように更新します。

wls:/base_domain/serverConfig> updateIRMRefreshPeriod(0,50,\"MINUTES\")

addIRMSyncWindow

同期ウィンドウを作成するオンライン・コマンド。

説明

このコマンドは、同期ウィンドウを作成します。同期ウィンドウは、Oracle IRM Desktopが権限を同期するためにサーバーへの接続を試みる期間です。

構文

addIRMSyncWindow(day,stHrs,stMins,endHrs,endMins)

引数

定義

day

曜日を指定します。'MONDAY'、'TUESDAY'などです。

stHrs

開始時を指定します。整数。

stMins

開始分を指定します。整数。

endHrs

終了時を指定します。整数。

endMins

終了分を指定します。整数。

例

次の例では、Oracle IRM Desktopが、月曜日の午前9時30分から午後6時30分の間、サーバーに接続を試みるようになる同期ウィンドウを作成します。

wls:/base_domain/serverConfig> addIRMSyncWindow(\"MONDAY\",9,30,6,30)

getIRMSyncWindow

既存の同期ウィンドウを表示するオンライン・コマンド。

説明

このコマンドは、指定された索引にある同期ウィンドウを表示します。同期ウィンドウは、Oracle IRM Desktopが権限を同期するためにサーバーへの接続を試みる期間です。

構文

getIRMSyncWindow(sindex)

引数

定義

sindex

同期ウィンドウの索引を指定します。

例

次の例では、索引ゼロにある同期ウィンドウを表示します。

wls:/base_domain/serverConfig> getIRMSyncWindow(0)

次の例では、索引1にある同期ウィンドウを表示します。

wls:/base_domain/serverConfig> getIRMSyncWindow(1)

getIRMSyncWindows

既存の同期ウィンドウをすべて表示するオンライン・コマンド。

説明

このコマンドは、既存の同期ウィンドウをすべて表示します。同期ウィンドウは、Oracle IRM Desktopが権限を同期するためにサーバーへの接続を試みる期間です。

構文

getIRMSyncWindows()

例

wls:/base_domain/serverConfig> getIRMSyncWindows()

removeIRMSyncWindow

既存の同期ウィンドウを削除するオンライン・コマンド。

説明

このコマンドは、指定された索引にある同期ウィンドウを削除します。同期ウィンドウは、Oracle IRM Desktopが権限を同期するためにサーバーへの接続を試みる期間です。

構文

removeIRMSyncWindow(sindex)

引数

定義

sindex

同期ウィンドウの索引を指定します。

例

次の例では、索引ゼロにある同期ウィンドウを削除します。

wls:/base_domain/serverConfig> removeIRMSyncWindow(0)

次の例では、索引1にある同期ウィンドウを削除します。

wls:/base_domain/serverConfig> removeIRMSyncWindow(1)

updateIRMSyncWindow

既存の同期ウィンドウを更新するオンライン・コマンド。

説明

このコマンドは、既存の同期ウィンドウを更新します。同期ウィンドウは、Oracle IRM Desktopが権限を同期するためにサーバーへの接続を試みる期間です。

構文

updateIRMSyncWindow(indexOfDay,day,stHrs,stMins,endHrs,endMins)

引数

定義

indexOfDay

同期ウィンドウの索引を指定します。整数。

day

曜日を指定します。'MONDAY'、'TUESDAY'などです。

stHrs

開始時を指定します。整数。

stMins

開始分を指定します。整数。

endHrs

終了時を指定します。整数。

endMins

終了分を指定します。整数。

例

次の例では、Oracle IRM Desktopが、月曜日の午前9時30分から午後5時30分の間、サーバーに接続を試みるようになるように、索引ゼロにある同期ウィンドウを更新します。

wls:/base_domain/serverConfig> updateIRMSyncWindow(0,\"MONDAY\",9,30,5,30)

getIRMCryptoSchema

暗号化アルゴリズムを表示するオンライン・コマンド。

説明

このコマンドは、Oracle IRMを使用してシールされているファイルに現在適用されている暗号化アルゴリズムを表示します。

構文

getIRMCryptoSchema()

例

wls:/base_domain/serverConfig> getIRMCryptoSchema()

setIRMCryptoSchema

暗号化アルゴリズムを設定するオンライン・コマンド。

説明

このコマンドは、Oracle IRMを使用してシールされているファイルに適用する暗号化アルゴリズムを設定します。デフォルトのAES128をお薦めします。

構文

setIRMCryptoSchema(cryptID)

引数

定義

cryptID

暗号化アルゴリズムの名前を指定します。使用可能なアルゴリズム名は、AES128、AES256、AES128-FIPS、AES256-FIPS、DES3-FIPSです。

例

次の例では、Oracle IRMの通信に使用される暗号化アルゴリズムをAES128に設定します。

wls:/base_domain/serverConfig> setIRMCryptoSchema(\"AES128\")

getIRMDeviceCount

デバイス数を表示するオンライン・コマンド。

説明

このコマンドは、1つのシールされたドキュメントをユーザーが一度に開くことができるデバイスの最大数を表示します。この値はすべてのユーザーに適用され、ユーザーごとに異なることはありません。

構文

getIRMDeviceCount()

例

wls:/base_domain/serverConfig> getIRMDeviceCount()

setIRMDeviceCount

デバイス数を設定するオンライン・コマンド。

説明

このコマンドは、1つのシールされたドキュメントをユーザーが一度に開くことができるデバイスの最大数を設定します。この値はすべてのユーザーに適用されます。通常、このデバイス数は、パスワードを共有することでドキュメントのアクセス制限をすり抜けることを困難にするために低く(1または2に)設定します。

構文

setIRMDeviceCount(devCount)

引数

定義

devCount

デバイス数の値を指定します。整数。

例

次の例では、デバイス数を2に設定します。

wls:/base_domain/serverConfig> setIRMDeviceCount(2)

getIRMJournalCleanUp

現在のレポート・レコード・クリーンアップ値を表示するオンライン・コマンド。

説明

このコマンドは、レポート・レコード・クリーンアップ値を表示します。この値は、レポート・レコード・クリーンアップが実行される頻度、およびレポート・レコードが削除されるまでのそれらの最大存続時間を示します。

構文

getIRMJournalCleanUp()

例

wls:/base_domain/serverConfig> getIRMJournalCleanUp()

setIRMJournalCleanUp

レポート・レコード・クリーンアップ値を設定するオンライン・コマンド。

説明

このコマンドは、レポート・レコードクリーン・アップが実行される頻度、およびレポート・レコードが削除されるまでのそれらの最大存続時間を設定します。

構文

setIRMJournalCleanUp(clDuration,clUnitType,retDuration,retUnitType)

引数

定義

clDuration

レポート・レコード・クリーンアップが実行される頻度の値を指定します。整数。

clUnitType

レポート・レコード・クリーンアップが実行される頻度の単位を指定します。'MINUTES'、'HOURS'、'DAYS'、'MONTHS'、'YEARS'です。

retDuration

レポート・レコードが削除されるまでのそれらの最大存続時間の値を指定します。整数。

retUnitType

レポート・レコードが削除されるまでのそれらの最大存続時間の単位を指定します。'MINUTES'、'HOURS'、'DAYS'、'MONTHS'、'YEARS'です。

例

次の例では、レポート・レコード・クリーンアップを5日ごとに実行し、6か月を経過したレポート・レコードを削除します。

wls:/base_domain/serverConfig> setIRMJournalCleanUp(5,\"DAYS\",6,\"MONTHS\")

getIRMLicenseStateCleanUp

ライセンス状態クリーンアップ頻度を表示するオンライン・コマンド。

説明

このコマンドは、ライセンス状態クリーンアップ頻度(ライセンス・レコードが削除される頻度)を表示します。

構文

getIRMLicenseStateCleanUp()

例

wls:/base_domain/serverConfig> getIRMLicenseStateCleanUp()

setIRMLicenseStateCleanUp

ライセンス状態クリーンアップ頻度を設定するオンライン・コマンド。

説明

このコマンドは、ライセンス状態クリーンアップ頻度(ライセンス・レコードが削除される頻度)を設定します。

構文

setIRMLicenseStateCleanUp(duration,unitType)

引数

定義

duration

ライセンス・レコードが削除される頻度の値を指定します。整数。

unitType

ライセンス・レコードが削除される頻度の単位を指定します。'MINUTES'、'HOURS'、'DAYS'、'MONTHS'、'YEARS'です。

例

次の例では、ライセンス・レコードが削除される頻度を10時間に設定します。

wls:/base_domain/serverConfig> setIRMLicenseStateCleanUp(10,\"HOURS\")

次の例では、ライセンス・レコードが削除される頻度を50分に設定します。

wls:/base_domain/serverConfig> setIRMLicenseStateCleanUp(50,\"MINUTES\")

getIRMPrivacyURL

プライバシ・ステートメント・ページのURLを表示するオンライン・コマンド。

説明

このコマンドは、プライバシ・ステートメント・ページのURLを表示します。シールされたコンテンツを表示する前にユーザーが同意する必要があるステートメントを表示するプライバシ・ステートメント・ページ。

構文

getIRMPrivacyURL()

例

wls:/base_domain/serverConfig> getIRMPrivacyURL()

setIRMPrivacyURL

プライバシ・ステートメント・ページのURLを設定するオンライン・コマンド。

説明

このコマンドは、シールされたコンテンツを表示する前にユーザーが同意する必要があるプライバシ・ステートメントのURLを設定します。

構文

setIRMPrivacyURL(privacyURL)

引数

定義

privacyURL

プライバシ・ステートメント・ページのURLを指定します。

例

次の例では、プライバシ・ポリシー・ページのURLを"http://irm.example.com/"に設定します。

wls:/base_domain/serverConfig> setIRMPrivacyURL(\"http://irm.example.com/\")

getIRMKeyStore

Oracle IRMキーストアのタイプおよび場所を表示するオンライン・コマンド。

説明

このコマンドは、Oracle IRMキーストアのタイプおよび場所を表示します。

構文

getIRMKeyStore()

例

wls:/base_domain/serverConfig> getIRMKeyStore()

setIRMKeyStore

Oracle IRMキーストアのタイプおよび場所を設定するオンライン・コマンド。

説明

このコマンドは、Oracle IRMキーストアのタイプおよび場所を設定します。通常は、キーストアのタイプおよび場所をデフォルト(場所${domain.home}/config/fmwconfig/irm.jksのタイプJKS)から変更する必要はありません。

構文

setIRMKeyStore()

次の引数を指定するように求められます。

引数

定義

KeyStore Type

キーストアのタイプを指定します。

KeyStore Location

キーストアの場所を指定します。

例

次の例では、キーストアのタイプをJCEKSに、キーストアの場所をD:/exampledir/に設定します。

wls:/base_domain/serverConfig> setIRMKeyStore()
Enter KeyStore Type: JCEKS
Enter KeyStore Location: D:/exampledir/

移行コマンド

表16-3に示すWLSTコマンドを使用して、Oracle IRM Serverのインスタンス間におけるユーザー・データのインポートおよびエクスポートを設定します。

表16-3 Oracle IRMユーザー・データのインポートおよびエクスポートのためのWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

setIRMExportFolder

データ・エクスポート・フォルダの場所を設定またはクリアします。

オンライン

getIRMExportFolder

データ・エクスポート・フォルダの値を表示します。

オンライン

setIRMImportFolder

データ・インポート・フォルダの場所を設定またはクリアします。

オンライン

getIRMImportFolder

データ・インポート・フォルダの値を表示します。

オンライン

setIRMExportFolder

データ・エクスポート・フォルダの場所を設定またはクリアするオンライン・コマンド。

説明

このコマンドは、データ・エクスポートに使用するフォルダの場所を設定またはクリアします。

構文

setIRMExportFolder(folder)

引数

定義

folder

データ・エクスポート・フォルダの値を指定します。

例

wls:/base_domain/serverConfig> setIRMExportFolder("export")

getIRMExportFolder

データ・エクスポート・フォルダの値を表示するオンライン・コマンド。

説明

このコマンドは、データ・エクスポートに使用するフォルダの場所を表示します。

構文

getIRMExportFolder()

例

wls:/base_domain/serverConfig> getIRMExportFolder()

setIRMImportFolder

データ・インポート・フォルダの場所を設定またはクリアするオンライン・コマンド。

説明

このコマンドは、データ・インポートに使用するフォルダの場所を設定またはクリアします。

構文

setIRMImportFolder(folder)

引数

定義

folder

インポート・フォルダの値を指定します。

例

wls:/base_domain/serverConfig> setIRMImportFolder("import")

getIRMImportFolder

データ・インポート・フォルダの値を表示するオンライン・コマンド。

説明

このコマンドは、データ・インポートに使用するフォルダの場所を表示します。

構文

getIRMImportFolder()

例

wls:/base_domain/serverConfig> getIRMImportFolder()

テスト・コンテンツ・コマンド

表16-4に示すWLSTコマンドを使用して、Oracle IRM Desktopのユーザー向けのテスト・コンテンツを設定します。

表16-4 テスト・コンテンツのためのWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

addIRMTestContent

新しいテスト・コンテンツ・インスタンスを作成します。

オンライン

getIRMTestContent

既存のテスト・コンテンツ・インスタンスの詳細を表示します。

オンライン

getIRMTestContents

既存のテスト・コンテンツ・インスタンスすべての詳細を表示します。

オンライン

removeIRMTestContent

既存のテスト・コンテンツ・インスタンスを削除します。

オンライン

updateIRMTestContent

既存のテスト・コンテンツ・インスタンスを更新します。

オンライン

addIRMTestContent

新しいテスト・コンテンツ・インスタンスを作成するオンライン・コマンド。

説明

このコマンドは、テスト・コンテンツ・インスタンスを作成します。テスト・コンテンツ・インスタンスによって、テスト・コンテンツのアイテム(通常はイメージ・ファイル)が識別されます。テスト・コンテンツは、Oracle IRM Desktopがクライアント・テスト・ファシリティを介してOracle IRM Serverに正常に接続したときに、シールされたドキュメント内に表示されます。

構文

addIRMTestContent(uri,localeKeys,testNames)

引数

定義

uri

テスト・コンテンツ(たとえば、イメージ・ファイル)のURIを指定します。

localeKeys

このテスト・コンテンツ・インスタンスと関連付けられているロケールを指定します。表16-5に示す2文字の言語コードのリストのいずれか(たとえば、フランス語の場合は'fr')にする必要があります。1つのインスタンスに対してサポートされているロケールが複数ある場合、2文字のコードはカンマ区切りの値で表示する必要があります。

testNames

このテスト・コンテンツ・インスタンスと関連付けられている名前を指定します。1つのURIに対して名前が複数ある場合、名前はカンマ区切りの値で表示する必要があります。

表16-5 言語コード(ISO 639-1「2文字コード」)

言語/コード

言語/コード

言語/コード

アラビア語: ar

ギリシャ語: el

ルーマニア語: ro

ポルトガル語(ブラジル): pt-BR

ヘブライ語: iw

ロシア語: ru

チェコ語: cs

ハンガリー語: hu

簡体字中国語: zh-CN

デンマーク語: da

イタリア語: it

スロバキア語: sk

オランダ語: nl

日本語: ja

スペイン語: es

英語: en

韓国語: ko

スウェーデン語: sv

フィンランド語: fi

ノルウェー語: no

タイ語: th

フランス語: fr

ポーランド語: pl

繁体字中国語: zh-TW

ドイツ語: de

ポルトガル語: pt

トルコ語: tr

例

次の例では、'Test Content'という名前を表示する英語のインストールで使用するためのhttp://irm.example.comにあるexampleImage.jpgという名前のイメージを構成するテスト・コンテンツ・インスタンスを作成します。

wls:/base_domain/serverConfig> addIRMTestContent(\"http://irm.example.com/exampleImage.jpg\",\"en\",\"Test Content\")

次の例では、'Test Content (en)'および'Test Content (fr)'という名前を表示する英語およびフランス語のインストールで使用するためのhttp://irm.example.comにあるexampleImage.jpgという名前のイメージを構成するテスト・コンテンツ・インスタンスを作成します。

wls:/base_domain/serverConfig> addIRMTestContent(\"http://irm.example.com/exampleImage.jpg\",\"en,fr\",\"Test
Content (en),Test Content (fr)\")

getIRMTestContent

既存のテスト・コンテンツ・インスタンスの詳細を表示するオンライン・コマンド。

説明

このコマンドは、指定された索引にあるテスト・コンテンツ・インスタンスの詳細を表示します。テスト・コンテンツ・インスタンスによって、テスト・コンテンツのアイテム(通常はイメージ・ファイル)が識別されます。テスト・コンテンツは、Oracle IRM Desktopがクライアント・テスト・ファシリティを介してOracle IRM Serverに正常に接続したときに、シールされたドキュメント内に表示されます。

構文

getIRMTestContent(tindex)

引数

定義

tindex

テスト・コンテンツ・インスタンスの索引を指定します。

例

次の例では、索引ゼロにあるテスト・コンテンツ・インスタンスの詳細を表示します。

wls:/base_domain/serverConfig> getIRMTestContent(0)

次の例では、索引1にあるテスト・コンテンツ・インスタンスの詳細を表示します。

wls:/base_domain/serverConfig> getIRMTestContent(1)

getIRMTestContents

すべてのテスト・コンテンツ・インスタンスを表示するオンライン・コマンド。

説明

このコマンドは、すべてのテスト・コンテンツ・インスタンスを表示します。テスト・コンテンツ・インスタンスによって、テスト・コンテンツのアイテム(通常はイメージ・ファイル)が識別されます。テスト・コンテンツは、Oracle IRM Desktopがクライアント・テスト・ページを介してOracle IRM Serverに正常に接続したときに、シールされたドキュメント内に表示されます。

構文

getIRMTestContents()

例

wls:/base_domain/serverConfig> getIRMTestContents()

removeIRMTestContent

既存のテスト・コンテンツ・インスタンスを削除するオンライン・コマンド。

説明

このコマンドは、指定された索引にあるテスト・コンテンツ・インスタンスを削除します。テスト・コンテンツ・インスタンスによって、テスト・コンテンツのアイテム(通常はイメージ・ファイル)が識別されます。

構文

removeIRMTestContent(tindex)

引数

定義

tindex

テスト・コンテンツの索引を指定します。

例

次の例では、索引ゼロにあるテスト・コンテンツ・インスタンスを削除します。

wls:/base_domain/serverConfig> removeIRMTestContent(0)

次の例では、索引1にあるテスト・コンテンツ・インスタンスを削除します。

wls:/base_domain/serverConfig> removeIRMTestContent(1)

updateIRMTestContent

既存のテスト・コンテンツ・インスタンスを更新するオンライン・コマンド。

説明

このコマンドは、既存のテスト・コンテンツ・インスタンスを更新します。テスト・コンテンツ・インスタンスによって、テスト・コンテンツのアイテム(通常はイメージ・ファイル)が識別されます。テスト・コンテンツは、Oracle IRM Desktopがクライアント・テスト・ファシリティを介してOracle IRM Serverに正常に接続したときに、シールされたドキュメント内に表示されます。

構文

updateIRMTestContent(tindex,uri,localeKeys,testNames)

引数

定義

tindex

テスト・コンテンツ・インスタンスの索引を指定します。整数。

uri

テスト・コンテンツ(たとえば、イメージ・ファイル)のURIを指定します。

localeKeys

このテスト・コンテンツ・インスタンスと関連付けられているロケールを指定します。表16-5に示す2文字の言語コードのリストのいずれか(たとえば、フランス語の場合は'fr')にする必要があります。1つのインスタンスに対してサポートされているロケールが複数ある場合、2文字のコードはカンマ区切りの値で表示する必要があります。

testNames

このテスト・コンテンツ・インスタンスと関連付けられている名前を指定します。1つのURIに対して名前が複数ある場合、名前はカンマ区切りの値で表示する必要があります。

例

次の例では、'Test Content'という名前を表示する英語のインストールで使用するhttp://irm.example.comにあるexampleImage.jpgにイメージを変更することで、テスト・コンテンツ・インスタンスを更新します。

wls:/base_domain/serverConfig> updateIRMTestContent(0,\"http://irm.example.com/exampleImage.jpg\",\"en\",\"Test Content\")

次の例では、'Test Content (English)'および'Test Content (French)'という名前を表示する英語およびフランス語のインストールで使用するためのhttp://irm.example.comにあるexampleImage.jpgにイメージを変更することでテスト・コンテンツ・インスタンスを更新します。

wls:/base_domain/serverConfig> updateIRMTestContent(0,
\"http://irm.example.com/exampleImage.jpg\",\"en,fr\",\"Test Content
(English),Test Content (French)\")

言語サポート・コマンド

表16-6に示すWLSTコマンドを使用して、Oracle IRM Serverのユーザー向けの言語サポートを設定します。

表16-6 Oracle IRM Serverの言語サポートのためのWLSTコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

addIRMTranslation

新しい言語サポート・インスタンスを作成します。

オンライン

getIRMDefaultTranslation

デフォルト言語を表示します。

オンライン

getIRMTranslations

すべての言語サポート・インスタンスを表示します。

オンライン

removeIRMTranslation

既存の言語サポート・インスタンスを削除します。

オンライン

setIRMTranslations

デフォルト言語を設定し、1つ以上の追加の言語に対する言語サポート・インスタンスを設定します。

オンライン

addIRMTranslation

新しい言語サポート・インスタンスを作成するオンライン・コマンド。

説明

このコマンドは、新しい言語サポート・インスタンスを作成します。各言語サポート・インスタンスは、デフォルト言語に加えて1つ以上の言語の名前および説明を追加するOracle IRM Serverのファシリティを提供します。

構文

addIRMTranslation(transList)

引数

定義

transList

サポートされる言語指定します。表16-5に示す2文字の言語コードのリストのいずれか(たとえば、フランス語の場合は'fr')にする必要があります。1つのインスタンスに対してサポートされている言語が複数ある場合、2文字のコードはカンマ区切りの値で表示する必要があります。

例

次の例では、Oracle IRM Serverのユーザーがデフォルト言語に加えてフランス語の名前および説明を追加できるようにする言語サポート・インスタンスを作成します。

wls:/base_domain/serverConfig> addIRMTranslation(\"fr\")

次の例では、Oracle IRM Serverのユーザーがデフォルト言語に加えてフランス語およびアラビア語の名前および説明を追加できるようにする言語サポート・インスタンスを作成します。

wls:/base_domain/serverConfig> addIRMTranslation(\"fr,ar\")

getIRMDefaultTranslation

デフォルト言語を表示するオンライン・コマンド。

説明

このコマンドは、デフォルト言語を表示します。

構文

getIRMDefaultTranslation()

例

wls:/base_domain/serverConfig> getIRMDefaultTranslation()

getIRMTranslations

すべての言語サポート・インスタンスを表示するオンライン・コマンド。

説明

このコマンドは、すべての言語サポート・インスタンスを表示します。各言語サポート・インスタンスは、デフォルト言語に加えて1つ以上の言語の名前および説明を追加するOracle IRM Serverのファシリティを提供します。

構文

getIRMTranslations()

例

wls:/base_domain/serverConfig> getIRMTranslations()

removeIRMTranslation

既存の言語サポート・インスタンスを削除するオンライン・コマンド。

説明

このコマンドは、指定された索引にある言語サポート・インスタンスを削除します。各言語サポート・インスタンスは、デフォルト言語に加えて1つ以上の言語の名前および説明を追加するOracle IRM Serverのファシリティを提供します。

構文

removeIRMTranslation(tindex)

引数

定義

tindex

言語サポート・インスタンスの索引を指定します。

例

次の例では、索引ゼロにある言語サポート・インスタンスを削除します。

wls:/base_domain/serverConfig> removeIRMTranslation(0)

次の例では、索引1にある言語サポート・インスタンスを削除します。

wls:/base_domain/serverConfig> removeIRMTranslation(1)

setIRMTranslations

デフォルト言語を設定し、デフォルト言語に加えて1つ以上の言語に対する言語サポート・インスタンスを設定するオンライン・コマンド。

説明

このコマンドは、デフォルト言語を設定し、デフォルト言語に加えて1つ以上の言語に対する言語サポート・インスタンスを設定します。各言語サポート・インスタンスは、デフォルト言語に加えて1つ以上の言語の名前および説明を追加するOracle IRM Serverのファシリティを提供します。

構文

setIRMTranslations(defaultTrans,transList)

引数

定義

defaultTrans

デフォルト言語を指定します。言語コード(たとえば、英語の場合は'en')。

transList

サポートされる言語指定します。表16-5に示す2文字の言語コードのリストのいずれか(たとえば、フランス語の場合は'fr')にする必要があります。1つのインスタンスに対してサポートされている言語が複数ある場合、2文字のコードはカンマ区切りの値で表示する必要があります。

例

次の例では、Oracle IRM Serverのユーザーが、デフォルト言語として英語で名前および説明を入力し、さらにフランス語で名前および説明を入力できるようにします。

wls:/base_domain/serverConfig> setIRMTranslations(\"en\",\"fr\")

次の例では、Oracle IRM Serverのユーザーが、デフォルト言語として英語で名前および説明を入力し、さらにフランス語およびアラビア語で名前および説明を入力できるようにします。

wls:/base_domain/serverConfig> setIRMTranslations(\"en\",\"fr,ar\")

Oracle IRM Desktopインストーラ・コマンド

表16-7に示すWLSTコマンドを使用して、Oracle IRM Desktopソフトウェア向けのインストール・サポートを設定します。

表16-7 WLST Oracle IRM Desktopインストーラのコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

addIRMDownload

新しいインストーラを作成します。

オンライン

getIRMDownload

既存のインストーラの詳細を表示します。

オンライン

getIRMDownloads

すべてのインストーラの詳細を表示します。

オンライン

removeIRMDownload

既存のインストーラを削除します。

オンライン

updateIRMDownload

既存のインストーラを更新します。

オンライン

addIRMDownload

新しいインストーラを作成するオンライン・コマンド。

説明

このコマンドは、新しいインストーラを作成します。各インストーラは、Oracle IRM DesktopをインストールするためのソフトウェアのロケールおよびURIを識別し、Oracle IRM Serverのユーザーがインストーラを選択できるように名前およびバージョン番号を表示します。

構文

addIRMDownload(locale,name,version,uri)

引数

定義

locale

インストーラのロケールを指定します。表16-5に示す2文字の言語コードのリストのいずれか(たとえば、英語の場合は'en')にする必要があります。

name

インストーラの名前を指定します。

version

インストーラのバージョンを指定します。これは、インストーラのラベルであり、関連付けられているインストール・ソフトウェアに対して検証されていません。

uri

Oracle IRM Desktopインストール・ソフトウェアのURIを指定します。

例

次の例では、'Oracle IRM Desktop'という名前でバージョン番号11.1.1.1.0.0 (Oracle IRM Serverのユーザーがこのインストーラを選択したときに表示される)のhttp://irm.example.com/にある英語言語のインストール・ソフトウェア向けのインストーラを作成します。

wls:/base_domain/serverConfig> addIRMDownload(\"en\",\"Oracle IRM Desktop\",\"11.1.1.1.0.0\",\"http://irm.example.com/\")

getIRMDownload

既存のインストーラの詳細を表示するオンライン・コマンド。

説明

このコマンドは、指定された索引にあるインストーラの詳細を表示します。各インストーラは、Oracle IRM DesktopをインストールするためのソフトウェアのロケールおよびURIを識別し、Oracle IRM Serverのユーザーがインストーラを選択できるように名前およびバージョン番号を表示します。

構文

getIRMDownload(dindex)

引数

定義

dindex

ダウンロードの索引を指定します。

例

次の例では、索引ゼロにあるインストーラの詳細を表示します。

wls:/base_domain/serverConfig> getIRMDownload(0)

次の例では、索引1にあるインストーラの詳細を表示します。

wls:/base_domain/serverConfig> getIRMDownload(1)

getIRMDownloads

すべてのインストーラの詳細を表示するオンライン・コマンド。

説明

このコマンドは、すべてのインストーラの詳細を表示します。各インストーラは、Oracle IRM DesktopをインストールするためのソフトウェアのロケールおよびURIを識別し、Oracle IRM Serverのユーザーがインストーラを選択できるように名前およびバージョン番号を表示します。

構文

getIRMDownloads()

例

wls:/base_domain/serverConfig> getIRMDownloads()

removeIRMDownload

既存のインストーラを削除するオンライン・コマンド。

説明

指定された索引にあるインストーラを削除します。各インストーラは、Oracle IRM DesktopをインストールするためのソフトウェアのロケールおよびURIを識別し、Oracle IRM Serverのユーザーがインストーラを選択できるように名前およびバージョン番号を表示します。

構文

removeIRMDownload(dindex)

引数

定義

dindex

ダウンロードの索引を指定します。

例

次の例では、索引ゼロにあるインストーラを削除します。

wls:/base_domain/serverConfig> removeIRMDownload(0)

次の例では、索引1にあるインストーラを削除します。

wls:/base_domain/serverConfig> removeIRMDownload(1)

updateIRMDownload

既存のインストーラを更新するオンライン・コマンド。

説明

このコマンドは、既存のインストーラを更新します。各インストーラは、Oracle IRM DesktopをインストールするためのソフトウェアのロケールおよびURIを識別し、Oracle IRM Serverのユーザーがインストーラを選択できるように名前およびバージョン番号を表示します。

構文

updateIRMDownload(dindex,locale,name,version,uri)

引数

定義

dindex

インストーラの索引を指定します。整数。

locale

ダウンロードのロケールを指定します。表16-5に示す2文字の言語コードのリストのいずれか(たとえば、英語の場合は'en')にする必要があります。

name

インストーラの名前を指定します。

version

インストーラのバージョンを指定します。これは、インストーラのラベルであり、関連付けられているインストール・ソフトウェアに対して検証されていません。

uri

Oracle IRM Desktopインストール・ソフトウェアのURIを指定します。

例

次の例では、索引ゼロのインストーラを更新します。更新後、インストール・ソフトウェアは英語言語となり、http://irm.example.com/に配置されます。'Oracle IRM Desktop (English)'という名前およびバージョン番号11.1.1.1.0.0が、Oracle IRM Serverのユーザーがこのインストーラを選択したときに表示されます。

wls:/base_domain/serverConfig> updateIRMDownload(0,\"en\",\"Oracle IRM Desktop
(English)\",\"11.1.1.1.0.0\",\"http://irm.example.com/\")

17 Oracle WebCenter: ImagingカスタムWLSTコマンド

次の項では、Oracle WebCenter: Imagingの固有のWLSTコマンドについて説明します。次のトピックがあります。

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

- 診断コマンド

- Imagingの構成コマンド

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

Imaging固有のWLSTコマンドは、次のカテゴリに分かれています。

表17-1 ImagingのWLSTコマンド・カテゴリ

コマンド・カテゴリ

説明

診断コマンド

ワークフロー・エージェントおよびその他の処理情報を返します。

Imagingの構成コマンド

Imaging and Process Managementに固有の設定を構成します。

診断コマンド

表17-2に示すImagingのWLST診断コマンドを使用して、ワークフロー・プロセス中の処理の失敗を一覧表示し、編成します。

表17-2 Imagingの診断コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

clearIPMWorkflowFaults

ワークフロー・エージェントの処理中に発生した処理の失敗をクリアします。

オンライン

listIPMWorkflowFaults

ワークフロー・エージェントの処理中に発生した処理の失敗の詳細を提供します。

オンライン

repairIPMWorkflowFaults

ワークフロー・エージェントの処理中に発生した処理の失敗を修復します。

オンライン

sumIPMWorkflowFaults

ワークフロー・エージェントの処理中の処理の失敗を、日付、アプリケーションIDまたはバッチIDによってグループ化してカウントします。

オンライン

resetIpmDMSMetrics

DMSメトリックをゼロにリセットします。

オンライン

clearIPMWorkflowFaults

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

WLSTでの使用: オンライン

説明

ワークフロー・エージェントの処理中に発生した処理の失敗をクリアします。

構文

clearIPMWorkflowFaults([startDate], [endDate], [appId], [batchId])

引数

定義

startDate

オプション。エラー詳細を修復する必要がある日付範囲の開始日(yyyy-MM-dd形式)。

endDate

オプション。エラー詳細を修復する必要がある日付範囲の終了日(yyyy-MM-dd形式)。

appId

オプション。エラー詳細を修復する必要があるアプリケーションID (yyyy-MM-dd形式)。

batchId

オプション。エラー詳細を修復する必要があるバッチID。

例

次の例では、指定したパラメータ内のフォルトをクリアします。

clearIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02")
clearIPMWorkflowFaults(appId=3)
clearIPMWorkflowFaults(batchId=15)
clearIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02", appid=3)

listIPMWorkflowFaults

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

WLSTでの使用: オンライン

説明

ワークフロー・エージェントの処理中に発生した処理の失敗の詳細を一覧表示します。

構文

listIPMWorkflowFaults([startDate], [endDate], [appId], [batchId])

引数

定義

startDate

オプション。エラー詳細を修復する必要がある日付範囲の開始日(yyyy-MM-dd形式)。

endDate

オプション。エラー詳細を修復する必要がある日付範囲の終了日(yyyy-MM-dd形式)。

appId

オプション。エラー詳細を修復する必要があるアプリケーションID。

batchId

オプション。エラー詳細を修復する必要があるバッチID。

例

次の例では、指定したパラメータ内のフォルトを一覧表示します。

listIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02")
listIPMWorkflowFaults(appId=3)
listIPMWorkflowFaults(batchId=15)
listIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02", appId=3)

repairIPMWorkflowFaults

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

WLSTでの使用: オンライン

説明

ワークフロー・エージェントの処理中に発生した処理の失敗を修復します。

構文

repairIPMWorkflowFaults([startDate], [endDate], [appId], [batchId])

引数

定義

startDate

オプション。エラー詳細を修復する必要がある日付範囲の開始日(yyyy-MM-dd形式)。

endDate

オプション。エラー詳細を修復する必要がある日付範囲の終了日(yyyy-MM-dd形式)。

appId

オプション。エラー詳細を修復する必要があるアプリケーションID。

batchId

オプション。エラー詳細を修復する必要があるバッチID。

例

次の例では、指定したパラメータ内のフォルトを修復します。

repairIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02")
repairIPMWorkflowFaults(appId=3)
repairIPMWorkflowFaults(batchId=15)
repairIPMWorkflowFaults(startDate="2009-06-01", endDate="2009-06-02", appid=3)

sumIPMWorkflowFaults

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

WLSTでの使用: オンライン

説明

ワークフロー・エージェントの処理中に発生した処理の失敗のカウントを提供します。結果は、日付、アプリケーションIDまたはバッチIDによってグループ化されます。

構文

sumIPMWorkflowFaults(group)

引数

定義

groupOption

必須。次のうちいずれか。

- DATE: 日付でグループ化されたフォルト・カウントを返します。

- APPID: アプリケーションIDでグループ化されたフォルト・カウントを返します。

- BATCHID: バッチIDでグループ化されたフォルト・カウントを返します。

例

次の例では、最初に日付で、次にアプリケーションIDで、そしてバッチIDでグループ化されたすべてのワークフロー・フォルトを返します。

sumIPMWorkflowFaults(group="DATE")
sumIPMWorkflowFaults(group="APPID")
sumIPMWorkflowFaults(group="BATCHID")

resetIpmDMSMetrics

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

WLSTでの使用: オンライン

説明

I/PMと関連付けられているすべてのDynamic Monitoring Server (DMS)メトリックをゼロにリセットします。これは、通常、管理者が、履歴パフォーマンス・データによって現在の結果に歪みが生じていることを見つけた場合に行われます。

構文

resetIpmDMSMetrics()

例

次の例では、すべてのDMSメトリックをゼロにリセットします。

resetIpmDMSMetrics()

Imagingの構成コマンド

表17-3に示すImagingの構成コマンドを使用して、Imagingに固有の構成値を一覧表示および設定します。

表17-3 Imagingの構成コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

createIPMConnection

接続定義ファイルから新しいImagingの接続を作成します。

オンライン

getIPMConfig

カスタムImaging構成MBeanに移動して標準WLST setコマンドを使用する場合と同様に、Imaging構成設定値を取得します。

オンライン

grantIPMCredAccess

Imaging管理対象サーバーが、管理サーバーとは別のドメイン・ホームにある場合に、ImagingにCredentialAccessPermissionsを付与します。

オンライン

importIPMApplication

前にエクスポートされた定義ファイルからアプリケーション定義をインポートします。

オンライン

importIPMInput

前にエクスポートされた定義ファイルから入力定義をインポートします。

オンライン

importIPMSearch

前にエクスポートされた定義ファイルから検索定義をインポートします。

オンライン

listIPMConfig

Imaging構成MBeanを一覧表示します。

オンライン

listIPMExportFile

エクスポートされたImaging定義ファイルの内容を一覧表示します。

オンライン

refreshIPMSecurity

Imagingデータベースに現在格納されているセキュリティ・アイテムをリフレッシュします。

オンライン

setIPMConfig

Imagingの構成値を設定します。

オンライン

submitIPMToWorkflow

ドキュメントをワークフロー・エージェントに送信します。

オンライン

createIPMConnection

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

WLSTでの使用: オンライン

説明

接続定義ファイルから新しいImagingの接続を作成します。接続定義ファイルはXMLファイルであり、Imaging ConnectionService WebサービスAPIスキーマ定義からConnection要素タイプを使用して、単一のImaging接続定義を記述します。このスキーマは、次のURLを使用して実行されるImagingサーバーから使用できます。

http://ipm_server_machine:ipm_server_port/imaging/ws/ConnectionService?xsd=1

接続定義ファイル・フォーマットの詳細は、『Oracle WebCenter Content Imaging管理者ガイド』を参照してください。

構文

createIPMConnection(connectionFile)

引数

定義

connectionFile

必須。Imagingサーバー・ノード上の接続定義ファイルの場所のフルパス。一重または二重の引用符で囲む必要があります。

例

次の例では、指定された属性に基づいて接続を作成します。

createIPMConnection(connectionFile="/home/ipmuser/localCSConnection.xml")

getIPMConfig

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

WLSTでの使用: オンライン

説明

Imagingの構成設定値を取得します。このコマンドは、カスタムMBean階層を参照してImaging構成MBeanに移動し、標準WLST setコマンドを使用してMBean属性を設定する場合と同じです。

構文

getIPMConfig(attrName)

引数

定義

attrName

必須。読み取る属性の名前。一重または二重の引用符で囲む必要があります。

例

次の例では、指定した属性名の値を返します。

getIPMConfig('AgentUser')getIPMConfig('CheckInterval')

grantIPMCredAccess

Imagingが資格証明ストアから資格証明を読み取れるようにCredentialAccessPermissionsを付与します。このコマンドは、Imaging管理対象サーバーが、管理サーバーとは別のドメイン・ホームに配置されている場合の構成に必要です。少なくとも1つのImaging管理対象サーバーが管理サーバーと同じドメイン・ホームに配置されている場合、Imagingの起動中にCredentialAccessPermissionsが付与されるため、このコマンドは不要です。

ただし、Imaging管理対象サーバーが管理サーバーと同じドメインにない場合は、Imagingの起動によって、そのローカル設定にのみ作用する権限が付与されます。ローカル設定は管理サーバーがそのコピーをドメイン全体の構成として同期する際に上書きされます。このコマンドは、パーミッションがすべてのドメイン・ノードに適切に配分されるように管理サーバー構成を更新します。

構文

grantIPMCredAccess()

例

次の例では、すべてのImaging構成Mbeanのリストを返します。

grantIPMCredAccess()

importIPMApplication

前にエクスポートされた定義ファイルからアプリケーション定義をインポートします。

構文

importIPMApplication(exportFile, action, name, repository, securityOption, securityMember, docSecurityOption, docSecurityGroup, storageOption, storageVolume)

引数

定義

exportFile

必須。Imagingサーバー・ノード上のエクスポート定義ファイルの場所のフルパス。一重または二重の引用符で囲む必要があります。

action

必須。実行するアクション。実行可能なアクションは次のとおりです:

- Add: 新規入力を作成します。同じ名前のアプリケーションがすでに存在する場合は失敗します。

- Update: 既存の入力を変更します。同じ名前のアプリケーションが存在しない場合は失敗します。

- AddOrUpdate: まだ存在していない場合は新規アプリケーションを作成します。存在する場合はそれを更新します。

name

必須。エクスポートされた定義ファイルからインポートするアプリケーションの名前。

repository

そのアプリケーションを作成するリポジトリの名前。アプリケーションを追加する場合は必須であり、アプリケーションを更新または変更する場合は無視されます。

securityOption

オプション。インポートされるアプリケーションのセキュリティを定義する方法を次のように指定します。

- Existing: 既存の定義で定義されているアプリケーション・セキュリティを使用します。更新アクションの場合にのみ有効です。

- Imported: インポート・ファイルで定義されているアプリケーション・セキュリティの使用を試みます。インポート・ファイルに定義されているメンバーのいずれかが無効な場合は失敗します。

- ValidOnly: インポート・ファイルで定義されているアプリケーション・セキュリティを使用し、無効なメンバーをすべてフィルタで除外します。

- CurrentUser: サーバーに接続するために使用するユーザーに完全なパーミッションを設定します。

- User: securityMemberパラメータで指定されているユーザー名に完全なパーミッションを設定します。

- Group: securityMemberパラメータで指定されているグループ名に完全なパーミッションを設定します。

securityMember

アプリケーションに対する完全なパーミッションを付与されるユーザーまたはグループの名前。securityOptionをUserまたはGroupのいずれかに設定した場合にのみ有効であり、それ以外の場合は無視されます。

docSecurityOption

オプション。インポートされるアプリケーションのドキュメント・セキュリティを定義する方法を指定します。

- Existing: 既存のアプリケーションで定義されているドキュメント・セキュリティを使用します。更新アクションの場合にのみ有効です。

- Imported: インポート・ファイルで定義されているドキュメント・セキュリティの使用を試みます。インポート・ファイルに定義されているメンバーのいずれかが無効な場合は失敗します。

- ValidOnly: インポート・ファイルで定義されているドキュメント・セキュリティを使用し、無効なメンバーをすべてフィルタで除外します。

- Group: docSecurityGroupパラメータで指定されているグループ名に完全なパーミッションを設定します。

docSecurityGroup

ドキュメント・セキュリティに対する完全なパーミッションを付与されるグループの名前。docSecurityOptionをGroupに設定した場合にのみ有効であり、それ以外の場合は無視されます。

storageOption

オプション。インポートされるアプリケーションの記憶域ポリシーを定義する方法を指定します。

- Existing: 既存のアプリケーションで定義されているドキュメント記憶域ポリシーを使用します。更新アクションの場合にのみ有効です。

- Imported: インポート・ファイルで定義されている記憶域ポリシーの使用を試みます。

- Volume: storageVolumeパラメータで指定されている特定のボリュームを使用します。

- Default: システム・デフォルト・ボリュームを使用するための記憶域ポリシーを設定します。

storageVolume

必須。記憶域ポリシーを設定するボリューム。VolumeのstorageOptionが使用される場合にのみ有効です。それ以外の場合は無効です。

例

次の例では、Invoicesという名前の既存のアプリケーションを更新します。更新アクションでは、元のアプリケーションで指定されているリポジトリが使用されるため、リポジトリはNoneと示されます。

importIPMApplication(exportFile="/home/ipmuser/exportdefinitions.xml", action="Update", name="Invoices", repository=None, securityOption="Existing")

例

次の例では、Receiptsという名前の新規アプリケーションを作成します。追加アクションでは、有効なリポジトリを指定する必要があるため、リポジトリは明示的に指定されています。

importIPMApplication(exportFile="/home/ipmuser/exportdefinitions.xml", action="Add", name="Receipts", repository="LocalCS", securityOption="ValidOnly")

importIPMInput

前にエクスポートされた定義ファイルから入力定義をインポートします。

構文

importIPMInput(exportFile, action, name, securityOption, securityMember)
)

引数

定義

exportFile

必須。Imagingサーバー・ノード上のエクスポート定義ファイルの場所のフルパス。一重または二重の引用符で囲む必要があります。

action

必須。実行するアクション。実行可能なアクションは次のとおりです:

- Add: 新規入力を作成します。同じ名前の入力がすでに存在する場合は失敗します。

- Update: 既存の入力を変更します。同じ名前の入力が存在しない場合は失敗します。

- AddOrUpdate: まだ存在していない場合は新規アプリケーションを作成します。存在する場合はそれを更新します。

name

必須。エクスポートされた定義ファイルからインポートする入力の名前。

repository

そのアプリケーションを作成するリポジトリの名前。アプリケーションを追加する場合は必須であり、アプリケーションを更新または変更する場合は無視されます。

securityOption

オプション。インポートされるアプリケーションのセキュリティを定義する方法を次のように指定します。

- Existing: 既存の定義で定義されている入力セキュリティを使用します。更新アクションの場合にのみ有効です。

- Imported: インポート・ファイルで定義されている入力セキュリティの使用を試みます。インポート・ファイルに定義されているメンバーのいずれかが無効な場合は失敗します。

- ValidOnly: インポート・ファイルで定義されている入力セキュリティを使用し、無効なメンバーをすべてフィルタで除外します。

- CurrentUser: サーバーに接続するために使用するユーザーに完全なパーミッションを設定します。

- User: securityMemberパラメータで指定されているユーザー名に完全なパーミッションを設定します。

- Group: securityMemberパラメータで指定されているグループ名に完全なパーミッションを設定します。

securityMember

入力に対する完全なパーミッションを付与されるユーザーまたはグループの名前。securityOptionをUserまたはGroupのいずれかに設定した場合にのみ有効であり、それ以外の場合は無視されます。

例

次の例では、Invoicesという名前の既存の入力を更新します。更新アクションでは、元のアプリケーションで指定されているリポジトリが使用されるため、リポジトリはNoneと示されます。

importIPMInput(exportFile="/home/ipmuser/exportdefinitions.xml", action="Update", name="Invoices", securityOption="Existing")

例

次の例では、Receiptsという名前の新規入力を作成します。追加アクションでは、有効なリポジトリを指定する必要があるため、リポジトリは明示的に指定されています。

importIPMInput(exportFile="/home/ipmuser/exportdefinitions.xml", action="Add", name="Receipts", securityOption="ValidOnly")

importIPMSearch

前にエクスポートされた定義ファイルから検索定義をインポートします。

構文

importIPMSearch(exportFile, action, name, securityOption, securityMember)

引数

定義

exportFile

必須。Imagingサーバー・ノード上のエクスポート定義ファイルの場所のフルパス。一重または二重の引用符で囲む必要があります。

action

必須。実行するアクション。実行可能なアクションは次のとおりです:

- Add: 新規検索を作成します。同じ名前の検索がすでに存在する場合は失敗します。

- Update: 既存の検索を変更します。同じ名前の検索が存在しない場合は失敗します。

- AddOrUpdate: まだ存在していない場合は新規検索を作成します。存在する場合はそれを更新します。

name

必須。エクスポートされた定義ファイルからインポートする検索の名前。

repository

そのアプリケーションを作成するリポジトリの名前。アプリケーションを追加する場合は必須であり、アプリケーションを更新または変更する場合は無視されます。

securityOption

オプション。インポートされるアプリケーションのセキュリティを定義する方法を次のように指定します。

- Existing: 既存の定義で定義されている検索セキュリティを使用します。更新アクションの場合にのみ有効です。

- Imported: インポート・ファイルで定義されている検索セキュリティの使用を試みます。インポート・ファイルに定義されているメンバーのいずれかが無効な場合は失敗します。

- ValidOnly: インポート・ファイルで定義されている検索セキュリティを使用し、無効なメンバーをすべてフィルタで除外します。

- CurrentUser: サーバーに接続するために使用するユーザーに完全なパーミッションを設定します。

- User: securityMemberパラメータで指定されているユーザー名に完全なパーミッションを設定します。

- Group: securityMemberパラメータで指定されているグループ名に完全なパーミッションを設定します。

securityMember

検索に対する完全なパーミッションを付与されるユーザーまたはグループの名前。securityOptionをUserまたはGroupのいずれかに設定した場合にのみ有効であり、それ以外の場合は無視されます。

例

次の例では、Invoicesという名前の既存の検索を更新します。更新アクションでは、元のアプリケーションで指定されているリポジトリが使用されるため、リポジトリはNoneと示されます。

importIPMSearch(exportFile="/home/ipmuser/exportdefinitions.xml", action="Update", name="Invoices", securityOption="Existing")

例

次の例では、Receiptsという名前の新規検索を作成します。追加アクションでは、有効なリポジトリを指定する必要があるため、リポジトリは明示的に指定されています。

importIPMSearch(exportFile="/home/ipmuser/exportdefinitions.xml", action="Add", name="Receipts", securityOption="ValidOnly")

listIPMConfig

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

WLSTでの使用: オンライン

説明

Imaging構成MBeanの一覧を提供します。このコマンドは、カスタムMBean階層を参照し、Imaging MBean属性を一覧表示する場合と同じです。

構文

listIPMConfig()

例

次の例では、すべてのImaging構成Mbeanのリストを返します。

listIPMConfig()

listIPMExportFile

エクスポートされたImaging定義ファイルの内容を一覧表示します。

構文

listIPMExportFile(exportFile="<path to file>")

引数

定義

exportFile

必須。Imagingサーバー・ノード上のエクスポート定義ファイルの場所のフルパス。一重または二重の引用符で囲む必要があります。

例

次の例では、Imaging定義ファイルの内容を返します。

listIPMExportFile(exportFile="/home/ipmuser/exportdefinitions.xml")

refreshIPMSecurity

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

WLSTでの使用: オンライン

説明

Imagingデータベースに現在格納されているセキュリティ・アイテムをリフレッシュします。これは通常、異なるポリシー・ストアにセキュリティを移行し、新しいポリシー・ストア内に見つかったセキュリティ・アイテムのみを更新する場合に実行します。

構文

refreshIPMSecurity()

例

次の例では、Imagingデータベースに格納されているセキュリティ・アイテムをリフレッシュします。

refreshIPMSecurity()

setIPMConfig

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

WLSTでの使用: オンライン

説明

Imagingの構成設定値を設定します。このコマンドは、カスタムMBean階層を参照してImaging構成MBeanに移動し、標準WLST 'set'コマンドを使用してMBean属性を設定する場合と同じです。

構文

setIPMConfig(attrName, value)

引数

定義

attrName

必須。設定する属性の名前。一重または二重の引用符で囲む必要があります。

value

必須。設定する属性の値。値が文字列リテラルである場合にのみ、一重または二重の引用符で囲みます。

例

次の例では、指定した属性名に指定した値を設定します。

setIPMConfig('AgentUser', 'agentadmin')setIPMConfig('CheckInterval', 30)

submitIPMToWorkflow

ドキュメントをワークフロー・エージェントに送信します。ドキュメントが送信されたことを示す確認メッセージが表示されますが、ドキュメントがワークフローで構成されていないアプリケーションに格納されている場合、アクションは実行されません。

構文

submitIPMToWorkflow(documentId)

引数

定義

documentId

必須。送信されたドキュメントの一意のドキュメントID。

例

次の例では、ドキュメントをワークフローに送信します。

submitIPMToWorkflow(documentId="2.IPM_12345")

18 Oracle Business Process ManagementカスタムWLSTコマンド

この章では、Oracle Business Process ManagementカスタムWLSTコマンドのリストを示し、説明します。

BPMLifecycleAdminコマンド・グループ

表18-1は、プロジェクトのライフサイクル管理のためのBPMLifecycleAdminコマンドのリストを示し、説明しています。

表18-1 プロジェクトのライフサイクル管理のためのBPMLifecycleAdminコマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

create_public_share

公開共有を作成します

オフライン

unlock_public_share

公開共有をロック解除します

オフライン

export_public_share

公開共有をファイル・システムにエクスポートします

オフライン

delete_public_share

公開共有を削除します

オフライン

publish_template

テンプレートをMDSに公開します

オフライン

export_template

テンプレートをファイル・システムにエクスポートします

オフライン

delete_template

テンプレートをMDSから削除します

オフライン

create_public_share

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、テンプレートから公開共有を作成します。そのテンプレートはMDS内に存在している必要があります。

構文

create_public_share(composerUser, composerPassword, connectionURL, templateName, publicshareId, mdsconfigLocation, [Override], [oracleHome] )

引数

定義

composerUser

現在の操作を実行するBusiness Process Composerユーザー。

composerPassword

BPM Composerユーザーのパスワード

connectionURL

host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL

templateName

MDS内のテンプレートの名前

publicshareId

作成する公開共有の名前

mdsconfigLocation

MDSへの接続に使用するmds-config.xmlの場所

projectLocation

公開共有の作成先のパス。そのパスが存在しない場合、作成されます。ルートは、'/'です。

Override

同じ名前を持つ公開共有がMDS内に存在している場合、その公開共有をオーバーライドできます。このコマンドを実行する場合、テンプレートはオーバーライドされません。

oracleHome

オプション。使用されるOracleホーム。

例

次の例では、Sample_PublicShareという名前の公開共有を作成します。これは、Sample_Templateという名前のテンプレートに基づいています。公開共有の名前はSample_PublicShareであり、mds-config.xmlファイルの場所は/tmp/mds-config.xmlです。

create_public_share('user_name', 'password', 'host:port','Sample_Template', 'Sample_PublicShare','/tmp/mds-config.xml')

次の例では、Sample_PublicShareという名前の公開共有を作成します。これは、MDS内に存在するSample_Templateという名前のテンプレートに基づいています。テンプレートではなく、公開共有がオーバーライドされます。mds-config.xmlファイルの場所は/tmp/mds-config.xmlです。

create_public_share('user_name', 'password', 'host:port','Sample_Template', 'Sample_PublicShare','/tmp/mds-config.xml','true')"

unlock_public_share

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、公開共有をロック解除します。たとえば、Antタスクcreate_public_shareコマンドを使用してプロジェクトを作成する場合、そのプロジェクトはロックされた状態で作成されます。その後、unlock_public_shareコマンドを使用してそれをロック解除できます。

ロックは、Oracle Business Process Composerの「プロジェクトの作成」ページの「共有の有効化」チェック・ボックスを選択または選択解除することによっても設定できます。

それは、ユーザーが、Business Process Composerからプロジェクトを公開するときもロック解除されます。

その公開共有はMDS内に存在している必要があります。

構文

unlock_public_share(composerUser, composerPassword, connectionURL, publicshareId, mdsconfigLocation, [oracleHome] )

引数

定義

composerUser

現在の操作を実行するBusiness Process Composerユーザー。

composerPassword

BPM Composerユーザーのパスワード

connectionURL

host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL

publicshareId

ロック解除する公開共有の名前

mdsconfigLocation

MDSへの接続に使用するmds-config.xmlの場所

oracleHome

オプション。使用されるOracleホーム

例

次の例では、Sample_PublicShareという名前の公開共有をロック解除します。mds-config.xmlファイルの場所は/tmp/mds-config.xmlです。

unlock_public_share('user_name', 'password', 'host:port','Sample_PublicShare', '/tmp/mds-config.xml')

export_public_share

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、MDSからファイル・システムに公開共有をエクスポートします。

構文

export_public_share(composerUser, composerPassword, connectionURL, publicshareId,fsLocation, mdsconfigLocation, [oracleHome] )

引数

定義

composerUser

現在の操作を実行するBusiness Process Composerユーザー。

composerPassword

BPM Composerユーザーのパスワード

connectionURL

host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL

publicshareId

エクスポートする公開共有の名前

fsLocation

プロジェクトをダウンロードするファイル・システムの場所

mdsconfigLocation

MDSへの接続に使用するmds-config.xmlの場所

oracleHome

オプション。使用されるOracleホーム

例

次の例では、公開共有名としてSample_PublicShareを、ファイル・システムの場所として/tmpを、mds-config.xmlファイルの場所として/tmp/mds-config.xmlを指定します。

export_public_share('user_name', 'password', 'host:port','Sample_PublicShare','/tmp', '/tmp/mds-config.xml')

delete_public_share

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、MDSから公開共有を削除します。このコマンドを実行するには、公開共有がロックされていないことが必要です。

構文

delete_public_share(composerUser, composerPassword, connectionURL, publicshareId, mdsconfigLocation, [releaseLock], [oracleHome] )

引数

定義

composerUser

現在の操作を実行するBusiness Process Composerユーザー。

composerPassword

BPM Composerユーザーのパスワード

connectionURL

host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL

publicshareId

削除する公開共有の名前

mdsconfigLocation

MDSへの接続に使用するmds-config.xmlの場所

releaseLock

オプション。公開共有がロックされている場合、このロックは解除でき、削除操作を完了できます。この属性は、trueとfalseのいずれかに設定できます。指定しない場合、デフォルト値はfalseです。

oracleHome

オプション。使用されるOracleホーム

例

次の例では、削除する公開共有の名前および場所を指定します。

delete_public_share('Sample_PublicShare','/tmp/mds-config.xml')

次の例では、削除する公開共有の名前および場所を指定し、ロックされていてもその公開共有を削除することを指定します。

delete_public_share('user_name', 'password', 'host:port','Sample_PublicShare','/tmp/mds-config.xml','true')

publish_template

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、ファイル・システムからMDSにテンプレートを公開します。

構文

publish_template(composerUser, composerPassword, connectionURL, templateName,fsLocation, mdsconfigLocation, [Override], [oracleHome] )

引数

定義

composerUser

現在の操作を実行するBusiness Process Composerユーザー。

composerPassword

BPM Composerユーザーのパスワード

connectionURL

host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL

templateName

公開するテンプレートの名前

fsLocation

テンプレート・プロジェクトのファイル・システムの場所

mdsconfigLocation

MDSへの接続に使用するmds-config.xmlの場所

projectLocation

公開共有の作成先のパス。そのパスが存在しない場合、作成されます。ルートは、'/'です。

Override

MDSにテンプレートを公開するときに、この属性によって、同じ名前を持つ既存のテンプレートをオーバーライドできます。'true'と'false'のいずれかにすることができます。指定しない場合、デフォルト値は'false'です。

oracleHome

オプション。使用されるOracleホーム

例

次の例では、Sample_Template_Name_MDSという名前のテンプレートをルート・フォルダに公開します。

f('user_name', 'password', 'host:port','Sample_Template','/tmp/MyTemplate','/', '/tmp/mds-config.xml')

次の例では、Sample_Template_Name_MDSという名前のテンプレートを'/WorkingOn/'フォルダに公開します。

publish_template('user_name', 'password', 'host:port','Sample_Template','/tmp/MyTemplate','/WorkingOn', '/tmp/mds-config.xml')

export_template

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、MDSからファイル・システムにテンプレートをエクスポートします。

構文

export_template(composerUser, composerPassword, connectionURL, templateName, fsLocation, mdsconfigLocation, [oracleHome] )

引数

定義

composerUser

現在の操作を実行するBusiness Process Composerユーザー。

composerPassword

BPM Composerユーザーのパスワード

connectionURL

host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL

templateName

エクスポートするテンプレートの名前

fsLocation

プロジェクトをダウンロードするファイル・システムの場所

mdsconfigLocation

MDSへの接続に使用するmds-config.xmlの場所

oracleHome

オプション。使用されるOracleホーム

例

次の例では、テンプレート名としてSample_Templateを、ファイル・システムの場所として/tmpを、mds-config.xmlファイルの場所として/tmp/mds-config.xmlを指定します。

export_template('user_name', 'password', 'host:port','Sample_Template','/tmp','/tmp/mds-config.xml')

delete_template

コマンド・カテゴリ: BPMLifecycleAdminコマンド

WLSTでの使用: オフライン

説明

このコマンドを使用して、MDSからテンプレートを削除します。

構文

delete_template(composerUser, composerPassword, connectionURL, templateName,mdsconfigLocation, [oracleHome] )

引数

定義

composerUser

現在の操作を実行するBusiness Process Composerユーザー。

composerPassword

BPM Composerユーザーのパスワード

connectionURL

host:portの形式のセキュリティ・サーバー・サービスへのJNDI接続URL

templateName

削除するテンプレートの名前

fsLocation

テンプレート・プロジェクトのファイル・システムの場所

mdsconfigLocation

MDSへの接続に使用するmds-config.xmlの場所

projectLocation

公開共有の作成先のパス。そのパスが存在しない場合、作成されます。ルートは、'/'です。

oracleHome

オプション。使用されるOracleホーム

例

次の例では、Sample_templateという名前のテンプレートをMDSから削除します。

delete_template('weblogic', 'welcome1', 'host:port','/Sample_template','/tmp/mds-config.xml')

19 Oracle WebCenter ContentカスタムWLSTコマンド

次の項では、Oracle WebCenter ContentのWLSTカスタム・コマンドについて説明します。これらのコマンドで、WebCenter ContentサーバーおよびContent Serverインスタンスをコマンド行から構成および監視できます。次のトピックがあります。

- 「WLST WebCenter Contentのヘルプ」

- 「サーバー構成コマンド」

- 「電子メール構成コマンド」

- 「追加のコマンド」

WebCenter ContentおよびContent Serverの管理および構成の詳細は、Oracle WebCenter Content Content Serverシステム管理者ガイドを参照してください。

注意:

WebCenter Contentカスタム・コマンドを使用するには、コンポーネントがインストールされたOracle共通ホームからWLSTスクリプトを呼び出す必要があります。Oracle Fusion Middleware管理者ガイドのカスタムWLSTコマンドの使用に関する項を参照してください。

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

WLST WebCenter Contentコマンドは次のカテゴリに分かれています。

表19-1 WLST WebCenter Contentコマンド・カテゴリ

コマンド・カテゴリ

説明

サーバー構成コマンド

Content Serverインスタンスの構成を表示および管理します。

電子メール構成コマンド

Content Server電子メールの構成を表示および管理します。

追加のコマンド

コンテンツ・サーバー・インスタンスのステータス情報を表示します。

WLST WebCenter Contentのヘルプ

WLSTから呼び出すことができるWebCenter Contentコマンドを表示するには、WLSTプロンプトで次のコマンドを入力します。

help('UCM')

特定のWebCenter Contentコマンドのヘルプを表示するには、'UCM'をコマンドの名前に置き換えます。例:

help('getUCMServerPort')

ゲッター・メソッドとセッター・メソッドの実装

WebCenter Content向けのWLSTコンポーネントは、getterおよびsetterメソッドを使用して、複数のアプリケーションがそれらに対応するMbeanを管理対象サーバー上に登録しているがWLSTは1つのアプリケーションのみと通信できる状況を処理します。

getterメソッド

getterメソッドは、ゼロまたは1つの引数を処理するように設計されています。

WLST WebCenter Contentコマンドに引数を指定しない場合、次の2つのうちの1つが発生します。

- サーバー上に1つのアプリケーションのみによってそのMbeanが登録されている場合、WLST WebCenter Contentコマンドは正常に機能し、その出力が表示されます。

- サーバー上に複数のアプリケーションによってMbeanが登録されている場合、エラー・メッセージが表示され、引数に具体的なアプリケーション名を入力するように求めらます。

WLST WebCenter Contentコマンドに対する引数が1つである場合、次のようになります。

- 引数を入力するときに、適切なアプリケーション名を入力する必要があります。名前が適切に入力されていない場合、エラー・メッセージが表示され、引数に有効なアプリケーション名を入力するように求めらます。

setterメソッド

setterメソッドは、1つまたは2つの引数を処理するように設計されています。

- 最初の引数は、パラメータに設定するvalueです。

- 2番目の引数はapplication nameであり、NULLまたは文字列です。

サーバー構成コマンド

表19-2のコマンドを使用して、Oracle WebCenter Content Serverインスタンスを構成します。

表19-2 WLSTサーバー構成コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

getUCMHttpServerAddress

HTTPサーバー・アドレス値を表示します。

オンライン

setUCMHttpServerAddress

HTTPサーバー・アドレス値を設定します。

オンライン

getUCMServerPort

Intradoc Server Port構成パラメータを表示します。

オンライン

setUCMServerPort

Intradoc Server Port構成パラメータを設定します。

オンライン

getUCMIPAddressFilter

IPアドレス・フィルタ値を表示します。

オンライン

setUCMIPAddressFilter

IPアドレス・フィルタ値を設定します。

オンライン

getUCMUseSSL

SSLの使用に関する値を表示します。

オンライン

setUCMUseSSL

SSLの使用に関する値を設定します。

オンライン

getUCMHttpServerAddress

WLSTでの使用: オンライン

説明

config.cfgファイルからHTTPサーバー・アドレス値を取得し、それを表示します。

構文

getUCMHttpServerAddress()

または

getUCMHttpServerAddress(application_name)

例

次のコマンドは、アプリケーション"Content Server"のWebCenter Content HTTPサーバー・アドレスを表示します。

getUCCHttpServerAddress('Content Server')
server.mycompany.com

setUCMHttpServerAddress

WLSTでの使用: オンライン

説明

config.cfgファイル内のHTTPサーバー・アドレス値を設定します。HTTPサーバー・アドレスは、abc.xyz.defの形式またはポート番号を含むIPアドレスです。

HTTPサーバー・アドレスは、Content Serverユーザー・インタフェースにおいて完全なURLを生成するために使用されます。

構文

setUCMHttpServerAddress()

または

setUCMHttpServerAddress(value,application_name)

例

次のコマンドは、アプリケーション"Content Server"のOracle WebCenter Content HTTPサーバー・アドレスを設定します。

setUCMHttpServerAddress(server.mycompany.com,'Content Server')

getUCMServerPort

WLSTでの使用: オンライン

説明

config.cfgファイルからIntradoc Server Port構成パラメータを取得し、それを表示します。

構文

getUCMServerPort()

または

getUCMServerPort(application_name)

例

次のコマンドは、アプリケーション"Content Server"のIntradoc Server Port値を表示します。

getUCMServerPort('Content Server')
4442

setUCMServerPort

WLSTでの使用: オンライン

説明

サーバー・ポート構成パラメータを設定します。サーバー・ポートは、0から65535までの正の整数にする必要があります。

構文

setUCMServerPort(value)

または

setUCMServerPort(value,application_name)

例

次のコマンドは、アプリケーション"Content Server"のサーバー・ポート構成パラメータを設定します。

setUCMServerPort(4442,'Content Server')

getUCMIPAddressFilter

WLSTでの使用: オンライン

説明

config.cfgファイルからIPアドレス・フィルタ値を取得し、それを表示します。

構文

getUCMIPAddressFilter()

または

getUCMIPAddressFilter(application_name)

例

次のコマンドは、アプリケーション"Content Server"のIPアドレス・フィルタ値を表示します。

getUCMIPAddressFilter('Content Server')
10.131.123.*

setUCMIPAddressFilter

WLSTでの使用: オンライン

説明

WebCenter Content IPアドレス・フィルタ値を設定します。それは、"*.*.*.*"形式またはIPV6形式の必要があります。値は、Intradoc Server Portを介してContent Serverインスタンスと通信するために許可されているIPアドレスのリストから取得する必要があります。

構文

setUCMIPAddressFilter(value)

または

setUCMIPAddressFilter(value,application_name)

例

次のコマンドは、アプリケーション"Content Server"のWebCenter Content IPアドレス・フィルタの値を設定します。

setUCMIPAddressFilter(10.131.123.*,'Content Server')

getUCMUseSSL

WLSTでの使用: オンライン

説明

config.cfgファイルからSSLの使用に関する値を取得し、それを表示します。値は、TrueまたはFalseです。

構文

getUCMUseSSL()

または

getUCMUseSSL(application_name)

例

次のコマンドは、アプリケーション"Content Server"のSSLの使用に関する値を表示します。

getUCMUseSSL('Content Server')
True

setUCMUseSSL

WLSTでの使用: オンライン

説明

config.cfgファイル内のSSLの使用に関する値を設定します。値は、TrueまたはFalseです。

構文

setUCMUseSSL(value)

または

setUCMUseSSL(value,application_name)

例

次のコマンドは、アプリケーション"Content Server"のSSLの使用に関する値を設定します。

setUCMUseSSL(True,'Content Server')

電子メール構成コマンド

表19-3のコマンドを使用して、Oracle WebCenter Content Serverインスタンスの電子メールを構成します。

表19-3 WLSTの電子メール構成コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

getUCMMailServer

メール・サーバー値を表示します。

オンライン

setUCMMailServer

メール・サーバー値を設定します。

オンライン

getUCMSmtpPort

SMTPポート値を表示します。

オンライン

setUCMSmtpPort

SMTPポート値を設定します。

オンライン

getUCMSysAdminAddress

管理アドレス値を表示します。

オンライン

setUCMSysAdminAddress

管理アドレス値を設定します。

オンライン

getUCMMailServer

WLSTでの使用: オンライン

説明

config.cfgファイルからメール・サーバー値を取得し、それを表示します。

構文

getUCMMailServer()

または

getUCMMailServer(application_name)

例

次のコマンドは、アプリケーション"Content Server"のメール・サーバー値を表示します。

getUCMMailServer('Content Server')
mymailserver.mycompany.com

setUCMMailServer

WLSTでの使用: オンライン

説明

config.cfgファイル内のメール・サーバー値を設定します。メール・サーバー値は、SMTPベースの電子メールを送信するためにContent Serverインスタンスによって使用されるメール・サーバーの名前です。

構文

setUCMMailServer(value)

または

setUCMMailServer(value,application_name)

例

次のコマンドは、アプリケーション"Content Server"のメール・サーバーの値を設定します。

setUCMMailServer(mymailserver.mycompany.com,'Content Server')

getUCMSmtpPort

WLSTでの使用: オンライン

説明

config.cfgファイル内のSMTPポート値を取得し、それを表示します。

構文

getUCMSmtpPort()

または

getUCMSmtpPort(application_name)

例

次のコマンドは、アプリケーション"Content Server"のSMTPポート値を表示します。

getUCMSmtpPort('Content Server')
4055

setUCMSmtpPort

WLSTでの使用: オンライン

説明

config.cfgファイル内のSMTPポート値を設定します。SMTPポートは、1から65535までの正の整数にする必要があります。ポートをNULLにリセットするには、値にNoneと入力します(setUCMSmtpPort(None))。

構文

setUCMSmtpPort(value)

または

setUCMSmtpPort(value,application_name)

例

次のコマンドは、アプリケーション"Content Server"のSMTPポート値を設定します。

setUCMSmtpPort(4055,'Content Server')

getUCMSysAdminAddress

WLSTでの使用: オンライン

説明

config.cfgファイルから管理アドレス値を取得し、それを表示します。値は、abc@xyz.defの形式です。

構文

getUCMSysAdminAddress()

または

getUCMSysAdminAddress(application_name)

例

次のコマンドは、アプリケーション"Content Server"の管理アドレス値を表示します。

getUCMSysAdminAddress('Content Server')
mymail@mycompany.com

setUCMSysAdminAddress

WLSTでの使用: オンライン

説明

config.cfgファイル内の管理アドレス値を設定します。管理アドレスは、abc@xyz.defの形式です。

構文

setUCMSysAdminAddress(value)

または

setUCMSysAdminAddress(value,application_name)

例

次のコマンドは、アプリケーション"Content Server"の管理アドレス値を設定します。

setUCMSysAdminAddress(mymail@mycompany.com,'Content Server')

追加のコマンド

表19-4のコマンドを使用して、Oracle WebCenter Content Serverインスタンスを監視するための追加の設定を構成します。

表19-4 WLSTの追加の構成コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

getUCMCSVersion

バージョン番号を表示します。

オンライン

getUCMServerUptime

稼働時間値を表示します。

オンライン

getUCMCSVersion

WLSTでの使用: オンライン

説明

Content Serverの実行中のインスタンスのバージョン番号を取得します。

構文

getUCMCSVersion()

または

getUCMCSVersion(application_name)

例

次のコマンドは、アプリケーション"Content Server"のアクティブなインスタンスのバージョン番号を表示します。

getUCMCSVersion('Content Server')
11g R1

getUCMServerUptime

WLSTでの使用: オンライン

説明

Content Serverインスタンスの稼働していた時間の長さを取得します。

構文

getUCMServerUptime()

または

getUCMServerUptime(application_name)

例

次のコマンドは、アプリケーション"Content Server"の稼働していた時間の長さを表示します。

getUCMServerUptime('Content Server')
00H:01 Min:12 Sec:255 MilliSeconds

20 エンタープライズ・スケジューラ・カスタムWLSTコマンド

表20-1に示すカテゴリのOracle Enterprise Schedulerのコマンドを使用して、エンタープライズ・スケジューラの構成、サーバー、ログ、およびジョブ・リクエストを管理します。

注意:

これらのエンタープライズ・スケジューラ・カスタムWLSTコマンドを使用するには、Oracle共通ホームからWLSTスクリプトを起動する必要があります。Oracle Fusion Middleware管理者ガイドのカスタムWLSTコマンドの使用に関する項を参照してください。

これらのWLSTコマンドを実行する場合、クラスパスに次のJARを設定する必要があります。

- MW_HOME/oracle_common/modules/oracle.jmx_11.1.1/jmxframework.jar

- WL_HOME/server/lib/weblogic.jar

- MW_HOME/ORACLE_HOME/ess/lib/ess-admin.jar

エンタープライズ・スケジューラ・カスタム・コマンド

表20-1に示すエンタープライズ・スケジューラのコマンドを使用して、エンタープライズ・スケジューラのサーバー、構成、ジョブ・リクエストおよびログを管理します。「WLSTでの使用」列の「オンライン」は、そのコマンドが、実行中の管理サーバーに接続している場合にのみ使用できることを意味します。「オフライン」は、そのコマンドが、実行中のサーバーに接続されてない場合のみに使用できることを意味します。

表20-1 Oracle Enterprise Schedulerの管理コマンド

このコマンドを使用します...

次を行うには...

WLSTの使用...

essGetRequestContent

リクエストの実行が完了した後、そのログおよび出力データ・ファイルを取得します。

オンライン

essManageRequest

リクエスト状態を手動で取り消し、リカバリ、または完了します。

オンライン

essManageRuntimeConfig

様々な構成パラメータを追加、変更、削除および表示します。

オンライン

essManageServer

サーバー上で実行されているエンタープライズ・スケジューラ・アプリケーションを起動、停止、およびそのステータスを取得します。

オンライン

essQueryRequests

ホストするアプリケーションの名前、状態または実行経過時間に基づいて、リクエストを検索および一覧表示します。

オンライン

essGetRequestContent

コマンド・カテゴリ: ESS

WLSTでの使用: オンライン

説明

リクエストの実行が完了した後、そのログおよび出力データ・ファイルを取得します。

構文

essGetOutputContent(requestId, contentType, logLines, outDir)

引数

定義

requestId

リクエストID。

contentType

処理する内容のタイプ。LOG、OUTPUT、BINARY_OUTPUTまたはTEXT_OUTPUTです。デフォルトでは、OUTPUT contentTypeによって、BINARY_OUTPUTとTEXT_OUTPUTの両方の内容が確認されます。

logLines

オプション。リクエスト・ログから読み取る行数。デフォルトは1000です。

outDir

オプション。出力ファイルのダンプ先となる出力ディレクトリの絶対パス。デフォルトはカレント・ディレクトリです。

例

リクエストID 123のリクエスト・ログを取得するには

essGetOutputContent(123, "LOG")

リクエスト123のすべての出力を取得するには

essGetOutputContent(123, "OUTPUT")

リクエスト123のすべての出力を取得し、それを/tmpディレクトリに保存するには

essGetOutputContent(123, "OUTPUT", outDir="/tmp")

リクエスト123のすべてのテキスト出力を取得し、それを/tmpディレクトリに保存するには

essGetOutputContent(123, "TEXT_OUTPUT", outDir="/tmp")

リクエスト123のすべてのバイナリ出力を取得し、それを/tmpディレクトリに保存するには

essGetOutputContent(123, "BINARY_OUTPUT", outDir="/tmp")

リクエストID 123のリクエスト・ログの最初の100行を取得するには

essGetOutputContent(123, "LOG", logLines=100)

essManageRequest

コマンド・カテゴリ: ESS

WLSTでの使用: オンライン

説明

リクエスト状態を手動で取り消し、リカバリ、または完了します。

構文

essManageRequest(requestId, operation, asyncStatus, statusMessage)

引数

定義

requestId

リクエストID。

operation

実行する操作: CANCEL、RECOVERまたはCOMPLETE。

asyncStatus

COMPLETE操作が指定されている場合は、必須です。指定したリクエストに設定するステータス。次のうちの1つにする必要があります。

- BIZ_ERROR

- CANCEL

- ERROR

- ERROR_MANUAL_RECOVERY

- PAUSE

- SUCCESS

- UPDATE

- WARNING

statusMessage

オプション。操作を説明する限定的なステータス・メッセージ。

例

リクエスト123を取り消すには

essManageRequest(123, "CANCEL")

リクエスト123をリカバリするには

essManageRequest(123, "RECOVER")

リクエスト123を完了するには

essManageRequest(123, "COMPLETE", asyncStatus="ERROR", statusMessage="Completed by Admin")

essManageRuntimeConfig

コマンド・カテゴリ: ESS

WLSTでの使用: オンライン

説明

様々な構成パラメータを追加、変更、削除および表示します。

構文

essManageRuntimeConfig(app, type, operation, name, val)

引数

定義

app

ランタイム構成を管理するホストするアプリケーション名。

type

構成プロパティのタイプ。APPまたはESSのいずれかです。

operation

オプション。実行する操作。値は次のうちの1つです。add (追加)、mod (変更)、del (削除)、get (取得)またはgetall (すべて取得)。デフォルトは、getallです。

name

操作に対してgetall値が使用されている場合はオプションです。構成パラメータの名前。

val

操作に対してdel、getまたはgetall値が使用されている場合はオプションです。パラメータに対して設定する値。

例

値"bar"を持つENVパラメータを追加するには

essManageRuntimeConfig("myapp", "APP", operation="add", name="foo", val="bar")

ENVパラメータ"foo"の値を取得するには

essManageRuntimeConfig("myapp", "APP", operation="get", name="foo")

すべてのENVパラメータのリストを取得するには

essManageRuntimeConfig("myapp", "APP", operation="getall")
essManageRuntimeConfig("myapp", "APP")

ENVパラメータ"foo"の値を"barone"に変更するには

essManageRuntimeConfig("myapp", "APP", operation="mod", name="foo", val="barone")

ENVパラメータ"foo"を削除するには

essManageRuntimeConfig("myapp", "APP", operation="del", name="foo")

ESSタイプのすべてのパラメータをすべて表示するには

essManageRuntimeConfig("myapp", "ESS")

essManageServer

コマンド・カテゴリ: ESS

WLSTでの使用: オンライン

説明

サーバー上で実行されているエンタープライズ・スケジューラ・アプリケーションを起動、停止、およびそのステータスを取得します。エンタープライズ・スケジューラ・アプリケーションを起動することは、エンタープライズ・スケジューラ・プロセッサ・スレッドを起動し、リクエストの処理を開始できるようにすることを意味します。エンタープライズ・スケジューラを停止することは、エンタープライズ・スケジューラ・プロセッサを停止または静止し、新しいリクエストが処理されないようにすることを意味します。

クラスタ内のWLS管理サーバーに接続している場合、このコマンドは、クラスタ内のすべてのノードに作用します。

構文

essManageServer(operation)

引数

定義

operation

実行する操作。START、STOPまたはSTATUSの1つです。

例

エンタープライズ・スケジューラを停止するには

essManageServer("STOP")

エンタープライズ・スケジューラ・プロセッサの現在の状態を取得するには

essManageServer("STATUS")

essQueryRequests

コマンド・カテゴリ: ESS

WLSTでの使用: オンライン

説明

ホストするアプリケーションの名前、状態または実行経過時間に基づいて、リクエストを検索および一覧表示します。このコマンドは、長時間実行されているリクエストを見つけるために使用できます。

構文

essQueryRequests(app, state, days, hours, minutes)

引数

定義

app

オプション。ホストするアプリケーションの名前。

state

オプション。リクエストの状態。次のうちの1つを指定できます(デフォルトはRUNNING):

- BLOCKED

- CANCELLED

- CANCELLING

- COMPLETED

- ERROR

- ERROR_AUTO_RETRY

- ERROR_MANUAL_RECOVERY

- EXPIRED

- FINISHED

- HOLD

- PAUSED

- PENDING_VALIDATION

- READY

- RUNNING

- SCHEDULE_ENDED

- SUCCEEDED

- VALIDATION_FAILED

- WAIT

- WARNING

days

オプション。時間を日単位で指定します。

hours

オプション。時間を時間単位で指定します。

minutes

オプション。時間を分単位で指定します。

例

RUNNING状態のリクエストをすべて取得するには

essQueryRequests()
essQueryRequests(state="RUNNING")

CANCELLEDのリクエストをすべて取得するには

essQueryRequests(state="CANCELLED")

2日間より長い時間実行されているリクエストをすべて取得するには

essQueryRequests(days=2)

10時間より長い時間実行されているリクエストをすべて取得するには

essQueryRequests(hours=10)

アプリケーション"myapp"に対して実行されているリクエストをすべて取得するには

essQueryRequests(appName="myapp")

オラクル社の法律上の注意点について

コピーライトについて

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

商標と登録商標について

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の登録商標です。

ライセンス制約の保証と結果的に生じる損害の免責

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

保証免責

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

制限付権利

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

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）、その他の対策を講じることは使用者の責任となります。このソフトウェアもしくはハードウェアを危険が伴うアプリケーションで使用したことに起因して損害が発生しても、オラクル社およびその関連会社は一切の責任を負いかねます。

第三者のコンテンツ、製品、サービスに対する免責事項

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

ドラフトのアルファ版およびベータ版ドキュメントについて

このドキュメントが試作版の場合:

このドキュメントは試作版であり、デモおよび暫定使用のみを目的としたものです。このソフトウェアを使用するハードウェアに限定するものではありません。オラクル社およびその関連会社は、このドキュメントに関して一切の責任を負わず、いかなる保証もいたしません。また、このドキュメントを使用したことによって損失、費用、あるいは損害が発生しても、一切の責任を負いかねます。