プライマリ・コンテンツに移動
Oracle® Fusion Middleware Oracle WebLogic Server Multitenant RESTfulドメイン・ランタイム・リファレンス
12c (12.2.1)
E72536-01
  目次へ移動
目次

前
 
 

2 エンティティ

次の各項では、RESTリソースが動作するデータ・モデルについて説明します。これらのデータ・モデルは、RESTリソースでやりとりされる情報を記述したものです。

java.lang.Throwable

このエンティティは、エラーおよび例外を表します。

java.lang.Throwableエンティティのプロパティは、次のとおりです。

cause

このプロパティには、エラーおよび例外のスタック・トレースが含まれます。

タイプ: java.lang.Throwable

message

このプロパティには、エラーまたは例外がスローされた理由が含まれます。

タイプ: string

java.util.Properties

このエンティティは、プロパティ・オブジェクトに各プロパティを表すプロパティを持つJSONオブジェクトを表します。ここで、キーはプロパティの名前で値はプロパティの値を含む文字列です。

weblogic.management.rest.bean.model.CurrentUser

リクエストを行っている認証済ユーザー。

weblogic.management.rest.bean.model.CurrentUserエンティティのプロパティは、次のとおりです。

partitionId

起動されているコンポーネントが存在するパーティションのID。

タイプ: string

partitionName

人間が読める形式のパーティションIDの名前。

タイプ: string

user

ユーザーが認証済の場合、このリクエストを行っているユーザーのログイン。ユーザーが認証されていない場合、null

タイプ: string

weblogic.management.rest.bean.model.Version

Versionエンティティでは、WebLogic Serverリソースのバージョンが表されます。

weblogic.management.rest.bean.model.Versionエンティティのプロパティは、次のとおりです。

isLatest

これがデフォルト・バージョンの場合True

タイプ: ブール

lifecycle

このバージョンのライフサイクル: activeまたはdeprecated

タイプ: string

version

このバージョンの名前。

タイプ: string

weblogic.management.runtime.AppDeploymentRuntimeMBean

このMBeanは、アプリケーションのデプロイメント操作を提供します。現在は開始および停止のみサポートされます。今後このMBeanの機能が拡張され、ドメインへのアプリケーションのデプロイメントおよび本番再デプロイメント、エンタープライズ・アプリケーション内のモジュールの部分的なデプロイメントなどの拡張WLSデプロイメント機能をサポートする操作に対応する可能性があります。

weblogic.management.runtime.AppDeploymentRuntimeMBeanエンティティのプロパティは、次のとおりです。

applicationName

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

タイプ: string

制約: 読取り専用、再起動が必要

applicationVersion

アプリケーションのバージョン識別子。

タイプ: string

制約: 読取り専用、再起動が必要

modules

アプリケーションのモジュールのリスト。これらのモジュールは、モジュール・レベルのターゲット指定で使用できます。

タイプ: stringの配列

制約: 読取り専用、再起動が必要

name

この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

タイプ: string

制約: 読取り専用、再起動が必要

partitionName

アプリケーションを含むパーティションの名前。

タイプ: string

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要

weblogic.management.runtime.AppRuntimeStateRuntimeMBean

デプロイしたアプリケーションのランタイム状態へのアクセスを提供します。

weblogic.management.runtime.AppRuntimeStateRuntimeMBeanエンティティのプロパティは、次のとおりです。

applicationIds

タイプ: stringの配列

制約: 読取り専用、再起動が必要

name

この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

タイプ: string

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要

weblogic.management.runtime.DeploymentManagerMBean

このMBeanは、デプロイメント操作を提供します。

DeploymentManagerオブジェクトは、WebLogic Serverデプロイメント・フレームワークのステートレス・インタフェースです。現在はユーザーによるデプロイメントの開始および停止を可能にするAppDeploymentRuntimeMBeansへのアクセスを提供します。今後このMBeanの機能が拡張され、ドメインへのアプリケーションのデプロイメントおよび本番再デプロイメント、エンタープライズ・アプリケーション内のモジュールの部分的なデプロイメントなどの拡張WebLogic Serverデプロイメント機能をサポートする操作に対応する可能性があります。

