ジャンプ先

• リクエスト
• レスポンス

このOSGiフレームワークの表示

get

/management/weblogic/{version}/domainConfig/osgiFrameworks/{name}

このOSGiフレームワークを表示します。

リクエスト

パス・パラメータ

• name: string
  コレクション内のインスタンスの名前プロパティ。
• version: string
  WebLogic RESTインタフェースのバージョン。

問合せパラメータ

• excludeFields(optional): string
  'excludeFields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これはフィールド名のカンマ区切りリストです。存在する場合は、名前がリストにないフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('fields'問合せパラメータが指定されていない場合)。ノート: 'excludeFields'が指定されている場合、'fields'は指定できません。
• excludeLinks(optional): string
  'excludeLinks'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これはリンク関係名のカンマ区切りリストです。存在する場合は、関係名がリストにないフィールドのみが返されます。存在しない場合は、すべてのリンクが返されます('links'問合せパラメータが指定されていない場合)。ノート: 'excludeLinks'が指定されている場合、'links'は指定できません。
• fields(optional): string
  'fields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これはフィールド名のカンマ区切りリストです。存在する場合は、名前が一致するフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('excludeFields'問合せパラメータが指定されていない場合)。ノート: 'fields'が指定されている場合、'excludeFields'は指定できません。
• links(optional): string
  'links'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これはリンク関係名のカンマ区切りリストです。存在する場合は、関係名が一致するリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('excludeLinks'問合せパラメータが指定されていない場合)。ノート: 'links'が指定されている場合、'excludeLinks'は指定できません。

セキュリティ

• Admin: basic
  型: basic

  説明: Adminセキュリティ・ロールのユーザー。
• Deployer: basic
  型: basic

  説明: デプロイヤ・セキュリティ・ロールのユーザー。
• Monitor: basic
  型: basic

  説明: モニター・セキュリティ・ロールのユーザー。
• Operator: basic
  型: basic

  説明: オペレータ・セキュリティ・ロールのユーザー。

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

このOSGiフレームワークを返します。

本文 ()

ルート・スキーマ: OSGiフレームワーク

型: object

ソースの表示

• deployInstallationBundles(optional): string
  デフォルト値: populate

  指定可能な値: [ "populate"、"ignore" ]

  WebLogicヘルパー・バンドルをフレームワークにインストールするかどうかを指定します。

  これが"populate"に設定されている場合、wlserver/server/osgi-libの下のWebLogicインストール・ディレクトリにあるバンドルが、このOSGiフレームワークにインストールされます。さらに、osgi-libディレクトリ内のバンドルがまだそこに存在しない場合にバンドルを有効にするために、いくつかの追加パッケージがbootdelegationクラスパス・パラメータに追加されます。

  これが"ignore"に設定されている場合、WebLogicインストール・ディレクトリにあるバンドルはフレームワークにインストールされません。

• deploymentOrder(optional): integer(int32)
  最小値: 0

  最大値: 2147483647

  デフォルト値: 1000

  デプロイの優先度。サーバーはこの値を使用して項目のデプロイ順を決定します。優先度は、同じタイプでデプロイ可能なアイテム間で決められます。

  たとえば、サーバーではすべてのEJBを優先度に従ってデプロイしてから、起動クラスを優先度に従ってデプロイします。

  「デプロイ順序」の値が小さい項目から順にデプロイされます。「デプロイ順序」の値が等しいデプロイメントの順序付けは保証されていません。クラスタ間の順序付けは保証されていません。

• dynamicallyCreated(optional): boolean
  読取り専用: true

  デフォルト値: false

  MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます

• factoryImplementationClass(optional): string
  デフォルト値: org.apache.felix.framework.FrameworkFactory

  org.osgi.framework.launch.FrameworkFactoryクラスのフレームワーク実装クラスの名前。

• id(optional): integer(int64)
  読取り専用: true

  このMBeanインスタンスの一意のIDを返します

• initProperties(optional): object プロパティ
  タイトル: Properties

  使用可能なその他のプロパティ: additionalProperties

  フレームワークを初期化するときに使用されるプロパティ。すべての標準プロパティとフレームワークに固有のプロパティを設定できます。

• name(optional): string
  読取り専用: true

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

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

  Name=user-specified-name

  制約

  • 有効なNULL
• notes(optional): string

  この構成の説明として任意に入力できる情報。

  WebLogic Serverは、ドメインの構成ファイル(config.xml)に、このノートをXML PCDATAとして保存します。すべての左山カッコ(<)はxmlエンティティに変換されます<) are converted to the xml entity <。改行/行送りは保持されます</)>。

  ノート: 管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。

• orgOsgiFrameworkBootdelegation(optional): string
  デフォルト値: oracle.doceng.json.BetterJsonNull@464b5685

  org.osgi.framework.bootdelegationプロパティの名前。この値は(設定されている場合)、初期プロパティに指定されている値よりも優先されることに注意してください。

• orgOsgiFrameworkSystemPackagesExtra(optional): string
  デフォルト値: oracle.doceng.json.BetterJsonNull@5e44916a

  org.osgi.framework.system.packages.extraプロパティの名前。この値は(設定されている場合)、初期プロパティに指定されている値よりも優先されることに注意してください。

• osgiImplementationLocation(optional): string
  デフォルト値: oracle.doceng.json.BetterJsonNull@4f0de62a

  org.osgi.framework.launch.FrameworkFactory実装を含むOSGi実装JARファイルの場所。このフィールドが設定されていない場合、製品に含まれる適切なデフォルト実装が使用されます。

  このフィールドが相対の場合、サーバーの開始ディレクトリを基準とし、このフレームワークがデプロイされる場所にファイルが存在する必要があります。このフィールドが相対でない場合、このフレームワークがデプロイされるのと同じ場所に指定したファイル名が存在する必要があります。

