Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


weblogic.management.configuration
Interface OsgiFrameworkMBean

All Superinterfaces:
ConfigurationMBean, DeploymentMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

public interface OsgiFrameworkMBean
extends DeploymentMBean

An MBean representing an OSGi framework.


Field Summary

 

Fields inherited from interface weblogic.management.configuration.DeploymentMBean
DEFAULT_ORDER, MAX_ORDER, MIN_ORDER

 

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY

 

Method Summary
abstract  String getDeployInstallationBundles()
          Determines if some WebLogic helper bundles will be installed into the framework
abstract  String getFactoryImplementationClass()
          The name of the frameworks implementation class for the org.osgi.framework.launch.FrameworkFactory class.
abstract  Properties getInitProperties()
          The properties to be used when initializing the framework.
abstract  String getName()
          The user-specified name of this MBean instance.
abstract  String getOrgOsgiFrameworkBootdelegation()
          The name of the org.osgi.framework.bootdelegation property.
abstract  String getOrgOsgiFrameworkSystemPackagesExtra()
          The name of the org.osgi.framework.system.packages.extra property.
abstract  String getOsgiImplementationLocation()
          The location of the OSGi implementation JAR file which contains the org.osgi.framework.launch.FrameworkFactory implementation.
abstract  boolean isRegisterGlobalDataSources()
          Returns true if global data sources should be added to the OSGi service registry.
abstract  boolean isRegisterGlobalWorkManagers()
          Returns true if global work managers should be added to the OSGi service registry.
abstract  void setDeployInstallationBundles(String deploymentOption)
          Determines if some WebLogic helper bundles will be installed into the framework
abstract  void setFactoryImplementationClass(String factoryClass)
          The name of the frameworks implementation class for the org.osgi.framework.launch.FrameworkFactory class.
abstract  void setInitProperties(Properties frameworkProperties)
          The properties to be used when initializing the framework.
abstract  void setOrgOsgiFrameworkBootdelegation(String bootDelegation)
          The name of the org.osgi.framework.bootdelegation property.
abstract  void setOrgOsgiFrameworkSystemPackagesExtra(String extra)
          The name of the org.osgi.framework.system.packages.extra property.
abstract  void setOsgiImplementationLocation(String location)
          The location of the OSGi implementation JAR file which contains the org.osgi.framework.launch.FrameworkFactory implementation.
abstract  void setRegisterGlobalDataSources(boolean doAdd)
          Set to true if global data sources should be added to the OSGi service registry.
abstract  void setRegisterGlobalWorkManagers(boolean doAdd)
          Set to true if global work managers should be added to the OSGi service registry.

 

Methods inherited from interface weblogic.management.configuration.DeploymentMBean
addTarget, getDeploymentOrder, getTargets, removeTarget, setDeploymentOrder, setTargets

 

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

 

Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

 

Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes

 

Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister

 

Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener

 

Methods inherited from interface weblogic.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

 

Method Detail

getName

String getName()

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

Specified by:
getName in interface ConfigurationMBean
Specified by:
getName in interface WebLogicMBean

getOsgiImplementationLocation

String getOsgiImplementationLocation()

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.

Returns:
The location of the JAR file containing the OSGi implementation

setOsgiImplementationLocation

void setOsgiImplementationLocation(String location)
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.

Parameters:
location - The location of the JAR file containing the OSGi implementation

getFactoryImplementationClass

String getFactoryImplementationClass()
The name of the frameworks implementation class for the org.osgi.framework.launch.FrameworkFactory class.
Returns:
The name of the implementation class for org.osgi.framework.launch.FrameworkFactory

setFactoryImplementationClass

void setFactoryImplementationClass(String factoryClass)
The name of the frameworks implementation class for the org.osgi.framework.launch.FrameworkFactory class.
Parameters:
factoryClass - The name of the implementation class for org.osgi.framework.launch.FrameworkFactory

getInitProperties

Properties getInitProperties()
The properties to be used when initializing the framework. All standard properties and all properties specific to the framework can be set.
Returns:
The properties used to initialize the framework

setInitProperties

void setInitProperties(Properties frameworkProperties)
                       throws InvalidAttributeValueException
The properties to be used when initializing the framework. All standard properties and all properties specific to the framework can be set.
Parameters:
frameworkProperties - The properties used to initialize the framework
Throws:
InvalidAttributeValueException

isRegisterGlobalWorkManagers

boolean isRegisterGlobalWorkManagers()
Returns true if global work managers should be added to the OSGi service registry.
Returns:
true if global work managers should be added to the OSGi service registry.

setRegisterGlobalWorkManagers

void setRegisterGlobalWorkManagers(boolean doAdd)
Set to true if global work managers should be added to the OSGi service registry.
Parameters:
doAdd -

isRegisterGlobalDataSources

boolean isRegisterGlobalDataSources()
Returns true if global data sources should be added to the OSGi service registry.
Returns:
true if global work managers should be added to the OSGi service registry.

setRegisterGlobalDataSources

void setRegisterGlobalDataSources(boolean doAdd)
Set to true if global data sources should be added to the OSGi service registry.
Parameters:
doAdd -

getOrgOsgiFrameworkBootdelegation

String getOrgOsgiFrameworkBootdelegation()
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.
Returns:
The value that the org.osgi.framework.bootdelegation property should take.

setOrgOsgiFrameworkBootdelegation

void setOrgOsgiFrameworkBootdelegation(String bootDelegation)
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.
Parameters:
bootDelegation - The value that the org.osgi.framework.bootdelegation property should take.

getOrgOsgiFrameworkSystemPackagesExtra

String getOrgOsgiFrameworkSystemPackagesExtra()
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.
Returns:
The value that the org.osgi.framework.system.packages.extra property should take.

setOrgOsgiFrameworkSystemPackagesExtra

void setOrgOsgiFrameworkSystemPackagesExtra(String extra)
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.
Parameters:
extra - The value that the org.osgi.framework.system.packages.extra property should take.

getDeployInstallationBundles

String getDeployInstallationBundles()
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.

Returns:
populate if WebLogic installation bundles should be installed into the framework. May not return null.

setDeployInstallationBundles

void setDeployInstallationBundles(String deploymentOption)
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.

Parameters:
deploymentOption - populate if WebLogic installation bundles should be installed into the framework. May not be null.

Skip navigation links

Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09