このMBeanは、アプリケーションが作成または削除された場合やアプリケーションの状態が変更された場合に、通知を発します。通知タイプは、次のとおりです。

  • appdeployment.created

  • appdeployment.deleted

  • appdeployment.state.new

  • appdeployment.state.prepared

  • appdeployment.state.admin

  • appdeployment.state.active

  • appdeployment.state.retired

  • appdeployment.state.failed

  • appdeployment.state.update.pending

  • appdeployment.state.unknown

ユーザーデータは、アプリケーションのオブジェクト名です。

weblogic.management.runtime.DeploymentManagerMBeanエンティティのプロパティは、次のとおりです。

maximumDeploymentProgressObjectsCount

進行状況オブジェクトの最大許容数。

タイプ: int

制約: 再起動が必要

name

この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

タイプ: string

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要

weblogic.management.runtime.DeploymentProgressObjectMBean

このMBeanは、デプロイメント操作のモニタリング用のユーザーAPIで、管理サーバーにのみ存在します。現在、AppDeploymentRuntimeMBeanによって始動される開始および停止操作のみサポートされます。

weblogic.management.runtime.DeploymentProgressObjectMBeanエンティティのプロパティは、次のとおりです。

applicationName

現在のデプロイメント操作のアプリケーションの名前。

タイプ: string

制約: 読取り専用、再起動が必要

completed

このプロパティは、非同期ジョブが完了したかどうかを示します。

タイプ: ブール

deploymentMessages

現在のデプロイメント操作について生成されたステータス・メッセージの順序付き配列を提供します。

タイプ: stringの配列

制約: 読取り専用、再起動が必要

endTime

このプロパティは、非同期ジョブが終了した時間を示します。

タイプ: java.util.Date

failedTargets

現在のデプロイメント操作が失敗したターゲット。

タイプ: stringの配列

制約: 読取り専用、再起動が必要

id

現在のデプロイメント操作の一意のID。

タイプ: string

制約: 読取り専用、再起動が必要

name

この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

タイプ: string

制約: 読取り専用、再起動が必要

operationType

現在のデプロイメント操作のデプロイメント操作タイプ。取り得る値は、1(開始)および2(停止)です。

タイプ: int

制約: 読取り専用、再起動が必要

progress

このプロパティは、非同期ジョブが成功したか、失敗したか、進行中かを示します。

タイプ: string

rootExceptions

現在のデプロイメント操作が失敗した場合、このメソッドは失敗の根本原因を表す0個以上の例外を返すことがあります。配列にはWLS例外クラスは含まれません。かわりに、元のWLS Exceptionsのスタック・トレースおよびメッセージを含む新規Exceptionsになります。

タイプ: java.lang.Throwableの配列

制約: 読取り専用、再起動が必要

startTime

このプロパティは、非同期ジョブが開始された時間を示します。

タイプ: java.util.Date

startTimeAsLong

現在のデプロイメント操作が開始された時間。値はミリ秒単位で、システム時間と合っています。

タイプ: ロング

制約: 読取り専用、再起動が必要

state

現在のデプロイメント操作の状態。取り得る値は、STATE_INITIALIZED、STATE_RUNNING、STATE_COMPLETED、STATE_FAILEDおよびSTATE_DEFERREDです。

タイプ: string

制約: 読取り専用、再起動が必要

targets

現在のデプロイメント操作に対して指定されたターゲット。

タイプ: stringの配列

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要

weblogic.management.runtime.DomainPartitionRuntimeMBean

このクラスは、ドメイン・レベルのパーティション処理に使用されます。

weblogic.management.runtime.DomainPartitionRuntimeMBeanエンティティのプロパティは、次のとおりです。

name

この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

タイプ: string

制約: 読取り専用、再起動が必要

partitionID

該当するパーティションのパーティションID値を返します。

タイプ: string

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要

weblogic.management.runtime.DomainRuntimeMBean

