org.osgi.core 6.0.0 · org.osgi.framework.startlevel.BundleStartLevel

Method Summary

Modifier and Type	Method and Description
public int	Returns: The start level value of the bundle. getStartLevel() Return the assigned start level value for the bundle.
public boolean	Returns: `true` if the bundle's autostart setting indicates the activation policy declared in the manifest must be used. `false` if the bundle must be eagerly activated. isActivationPolicyUsed() Returns whether the bundle's autostart setting indicates that the activation policy declared in the bundle manifest must be used.
public boolean	Returns: `true` if the autostart setting of the bundle indicates it is to be started. `false` otherwise. isPersistentlyStarted() Returns whether the bundle's autostart setting indicates it must be started.
public void	setStartLevel(int The new start level for the bundle. startlevel) Assign a start level value to the bundle.

Inherited from org.osgi.framework.BundleReference:: getBundle

Method Detail

getStartLevel back to summary

getStartLevel	back to summary
public int getStartLevel() Return the assigned start level value for the bundle. Returns:int The start level value of the bundle. Exceptions IllegalStateException: If the bundle has been uninstalled. See Also `setStartLevel(int)`

public int getStartLevel()

Return the assigned start level value for the bundle.

Returns:int

The start level value of the bundle.

Exceptions

IllegalStateException:: If the bundle has been uninstalled.

See Also

setStartLevel(int)

isActivationPolicyUsed back to summary

isActivationPolicyUsed	back to summary
public boolean isActivationPolicyUsed() Returns whether the bundle's autostart setting indicates that the activation policy declared in the bundle manifest must be used. The autostart setting of a bundle indicates whether the bundle's declared activation policy is to be used when the bundle is started. Returns:boolean `true` if the bundle's autostart setting indicates the activation policy declared in the manifest must be used. `false` if the bundle must be eagerly activated. Exceptions IllegalStateException: If the bundle has been uninstalled. See Also `Bundle#START_ACTIVATION_POLICY`

public boolean isActivationPolicyUsed()

Returns whether the bundle's autostart setting indicates that the activation policy declared in the bundle manifest must be used.

The autostart setting of a bundle indicates whether the bundle's declared activation policy is to be used when the bundle is started.

Returns:boolean

true if the bundle's autostart setting indicates the activation policy declared in the manifest must be used. false if the bundle must be eagerly activated.

Exceptions

IllegalStateException:: If the bundle has been uninstalled.

See Also

Bundle#START_ACTIVATION_POLICY

isPersistentlyStarted back to summary

isPersistentlyStarted	back to summary
public boolean isPersistentlyStarted() Returns whether the bundle's autostart setting indicates it must be started. The autostart setting of a bundle indicates whether the bundle is to be started when its start level is reached. Returns:boolean `true` if the autostart setting of the bundle indicates it is to be started. `false` otherwise. Exceptions IllegalStateException: If this bundle has been uninstalled. See Also `Bundle#START_TRANSIENT`

public boolean isPersistentlyStarted()

Returns whether the bundle's autostart setting indicates it must be started.

The autostart setting of a bundle indicates whether the bundle is to be started when its start level is reached.

Returns:boolean

true if the autostart setting of the bundle indicates it is to be started. false otherwise.

Exceptions

IllegalStateException:: If this bundle has been uninstalled.

See Also

Bundle#START_TRANSIENT

setStartLevel back to summary

setStartLevel	back to summary
public void setStartLevel(int startlevel) Assign a start level value to the bundle. The bundle will be assigned the specified start level. The start level value assigned to the bundle will be persistently recorded by the Framework. If the new start level for the bundle is lower than or equal to the active start level of the Framework and the bundle's autostart setting indicates this bundle must be started, the Framework will start the bundle as described in the `Bundle#start(int)` method using the `Bundle#START_TRANSIENT` option. The `Bundle#START_ACTIVATION_POLICY` option must also be used if `isActivationPolicyUsed()` returns `true`. The actual starting of the bundle must occur asynchronously. If the new start level for the bundle is higher than the active start level of the Framework, the Framework will stop the bundle as described in the `Bundle#stop(int)` method using the `Bundle#STOP_TRANSIENT` option. The actual stopping of the bundle must occur asynchronously. Parameters startlevel:int The new start level for the bundle. Exceptions IllegalArgumentException: If the specified start level is less than or equal to zero, or if the bundle is the system bundle. IllegalStateException: If the bundle has been uninstalled. SecurityException: If the caller does not have `AdminPermission[bundle,EXECUTE]` and the Java runtime environment supports permissions.

public void setStartLevel(int startlevel)

Assign a start level value to the bundle.

The bundle will be assigned the specified start level. The start level value assigned to the bundle will be persistently recorded by the Framework.

If the new start level for the bundle is lower than or equal to the active start level of the Framework and the bundle's autostart setting indicates this bundle must be started, the Framework will start the bundle as described in the Bundle#start(int) method using the Bundle#START_TRANSIENT option. The Bundle#START_ACTIVATION_POLICY option must also be used if isActivationPolicyUsed() returns true. The actual starting of the bundle must occur asynchronously.

If the new start level for the bundle is higher than the active start level of the Framework, the Framework will stop the bundle as described in the Bundle#stop(int) method using the Bundle#STOP_TRANSIENT option. The actual stopping of the bundle must occur asynchronously.

Parameters

startlevel:int: The new start level for the bundle.

Exceptions

IllegalArgumentException:: If the specified start level is less than or equal to zero, or if the bundle is the system bundle.
IllegalStateException:: If the bundle has been uninstalled.
SecurityException:: If the caller does not have AdminPermission[bundle,EXECUTE] and the Java runtime environment supports permissions.

public Interface BundleStartLevel

Method Summary

Method Detail