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.

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

Default Value:

null

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

Default Value:

null

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

Default Value:

"org.apache.felix.framework.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

Default Value:

"org.apache.felix.framework.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.

Default Value:

true

setRegisterGlobalWorkManagers

void setRegisterGlobalWorkManagers(boolean doAdd)

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

Parameters:

doAdd -

Default Value:

true

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.

Default Value:

true

setRegisterGlobalDataSources

void setRegisterGlobalDataSources(boolean doAdd)

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

Parameters:

doAdd -

Default Value:

true

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.

Default Value:

null

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.

Default Value:

null

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.

Default Value:

null

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.

Default Value:

null

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.

Default Value:

"populate"

Valid Values:

"populate","ignore"

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.

Default Value:

"populate"

Valid Values:

"populate","ignore"