このクラスは、WebLogicドメインのモニタリングに使用されます。ドメインには、0個以上のクラスタを含むことができます。クラスタは論理名で参照できます。

weblogic.management.runtime.DomainRuntimeMBeanエンティティのプロパティは、次のとおりです。

currentDomainPartitionRuntime

現在のパーティションのドメイン・パーティション・ランタイムMBeanを返します

タイプ: weblogic.management.runtime.DomainPartitionRuntimeMBean参照

制約: 読取り専用、再起動が必要

name

このMBeanインスタンスのユーザー定義の名前。

この名前は、MBeanのjavax.management.ObjectNameに、主要なプロパティとして含まれています

Name=user-specified-name

タイプ: string

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要

weblogic.management.runtime.EditSessionConfigurationManagerMBean

weblogic.management.runtime.EditSessionConfigurationManagerMBeanエンティティのプロパティは、次のとおりです。

name

この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

タイプ: string

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要

weblogic.management.runtime.EditSessionConfigurationRuntimeMBean

weblogic.management.runtime.EditSessionConfigurationRuntimeMBeanエンティティのプロパティは、次のとおりです。

creator

編集セッションの元の作成者。

タイプ: string

制約: 読取り専用、再起動が必要

currentEditor

編集セッションの現在のエディタ。エディタはロックを所有しています。

タイプ: string

制約: 読取り専用、再起動が必要

description

編集セッション構成の説明。

タイプ: string

制約: 読取り専用、再起動が必要

editSessionName

編集セッション構成の名前。

タイプ: string

制約: 読取り専用、再起動が必要

editSessionServerJndi

関連するEditSessionServerのJNDI名

タイプ: string

制約: 読取り専用、再起動が必要

mergeNeeded

この編集セッションの最後のアクティブ化の後、またはその作成後でもこの編集セッションをアクティブ化する前に、別の編集セッションが独自の変更をアクティブ化した場合、trueが返されます。

これは、この編集セッション構成が実際のランタイム構成ではない可能性があることを示します。解決メソッドを使用して、この構成に変更をマージします。

この編集セッション構成にも変更がある場合は、このセッションとランタイム構成の間で矛盾が生じている可能性があります。解決メソッドを使用して、不整合の原因を削除します。

タイプ: ブール

制約: 読取り専用、再起動が必要

name

この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

タイプ: string

制約: 読取り専用、再起動が必要

partitionName

この編集セッションが属するパーティション名。

タイプ: string

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要

weblogic.management.runtime.LibDeploymentRuntimeMBean

このMBeanは、ライブラリのデプロイメント操作を提供します。

weblogic.management.runtime.LibDeploymentRuntimeMBeanエンティティのプロパティは、次のとおりです。

implementationVersion

ライブラリの実装バージョン。設定されていない場合はnull

タイプ: string

制約: 読取り専用、再起動が必要

libraryIdentifier

ライブラリの識別子。

タイプ: string

制約: 読取り専用、再起動が必要

libraryName

ライブラリの名前。

タイプ: string

制約: 読取り専用、再起動が必要

name

この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

タイプ: string

制約: 読取り専用、再起動が必要

partitionName

ライブラリを含むパーティションの名前。

タイプ: string

制約: 読取り専用、再起動が必要

specificationVersion

ライブラリの仕様バージョン。設定されていない場合はnull

タイプ: string

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要

weblogic.management.runtime.PartitionLifeCycleRuntimeMBean

weblogic.management.runtime.PartitionLifeCycleRuntimeMBeanエンティティのプロパティは、次のとおりです。

name

この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

タイプ: string

制約: 読取り専用、再起動が必要

state

パーティションの現在の状態。

タイプ: string

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要

weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBean

パーティション・ライフ・サイクルに関連する長時間実行タスクに関する情報を示します。

weblogic.management.runtime.PartitionLifeCycleTaskRuntimeMBeanエンティティのプロパティは、次のとおりです。

completed

このプロパティは、非同期ジョブが完了したかどうかを示します。

タイプ: ブール

description

このタスクの説明。

タイプ: string

制約: 読取り専用、再起動が必要

endTime

