Eclipse Platform
Release 3.6

org.eclipse.equinox.p2.engine
Interface IProfile

All Superinterfaces:
IQueryable<IInstallableUnit>

public interface IProfile
extends IQueryable<IInstallableUnit>

Since:
2.0

Field Summary
static int LOCK_NONE
          Constant used to indicate that an installable unit is not locked in anyway.
static int LOCK_UNINSTALL
          Constant used to indicate that an installable unit is locked so that it may not be uninstalled.
static int LOCK_UPDATE
          Constant used to indicate that an installable unit is locked so that it may not be updated. updates.
static String PROP_CACHE
          Profile property constant indicating the bundle pool cache location.
static String PROP_CONFIGURATION_FOLDER
          Profile property constant indicating the configuration folder for the profile.
static String PROP_DESCRIPTION
          Profile property constant for a string property indicating a user visible short textual description of this profile.
static String PROP_ENVIRONMENTS
          Profile property constant indicating the list of environments (e.g., OS, WS, ...) in which a profile can operate.
static String PROP_INSTALL_FEATURES
          Profile property constant for a boolean property indicating if update features should be installed in this profile
static String PROP_INSTALL_FOLDER
          Profile property constant indicating the install folder for the profile.
static String PROP_LAUNCHER_CONFIGURATION
          Profile property constant indicating the location of the launcher configuration file for the profile.
static String PROP_NAME
          Profile property constant for a string property indicating a user visible name of this profile.
static String PROP_NL
          Profile property constant indicating the installed language(s) for the profile.
static String PROP_PROFILE_LOCKED_IU
          A property key (value "org.eclipse.equinox.p2.type.lock") for an integer property indicating how an installable unit is locked in its profile.
static String PROP_PROFILE_ROOT_IU
           
static String PROP_ROAMING
          Profile property constant for a boolean property indicating if the profiling is roaming.
static String PROP_SHARED_CACHE
          Profile property constant indicating a shared read-only bundle pool cache location.
 
Method Summary
 IQueryResult<IInstallableUnit> available(IQuery<IInstallableUnit> query, IProgressMonitor monitor)
           
 Map<String,String> getInstallableUnitProperties(IInstallableUnit iu)
           
 String getInstallableUnitProperty(IInstallableUnit iu, String key)
           
 String getProfileId()
           
 Map<String,String> getProperties()
           
 String getProperty(String key)
          Get the stored value associated with the given key.
 IProvisioningAgent getProvisioningAgent()
          Returns the provisioning agent that manages this profile
 long getTimestamp()
           
 
Methods inherited from interface org.eclipse.equinox.p2.query.IQueryable
query
 

Field Detail

LOCK_NONE

static final int LOCK_NONE
Constant used to indicate that an installable unit is not locked in anyway.

See Also:
PROP_PROFILE_LOCKED_IU, Constant Field Values

LOCK_UNINSTALL

static final int LOCK_UNINSTALL
Constant used to indicate that an installable unit is locked so that it may not be uninstalled.

See Also:
PROP_PROFILE_LOCKED_IU, Constant Field Values

LOCK_UPDATE

static final int LOCK_UPDATE
Constant used to indicate that an installable unit is locked so that it may not be updated. updates.

See Also:
PROP_PROFILE_LOCKED_IU, Constant Field Values

PROP_PROFILE_LOCKED_IU

static final String PROP_PROFILE_LOCKED_IU
A property key (value "org.eclipse.equinox.p2.type.lock") for an integer property indicating how an installable unit is locked in its profile. The integer is a bit-mask indicating the different locks defined on the installable unit. The property should be obtained from a profile using IProfile#getInstallableUnitProperty(IInstallableUnit, String).

See Also:
LOCK_UNINSTALL, LOCK_UPDATE, LOCK_NONE, Constant Field Values

PROP_PROFILE_ROOT_IU

static final String PROP_PROFILE_ROOT_IU
See Also:
Constant Field Values

PROP_INSTALL_FOLDER

static final String PROP_INSTALL_FOLDER
Profile property constant indicating the install folder for the profile.

See Also:
Constant Field Values

PROP_CONFIGURATION_FOLDER

static final String PROP_CONFIGURATION_FOLDER
Profile property constant indicating the configuration folder for the profile.

See Also:
Constant Field Values

PROP_LAUNCHER_CONFIGURATION

static final String PROP_LAUNCHER_CONFIGURATION
Profile property constant indicating the location of the launcher configuration file for the profile.

See Also:
Constant Field Values

PROP_NL

static final String PROP_NL
Profile property constant indicating the installed language(s) for the profile.

See Also:
Constant Field Values

PROP_DESCRIPTION

static final String PROP_DESCRIPTION
Profile property constant for a string property indicating a user visible short textual description of this profile. May be empty or null, and generally will be for non-top level install contexts.

See Also:
Constant Field Values

PROP_NAME

static final String PROP_NAME
Profile property constant for a string property indicating a user visible name of this profile. May be empty or null, and generally will be for non-top level install contexts.

See Also:
Constant Field Values

PROP_ENVIRONMENTS

static final String PROP_ENVIRONMENTS
Profile property constant indicating the list of environments (e.g., OS, WS, ...) in which a profile can operate. The value of the property is a comma-delimited string of key/value pairs.

See Also:
Constant Field Values

PROP_ROAMING

static final String PROP_ROAMING
Profile property constant for a boolean property indicating if the profiling is roaming. A roaming profile is one whose physical install location varies and is updated whenever it runs.

See Also:
Constant Field Values

PROP_CACHE

static final String PROP_CACHE
Profile property constant indicating the bundle pool cache location.

See Also:
Constant Field Values

PROP_SHARED_CACHE

static final String PROP_SHARED_CACHE
Profile property constant indicating a shared read-only bundle pool cache location.

See Also:
Constant Field Values

PROP_INSTALL_FEATURES

static final String PROP_INSTALL_FEATURES
Profile property constant for a boolean property indicating if update features should be installed in this profile

See Also:
Constant Field Values
Method Detail

getProvisioningAgent

IProvisioningAgent getProvisioningAgent()
Returns the provisioning agent that manages this profile

Returns:
A provisioning agent.

getProfileId

String getProfileId()

getProperty

String getProperty(String key)
Get the stored value associated with the given key. null is returned if this property is not present


getInstallableUnitProperty

String getInstallableUnitProperty(IInstallableUnit iu,
                                  String key)

getProperties

Map<String,String> getProperties()

getInstallableUnitProperties

Map<String,String> getInstallableUnitProperties(IInstallableUnit iu)

getTimestamp

long getTimestamp()

available

IQueryResult<IInstallableUnit> available(IQuery<IInstallableUnit> query,
                                         IProgressMonitor monitor)

Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.