| /********************************************************************** |
| * Copyright (c) 2004 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Common Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/cpl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - Initial API and implementation |
| **********************************************************************/ |
| package org.eclipse.wst.server.core; |
| |
| import org.eclipse.core.runtime.CoreException; |
| import org.eclipse.core.runtime.IPath; |
| import org.eclipse.core.runtime.IProgressMonitor; |
| /** |
| * A working copy runtime object used for formulating changes |
| * to a runtime instance ({@link IRuntime}). Changes made on a |
| * working copy do not occur (and are not persisted) until a |
| * save() is performed. |
| * <p> |
| * [issue: IElementWorkingCopy and IElement support an open-ended set |
| * of attribute-value pairs. What is relationship between these |
| * attributes and (a) the get/setXXX methods found on this interface, |
| * and (b) get/setXXX methods provided by specific server types? |
| * Is it the case that these attribute-values pairs are the only |
| * information about a runtime instance that can be preserved |
| * between workbench sessions? That is, any information recorded |
| * just in instance fields of an RuntimeDelegate implementation |
| * will be lost when the session ends.] |
| * </p> |
| * <p> |
| * This interface is not intended to be implemented by clients. |
| * </p> |
| * <p> |
| * <it>Caveat: The server core API is still in an early form, and is |
| * likely to change significantly before the initial release.</it> |
| * </p> |
| * |
| * @see IRuntime |
| * @since 1.0 |
| */ |
| public interface IRuntimeWorkingCopy extends IRuntime, IElementWorkingCopy { |
| /** |
| * Returns the runtime instance that this working copy is |
| * associated with. |
| * <p> |
| * For a runtime working copy created by a call to |
| * {@link IRuntime#createWorkingCopy()}, |
| * <code>this.getOriginal()</code> returns the original |
| * runtime object. For a runtime working copy just created by |
| * a call to {@link IRuntimeType#createRuntime(String)}, |
| * <code>this.getOriginal()</code> returns <code>null</code>. |
| * </p> |
| * |
| * @return the associated runtime instance, or <code>null</code> if none |
| */ |
| public IRuntime getOriginal(); |
| |
| /** |
| * Returns the extension for this runtime working copy. |
| * The runtime working copy extension is a |
| * runtime-type-specific object. By casting the runtime working copy |
| * extension to the type prescribed in the API documentation for that |
| * particular runtime working copy type, the client can access |
| * runtime-type-specific properties and methods. |
| * |
| * @return the extension for the runtime working copy |
| */ |
| //public IServerExtension getWorkingCopyExtension(IProgressMonitor monitor); |
| |
| /** |
| * Sets the absolute path in the local file system to the root of the runtime, |
| * typically the installation directory. |
| * |
| * @param path the location of this runtime, or <code>null</code> if none |
| * @see IRuntime#getLocation() |
| */ |
| public void setLocation(IPath path); |
| |
| /** |
| * Commits the changes made in this working copy. If there is |
| * no extant runtime instance with a matching id and runtime |
| * type, this will create a runtime instance with attributes |
| * taken from this working copy, and return that object. |
| * <p> |
| * If there an existing runtime instance with a matching id and |
| * runtime type, this will change the runtime instance accordingly. |
| * The returned runtime will be the same runtime this is returned |
| * from getOriginal(), after the changes have been applied. |
| * </p> |
| * Runtimes can be saved even when they have invalid properties. It |
| * is the clients responsibility to call validate() or check the |
| * properties before saving. |
| * <p> |
| * [issue: What is lifecycle for RuntimeWorkingCopyDelegate |
| * associated with this working copy?] |
| * </p> |
| * |
| * @param monitor a progress monitor, or <code>null</code> if progress |
| * reporting and cancellation are not desired |
| * @return a new runtime instance |
| * @throws CoreException if the save could not be completed |
| */ |
| public IRuntime save(boolean force, IProgressMonitor monitor) throws CoreException; |
| } |