このプロパティは、非同期ジョブが終了した時間を示します。

タイプ: java.util.Date

name

この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

タイプ: string

制約: 読取り専用、再起動が必要

operation

現在の操作の名前を返します。

タイプ: string

制約: 読取り専用、再起動が必要

parentTask

このタスクを一部とするタスク。

null値は、このタスクがサブタスクでないことを示します。

タイプ: weblogic.management.runtime.TaskRuntimeMBean参照

制約: 読取り専用、再起動が必要

partitionName

操作対象のパーティションの名前を返します。

タイプ: string

制約: 読取り専用、再起動が必要

progress

このタスクの進行状況。

タイプ: string

制約: 読取り専用、再起動が必要

running

タスクがまだ実行中かどうかを示します。

タイプ: ブール

制約: 読取り専用、再起動が必要

startTime

このプロパティは、非同期ジョブが開始された時間を示します。

タイプ: java.util.Date

startTimeAsLong

このタスクが開始された時刻。

タイプ: ロング

制約: 読取り専用、再起動が必要

systemTask

このタスクがサーバーによって開始されたか、ユーザーによって開始されたかを示します。

タイプ: ブール

制約: 読取り専用、再起動が必要

taskError

このタスクの実行中にエラーが発生した場合、エラーを表す例外を返します。

タイプ: java.lang.Throwable

制約: 読取り専用、再起動が必要

taskStatus

このタスクのステータス。

タイプ: string

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要

weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBean

weblogic.management.runtime.ResourceGroupLifeCycleRuntimeMBeanエンティティのプロパティは、次のとおりです。

name

この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

タイプ: string

制約: 読取り専用、再起動が必要

state

現在のリソース・グループの状態。

タイプ: string

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要

weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBean

weblogic.management.runtime.ResourceGroupLifeCycleTaskRuntimeMBeanエンティティのプロパティは、次のとおりです。

completed

このプロパティは、非同期ジョブが完了したかどうかを示します。

タイプ: ブール

description

このタスクの説明。

タイプ: string

制約: 読取り専用、再起動が必要

endTime

このプロパティは、非同期ジョブが終了した時間を示します。

タイプ: java.util.Date

name

この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

タイプ: string

制約: 読取り専用、再起動が必要

operation

現在の操作の名前を返します。

タイプ: string

制約: 読取り専用、再起動が必要

parentTask

このタスクを一部とするタスク。

null値は、このタスクがサブタスクでないことを示します。

タイプ: weblogic.management.runtime.TaskRuntimeMBean参照

制約: 読取り専用、再起動が必要

progress

このタスクの進行状況。

タイプ: string

制約: 読取り専用、再起動が必要

resourceGroupName

操作対象のリソース・グループの名前を返します。

タイプ: string

制約: 読取り専用、再起動が必要

running

タスクがまだ実行中かどうかを示します。

タイプ: ブール

制約: 読取り専用、再起動が必要

startTime

このプロパティは、非同期ジョブが開始された時間を示します。

タイプ: java.util.Date

startTimeAsLong

このタスクが開始された時刻。

タイプ: ロング

制約: 読取り専用、再起動が必要

systemTask

このタスクがサーバーによって開始されたか、ユーザーによって開始されたかを示します。

タイプ: ブール

制約: 読取り専用、再起動が必要

taskError

このタスクの実行中にエラーが発生した場合、エラーを表す例外を返します。

タイプ: java.lang.Throwable

制約: 読取り専用、再起動が必要

taskStatus

このタスクのステータス。

タイプ: string

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要

weblogic.management.runtime.ServerRuntimeMBean

サーバー・インスタンスのランタイム情報の取得およびある状態から別の状態へのサーバーの遷移のためのメソッドを提供します。

weblogic.management.runtime.ServerRuntimeMBeanエンティティのプロパティは、次のとおりです。

adminServerHost

管理サーバーが接続をリスニングするアドレス。たとえば、文字列santiagoを返します

タイプ: string

制約: 読取り専用、再起動が必要

adminServerListenPort

管理サーバーが接続をリスニングするポート。

