Jump to

• Request
• Response

Create A New Osgi Framework

post

/management/weblogic/{version}/edit/resourceGroupTemplates/{name}/osgiFrameworks

Add a new osgi framework to this collection.

Request

Supported Media Types

• application/json

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Header Parameters

• X-Requested-By: string
  The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Body ()

Must contain a populated osgi framework model.

Root Schema : Osgi Framework

Type: object

Show Source

• deployInstallationBundles(optional): string
  Default Value: populate

  Allowed Values: [ "populate", "ignore" ]

  Determines if some WebLogic helper bundles will be installed into the framework

  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.

  If this is set to "ignore" then the bundles found in the WebLogic installation directory will not be installed into the framework.

• deploymentOrder(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  Default Value: 1000

  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.

  For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

  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.

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

  Return whether the MBean was created dynamically or is persisted to config.xml

• factoryImplementationClass(optional): string
  Default Value: org.apache.felix.framework.FrameworkFactory

  The name of the frameworks implementation class for the org.osgi.framework.launch.FrameworkFactory class.

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

• initProperties(optional): object Properties
  Title: Properties

  Additional Properties Allowed: additionalProperties

  The properties to be used when initializing the framework. All standard properties and all properties specific to the framework can be set.

• name(optional): string
  Read Only: true

  The user-specified name of this MBean instance.

  This name is included as one of the key properties in the MBean's javax.management.ObjectName

  Name=user-specified-name

  Constraints

  • legal null
• notes(optional): string

  Optional information that you can include to describe this configuration.

  WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.

  Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

• orgOsgiFrameworkBootdelegation(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@17c18d31

  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.

• orgOsgiFrameworkSystemPackagesExtra(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@8e8d8a0

  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.

• osgiImplementationLocation(optional): string
  Default Value: oracle.doceng.json.BetterJsonNull@788ed40

  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.

  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.

• registerGlobalDataSources(optional): boolean
  Default Value: true

  Returns true if global data sources should be added to the OSGi service registry.

• registerGlobalWorkManagers(optional): boolean
  Default Value: true

  Returns true if global work managers should be added to the OSGi service registry.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• targets(optional): array Target References
  Title: Target References

  Contains the array of target references.

  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.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • 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":""
}

Nested Schema : Properties

Type: object

Title: Properties

Additional Properties Allowed

Show Source

• 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"
}

The properties to be used when initializing the framework. All standard properties and all properties specific to the framework can be set.

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

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

Nested Schema : Target References

Type: array

Title: Target References

Contains the array of target references.

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.

Show Source

• Array of: object Target Reference
  Title: Target Reference

  Contains the 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>"
}

Nested Schema : Target Reference

Type: object

Title: Target Reference

Contains the target reference.

Show Source

• identity(optional): array Identity
  Title: Identity

  DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

{
    "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."
}

Nested Schema : Identity

Type: array

Title: Identity

DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

Show Source

• Array of: 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."
}

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.

Back to Top

Response

201 Response

Back to Top