| 1 |
/******************************************************************************* |
| 2 |
* Copyright (c) 2007, 2010 IBM Corporation and others. |
| 3 |
* |
| 4 |
* This program and the accompanying materials |
| 5 |
* are made available under the terms of the Eclipse Public License 2.0 |
| 6 |
* which accompanies this distribution, and is available at |
| 7 |
* https://www.eclipse.org/legal/epl-2.0/ |
| 8 |
* |
| 9 |
* SPDX-License-Identifier: EPL-2.0 |
| 10 |
* |
| 11 |
* Contributors: |
| 12 |
* IBM Corporation - initial API and implementation |
| 13 |
* Sonatype, Inc. - ongoing development |
| 14 |
*******************************************************************************/ |
| 15 |
package org.eclipse.equinox.p2.planner; |
| 16 |
|
| 17 |
import org.eclipse.core.runtime.IProgressMonitor; |
| 18 |
import org.eclipse.equinox.p2.engine.*; |
| 19 |
import org.eclipse.equinox.p2.metadata.IInstallableUnit; |
| 20 |
import org.eclipse.equinox.p2.query.IQueryResult; |
| 21 |
|
| 22 |
/** |
| 23 |
* Planners are responsible for determining what should be done to a given |
| 24 |
* profile to reshape it as requested. That is, given the current state of a |
| 25 |
* profile, a description of the desired changes to that profile and metadata |
| 26 |
* describing the available installable units, a planner produces a concrete plan that lists the |
| 27 |
* exact steps that the engine should perform. |
| 28 |
* |
| 29 |
* @noimplement This interface is not intended to be implemented by clients. |
| 30 |
* @noextend This interface is not intended to be extended by clients. |
| 31 |
* @since 2.0 |
| 32 |
*/ |
| 33 |
public interface IPlanner { |
| 34 |
/** |
| 35 |
* Service name constant for the planner service. |
| 36 |
*/ |
| 37 |
public static final String SERVICE_NAME = IPlanner.class.getName(); |
| 38 |
|
| 39 |
/** |
| 40 |
* Returns a plan describing the set of changes that must be performed to |
| 41 |
* satisfy the given profile change request. |
| 42 |
* |
| 43 |
* @param profileChangeRequest the request to be evaluated |
| 44 |
* @param context the context in which the request is processed |
| 45 |
* @param monitor a monitor on which planning |
| 46 |
* @return the plan representing the system that needs to be |
| 47 |
*/ |
| 48 |
public IProvisioningPlan getProvisioningPlan(IProfileChangeRequest profileChangeRequest, ProvisioningContext context, IProgressMonitor monitor); |
| 49 |
|
| 50 |
public IProvisioningPlan getDiffPlan(IProfile currentProfile, IProfile targetProfile, IProgressMonitor monitor); |
| 51 |
|
| 52 |
public IProfileChangeRequest createChangeRequest(IProfile profileToChange); |
| 53 |
|
| 54 |
/** |
| 55 |
* @noreference This method is not intended to be referenced by clients. |
| 56 |
* You may want to consider using the org.eclipse.equinox.p2.operations.UpdateOperation class instead. |
| 57 |
*/ |
| 58 |
public IQueryResult<IInstallableUnit> updatesFor(IInstallableUnit iu, ProvisioningContext context, IProgressMonitor monitor); |
| 59 |
} |