タイプ: int

制約: 読取り専用、再起動が必要

adminServerListenPortSecure

サーバーで管理トラフィックに使用するポートが、セキュアなプロトコルを使用するように構成されているかどうかを示します。

タイプ: ブール

制約: 読取り専用、再起動が必要

defaultURL

クライアントがこのサーバーのデフォルト・ネットワーク・チャネルへの接続に使用するURL。

返される値は、デフォルト・プロトコル、リスニング・アドレスおよびリスニング・ポートを示します。

protocol://listen-addresslisten-port

注意: デフォルト・プロトコル、リスニング・アドレスおよびリスニング・ポートはドメインのconfig.xmlファイルに保持されますが、サーバー・インスタンスの起動時、コマンド行オプションでこれらの保持されている値をオーバーライドできます。このgetDefaultURLメソッドは現在使用されているURL値を返します。この値は必ずしもconfig.xmlに指定されている値とはかぎりません

返されるURLは、動的チャネル更新と合致します。

タイプ: string

制約: 読取り専用、再起動が必要

name

この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

タイプ: string

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要

weblogicVersion

このWebLogic Serverインスタンス(サーバー)のバージョン。

タイプ: string

制約: 読取り専用、再起動が必要

weblogic.management.runtime.TaskRuntimeMBean

進行中で長時間実行の可能性のある管理プロセスのモニタリング情報を示します。これは少なくともI/Oを伴うOA&M操作と考えられます。たとえば、サーバーの起動と停止、アプリケーションのデプロイとアンデプロイまたはサービスの移行などです。

この種のMBean操作では、別のスレッドを生成して実際の作業を行い、TaskRuntimeMBeanのインスタンスを呼出し元に即座に返します。呼出し元は、必要に応じてこれを使用してタスクの進行状況を追跡できます。ユーザーは、TaskRuntimeMBeanのすべてのインスタンスについて問合せを行い、現在実行中のタスクと最近完了したタスクの両方のサマリーを取得することもできます。

TaskRuntimeMBeanのインスタンスは、記述された作業の完了後MBeanServerに存在し続けます。最終的にはユーザーによって明示的に登録解除されるか、完了後一定時間が経過したTaskRuntimeMBeanのインスタンスを定期的にパージするスカベンジャ・プロセスによって削除されます。

weblogic.management.runtime.TaskRuntimeMBeanエンティティのプロパティは、次のとおりです。

completed

このプロパティは、非同期ジョブが完了したかどうかを示します。

タイプ: ブール

description

このタスクの説明。

タイプ: string

制約: 読取り専用、再起動が必要

endTime

このプロパティは、非同期ジョブが終了した時間を示します。

タイプ: java.util.Date

name

この構成の名前。WebLogic ServerはMBeanを使用して構成を実装および永続化します。

タイプ: string

制約: 読取り専用、再起動が必要

parentTask

このタスクを一部とするタスク。

null値は、このタスクがサブタスクでないことを示します。

タイプ: weblogic.management.runtime.TaskRuntimeMBean参照

制約: 読取り専用、再起動が必要

progress

このタスクの進行状況。

タイプ: string

制約: 読取り専用、再起動が必要

running

タスクがまだ実行中かどうかを示します。

タイプ: ブール

制約: 読取り専用、再起動が必要

startTime

このプロパティは、非同期ジョブが開始された時間を示します。

タイプ: java.util.Date

startTimeAsLong

このタスクが開始された時刻。

タイプ: ロング

制約: 読取り専用、再起動が必要

systemTask

このタスクがサーバーによって開始されたか、ユーザーによって開始されたかを示します。

タイプ: ブール

制約: 読取り専用、再起動が必要

taskError

このタスクの実行中にエラーが発生した場合、エラーを表す例外を返します。

タイプ: java.lang.Throwable

制約: 読取り専用、再起動が必要

taskStatus

このタスクのステータス。

タイプ: string

制約: 読取り専用、再起動が必要

type

MBeanのタイプを戻します。

タイプ: string

制約: 読取り専用、再起動が必要