Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
Copyright (c) 2003, 2008 IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html Contributors: IBM Corporation - initial API and implementation /
 
 package org.eclipse.osgi.service.resolver;
 
The state of a system as reported by a resolver. This includes all bundles presented to the resolver relative to this state (i.e., both resolved and unresolved).

This interface is not intended to be implemented by clients. The StateObjectFactory should be used to construct instances.

Since:
3.1
Noimplement:
This interface is not intended to be implemented by clients.
 
 public interface State {
Adds the given bundle to this state.

If the bundle already exists in another state then an IllegalStateException will be thrown. Note that even if you remove a BundleDescription from one State object using removeBundle(org.eclipse.osgi.service.resolver.BundleDescription) it may still be considered as removing pending if other bundles in that state depend on the bundle you removed. To complete a pending removal a call must be done to resolve(org.eclipse.osgi.service.resolver.BundleDescription[]) with the removed bundle.

Parameters:
description the description to add
Returns:
a boolean indicating whether the bundle was successfully added
Throws:
java.lang.IllegalStateException if the bundle already exists in another state
 
 	public boolean addBundle(BundleDescription description);

Returns a delta describing the differences between this state and the given state. The given state is taken as the base so the absence of a bundle in this state is reported as a deletion, etc.

Note that the generated StateDelta will contain BundleDeltas with one of the following types: BundleDelta.ADDED, BundleDelta.REMOVED and BundleDelta.UPDATED

Parameters:
baseState the base state
Returns:
a delta describing differences between this and the base state state
 
 	public StateDelta compare(State baseStatethrows BundleException;

Removes a bundle description with the given bundle id.

Parameters:
bundleId the id of the bundle description to be removed
Returns:
the removed bundle description, or null, if a bundle with the given id does not exist in this state
 
 	public BundleDescription removeBundle(long bundleId);

Removes the given bundle description.

Parameters:
bundle the bundle description to be removed
Returns:
true, if if the bundle description was removed, false otherwise
 
 	public boolean removeBundle(BundleDescription bundle);

Updates an existing bundle description with the given description.

Parameters:
newDescription the bundle description to replace an existing one
Returns:
true, if if the bundle description was updated, false otherwise
 
 	public boolean updateBundle(BundleDescription newDescription);

Returns the delta representing the changes from the time this state was first captured until now.

Returns:
the state delta
 
 	public StateDelta getChanges();

Returns descriptions for all bundles known to this state.

Returns:
the descriptions for all bundles known to this state.
 
Returns the bundle descriptor for the bundle with the given id. null is returned if no such bundle is found in this state.

Returns:
the descriptor for the identified bundle
See also:
BundleDescription.getBundleId()
	public BundleDescription getBundle(long id);

Returns the bundle descriptor for the bundle with the given name and version. A null value is returned if no such bundle is found in this state. A resolved bundle is always preferably returned over an unresolved bundle. If multiple bundles with the same resolution state are available, the bundle with the highest version number is returned if the version is null.

Parameters:
symbolicName symbolic name of the bundle to query
version version of the bundle to query. null matches any bundle
Returns:
the descriptor for the identified bundle
	public BundleDescription getBundle(String symbolicNameVersion version);

Returns the bundle descriptor for the bundle with the given location identifier. null is returned if no such bundle is found in this state.

Parameters:
location location identifier of the bundle to query
Returns:
the descriptor for the identified bundle
Returns the timestamp for this state. This correlates this timestamp to the system state. For example, if the system state timestamp is 4 but then some bundles are installed, the system state timestamp is updated. By comparing 4 to the current system state timestamp it is possible to detect if the states are out of sync.

Returns:
the timestamp of this state
	public long getTimeStamp();

Sets the timestamp for this state

Parameters:
newTimeStamp the new timestamp for this state
	public void setTimeStamp(long newTimeStamp);

Returns true if there have been no modifications to this state since the last time resolve() was called.

Returns:
whether or not this state has changed since last resolved.
	public boolean isResolved();

Resolves the given version constraint with the given supplier. The given constraint object is destructively modified to reflect its new resolved state. Note that a constraint can be unresolved by passing null for the supplier.

This method is intended to be used by resolvers in the process of determining which constraints are satisfied by which components.

Parameters:
constraint the version constraint to update
supplier the supplier which satisfies the constraint. May be null if the constraint is to be unresolved.
Throws:
java.lang.IllegalStateException if this is not done during a call to resolve
	public void resolveConstraint(VersionConstraint constraintBaseDescription supplier);

Sets whether or not the given bundle is selected in this state.

This method is intended to be used by resolvers in the process of determining which constraints are satisfied by which components.

Deprecated:
use resolveBundle(org.eclipse.osgi.service.resolver.BundleDescription,boolean,org.eclipse.osgi.service.resolver.BundleDescription[],org.eclipse.osgi.service.resolver.ExportPackageDescription[],org.eclipse.osgi.service.resolver.ExportPackageDescription[],org.eclipse.osgi.service.resolver.BundleDescription[],org.eclipse.osgi.service.resolver.ExportPackageDescription[])
Parameters:
bundle the bundle to update
status whether or not the given bundle is resolved, if false the other parameters are ignored
hosts the host for the resolve fragment, can be null
selectedExports the selected exported packages for this resolved bundle, can be null
resolvedRequires the BundleDescriptions that resolve the required bundles for this bundle, can be null
resolvedImports the exported packages that resolve the imports for this bundle, can be null
Throws:
java.lang.IllegalStateException if this is not done during a call to resolve
	public void resolveBundle(BundleDescription bundleboolean statusBundleDescription[] hostsExportPackageDescription[] selectedExportsBundleDescription[] resolvedRequiresExportPackageDescription[] resolvedImports);

Sets whether or not the given bundle is selected in this state.

This method is intended to be used by resolvers in the process of determining which constraints are satisfied by which components.

Parameters:
bundle the bundle to update
status whether or not the given bundle is resolved, if false the other parameters are ignored
hosts the host for the resolve fragment, can be null
selectedExports the selected exported packages for this resolved bundle, can be null
substitutedExports the exported packages that resolve imports for this bundle and substitute exports, can be null
resolvedRequires the BundleDescriptions that resolve the required bundles for this bundle, can be null
resolvedImports the exported packages that resolve the imports for this bundle, can be null
Throws:
java.lang.IllegalStateException if this is not done during a call to resolve
Since:
3.4
	public void resolveBundle(BundleDescription bundleboolean statusBundleDescription[] hostsExportPackageDescription[] selectedExportsExportPackageDescription[] substitutedExportsBundleDescription[] resolvedRequiresExportPackageDescription[] resolvedImports);

Sets the given removal pending bundle to removal complete for this state.

This method is intended to be used by resolvers in the process of resolving bundles.

Parameters:
bundle the bundle to set a removal complete.
Throws:
java.lang.IllegalStateException if this is not done during a call to resolve
	public void removeBundleComplete(BundleDescription bundle);

Adds a new ResolverError for the specified bundle.

This method is intended to be used by resolvers in the process of resolving.

Parameters:
bundle the bundle to add a new ResolverError for
type the type of ResolverError to add
data the data for the ResolverError
unsatisfied the unsatisfied constraint or null if the resolver error was not caused by an unsatisfied constraint.
Throws:
java.lang.IllegalStateException if this is not done during a call to resolve
Since:
3.2
	public void addResolverError(BundleDescription bundleint typeString dataVersionConstraint unsatisfied);

Removes all ResolverErrors for the specified bundle.

This method is intended to be used by resolvers in the process of resolving.

Parameters:
bundle the bundle to remove all ResolverErrors for
Throws:
java.lang.IllegalStateException if this is not done during a call to resolve
Since:
3.2
	public void removeResolverErrors(BundleDescription bundle);

Returns all ResolverErrors for the given bundle

Parameters:
bundle the bundle to get all ResolverErrors for
Returns:
all ResolverErrors for the given bundle
Since:
3.2
Returns the resolver associated with this state. A state can work with at most one resolver at any given time. Similarly, a resolver can work with at most one state at a time.

Returns:
the resolver for this state. null is returned if the state does not have a resolver
	public Resolver getResolver();

Sets the resolver associated with this state. A state can work with at most one resolver at any given time. Similarly, a resolver can work with at most one state at a time.

To ensure that this state and the given resovler are properly linked, the following expression must be included in this method if the given resolver (value) is not identical to the result of this.getResolver().

  if (this.getResolver() != value) value.setState(this);
 
	// TODO what happens if you set the Resolver after some bundles have
	// been added to the state but it is not resolved?  Should setting
	// the resolver force a state to be unresolved?
	public void setResolver(Resolver value);

Resolves the constraints contained in this state using the resolver currently associated with the state and returns a delta describing the changes in resolved states and dependencies in the state.

Note that this method is typically implemented using

  this.getResolver().resolve();
 
and is the preferred path for invoking resolution. In particular, states should refuse to perform updates (@see #select() and #resolveConstraint()) if they are not currently involved in a resolution cycle.

Note the given state is destructively modified to reflect the results of resolution.

Parameters:
incremental a flag controlling whether resolution should be incremental
Returns:
a delta describing the changes in resolved state and interconnections
	public StateDelta resolve(boolean incremental);

Same as State.resolve(true);
	public StateDelta resolve();

Resolves the constraints contained in this state using the resolver currently associated with the state in a incremental, "least-perturbing" mode, and returns a delta describing the changes in resolved states and dependencies in the state.

Parameters:
discard an array containing descriptions for bundles whose current resolution state should be forgotten. If null then all the current removal pending BundleDescriptions are refreshed.
Returns:
a delta describing the changes in resolved state and interconnections
	public StateDelta resolve(BundleDescription[] discard);

Sets the version overrides which are to be applied during the resolutoin of this state. Version overrides allow external forces to refine/override the version constraints setup by the components in the state.

Parameters:
value
	// TODO the exact form of this is not defined as yet.
	public void setOverrides(Object value);

Returns descriptions for all bundles currently resolved in this state.

Returns:
the descriptions for all bundles currently resolved in this state.
Returns whether this state is empty.

Returns:
true if this state is empty, false otherwise
	public boolean isEmpty();

Returns all exported packages in this state, according to the OSGi rules for resolution.

Returns all bundle descriptions with the given bundle symbolic name.

Parameters:
symbolicName symbolic name of the bundles to query
Returns:
the descriptors for all bundles known to this state with the specified symbolic name.
	public BundleDescription[] getBundles(String symbolicName);

Returns the factory that created this state.

Returns:
the state object factory that created this state
Attempts to find an ExportPackageDescription that will satisfy a dynamic import for the specified requestedPackage for the specified importingBundle. If no ExportPackageDescription is available that satisfies a dynamic import for the importingBundle then null is returned.

Parameters:
importingBundle the BundleDescription that is requesting a dynamic package
requestedPackage the name of the package that is being requested
Returns:
the ExportPackageDescription that satisfies the dynamic import request; a value of null is returned if none is available.
	public ExportPackageDescription linkDynamicImport(BundleDescription importingBundleString requestedPackage);

Sets the platform properties of the state. The platform properties are used to resolve the following constraints:
  • The execution environment requirements (i.e. Bundle-RequiredExecutionEnvironment).
  • The platform filter requirements (i.e. Eclipse-PlatformFilter).
  • The native code requirements (i.e. Bundle-NativeCode).
Arbitrary keys may be used in the platform properties but the following keys have a specified meaning:
  • osgi.nl - the platform language setting.
  • osgi.os - the platform operating system.
  • osgi.arch - the platform architecture.
  • osgi.ws - the platform windowing system.
  • osgi.resolverMode - the resolver mode. A value of "strict" will set the resolver mode to strict.
  • org.osgi.framework.system.packages - the packages exported by the system bundle.
  • org.osgi.framework.executionenvironment - the comma separated list of supported execution environments. This property is then used to resolve the required execution environment the bundles in a state.
  • org.osgi.framework.os.name - the name of the operating system. This property is used to resolve the osname attribute of bundle native code (i.e. Bundle-NativeCode).
  • org.osgi.framework.os.version - the version of the operating system. This property is used to resolve the osversion attribute of bundle native code (i.e. Bundle-NativeCode).
  • org.osgi.framework.processor - the processor name. This property is used to resolve the processor attribute of bundle native code (i.e. Bundle-NativeCode).
  • org.osgi.framework.language - the language being used. This property is used to resolve the language attribute of bundle native code (i.e. Bundle-NativeCode).

The values used for the supported properties can be String type to specify a single value for the property or they can by String[] to specify a list of values for the property.

Parameters:
platformProperties the platform properties of the state
Returns:
false if the platformProperties specified do not change any of the supported properties already set. If any of the supported property values are changed as a result of calling this method then true is returned.
	public boolean setPlatformProperties(Dictionary platformProperties);

Sets the platform properties of the state to a list of platform properties.

Parameters:
platformProperties a set of platform properties for the state
Returns:
false if the platformProperties specified do not change any of the supported properties already set. If any of the supported property values are changed as a result of calling this method then true is returned.
See also:
setPlatformProperties(java.util.Dictionary)
	public boolean setPlatformProperties(Dictionary[] platformProperties);

Returns the list of platform properties currently set for this state.

Returns:
the list of platform properties currently set for this state.
Returns the list of system packages which are exported by the system bundle. The list of system packages is set by the org.osgi.framework.system.packages value in the platform properties for this state.

Returns:
the list of system packages
See also:
setPlatformProperties(java.util.Dictionary)
Returns a state helper object. State helpers provide convenience methods for manipulating states.

A possible implementation for this method would provide the same single StateHelper instance to all clients.

Returns:
a state helper
Since:
3.2
See also:
StateHelper
Returns the highest bundle ID. The value -1 is returned if no bundles exist in this state.

Note that this method returns the highest bundle ID the ever existed in this this state object. This bundle may have been removed from the state.

Returns:
the highest bundle ID.
Since:
3.3
	public long getHighestBundleId();

Sets the native code paths of a native code description as invalid. Native code paths are invalid if they can not be found in the bundle content.

The framework, or some other entity which has access to bundle content, will call this method to validate or invalidate native code paths.

Parameters:
nativeCodeDescription the native code description.
hasInvalidNativePaths true if the native code paths are invalid; false otherwise.
Since:
3.4
	public void setNativePathsInvalid(NativeCodeDescription nativeCodeDescriptionboolean hasInvalidNativePaths);

Returns an array of BundleDescriptions for the bundles that are disabled in the system. Use getDisabledInfos(org.eclipse.osgi.service.resolver.BundleDescription) to interrogate the reason that each bundle is disabled.

Returns:
the array of disabled bundles. An empty array is returned if no bundles are disabled.
Since:
3.4
See also:
DisabledInfo
Adds the disabled info to this state. If a disable info already exists for the specified policy and the specified bundle then it is replaced with the given disabled info.

Parameters:
disabledInfo the disabled info to add.
Throws:
java.lang.IllegalArgumentException if the BundleDescription for the specified disabled info does not exist in this state.
Since:
3.4
	public void addDisabledInfo(DisabledInfo disabledInfo);

Removes the disabled info from the state.

Parameters:
disabledInfo the disabled info to remove
Since:
3.4
	public void removeDisabledInfo(DisabledInfo disabledInfo);

Returns an array of disabled info for the specified bundle. If no disabled info exist then an empty array is returned.

Parameters:
bundle the bundle to get the disabled info for.
Returns:
the array of disabled info.
Since:
3.4
Returns the disabled info for the specified bundle with the specified policy name. If no disabled info exists then null is returned.

Parameters:
bundle the bundle to get the disabled info for
Returns:
the disabled info.
Since:
3.4
	public DisabledInfo getDisabledInfo(BundleDescription bundleString policyName);
New to GrepCode? Check out our FAQ X