• registerGlobalDataSources(optional): boolean
  デフォルト値: true

  データ・ソースをOSGiサービス・レジストリに追加する必要がある場合、trueを返します。

• registerGlobalWorkManagers(optional): boolean
  デフォルト値: true

  グローバル・ワーク・マネージャをOSGiサービス・レジストリに追加する必要がある場合、trueを返します。

• tags(optional): array Items
  タイトル: Items

  この構成MBeanのすべてのタグを返します

• targets(optional): array ターゲット参照
  タイトル: Target References

  ターゲット参照の配列が含まれます。

  現在のドメインでこの項目をデプロイできるターゲットのリストから、MBeanをデプロイするターゲットを選択する必要があります。ターゲットはサーバーまたはクラスタです。デプロイメントが重複している場合、デプロイメントは1回のみ行われます。

• type(optional): string
  読取り専用: true

  MBeanのタイプを戻します。

  制約

  • unharvestable

{
    "type":"object",
    "properties":{
        "deployInstallationBundles":{
            "default":"populate",
            "enum":[
                "populate",
                "ignore"
            ],
            "type":"string",
            "description":"<p>Determines if some WebLogic helper bundles will be installed into the framework </p><p> If this is set to \"populate\" then the bundles found in the WebLogic installation directory under wlserver/server/osgi-lib will be installed into this OSGi framework.  Futhermore a few extra packages will be added to the bootdelegation classpath parameters in order to enable the bundles in the osgi-lib directory if they are not already there.</p><p> If this is set to \"ignore\" then the bundles found in the WebLogic installation directory will not be installed into the framework.</p>"
        },
        "deploymentOrder":{
            "default":1000,
            "minimum":0,
            "maximum":2147483647,
            "type":"integer",
            "format":"int32",
            "description":"<p>A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.</p><p>For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.</p><p>Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "factoryImplementationClass":{
            "default":"org.apache.felix.framework.FrameworkFactory",
            "type":"string",
            "description":"<p>The name of the frameworks implementation class for the org.osgi.framework.launch.FrameworkFactory class.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "initProperties":{
            "type":"object",
            "description":"<p>The properties to be used when initializing the framework. All standard properties and all properties specific to the framework can be set.</p>",
            "additionalProperties":{
                "type":"string"
            },
            "title":"Properties"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "orgOsgiFrameworkBootdelegation":{
            "default":null,
            "type":"string",
            "description":"<p>The name of the org.osgi.framework.bootdelegation property.  Note that this value, if set, will take precedence over anything specified in the init-properties.</p>"
        },
        "orgOsgiFrameworkSystemPackagesExtra":{
            "default":null,
            "type":"string",
            "description":"<p>The name of the org.osgi.framework.system.packages.extra property.  Note that this value, if set, will take precedence over anything specified in the init-properties.</p>"
        },
        "osgiImplementationLocation":{
            "default":null,
            "type":"string",
            "description":"<p>The location of the OSGi implementation JAR file which contains the org.osgi.framework.launch.FrameworkFactory implementation.  If this field is not set then an appropriate default implementation that is shipped with the product will be used.</p><p> If this field is relative it must be relative to the start directory of the server and the file must exist everywhere this framework is deployed.  If this field is not relative then the given filename must exist at the same location everywhere this framework is deployed.</p>"
        },
        "registerGlobalDataSources":{
            "default":true,
            "type":"boolean",
            "description":"<p>Returns true if global data sources should be added to the OSGi service registry.</p>"
        },
        "registerGlobalWorkManagers":{
            "default":true,
            "type":"boolean",
            "description":"<p>Returns true if global work managers should be added to the OSGi service registry.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "targets":{
            "title":"Target References",
            "type":"array",
            "items":{
                "title":"Target Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the target reference."
            },
            "description":"Contains the array of target references. <p>You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

ネストされたスキーマ: プロパティ

型: object

タイトル: Properties

使用可能なその他のプロパティ

ソースの表示

• string

{
    "type":"object",
    "description":"<p>The properties to be used when initializing the framework. All standard properties and all properties specific to the framework can be set.</p>",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Properties"
}

フレームワークを初期化するときに使用されるプロパティ。すべての標準プロパティとフレームワークに固有のプロパティを設定できます。

ネストされたスキーマ: 項目

型: array

タイトル: Items

この構成MBeanのすべてのタグを返します

ソースの表示

• 配列: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

ネストされたスキーマ: ターゲット参照

型: array

タイトル: Target References

ターゲット参照の配列が含まれます。

現在のドメインでこの項目をデプロイできるターゲットのリストから、MBeanをデプロイするターゲットを選択する必要があります。ターゲットはサーバーまたはクラスタです。デプロイメントが重複している場合、デプロイメントは1回のみ行われます。

ソースの表示

• 配列: object ターゲット参照
  タイトル: Target Reference

  ターゲット参照が含まれます。

{
    "title":"Target References",
    "type":"array",
    "items":{
        "title":"Target Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the target reference."
    },
    "description":"Contains the array of target references. <p>You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.</p>"
}

ネストされたスキーマ: ターゲット参照

型: object

タイトル: Target Reference

ターゲット参照が含まれます。

ソースの表示

• identity(optional): array アイデンティティ
  タイトル: Identity

  DOC TEAM TBD - アイデンティティの説明 - 別のWLS RESTリソースへの参照です。

{
    "title":"Target Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the target reference."
}

ネストされたスキーマ: アイデンティティ

型: array

タイトル: Identity

DOC TEAM TBD - アイデンティティの説明 - 別のWLS RESTリソースへの参照です。

ソースの表示

• 配列: string

{
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}

トップに戻る