>> entrySet() {
+// return this.map.entrySet();
+// }
+//
+// @Override
+// public boolean equals(Object other) {
+// if (this == other) {
+// return true;
+// }
+// return this.map.equals(other);
+// }
+//
+// @Override
+// public int hashCode() {
+// return this.map.hashCode();
+// }
+//
+// @Override
+// public String toString() {
+// return this.map.toString();
+// }
+// }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/FileCopyUtils.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/FileCopyUtils.java
new file mode 100644
index 000000000..1a52f0926
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/FileCopyUtils.java
@@ -0,0 +1,241 @@
+/*
+ * Copyright 2002-2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springsource.ide.eclipse.commons.core.util;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+
+import org.apache.log4j.lf5.util.StreamUtils;
+import org.eclipse.core.runtime.Assert;
+
+/**
+ * Simple utility methods for file and stream copying. All copy methods use a block size
+ * of 4096 bytes, and close all affected streams when done. A variation of the copy
+ * methods from this class that leave streams open can be found in {@link StreamUtils}.
+ *
+ * Mainly for use within the framework, but also useful for application code.
+ *
+ * @author Juergen Hoeller
+ * @since 06.10.2003
+ * @see StreamUtils
+ * @see FileSystemUtils
+ */
+public abstract class FileCopyUtils {
+
+// /**
+// * The default buffer size used when copying bytes.
+// */
+// public static final int BUFFER_SIZE = StreamUtils.BUFFER_SIZE;
+//
+//
+// //---------------------------------------------------------------------
+// // Copy methods for java.io.File
+// //---------------------------------------------------------------------
+//
+// /**
+// * Copy the contents of the given input File to the given output File.
+// * @param in the file to copy from
+// * @param out the file to copy to
+// * @return the number of bytes copied
+// * @throws IOException in case of I/O errors
+// */
+// public static int copy(File in, File out) throws IOException {
+// Assert.notNull(in, "No input File specified");
+// Assert.notNull(out, "No output File specified");
+// return copy(Files.newInputStream(in.toPath()), Files.newOutputStream(out.toPath()));
+// }
+//
+// /**
+// * Copy the contents of the given byte array to the given output File.
+// * @param in the byte array to copy from
+// * @param out the file to copy to
+// * @throws IOException in case of I/O errors
+// */
+// public static void copy(byte[] in, File out) throws IOException {
+// Assert.notNull(in, "No input byte array specified");
+// Assert.notNull(out, "No output File specified");
+// copy(new ByteArrayInputStream(in), Files.newOutputStream(out.toPath()));
+// }
+//
+// /**
+// * Copy the contents of the given input File into a new byte array.
+// * @param in the file to copy from
+// * @return the new byte array that has been copied to
+// * @throws IOException in case of I/O errors
+// */
+// public static byte[] copyToByteArray(File in) throws IOException {
+// Assert.notNull(in, "No input File specified");
+// return copyToByteArray(Files.newInputStream(in.toPath()));
+// }
+//
+//
+ //---------------------------------------------------------------------
+ // Copy methods for java.io.InputStream / java.io.OutputStream
+ //---------------------------------------------------------------------
+
+ /**
+ * Copy the contents of the given InputStream to the given OutputStream.
+ * Closes both streams when done.
+ * @param in the stream to copy from
+ * @param out the stream to copy to
+ * @throws IOException in case of I/O errors
+ */
+ public static void copy(InputStream in, OutputStream out) throws IOException {
+ Assert.isNotNull(in, "No InputStream specified");
+ Assert.isNotNull(out, "No OutputStream specified");
+
+ try {
+ StreamUtils.copy(in, out);
+ }
+ finally {
+ try {
+ in.close();
+ }
+ catch (IOException ex) {
+ }
+ try {
+ out.close();
+ }
+ catch (IOException ex) {
+ }
+ }
+ }
+//
+// /**
+// * Copy the contents of the given byte array to the given OutputStream.
+// * Closes the stream when done.
+// * @param in the byte array to copy from
+// * @param out the OutputStream to copy to
+// * @throws IOException in case of I/O errors
+// */
+// public static void copy(byte[] in, OutputStream out) throws IOException {
+// Assert.notNull(in, "No input byte array specified");
+// Assert.notNull(out, "No OutputStream specified");
+//
+// try {
+// out.write(in);
+// }
+// finally {
+// try {
+// out.close();
+// }
+// catch (IOException ex) {
+// }
+// }
+// }
+//
+// /**
+// * Copy the contents of the given InputStream into a new byte array.
+// * Closes the stream when done.
+// * @param in the stream to copy from (may be {@code null} or empty)
+// * @return the new byte array that has been copied to (possibly empty)
+// * @throws IOException in case of I/O errors
+// */
+// public static byte[] copyToByteArray(@Nullable InputStream in) throws IOException {
+// if (in == null) {
+// return new byte[0];
+// }
+//
+// ByteArrayOutputStream out = new ByteArrayOutputStream(BUFFER_SIZE);
+// copy(in, out);
+// return out.toByteArray();
+// }
+//
+//
+// //---------------------------------------------------------------------
+// // Copy methods for java.io.Reader / java.io.Writer
+// //---------------------------------------------------------------------
+//
+// /**
+// * Copy the contents of the given Reader to the given Writer.
+// * Closes both when done.
+// * @param in the Reader to copy from
+// * @param out the Writer to copy to
+// * @return the number of characters copied
+// * @throws IOException in case of I/O errors
+// */
+// public static int copy(Reader in, Writer out) throws IOException {
+// Assert.notNull(in, "No Reader specified");
+// Assert.notNull(out, "No Writer specified");
+//
+// try {
+// int byteCount = 0;
+// char[] buffer = new char[BUFFER_SIZE];
+// int bytesRead = -1;
+// while ((bytesRead = in.read(buffer)) != -1) {
+// out.write(buffer, 0, bytesRead);
+// byteCount += bytesRead;
+// }
+// out.flush();
+// return byteCount;
+// }
+// finally {
+// try {
+// in.close();
+// }
+// catch (IOException ex) {
+// }
+// try {
+// out.close();
+// }
+// catch (IOException ex) {
+// }
+// }
+// }
+//
+// /**
+// * Copy the contents of the given String to the given output Writer.
+// * Closes the writer when done.
+// * @param in the String to copy from
+// * @param out the Writer to copy to
+// * @throws IOException in case of I/O errors
+// */
+// public static void copy(String in, Writer out) throws IOException {
+// Assert.notNull(in, "No input String specified");
+// Assert.notNull(out, "No Writer specified");
+//
+// try {
+// out.write(in);
+// }
+// finally {
+// try {
+// out.close();
+// }
+// catch (IOException ex) {
+// }
+// }
+// }
+//
+// /**
+// * Copy the contents of the given Reader into a String.
+// * Closes the reader when done.
+// * @param in the reader to copy from (may be {@code null} or empty)
+// * @return the String that has been copied to (possibly empty)
+// * @throws IOException in case of I/O errors
+// */
+// public static String copyToString(@Nullable Reader in) throws IOException {
+// if (in == null) {
+// return "";
+// }
+//
+// StringWriter out = new StringWriter();
+// copy(in, out);
+// return out.toString();
+// }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/FuzzyMatcher.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/FuzzyMatcher.java
new file mode 100644
index 000000000..c4eaada58
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/FuzzyMatcher.java
@@ -0,0 +1,133 @@
+/*******************************************************************************
+ * Copyright (c) 2015 Pivotal, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.core.util;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+import org.eclipse.jface.text.IRegion;
+
+/**
+ * @author Kris De Volder
+ */
+public class FuzzyMatcher {
+
+ private static class Region implements IRegion {
+ public Region(int start, int end) {
+ super();
+ this.start = start;
+ this.end = end;
+ }
+ int start;
+ int end;
+ @Override
+ public int getLength() {
+ return end-start;
+ }
+ @Override
+ public int getOffset() {
+ return start;
+ }
+ @Override
+ public String toString() {
+ return "Region["+start+".."+end+"]";
+ }
+ }
+
+ public static Collection highlights(CharSequence query, String data) {
+ List highlights = new ArrayList<>();
+ int qpos = 0;
+ int dpos = 0;
+ int qlen = query.length();
+ int dlen = data.length();
+ while (qpos highlights, int nextMatch) {
+ if (highlights.isEmpty()) {
+ highlights.add(new Region(nextMatch, nextMatch+1));
+ }
+ Region lastRegion = (Region) highlights.get(highlights.size()-1);
+ if (lastRegion.getOffset()+lastRegion.getLength()==nextMatch) {
+ lastRegion.end++;
+ } else {
+ highlights.add(new Region(nextMatch, nextMatch+1));
+ }
+ }
+
+ /**
+ * Match given pattern with a given data. The data is considered a 'match' for the
+ * pattern if all characters in the pattern can be found in the data, in the
+ * same order but with possible 'gaps' in between.
+ *
+ * The function returns 0. when the pattern doesn't match the data and a non-zero
+ * 'score' when it does. The higher the score, the better the match is considered to
+ * be.
+ */
+ public static double matchScore(CharSequence pattern, String data) {
+ int ppos = 0; //pos of next char in pattern to look for
+ int dpos = 0; //pos of next char in data not yet matched
+ int gaps = 0; //number of 'gaps' in the match. A gap is any non-empty run of consecutive characters in the data that are not used by the match
+ int skips = 0; //number of skipped characters. This is the sum of the length of all the gaps.
+ int plen = pattern.length();
+ int dlen = data.length();
+ if (plen>dlen) {
+ return 0.0;
+ }
+ while (ppos=dlen) {
+ //still chars left in pattern but no more data
+ return 0.0;
+ }
+ char c = pattern.charAt(ppos++);
+ int foundCharAt = data.indexOf(c, dpos);
+ if (foundCharAt>=0) {
+ if (foundCharAt>dpos) {
+ gaps++;
+ skips+=foundCharAt-dpos;
+ }
+ dpos = foundCharAt+1;
+ } else {
+ return 0.0;
+ }
+ }
+ //end of pattern reached. All matched.
+ if (dpos more extra = worse score
+ }
+ return score(gaps, skips, pattern);
+ }
+
+ private static double score(int gaps, int skips, CharSequence pattern) {
+ if (gaps==0) {
+ //gaps == 0 means a prefix match, ignore 'skips' at end of String and just sort
+ // alphabetic (see STS-4049)
+ return 0.5+pattern.length(); //all scored equally, assumes using a 'stable' sorter.
+ } else {
+ double badness = 1+gaps + skips/1000.0; // higher is worse
+ return 1.0/badness + pattern.length(); //higher is better
+ }
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/IOUtil.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/IOUtil.java
new file mode 100644
index 000000000..8e3198491
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/IOUtil.java
@@ -0,0 +1,36 @@
+/*******************************************************************************
+ * Copyright (c) 2013 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.core.util;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+public class IOUtil {
+
+ private static final int BUF_SIZE = 1024;
+
+ /**
+ * Consume all data in an input stream, discdaring the data and closing the stream upon completion.
+ */
+ public static void consume(InputStream stream) throws IOException {
+ try {
+ byte[] buf = new byte[BUF_SIZE];
+ while (stream.read(buf)>=0) {}
+ } finally {
+ try {
+ stream.close();
+ } catch (IOException e) {
+ //ignore (or it may mask a more important / interesting error in the body of the try
+ }
+ }
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/MultiplexingOutputStream.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/MultiplexingOutputStream.java
new file mode 100644
index 000000000..86f55b6bf
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/MultiplexingOutputStream.java
@@ -0,0 +1,99 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.core.util;
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+/**
+ * A wrapper around multiple output streams that mulitplexes any output written to this Stream to all
+ * the wrapped Streams.
+ * @author Kris De Volder
+ */
+public class MultiplexingOutputStream extends OutputStream {
+
+ OutputStream[] streams = null;
+
+ public MultiplexingOutputStream(OutputStream... streams) {
+ super();
+ if (streams==null) {
+ this.streams = new OutputStream[0];
+ } else {
+ this.streams = streams;
+ }
+ }
+
+ /**
+ * Writes the byte b to each wrapped OutputStream.
+ *
+ * If one of the Streams throws an Exception this exception is
+ * propagated. No guarantees are made in this case that output
+ * is written to the other Streams.
+ */
+ @Override
+ public void write(int b) throws IOException {
+ for (OutputStream s : streams) {
+ s.write(b);
+ }
+ }
+
+ /**
+ * Writes to each wrapped OutputStream.
+ *
+ * If one of the Streams throws an Exception this exception is
+ * propagated. No guarantees are made in this case that output
+ * is written to the other Streams.
+ */
+ @Override
+ public void write(byte[] b, int off, int len) throws IOException {
+ for (OutputStream s : streams) {
+ s.write(b, off, len);
+ }
+ }
+
+ /**
+ * Attempt to close all of the underlying Streams. If any of the Streams
+ * throws an exception it is guaranteed that at least one of those
+ * exceptions will be propagated.
+ *
+ * Even if one of the streams throws an Exception, we will still
+ * attempt to close the other Streams.
+ */
+ @Override
+ public void close() throws IOException {
+ super.close();
+ Throwable caught = null;
+ for (OutputStream s : streams) {
+ try {
+ s.close();
+ } catch (Throwable e) {
+ caught = e;
+ }
+ }
+ if (caught!=null) {
+ if (caught instanceof IOException) {
+ throw (IOException)caught;
+ } else {
+ // If not a Declared exception it must be an unchecked exception.
+ throw (Error)caught;
+ }
+ }
+ }
+
+ @Override
+ public void flush() throws IOException {
+ for (OutputStream s : streams) {
+ s.flush();
+ }
+ }
+
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/NameGenerator.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/NameGenerator.java
new file mode 100644
index 000000000..277c9c0d2
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/NameGenerator.java
@@ -0,0 +1,48 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.core.util;
+
+/**
+ * Simple name generator implementation
+ *
+ * @author Alex Boyko
+ * @author Kris De Volder
+ */
+public class NameGenerator {
+
+ private static final String delimiter = "-";
+
+ private String prefix;
+ private int number = 0;
+
+ public NameGenerator(String previousName) {
+ prefix = previousName.replace(' ', '-'); //See: https://github.com/spring-projects/spring-ide/issues/230
+ int d = previousName.lastIndexOf(delimiter);
+ if (d>=0) {
+ try {
+ String numString = previousName.substring(d+1);
+ number = Integer.parseInt(numString);
+ prefix = previousName.substring(0, d);
+ } catch (NumberFormatException e) {
+ //ignore
+ }
+ }
+ }
+
+ public String generateNext() {
+ StringBuilder sb = new StringBuilder();
+ sb.append(prefix);
+ sb.append(delimiter);
+ sb.append(++number);
+ return sb.toString();
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/NatureUtils.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/NatureUtils.java
new file mode 100644
index 000000000..b8b29a391
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/NatureUtils.java
@@ -0,0 +1,83 @@
+/*******************************************************************************
+ * Copyright (c) 2012, 2015 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.core.util;
+
+import java.util.LinkedHashSet;
+import java.util.Set;
+
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.resources.IProjectDescription;
+import org.eclipse.core.resources.IResource;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.springsource.ide.eclipse.commons.internal.core.CorePlugin;
+
+/**
+ * @author Kris De Volder
+ */
+public class NatureUtils {
+
+ /**
+ * Make sure a project has a number of required natures. If the natures are not yet present, add them now.
+ * @throws CoreException
+ */
+ public static void ensure(IProject project, IProgressMonitor mon, String... reqNatures) throws CoreException {
+ IProjectDescription desc = project.getDescription();
+ String[] oldNaturesArr = desc.getNatureIds();
+ Set natures = new LinkedHashSet();
+ for (String n : reqNatures) {
+ natures.add(n);
+ }
+ for (String n : oldNaturesArr) {
+ natures.add(n);
+ }
+ if (natures.size()>oldNaturesArr.length) {
+ //Some natures got added
+ desc.setNatureIds(natures.toArray(new String[natures.size()]));
+ project.setDescription(desc, mon);
+ } else {
+ //No new natures added, but need to set it to force desired ordering
+ desc.setNatureIds(natures.toArray(new String[natures.size()]));
+ project.setDescription(desc, IResource.AVOID_NATURE_CONFIG, mon);
+ }
+ }
+
+ /**
+ * Removes a nature from a project. This does nothing if the project doesn't have the nature.
+ */
+ public static void remove(IProject project, String natureId, IProgressMonitor mon) throws CoreException {
+ IProjectDescription desc = project.getDescription();
+ String[] oldNaturesArr = desc.getNatureIds();
+ Set natures = new LinkedHashSet();
+ for (String n : oldNaturesArr) {
+ if (!n.equals(natureId)) {
+ natures.add(n);
+ }
+ }
+ if (natures.size()!=oldNaturesArr.length) {
+ //Something removed
+ desc.setNatureIds(natures.toArray(new String[natures.size()]));
+ project.setDescription(desc, mon);
+ }
+
+ }
+
+ public static boolean hasNature(IProject p, String natureId) {
+ try {
+ return p!=null && p.isAccessible() && p.hasNature(natureId);
+ } catch (CoreException e) {
+ CorePlugin.log(e);
+ }
+ return false;
+ }
+
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/OsUtils.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/OsUtils.java
new file mode 100644
index 000000000..17733ea26
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/OsUtils.java
@@ -0,0 +1,63 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.core.util;
+
+import static java.nio.file.attribute.PosixFilePermission.GROUP_EXECUTE;
+import static java.nio.file.attribute.PosixFilePermission.GROUP_READ;
+import static java.nio.file.attribute.PosixFilePermission.GROUP_WRITE;
+import static java.nio.file.attribute.PosixFilePermission.OTHERS_EXECUTE;
+import static java.nio.file.attribute.PosixFilePermission.OTHERS_READ;
+import static java.nio.file.attribute.PosixFilePermission.OTHERS_WRITE;
+import static java.nio.file.attribute.PosixFilePermission.OWNER_EXECUTE;
+import static java.nio.file.attribute.PosixFilePermission.OWNER_READ;
+import static java.nio.file.attribute.PosixFilePermission.OWNER_WRITE;
+
+import java.nio.file.attribute.PosixFilePermission;
+import java.util.EnumSet;
+import java.util.Set;
+
+/**
+ * @author Kris De Volder
+ *
+ * @since 2.8
+ */
+public class OsUtils {
+
+ public static boolean isWindows() {
+ return System.getProperty("os.name").contains("Windows");
+ }
+
+ private static final PosixFilePermission[] decodeMap = {
+ //This is exactly the reverse order as in the enum.
+ //But it seems safer not to rely on that.
+ OTHERS_EXECUTE,
+ OTHERS_WRITE,
+ OTHERS_READ,
+ GROUP_EXECUTE,
+ GROUP_WRITE,
+ GROUP_READ,
+ OWNER_EXECUTE,
+ OWNER_WRITE,
+ OWNER_READ
+ };
+
+ public static Set posixFilePermissions(int mode) {
+ int mask = 1;
+ Set perms = EnumSet.noneOf(PosixFilePermission.class);
+ for (PosixFilePermission flag : decodeMap) {
+ if (flag!=null && (mask & mode) != 0) {
+ perms.add(flag);
+ }
+ mask = mask << 1;
+ }
+ return perms;
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/ProcessUtils.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/ProcessUtils.java
new file mode 100644
index 000000000..e8ac185e4
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/ProcessUtils.java
@@ -0,0 +1,94 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.core.util;
+
+import java.io.IOException;
+import java.lang.reflect.Field;
+import java.util.List;
+
+import javax.management.remote.JMXConnector;
+import javax.management.remote.JMXConnectorFactory;
+import javax.management.remote.JMXServiceURL;
+
+import org.springsource.ide.eclipse.commons.internal.core.CorePlugin;
+
+import com.sun.tools.attach.AttachNotSupportedException;
+import com.sun.tools.attach.VirtualMachine;
+import com.sun.tools.attach.VirtualMachineDescriptor;
+
+/**
+ * Process Utilities making use of JDK tools
+ *
+ * @author Alex Boyko
+ *
+ */
+@SuppressWarnings("restriction")
+public class ProcessUtils {
+
+ /**
+ * Retrieves PID of a process
+ * @param p the process
+ * @return PID
+ */
+ public static long getProcessID(Process p) {
+ long result = -1;
+ try {
+ Field f = p.getClass().getDeclaredField("pid");
+ f.setAccessible(true);
+ result = f.getLong(p);
+ f.setAccessible(false);
+ }
+ catch (Exception ex) {
+ throw new UnsupportedOperationException("Process PID calculation not supported on the current platform",
+ ex);
+ }
+ return result;
+ }
+
+ /**
+ * Creates JMX Connector to a process specified by its PID
+ * @param pid the PID
+ * @return JMX connector
+ */
+ public static JMXConnector createJMXConnector(String pid) {
+ List vmds = VirtualMachine.list();
+ VirtualMachineDescriptor vmd = vmds.stream().filter(descriptor -> descriptor.id().equals(pid)).findFirst().orElse(null);
+ if (vmd != null) {
+ try {
+ String agentUrl = VirtualMachine.attach(vmd).startLocalManagementAgent();
+ if (agentUrl != null) {
+ JMXServiceURL serviceUrl = new JMXServiceURL(agentUrl);
+ return JMXConnectorFactory.connect(serviceUrl, null);
+ }
+ } catch (AttachNotSupportedException e) {
+ CorePlugin.log(e);
+ } catch (IOException e) {
+ CorePlugin.log(e);
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Determines whether current JDK supports utilities defined in this class
+ * @return true for compatible JDK
+ */
+ public static boolean isLatestJdkForTools() {
+ try {
+ return VirtualMachine.class.getDeclaredMethod("startLocalManagementAgent") != null;
+ }
+ catch (NoSuchMethodException | SecurityException e) {
+ // ignore
+ }
+ return false;
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/StreamUtils.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/StreamUtils.java
new file mode 100644
index 000000000..41de8c003
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/StreamUtils.java
@@ -0,0 +1,263 @@
+/*
+ * Copyright 2002-2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springsource.ide.eclipse.commons.core.util;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+
+import org.eclipse.core.runtime.Assert;
+
+/**
+ * Simple utility methods for dealing with streams. The copy methods of this class are
+ * similar to those defined in {@link FileCopyUtils} except that all affected streams are
+ * left open when done. All copy methods use a block size of 4096 bytes.
+ *
+ * Mainly for use within the framework, but also useful for application code.
+ *
+ * @author Juergen Hoeller
+ * @author Phillip Webb
+ * @author Brian Clozel
+ * @since 3.2.2
+ * @see FileCopyUtils
+ */
+public abstract class StreamUtils {
+
+ /**
+ * The default buffer size used why copying bytes.
+ */
+ public static final int BUFFER_SIZE = 4096;
+
+// private static final byte[] EMPTY_CONTENT = new byte[0];
+//
+//
+// /**
+// * Copy the contents of the given InputStream into a new byte array.
+// * Leaves the stream open when done.
+// * @param in the stream to copy from (may be {@code null} or empty)
+// * @return the new byte array that has been copied to (possibly empty)
+// * @throws IOException in case of I/O errors
+// */
+// public static byte[] copyToByteArray(@Nullable InputStream in) throws IOException {
+// if (in == null) {
+// return new byte[0];
+// }
+//
+// ByteArrayOutputStream out = new ByteArrayOutputStream(BUFFER_SIZE);
+// copy(in, out);
+// return out.toByteArray();
+// }
+//
+// /**
+// * Copy the contents of the given InputStream into a String.
+// * Leaves the stream open when done.
+// * @param in the InputStream to copy from (may be {@code null} or empty)
+// * @return the String that has been copied to (possibly empty)
+// * @throws IOException in case of I/O errors
+// */
+// public static String copyToString(@Nullable InputStream in, Charset charset) throws IOException {
+// if (in == null) {
+// return "";
+// }
+//
+// StringBuilder out = new StringBuilder();
+// InputStreamReader reader = new InputStreamReader(in, charset);
+// char[] buffer = new char[BUFFER_SIZE];
+// int bytesRead = -1;
+// while ((bytesRead = reader.read(buffer)) != -1) {
+// out.append(buffer, 0, bytesRead);
+// }
+// return out.toString();
+// }
+//
+// /**
+// * Copy the contents of the given byte array to the given OutputStream.
+// * Leaves the stream open when done.
+// * @param in the byte array to copy from
+// * @param out the OutputStream to copy to
+// * @throws IOException in case of I/O errors
+// */
+// public static void copy(byte[] in, OutputStream out) throws IOException {
+// Assert.notNull(in, "No input byte array specified");
+// Assert.notNull(out, "No OutputStream specified");
+//
+// out.write(in);
+// }
+//
+// /**
+// * Copy the contents of the given String to the given output OutputStream.
+// * Leaves the stream open when done.
+// * @param in the String to copy from
+// * @param charset the Charset
+// * @param out the OutputStream to copy to
+// * @throws IOException in case of I/O errors
+// */
+// public static void copy(String in, Charset charset, OutputStream out) throws IOException {
+// Assert.notNull(in, "No input String specified");
+// Assert.notNull(charset, "No charset specified");
+// Assert.notNull(out, "No OutputStream specified");
+//
+// Writer writer = new OutputStreamWriter(out, charset);
+// writer.write(in);
+// writer.flush();
+// }
+//
+ /**
+ * Copy the contents of the given InputStream to the given OutputStream.
+ * Leaves both streams open when done.
+ * @param in the InputStream to copy from
+ * @param out the OutputStream to copy to
+ * @return the number of bytes copied
+ * @throws IOException in case of I/O errors
+ */
+ public static int copy(InputStream in, OutputStream out) throws IOException {
+ Assert.isNotNull(in, "No InputStream specified");
+ Assert.isNotNull(out, "No OutputStream specified");
+
+ int byteCount = 0;
+ byte[] buffer = new byte[BUFFER_SIZE];
+ int bytesRead = -1;
+ while ((bytesRead = in.read(buffer)) != -1) {
+ out.write(buffer, 0, bytesRead);
+ byteCount += bytesRead;
+ }
+ out.flush();
+ return byteCount;
+ }
+
+// /**
+// * Copy a range of content of the given InputStream to the given OutputStream.
+// *
If the specified range exceeds the length of the InputStream, this copies
+// * up to the end of the stream and returns the actual number of copied bytes.
+// *
Leaves both streams open when done.
+// * @param in the InputStream to copy from
+// * @param out the OutputStream to copy to
+// * @param start the position to start copying from
+// * @param end the position to end copying
+// * @return the number of bytes copied
+// * @throws IOException in case of I/O errors
+// * @since 4.3
+// */
+// public static long copyRange(InputStream in, OutputStream out, long start, long end) throws IOException {
+// Assert.notNull(in, "No InputStream specified");
+// Assert.notNull(out, "No OutputStream specified");
+//
+// long skipped = in.skip(start);
+// if (skipped < start) {
+// throw new IOException("Skipped only " + skipped + " bytes out of " + start + " required");
+// }
+//
+// long bytesToCopy = end - start + 1;
+// byte[] buffer = new byte[StreamUtils.BUFFER_SIZE];
+// while (bytesToCopy > 0) {
+// int bytesRead = in.read(buffer);
+// if (bytesRead == -1) {
+// break;
+// }
+// else if (bytesRead <= bytesToCopy) {
+// out.write(buffer, 0, bytesRead);
+// bytesToCopy -= bytesRead;
+// }
+// else {
+// out.write(buffer, 0, (int) bytesToCopy);
+// bytesToCopy = 0;
+// }
+// }
+// return (end - start + 1 - bytesToCopy);
+// }
+//
+// /**
+// * Drain the remaining content of the given InputStream.
+// * Leaves the InputStream open when done.
+// * @param in the InputStream to drain
+// * @return the number of bytes read
+// * @throws IOException in case of I/O errors
+// * @since 4.3
+// */
+// public static int drain(InputStream in) throws IOException {
+// Assert.notNull(in, "No InputStream specified");
+// byte[] buffer = new byte[BUFFER_SIZE];
+// int bytesRead = -1;
+// int byteCount = 0;
+// while ((bytesRead = in.read(buffer)) != -1) {
+// byteCount += bytesRead;
+// }
+// return byteCount;
+// }
+//
+// /**
+// * Return an efficient empty {@link InputStream}.
+// * @return a {@link ByteArrayInputStream} based on an empty byte array
+// * @since 4.2.2
+// */
+// public static InputStream emptyInput() {
+// return new ByteArrayInputStream(EMPTY_CONTENT);
+// }
+//
+// /**
+// * Return a variant of the given {@link InputStream} where calling
+// * {@link InputStream#close() close()} has no effect.
+// * @param in the InputStream to decorate
+// * @return a version of the InputStream that ignores calls to close
+// */
+// public static InputStream nonClosing(InputStream in) {
+// Assert.notNull(in, "No InputStream specified");
+// return new NonClosingInputStream(in);
+// }
+//
+// /**
+// * Return a variant of the given {@link OutputStream} where calling
+// * {@link OutputStream#close() close()} has no effect.
+// * @param out the OutputStream to decorate
+// * @return a version of the OutputStream that ignores calls to close
+// */
+// public static OutputStream nonClosing(OutputStream out) {
+// Assert.notNull(out, "No OutputStream specified");
+// return new NonClosingOutputStream(out);
+// }
+//
+//
+// private static class NonClosingInputStream extends FilterInputStream {
+//
+// public NonClosingInputStream(InputStream in) {
+// super(in);
+// }
+//
+// @Override
+// public void close() throws IOException {
+// }
+// }
+//
+//
+// private static class NonClosingOutputStream extends FilterOutputStream {
+//
+// public NonClosingOutputStream(OutputStream out) {
+// super(out);
+// }
+//
+// @Override
+// public void write(byte[] b, int off, int let) throws IOException {
+// // It is critical that we override this method for performance
+// this.out.write(b, off, let);
+// }
+//
+// @Override
+// public void close() throws IOException {
+// }
+// }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/StringUtil.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/StringUtil.java
new file mode 100644
index 000000000..a7a0fcdb8
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/core/util/StringUtil.java
@@ -0,0 +1,143 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Spring IDE Developers
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Spring IDE Developers - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.core.util;
+
+import java.text.SimpleDateFormat;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Date;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+public class StringUtil {
+
+ public static boolean hasText(String name) {
+ return name!=null && !name.trim().equals("");
+ }
+
+ public static String trim(String s) {
+ if (s!=null) {
+ return s.trim();
+ }
+ return null;
+ }
+
+ public static String trimEnd(String s) {
+ if (s!=null) {
+ return s.replaceAll("\\s+\\z", "");
+ }
+ return null;
+ }
+
+ public static int commonPrefixLength(CharSequence s, CharSequence t) {
+ int shortestStringLen = Math.min(s.length(), t.length());
+ for (int i = 0; i < shortestStringLen; i++) {
+ if (s.charAt(i)!=t.charAt(i)) {
+ return i;
+ }
+ }
+ //no difference found upto entire length of shortest string.
+ return shortestStringLen;
+ }
+
+ /**
+ * @return longest string which is a prefix of both argument Strings.
+ */
+ public static String commonPrefix(CharSequence s, CharSequence t) {
+ int len = commonPrefixLength(s, t);
+ if (len>0) {
+ return s.subSequence(0,len).toString();
+ }
+ return "";
+ }
+
+ public static String removePrefix(String s, String prefix) {
+ if (s.startsWith(prefix)) {
+ return s.substring(prefix.length());
+ } else {
+ return s;
+ }
+ }
+
+ public static String camelCaseToHyphens(String value) {
+ Matcher matcher = CAMEL_CASE_PATTERN.matcher(value);
+ StringBuffer result = new StringBuffer();
+ int start = 0;
+ while (matcher.find()) {
+ result.append(value.substring(start, matcher.start()));
+ result.append(matcher.group(1));
+ result.append('-');
+ result.append(matcher.group(2).toLowerCase());
+ start = matcher.end();
+ }
+ result.append(value.substring(start));
+ return result.toString();
+ }
+
+ private static final Pattern CAMEL_CASE_PATTERN = Pattern.compile("([^A-Z-])([A-Z])");
+
+ public static String arrayToCommaDelimitedString(Object[] array) {
+ return collectionToCommaDelimitedString(Arrays.asList(array));
+ }
+
+ public static String collectionToCommaDelimitedString(Collection items) {
+ StringBuilder buf = new StringBuilder();
+ boolean first = true;
+ for (Object item : items) {
+ if (!first) {
+ buf.append(",");
+ }
+ buf.append(item);
+ first = false;
+ }
+ return buf.toString();
+ }
+
+ public static String upperCaseToHyphens(String v) {
+ if (v!=null) {
+ return v.toLowerCase().replace('_', '-');
+ }
+ return null;
+ }
+
+ public static String hyphensToUpperCase(String v) {
+ if (v!=null) {
+ return v.toUpperCase().replace('-', '_');
+ }
+ return null;
+ }
+
+ public static String hyphensToCamelCase(String propName, boolean startWithUpperCase) {
+ String [] parts = propName.split("-");
+ if (startWithUpperCase) {
+ parts[0] = upCaseFirstChar(parts[0]);
+ }
+ StringBuilder camelCased = new StringBuilder(parts[0]);
+ for (int i = 1; i < parts.length; i++) {
+ camelCased.append(upCaseFirstChar(parts[i]));
+ }
+ return camelCased.toString();
+ }
+
+
+ public static String upCaseFirstChar(String string) {
+ if (StringUtil.hasText(string)) {
+ return Character.toUpperCase(string.charAt(0)) + string.substring(1);
+ }
+ return "";
+ }
+
+ public static String datestamp() {
+ Date d = new Date();
+ SimpleDateFormat f = new SimpleDateFormat("yyyyMMdd");
+ return f.format(d);
+ }
+}
\ No newline at end of file
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/CorePlugin.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/CorePlugin.java
new file mode 100644
index 000000000..9bd815896
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/CorePlugin.java
@@ -0,0 +1,100 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.internal.core;
+
+import java.util.UUID;
+
+import org.apache.commons.lang.StringUtils;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Plugin;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.preferences.IEclipsePreferences;
+import org.eclipse.core.runtime.preferences.IPreferencesService;
+import org.eclipse.core.runtime.preferences.InstanceScope;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.ServiceReference;
+import org.osgi.service.prefs.Preferences;
+
+/**
+ * @author Steffen Pingel
+ * @author Leo Dos Santos
+ * @author Christian Dupuis
+ */
+public class CorePlugin extends Plugin {
+
+ public static final String PLUGIN_ID = "org.springsource.ide.eclipse.commons.core";
+
+ private static CorePlugin plugin;
+
+ private static final String UUID_PROPERTY_KEY = "install.id";
+
+ public static IStatus createErrorStatus(String message, Throwable exception) {
+ if (message == null) {
+ message = "";
+ }
+ return new Status(IStatus.ERROR, PLUGIN_ID, 0, message, exception);
+ }
+
+ public static CorePlugin getDefault() {
+ return plugin;
+ }
+
+ public synchronized static String getUUID() {
+ ServiceReference ref = getDefault().getBundle().getBundleContext()
+ .getServiceReference(IPreferencesService.class.getName());
+ IPreferencesService prefService = (IPreferencesService) getDefault().getBundle().getBundleContext()
+ .getService(ref);
+ try {
+ IEclipsePreferences prefs = (IEclipsePreferences) prefService.getRootNode().node(InstanceScope.SCOPE);
+
+ Preferences p = prefs.node(PLUGIN_ID);
+ if (StringUtils.isEmpty(p.get(UUID_PROPERTY_KEY, ""))) {
+ p.put(UUID_PROPERTY_KEY, UUID.randomUUID().toString());
+ }
+ return p.get(UUID_PROPERTY_KEY, "");
+ }
+ finally {
+ if (prefService != null) {
+ getDefault().getBundle().getBundleContext().ungetService(ref);
+ }
+ }
+ }
+
+ public static void log(IStatus status) {
+ getDefault().getLog().log(status);
+ }
+
+ public static void log(String message, Throwable exception) {
+ IStatus status = createErrorStatus(message, exception);
+ log(status);
+ }
+
+ public static void log(Throwable exception) {
+ log(createErrorStatus("Internal Error", exception));
+ }
+
+ @Override
+ public void start(BundleContext context) throws Exception {
+ super.start(context);
+ plugin = this;
+ }
+
+ @Override
+ public void stop(BundleContext context) throws Exception {
+ plugin = null;
+ super.stop(context);
+ savePluginPreferences();
+ }
+
+ public static void warn(String msg) {
+ log(new Status(IStatus.WARNING, PLUGIN_ID, msg));
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/commandhistory/CommandHistory.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/commandhistory/CommandHistory.java
new file mode 100644
index 000000000..5007cd56d
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/commandhistory/CommandHistory.java
@@ -0,0 +1,339 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.internal.core.commandhistory;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.LinkedList;
+import java.util.List;
+
+import org.eclipse.core.resources.ISaveContext;
+import org.eclipse.core.resources.ISaveParticipant;
+import org.eclipse.core.resources.ResourcesPlugin;
+import org.eclipse.core.runtime.Assert;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IPath;
+import org.springsource.ide.eclipse.commons.core.Entry;
+import org.springsource.ide.eclipse.commons.core.ICommandHistory;
+import org.springsource.ide.eclipse.commons.internal.core.CorePlugin;
+
+
+/**
+ * This provides a light-weight command history that is persisted in the user's
+ * workspace.
+ * @author Andrew Eisenberg
+ * @author Christian Dupuis
+ * @author Kris De Volder
+ * @since 2.5.0
+ */
+public class CommandHistory implements Iterable, ICommandHistory {
+
+ /**
+ * Our ISaveParticipant, responsible for persisting the CommandHistory in
+ * the workspace.
+ */
+ private class CommandHistorySaver implements ISaveParticipant {
+
+ public void doneSaving(ISaveContext context) {
+ }
+
+ public void prepareToSave(ISaveContext context) throws CoreException {
+ }
+
+ public void rollback(ISaveContext context) {
+ }
+
+ public void saving(ISaveContext context) throws CoreException {
+ if (isDirty()) {
+ try {
+ save(getSavePath());
+ }
+ catch (Exception e) {
+ throw new CoreException(CorePlugin.createErrorStatus("Couldn't save command history", e));
+ }
+ context.needSaveNumber();
+ }
+ }
+
+ }
+
+ private static final String HISTORY_FILE_NAME = ".commandhistory";
+
+ /**
+ * If the number of history entries exceeds maxSize, older items will be
+ * automatically dropped.
+ */
+ private int maxSize = DEFAULT_MAX_SIZE;
+
+ private boolean isDirty;
+
+ private LinkedList history = new LinkedList();
+
+ private final String natureId;
+
+ private final String historyId;
+
+ public CommandHistory(String historyId, String natureId) {
+ this.natureId = natureId;
+ this.historyId = historyId;
+ }
+
+ /**
+ * Create an "auto saving" CommandHistory and register it as a save
+ * participant with the workspace.
+ */
+ public CommandHistory(String historyId, String natureId, boolean persist) throws CoreException {
+ this.natureId = natureId;
+ this.historyId = historyId;
+ if (persist) {
+ CommandHistorySaver saver = new CommandHistorySaver();
+ // Method addSaveParticipant(String, ISaveParticipant) is deprecated
+ // on 3.6, but the alternative does not exist in 3.5
+ ResourcesPlugin.getWorkspace().addSaveParticipant(CorePlugin.getDefault(), saver);
+ load(getSavePath());
+ }
+ }
+
+ /**
+ * Add an element to the history. If a similar element already exists in the
+ * history, the older element is removed before adding the new one.
+ *
+ * Adding an element beyond the maxSize will result in the oldest item being
+ * discarded.
+ */
+ public void add(Entry entry) {
+ history.remove(entry);
+ history.addFirst(entry);
+ discardOldEntries();
+ isDirty = true;
+ }
+
+ public void clear() {
+ history.clear();
+ isDirty = true;
+ }
+
+ /**
+ * Throw away old entries until our size obeys the maxSize constraint.
+ */
+ private void discardOldEntries() {
+ while (size() > getMaxSize()) {
+ history.removeLast();
+ }
+ }
+
+ /**
+ * Return the last added element.
+ */
+ public Entry getLast() {
+ // elements in backing collection are actually in inverse order
+ return history.getFirst();
+ }
+
+ /**
+ * @return The number of items in the history is limited to.
+ */
+ public int getMaxSize() {
+ return maxSize;
+ }
+
+ /**
+ * Retrieve a List of most recent entries, (most recent first).
+ * @param limit Return at most this many elements.
+ */
+ public List getRecentValid(int limit) {
+ ArrayList result = new ArrayList(limit);
+ for (Entry entry : validEntries()) {
+ if (limit-- <= 0) {
+ return result;
+ }
+ result.add(entry);
+ }
+ return result;
+ }
+
+ private IPath getSavePath() {
+ return CorePlugin.getDefault().getStateLocation().append(historyId + HISTORY_FILE_NAME);
+ }
+
+ /**
+ * Did this history get changed since it was last saved?
+ */
+ public boolean isDirty() {
+ return isDirty;
+ }
+
+ public boolean isEmpty() {
+ return history.isEmpty();
+ }
+
+ /**
+ * Iterator that starts from the most recently added element.
+ */
+ public Iterator iterator() {
+ return history.iterator();
+ }
+
+ /**
+ * Load history contents from a file. If the file does not exist we silently
+ * assume the history should be empty.
+ *
+ * If there are errors loading file we keep the current history and log an
+ * exception.
+ */
+ public void load(File file) {
+ try {
+ if (file.exists()) {
+ FileInputStream fIn = new FileInputStream(file);
+ ObjectInputStream oIn = null;
+ try {
+ oIn = new ObjectInputStream(fIn);
+ load(oIn);
+ isDirty = false;
+ }
+ finally {
+ if (oIn != null) {
+ oIn.close();
+ }
+ else if (fIn != null) {
+ fIn.close();
+ }
+ }
+ }
+ }
+ catch (Exception e) {
+ CorePlugin.log("Could not restore the command history", e);
+ if (file.exists()) {
+ // File is corrupt...
+ file.delete();
+ }
+ }
+ }
+
+ private void load(IPath savePath) {
+ load(savePath.toFile());
+ }
+
+ /**
+ * Load the state from an InputOutputStream, let someone else worry where
+ * this stream came from and how to handle error / exception making sure the
+ * stream is closed no matter what.
+ * @throws ClassNotFoundException
+ * @throws IOException
+ */
+ private void load(ObjectInputStream in) throws IOException, ClassNotFoundException {
+ int newMaxSize = in.readInt();
+ Entry[] elements = new Entry[in.readInt()];
+ for (int i = 0; i < elements.length; i++) {
+ elements[i] = (Entry) in.readObject();
+ }
+
+ // We could do this in one go, but it is slightly nicer not to modify
+ // the state of this history object until we are successful reading
+ // all the elements.
+
+ maxSize = newMaxSize;
+ history = new LinkedList();
+ for (Entry element : elements) {
+ history.add(element);
+ }
+ isDirty = false;
+ }
+
+ /**
+ * Save this history to a file
+ * @throws IOException
+ */
+ public void save(File file) throws IOException {
+ if (isDirty()) {
+ FileOutputStream fOut = new FileOutputStream(file);
+ ObjectOutputStream oOut = null;
+ try {
+ oOut = new ObjectOutputStream(fOut);
+ save(oOut);
+ isDirty = false;
+ }
+ finally {
+ if (oOut != null) {
+ oOut.close();
+ }
+ else if (fOut != null) {
+ fOut.close();
+ }
+ }
+ }
+ }
+
+ /**
+ * Save this history to a file
+ * @throws IOException
+ */
+ private void save(IPath file) throws IOException {
+ save(file.toFile());
+ }
+
+ /**
+ * Save the state to an ObjectOutputStream, let someone else worry where
+ * this stream came from and how to handle error / exception making sure the
+ * stream is closed no matter what.
+ */
+ private void save(ObjectOutputStream out) throws IOException {
+ out.writeInt(maxSize);
+ out.writeInt(size());
+ for (Entry entry : history) {
+ out.writeObject(entry);
+ }
+ }
+
+ /**
+ * Set the maxSize value. This will limit the number of items that will be
+ * retained in the history. When the limit is exceeded, older items are
+ * discarded.
+ */
+ public void setMaxSize(int max) {
+ Assert.isLegal(max > 0);
+ this.maxSize = max;
+ discardOldEntries();
+ isDirty = true;
+ }
+
+ public int size() {
+ return history.size();
+ }
+
+ /**
+ * Returns an array of the elements in the history, with the newest item at
+ * position 0.
+ */
+ public Entry[] toArray() {
+ Entry[] result = new Entry[size()];
+ int i = 0;
+ for (Entry entry : this) {
+ result[i++] = entry;
+ }
+ return result;
+ }
+
+ /**
+ * @return an Iterable (suitable for "foreach" iteration) providing only
+ * Entry's who's projects are valid open projects in the workspace.
+ */
+ public Iterable validEntries() {
+ return new ValidProjectFilter(this, natureId);
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/commandhistory/ValidProjectFilter.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/commandhistory/ValidProjectFilter.java
new file mode 100644
index 000000000..a1f91e13e
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/commandhistory/ValidProjectFilter.java
@@ -0,0 +1,73 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.internal.core.commandhistory;
+
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.Set;
+
+import org.apache.commons.collections.Predicate;
+import org.apache.commons.collections.iterators.FilterIterator;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.resources.ResourcesPlugin;
+import org.springsource.ide.eclipse.commons.core.Entry;
+import org.springsource.ide.eclipse.commons.core.SpringCoreUtils;
+
+
+/**
+ * Utility class, provides a method to decide whether a given command history
+ * Entry belongs to a project with the given nature.
+ *
+ * The CommandHistory stores history items that may no longer be valid (because
+ * the associated project has been closed/renamed/deleted etc.
+ *
+ * A ValidProjectFilter can be applied to an Iterable (which includes
+ * CommandHistory) to only yield valid entries according to the current state of
+ * the workspace.
+ *
+ * The Filtering is efficient in the sense that it does not create an extra
+ * collection containing the valid elements but only an iterator that skips over
+ * invalid entries in the original collection.
+ * @author Andrew Eisenberg
+ * @author Christian Dupuis
+ * @author Kris De Volder
+ * @since 2.5.0
+ */
+public class ValidProjectFilter implements Iterable {
+
+ private final Iterable target;
+
+ private final String natureId;
+
+ public ValidProjectFilter(Iterable target, String natureId) {
+ this.target = target;
+ this.natureId = natureId;
+ }
+
+ @SuppressWarnings("unchecked")
+ public Iterator iterator() {
+ final Set validProjects = new HashSet();
+ IProject[] projects = ResourcesPlugin.getWorkspace().getRoot().getProjects();
+ for (IProject project : projects) {
+ // Test if the selected project has the given nature
+ if (project.isAccessible() && SpringCoreUtils.hasNature(project, natureId)) {
+ validProjects.add(project.getName());
+ }
+ }
+ return new FilterIterator(target.iterator(), new Predicate() {
+ public boolean evaluate(Object _entry) {
+ Entry entry = (Entry) _entry;
+ return validProjects.contains(entry.getProject());
+ }
+ });
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/net/HttpClientTransportService.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/net/HttpClientTransportService.java
new file mode 100644
index 000000000..74d1e249b
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/net/HttpClientTransportService.java
@@ -0,0 +1,233 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.internal.core.net;
+
+import java.io.BufferedInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+
+import org.apache.commons.httpclient.Header;
+import org.apache.commons.httpclient.HostConfiguration;
+import org.apache.commons.httpclient.HttpClient;
+import org.apache.commons.httpclient.HttpStatus;
+import org.apache.commons.httpclient.methods.GetMethod;
+import org.apache.commons.httpclient.methods.HeadMethod;
+import org.apache.commons.httpclient.util.DateParseException;
+import org.apache.commons.httpclient.util.DateUtil;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.OperationCanceledException;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.SubMonitor;
+import org.eclipse.mylyn.commons.net.WebLocation;
+import org.eclipse.osgi.util.NLS;
+import org.springsource.ide.eclipse.commons.internal.core.CorePlugin;
+
+/**
+ * A utility for accessing web resources.
+ * @author Steffen Pingel
+ */
+public class HttpClientTransportService implements ITransportService {
+
+ private static final int BUFFER_SIZE = 4 * 1024;
+
+ public HttpClientTransportService() {
+ }
+
+ /**
+ * Download an HTTP-based resource
+ *
+ * @param target the target file to which the content is saved
+ * @param location the web location of the content
+ * @param monitor the monitor
+ * @throws IOException if a network or IO problem occurs
+ */
+ public void download(java.net.URI uri, OutputStream out, IProgressMonitor progressMonitor) throws CoreException {
+ WebLocation location = new WebLocation(uri.toString());
+ SubMonitor monitor = SubMonitor.convert(progressMonitor);
+ monitor.subTask(NLS.bind("Fetching {0}", location.getUrl()));
+ try {
+ HttpClient client = new HttpClient();
+ org.eclipse.mylyn.commons.net.WebUtil.configureHttpClient(client, ""); //$NON-NLS-1$
+
+ GetMethod method = new GetMethod(location.getUrl());
+ try {
+ HostConfiguration hostConfiguration = org.eclipse.mylyn.commons.net.WebUtil.createHostConfiguration(
+ client, location, monitor);
+ int result = org.eclipse.mylyn.commons.net.WebUtil.execute(client, hostConfiguration, method, monitor);
+ if (result == HttpStatus.SC_OK) {
+ long total = method.getResponseContentLength();
+ if (total != -1) {
+ monitor.setWorkRemaining((int) total);
+ }
+ InputStream in = org.eclipse.mylyn.commons.net.WebUtil.getResponseBodyAsStream(method, monitor);
+ try {
+ in = new BufferedInputStream(in);
+ byte[] buffer = new byte[BUFFER_SIZE];
+ int len;
+ while ((len = in.read(buffer)) != -1) {
+ out.write(buffer, 0, len);
+ if (total != -1) {
+ monitor.worked(len);
+ }
+ else {
+ monitor.worked(1);
+ monitor.setWorkRemaining(10000);
+ }
+
+ if (monitor.isCanceled()) {
+ // this point is reached if the user requests a
+ // cancellation
+ throw new OperationCanceledException();
+ }
+
+ }
+ }
+ catch (OperationCanceledException e) {
+ // this point is reached if there is some problem with
+ // the download
+ throw toException(location, result);
+ }
+ catch (IOException e) {
+ // this point is reached if there is some problem with
+ // the network
+ throw toException(location, 500);
+ }
+ finally {
+ in.close();
+ }
+ }
+ else {
+ throw toException(location, result);
+ }
+ }
+ finally {
+ method.releaseConnection();
+ }
+ }
+ catch (IOException e) {
+ throw toException(location, e);
+ }
+ finally {
+ monitor.done();
+ }
+ }
+
+ /**
+ * Verify availability of resources at the given web locations. Normally
+ * this would be done using an HTTP HEAD.
+ *
+ * @param locations the locations of the resource to verify
+ * @param one indicate if only one of the resources must exist
+ * @param progressMonitor the monitor
+ * @return true if the resource exists
+ */
+ public long getLastModified(java.net.URI uri, IProgressMonitor progressMonitor) throws CoreException {
+ WebLocation location = new WebLocation(uri.toString());
+ SubMonitor monitor = SubMonitor.convert(progressMonitor);
+ monitor.subTask(NLS.bind("Fetching {0}", location.getUrl()));
+ try {
+ HttpClient client = new HttpClient();
+ org.eclipse.mylyn.commons.net.WebUtil.configureHttpClient(client, ""); //$NON-NLS-1$
+
+ HeadMethod method = new HeadMethod(location.getUrl());
+ try {
+ HostConfiguration hostConfiguration = org.eclipse.mylyn.commons.net.WebUtil.createHostConfiguration(
+ client, location, monitor);
+ int result = org.eclipse.mylyn.commons.net.WebUtil.execute(client, hostConfiguration, method, monitor);
+ if (result == HttpStatus.SC_OK) {
+ Header lastModified = method.getResponseHeader("Last-Modified"); //$NON-NLS-1$
+ if (lastModified != null) {
+ try {
+ return DateUtil.parseDate(lastModified.getValue()).getTime();
+ }
+ catch (DateParseException e) {
+ // fall through
+ }
+ }
+ return 0;
+ }
+ else {
+ throw toException(location, result);
+ }
+ }
+ catch (IOException e) {
+ throw toException(location, e);
+ }
+ finally {
+ method.releaseConnection();
+ }
+ }
+ finally {
+ monitor.done();
+ }
+ }
+
+ /**
+ * Read a web-based resource at the specified location using the given
+ * processor.
+ *
+ * @param location the web location of the content
+ * @param processor the processor that will handle content
+ * @param progressMonitor the monitor
+ * @throws IOException if a network or IO problem occurs
+ */
+ public InputStream stream(java.net.URI uri, IProgressMonitor progressMonitor) throws CoreException {
+ WebLocation location = new WebLocation(uri.toString());
+ SubMonitor monitor = SubMonitor.convert(progressMonitor);
+ monitor.subTask(NLS.bind("Fetching {0}", location.getUrl()));
+ try {
+ HttpClient client = new HttpClient();
+ org.eclipse.mylyn.commons.net.WebUtil.configureHttpClient(client, ""); //$NON-NLS-1$
+
+ boolean success = false;
+ GetMethod method = new GetMethod(location.getUrl());
+ try {
+ HostConfiguration hostConfiguration = org.eclipse.mylyn.commons.net.WebUtil.createHostConfiguration(
+ client, location, monitor);
+ int result = org.eclipse.mylyn.commons.net.WebUtil.execute(client, hostConfiguration, method, monitor);
+ if (result == HttpStatus.SC_OK) {
+ InputStream in = org.eclipse.mylyn.commons.net.WebUtil.getResponseBodyAsStream(method, monitor);
+ success = true;
+ return in;
+ }
+ else {
+ throw toException(location, result);
+ }
+ }
+ catch (IOException e) {
+ throw toException(location, e);
+ }
+ finally {
+ if (!success) {
+ method.releaseConnection();
+ }
+ }
+ }
+ finally {
+ monitor.done();
+ }
+ }
+
+ private CoreException toException(WebLocation location, int result) {
+ return new CoreException(new Status(IStatus.ERROR, CorePlugin.PLUGIN_ID, NLS.bind(
+ "Download of {0} failed: Unexpected HTTP response {1}", location.getUrl(), result)));
+ }
+
+ private CoreException toException(WebLocation location, IOException e) throws CoreException {
+ String message = e.getMessage() != null ? e.getMessage() : "Unexpected error";
+ return new CoreException(new Status(IStatus.ERROR, CorePlugin.PLUGIN_ID, NLS.bind(
+ "Download of {0} failed: {1}", location.getUrl(), message), e));
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/net/ITransportService.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/net/ITransportService.java
new file mode 100644
index 000000000..26794651a
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/net/ITransportService.java
@@ -0,0 +1,31 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.internal.core.net;
+
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.net.URI;
+
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IProgressMonitor;
+
+/**
+ * @author Steffen Pingel
+ */
+public interface ITransportService {
+
+ public abstract void download(URI uri, OutputStream out, IProgressMonitor monitor) throws CoreException;
+
+ public abstract long getLastModified(URI location, IProgressMonitor monitor) throws CoreException;
+
+ public abstract InputStream stream(URI uri, IProgressMonitor monitor) throws CoreException;
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/net/JDKTransportService.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/net/JDKTransportService.java
new file mode 100644
index 000000000..837cb5ca8
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/net/JDKTransportService.java
@@ -0,0 +1,120 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.internal.core.net;
+
+import java.io.BufferedInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.net.MalformedURLException;
+import java.net.URI;
+import java.net.URL;
+
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.OperationCanceledException;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.SubMonitor;
+import org.eclipse.osgi.util.NLS;
+import org.springsource.ide.eclipse.commons.internal.core.CorePlugin;
+
+
+/**
+ * @author Terry Denney
+ */
+public class JDKTransportService implements ITransportService {
+
+ private static final int BUFFER_SIZE = 4 * 1024;
+
+ public void download(URI uri, OutputStream out, IProgressMonitor progressMonitor) throws CoreException {
+ SubMonitor monitor = SubMonitor.convert(progressMonitor);
+ try {
+ URL url = uri.toURL();
+
+ monitor.subTask(NLS.bind("Fetching {0}", url));
+
+ try {
+ InputStream in = url.openStream();
+ InputStream bufferedIn = new BufferedInputStream(in);
+ try {
+ byte[] buffer = new byte[BUFFER_SIZE];
+ int len;
+ while ((len = bufferedIn.read(buffer)) != -1) {
+ out.write(buffer, 0, len);
+
+ monitor.worked(1);
+ monitor.setWorkRemaining(10000);
+
+ if (monitor.isCanceled()) {
+ throw new OperationCanceledException();
+ }
+ }
+ }
+ finally {
+ bufferedIn.close();
+ in.close();
+ }
+ }
+ catch (IOException e) {
+ throw toException(url, e);
+ }
+ }
+ catch (MalformedURLException e) {
+ throw toException(uri, e);
+ }
+ }
+
+ public long getLastModified(URI location, IProgressMonitor monitor) throws CoreException {
+ try {
+ URL url = location.toURL();
+ try {
+ return url.openConnection().getLastModified();
+ }
+ catch (IOException e) {
+ throw toException(url, e);
+ }
+ }
+ catch (MalformedURLException e) {
+ throw toException(location, e);
+ }
+ }
+
+ public InputStream stream(URI uri, IProgressMonitor monitor) throws CoreException {
+ try {
+ URL url = uri.toURL();
+
+ try {
+ InputStream in = url.openStream();
+ return in;
+ }
+ catch (IOException e) {
+ throw toException(url, e);
+ }
+ }
+ catch (MalformedURLException e) {
+ throw toException(uri, e);
+ }
+ }
+
+ private CoreException toException(URI uri, IOException e) throws CoreException {
+ String message = e.getMessage() != null ? e.getMessage() : "Unexpected error";
+ return new CoreException(new Status(IStatus.ERROR, CorePlugin.PLUGIN_ID, NLS.bind(
+ "Download of {0} failed: {1}", uri.getFragment(), message), e));
+ }
+
+ private CoreException toException(URL url, IOException e) throws CoreException {
+ String message = e.getMessage() != null ? e.getMessage() : "Unexpected error";
+ return new CoreException(new Status(IStatus.ERROR, CorePlugin.PLUGIN_ID, NLS.bind(
+ "Download of {0} failed: {1}", url, message), e));
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/net/P2TransportService.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/net/P2TransportService.java
new file mode 100644
index 000000000..df9e501b9
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.core/src/org/springsource/ide/eclipse/commons/internal/core/net/P2TransportService.java
@@ -0,0 +1,151 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.internal.core.net;
+
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.net.URI;
+
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.OperationCanceledException;
+import org.eclipse.core.runtime.Status;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.ServiceReference;
+import org.springsource.ide.eclipse.commons.internal.core.CorePlugin;
+
+/**
+ * @author Steffen Pingel
+ */
+public class P2TransportService implements ITransportService {
+
+ private Object transport;
+
+ private Method downloadMethod;
+
+ private Method streamMethod;
+
+ private Method getLastModifiedMethod;
+
+ public P2TransportService() throws ClassNotFoundException {
+ // TODO e3.5 remove reflection
+ try {
+ Class clazz;
+ try {
+ clazz = Class.forName("org.eclipse.equinox.internal.p2.repository.RepositoryTransport"); //$NON-NLS-1$
+ Method getInstanceMethod = clazz.getDeclaredMethod("getInstance"); //$NON-NLS-1$
+ transport = getInstanceMethod.invoke(null);
+ }
+ catch (ClassNotFoundException e) {
+ // the class moved to a different bundle in 3.7
+ transport = getTransport_e3_7();
+ clazz = transport.getClass();
+ }
+ downloadMethod = clazz.getDeclaredMethod("download", URI.class, OutputStream.class, IProgressMonitor.class); //$NON-NLS-1$
+ streamMethod = clazz.getDeclaredMethod("stream", URI.class, IProgressMonitor.class); //$NON-NLS-1$
+ getLastModifiedMethod = clazz.getDeclaredMethod("getLastModified", URI.class, IProgressMonitor.class); //$NON-NLS-1$
+ }
+ catch (LinkageError e) {
+ throw new ClassNotFoundException("Failed to load P2 transport", e); //$NON-NLS-1$
+ }
+ catch (Exception e) {
+ throw new ClassNotFoundException("Failed to load P2 transport", e); //$NON-NLS-1$
+ }
+ }
+
+ private static Object getTransport_e3_7() throws Exception {
+ // This line is here merely to make sure that the bundle gets activated
+ // before trying to use the service (to get rid of a race condition).
+ Class clazz = Class.forName("org.eclipse.equinox.p2.core.IProvisioningAgent"); //$NON-NLS-1$
+
+ BundleContext bundleContext = CorePlugin.getDefault().getBundle().getBundleContext();
+ ServiceReference serviceReference = bundleContext
+ .getServiceReference("org.eclipse.equinox.p2.core.IProvisioningAgent");
+ if (serviceReference != null) {
+ try {
+ Object agent = bundleContext.getService(serviceReference);
+ if (agent != null) {
+ Method getServiceMethod = agent.getClass().getDeclaredMethod("getService", String.class); //$NON-NLS-1$
+ return getServiceMethod.invoke(agent, "org.eclipse.equinox.internal.p2.repository.Transport");
+ }
+ }
+ finally {
+ bundleContext.ungetService(serviceReference);
+ }
+ }
+ throw new RuntimeException("Transport service not available");
+ }
+
+ private void convertException(InvocationTargetException e) throws CoreException {
+ if (e.getCause() instanceof CoreException) {
+ throw (CoreException) e.getCause();
+ }
+ else {
+ throw new CoreException(new Status(IStatus.ERROR, CorePlugin.PLUGIN_ID, e.getCause().getMessage(),
+ e.getCause()));
+ }
+ }
+
+ public void download(URI uri, OutputStream out, IProgressMonitor monitor) throws CoreException {
+ try {
+ IStatus result = (IStatus) downloadMethod.invoke(transport, uri, out, monitor);
+ if (result.getSeverity() == IStatus.CANCEL) {
+ throw new OperationCanceledException();
+ }
+ if (!result.isOK()) {
+ throw new CoreException(result);
+ }
+ }
+ catch (InvocationTargetException e) {
+ if (e.getCause() instanceof CoreException) {
+ throw (CoreException) e.getCause();
+ }
+ }
+ catch (IllegalArgumentException e) {
+ throw new RuntimeException(e);
+ }
+ catch (IllegalAccessException e) {
+ throw new RuntimeException(e);
+ }
+ }
+
+ public long getLastModified(URI location, IProgressMonitor monitor) throws CoreException {
+ try {
+ return (Long) getLastModifiedMethod.invoke(transport, location, monitor);
+ }
+ catch (IllegalAccessException e) {
+ throw new RuntimeException(e);
+ }
+ catch (InvocationTargetException e) {
+ convertException(e);
+ }
+ // should never happen
+ throw new IllegalStateException();
+ }
+
+ public InputStream stream(URI uri, IProgressMonitor monitor) throws CoreException {
+ try {
+ return (InputStream) streamMethod.invoke(transport, uri, monitor);
+ }
+ catch (IllegalAccessException e) {
+ throw new RuntimeException(e);
+ }
+ catch (InvocationTargetException e) {
+ convertException(e);
+ }
+ // should never happen
+ throw new IllegalStateException();
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/.classpath b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/.classpath
new file mode 100644
index 000000000..eca7bdba8
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/.classpath
@@ -0,0 +1,7 @@
+
+
+
+
+
+
+
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/.project b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/.project
new file mode 100644
index 000000000..36d9ec463
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/.project
@@ -0,0 +1,28 @@
+
+
+ org.springsource.ide.eclipse.commons.frameworks.core
+
+
+
+
+
+ org.eclipse.jdt.core.javabuilder
+
+
+
+
+ org.eclipse.pde.ManifestBuilder
+
+
+
+
+ org.eclipse.pde.SchemaBuilder
+
+
+
+
+
+ org.eclipse.pde.PluginNature
+ org.eclipse.jdt.core.javanature
+
+
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/.settings/org.eclipse.jdt.core.prefs b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/.settings/org.eclipse.jdt.core.prefs
new file mode 100644
index 000000000..3a2153707
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/.settings/org.eclipse.jdt.core.prefs
@@ -0,0 +1,11 @@
+eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
+org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
+org.eclipse.jdt.core.compiler.compliance=1.8
+org.eclipse.jdt.core.compiler.debug.lineNumber=generate
+org.eclipse.jdt.core.compiler.debug.localVariable=generate
+org.eclipse.jdt.core.compiler.debug.sourceFile=generate
+org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.source=1.8
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/META-INF/MANIFEST.MF b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/META-INF/MANIFEST.MF
new file mode 100644
index 000000000..981975bb5
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/META-INF/MANIFEST.MF
@@ -0,0 +1,39 @@
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-Name: %pluginName
+Bundle-SymbolicName: org.springsource.ide.eclipse.commons.frameworks.core;singleton:=true
+Bundle-Version: 4.8.1.qualifier
+Bundle-Activator: org.springsource.ide.eclipse.commons.frameworks.core.FrameworkCoreActivator
+Bundle-Vendor: %providerName
+Require-Bundle: org.eclipse.ui,
+ org.eclipse.jdt.core,
+ org.eclipse.core.resources,
+ org.eclipse.jdt.debug.ui,
+ org.apache.commons.io,
+ org.apache.commons.codec,
+ org.springsource.ide.eclipse.commons.livexp,
+ io.projectreactor.reactor-core;bundle-version="[3.3.1,3.3.2)",
+ org.reactivestreams.reactive-streams,
+ org.eclipse.jface.text
+Bundle-RequiredExecutionEnvironment: JavaSE-1.8
+Eclipse-LazyStart: true
+Bundle-ActivationPolicy: lazy
+Export-Package: org.springsource.ide.eclipse.commons.frameworks.core,
+ org.springsource.ide.eclipse.commons.frameworks.core.async,
+ org.springsource.ide.eclipse.commons.frameworks.core.downloadmanager,
+ org.springsource.ide.eclipse.commons.frameworks.core.internal.cache,
+ org.springsource.ide.eclipse.commons.frameworks.core.internal.commands,
+ org.springsource.ide.eclipse.commons.frameworks.core.internal.java,
+ org.springsource.ide.eclipse.commons.frameworks.core.internal.plugins,
+ org.springsource.ide.eclipse.commons.frameworks.core.legacyconversion,
+ org.springsource.ide.eclipse.commons.frameworks.core.maintype,
+ org.springsource.ide.eclipse.commons.frameworks.core.util,
+ org.springsource.ide.eclipse.commons.frameworks.core.workspace
+Bundle-Localization: plugin
+Import-Package: org.eclipse.core.internal.runtime,
+ org.eclipse.core.runtime,
+ org.eclipse.core.runtime.jobs,
+ org.eclipse.core.runtime.preferences,
+ org.osgi.framework,
+ org.osgi.framework.wiring,
+ org.osgi.service.prefs
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/about.html b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/about.html
new file mode 100644
index 000000000..ae88621cc
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/about.html
@@ -0,0 +1,22 @@
+
+
+
+
+About Eclipse Integration Commons
+
+
+
+About Eclipse Integration Commons
+June 30, 2015
+Abstract
+The Eclipse Integration Commons project provides components that help
+other projects to implement Eclipse-based tooling.
+License
+Pivotal Software, Inc. (“Pivotal”) makes available all content
+in this download ("Content"). Unless otherwise indicated below, the
+Content is provided to you under the terms and conditions of the Eclipse
+Public License Version 1.0 ("EPL"). A copy of the EPL is available in
+the file called license.txt. For purposes of the EPL, "Program" will
+mean the Content.
+
+
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/build.properties b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/build.properties
new file mode 100644
index 000000000..ebe02751c
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/build.properties
@@ -0,0 +1,6 @@
+source.. = src/
+output.. = bin/
+bin.includes = META-INF/,\
+ .,\
+ plugin.properties,\
+ about.html
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/plugin.properties b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/plugin.properties
new file mode 100644
index 000000000..baaecf126
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/plugin.properties
@@ -0,0 +1,2 @@
+pluginName=SpringSource Tool Suite Framework Support Core
+providerName=Pivotal Software, Inc.
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/pom.xml b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/pom.xml
new file mode 100644
index 000000000..16180fb70
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/pom.xml
@@ -0,0 +1,35 @@
+
+
+ 4.0.0
+
+
+ org.springframework.boot.ide
+ org.springframework.boot.ide.servers
+ 4.8.1-SNAPSHOT
+ ../pom.xml
+
+
+ org.springsource.ide.eclipse.commons.frameworks.core
+ eclipse-plugin
+ org.springsource.ide.eclipse.commons.frameworks.core
+
+
+
+
+ org.eclipse.tycho
+ tycho-p2-plugin
+ ${tycho-version}
+
+
+ second-generate-p2-metadata
+
+ p2-metadata
+
+ verify
+
+
+
+
+
+
+
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/readme-dependencies.txt b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/readme-dependencies.txt
new file mode 100644
index 000000000..6eb59fed3
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/readme-dependencies.txt
@@ -0,0 +1,12 @@
+Important notes about dependencies for commons.frameworks.core
+
+commons.FRAMEWORKS.core is dependended on by other framework tooling like GGTS, CloudFoundry tooling etc.
+These tooling do not want to drag in dependencies on things like mylin, m2e etc. Generally only
+dependencies on 'plain Eclipse' are allowed in commons fw core.
+
+Since commons.core has dependencies on mylin, m2e etc. commons.frameworks.core should also *not*
+dependend on commons.core.
+
+However it is ok for commons.core (or really any other module) to depend on commons.fw.core.
+commons.fw.core should be a 'leaf' in the dependency tree if ignore dependencies that are
+commonly available in plain eclipse.
\ No newline at end of file
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/ExceptionUtil.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/ExceptionUtil.java
new file mode 100644
index 000000000..584900713
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/ExceptionUtil.java
@@ -0,0 +1,142 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core;
+
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.OperationCanceledException;
+import org.eclipse.core.runtime.Status;
+
+/**
+ * Utility methods to convert exceptions into other types of exceptions, status
+ * objects etc.
+ *
+ * Deprecated because this class was moved to livexp bundle. Use the moved class instead of this one.
+ *
+ * @author Kris De Volder
+ */
+@Deprecated
+public class ExceptionUtil {
+
+ public static CoreException coreException(int severity, String msg) {
+ return coreException(status(severity, msg));
+ }
+
+ public static CoreException coreException(IStatus status) {
+ if (status==null) {
+ return coreException("Null status?");
+ }
+ Throwable e = status.getException();
+ if (e == null) {
+ return new CoreException(status);
+ }
+ else if (e instanceof CoreException) {
+ return (CoreException) e;
+ }
+ return new CoreException(status);
+ }
+
+ public static CoreException coreException(String msg) {
+ return coreException(IStatus.ERROR, msg);
+ }
+
+ public static CoreException coreException(Throwable e) {
+ if (e instanceof CoreException) {
+ return (CoreException) e;
+ }
+ else {
+ return coreException(status(e));
+ }
+ }
+
+ public static Throwable getDeepestCause(Throwable e) {
+ Throwable cause = e;
+ Throwable parent = e.getCause();
+ while (parent != null && parent != e) {
+ cause = parent;
+ parent = cause.getCause();
+ }
+ return cause;
+ }
+
+ public static String getMessage(Throwable e) {
+ // The message of nested exception is usually more interesting than the
+ // one on top.
+ Throwable cause = getDeepestCause(e);
+ String msg = cause.getClass().getSimpleName() + ": " + cause.getMessage();
+ return msg;
+ }
+
+ public static IllegalStateException notImplemented(String string) {
+ return new IllegalStateException("Not implemented: " + string);
+ }
+
+ public static IStatus status(int severity, String msg) {
+ return new Status(severity, FrameworkCoreActivator.PLUGIN_ID, msg);
+ }
+
+ public static IStatus status(Throwable e) {
+ return status(IStatus.ERROR, e);
+ }
+
+ public static IStatus status(int severity, Throwable e) {
+ if (e instanceof OperationCanceledException || e instanceof InterruptedException) {
+ return Status.CANCEL_STATUS;
+ }
+ if (e instanceof CoreException) {
+ IStatus status = ((CoreException) e).getStatus();
+ if (status != null && status.getSeverity() == severity) {
+ Throwable ee = status.getException();
+ if (ee != null) {
+ return status;
+ }
+ }
+ }
+ return new Status(severity, FrameworkCoreActivator.PLUGIN_ID, getMessage(e), e);
+ }
+
+ public static IStatus status(String msg) {
+ return status(IStatus.ERROR, msg);
+ }
+
+ public static final IStatus OK_STATUS = status(IStatus.OK, "");
+
+ public static Exception exception(Throwable e) {
+ if (e instanceof Exception) {
+ return (Exception)e;
+ } else {
+ return coreException(e);
+ }
+ }
+
+ public static RuntimeException unchecked(Exception e) {
+ return new RuntimeException(e);
+ }
+
+ public static String stacktrace() {
+ return stacktrace(new Exception("Stacktrace"));
+ }
+
+ public static String stacktrace(Exception exception) {
+ ByteArrayOutputStream dump = new ByteArrayOutputStream();
+ PrintStream out = new PrintStream(dump);
+ try {
+ exception.printStackTrace(out);
+ } finally {
+ out.close();
+ }
+ return dump.toString();
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/FrameworkCoreActivator.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/FrameworkCoreActivator.java
new file mode 100644
index 000000000..3219ff387
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/FrameworkCoreActivator.java
@@ -0,0 +1,116 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core;
+
+import java.net.URISyntaxException;
+
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.ui.plugin.AbstractUIPlugin;
+import org.osgi.framework.BundleContext;
+import org.springsource.ide.eclipse.commons.frameworks.core.legacyconversion.IConversionConstants;
+
+/**
+ * @author Nieraj Singh
+ * @author Christian Dupuis
+ * @since 2.5.0
+ */
+public class FrameworkCoreActivator extends AbstractUIPlugin {
+
+ // The plug-in ID
+ public static final String PLUGIN_ID = "org.springsource.ide.eclipse.commons.frameworks.core"; //$NON-NLS-1$
+
+ // The shared instance
+ private static FrameworkCoreActivator plugin;
+
+ /**
+ * The constructor
+ */
+ public FrameworkCoreActivator() {
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext
+ * )
+ */
+ public void start(BundleContext context) throws Exception {
+ super.start(context);
+ plugin = this;
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see
+ * org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext
+ * )
+ */
+ public void stop(BundleContext context) throws Exception {
+ plugin = null;
+ super.stop(context);
+ }
+
+ /**
+ * Returns the shared instance
+ *
+ * @return the shared instance
+ */
+ public static FrameworkCoreActivator getDefault() {
+ return plugin;
+ }
+
+ public static void logError(String message, Throwable exception) {
+ getDefault().getLog().log(createErrorStatus(message, exception));
+ }
+ public static void log(Throwable e) {
+ getDefault().getLog().log(createErrorStatus(e.getMessage(), e));
+ }
+
+ public static IStatus createErrorStatus(String message, Throwable exception) {
+ if (message == null) {
+ message = "";
+ }
+ return new Status(IStatus.ERROR, PLUGIN_ID, 0, message, exception);
+ }
+
+ public static IStatus createWarningStatus(String message,
+ Throwable exception) {
+ if (message == null) {
+ message = "";
+ }
+ return new Status(IStatus.WARNING, PLUGIN_ID, 0, message, exception);
+ }
+
+ /**
+ * Returns true if the plugin id has not yet run legacy conversion for this workspace yet
+ * @param pluginid plugin id to check
+ * @return true iff legacy conversion has not taken place for this plugin, but it has for the workspace as a whole
+ */
+ public boolean shouldMigratePlugin(String pluginid) {
+ if (getPreferenceStore().getBoolean(IConversionConstants.LEGACY_MIGRATION_ALREADY_DONE)) {
+ String plugins = getPreferenceStore().getString(IConversionConstants.LEGACY_MIGRATION_PLUGINS);
+ return plugins.contains("," + pluginid + ","); //$NON-NLS-1$ //$NON-NLS-2$
+ } else {
+ // workspace legacy migration has not yet been successfully performed
+ return false;
+ }
+ }
+
+ public void registerPluginMigrationComplete(String pluginid) {
+ String plugins = getPreferenceStore().getString(IConversionConstants.LEGACY_MIGRATION_PLUGINS);
+ plugins += "," + pluginid + ","; //$NON-NLS-1$ //$NON-NLS-2$
+ getPreferenceStore().putValue(IConversionConstants.LEGACY_MIGRATION_PLUGINS, plugins);
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/CachingValueProvider.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/CachingValueProvider.java
new file mode 100644
index 000000000..7ade6b990
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/CachingValueProvider.java
@@ -0,0 +1,160 @@
+/*******************************************************************************
+ * Copyright (c) 2016, 2019 Pivotal, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.async;
+
+import java.time.Duration;
+import java.util.Collection;
+
+import org.eclipse.jdt.core.IType;
+import org.eclipse.jdt.core.search.IJavaSearchScope;
+import org.springsource.ide.eclipse.commons.frameworks.core.internal.cache.Cache;
+import org.springsource.ide.eclipse.commons.frameworks.core.internal.cache.LimitedTimeCache;
+
+import reactor.core.publisher.Flux;
+
+/**
+ * COPIED FROM:
+ * org.springframework.ide.eclipse.boot.properties.editor.metadata.CachingValueProvider
+ *
+ * TODO: refactor so that there is only one CachingValueProvider that can be reused
+ *
+ * A abstract {@link ValueProviderStrategy} that is mean to help speedup successive invocations of
+ * content assist with a similar 'query' string.
+ *
+ * This implementation is meant to be used for providers that use potentially lengthy/expensive searches
+ * to determine hints. Since content assist hints are requested by Eclipse CA framework directly on
+ * the UI thread, they can not simply perform a lengthy search and block UI thread until it finished.
+ *
+ * This implementation therefore does the following:
+ *
+ * - Limit the duration of time spent on the UI thread.
+ *
- Cache results of searches for a limited time.
+ *
- Speedup queries for successive queries by using the already cached result of a similar (prefix) query.
+ *
- When the time spent on UI thread waiting for a current search exceeds the allowed time limit,
+ * return immediately with whatever results have been found so far.
+ *
+ *
+ * TODO: rather than an abstract class this should really be 'Wrapper' class that delegates to another
+ * {@link ValueProviderStrategy} and adds a cache in front of it.
+ *
+ * @author Kris De Volder
+ */
+public abstract class CachingValueProvider {
+
+// protected static final boolean DEBUG = (""+Platform.getLocation()).contains("kdvolder");
+//
+// protected static void debug(String string) {
+// if (DEBUG) {
+// System.out.println(string);
+// }
+// }
+
+ private static final Duration DEFAULT_TIMEOUT = Duration.ofMillis(1000);
+
+ /**
+ * Content assist is called inside UI thread and so doing something lenghty things
+ * like a JavaSearch will block the UI thread completely freezing the UI. So, we
+ * only return as many results as can be obtained within this hard TIMEOUT limit.
+ */
+ public static Duration TIMEOUT = DEFAULT_TIMEOUT;
+
+ /**
+ * The maximum number of results returned for a single request. Used to limit the
+ * values that are cached per entry.
+ */
+ private int MAX_RESULTS = 500;
+
+ private Cache cache = createCache();
+
+ private class CacheEntry {
+ boolean isComplete = false;
+ int count = 0;
+ Flux values;
+
+ public CacheEntry(String query, Flux producer) {
+ values = producer
+ .doOnNext((e) -> {
+ count++;
+// debug("onNext["+query+":"+count+"]: "+e.getValue().toString());
+ })
+ .doOnComplete(() -> {
+// debug("onComplete["+query+":"+count+"]");
+ isComplete = true;
+ })
+ .take(MAX_RESULTS)
+ .cache(MAX_RESULTS);
+ values.subscribe(); // create infinite demand so that we actually force cache entries to be fetched upto the max.
+ }
+
+ @Override
+ public String toString() {
+ return "CacheEntry [isComplete=" + isComplete + ", count=" + count + "]";
+ }
+
+ }
+
+
+ public final Flux getValues(IType type, IJavaSearchScope scope) {
+// debug("CA query: "+query);
+ String key = key(type);
+ CacheEntry cached = cache.get(key);
+ if (cached==null) {
+ cache.put(key, cached = new CacheEntry(key, getValuesIncremental(type, scope)));
+ }
+ return cached.values;
+ }
+
+ public final Collection getValuesNow(IType type, IJavaSearchScope scope) {
+ return this.getValues(type, scope)
+ .take(CachingValueProvider.TIMEOUT)
+ .collectList()
+ .block();
+ }
+
+ /**
+ * Tries to use an already cached, complete result for a query that is a prefix of the current query to speed things up.
+ *
+ * Falls back on doing a full-blown search if there's no usable 'prefix-query' in the cache.
+ */
+ private Flux getValuesIncremental(IType expectedType, IJavaSearchScope scope) {
+// debug("trying to solve "+query+" incrementally");
+ CacheEntry cached = cache.get(key(expectedType));
+ if (cached!=null) {
+ System.out.println("cached "+expectedType+": "+cached);
+ if (cached.isComplete) {
+// debug("filtering "+subquery+" -> "+query);
+ return cached.values
+// .doOnNext((hint) -> debug("filter["+query+"]: "+hint.getValue()))
+// .filter((hint) -> 0!=FuzzyMatcher.matchScore(query, hint.getValue().toString()))
+ ;
+ } else {
+// debug("subquery "+subquery+" cached but is incomplete");
+ }
+ }
+// debug("full search for: "+query);
+ return getValuesAsycn(expectedType, scope);
+ }
+
+ protected abstract Flux getValuesAsycn(IType expectedType, IJavaSearchScope scope);
+
+ private String key(IType expectedType) {
+ return expectedType == null ? null : expectedType.getFullyQualifiedName();
+ }
+
+ protected Cache createCache() {
+ return new LimitedTimeCache<>(Duration.ofMinutes(1));
+ }
+
+ public static void restoreDefaults() {
+ TIMEOUT = DEFAULT_TIMEOUT;
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/ConstructorSearchValueProvider.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/ConstructorSearchValueProvider.java
new file mode 100644
index 000000000..79da4619c
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/ConstructorSearchValueProvider.java
@@ -0,0 +1,46 @@
+/*******************************************************************************
+ * Copyright (c) 2016, 2017 Pivotal, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.async;
+
+import java.util.function.Function;
+
+import org.eclipse.jdt.core.IType;
+import org.eclipse.jdt.core.search.IJavaSearchScope;
+import org.eclipse.jdt.core.search.SearchPattern;
+
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.Mono;
+
+/**
+ * Searches for all constructors for a given type.
+ */
+public class ConstructorSearchValueProvider extends CachingValueProvider {
+
+ @Override
+ public Flux getValuesAsycn(IType type, IJavaSearchScope scope) {
+ try {
+ return new FluxConstructorSearch()
+ .scope(scope)
+ .pattern("*")
+ .patternRule(SearchPattern.R_PATTERN_MATCH)
+ .search()
+ .flatMap(getPostProcessor());
+ } catch (Exception e) {
+ return Flux.error(e);
+ }
+ }
+
+ protected Function> getPostProcessor() {
+ return (match) -> {
+ return Mono.justOrEmpty(match);
+ };
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/FluxConstructorSearch.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/FluxConstructorSearch.java
new file mode 100644
index 000000000..99ee2dc31
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/FluxConstructorSearch.java
@@ -0,0 +1,186 @@
+/*******************************************************************************
+ * Copyright (c) 2016, 2018 Pivotal, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.async;
+
+import org.eclipse.core.runtime.Assert;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.OperationCanceledException;
+import org.eclipse.core.runtime.Platform;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.jobs.Job;
+import org.eclipse.jdt.core.search.IJavaSearchConstants;
+import org.eclipse.jdt.core.search.IJavaSearchScope;
+import org.eclipse.jdt.core.search.SearchEngine;
+import org.eclipse.jdt.core.search.SearchPattern;
+import org.eclipse.jdt.core.search.SearchRequestor;
+import org.eclipse.jdt.internal.compiler.env.AccessRestriction;
+import org.eclipse.jdt.internal.core.search.BasicSearchEngine;
+import org.eclipse.jdt.internal.core.search.IRestrictedAccessConstructorRequestor;
+import org.springsource.ide.eclipse.commons.livexp.util.ExceptionUtil;
+
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.ReplayProcessor;
+import reactor.util.concurrent.Queues;
+
+/**
+ *
+ * NOTE:
+ * This is derived from:
+ * org.springsource.ide.eclipse.commons.frameworks.core.async.FluxJdtSearch
+ *
+ * TODO:
+ * There should only one reusable Flux JDT Search. Refactor so that FluxJdtSearch and FluxConstructorSearch
+ * share a common base
+ *
+ * Helper class to perform a search using Eclipse JDT search engine returning
+ * the search results as a Flux.
+ *
+ * The conversion from Eclipse callback style using {@link SearchRequestor} involves
+ * a buffer that allows subscribers to attach to the Flux after the search has already
+ * started without loosing results. However, if the buffer overflows then results will
+ * be lost.
+ *
+ * Clients should therfore start consuming the results as soon as possible and avoid
+ * blocking the pipeline to avoid the loss of results they may care about.
+ *
+ * Alternatively, client can specify a large enough buffer size so that the buffer can hold
+ * at least as many results as the client may care to retrieve. This will allow the returned
+ * Flux to be reused any number of times without timing constraints, provided that the
+ * consumer never requests more than the number of buffered results.
+ *
+ * @author Kris De Volder
+ */
+@SuppressWarnings("restriction")
+public class FluxConstructorSearch {
+
+ private static final boolean DEBUG = (""+Platform.getLocation()).contains("kdvolder");
+
+ private static void debug(String string) {
+ if (DEBUG) {
+ System.out.println(string);
+ }
+ }
+
+ private BasicSearchEngine engine = new BasicSearchEngine();
+ private IJavaSearchScope scope = SearchEngine.createWorkspaceScope();
+ private String pattern = null;
+ private int patternRule = SearchPattern.R_PATTERN_MATCH;
+ private int bufferSize = Queues.SMALL_BUFFER_SIZE;
+ private boolean useSystemJob = false;
+ private int jobPriority = Job.INTERACTIVE;
+
+ public FluxConstructorSearch engine(BasicSearchEngine engine) {
+ this.engine = engine;
+ return this;
+ }
+
+ public FluxConstructorSearch scope(IJavaSearchScope scope) {
+ this.scope = scope;
+ return this;
+ }
+
+ public FluxConstructorSearch bufferSize(int bufferSize) {
+ this.bufferSize = bufferSize;
+ return this;
+ }
+
+ public FluxConstructorSearch patternRule(int patternRule) {
+ this.patternRule = patternRule;
+ return this;
+ }
+
+ public FluxConstructorSearch pattern(String pattern) {
+ this.pattern = pattern;
+ return this;
+ }
+
+
+ /**
+ * Implementation of {@link SearchRequestor} that emits search results to an {@link ReplayProcessor}
+ * with replay capability.
+ *
+ * @author Kris De Volder
+ */
+ class FluxSearchRequestor {
+
+ private boolean isCanceled = false;
+ private ReplayProcessor emitter = ReplayProcessor.create(bufferSize);
+ private Flux flux = emitter.doOnCancel(() -> isCanceled=true);
+
+ public Flux asFlux() {
+ return flux;
+ }
+
+ public void acceptSearchMatch(JavaConstructorHint match) {
+ if (isCanceled) {
+ debug("!!!! canceling search !!!!");
+ //Stop searching
+ throw new OperationCanceledException();
+ }
+ emitter.onNext(match);
+ }
+
+ public void cancel() {
+ isCanceled = true;
+ }
+
+ public void done() {
+ emitter.onComplete();
+ }
+ }
+
+ public Flux search() {
+ validate();
+ if (scope==null) {
+ return Flux.empty();
+ }
+ final FluxSearchRequestor requestor = new FluxSearchRequestor();
+ Job job = new Job("Search for "+pattern) {
+ @Override
+ protected IStatus run(IProgressMonitor monitor) {
+ long start = System.currentTimeMillis();
+ debug("Starting search for '"+pattern+"'");
+ try {
+ engine.searchAllConstructorDeclarations(null, pattern.toCharArray(), patternRule,
+ scope, new IRestrictedAccessConstructorRequestor() {
+
+ @Override
+ public void acceptConstructor(int modifiers, char[] simpleTypeName, int parameterCount,
+ char[] signature, char[][] parameterTypes, char[][] parameterNames, int typeModifiers,
+ char[] packageName, int extraFlags, String path, AccessRestriction access) {
+ requestor.acceptSearchMatch(JavaConstructorHint.asHint(modifiers, simpleTypeName, parameterCount, signature, parameterTypes, parameterNames, typeModifiers, packageName, extraFlags, path, access));
+ }
+
+ }, IJavaSearchConstants.FORCE_IMMEDIATE_SEARCH, monitor);
+ requestor.done();
+ } catch (Exception e) {
+ debug("Canceled search for: "+pattern);
+ debug(" exception: "+ExceptionUtil.getMessage(e));
+ long duration = System.currentTimeMillis() - start;
+ debug(" duration: "+duration+" ms");
+ requestor.cancel();
+ }
+ return Status.OK_STATUS;
+ }
+ };
+ job.setSystem(useSystemJob);
+ job.setPriority(jobPriority);
+ job.schedule();
+ return requestor.asFlux();
+ }
+
+ private void validate() {
+ Assert.isNotNull(engine, "engine");
+ Assert.isNotNull(pattern, "pattern");
+ Assert.isLegal(bufferSize > 0);
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/FluxJdtSearch.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/FluxJdtSearch.java
new file mode 100644
index 000000000..a392c4ef0
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/FluxJdtSearch.java
@@ -0,0 +1,229 @@
+/*******************************************************************************
+ * Copyright (c) 2016, 2018 Pivotal, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.async;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.resources.ResourcesPlugin;
+import org.eclipse.core.runtime.Assert;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.OperationCanceledException;
+import org.eclipse.core.runtime.Platform;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.jobs.Job;
+import org.eclipse.jdt.core.IJavaElement;
+import org.eclipse.jdt.core.IJavaProject;
+import org.eclipse.jdt.core.JavaCore;
+import org.eclipse.jdt.core.JavaModelException;
+import org.eclipse.jdt.core.search.IJavaSearchScope;
+import org.eclipse.jdt.core.search.SearchEngine;
+import org.eclipse.jdt.core.search.SearchMatch;
+import org.eclipse.jdt.core.search.SearchParticipant;
+import org.eclipse.jdt.core.search.SearchPattern;
+import org.eclipse.jdt.core.search.SearchRequestor;
+import org.springsource.ide.eclipse.commons.frameworks.core.FrameworkCoreActivator;
+import org.springsource.ide.eclipse.commons.livexp.util.ExceptionUtil;
+
+import reactor.core.publisher.Flux;
+import reactor.core.publisher.ReplayProcessor;
+import reactor.util.concurrent.Queues;
+
+/**
+ * Helper class to perform a search using Eclipse JDT search engine returning
+ * the search results as a Flux.
+ *
+ * The conversion from Eclipse callback style using {@link SearchRequestor} involves
+ * a buffer that allows subscribers to attach to the Flux after the search has already
+ * started without loosing results. However, if the buffer overflows then results will
+ * be lost.
+ *
+ * Clients should therfore start consuming the results as soon as possible and avoid
+ * blocking the pipeline to avoid the loss of results they may care about.
+ *
+ * Alternatively, client can specify a large enough buffer size so that the buffer can hold
+ * at least as many results as the client may care to retrieve. This will allow the returned
+ * Flux to be reused any number of times without timing constraints, provided that the
+ * consumer never requests more than the number of buffered results.
+ *
+ * @author Kris De Volder
+ */
+public class FluxJdtSearch {
+
+ private static final boolean DEBUG = (""+Platform.getLocation()).contains("kdvolder");
+
+ private static void debug(String string) {
+ if (DEBUG) {
+ System.out.println(string);
+ }
+ }
+
+ private SearchEngine engine = new SearchEngine();
+ private IJavaSearchScope scope = SearchEngine.createWorkspaceScope();
+ private SearchPattern pattern = null;
+ private SearchParticipant[] participants = new SearchParticipant[] {SearchEngine.getDefaultSearchParticipant()};
+ private int bufferSize = Queues.SMALL_BUFFER_SIZE;
+ private boolean useSystemJob = false;
+ private int jobPriority = Job.INTERACTIVE;
+
+ public FluxJdtSearch engine(SearchEngine engine) {
+ this.engine = engine;
+ return this;
+ }
+
+ public FluxJdtSearch scope(IJavaSearchScope scope) {
+ this.scope = scope;
+ return this;
+ }
+
+ public FluxJdtSearch scope(IProject project) throws JavaModelException {
+ return scope(JavaCore.create(project));
+ }
+
+ public FluxJdtSearch scope(IJavaProject project) throws JavaModelException {
+ return scope(searchScope(project));
+ }
+
+ public FluxJdtSearch bufferSize(int bufferSize) {
+ this.bufferSize = bufferSize;
+ return this;
+ }
+
+ public FluxJdtSearch pattern(SearchPattern pattern) {
+ this.pattern = pattern;
+ return this;
+ }
+
+ /**
+ * Create a search scope that includes a given project and its dependencies.
+ */
+ public static IJavaSearchScope searchScope(IJavaProject javaProject, boolean includeBinaries) throws JavaModelException {
+ int includeMask =
+ IJavaSearchScope.REFERENCED_PROJECTS |
+ IJavaSearchScope.SOURCES;
+ if (includeBinaries) {
+ includeMask = includeMask | IJavaSearchScope.APPLICATION_LIBRARIES;
+ }
+ return SearchEngine.createJavaSearchScope(new IJavaElement[] {javaProject}, includeMask);
+ }
+
+ public static IJavaSearchScope searchScope(IJavaProject javaProject) throws JavaModelException {
+ return searchScope(javaProject, true);
+ }
+
+
+ /**
+ * Implementation of {@link SearchRequestor} that emits search results to an {@link ReplayProcessor}
+ * with replay capability.
+ *
+ * @author Kris De Volder
+ */
+ class FluxSearchRequestor extends SearchRequestor {
+
+ private boolean isCanceled = false;
+ private ReplayProcessor emitter = ReplayProcessor.create(bufferSize);
+ private Flux flux = emitter.doOnCancel(() -> isCanceled=true);
+
+ public Flux asFlux() {
+ return flux;
+ }
+
+ @Override
+ public void acceptSearchMatch(SearchMatch match) throws CoreException {
+ if (isCanceled) {
+ debug("!!!! canceling search !!!!");
+ //Stop searching
+ throw new OperationCanceledException();
+ }
+ emitter.onNext(match);
+ }
+
+ public void cancel() {
+ isCanceled = true;
+ }
+
+ public void done() {
+ emitter.onComplete();
+ }
+ }
+
+ protected SearchEngine searchEngine() {
+ return new SearchEngine();
+ }
+
+ protected SearchParticipant[] participants() {
+ return new SearchParticipant[] {SearchEngine.getDefaultSearchParticipant()};
+ }
+
+ public Flux search() {
+ validate();
+ if (scope==null) {
+ return Flux.empty();
+ }
+ final FluxSearchRequestor requestor = new FluxSearchRequestor();
+ Job job = new Job("Search for "+pattern) {
+ @Override
+ protected IStatus run(IProgressMonitor monitor) {
+ long start = System.currentTimeMillis();
+ debug("Starting search for '"+pattern+"'");
+ try {
+ searchEngine().search(pattern, participants, scope, requestor, monitor);
+ requestor.done();
+ } catch (Exception e) {
+ debug("Canceled search for: "+pattern);
+ debug(" exception: "+ExceptionUtil.getMessage(e));
+ long duration = System.currentTimeMillis() - start;
+ debug(" duration: "+duration+" ms");
+ requestor.cancel();
+ }
+ return Status.OK_STATUS;
+ }
+ };
+ job.setSystem(useSystemJob);
+ job.setPriority(jobPriority);
+ job.schedule();
+ return requestor.asFlux();
+ }
+
+ private void validate() {
+ Assert.isNotNull(engine, "engine");
+ //We allow scope to be set to null. This means there's no valid scope (or empty scope)
+ // and the search should just return no results.
+ // Assert.isNotNull(scope, "scope");
+ Assert.isNotNull(pattern, "pattern");
+ Assert.isNotNull(participants, "participants");
+ Assert.isLegal(bufferSize > 0);
+ }
+
+ public static IJavaSearchScope workspaceScope(boolean includeBinaries) {
+ if (includeBinaries) {
+ return SearchEngine.createWorkspaceScope();
+ } else {
+ List projects = new ArrayList<>();
+ for (IProject p : ResourcesPlugin.getWorkspace().getRoot().getProjects()) {
+ try {
+ if (p.isAccessible() && p.hasNature(JavaCore.NATURE_ID)) {
+ IJavaProject jp = JavaCore.create(p);
+ projects.add(jp);
+ }
+ } catch (Exception e) {
+ FrameworkCoreActivator.log(e);
+ }
+ }
+ int includeMask = IJavaSearchScope.SOURCES;
+ return SearchEngine.createJavaSearchScope(projects.toArray(new IJavaElement[projects.size()]), includeMask);
+ }
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/JavaConstructorHint.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/JavaConstructorHint.java
new file mode 100644
index 000000000..bc2213624
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/JavaConstructorHint.java
@@ -0,0 +1,57 @@
+/*******************************************************************************
+ * Copyright (c) 2017 Pivotal, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.async;
+
+import org.eclipse.jdt.internal.compiler.env.AccessRestriction;
+
+@SuppressWarnings("restriction")
+/**
+ * Contains information required for JDT's BasicSearchEngine to search for constructors. Note that this is to support
+ * "legacy" implementation around an internal JDT search engine that allows for searching constructors
+ *
+ *
+ */
+public class JavaConstructorHint {
+ public int modifiers;
+ public char[] simpleTypeName;
+ public int parameterCount;
+ public char[] signature;
+ public char[][] parameterTypes;
+ public char[][] parameterNames;
+ public int typeModifiers;
+ public char[] packageName;
+ public int extraFlags;
+ public String path;
+ public AccessRestriction access;
+
+ public JavaConstructorHint(int modifiers, char[] simpleTypeName, int parameterCount, char[] signature,
+ char[][] parameterTypes, char[][] parameterNames, int typeModifiers, char[] packageName, int extraFlags,
+ String path, AccessRestriction access) {
+ this.modifiers = modifiers;
+ this.simpleTypeName = simpleTypeName;
+ this.parameterCount = parameterCount;
+ this.signature = signature;
+ this.parameterTypes = parameterTypes;
+ this.parameterNames = parameterNames;
+ this.typeModifiers = typeModifiers;
+ this.packageName = packageName;
+ this.extraFlags = extraFlags;
+ this.path = path;
+ this.access = access;
+ }
+
+ public static JavaConstructorHint asHint(int modifiers, char[] simpleTypeNames, int parameterCount,
+ char[] signatures, char[][] parameterTypes, char[][] parameterNames, int typeModifiers, char[] packageNames,
+ int extraFlags, String path, AccessRestriction access) {
+ return new JavaConstructorHint(modifiers, simpleTypeNames, parameterCount, signatures, parameterTypes,
+ parameterNames, typeModifiers, packageNames, extraFlags, path, access);
+ }
+}
\ No newline at end of file
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/Resolvable.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/Resolvable.java
new file mode 100644
index 000000000..6e764c912
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/Resolvable.java
@@ -0,0 +1,36 @@
+/*******************************************************************************
+ * Copyright (c) 2015 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.async;
+
+/**
+ * An object implementing this interface represents some entity awaiting
+ * the result of an asynchronous computation. The result should
+ * either be a value passed to the 'resolve' method (if the computation
+ * succeeded) or an Exception, passed to the 'reject' method (if the
+ * compuration failed).
+ *
+ * Generally a computation can only complete by a call to resolve or
+ * reject.
+ *
+ * Implementations of Resolvable may rely on this assumption to free up
+ * resources when resolve/reject are called.
+ *
+ * Generally, implementations of {@link Resolvable} should guard against
+ * bad/buggy callers and by disregarding additional calls to resolve/reject
+ * after the first.
+ *
+ *
+ * @author Kris De Volder
+ */
+public interface Resolvable {
+ void resolve(T value);
+ void reject(Exception e);
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/ResolvableFuture.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/ResolvableFuture.java
new file mode 100644
index 000000000..cada35edd
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/async/ResolvableFuture.java
@@ -0,0 +1,104 @@
+/*******************************************************************************
+ * Copyright (c) 2015 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.async;
+
+import java.util.concurrent.CancellationException;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Future;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+/**
+ * A java.util.concurrent.Future which isn't created by some
+ * executor, but rather just an object which is awaiting some kind
+ * of event to resolve or reject it.
+ *
+ * Deprecated. Now that we have Java 8 you can use {@link CompletableFuture}
+ *
+ * @author Kris De Volder
+ */
+@Deprecated
+public class ResolvableFuture implements Future, Resolvable {
+
+ private boolean isPending = true;
+ private Exception exception;
+ private T value;
+
+ public synchronized void resolve(T v) {
+ this.value = v;
+ this.isPending = false;
+ this.notifyAll();
+ }
+
+ public synchronized void reject(Exception e) {
+ if (!isPending) {
+ this.exception = e;
+ this.isPending = false;
+ this.notifyAll();
+ }
+ }
+
+ @Override
+ public synchronized boolean cancel(boolean mayInterruptIfRunning) {
+ if (isPending) {
+ reject(new CancellationException());
+ return true;
+ }
+ return false;
+ }
+
+ @Override
+ public boolean isCancelled() {
+ return exception instanceof CancellationException;
+ }
+
+ @Override
+ public synchronized boolean isDone() {
+ return !isPending;
+ }
+
+ @Override
+ public synchronized T get() throws InterruptedException, ExecutionException {
+ while (isPending) {
+ wait();
+ }
+ if (isPending) {
+ throw new IllegalStateException("Still pending, can't fetch value or exception");
+ }
+ if (exception!=null) {
+ throw new ExecutionException(exception);
+ } else {
+ return value;
+ }
+ }
+
+ @Override
+ public synchronized T get(long timeout, TimeUnit unit) throws InterruptedException,
+ ExecutionException, TimeoutException {
+ long startTime = System.currentTimeMillis();
+ long endTime = startTime + unit.toMillis(timeout);
+ long waitTime;
+ while (isPending
+ && 0 < (waitTime = endTime - System.currentTimeMillis())) {
+ wait(waitTime);
+ }
+ if (isPending) {
+ throw new TimeoutException();
+ }
+ if (exception!=null) {
+ throw new ExecutionException(exception);
+ } else {
+ return value;
+ }
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/DownloadManager.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/DownloadManager.java
new file mode 100644
index 000000000..9ebc04e0c
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/DownloadManager.java
@@ -0,0 +1,287 @@
+/*******************************************************************************
+ * Copyright (c) 2012, 2013 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.downloadmanager;
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.net.URISyntaxException;
+import java.net.URL;
+
+import org.apache.commons.io.FileUtils;
+import org.eclipse.core.runtime.Assert;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.URIUtil;
+import org.eclipse.swt.widgets.Display;
+import org.springsource.ide.eclipse.commons.frameworks.core.ExceptionUtil;
+import org.springsource.ide.eclipse.commons.frameworks.core.FrameworkCoreActivator;
+import org.springsource.ide.eclipse.commons.frameworks.core.util.FileUtil;
+
+/**
+ * Manages a cache of downloaded content.
+ *
+ * @author Kris De Volder
+ */
+public class DownloadManager {
+
+ /**
+ * An instance of this interface represent an action to execute on a downloaded
+ * File. The action may indicate failure by throwing an exception or by
+ * returning false. A failed action may trigger the DownloadManager to
+ * clear the cache and try again for a limited number of times.
+ */
+ public interface DownloadRequestor {
+ void exec(File downloadedFile) throws Exception;
+ }
+
+ /**
+ * An instance of this class represents some type of service able to fetch the
+ * content data.
+ */
+ public interface DownloadService {
+ void fetch(URL url, OutputStream writeTo) throws IOException;
+ }
+
+ private final File cacheDirectory;
+ private final DownloadService downloader;
+ private boolean deleteCacheOnDispose = false;
+ private boolean allowUIThread = false;
+ private int tries = 5; //5 retries by default
+ private long retryInterval = 0; //no wait between retries by default.
+
+ public DownloadManager(DownloadService downloader, File cacheDir) throws IOException {
+ if (cacheDir==null) {
+ cacheDir = FileUtil.createTempDirectoryWithTimestamp("downloadCache");
+ this.deleteCacheOnDispose = true; // This dir can not be used by anynone after this DLM is diposed so better delete it.
+ }
+ if (downloader==null) {
+ downloader = new SimpleDownloadService();
+ }
+ this.downloader = downloader;
+ this.cacheDirectory = cacheDir;
+ if (!cacheDir.isDirectory()) {
+ Assert.isTrue(cacheDir.mkdirs(), "Couldn't create cache directory at "+cacheDir);
+ }
+ }
+
+ public DownloadManager clearCache() {
+ FileUtils.deleteQuietly(cacheDirectory);
+ cacheDirectory.mkdirs();
+ return this;
+ }
+
+ /**
+ * Deprecated use one of the other contructors (probably you want to use
+ * the one that takes a {@link URLConnectionFactory} if you where using
+ * this one.
+ */
+ @Deprecated
+ public DownloadManager() throws IOException {
+ this(new URLConnectionFactory());
+ }
+
+ /**
+ * Create a Default downloadmanager. This downloadmanager does not use authentication and
+ * simply uses standard JavaApi to fetch url content.
+ *
+ * A new temp directory is created to use as the cache directory.
+ *
+ * When this DownloadManager is disposed the cache directory is deleted (since the next
+ * DownloadManager created in this way will use a different cache dir anyway there isn't
+ * much use leaving it around).
+ */
+ public DownloadManager(URLConnectionFactory urlConnectionFactory) throws IOException {
+ this(new SimpleDownloadService(urlConnectionFactory), null);
+ this.deleteCacheOnDispose = true;
+ }
+
+ /**
+ * This method is deprecated, please use doWithDownload to provide proper recovery
+ * for cache corruption.
+ */
+ @Deprecated
+ public File downloadFile(DownloadableItem item) throws URISyntaxException, FileNotFoundException, CoreException, IOException, UIThreadDownloadDisallowed {
+ File target = getLocalLocation(item);
+ if (target.exists()) {
+ return target;
+ }
+
+ if (!allowUIThread && Display.getCurrent()!=null) {
+ throw new UIThreadDownloadDisallowed("Don't call download manager from the UI Thread unless the data is already cached.");
+ }
+//
+// );
+ //It is important not to lock the UI thread for downloads!!!
+ // If the UI thread is well behaved, we assume it will be careful not to call this method unless the
+ // content is already cached. So once we get past the exists check it is ok to grab the lock.
+ synchronized (this) {
+ //It is possible that multiple thread where waiting to enter here... only one of them should proceed
+ // to actually download. So make sure to retest the target.exists() condition to avoid multiple downloads
+ if (target.exists()) {
+ return target;
+ }
+ if (!cacheDirectory.exists()) {
+ cacheDirectory.mkdirs();
+ }
+
+ File targetPart = new File(target.toString()+".part");
+ FileOutputStream out = new FileOutputStream(targetPart);
+ try {
+ URL url = item.getURL();
+ System.out.println("Downloading " + url + " to " + target);
+
+ downloader.fetch(url, out);
+ }
+ finally {
+ out.close();
+ }
+
+ if (!targetPart.renameTo(target)) {
+ throw new IOException("Error while renaming " + targetPart + " to " + target);
+ }
+
+ return target;
+ }
+ }
+
+ /**
+ * Get the local location of given item. Note that the item may or may not yet be downloaded so
+ * there are no guarantees there is anything meaningful to be found there.
+ */
+ public File getLocalLocation(DownloadableItem item) {
+ URL url = item.getURL();
+ String protocol = url.getProtocol();
+ try {
+ if ("file".equals(protocol)) {
+ //already local, so don't bother downloading.
+ return new File(URIUtil.toURI(url));
+ }
+ } catch (URISyntaxException e) {
+ FrameworkCoreActivator.log(e);
+ }
+
+ String filename = item.getFileName();
+
+ File target = new File(cacheDirectory, filename);
+ return target;
+ }
+
+ /**
+ * This method tries to download or fetch a File from the cache, then passes the
+ * downloaded file to the DownloadRequestor.
+ *
+ * If the requestor fails to properly execute on the downloaded file, the cache
+ * will be presumed to be corrupt. The file will be deleted from the cache
+ * and the download will be tried again. (for a limited number of times)
+ */
+ public void doWithDownload(DownloadableItem target, DownloadRequestor action) throws Exception {
+ int tries = getTries(); // try at most X times
+ Throwable e = null;
+ File downloadedFile = null;
+ do {
+ tries--;
+ try {
+ downloadedFile = downloadFile(target);
+ action.exec(downloadedFile);
+ return; // action succeeded without exceptions
+ } catch (UIThreadDownloadDisallowed caught) {
+ //No sense retrying this as it will just fail again...
+ throw caught;
+ } catch (Throwable caught) {
+ FrameworkCoreActivator.log(caught);
+ //Presume the cache may be corrupt!
+ //System.out.println("Delete corrupt download: "+downloadedFile);
+ if (downloadedFile!=null) {
+ downloadedFile.delete();
+ downloadedFile = null;
+ }
+ e = caught;
+ if (tries>0 && retryInterval>0) {
+ Thread.sleep(retryInterval);
+ }
+ }
+ } while (tries>0);
+ //Can only get here if action failed to execute on downloaded file...
+ //thus, e can not be null.
+ throw ExceptionUtil.exception(e);
+ }
+
+ /**
+ * @since 3.6.3
+ */
+ public int getTries() {
+ return tries;
+ }
+
+ /**
+ * Sets the maximum number of times DownloadManager will try and retyr to fetch
+ * a failed download. Note that the first try also counts. So if 'tries' is
+ * set to 3 then a failed download will be retried upto 2 times. I.e. one
+ * try and then 2 retries.
+ *
+ * @since 3.6.3
+ */
+ public DownloadManager setTries(int r) {
+ //Setting to 0 is not sensible because it would mean to just fail without even trying.
+ Assert.isLegal(r>1);
+ this.tries = r;
+ return this;
+ }
+
+ /**
+ * Sets the time in milliseconds to wait between retries. The default is 0 meaning no
+ * wait.
+ *
+ * @since 3.6.3
+ */
+ public void setRetryInterval(long retryInterval) {
+ Assert.isLegal(retryInterval>=0);
+ this.retryInterval = retryInterval;
+ }
+
+ /**
+ * @since 3.6.3
+ */
+ public long getRetryInterval(long retryInterval) {
+ return retryInterval;
+ }
+
+ public File getCacheDir() {
+ return cacheDirectory;
+ }
+
+ public boolean isDownloaded(DownloadableItem item) {
+ File target = getLocalLocation(item);
+ return target!=null && target.exists();
+ }
+
+ /**
+ * Dispose this download manager. Optionally delete its cache directory as well.
+ */
+ public void dispose() {
+ if (deleteCacheOnDispose) {
+ FileUtils.deleteQuietly(cacheDirectory);
+ deleteCacheOnDispose = false;
+ }
+ }
+
+ /**
+ * If this is false, an exception will be thrown if download is attempted on
+ * the UI thread. The default value is true.
+ */
+ public DownloadManager allowUIThread(boolean allow) {
+ allowUIThread = allow;
+ return this;
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/DownloadableItem.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/DownloadableItem.java
new file mode 100644
index 000000000..30d7fd592
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/DownloadableItem.java
@@ -0,0 +1,153 @@
+/*******************************************************************************
+ * Copyright (c) 2013 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.downloadmanager;
+
+import java.io.File;
+import java.net.URL;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
+
+import org.apache.commons.codec.binary.Base64;
+import org.apache.commons.io.FileUtils;
+import org.eclipse.core.runtime.Assert;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Status;
+import org.springsource.ide.eclipse.commons.frameworks.core.ExceptionUtil;
+import org.springsource.ide.eclipse.commons.frameworks.core.FrameworkCoreActivator;
+import org.springsource.ide.eclipse.commons.frameworks.core.downloadmanager.DownloadManager.DownloadRequestor;
+
+/**
+ * A DownloadableItem is something that can be downloaded and
+ * stored in the local file system as a file.
+ *
+ * @author Kris De Volder
+ */
+public class DownloadableItem {
+
+ private final URL url;
+ protected final DownloadManager downloader;
+ private String name; //optional name. If set this name will be used as filename in the cache otherwise
+ // suitable name will be computed.
+ protected IStatus downloadStatus = Status.OK_STATUS; //error message if download failed. Otherwise contains 'OK'.
+
+ public DownloadableItem(URL url, DownloadManager downloader) {
+ this.url = url;
+ this.downloader = downloader;
+ }
+
+ public void setFileName(String n) {
+ this.name = n;
+ }
+
+ /**
+ * A downloadable item must provide a URI where its contents can be fetched from.
+ */
+ public URL getURL() {
+ return url;
+ }
+
+ /**
+ * Force the item to be downloaded to a local File. If an item is already downloaded
+ * the cached local file will be returned immediately. Otherwise the method will block
+ * until the download is complete or an error occurs.
+ */
+ public File getFile() throws Exception {
+ try {
+ final File[] fileBox = new File[1];
+ downloader.doWithDownload(this, new DownloadRequestor() {
+ public void exec(File downloadedFile) throws Exception {
+ fileBox[0] = downloadedFile;
+ //TODO; validate file contents?
+ }
+ });
+ downloadStatus = Status.OK_STATUS;
+ return fileBox[0];
+ } catch (UIThreadDownloadDisallowed e) {
+ //Shouldn't affect download status since it means download was not attempted
+ throw e;
+ } catch (Exception e) {
+ downloadStatus = error(ExceptionUtil.getMessage(e));
+ throw e;
+ }
+ }
+
+ protected IStatus error(String message) {
+ return new Status(IStatus.ERROR, FrameworkCoreActivator.PLUGIN_ID, message);
+ }
+
+ /**
+ * A downloadable item must provide a filename where its cached downloaded contents
+ * should be stored. The name must uniquely identify the downloadable item
+ * within the scope of the DownloadManager used to download this item.
+ *
+ * The name must also be a legal file name on the current OS.
+ *
+ * A default implementation is provided that uses sha1 and Base64 encoding
+ * to generate a name from the uri.
+ *
+ * These generated names are not guaranteed to be unique, but the chance of
+ * a collisions is astronomically small.
+ */
+ protected String getFileName() {
+ if (name==null) {
+ try {
+ MessageDigest sha1encoder = MessageDigest.getInstance("sha1");
+ byte[] bytes = sha1encoder.digest((""+getURL()).getBytes());
+ name = new String(Base64.encodeBase64(bytes));
+ name = name.replace('/', '_'); //slashes are trouble in file names.
+ } catch (NoSuchAlgorithmException e) {
+ //This should not be possible
+ throw new Error(e);
+ }
+ }
+ return name;
+ }
+
+ @Override
+ public String toString() {
+ return url.toString();
+ }
+
+ public boolean isDownloaded() {
+ return downloader!=null && downloader.isDownloaded(this);
+ }
+
+ /**
+ * Error message if download failed. Other
+ * @return
+ */
+ public IStatus getDownloadStatus() {
+ return downloadStatus;
+ }
+
+ public void clearCache() {
+ //Take care not to delete the original file if was local to begin with (in that case we don't
+ // copy it into the cache dir so there is no cache to clear!
+ if (url!=null && !"file".equals(url.getProtocol())) {
+ //Avoid race conditions when someone is downloading this item at the moment.
+ synchronized (downloader) {
+ File localFile = downloader.getLocalLocation(this);
+ FileUtils.deleteQuietly(localFile);
+ }
+ }
+ }
+
+ /**
+ * Determine the location to unzip to (without actually doing any unzipping).
+ */
+ public File getUnzipDir() {
+ String fileName = getFileName();
+ Assert.isTrue(fileName.endsWith(".zip"));
+ File unzipLocation = new File(downloader.getCacheDir(), fileName.substring(0, fileName.length()-4));
+ return unzipLocation;
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/SimpleDownloadService.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/SimpleDownloadService.java
new file mode 100644
index 000000000..fef47b178
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/SimpleDownloadService.java
@@ -0,0 +1,70 @@
+/*******************************************************************************
+ * Copyright (c) 2013 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.downloadmanager;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.net.URL;
+import java.net.URLConnection;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+
+import org.springsource.ide.eclipse.commons.frameworks.core.downloadmanager.DownloadManager.DownloadService;
+import org.springsource.ide.eclipse.commons.frameworks.core.util.IOUtil;
+
+public class SimpleDownloadService implements DownloadService {
+
+ private final URLConnectionFactory connectionFactory;
+ private static final boolean DEBUG = false;
+
+ public SimpleDownloadService() {
+ this(new URLConnectionFactory());
+ }
+
+ public SimpleDownloadService(URLConnectionFactory urlConnectionFactory) {
+ this.connectionFactory = urlConnectionFactory;
+ }
+
+ //@Override
+ public void fetch(URL url, OutputStream writeTo) throws IOException {
+ URLConnection conn = null;
+ InputStream input = null;
+ try {
+ conn = connectionFactory.createConnection(url);
+ conn.connect();
+ if (DEBUG) {
+ System.out.println(">>> "+url);
+ Map> headers = conn.getHeaderFields();
+ for (Entry> header : headers.entrySet()) {
+ System.out.println(header.getKey()+":");
+ for (String value : header.getValue()) {
+ System.out.println(" "+value);
+ }
+ }
+ System.out.println("<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<");
+ }
+
+ input = conn.getInputStream();
+ IOUtil.pipe(input, writeTo);
+ } finally {
+ if (input!=null) {
+ try {
+ input.close();
+ } catch (Throwable e) {
+ //ignore.
+ }
+ }
+ }
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/UIThreadDownloadDisallowed.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/UIThreadDownloadDisallowed.java
new file mode 100644
index 000000000..250f00361
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/UIThreadDownloadDisallowed.java
@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright (c) 2013 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.downloadmanager;
+
+
+/**
+ * Exception thrown by the DownloadManager when a download operation
+ * is attempted in the UIThread. This is bad practice as it will
+ * freeze the UI until the download is complete.
+ *
+ * @author Kris De Volder
+ */
+public class UIThreadDownloadDisallowed extends Exception {
+
+ public UIThreadDownloadDisallowed(String string) {
+ super(string);
+ }
+
+ private static final long serialVersionUID = 1L;
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/URLConnectionFactory.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/URLConnectionFactory.java
new file mode 100644
index 000000000..9ef1e5f28
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/downloadmanager/URLConnectionFactory.java
@@ -0,0 +1,27 @@
+/*******************************************************************************
+ * Copyright (c) 2013 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.downloadmanager;
+
+import java.io.IOException;
+import java.net.URL;
+import java.net.URLConnection;
+
+public class URLConnectionFactory {
+
+ public int CONNECT_TIMEOUT = 3000;
+
+ public URLConnection createConnection(URL url) throws IOException {
+ URLConnection conn = url.openConnection();
+ conn.setConnectTimeout(CONNECT_TIMEOUT);
+ return conn;
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/cache/Cache.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/cache/Cache.java
new file mode 100644
index 000000000..24345a0ae
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/cache/Cache.java
@@ -0,0 +1,15 @@
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.cache;
+
+/**
+ * A Cache is basically just some kind of map in which key/value pairs can be kept.
+ *
+ * Different implementations of this interface may implement different methods of automatically
+ * expiring cache entries.
+ */
+public interface Cache {
+
+ V get(K key);
+ void put(K key, V value);
+ void clear(); //clear all entries from the cache.
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/cache/LimitedTimeCache.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/cache/LimitedTimeCache.java
new file mode 100644
index 000000000..7ddaf0dd5
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/cache/LimitedTimeCache.java
@@ -0,0 +1,155 @@
+/*******************************************************************************
+ * Copyright (c) 2016, 2017 Pivotal, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.cache;
+
+import java.time.Duration;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.function.Function;
+
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.jobs.Job;
+
+/**
+ * A cache that automatically removes entries when they reach a certain age.
+ *
+ * @author Kris De Volder
+ */
+public class LimitedTimeCache implements Cache {
+
+ private static final boolean DEBUG = false; //(""+Platform.getLocation()).contains("kdvolder");
+
+ private static void debug(String string) {
+ if (DEBUG) {
+ System.out.println(string);
+ }
+ }
+
+ public final long MAX_AGE;
+ public final long AGE_MARGIN;
+
+ private Map cache = new HashMap<>();
+
+ /**
+ * Job that removes expired entries from the cache.
+ */
+ private Job clearExpiredJob = new Job("Clean expired cache entries") {
+
+ {
+ setSystem(true);
+ }
+
+ @Override
+ protected IStatus run(IProgressMonitor monitor) {
+ long oldest = clearExpired();
+ //Reschedule job to again run when the next entry expires.
+ if (oldest>=0) {
+ clearExpiredJob.schedule(MAX_AGE - oldest + AGE_MARGIN);
+ }
+ return Status.OK_STATUS;
+ }
+ };
+
+ private class Entry {
+ long lastUsed;
+ V value;
+ Entry(V v) {
+ this.value = v;
+ this.lastUsed = System.currentTimeMillis();
+ }
+ long age() {
+ return System.currentTimeMillis() - lastUsed;
+ }
+ }
+
+ public LimitedTimeCache(Duration MAX_AGE_DURATION) {
+ MAX_AGE = MAX_AGE_DURATION.toMillis();
+ AGE_MARGIN = Math.max(1000, MAX_AGE / 20);
+ }
+
+ @Override
+ public synchronized V get(K key) {
+ Entry e = cache.get(key);
+ if (e!=null) {
+ e.lastUsed = System.currentTimeMillis();
+ return e.value;
+ }
+ return null;
+ }
+
+ @Override
+ public synchronized void put(K key, V value) {
+ boolean wasEmpty = cache.isEmpty();
+ if (value==null) {
+ cache.remove(key);
+ } else {
+ cache.put(key, new Entry(value));
+ }
+ //if the cache was not empty then it is already guaranteed a 'cleaningJob' will run to
+ // clean the existing oldest entry.
+ if (wasEmpty && !cache.isEmpty()) {
+ //The entry we just added is the only one in the cache.
+ //Therefore, that entry must be the oldest and its age is 0.
+ //So we know when the job should run next:
+ clearExpiredJob.schedule(MAX_AGE+AGE_MARGIN);
+ }
+ }
+
+ @Override
+ public synchronized void clear() {
+ cache.clear();
+ }
+
+ /**
+ * Iterates the cache removing all expired entries.
+ * @return The age of the oldest non-expired entry in the cache or -1 if the cache is empty.
+ */
+ private synchronized long clearExpired() {
+ debug(">>> clearExpired MAX_AGE = "+MAX_AGE);
+ Iterator.Entry>> iter = cache.entrySet().iterator();
+ long oldest = -1;
+ while (iter.hasNext()) {
+ java.util.Map.Entry.Entry> me = iter.next();
+ Entry e = me.getValue();
+ long age = e.age();
+ if (age>=MAX_AGE) {
+ debug("Expired: "+me.getKey() +" age: "+e.age());
+ iter.remove();
+ } else {
+ oldest = Math.max(oldest, age);
+ }
+ }
+ debug("<<< clearExpired ["+cache.size()+"]");
+ return oldest;
+ }
+
+ /**
+ * Applies a {@link LimitedTimeCache} cache around a given function.
+ *
+ * @param duration time after which entries in the cache should expire.
+ * @param func Function to wrap the cache around
+ * @return Equivalent function but with caching.
+ */
+ public static Function applyOn(Duration duration, Function func) {
+ LimitedTimeCache cache = new LimitedTimeCache<>(duration);
+ return (k) -> {
+ V v = cache.get(k);
+ if (v==null) {
+ cache.put(k, v=func.apply(k));
+ }
+ return v;
+ };
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/BooleanParameterDescriptor.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/BooleanParameterDescriptor.java
new file mode 100644
index 000000000..426399654
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/BooleanParameterDescriptor.java
@@ -0,0 +1,79 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+/**
+ * @author Nieraj Singh
+ */
+public class BooleanParameterDescriptor extends ParameterDescriptor {
+
+ private boolean useNameAsValue;
+
+ /**
+ * Use this constructor if the boolean value is either "true" or "false", meaning that the parameter has a
+ * pattern:
+ *
+ * [parametername]=true
+ *
+ *
+ * [parametername]=false
+ *
+ *
+ * @param name
+ * @param description
+ * @param isMandatory
+ * @param defaultValue
+ * @param requiresNameInCommand
+ * @param parameterPrefix
+ * @param valueSeparator
+ */
+ public BooleanParameterDescriptor(String name, String description,
+ boolean isMandatory, boolean defaultValue,
+ boolean requiresNameInCommand, String parameterPrefix,
+ String valueSeparator) {
+ super(name, description, isMandatory, new Boolean(defaultValue),
+ ParameterKind.BOOLEAN, requiresNameInCommand, parameterPrefix,
+ valueSeparator);
+ useNameAsValue = false;
+ }
+
+ /**
+ * User this constructor if the name of the parameter itself is also the
+ * value. This should be used when the parameter either appears in the command
+ * string with its name if set to true, or is omitted altogether if the value is false
+ *
+ *
+ * @param name
+ * @param description
+ * @param isMandatory
+ * @param defaultValue
+ * @param parameterPrefix
+ */
+ public BooleanParameterDescriptor(String name, String description,
+ boolean isMandatory, boolean defaultValue, String parameterPrefix) {
+ super(name, description, isMandatory, new Boolean(defaultValue),
+ ParameterKind.BOOLEAN, true, parameterPrefix, null);
+ useNameAsValue = true;
+ }
+
+ /**
+ * If true, the name of the parameter should be used as a value, instead of
+ * using "true" or "false". Therefore , in this case, the if the boolean is
+ * true, the name of the parameter is included, if boolean is false, the
+ * parameter is omitted.
+ *
+ * @return
+ */
+ public boolean useNameAsValue() {
+ return useNameAsValue;
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ComboParameterDescriptor.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ComboParameterDescriptor.java
new file mode 100644
index 000000000..ab7f498b0
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ComboParameterDescriptor.java
@@ -0,0 +1,33 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+/**
+ * A combo parameter must specify an ordered list of valid values. If also
+ * specifying a default value, the value should be part of the list of valid
+ * values.
+ * @author Nieraj Singh
+ */
+public class ComboParameterDescriptor extends ParameterDescriptor {
+ private String[] values;
+
+ public ComboParameterDescriptor(String name, String description,
+ boolean isMandatory, Object defaultValue, boolean requiresName,
+ String delimiter, String valueSeparator, String[] values) {
+ super(name, description, isMandatory, defaultValue,
+ ParameterKind.COMBO, requiresName, delimiter, valueSeparator);
+ this.values = values;
+ }
+
+ public String[] getSelectionValues() {
+ return values;
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/CommandFactory.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/CommandFactory.java
new file mode 100644
index 000000000..b0887596c
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/CommandFactory.java
@@ -0,0 +1,36 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+
+/**
+ * Constructs command parameter descriptors, as well as command instances.
+ * @author Nieraj Singh
+ * @author Christian Dupuis
+ */
+public class CommandFactory {
+
+ public static IFrameworkCommand createCommandInstance(IFrameworkCommandDescriptor descriptor) {
+ if (descriptor == null) {
+ return null;
+ }
+ return new FrameworkCommand(descriptor);
+ }
+
+ /*
+ * Command descriptor methods
+ */
+ public static IFrameworkCommandDescriptor createCommandDescriptor(String name, String description,
+ ICommandParameterDescriptor[] parameters) {
+ return new FrameworkCommandDescriptor(name, description, parameters);
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/CommandParameter.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/CommandParameter.java
new file mode 100644
index 000000000..d9f217e69
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/CommandParameter.java
@@ -0,0 +1,96 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Basic implementation of a command parameter instance. It contains a reference
+ * to the parameter descriptor.
+ * @author Nieraj Singh
+ */
+public class CommandParameter implements ICommandParameter,
+ IValueChangedNotifier {
+
+ private Object value;
+ private ICommandParameterDescriptor descriptor;
+ private List listeners;
+
+ public CommandParameter(ICommandParameterDescriptor descriptor) {
+ this.descriptor = descriptor;
+ init();
+ }
+
+ protected void init() {
+ if (descriptor != null) {
+ Object defaultValue = descriptor.getDefaultValue();
+ if (defaultValue != null) {
+ // Internal set value. Do not fire events for this
+ value = defaultValue;
+ }
+ }
+ }
+
+ public ICommandParameterDescriptor getParameterDescriptor() {
+ return descriptor;
+ }
+
+ public void setValue(Object value) {
+ this.value = value;
+ notifyValueChanged(value);
+ }
+
+ public Object getValue() {
+ return value;
+ }
+
+ public boolean hasValue() {
+ return value != null;
+ }
+
+ public IParameterValueListener addListener(IParameterValueListener listener) {
+ if (listener == null) {
+ return null;
+ }
+ if (listeners != null) {
+ listeners = new ArrayList();
+ }
+
+ if (listeners.contains(listener)) {
+ return null;
+ }
+
+ listeners.add(listener);
+
+ return listener;
+ }
+
+ public IParameterValueListener removeListener(
+ IParameterValueListener listener) {
+ if (listeners != null && listeners.remove(listener)) {
+ return listener;
+ }
+ return null;
+ }
+
+ protected void notifyValueChanged(Object value) {
+ if (listeners == null) {
+ return;
+ }
+
+ ParameterValueEvent event = new ParameterValueEvent(value);
+ for (IParameterValueListener listener : listeners) {
+ listener.handleValueChanged(event);
+ }
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/CompositeCommandParameter.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/CompositeCommandParameter.java
new file mode 100644
index 000000000..ed0841347
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/CompositeCommandParameter.java
@@ -0,0 +1,93 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * @author Nieraj Singh
+ */
+public class CompositeCommandParameter extends CommandParameter {
+
+ private List parameters;
+
+ public CompositeCommandParameter(CompositeParameterDescriptor descriptor) {
+ super(descriptor);
+ }
+
+ /**
+ * Never null.
+ *
+ * @return
+ */
+ public List getParameters() {
+ if (parameters == null) {
+ parameters = new ArrayList();
+ CompositeParameterDescriptor descriptor = (CompositeParameterDescriptor) getParameterDescriptor();
+ List childDescriptors = descriptor
+ .getParameterDescriptors();
+ for (ICommandParameterDescriptor child : childDescriptors) {
+ ICommandParameter parameter = ParameterFactory
+ .getParameterInstance(child);
+ if (parameter != null) {
+ parameters.add(parameter);
+ }
+ }
+ }
+ return parameters;
+ }
+
+ /**
+ * For a composite parameter, the value of the parameter is the value of one
+ * of it's child parameters whose value has been set. If none of the child
+ * parameters have value set, null is returned.
+ */
+ public Object getValue() {
+ ICommandParameter setChildParameter = getSetChildCommandParameter();
+ if (setChildParameter != null) {
+ return setChildParameter.getValue();
+ }
+ return null;
+ }
+
+ /**
+ * If a composite parameter has a child parameter with a value set, return
+ * true. If none of the composite parameter's children have value set,
+ * return false.
+ */
+ public boolean hasValue() {
+ return getValue() != null;
+ }
+
+ /**
+ * Returns the child command parameter that has a set value. Ideally there
+ * should only be at most one command parameter with a value, but if more
+ * than one is encountered, the first one is returned.
+ *
+ * @return first command parameter with value set that is found, or null if
+ * none of the child parameters have value.
+ */
+ public ICommandParameter getSetChildCommandParameter() {
+ if (parameters == null || parameters.isEmpty()) {
+ return null;
+ }
+
+ for (ICommandParameter parameter : parameters) {
+ // There should at most only be one parameter with a value
+ // If not, return the first one encountered
+ if (parameter.hasValue()) {
+ return parameter;
+ }
+ }
+ return null;
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/CompositeParameterDescriptor.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/CompositeParameterDescriptor.java
new file mode 100644
index 000000000..a29c4744c
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/CompositeParameterDescriptor.java
@@ -0,0 +1,42 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * @author Nieraj Singh
+ */
+public class CompositeParameterDescriptor extends ParameterDescriptor {
+
+ private List descriptors;
+
+ public CompositeParameterDescriptor(String name, String description,
+ boolean isMandatory, Object defaultValue,
+ boolean requiresNameInCommand, String argumentDelimiter,
+ String valueSeparator, List descriptors) {
+ super(name, description, isMandatory, defaultValue,
+ ParameterKind.COMPOSITE, requiresNameInCommand,
+ argumentDelimiter, valueSeparator);
+ this.descriptors = descriptors;
+ }
+
+ /**
+ * Should never be null. Return empty if it contains no child descriptors
+ *
+ * @return
+ */
+ public List getParameterDescriptors() {
+ return descriptors != null ? descriptors
+ : (descriptors = Collections.EMPTY_LIST);
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/FrameworkCommand.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/FrameworkCommand.java
new file mode 100644
index 000000000..c22c017a9
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/FrameworkCommand.java
@@ -0,0 +1,58 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Basic framework command implementation. Represents an INSTANCE of a command.
+ *
+ * The command description and name are immutable, but the list of parameters is
+ * mutable.
+ * @author Nieraj Singh
+ */
+public class FrameworkCommand implements IFrameworkCommand {
+
+ private IFrameworkCommandDescriptor descriptor;
+ private List parameters;
+
+ public FrameworkCommand(IFrameworkCommandDescriptor descriptor) {
+ this.descriptor = descriptor;
+ }
+
+ public List getParameters() {
+ if (parameters == null) {
+ this.parameters = new ArrayList();
+ ICommandParameterDescriptor[] parameterDescriptors = descriptor
+ .getParameters();
+ for (ICommandParameterDescriptor paramDescriptor : parameterDescriptors) {
+ if (paramDescriptor != null) {
+ ICommandParameter parameter = getCommandParameter(paramDescriptor);
+ if (parameter != null) {
+ parameters.add(parameter);
+ }
+ }
+ }
+ }
+ return parameters;
+ }
+
+ protected ICommandParameter getCommandParameter(
+ ICommandParameterDescriptor descriptor) {
+ return ParameterFactory.getParameterInstance(descriptor);
+ }
+
+ public IFrameworkCommandDescriptor getCommandDescriptor() {
+ return descriptor;
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/FrameworkCommandDescriptor.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/FrameworkCommandDescriptor.java
new file mode 100644
index 000000000..3ad39aa5f
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/FrameworkCommandDescriptor.java
@@ -0,0 +1,46 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+/**
+ * Basic implementation of a command descriptor. The list of parameters should not be null, although
+ * it can be empty.
+ * @author Nieraj Singh
+ */
+public class FrameworkCommandDescriptor implements IFrameworkCommandDescriptor {
+ private String name;
+ private String description;
+ private ICommandParameterDescriptor[] parameters;
+
+ public FrameworkCommandDescriptor(String name, String description,
+ ICommandParameterDescriptor[] parameters) {
+ this.name = name;
+ this.description = description;
+ this.parameters = parameters != null ? parameters
+ : new ICommandParameterDescriptor[] {};
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ public String getDescription() {
+ return description;
+ }
+
+ /*
+ * (non-Javadoc)
+ * @see com.springsource.sts.frameworks.core.internal.commands.IFrameworkCommandDescriptor#getParameters()
+ */
+ public ICommandParameterDescriptor[] getParameters() {
+ return parameters;
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ICommandListener.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ICommandListener.java
new file mode 100644
index 000000000..ba396a0ef
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ICommandListener.java
@@ -0,0 +1,32 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+/**
+ * Classes implementing this interface get notified when a command is added.
+ * This is meant to allow users to execute the notifier in a worker thread if
+ * necessary. A possible usage is to share the ICommandNotifier in a worker
+ * thread where commands can be added.
+ *
+ * Note that this adds command descriptors as opposed to command instances.
+ *
+ * @author Nieraj Singh
+ */
+public interface ICommandListener {
+
+ /**
+ * Add a command to the notifier. If null nothing gets added.
+ *
+ * @param command
+ * to add. If null nothing gets added.
+ */
+ public void addCommandDescriptor(IFrameworkCommandDescriptor commandDescriptor);
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ICommandParameter.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ICommandParameter.java
new file mode 100644
index 000000000..aa3d9e796
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ICommandParameter.java
@@ -0,0 +1,51 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+/**
+ * A command parameter instance that contains actual parameter values that can be run in a command
+ *
+ * The command parameter contains a reference to a parameter descriptor that describes the parameter, like its name,
+ * description, type, and default value.
+ *
+ * @author Nieraj Singh
+ */
+public interface ICommandParameter {
+
+ /**
+ * Get the parameter descriptor for this parameter instance
+ * @return
+ */
+ public ICommandParameterDescriptor getParameterDescriptor();
+
+ /**
+ * Set the actual value of the parameter. Usually set by the UI. Note that
+ * this should be stored separately from the default value, even if both are
+ * the same.
+ *
+ * @param actual
+ * parameter value.
+ */
+ public void setValue(Object value);
+
+ /**
+ * @return the actual parameter value. This is always a separate value than
+ * the default
+ */
+ public Object getValue();
+
+ /**
+ *
+ * @return True if it has a value, false otherwise
+ */
+ public boolean hasValue();
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ICommandParameterDescriptor.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ICommandParameterDescriptor.java
new file mode 100644
index 000000000..7ac78aaca
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ICommandParameterDescriptor.java
@@ -0,0 +1,105 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+/**
+ * This describes a parameter descriptor, and is intended to be IMMUTABLE.
+ *
+ * To instantiate a parameter whose values can be set, see
+ * {@link ICommandParameter}
+ * Example of how to define a parameter descriptor:
+ *
+ * -Dsys.env=prod
+ *
+ *
+ * Here, "-D" is the prefix, "sys.env" the parameter name, "=" the value
+ * separator, and "prod" a default value
+ *
+ * @author Nieraj Singh
+ */
+public interface ICommandParameterDescriptor {
+
+ /**
+ * This is the name of the parameter as it would appear in the actual
+ * command line String. It must be exactly as it would be used if a user
+ * would type it when executing a command in a command line.
+ *
+ * @return name of the parameter. It's required
+ */
+ public String getName();
+
+ /**
+ *
+ * @return optional description of the parameter that may include
+ * information on what it does, and what values may be acceptable
+ */
+ public String getDescription();
+
+ /**
+ *
+ * @return true if it requires a set value, false if it is an optional
+ * parameter
+ */
+ public boolean isMandatory();
+
+ /**
+ * Identifier indicating the type of parameter. Must not be null.
+ *
+ * @return non-null indentifier.
+ */
+ public ParameterKind getParameterKind();
+
+ /**
+ * Optionally, a parameter can specify a default value. Some parameters may
+ * always have a default value, like a boolean parameter, in which case the
+ * default is false. The value of the default is not expected to change
+ * throughout the life of the parameter, unlike the actual value.
+ *
+ * @return a default value, or null if it has no default value. Empty
+ * strings are considered default values, so only use null to
+ * indicate no default value
+ */
+ public Object getDefaultValue();
+
+ /**
+ * If the parameter name needs to be included in the executable command
+ * string and must be prefixed by a delimiter like "--", return a non-null
+ * value. Return null if parameter name should not be prefixed, regardless
+ * of whether the parameter name itself should appear or not.
+ *
+ * @return non-null String if it has a delimiter, null if not.
+ */
+ public String getParameterPrefix();
+
+ /**
+ * @return true if the parameter name forms part of the executable String,
+ * or false if it should be omitted.
+ */
+ public boolean requiresParameterNameInCommand();
+
+ /**
+ * Optional. If a parameter requires a value separator that separates the
+ * value from the parameter name, like for instance '=' or ':', the
+ * parameter descriptor must return a non-null, non-empty separator. A null
+ * or empty separator will be ignored.
+ *
+ * -Dsys.env=prod
+ *
+ *
+ * Here, "-D" is the prefix, "sys.env" the parameter name, and "=" the value
+ * separator
+ *
+ *
+ * @return the value separator
+ */
+ public String getValueSeparator();
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IFrameworkCommand.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IFrameworkCommand.java
new file mode 100644
index 000000000..ceda25e47
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IFrameworkCommand.java
@@ -0,0 +1,45 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+import java.util.List;
+
+/**
+ * Represents a command instance with a list of ordered parameters. Implementors
+ * can have the command instance generate parameter instances for the parameter
+ * descriptors contained in the associated command descriptor.
+ *
+ * Each instance is associated with one command descriptor, and it must hold a
+ * reference to the command descriptor it is representing
+ *
+ * @author Nieraj Singh
+ */
+public interface IFrameworkCommand {
+
+ /**
+ * Associated command descriptor. Must not be null.
+ *
+ * @return
+ */
+ public IFrameworkCommandDescriptor getCommandDescriptor();
+
+ /**
+ * List of parameters for this command. Note that order matters, therefore
+ * the order in which the parameters appear should match the order in which
+ * they are used as arguments to the command. This is a MUTABLE list, so
+ * callers can add or remove parameter instances, although the corresponding
+ * parameter descriptors cannot be modified
+ *
+ * @return ordered list of command parameters. May be empty but never null
+ */
+ public List getParameters();
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IFrameworkCommandDescriptor.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IFrameworkCommandDescriptor.java
new file mode 100644
index 000000000..7c9963dda
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IFrameworkCommandDescriptor.java
@@ -0,0 +1,43 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+
+/**
+ * Describes command including its parameters. This is intended to be an IMMUTABLE class, and ideally can be used
+ * globally to define a particular command.
+ *
+ * To instantiate a command whose parameter values can be set, use
+ * {@link IFrameworkCommand}
+ * @author Nieraj Singh
+ */
+public interface IFrameworkCommandDescriptor {
+ /**
+ * Name of the command. Cannot be null. This is the command script name.
+ */
+ public String getName();
+
+ /**
+ * Description of the command. Optional.
+ */
+ public String getDescription();
+
+ /**
+ * List of parameter descriptors that describe the parameters of this command.
+ *
+ * Note that this is order-sensitive, therefore the order in which they appear affects how
+ * the parameters are constructed in a command string.
+ *
+ * @return
+ */
+ public ICommandParameterDescriptor[] getParameters();
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IParameterFactory.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IParameterFactory.java
new file mode 100644
index 000000000..e12f8ca15
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IParameterFactory.java
@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+/**
+ * Allows specific domains to implement their own parameter instance factory that gets invoked by
+ * the command framework.
+ * @author Nieraj Singh
+ */
+public interface IParameterFactory {
+
+ /**
+ * Given a parameter descriptor, generate a parameter instance. This method is typically called by the framework so clients
+ * only need to make sure that their descriptor adapts to their factory for the generic command framework to invoke the factory.
+ *
+ * @param descriptor
+ * @return command parameter instance corresponding to the descriptor
+ */
+ public ICommandParameter getParameter(ICommandParameterDescriptor descriptor);
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IParameterValueListener.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IParameterValueListener.java
new file mode 100644
index 000000000..36aa35d6a
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IParameterValueListener.java
@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+/**
+ * Parameter instances can implement to be notified when a parameter value has
+ * changed. This is usually used with Composite parameters, where the value
+ * change of one child parameter should notify other child parameters
+ * @author Nieraj Singh
+ */
+public interface IParameterValueListener {
+
+ /**
+ * A parameter value has changed, allowing listeners to handle the change
+ * event.
+ *
+ * @param event
+ */
+ public void handleValueChanged(ParameterValueEvent event);
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IValueChangedNotifier.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IValueChangedNotifier.java
new file mode 100644
index 000000000..9598ee51b
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/IValueChangedNotifier.java
@@ -0,0 +1,24 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+/**
+ * Notifies listeners when parameter values have changed.
+ * @author Nieraj Singh
+ */
+public interface IValueChangedNotifier {
+
+ public IParameterValueListener addListener(IParameterValueListener listener);
+
+ public IParameterValueListener removeListener(
+ IParameterValueListener listener);
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/JavaParameterDescriptor.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/JavaParameterDescriptor.java
new file mode 100644
index 000000000..e99bdb0fe
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/JavaParameterDescriptor.java
@@ -0,0 +1,66 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+import org.eclipse.jdt.core.IJavaElement;
+
+/**
+ * Java parameter, where a java element type must be specified and may be used for content assist and other
+ * operations that require a Java type.
+ *
+ * The default value can be a qualified Java name, although it is optional.
+ * @author Nieraj Singh
+ */
+public class JavaParameterDescriptor extends ParameterDescriptor {
+
+ /**
+ * List of valid Java types.
+ */
+ public static final int FLAG_INTERFACE = 1 << 2;
+
+ public static final int FLAG_CLASS = 1 << 3;
+
+ public static final int FLAG_PACKAGE = 1 << 4;
+
+ private int type;
+
+ /**
+ *
+ * @param name
+ * of the parameter. required
+ * @param description
+ * description is optional.
+ * @param isMandatory
+ * if value is needed, set to true, false otherwise
+ * @param defaultValue
+ * @param type
+ * a IJavaElement type identifier, that indicates whether
+ * possible content assist should be for packages, types, etc..
+ */
+ public JavaParameterDescriptor(String name, String description,
+ boolean isMandatory, Object defaultValue, ParameterKind kind,
+ int type, boolean requiresName, String delimiter, String valueSeparator) {
+ super(name, description, isMandatory, defaultValue,
+ ParameterKind.JAVA_TYPE, requiresName, delimiter, valueSeparator);
+ this.type = type;
+ }
+
+ /**
+ * Get the java element type for this parameter. This may be used for
+ * content assist to decide what type of java element types to search for.
+ *
+ * @see IJavaElement
+ * @return java element type.
+ */
+ public int getJavaElementType() {
+ return type;
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ParameterDescriptor.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ParameterDescriptor.java
new file mode 100644
index 000000000..24e5086c3
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ParameterDescriptor.java
@@ -0,0 +1,88 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+import org.eclipse.core.runtime.PlatformObject;
+
+/**
+ * Base implementation of a parameter descriptor.
+ * @author Nieraj Singh
+ */
+public class ParameterDescriptor extends PlatformObject implements
+ ICommandParameterDescriptor {
+
+ private String name;
+ private String description;
+ private boolean isMandatory;
+ private Object defaultValue;
+ private ParameterKind kind;
+ private boolean requiresNameInCommand = false;
+ private String parameterPrefix;
+ private String valueSeparator;
+
+ public ParameterDescriptor(String name, String description,
+ boolean isMandatory, Object defaultValue, ParameterKind kind,
+ boolean requiresNameInCommand, String parameterPrefix,
+ String valueSeparator) {
+ super();
+ this.name = name;
+ this.description = description;
+ this.isMandatory = isMandatory;
+ this.defaultValue = defaultValue;
+ this.kind = kind;
+ this.requiresNameInCommand = requiresNameInCommand;
+ this.parameterPrefix = parameterPrefix;
+ this.valueSeparator = valueSeparator;
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ public String getDescription() {
+ return description;
+ }
+
+ public boolean isMandatory() {
+ return isMandatory;
+ }
+
+ public Object getDefaultValue() {
+ return defaultValue;
+ }
+
+ public ParameterKind getParameterKind() {
+ return kind;
+ }
+
+ public String getParameterPrefix() {
+ return parameterPrefix;
+ }
+
+ public String getValueSeparator() {
+ return valueSeparator;
+ }
+
+ public boolean requiresParameterNameInCommand() {
+ return requiresNameInCommand;
+ }
+
+ public Object getAdapter(Class adapter) {
+ // Ask the adapter manager first
+ Object adapterObj = super.getAdapter(adapter);
+
+ // If no adapter can be found, use the default factory
+ if (adapterObj == null && adapter == IParameterFactory.class) {
+ adapterObj = new ParameterFactory();
+ }
+ return adapterObj;
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ParameterFactory.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ParameterFactory.java
new file mode 100644
index 000000000..07c5b85ac
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ParameterFactory.java
@@ -0,0 +1,315 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+import java.util.List;
+
+import org.eclipse.core.runtime.IAdaptable;
+
+/**
+ * Base implementation of a parameter factory that descriptors adapt to. Clients
+ * can implement their own adapter factory and contribute it through platform
+ * adapter manager. Users should not be instantiating this class directly, as
+ * the adapter framework will manage factory lookup.
+ *
+ * A static method is provided that users can call to obtain a parameter via the
+ * adapter manager framework.
+ *
+ * @author Nieraj Singh
+ */
+public class ParameterFactory implements IParameterFactory {
+
+ /**
+ * Users should not instantiate this class or invoke this method directly.
+ * Use the static method instead, as it leverages the adapter manager
+ * framework.
+ */
+ public ICommandParameter getParameter(ICommandParameterDescriptor descriptor) {
+ if (descriptor == null) {
+ return null;
+ }
+
+ ParameterKind kind = descriptor.getParameterKind();
+ switch (kind) {
+ case BASE:
+ case JAVA_TYPE:
+ return new StringCommandParameter(descriptor);
+ case BOOLEAN:
+ case COMBO:
+ return new CommandParameter(descriptor);
+ case COMPOSITE:
+ return new CompositeCommandParameter(
+ (CompositeParameterDescriptor) descriptor);
+ }
+ return null;
+ }
+
+ /**
+ * A composite parameter is a parameter whose single value can be obtained
+ * by different types of parameter descriptors. However, a composite value
+ * always has just one value, just like any other parameter.
+ *
+ * @param name
+ * of the command exactly as it should appear when executed.
+ * Cannot be null or empty.
+ * @param description
+ * optional description
+ * @param isMandatory
+ * true if it is required. False otherwise
+ * @param defaultValue
+ * optional. If not required, use null.
+ * @param requiresName
+ * true if the name of the parameter should appear in the Command
+ * string
+ * @param prefix
+ * non-null if a prefix like "--" should be prepended to the
+ * parameter name. Null otherwise
+ * @param valueSeparator
+ * non-null if the value of the parameter requires a value
+ * separator like "=". Null otherwise
+ * @param descriptors
+ * list of descriptors that define this composite.
+ * @return
+ */
+ public static ICommandParameterDescriptor createCompositeParameterDescriptor(
+ String name, String description, boolean isMandatory,
+ String defaultValue, boolean requiresName, String delimiter,
+ String valueSeparator, List descriptors) {
+ return new CompositeParameterDescriptor(name, description, isMandatory,
+ defaultValue, requiresName, delimiter, valueSeparator,
+ descriptors);
+ }
+
+ /**
+ *
+ * Use this constructor if the boolean value is either "true" or "false",
+ * meaning that the parameter has a pattern:
+ *
+ * [parametername]=true
+ *
+ *
+ * [parametername]=false
+ *
+ * Boolean parameters ALWAYS have a default value (true or false)
+ *
+ * @param name
+ * of the command exactly as it should appear when executed.
+ * Cannot be null or empty.
+ * @param description
+ * optional description
+ * @param isMandatory
+ * true if it is required. False otherwise
+ * @param defaultValue
+ * . True or false
+ * @param requiresName
+ * true if the name of the parameter should appear in the Command
+ * string
+ * @param prefix
+ * non-null if a prefix like "--" should be prepended to the
+ * parameter name. Null otherwise
+ * @param valueSeparator
+ * non-null if the value of the parameter requires a value
+ * separator like "=". Null otherwise
+ */
+ public static ICommandParameterDescriptor createBooleanParameterDescriptor(
+ String name, String description, boolean isMandatory,
+ boolean defaultValue, boolean requiresName, String prefix,
+ String valueSeparator) {
+ return new BooleanParameterDescriptor(name, description, isMandatory,
+ defaultValue, requiresName, prefix, valueSeparator);
+ }
+
+ /**
+ * User this constructor if the name of the parameter itself is also the
+ * value. This should be used when the parameter either appears in the
+ * command string with its name if set to true, or is omitted altogether if
+ * the value is false
+ *
+ *
+ *
+ * parameter name: "windows". If true, it appears as: "--windows" in the
+ * command string. If false, it is omitted. The "--" needs to be defined as
+ * the prefix
+ *
+ * Boolean parameters ALWAYS have a default value (true or false)
+ *
+ * @param name
+ * of the command exactly as it should appear when executed.
+ * Cannot be null or empty.
+ * @param description
+ * optional description
+ * @param isMandatory
+ * true if it is required. False otherwise
+ * @param defaultValue
+ * . True or false
+ * @param prefix
+ * non-null if a prefix like "--" should be prepended to the
+ * parameter name. Null otherwise
+ */
+ public static ICommandParameterDescriptor createBooleanParameterDescriptor(
+ String name, String description, boolean isMandatory,
+ boolean defaultValue, String prefix) {
+ return new BooleanParameterDescriptor(name, description, isMandatory,
+ defaultValue, prefix);
+ }
+
+ /**
+ * Basic text-based parameter.
+ *
+ * @param name
+ * of the command exactly as it should appear when executed.
+ * Cannot be null or empty.
+ * @param description
+ * optional description
+ * @param isMandatory
+ * true if it is required. False otherwise
+ * @param defaultValue
+ * . Null if it has no default value
+ * @param requiresName
+ * true if the name of the parameter should appear in the Command
+ * string
+ * @param prefix
+ * non-null if a prefix like "--" should be prepended to the
+ * parameter name. Null otherwise
+ * @param valueSeparator
+ * non-null if the value of the parameter requires a value
+ * separator like "=". Null otherwise
+ * @return
+ */
+ public static ICommandParameterDescriptor createBaseParameterDescriptor(
+ String name, String description, boolean isMandatory,
+ String defaultValue, boolean requiresName, String prefix,
+ String valueSeparator) {
+ return new ParameterDescriptor(name, description, isMandatory,
+ defaultValue, ParameterKind.BASE, requiresName, prefix,
+ valueSeparator);
+ }
+
+ /**
+ * Creates a Java parameter that pertains to a Java type. The specified Java
+ * type allows UI components to support the correct type of content assist,
+ * type browsing and filtering
+ *
+ * @param name
+ * of the command exactly as it should appear when executed.
+ * Cannot be null or empty.
+ * @param description
+ * optional description
+ * @param isMandatory
+ * true if it is required. False otherwise
+ * @param defaultValue
+ * . Null if it has no default value
+ * @param requiresName
+ * true if the name of the parameter should appear in the Command
+ * string
+ * @param prefix
+ * non-null if a prefix like "--" should be prepended to the
+ * parameter name. Null otherwise
+ * @param valueSeparator
+ * non-null if the value of the parameter requires a value
+ * separator like "=". Null otherwise
+ * @param type
+ * must be a valid Java type that this parameter corresponds to.
+ * This may be used for content assist and Java type browsing.
+ * See valid values: {@link JavaParameterDescriptor}
+ * @return
+ */
+ public static ICommandParameterDescriptor createJavaParameterDescriptor(
+ String name, String description, boolean isMandatory,
+ String defaultValue, boolean requiresName, String prefix,
+ String valueSeparator, int type) {
+ return new JavaParameterDescriptor(name, description, isMandatory,
+ defaultValue, ParameterKind.JAVA_TYPE, type, requiresName,
+ prefix, valueSeparator);
+ }
+
+ /**
+ * Creates a combo descriptor for the given set of values.
+ *
+ * @param name
+ * of the command exactly as it should appear when executed.
+ * Cannot be null or empty.
+ * @param description
+ * optional description
+ * @param isMandatory
+ * true if it is required. False otherwise
+ * @param defaultValue
+ * . Null if it has no default value
+ * @param requiresName
+ * true if the name of the parameter should appear in the Command
+ * string
+ * @param prefix
+ * non-null if a prefix like "--" should be prepended to the
+ * parameter name. Null otherwise
+ * @param valueSeparator
+ * non-null if the value of the parameter requires a value
+ * separator like "=". Null otherwise
+ * @param values
+ * list of values that appear in the Combo. Cannot be null or
+ * empty.
+ * @return
+ */
+ public static ICommandParameterDescriptor createComboParameterDescriptor(
+ String name, String description, boolean isMandatory,
+ String defaultValue, boolean requiresName, String prefix,
+ String valueSeparator, String[] values) {
+ return new ComboParameterDescriptor(name, description, isMandatory,
+ defaultValue, requiresName, prefix, valueSeparator, values);
+ }
+
+ /**
+ * Creates a parameter descriptor that follows this pattern:
+ * "--[parametername]=[value]".
+ *
+ *
+ * If the parameter is serialised, it is prefixed by "--", followed by the
+ * exact parameter name, followed by "=" followed by the value.
+ *
+ *
+ * @param name
+ * of the command exactly as it should appear when executed.
+ * Cannot be null or empty.
+ * @param description
+ * optional description
+ * @param isMandatory
+ * true if it is required. False otherwise
+ * @param defaultValue
+ * . Null if it has no default value
+ * @return new Command descriptor for the given arguments.
+ */
+ public static ICommandParameterDescriptor createBasePrefixedParameterDescriptor(
+ String name, String description, boolean isMandatory,
+ String defaultValue) {
+ return createBaseParameterDescriptor(name, description, isMandatory,
+ defaultValue, true, "--", "=");
+ }
+
+ /**
+ * Users should use this method to obtain a parameter instance for a given
+ * parameter descriptor
+ *
+ * @param descriptor
+ * @return new parameter instance for the given parameter descriptor, or
+ * null if it couldn't be created
+ */
+ public static ICommandParameter getParameterInstance(
+ ICommandParameterDescriptor descriptor) {
+ if (descriptor instanceof IAdaptable) {
+ IParameterFactory factory = (IParameterFactory) ((IAdaptable) descriptor)
+ .getAdapter(IParameterFactory.class);
+ if (factory != null) {
+ return factory.getParameter(descriptor);
+ }
+ }
+ return null;
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ParameterKind.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ParameterKind.java
new file mode 100644
index 000000000..78c1798df
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ParameterKind.java
@@ -0,0 +1,36 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+/**
+ * Represents the different types of parameters.
+ * @author nisingh
+ *
+ */
+public enum ParameterKind {
+
+ // Parameter with a String value
+ BASE,
+
+ // Parameter with a set of defined values
+ COMBO,
+
+ // Parameter with a Java type value
+ JAVA_TYPE,
+
+ // Boolean parameter
+ BOOLEAN,
+
+ // A composite parameter
+ COMPOSITE
+
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ParameterValueEvent.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ParameterValueEvent.java
new file mode 100644
index 000000000..b054c7842
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/ParameterValueEvent.java
@@ -0,0 +1,28 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+/**
+ * @author Nieraj Singh
+ */
+public class ParameterValueEvent {
+
+ private Object value;
+
+ public ParameterValueEvent(Object value) {
+ this.value = value;
+ }
+
+ public Object getValueChanged() {
+ return value;
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/StringCommandParameter.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/StringCommandParameter.java
new file mode 100644
index 000000000..6f4e8b6a6
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/StringCommandParameter.java
@@ -0,0 +1,32 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+/**
+ * A String command parameter where a null OR empty String means there is no value.
+ * @author Nieraj Singh
+ */
+public class StringCommandParameter extends CommandParameter {
+
+ public StringCommandParameter(ICommandParameterDescriptor descriptor) {
+ super(descriptor);
+ }
+
+ public boolean hasValue() {
+ boolean hasVal = super.hasValue();
+ Object value = getValue();
+ if (hasVal && value instanceof String) {
+ hasVal &= ((String) value).length() > 0;
+ }
+ return hasVal;
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/SystemPropertyParameterDescriptor.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/SystemPropertyParameterDescriptor.java
new file mode 100644
index 000000000..d7afaffbc
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/commands/SystemPropertyParameterDescriptor.java
@@ -0,0 +1,29 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.commands;
+
+/**
+ * System property parameter descriptor that has "-D" prefix and a value separator "=".
+ * It is a base type text parameter, therefore has a free text field (no filters or content assist)
+ * @author Nieraj Singh
+ */
+public class SystemPropertyParameterDescriptor extends ParameterDescriptor {
+
+ public static final String SYSTEM_PREFIX = "-D";
+ public static final String VALUE_SEPARATOR = "=";
+
+ public SystemPropertyParameterDescriptor(String name, String description,
+ boolean isMandatory, Object defaultValue) {
+ super(name, description, isMandatory, defaultValue, ParameterKind.BASE,
+ true, SYSTEM_PREFIX, VALUE_SEPARATOR);
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/java/FrameworksJavaUtils.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/java/FrameworksJavaUtils.java
new file mode 100644
index 000000000..9cb6e7789
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/java/FrameworksJavaUtils.java
@@ -0,0 +1,64 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.java;
+
+import org.eclipse.jdt.core.IClasspathEntry;
+import org.eclipse.jdt.core.IJavaProject;
+import org.eclipse.jdt.core.IPackageFragmentRoot;
+import org.eclipse.jdt.core.JavaModelException;
+import org.springsource.ide.eclipse.commons.frameworks.core.FrameworkCoreActivator;
+
+
+/**
+ * Common Java utility methods.
+ * @author Nieraj Singh
+ */
+public class FrameworksJavaUtils {
+
+ private FrameworksJavaUtils() {
+ // Utility class
+ }
+
+ /**
+ * Obtain the package fragment roots of the first encountered source class
+ * path entry in the given java project. Return null if the java project is
+ * null, or no source class path entries can be found.
+ *
+ * @param javaProject
+ * containing source class path entries
+ * @return package fragment roots of first encountered source class path
+ * entry, or null otherwise
+ */
+ public static IPackageFragmentRoot[] getFirstEncounteredSourcePackageFragmentRoots(
+ IJavaProject javaProject) {
+ if (javaProject == null) {
+ return null;
+ }
+
+ try {
+
+ IClasspathEntry[] entries = javaProject.getRawClasspath();
+
+ for (IClasspathEntry entry : entries) {
+
+ if (entry.getEntryKind() == IClasspathEntry.CPE_SOURCE) {
+ return javaProject.findPackageFragmentRoots(entry);
+ }
+ }
+
+ } catch (JavaModelException e) {
+ FrameworkCoreActivator.logError(e.getLocalizedMessage(), e);
+ }
+ return null;
+
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/plugins/BasePluginData.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/plugins/BasePluginData.java
new file mode 100644
index 000000000..99ca0fd12
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/plugins/BasePluginData.java
@@ -0,0 +1,128 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.plugins;
+
+/**
+ * Very basic metadata for a plugin that only contains property information.
+ *
+ * @author Nieraj Singh
+ */
+public class BasePluginData {
+
+ private String name;
+ private String version;
+ private String runtimeVersion;
+ private String author;
+ private String title;
+ private String description;
+ private String documentation;
+
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ public void setDocumentation(String documentation) {
+ this.documentation = documentation;
+ }
+
+ /**
+ * Must never be null. Use empty string if null
+ * @param version
+ */
+ public void setVersion(String version) {
+ this.version = version;
+ }
+
+ public void setRuntimeVersion(String runtimeVersion) {
+ this.runtimeVersion = runtimeVersion;
+ }
+
+ public void setAuthor(String author) {
+ this.author = author;
+ }
+
+ public void setTitle(String title) {
+ this.title = title;
+ }
+
+ public void setDescription(String description) {
+ this.description = description;
+ }
+
+ /**
+ * Must never be null.
+ * @return
+ */
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * Never null, but may be empty.
+ * @return
+ */
+ public String getVersion() {
+ return version;
+ }
+
+ public String getDocumentation() {
+ return documentation;
+ }
+
+ public String getRuntimeVersion() {
+ return runtimeVersion;
+ }
+
+ public String getAuthor() {
+ return author;
+ }
+
+ public String getTitle() {
+ return title;
+ }
+
+ public String getDescription() {
+ return description;
+ }
+
+ @Override
+ public int hashCode() {
+ final int prime = 31;
+ int result = 1;
+ result = prime * result + ((name == null) ? 0 : name.hashCode());
+ result = prime * result + ((version == null) ? 0 : version.hashCode());
+ return result;
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj)
+ return true;
+ if (obj == null)
+ return false;
+ if (getClass() != obj.getClass())
+ return false;
+ BasePluginData other = (BasePluginData) obj;
+ if (name == null) {
+ if (other.name != null)
+ return false;
+ } else if (!name.equals(other.name))
+ return false;
+ if (version == null) {
+ if (other.version != null)
+ return false;
+ } else if (!version.equals(other.version))
+ return false;
+ return true;
+ }
+
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/plugins/Plugin.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/plugins/Plugin.java
new file mode 100644
index 000000000..c862a60d1
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/plugins/Plugin.java
@@ -0,0 +1,308 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.plugins;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Represents a published plugin model, which among other things,
+ * contains a list of published versions.
+ *
+ * It specifies the latest version of the plugin as it would be installed IF the
+ * plugin were installed without specifying a version number. NOTE that this is
+ * NOT the same as being the most recent version of the plugin that is
+ * available. There may be newer milestone versions available OR newer versions
+ * that are only compatible with newer runtimes. Therefore this model provides two
+ * API for retrieving new versions:
+ *
+ * The latest version available for the given version of a runtime used by a
+ * project. This is the version that is installed if a user installs the plugin
+ * WITHOUT specifying a version number.
+ *
+ * The most recent version added, which may be a milestone or only available for
+ * newer versions of a runtime, which a user must manually specify when installing
+ * the plugin. As the list of versions are ORDERED, the most recent version
+ * added version should be the last version that was added to the list.
+ *
+ *
+ * This model represents both a published plugin as well as an in-place plugin.
+ * In-place plugins usually only have one child version (i.e the only version
+ * that is available), and this version is considered the latest version.
+ *
+ *
+ * @author Nieraj Singh
+ * @author Andrew Eisenberg
+ */
+public class Plugin {
+
+ /**
+ * never null
+ */
+ private List versions = new ArrayList();
+
+ private PluginVersion latestVersion;
+
+ private String name;
+
+ /**
+ * Default is always false, meaning when created it is assumed it is
+ * published
+ */
+ private boolean isInplace = false;
+
+ public Plugin(String name) {
+ this.name = name;
+ }
+
+ /**
+ * Returns a COPY of an ORDERED list of versions, where the first entry is
+ * the oldest and the last the most recent. The last entry does NOT
+ * necessarily mean the version that will get install if the plugin were
+ * to be installed without specifying a version number. It just means the
+ * most recent version that is available for this plugin. The
+ * "latest version" (the version that installs when no version number
+ * is specified) may in fact be an older version than the most recent
+ * version that was added.
+ *
+ * @return all versions of this plugin, including new milestones. List is
+ * ordered, with the most recent entry being the last entry. Its
+ * never null, and should not be empty as a plugin has at least one
+ * version
+ */
+ public List getVersions() {
+ return new ArrayList(versions);
+ }
+
+ /**
+ * Ordered addition of a version. If the version doesn't already exist and
+ * is not null, it is added at the end of the list and true is returned if
+ * successfully added.
+ *
+ * Any version that is successfully added also has its parent set to this
+ * instance.
+ *
+ *
+ * @param version
+ * to add to the end of the list. The version must correspond to
+ * the same plugin (i.e must have the same plugin name)
+ * @return true if successfully added. False otherwise
+ */
+ public boolean addVersion(PluginVersion version) {
+ if (version != null && !versions.contains(version)
+ && getName().equals(version.getName())) {
+ versions.add(version);
+ version.setParent(this);
+ return true;
+ }
+ return false;
+ }
+
+ public void removeVersion(PluginVersion version) {
+ versions.remove(version);
+ }
+
+ /**
+ * Gets the version model for the given ID, or null if not found
+ *
+ * @param versionID
+ * @return
+ */
+ public PluginVersion getVersion(String versionID) {
+ if (versionID == null) {
+ return null;
+ }
+ for (PluginVersion version : getVersions()) {
+ if (versionID.equals(version.getVersion())) {
+ return version;
+ }
+ }
+ return null;
+ }
+
+ /**
+ *
+ * @return true if it is in place, false if it is published.
+ */
+ public boolean isInPlace() {
+ return isInplace;
+ }
+
+ /**
+ * Set to true ONLY if this plugin has not been published.
+ *
+ * @param isInplace
+ * true if it is in-place, false if it is published
+ */
+ public void setIsInPlace(boolean isInplace) {
+ this.isInplace = isInplace;
+ }
+
+ public boolean isInstalled() {
+ return getInstalled() != null;
+ }
+
+ public PluginVersion getInstalled() {
+ for (PluginVersion version : getVersions()) {
+ if (version.isInstalled()) {
+ return version;
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Will set the latest version IF the latest version already exists in the
+ * list of version, OR if it does not exist, it is successfully added at the
+ * end of the list. Returns true if latest version successfully set. False
+ * otherwise.
+ *
+ * Note that this CANNOT be null.
+ *
+ *
+ * @param latestVersion
+ * latest released version
+ * @return true if successfully set, false otherwise
+ */
+ public boolean setLatestReleasedVersion(PluginVersion latestVersion) {
+ if (versions.contains(latestVersion) || addVersion(latestVersion)) {
+ this.latestVersion = latestVersion;
+ //Note: it is possible that latestVersion was a 'duplicate' element. So although it
+ // is equals it may not be the same object. That means the parent could remain null
+ // unless we explicitly set it here. This causes NPE later on.
+ // See: STS-2490
+ this.latestVersion.setParent(this);
+ return true;
+ }
+ return false;
+ }
+
+ /**
+ * This may be different and more recent thatn the lastest released version
+ *
+ * @return the most recent version of the plugin that is available. This may
+ * OR may not be the same as the latest version available.
+ */
+ public PluginVersion getMostRecentVersionAdded() {
+ List children = getVersions();
+ if (children != null && !children.isEmpty()) {
+ return children.get(children.size() - 1);
+ }
+ return null;
+ }
+
+ /**
+ * Gets the latest version of this plugin, but may NOT necessarily be the
+ * most recent version. The "latest version" is defined as the version
+ * that installs when NO version number is specified when installing the
+ * plugin. This version is set when this plugin model is first
+ * created , and is considered the "latest version" for the particular
+ * version of the runtime that a project is using, although newer versions may
+ * exist. This cannot be null.
+ *
+ * @return latest version. Should not be null.
+ */
+ public PluginVersion getLatestReleasedVersion() {
+ return latestVersion;
+ }
+
+ /**
+ * Given a plugin, check if it is a version of this pluging. Return false if
+ * it is not a version of this plugin.
+ *
+ * @param pluginToCheck
+ * @return true if version. False otherwise.
+ */
+ public boolean isVersion(PluginVersion pluginToCheck) {
+ if (pluginToCheck == null) {
+ return false;
+ }
+ String nameToCheck = pluginToCheck.getName();
+ String versionToCheck = pluginToCheck.getVersion();
+ List versions = getVersions();
+ if (versions != null && versionToCheck != null && nameToCheck != null
+ && nameToCheck.equals(getName())) {
+ for (PluginVersion ver : versions) {
+ if (versionToCheck.equals(ver.getVersion())) {
+ return true;
+ }
+ }
+ }
+ return false;
+
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * Determines whether an update exists for the installed version. The
+ * lastest version available is the version that installs when the
+ * install-plugin command is run without specifying a version number.
+ * However, this may not necessarily be the newest version, as newer
+ * milestone versions may exist, as well as versions that are only
+ * compatible with newer runtimes.
+ *
+ * If a plugin is installed to the latest version, but newer milestone
+ * versions are available, this method returns false. It only returns true
+ * if the plugin is installed at an older version, but if the user were to
+ * run the install plugin command, a more recent released version would be
+ * installed instead.
+ *
+ *
+ * @return true if and only if the plugin is installed and a newer released
+ * version exists. If the plugin is not installed or it is installed
+ * with the latest released version, this returns false.
+ */
+ public boolean hasUpdate() {
+ // Should never be null
+ PluginVersion latestVersion = getLatestReleasedVersion();
+ PluginVersion installedVersion = getInstalled();
+ if (installedVersion == null) {
+ return false;
+ }
+ return isVersionHigher(latestVersion, installedVersion);
+ }
+
+ /**
+ * Checks if the first plugin is higher than the second plugin argument.
+ * False otherwise, including if one or the other or both arguments are
+ * null. True if and only if both version are NOT null and the first
+ * version is higher than the second.
+ *
+ * @param data1
+ * @param data2
+ * @return true if data1 is higher than data2
+ */
+ public static boolean isVersionHigher(PluginVersion data1,
+ PluginVersion data2) {
+ String version1 = data1.getVersion();
+ String version2 = data2.getVersion();
+ if (version1 != null && version2 != null) {
+ return version1.compareToIgnoreCase(version2) > 0;
+ }
+ return false;
+ }
+
+ @Override
+ public String toString() {
+ StringBuilder sb = new StringBuilder();
+ sb.append(name);
+ if (isInplace) {
+ sb.append(" (in-place)");
+ }
+ return sb.toString();
+ }
+
+
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/plugins/PluginService.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/plugins/PluginService.java
new file mode 100644
index 000000000..011cc2297
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/plugins/PluginService.java
@@ -0,0 +1,35 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.plugins;
+
+import java.util.List;
+
+/**
+ * An abstract implementation of a service for managing plug-ins.
+ *
+ * @author Steffen Pingel
+ */
+public abstract class PluginService {
+
+ public enum InstallOrUpgradeStatus {
+ SUCCESS, FAILED, INVALID_REPOSITORY_URL, VERIFICATION_NEEDED
+ }
+
+ public abstract InstallOrUpgradeStatus install(PluginVersion plugin);
+
+ public abstract List search(String searchTerms, boolean refresh,
+ boolean trustedOnly, boolean compatibleOnly);
+
+ public abstract InstallOrUpgradeStatus remove(PluginVersion plugin);
+
+ public abstract InstallOrUpgradeStatus upgrade(PluginVersion plugin);
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/plugins/PluginVersion.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/plugins/PluginVersion.java
new file mode 100644
index 000000000..e46259d34
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/internal/plugins/PluginVersion.java
@@ -0,0 +1,72 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.internal.plugins;
+
+/**
+ * Model element that represents a version of a plugin. It is usually a
+ * child of a plugin model element.
+ *
+ * @author Nieraj Singh
+ * @author Kris De Volder
+ */
+public class PluginVersion extends BasePluginData {
+
+ private Plugin parent;
+ private boolean isInstalled;
+
+ public PluginVersion() {
+ //
+ }
+
+ public PluginVersion(BasePluginData data) {
+ setData(data);
+ }
+
+ public void setParent(Plugin parent) {
+ this.parent = parent;
+ }
+
+ public Plugin getParent() {
+ return parent;
+ }
+
+ public void setInstalled(boolean isInstalled) {
+ this.isInstalled = isInstalled;
+ }
+
+ public boolean isInstalled() {
+ return isInstalled;
+ }
+
+ /**
+ * Support for copying a dependency data into the version model.
+ *
+ * @param data
+ */
+ protected void setData(BasePluginData data) {
+ if (data == null) {
+ return;
+ }
+ setName(data.getName());
+ setAuthor(data.getAuthor());
+ setDescription(data.getDescription());
+ setDocumentation(data.getDocumentation());
+ setRuntimeVersion(data.getRuntimeVersion());
+ setVersion(data.getVersion());
+ setTitle(data.getTitle());
+ }
+
+ @Override
+ public String toString() {
+ return getName()+"["+getVersion()+"]";
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/legacyconversion/AbstractLegacyConverter.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/legacyconversion/AbstractLegacyConverter.java
new file mode 100644
index 000000000..acbc83895
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/legacyconversion/AbstractLegacyConverter.java
@@ -0,0 +1,122 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.legacyconversion;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.nio.channels.FileChannel;
+import java.util.Properties;
+import java.util.Map.Entry;
+
+import org.eclipse.core.internal.utils.FileUtil;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.springsource.ide.eclipse.commons.frameworks.core.FrameworkCoreActivator;
+
+/**
+ * Shared methods between the two converter classes
+ * @author Andrew Eisenberg
+ * @since 3.0.0
+ */
+public abstract class AbstractLegacyConverter implements IConversionConstants {
+ public abstract IStatus convert(IProgressMonitor monitor);
+
+ protected void copyPluginStateLocation(String from,
+ String to) throws IOException {
+ File oldPreferencesFolder = FrameworkCoreActivator.getDefault().getStateLocation().removeLastSegments(1).append(from).toFile();
+ if (oldPreferencesFolder.exists() && oldPreferencesFolder.isDirectory()) {
+ File newPreferencesFolder = FrameworkCoreActivator.getDefault().getStateLocation().removeLastSegments(1).append(to).toFile();
+ copyDirectory(oldPreferencesFolder, newPreferencesFolder);
+ }
+ }
+
+ /**
+ * @param oldFolder
+ * @param newFolder
+ * @throws IOException
+ */
+ private void copyDirectory(File oldFolder, File newFolder)
+ throws IOException {
+ if (!newFolder.exists()) {
+ newFolder.mkdir();
+ }
+
+ // copy everything and delete old so we never have to do this again
+ for (File oldFile : oldFolder.listFiles()) {
+ String oldName = oldFile.getName();
+ String newName = oldName.replace(GRAILS_OLD_PLUGIN_NAME, GRAILS_NEW_PLUGIN_NAME);
+ newName = newName.replace(ROO_OLD_PLUGIN_NAME, ROO_NEW_PLUGIN_NAME);
+ File newFile = new File(newFolder, newName);
+ if (oldFile.isDirectory()) {
+ copyDirectory(new File(oldFolder, oldName), new File(newFolder, newName));
+ } else {
+ copyFile(oldFile, newFile);
+ }
+ }
+ }
+ /**
+ * Copies a preference file from the old location to the new one, replacing prefixes of the appropriate settings
+ *
+ * @param settingsFile the original settings file to copy
+ * @param newSettingsFile the new settings file to create
+ * @param oldPrefix old prefix of keys to migrate set to null if not using prefixes
+ * @param newPrefix new key prefix
+ */
+ protected void copyPreferencesFile(File settingsFile, File newSettingsFile, String oldPrefix, String newPrefix) throws IOException,
+ CoreException, FileNotFoundException {
+ if (settingsFile.exists()) {
+ Properties oldProps = new Properties();
+ oldProps.load(new FileInputStream(settingsFile));
+ Properties newProps = new Properties();
+ for (Entry prop : oldProps.entrySet()) {
+ String oldKey = prop.getKey().toString();
+ String newKey;
+ if (oldPrefix != null && oldKey.startsWith(oldPrefix)) {
+ newKey = oldKey.replace(oldPrefix, newPrefix);
+ } else {
+ newKey = oldKey;
+ }
+ newProps.put(newKey, prop.getValue());
+ }
+ newProps.store(new FileOutputStream(newSettingsFile), ""); //$NON-NLS-1$
+ }
+ }
+
+ public static void copyFile(File sourceFile, File destFile)
+ throws IOException {
+ if (!sourceFile.exists()) {
+ return;
+ }
+ if (!destFile.exists()) {
+ destFile.createNewFile();
+ }
+
+ FileChannel source = null;
+ FileChannel destination = null;
+
+ try {
+ source = new FileInputStream(sourceFile).getChannel();
+ destination = new FileOutputStream(destFile).getChannel();
+ destination.transferFrom(source, 0, source.size());
+ } finally {
+ if (source != null) {
+ source.close();
+ }
+ if (destination != null) {
+ destination.close();
+ }
+ }
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/legacyconversion/IConversionConstants.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/legacyconversion/IConversionConstants.java
new file mode 100644
index 000000000..387afc9b2
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/legacyconversion/IConversionConstants.java
@@ -0,0 +1,107 @@
+/*******************************************************************************
+ * Copyright (c) 2012, 2020 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.legacyconversion;
+
+/**
+ * Set of constants to be used to
+ * convert legacy (pre-3.0) STS projects to 3.0 projects.
+ * @author Andrew Eisenberg
+ * @since 3.0.0
+ */
+public interface IConversionConstants {
+ String AUTO_CHECK_FOR_LEGACY_STS_PROJECTS = "org.springsource.ide.eclipse.commons.frameworks.ui.legacyconversion.autocheck"; //$NON-NLS-1$
+ String LEGACY_MIGRATION_ALREADY_DONE = "org.springsource.ide.eclipse.commons.frameworks.ui.legacyconversion.done"; //$NON-NLS-1$
+ // comma separated list of plugins that already have run plugin-specific legacy conversion code
+ String LEGACY_MIGRATION_PLUGINS = "org.springsource.ide.eclipse.commons.frameworks.ui.legacyconversion.plugins"; //$NON-NLS-1$
+
+ // GRAILS
+ String GRAILS_OLD_PREFERENCE_PREFIX = "com.springsource.sts.grails"; //$NON-NLS-1$
+ String GRAILS_NEW_PREFERENCE_PREFIX = "org.grails.ide.eclipse"; //$NON-NLS-1$
+
+ String GRAILS_OLD_PLUGIN_NAME = GRAILS_OLD_PREFERENCE_PREFIX + ".core"; //$NON-NLS-1$
+ String GRAILS_NEW_PLUGIN_NAME = GRAILS_NEW_PREFERENCE_PREFIX + ".core"; //$NON-NLS-1$
+
+ String GRAILS_OLD_NATURE = GRAILS_OLD_PLUGIN_NAME + ".nature"; //$NON-NLS-1$
+ String GRAILS_NEW_NATURE = GRAILS_NEW_PLUGIN_NAME + ".nature"; //$NON-NLS-1$
+
+ String GRAILS_OLD_CONTAINER = GRAILS_OLD_PLUGIN_NAME + ".CLASSPATH_CONTAINER"; //$NON-NLS-1$
+ String GRAILS_NEW_CONTAINER = GRAILS_NEW_PLUGIN_NAME + ".CLASSPATH_CONTAINER"; //$NON-NLS-1$
+
+ String GRAILS_OLD_ATTRIBUTE = GRAILS_OLD_PLUGIN_NAME + ".SOURCE_FOLDER"; //$NON-NLS-1$
+ String GRAILS_NEW_ATTRIBUTE = GRAILS_NEW_PLUGIN_NAME + ".SOURCE_FOLDER"; //$NON-NLS-1$
+
+ String GRAILS_OLD_PERSPECTIVE_ID = "com.springsource.sts.grails.perspective"; //$NON-NLS-1$
+ String GRAILS_NEW_PERSPECTIVE_ID = "org.grails.ide.eclipse.perspective"; //$NON-NLS-1$
+
+ // GRADLE
+ String GRADLE_OLD_PREFIX = "com.springsource.sts.gradle"; //$NON-NLS-1$
+ String GRADLE_NEW_PREFIX = "org.springsource.ide.eclipse.gradle"; //$NON-NLS-1$
+ String GRADLE_OLD_PLUGIN_NAME = "com.springsource.sts.gradle.core"; //$NON-NLS-1$
+ String GRADLE_NEW_PLUGIN_NAME = "org.springsource.ide.eclipse.gradle.core"; //$NON-NLS-1$
+ String GRADLE_OLD_NATURE = GRADLE_OLD_PLUGIN_NAME + ".nature"; //$NON-NLS-1$
+ String GRADLE_NEW_NATURE = GRADLE_NEW_PLUGIN_NAME + ".nature"; //$NON-NLS-1$
+
+ // ROO
+ String ROO_OLD_NATURE = "com.springsource.sts.roo.core.nature"; //$NON-NLS-1$
+ String ROO_NEW_NATURE = "com.springsource.sts.roo.core.nature"; //$NON-NLS-1$
+
+ String ROO_OLD_PLUGIN_NAME = "com.springsource.sts.roo.core"; //$NON-NLS-1$
+ String ROO_NEW_PLUGIN_NAME = "org.springframework.ide.eclipse.roo.core"; //$NON-NLS-1$
+
+ String ROO_OLD_UI_NAME = "com.springsource.sts.roo.ui"; //$NON-NLS-1$
+ String ROO_NEW_UI_NAME = "org.springframework.ide.eclipse.roo.ui"; //$NON-NLS-1$
+
+ // OTHER
+ String STS_OLD_CONTENT_CORE = "com.springsource.sts.content.core"; //$NON-NLS-1$
+ String STS_NEW_CONTENT_CORE = "org.springsource.ide.eclipse.commons.content.core"; //$NON-NLS-1$
+
+ String STS_OLD_CORE = "com.springsource.sts.core"; //$NON-NLS-1$
+ String STS_NEW_CORE = "org.springsource.ide.eclipse.commons.core"; //$NON-NLS-1$
+
+ String STS_OLD_IDE_UI = "com.springsource.sts.ide.ui"; //$NON-NLS-1$
+ String STS_NEW_IDE_UI = "org.springsource.ide.eclipse.dashboard.ui"; //$NON-NLS-1$
+
+ String[] STS_OLD_WORKSPACE_PREFS = new String[] {
+ "com.springsource.sts.grails.core", //$NON-NLS-1$
+ "com.springsource.sts.grails.ui", //$NON-NLS-1$
+ "com.springsource.sts.grails.editor.gsp", //$NON-NLS-1$
+ "com.springsource.sts.grails.explorer", //$NON-NLS-1$
+ "com.springsource.sts.grails.refactoring", //$NON-NLS-1$
+ "com.springsource.sts.grails.groovy.debug.core", //$NON-NLS-1$
+ "com.springsource.sts.config.ui", //$NON-NLS-1$
+ "com.springsource.sts.core", //$NON-NLS-1$
+ // "com.springsource.sts.gradle.core", Gradle does its own thing.
+ "com.springsource.sts.groovy.debug.core", //$NON-NLS-1$
+ "com.springsource.sts.ide.metadata", //$NON-NLS-1$
+ "com.springsource.sts.maven", //$NON-NLS-1$
+ "com.springsource.sts.ide.osgi", //$NON-NLS-1$
+ "com.springsource.sts.ide.ui", //$NON-NLS-1$
+ //"com.springsource.sts.config.flow", //$NON-NLS-1$
+ };
+ String[] STS_NEW_WORKSPACE_PREFS = new String[] {
+ "org.grails.ide.eclipse.core", //$NON-NLS-1$
+ "org.grails.ide.eclipse.ui", //$NON-NLS-1$
+ "org.grails.ide.eclipse.editor.gsp", //$NON-NLS-1$
+ "org.grails.ide.eclipse.explorer", //$NON-NLS-1$
+ "org.grails.ide.eclipse.refactoring", //$NON-NLS-1$
+ "org.grails.ide.eclipse.groovy.debug.core", //$NON-NLS-1$
+ "org.springframework.ide.eclipse.config.ui", //$NON-NLS-1$
+ "org.springsource.ide.eclipse.commons.core", //$NON-NLS-1$
+// "org.springsource.ide.eclipse.gradle.core", //$NON-NLS-1$
+ "org.grails.ide.eclipse.groovy.debug.core", //$NON-NLS-1$
+ "org.springframework.ide.eclipse.metadata", //$NON-NLS-1$
+ "org.springframework.ide.eclipse.maven", //$NON-NLS-1$
+ "org.springframework.ide.eclipse.osgi.runtime", //$NON-NLS-1$
+ "org.springsource.ide.eclipse.dashboard.ui", //$NON-NLS-1$
+ //"org.springframework.ide.eclipse.config.graph" //$NON-NLS-1$
+ };
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/legacyconversion/LegacyProjectConverter.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/legacyconversion/LegacyProjectConverter.java
new file mode 100644
index 000000000..3c4ea28f3
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/legacyconversion/LegacyProjectConverter.java
@@ -0,0 +1,222 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.legacyconversion;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.eclipse.core.resources.IFolder;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.resources.IProjectDescription;
+import org.eclipse.core.resources.IResource;
+import org.eclipse.core.resources.ResourcesPlugin;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.MultiStatus;
+import org.eclipse.core.runtime.NullProgressMonitor;
+import org.eclipse.core.runtime.OperationCanceledException;
+import org.eclipse.core.runtime.Path;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.SubMonitor;
+import org.eclipse.core.runtime.jobs.Job;
+import org.eclipse.core.runtime.preferences.InstanceScope;
+import org.eclipse.jdt.core.IClasspathAttribute;
+import org.eclipse.jdt.core.IClasspathEntry;
+import org.eclipse.jdt.core.IJavaProject;
+import org.eclipse.jdt.core.JavaCore;
+import org.springsource.ide.eclipse.commons.frameworks.core.FrameworkCoreActivator;
+
+/**
+ * Converts legacy maven projects to the new m2e
+ * @author Andrew Eisenberg
+ * @since 3.0.0
+ */
+public class LegacyProjectConverter extends AbstractLegacyConverter implements IConversionConstants {
+
+ private final List allLegacyProjects;
+ private IProject[] selectedLegacyProjects;
+
+ /**
+ * Converts a single project
+ */
+ public LegacyProjectConverter(IProject legacyProject) {
+ allLegacyProjects = Collections.singletonList(legacyProject);
+ selectedLegacyProjects = new IProject[] { legacyProject };
+ }
+
+ public LegacyProjectConverter(List legacyProjects) {
+ this.allLegacyProjects = legacyProjects;
+ }
+
+ public List getAllLegacyProjects() {
+ return allLegacyProjects;
+ }
+
+ public IProject[] getSelectedLegacyProjects() {
+ return selectedLegacyProjects;
+ }
+
+ public void setSelectedLegacyProjects(IProject[] selectedLegacyProjects) {
+ this.selectedLegacyProjects = selectedLegacyProjects;
+ }
+
+ public IStatus convert(IProgressMonitor monitor) {
+ if (monitor == null) {
+ monitor = new NullProgressMonitor();
+ }
+ SubMonitor sub = SubMonitor.convert(monitor, selectedLegacyProjects.length);
+ IStatus[] statuses = new IStatus[selectedLegacyProjects.length];
+ int i = 0;
+ for (IProject project : selectedLegacyProjects) {
+ if (project.isAccessible()) {
+ sub.subTask("Converting " + project.getName()); //$NON-NLS-1$
+ if (sub.isCanceled()) {
+ throw new OperationCanceledException();
+ }
+ statuses[i++] = convert(project, monitor);
+ } else {
+ // project was closed before job started.
+ statuses[i++] = Status.OK_STATUS;
+ }
+ sub.worked(1);
+ }
+
+ return new MultiStatus(FrameworkCoreActivator.PLUGIN_ID, 0, statuses, "Result of converting legacy maven projects", null); //$NON-NLS-1$
+ }
+
+
+ private IStatus convert(IProject project, IProgressMonitor monitor) {
+ SubMonitor sub = SubMonitor.convert(monitor, 1);
+ // grab project rule
+ Job.getJobManager().beginRule(ResourcesPlugin.getWorkspace().getRoot(), sub);
+ try {
+ if (project.hasNature(GRAILS_OLD_NATURE)) {
+ convertGrailsProject(project, sub);
+ } else if (project.hasNature(ROO_OLD_NATURE)) {
+ convertRooProject(project, sub);
+ } else if (project.hasNature(GRADLE_OLD_NATURE)) {
+ convertGradleProject(project, sub);
+ }
+ } catch (Exception e) {
+ return new Status(IStatus.ERROR, FrameworkCoreActivator.PLUGIN_ID, "Failed to convert " + project.getName(), e); //$NON-NLS-1$
+ } finally {
+ // release rule
+ Job.getJobManager().endRule(ResourcesPlugin.getWorkspace().getRoot());
+ }
+ sub.worked(1);
+ return new Status(IStatus.OK, FrameworkCoreActivator.PLUGIN_ID, "Converted " + project.getName()); //$NON-NLS-1$
+ }
+
+ private static void convertGradleProject(IProject project, SubMonitor sub) throws Exception {
+ // nature
+ IProjectDescription description = project.getDescription();
+ String[] ids = description.getNatureIds();
+ List newIds = new ArrayList(ids.length);
+ for (int i = 0; i < ids.length; i++) {
+ if (!ids[i].equals(GRADLE_OLD_NATURE) && !ids[i].equals(GRADLE_NEW_NATURE)) {
+ newIds.add(ids[i]);
+ } else {
+ newIds.add(GRADLE_NEW_NATURE);
+ }
+ }
+ description.setNatureIds(newIds.toArray(new String[0]));
+ project.setDescription(description, sub);
+
+ // project preferences
+ // DO NOTHING: gradle tooling handles these itself by reading in both old and new locations.
+
+ // classpath container
+ IJavaProject javaProject = JavaCore.create(project);
+ IClasspathEntry[] classpath = javaProject.getRawClasspath();
+ List newClasspath = new ArrayList();
+ for (int i = 0; i < classpath.length; i++) {
+ IClasspathEntry entry = classpath[i];
+ if (entry.getEntryKind()==IClasspathEntry.CPE_CONTAINER) {
+ String path = entry.getPath().toString();
+ if (path.contains(GRADLE_OLD_PREFIX)) {
+ entry = JavaCore.newContainerEntry(new Path(path.replace(GRADLE_OLD_PREFIX, GRADLE_NEW_PREFIX)),
+ entry.getAccessRules(), entry.getExtraAttributes(), entry.isExported());
+ }
+ }
+ newClasspath.add(entry);
+ }
+ javaProject.setRawClasspath(newClasspath.toArray(new IClasspathEntry[0]), sub);
+ }
+
+ private void convertGrailsProject(IProject project, SubMonitor sub) throws Exception {
+ // nature
+ IProjectDescription description = project.getDescription();
+ String[] ids = description.getNatureIds();
+ List newIds = new ArrayList(ids.length);
+ for (int i = 0; i < ids.length; i++) {
+ if (!ids[i].equals(GRAILS_OLD_NATURE) && !ids[i].equals(GRAILS_NEW_NATURE)) {
+ newIds.add(ids[i]);
+ } else {
+ newIds.add(GRAILS_NEW_NATURE);
+ }
+ }
+ description.setNatureIds(newIds.toArray(new String[0]));
+ project.setDescription(description, sub);
+
+ // project preferences
+ IFolder preferencesFolder = project.getFolder(".settings/"); //$NON-NLS-1$
+ File settingsFile = preferencesFolder.getFile(GRAILS_OLD_PLUGIN_NAME + ".prefs").getLocation().toFile(); //$NON-NLS-1$ //$NON-NLS-2$
+ File newSettingsFile = preferencesFolder.getFile(GRAILS_NEW_PLUGIN_NAME + ".prefs").getLocation().toFile(); //$NON-NLS-1$ //$NON-NLS-2$
+ copyPreferencesFile(settingsFile, newSettingsFile, GRAILS_OLD_PREFERENCE_PREFIX, GRAILS_NEW_PREFERENCE_PREFIX);
+ InstanceScope.INSTANCE.getNode(GRAILS_OLD_PLUGIN_NAME).sync();
+ preferencesFolder.refreshLocal(IResource.DEPTH_ONE, sub);
+
+ // classpath container
+ IJavaProject javaProject = JavaCore.create(project);
+ IClasspathEntry[] classpath = javaProject.getRawClasspath();
+ List newClasspath = new ArrayList();
+ for (int i = 0; i < classpath.length; i++) {
+ if (classpath[i].getPath().toString().equals(GRAILS_OLD_CONTAINER)) {
+ newClasspath.add(JavaCore.newContainerEntry(new Path(GRAILS_NEW_CONTAINER), classpath[i].getAccessRules(), convertGrailsClasspathAttributes(classpath[i]), classpath[i].isExported()));
+ } else if (classpath[i].getEntryKind() == IClasspathEntry.CPE_SOURCE) {
+ newClasspath.add(JavaCore.newSourceEntry(classpath[i].getPath(), classpath[i].getInclusionPatterns(),
+ classpath[i].getExclusionPatterns(), classpath[i].getOutputLocation(), convertGrailsClasspathAttributes(classpath[i])));
+ } else {
+ newClasspath.add(classpath[i]);
+ }
+ }
+ javaProject.setRawClasspath(newClasspath.toArray(new IClasspathEntry[0]), sub);
+ }
+
+ private IClasspathAttribute[] convertGrailsClasspathAttributes(
+ IClasspathEntry entry) {
+ IClasspathAttribute[] oldAttributes = entry.getExtraAttributes();
+ if (oldAttributes == null || oldAttributes.length == 0) {
+ return new IClasspathAttribute[0];
+ }
+ IClasspathAttribute[] newAttributes = new IClasspathAttribute[oldAttributes.length];
+ for (int i = 0; i < oldAttributes.length; i++) {
+ if (oldAttributes[i].getName().equals(GRAILS_OLD_ATTRIBUTE)) {
+ newAttributes[i] = JavaCore.newClasspathAttribute(GRAILS_NEW_ATTRIBUTE, oldAttributes[i].getValue());
+ } else {
+ newAttributes[i] = oldAttributes[i];
+ }
+ }
+
+ return newAttributes;
+ }
+
+ private void convertRooProject(IProject project, SubMonitor sub) throws Exception {
+ IFolder preferencesFolder = project.getFolder(".settings/"); //$NON-NLS-1$
+ File settingsFile = preferencesFolder.getFile(ROO_OLD_PLUGIN_NAME + ".prefs").getLocation().toFile(); //$NON-NLS-1$ //$NON-NLS-2$
+ File newSettingsFile = preferencesFolder.getFile(ROO_NEW_PLUGIN_NAME + ".prefs").getLocation().toFile(); //$NON-NLS-1$ //$NON-NLS-2$
+ copyPreferencesFile(settingsFile, newSettingsFile, ROO_OLD_PLUGIN_NAME, ROO_NEW_PLUGIN_NAME);
+ InstanceScope.INSTANCE.getNode(ROO_OLD_PLUGIN_NAME).sync();
+ preferencesFolder.refreshLocal(IResource.DEPTH_ONE, sub);
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/legacyconversion/LegacyWorkspaceConverter.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/legacyconversion/LegacyWorkspaceConverter.java
new file mode 100644
index 000000000..b4a77a259
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/legacyconversion/LegacyWorkspaceConverter.java
@@ -0,0 +1,127 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.legacyconversion;
+
+import java.io.File;
+import java.io.IOException;
+
+import org.eclipse.core.internal.runtime.InternalPlatform;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.MultiStatus;
+import org.eclipse.core.runtime.NullProgressMonitor;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.SubMonitor;
+import org.eclipse.core.runtime.preferences.InstanceScope;
+import org.eclipse.jface.preference.IPreferenceStore;
+import org.springsource.ide.eclipse.commons.frameworks.core.FrameworkCoreActivator;
+
+/**
+ * Converts legacy 2.x workspace preferences into 3.x preferences
+ * @author Andrew Eisenberg
+ * @since 3.0.0
+ */
+public class LegacyWorkspaceConverter extends AbstractLegacyConverter implements IConversionConstants {
+ private static final IPreferenceStore PREFERENCE_STORE = FrameworkCoreActivator.getDefault().getPreferenceStore();
+
+ public boolean shouldAutoConvert() {
+ return ! PREFERENCE_STORE.getBoolean(LEGACY_MIGRATION_ALREADY_DONE);
+ }
+
+ public IStatus convert(IProgressMonitor monitor) {
+ if (monitor == null) {
+ monitor = new NullProgressMonitor();
+ }
+ SubMonitor sub = SubMonitor.convert(monitor, 4);
+
+ IStatus[] statuses = new IStatus[4];
+
+ statuses[0] = copyPluginPreferences(sub);
+ // nothing to do for grails any more
+// statuses[1] = convertGrailsWorkspacePreferences(sub);
+ statuses[1] = Status.OK_STATUS;
+ statuses[2] = convertRooWorkspacePreferences(sub);
+ statuses[3] = convertSTSPreferences(sub);
+
+ IStatus result = new MultiStatus(FrameworkCoreActivator.PLUGIN_ID, 0, statuses,
+ "Result of converting legacy STS 2.x workspace preferences to 3.x", null); //$NON-NLS-1$
+ // FrameworkCoreActivator.getDefault().getLog().log(result);
+ if (result.isOK()) {
+ PREFERENCE_STORE.setValue(LEGACY_MIGRATION_ALREADY_DONE, true);
+ }
+ return result;
+ }
+
+
+ /**
+ * Copies preferences inside of the
+ * @param sub
+ * @return
+ */
+ private IStatus copyPluginPreferences(SubMonitor sub) {
+ sub.subTask("Copying plugin preferences for legacy STS workspace"); //$NON-NLS-1$
+ try {
+ File prefsFolder = InternalPlatform.getDefault().getRuntimeInstance().getStateLocation().toFile();
+ prefsFolder = new File(prefsFolder, ".settings");
+ for (int i = 0; i < STS_OLD_WORKSPACE_PREFS.length; i++) {
+ if (STS_NEW_WORKSPACE_PREFS[i].equals("???")) { //$NON-NLS-1$
+ continue;
+ }
+ copyPreferencesFile(new File(prefsFolder, STS_OLD_WORKSPACE_PREFS[i] + ".prefs"), new File(prefsFolder, STS_NEW_WORKSPACE_PREFS[i] + ".prefs"), STS_OLD_WORKSPACE_PREFS[i], STS_NEW_WORKSPACE_PREFS[i]); //$NON-NLS-1$ //$NON-NLS-2$
+ InstanceScope.INSTANCE.getNode(STS_NEW_WORKSPACE_PREFS[i]).sync();
+ }
+ } catch (Exception e) {
+ return new Status(IStatus.ERROR, FrameworkCoreActivator.PLUGIN_ID, "Failed to convert legacy STS workspace preferences", e); //$NON-NLS-1$
+ }
+ return new Status(IStatus.OK, FrameworkCoreActivator.PLUGIN_ID, "Converted legacy STS plugin preferences"); //$NON-NLS-1$
+ }
+
+ private IStatus convertSTSPreferences(SubMonitor sub) {
+ sub.subTask("Converting STS plugin state locations"); //$NON-NLS-1$
+ try {
+ copyPluginStateLocation(STS_OLD_CONTENT_CORE, STS_NEW_CONTENT_CORE);
+ copyPluginStateLocation(STS_OLD_CORE, STS_NEW_CORE);
+ copyPluginStateLocation(STS_OLD_IDE_UI, STS_NEW_IDE_UI);
+ return new Status(IStatus.OK, FrameworkCoreActivator.PLUGIN_ID, "Converted legacy STS plugin state locations"); //$NON-NLS-1$
+ } catch (IOException e) {
+ return new Status(IStatus.ERROR, FrameworkCoreActivator.PLUGIN_ID, "Failed to convert legacy STS plugin state locations", e); //$NON-NLS-1$
+ } finally {
+ sub.worked(1);
+ }
+ }
+
+ // TODO FIXADE Probably safe to delete
+// private IStatus convertGrailsWorkspacePreferences(SubMonitor sub) {
+// sub.subTask("Converting Grails plugin state locations"); //$NON-NLS-1$
+// try {
+// copyPluginStateLocation(GRAILS_OLD_PREFERENCE_PREFIX, GRAILS_NEW_PREFERENCE_PREFIX);
+// return new Status(IStatus.OK, FrameworkCoreActivator.PLUGIN_ID, "Converted legacy Grails plugin state locations"); //$NON-NLS-1$
+// } catch (IOException e) {
+// return new Status(IStatus.ERROR, FrameworkCoreActivator.PLUGIN_ID, "Failed to convert legacy Grails plugin state locations", e); //$NON-NLS-1$
+// } finally {
+// sub.worked(1);
+// }
+// }
+
+ private IStatus convertRooWorkspacePreferences(SubMonitor sub) {
+ sub.subTask("Converting Roo plugin state locations"); //$NON-NLS-1$
+ try {
+ // Let RooInstallManager migrate the roo.installs content
+ // copyPluginStateLocation(ROO_OLD_PLUGIN_NAME, ROO_NEW_PLUGIN_NAME);
+ copyPluginStateLocation(ROO_OLD_UI_NAME, ROO_NEW_UI_NAME);
+ return new Status(IStatus.OK, FrameworkCoreActivator.PLUGIN_ID, "Converted legacy Roo plugin state locations"); //$NON-NLS-1$
+ } catch (IOException e) {
+ return new Status(IStatus.ERROR, FrameworkCoreActivator.PLUGIN_ID, "Failed to convert legacy Roo plugin state locations", e); //$NON-NLS-1$
+ } finally {
+ sub.worked(1);
+ }
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/maintype/IMainTypeFinder.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/maintype/IMainTypeFinder.java
new file mode 100644
index 000000000..0582a4e26
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/maintype/IMainTypeFinder.java
@@ -0,0 +1,34 @@
+/*******************************************************************************
+ * Copyright (c) 2013 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.maintype;
+
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.jdt.core.IJavaProject;
+import org.eclipse.jdt.core.IType;
+
+public interface IMainTypeFinder {
+
+ /**
+ * Finds main types in a given Java project. If no types are found, an empty
+ * value is returned.
+ *
+ * @param project
+ * java project where main types should be searched.
+ * @param mon
+ * @return non-null list of main types in the project. Return empty value if
+ * no main types are found.
+ * @throws Exception
+ * if failure occurred while finding main types
+ */
+ public IType[] findMain(IJavaProject project, IProgressMonitor mon)
+ throws Exception;
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/maintype/MainTypeFinder.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/maintype/MainTypeFinder.java
new file mode 100644
index 000000000..ebf45ec74
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/maintype/MainTypeFinder.java
@@ -0,0 +1,252 @@
+/*******************************************************************************
+ * Copyright (c) 2012, 2013 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.maintype;
+
+import java.util.ArrayList;
+import java.util.LinkedHashMap;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.Set;
+
+import org.eclipse.core.resources.IFile;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.SubProgressMonitor;
+import org.eclipse.jdt.core.IClasspathEntry;
+import org.eclipse.jdt.core.IJavaElement;
+import org.eclipse.jdt.core.IJavaProject;
+import org.eclipse.jdt.core.IPackageFragmentRoot;
+import org.eclipse.jdt.core.IType;
+import org.eclipse.jdt.core.JavaModelException;
+import org.eclipse.jdt.core.search.IJavaSearchScope;
+import org.eclipse.jdt.core.search.SearchEngine;
+import org.eclipse.jdt.internal.debug.ui.launcher.MainMethodSearchEngine;
+import org.springsource.ide.eclipse.commons.frameworks.core.ExceptionUtil;
+import org.springsource.ide.eclipse.commons.frameworks.core.FrameworkCoreActivator;
+
+/**
+ * Provides access to heuristic algorithms to 'guess' the main type for a
+ * project.
+ *
+ * Note: these algorithms may depend on project type and require access to
+ * various optional dependencies. E.g. gradle tooling for gradle projects, m2e
+ * for pom based algorithms etc.
+ *
+ * Ideally in the future additional algorithms should be contributable via
+ * extension point so that we don't need to add a gazilion dependencies in this
+ * plugin, but clients can depend on this plugin and implicitly gain access if
+ * the required stuff is installed.
+ *
+ * @author Kris De Volder
+ */
+@SuppressWarnings("restriction")
+public class MainTypeFinder {
+
+ private static MainTypeFinder instance;
+
+ private static final IType[] EMPTY = new IType[0];
+
+ /**
+ * Find the most likely main types that should be run when a user select this
+ * project with 'run as'.
+ *
+ * @return Types with main method or empty value if the 'most likely' main type
+ * can't be determined.
+ * @throws CoreException
+ * if something unexpected happened..
+ */
+ public static IType[] guessMainTypes(IJavaProject project, IProgressMonitor mon)
+ throws CoreException {
+ return getInstance().internalGuessMainTypes(project, mon);
+ }
+
+ private static synchronized MainTypeFinder getInstance() {
+ if (instance == null) {
+ instance = new MainTypeFinder();
+ }
+ return instance;
+ }
+
+ private Map algos;
+
+ /**
+ * Singelton, use getInstance or call one of the static public methods.
+ */
+ private MainTypeFinder() {
+ // TODO: support contributing additional algos with priorities via
+ // extension point
+ // Created as linked hash map so that iteration starts from highest to
+ // lowest confidence
+ this.algos = new LinkedHashMap();
+
+ // Add finders based on whether they return main types based on the confidence that
+ // they are exact types requested. For example, main types from pom files have high
+ // confidence that they are the types requested, whereas types from source have lower
+ // confidence that they are the types requested. Each confidence itself also has a priority
+ // order, with more authoritative finders listed first.
+ this.algos.put(Confidence.CERTAIN, new IMainTypeFinder[] {
+ // add in order of which is more authoritative
+ });
+
+ this.algos.put(Confidence.HIGH, new IMainTypeFinder[] {
+ // add more here if they should be considered more authorative
+ new FindInPom()
+ // add more here if they should be considered less authorative
+ });
+
+ this.algos.put(Confidence.LOW, new IMainTypeFinder[] {
+ // add more here if they should be considered more authorative
+ new FindInSource()
+ // add more here if they should be considered less authorative
+ });
+
+ }
+
+ private IType[] internalGuessMainTypes(IJavaProject project, IProgressMonitor mon)
+ throws CoreException {
+ Throwable error = null;
+ mon.beginTask("Search main types", algos.size());
+ Set totalTypes = new LinkedHashSet();
+
+ try {
+
+ for(Entry entry : algos.entrySet()) {
+ // Collect all types per confidence level
+ for (IMainTypeFinder algo : entry.getValue()) {
+ try {
+ IType[] found = algo.findMain(project, new SubProgressMonitor(mon, 1));
+ for (IType type : found) {
+ totalTypes.add(type);
+ }
+ } catch (Throwable e) {
+ if (error == null) {
+ // if multiple errors keep only the first one.
+ error = e;
+ }
+ }
+ }
+ // Stop when types of the highest confidence are found
+ if (!totalTypes.isEmpty()) {
+ break;
+ }
+ }
+
+ mon.worked(1);
+ } finally {
+ mon.done();
+ }
+ if (!totalTypes.isEmpty()) {
+ return totalTypes.toArray(new IType[0]);
+ } else {
+ // If there was an error throw it as an explanation of the failure.
+ if (error != null) {
+ throw ExceptionUtil.coreException(error);
+ }
+ }
+ return EMPTY;
+ }
+
+ private static final String MAIN_CLASS_PROP = "start-class";
+
+ public static class FindInPom implements IMainTypeFinder {
+
+ public IType[] findMain(IJavaProject jp, IProgressMonitor mon)
+ throws Exception {
+ mon.beginTask("Search main in pom", 1);
+ try {
+ IProject p = jp.getProject();
+ IFile pomFile = p.getFile("pom.xml");
+ if (pomFile.exists()) {
+ PomParser pomParser = new PomParser(pomFile);
+ String starterClassName = pomParser
+ .getProperty(MAIN_CLASS_PROP);
+ if (starterClassName != null) {
+ IType mainType = jp.findType(starterClassName);
+ if (mainType != null) {
+ return new IType[] { mainType };
+ }
+ throw ExceptionUtil.coreException("'pom.xml' defines '"
+ + MAIN_CLASS_PROP + "' as '" + starterClassName
+ + "' but it could not be found");
+ }
+ }
+ } finally {
+ mon.done();
+ }
+ return EMPTY;
+ }
+ }
+
+ public static class FindInSource implements IMainTypeFinder {
+
+ public IType[] findMain(IJavaProject javaProject,
+ IProgressMonitor monitor) throws Exception {
+ monitor.beginTask("Search main types in project source", 1);
+ try {
+
+ MainMethodSearchEngine engine = new MainMethodSearchEngine();
+ IJavaSearchScope scope = createSearchScope(javaProject);
+
+ boolean includeSubtypes = true;
+ IType[] types = engine
+ .searchMainMethods(monitor, scope, includeSubtypes);
+ if (types == null) {
+ types = EMPTY;
+ }
+ return types;
+ } catch (Exception e) {
+ FrameworkCoreActivator.log(e);
+ } finally {
+ monitor.done();
+ }
+ return EMPTY;
+ }
+
+ private IJavaSearchScope createSearchScope(IJavaProject javaProject) throws JavaModelException {
+ List pfrs = new ArrayList<>();
+ for (IPackageFragmentRoot pfr : javaProject.getAllPackageFragmentRoots()) {
+ IClasspathEntry cpe = pfr.getRawClasspathEntry();
+ if (isInteresting(cpe)) {
+ pfrs.add(pfr);
+ }
+ }
+
+ int constraints = IJavaSearchScope.SOURCES;
+ constraints |= IJavaSearchScope.APPLICATION_LIBRARIES;
+
+ return SearchEngine.createJavaSearchScope(
+ pfrs.toArray(new IJavaElement[pfrs.size()]), constraints);
+ }
+
+ private boolean isInteresting(IClasspathEntry cpe) {
+ if (cpe==null) {
+ return false;
+ }
+ int e_kind = cpe.getEntryKind();
+ return e_kind == IClasspathEntry.CPE_SOURCE
+ || (
+ e_kind == IClasspathEntry.CPE_CONTAINER &&
+ "org.jetbrains.kotlin.core.KOTLIN_CONTAINER".equals(cpe.getPath().segment(0))
+ );
+ }
+ }
+
+ /**
+ * Confidence that a search result for main types in a project is what is expected.
+ *
+ */
+ public static enum Confidence {
+ CERTAIN, HIGH, LOW
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/maintype/PomParser.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/maintype/PomParser.java
new file mode 100644
index 000000000..9c625537e
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/maintype/PomParser.java
@@ -0,0 +1,100 @@
+/*******************************************************************************
+ * Copyright (c) 2013 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.maintype;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.parsers.ParserConfigurationException;
+
+import org.eclipse.core.resources.IFile;
+import org.eclipse.core.runtime.CoreException;
+import org.springsource.ide.eclipse.commons.frameworks.core.ExceptionUtil;
+import org.springsource.ide.eclipse.commons.frameworks.core.util.XmlUtils;
+import org.w3c.dom.Document;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+import org.xml.sax.SAXException;
+
+//TODO: maybe we should use m2e in future. For now its simple enough we can do this ourselves
+// and avoid a mandatory dependency on m2e.
+
+/**
+ * Wrapper around a pom file. Can parse the pom and retrieve interesting data from it.
+ * It caches a Document internally so it avoids repeatedly parsing the same file
+ * for repeated info requests.
+ */
+class PomParser {
+
+ private Document doc;
+ private HashMap properties = null; //extracted from doc when first prop is requested.
+
+ private void parse(InputStream input) throws ParserConfigurationException, SAXException, IOException {
+ DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
+ DocumentBuilder dBuilder = dbFactory.newDocumentBuilder();
+ this.doc = dBuilder.parse(input);
+ }
+
+
+ public PomParser(IFile pomFile) throws CoreException {
+ parse(pomFile);
+ }
+
+
+ private void parse(IFile file) throws CoreException {
+ InputStream input = null;
+ try {
+ parse(input = file.getContents(true));
+ } catch (Exception e) {
+ throw ExceptionUtil.coreException(e);
+ } finally {
+ if (input!=null) {
+ try {
+ input.close();
+ } catch (IOException e) {
+ }
+ }
+ }
+ }
+
+ public String getProperty(String name) {
+ Map props = getProperties();
+ return props.get(name);
+ }
+
+
+ private Map getProperties() {
+ if (properties==null) {
+ properties = new HashMap();
+ NodeList propLists = doc.getElementsByTagName("properties");
+ //There should really only be one propList but anyhoo!
+ for (int i = 0; i < propLists.getLength(); i++) {
+ Node propList = propLists.item(i);
+ NodeList propNodes = propList.getChildNodes();
+ for (int j = 0; j < propNodes.getLength(); j++) {
+ Node propNode = propNodes.item(j);
+ String name = XmlUtils.getTagName(propNode);
+ if (name!=null) {
+ String value = propNode.getTextContent();
+ properties.put(name, value);
+ }
+ }
+ }
+ }
+ return properties;
+ }
+
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/ArrayEncoder.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/ArrayEncoder.java
new file mode 100644
index 000000000..b00ea73d2
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/ArrayEncoder.java
@@ -0,0 +1,86 @@
+/*******************************************************************************
+ * Copyright (c) 2012 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.util;
+
+import java.io.StringReader;
+import java.io.StringWriter;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Utilty methods for encoding / decoding an array of Strings into a single String.
+ *
+ * @author Kris De Volder
+ */
+public class ArrayEncoder {
+
+ private static final char ESCAPE_CHAR = '\\';
+ private static final char TERMINATOR_CHAR = ';';
+ private static final int BUFFER_SIZE = 1024;
+
+ /**
+ * Decode an array of Strings encoded as a single String by StringUtils encodeArray.
+ */
+ public static String[] decode(String encoded) {
+ if (encoded==null) {
+ return null;
+ }
+ // Encoding: String are terminated by a special terminator char. If the original String contains a separator
+ // character or an escape character it is escaped by preceding it with an escape character.
+
+ // Note: we use terminator char rather than a separator between Strings.
+ // This is because with a true separator, it will be impossible to distinguish between the encoding of an empty array
+ // and the encoding of an array with a single empty String.
+
+ // Examples: (terminator = ';' escape = '\\')
+
+ // new String[0] ==encode==> ""
+ // new String[] { "" } ==encode==> ";"
+ // new String[] { "Hello", "World" } ==encode==> "Hello;World;"
+
+ StringReader in = new StringReader(encoded);
+ List strings = new ArrayList();
+ StringBuffer currentString = new StringBuffer();
+ try {
+ for (int _c = in.read(); _c>=0; _c = in.read()) {
+ char c = (char)_c;
+ if (c==TERMINATOR_CHAR) {
+ strings.add(currentString.toString());
+ currentString = new StringBuffer();
+ } else if (c==ESCAPE_CHAR) {
+ c = (char)in.read();
+ currentString.append(c);
+ } else {
+ currentString.append(c);
+ }
+ }
+ } catch (Exception e) {
+ throw new IllegalStateException(e);
+ }
+ return strings.toArray(new String[strings.size()]);
+ }
+
+ public static String encode(String[] strings) {
+ StringWriter out = new StringWriter(BUFFER_SIZE);
+ for (String string : strings) {
+ for (int i = 0; i < string.length(); i++) {
+ char c = string.charAt(i);
+ if (c==ESCAPE_CHAR || c==TERMINATOR_CHAR) {
+ out.write(ESCAPE_CHAR);
+ }
+ out.write(c);
+ }
+ out.write(TERMINATOR_CHAR);
+ };
+ return out.toString();
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/DocumentRegion.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/DocumentRegion.java
new file mode 100644
index 000000000..572b9fcaa
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/DocumentRegion.java
@@ -0,0 +1,393 @@
+/*******************************************************************************
+ * Copyright (c) 2020 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.util;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.function.Predicate;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import org.eclipse.core.runtime.Assert;
+import org.eclipse.jface.text.BadLocationException;
+import org.eclipse.jface.text.IDocument;
+import org.eclipse.jface.text.IRegion;
+import org.eclipse.jface.text.ITypedRegion;
+import org.eclipse.jface.text.Region;
+import org.eclipse.jface.text.TypedRegion;
+import org.springsource.ide.eclipse.commons.livexp.util.ExceptionUtil;
+
+/**
+ * A non-sucky alternative to {@link IRegion}. Represents a region of text in a document.
+ *
+ * Caution: assumes the underlying document is not mutated during the lifetime of the
+ * region object (otherwise start/end positions may no longer be valid).
+ *
+ * Implements {@link CharSequence} for convenience (e.g you can use {@link DocumentRegion} as
+ * input to a {@link Pattern} and other standard JRE functions which expect a {@link CharSequence}.
+ *
+ * @author Kris De Volder
+ */
+public class DocumentRegion implements CharSequence {
+ final IDocument doc;
+ final int start;
+ final int end;
+ public DocumentRegion(IDocument doc, IRegion r) {
+ this(doc,
+ r.getOffset(),
+ r.getOffset()+r.getLength()
+ );
+ }
+
+ /**
+ * Constructs a {@link DocumentRegion} on a given document. Tries its
+ * best to behave sensibly when passed 'strange' coordinates by
+ * adjusting them logically rather than throw an Exception.
+ *
+ * A position before the start of the document is moved to be the start
+ * of the document.
+ *
+ * A position after the end of the document is moved to the end
+ * of the document.
+ *
+ * If 'end' position is before the start position it is moved be
+ * exactly at the start position (this avoids region with
+ * negative length).
+ */
+ public DocumentRegion(IDocument doc, int start, int end) {
+ this.doc = doc;
+ this.start = limitRange(start, 0, doc.getLength());
+ this.end = limitRange(end, start, doc.getLength());
+ }
+
+ /**
+ * Create {@link DocumentRegion} covering the whole document.
+ */
+ public DocumentRegion(IDocument doc) {
+ this(doc, 0, doc.getLength());
+ }
+
+ private int limitRange(int offset, int min, int max) {
+ if (offsetmax) {
+ return max;
+ }
+ return offset;
+ }
+
+ @Override
+ public String toString() {
+ return textBetween(doc, start, end);
+ }
+
+ public DocumentRegion trim() {
+ return trimEnd().trimStart();
+ }
+
+ public DocumentRegion trimStart() {
+ int howMany = 0;
+ int len = length();
+ while (howMany0) {
+ return subSequence(0, len-howMany);
+ }
+ return this;
+ }
+
+ /**
+ * Gets character from the region, offset from the start of the region
+ * @return the character from the document (char)0 if the offset is outside the region.
+ */
+ public char unsafeCharAt(int offset) {
+ if (offset<0 || offset>=length()) {
+ throw new IndexOutOfBoundsException(""+offset);
+ }
+ try {
+ return doc.getChar(start+offset);
+ } catch (BadLocationException e) {
+ throw new IndexOutOfBoundsException(""+offset);
+ }
+ }
+
+ /**
+ * Like charAt, but doesn't IndexOutOfBoundsException. Instead it
+ * return (char)0.
+ */
+ @Override
+ public char charAt(int offset) {
+ try {
+ return unsafeCharAt(offset);
+ } catch (IndexOutOfBoundsException e) {
+ return 0;
+ }
+ }
+
+ @Override
+ public int length() {
+ return end-start;
+ }
+
+ @Override
+ public DocumentRegion subSequence(int start, int end) {
+ int len = length();
+ Assert.isLegal(start>=0);
+ Assert.isLegal(end<=len);
+ if (start==0 && end==len) {
+ return this;
+ }
+ return new DocumentRegion(doc, this.start+start, this.start+end);
+ }
+
+ public boolean isEmpty() {
+ return length()==0;
+ }
+
+ public DocumentRegion subSequence(int start) {
+ return subSequence(start, length());
+ }
+
+ public IRegion asRegion() {
+ return new Region(start, end-start);
+ }
+
+ public ITypedRegion asTypedRegion(String type) {
+ return new TypedRegion(start, length(), type);
+ }
+
+
+ public int indexOf(char ch, int fromIndex) {
+ while (fromIndex < length()) {
+ if (charAt(fromIndex)==ch) {
+ return fromIndex;
+ }
+ fromIndex++;
+ }
+ return -1;
+ }
+
+ public DocumentRegion[] split(char c) {
+ List pieces = new ArrayList<>();
+ int start = 0;
+ int end;
+ while ((end=indexOf(c, start))>=0) {
+ pieces.add(subSequence(start, end));
+ start = end+1;
+ }
+ // Do not forget the last piece!
+ pieces.add(subSequence(start, length()));
+ return pieces.toArray(new DocumentRegion[pieces.size()]);
+ }
+
+ public DocumentRegion[] split(Pattern delimiter) {
+ List pieces = new ArrayList<>();
+ int start = 0;
+ Matcher matcher = delimiter.matcher(this);
+ while (matcher.find(start)) {
+ int end = matcher.start();
+ pieces.add(subSequence(start, end));
+ start = matcher.end();
+ }
+ // Do not forget the last piece!
+ pieces.add(subSequence(start, length()));
+ return pieces.toArray(new DocumentRegion[pieces.size()]);
+ }
+
+ /**
+ * Removes a single occurrence of pat from the start of this region.
+ */
+ public DocumentRegion trimStart(Pattern pat) {
+ pat = Pattern.compile("^("+pat.pattern()+")");
+ Matcher matcher = pat.matcher(this);
+ if (matcher.find()) {
+ return subSequence(matcher.end());
+ }
+ return this;
+ }
+
+ /**
+ * Removes a single occurrence of pat from the end of this region.
+ */
+ public DocumentRegion trimEnd(Pattern pat) {
+ pat = Pattern.compile("("+pat.pattern()+")$");
+ Matcher matcher = pat.matcher(this);
+ if (matcher.find()) {
+ return subSequence(0, matcher.start());
+ }
+ return this;
+ }
+
+ /**
+ * Get the region after this one with a given lenght.
+ *
+ * If the document is too short to provide the requested lenght
+ * then the region is truncated to end of the document.
+ */
+ public DocumentRegion textAfter(int len) {
+ Assert.isLegal(len>=0);
+ return new DocumentRegion(doc, end, Integer.MAX_VALUE == len ? Integer.MAX_VALUE : end+len);
+ }
+
+ /**
+ * Get the region before this one with a given lenght.
+ *
+ * If the requested region extends before the start of the document,
+ * then the region is shortened so its start coincides with document start.
+ */
+ public DocumentRegion textBefore(int len) {
+ Assert.isLegal(len>=0);
+ return new DocumentRegion(doc, start-len, start);
+ }
+
+ public IDocument getDocument() {
+ return doc;
+ }
+
+ /**
+ * Get the start of this region in 'absolute' terms (i.e. relative to the document).
+ */
+ public int getStart() {
+ return start;
+ }
+
+ /**
+ * Get the end of this region in 'absolute' terms (i.e. relative to the document).
+ */
+ public int getEnd() {
+ return end;
+ }
+
+ /**
+ * Convert the given document offset into an offset relative to this region.
+ */
+ public int toRelative(int offset) {
+ return offset-start;
+ }
+
+ public int getLength() {
+ return length();
+ }
+
+ public boolean endsWith(CharSequence string) {
+ int myLen = length();
+ int strLen = string.length();
+ if (myLen>=strLen) {
+ for (int i = 0; i < strLen; i++) {
+ if (charAt(myLen-strLen+i)!=string.charAt(i)) {
+ return false;
+ }
+ }
+ return true;
+ }
+ return false;
+ }
+
+ /**
+ * Take documentRegion at the end of
+ */
+ public DocumentRegion textAtEnd(int numChars) {
+ numChars = Math.min(getLength(), numChars);
+ return new DocumentRegion(doc, end-numChars, end);
+ }
+
+ public DocumentRegion textAtStart(int numChars) {
+ numChars = Math.min(getLength(), numChars);
+ return new DocumentRegion(doc, start, start + numChars);
+ }
+
+ /**
+ * Fetch text between two offsets. Doesn't throw BadLocationException.
+ * If either one or both of the offsets points outside the
+ * document then they will be adjusted to point the appropriate boundary to
+ * retrieve the text just upto the end or beginning of the document instead.
+ */
+ private static String textBetween(IDocument doc, int start, int end) {
+ Assert.isLegal(start<=end);
+ if (start>=doc.getLength()) {
+ return "";
+ }
+ if (start<0) {
+ start = 0;
+ }
+ if (end>doc.getLength()) {
+ end = doc.getLength();
+ }
+ if (end= 0 && doc.getChar(start) != '<'; start--) {
+ // nothing
+ }
+ } catch (BadLocationException e) {
+ // ignore
+ }
+ return new DocumentRegion(doc, start, end);
+ }
+
+ public DocumentRegion textBeforeOnLine() {
+ try {
+ int line = doc.getLineOfOffset(start);
+ int lineOffset = doc.getLineOffset(line);
+ return new DocumentRegion(doc, lineOffset, start);
+ } catch (BadLocationException e) {
+ throw ExceptionUtil.unchecked(e);
+ }
+ }
+
+ public boolean isWhiteSpace() {
+ for (int i = 0; i < getLength(); i++) {
+ if (!Character.isWhitespace(charAt(i))) {
+ return false;
+ }
+ }
+ return true;
+ }
+
+ public DocumentRegion textAfterOnLine() {
+ DocumentRegion textAfter = this.textAfter(Integer.MAX_VALUE);
+ return textAfter.takeWhile(c -> c != '\n' && c != 0);
+ }
+
+ public DocumentRegion takeWhile(Predicate condition) {
+ int i = 0;
+ for (; i < getLength() && condition.test(charAt(i)); i++) {
+ }
+ return this.textAtStart(i);
+ }
+
+// public Range asRange() throws BadLocationException {
+// return doc.toRange(asRegion());
+// }
+}
\ No newline at end of file
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/FileUtil.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/FileUtil.java
new file mode 100644
index 000000000..92de67c7e
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/FileUtil.java
@@ -0,0 +1,108 @@
+/*******************************************************************************
+ * Copyright (c) 2012, 2018 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.util;
+
+import java.io.File;
+import java.io.IOException;
+
+/**
+ * @author Steffen Pingel
+ * @author Leo Dos Santos
+ * @author Christian Dupuis
+ * @author Kris De Volder
+ */
+public class FileUtil {
+
+ /**
+ * Creates a temporary folder that gets deleted on VM shutdown. WARNING:
+ * any files created in this temporary folder will also be deleted on shutdown.
+ * It also appends a timestamp to the temporary directory name.
+ *
+ * @param name
+ * @return
+ * @throws IOException
+ */
+ public static File createTempDirectoryWithTimestamp(String name) throws IOException {
+ return createTempDirectory(name, Long.toString(System.nanoTime()));
+ }
+
+ /**
+ * Creates a temporary folder that gets deleted on VM shutdown. WARNING:
+ * any files created in this temporary folder will also be deleted on shutdown.
+ *
+ * @param name
+ * @return
+ * @throws IOException
+ */
+ public static File createTempDirectory(String name) throws IOException {
+ return createTempDirectory(name, null);
+ }
+
+
+ /**
+ * Creates a temporary folder that gets deleted on VM shutdown. WARNING:
+ * any files created in this temporary folder will also be deleted on shutdown.
+ *
+ * @param name
+ * @return
+ * @throws IOException
+ */
+ public static File createTempDirectory(String name, String suffix) throws IOException {
+ File tempFolder = File.createTempFile(name, suffix);
+ if (!tempFolder.delete()) {
+ throw new IOException("Could not delete temp file: " + tempFolder.getAbsolutePath());
+ }
+ if (!tempFolder.mkdirs()) {
+ throw new IOException("Could not create temp directory: " + tempFolder.getAbsolutePath());
+ }
+ deleteOnShutdown(tempFolder);
+ return tempFolder;
+ }
+
+ public static File createTempDirectory() throws IOException {
+ return createTempDirectoryWithTimestamp("temp");
+ }
+
+ public static boolean isJarFile(File jarFile) {
+ try {
+ return jarFile!=null && jarFile.isFile() && jarFile.toString().toLowerCase().endsWith(".jar");
+ } catch (Throwable e) {
+ org.springsource.ide.eclipse.commons.livexp.util.Log.log(e);
+ return false;
+ }
+ }
+
+ private static void deleteOnShutdown(File tempFolder) {
+ try {
+ Runtime.getRuntime().addShutdownHook(new Thread(() -> {
+ deleteResource(tempFolder);
+ }));
+ } catch (IllegalArgumentException | IllegalStateException | SecurityException e) {
+ org.springsource.ide.eclipse.commons.livexp.util.Log.log(e);
+ }
+ }
+
+ private static void deleteResource(File file) {
+ if (file == null || !file.exists()) {
+ return;
+ }
+
+ if (file.isDirectory()) {
+ File[] files = file.listFiles();
+ if (files != null) {
+ for (File content : files) {
+ deleteResource(content);
+ }
+ }
+ }
+ file.delete();
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/Gtk3Check.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/Gtk3Check.java
new file mode 100644
index 000000000..08437cb5b
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/Gtk3Check.java
@@ -0,0 +1,72 @@
+/*******************************************************************************
+ * Copyright (c) 2014 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Kris De Volder - Initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.util;
+
+import java.lang.reflect.Field;
+import java.util.List;
+import java.util.Vector;
+
+import org.eclipse.core.runtime.Platform;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.wiring.BundleWiring;
+import org.springsource.ide.eclipse.commons.frameworks.core.FrameworkCoreActivator;
+
+public class Gtk3Check {
+
+ //Related eclipse bug:
+ // https://bugs.eclipse.org/bugs/show_bug.cgi?id=434869
+ //If this bug is fixed before eclipse 4.4 release we can remove this code
+ //and any references to it
+
+ public static final boolean isGTK3 = isGTK3();
+
+ /**
+ * Try to determine if GTK3 native libraries are loaded. If it can't be determined conclusively
+ * assume 'the worst' case and return true.
+ */
+ private static boolean isGTK3() {
+
+ if (!"linux".equals(Platform.getOS())) {
+ return false;
+ }
+ try {
+ //Note don't look in the 'swt.gtk' bundle because it is a fragment.
+ // Should look in the 'host' bundle instead.
+ Bundle bundle = Platform.getBundle("org.eclipse.swt");
+ BundleWiring bw = bundle.adapt(BundleWiring.class);
+ ClassLoader cl = bw.getClassLoader();
+ List libs = getNativeLibs(cl);
+ for (String lib : libs) {
+// System.out.println(lib);
+ //TODO: not sure how good this check is. Could library exist under a different name?
+ if (lib.contains("swt-pi3-gtk")) {
+ return true;
+ }
+ }
+ //No problems determining loaded libs, and gtk3 lib not found!
+ return false;
+ } catch (Throwable e) {
+ FrameworkCoreActivator.log(e);
+ //Something went wrong determining if GTK3 is present.
+ //We must assume the worst to avoid potential JVM crash.
+ return true;
+ }
+ }
+
+ @SuppressWarnings("unchecked")
+ private static Vector getNativeLibs(ClassLoader classLoader) throws Exception {
+ //See: https://stackoverflow.com/questions/1007861/how-do-i-get-a-list-of-jni-libraries-which-are-loaded
+ Field field = ClassLoader.class.getDeclaredField("loadedLibraryNames");
+ field.setAccessible(true);
+ return (Vector)field.get(classLoader);
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/IOUtil.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/IOUtil.java
new file mode 100644
index 000000000..3afcceb12
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/IOUtil.java
@@ -0,0 +1,86 @@
+/*******************************************************************************
+ * Copyright (c) 2013 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.util;
+
+import java.io.BufferedOutputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.Closeable;
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+
+public class IOUtil {
+
+ /**
+ * Copy data from an inputstream into a file until end of the inputstream
+ * is reached.
+ *
+ * The input stream is closed automatically.
+ */
+ public static void pipe(InputStream data, File target) throws IOException {
+ target.getParentFile().mkdirs(); //try to create dirs for parent if they don't exist.
+ OutputStream out = new BufferedOutputStream(new FileOutputStream(target));
+ try {
+ pipe(data, out);
+ } finally {
+ out.close();
+ }
+ }
+
+ /**
+ * Copy input stream to output stream until end of the inputstream is reached.
+ * The intpustream is closed automatically, but the output stream is not.
+ */
+ public static void pipe(InputStream input, OutputStream output) throws IOException {
+ try {
+ byte[] buf = new byte[1024*4];
+ int n = input.read(buf);
+ while (n >= 0) {
+ output.write(buf, 0, n);
+ n = input.read(buf);
+ }
+ output.flush();
+ } finally {
+ input.close();
+ }
+ }
+
+ public static String toString(InputStream input) throws Exception {
+ return toString(input, "UTF8");
+ }
+
+ public static String toString(InputStream input, String encoding) throws Exception {
+ ByteArrayOutputStream buf = new ByteArrayOutputStream();
+ pipe(input, buf);
+ return buf.toString(encoding);
+ }
+
+ /**
+ * Sick and tired of writing try-catch around close calls... If something can't close, it usually means it
+ * was already closed, no longer exists etc. This method catches and ignores the exceptions.
+ */
+ public static void close(Closeable closeable) {
+ try {
+ closeable.close();
+ } catch (IOException e) {
+ //ignore
+ }
+ }
+
+ public static byte[] toBytes(InputStream stream) throws IOException {
+ ByteArrayOutputStream bytes = new ByteArrayOutputStream();
+ pipe(stream, bytes);
+ return bytes.toByteArray();
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/JavaTypeUtil.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/JavaTypeUtil.java
new file mode 100644
index 000000000..8d7ce9a8f
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/JavaTypeUtil.java
@@ -0,0 +1,97 @@
+/*******************************************************************************
+ * Copyright (c) 2019 Pivotal, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.util;
+
+import java.nio.file.Paths;
+import java.util.Collections;
+import java.util.Set;
+
+import org.eclipse.core.resources.IContainer;
+import org.eclipse.core.resources.ResourcesPlugin;
+import org.eclipse.core.runtime.IPath;
+import org.eclipse.jdt.core.IJavaProject;
+import org.springsource.ide.eclipse.commons.livexp.util.Log;
+
+public class JavaTypeUtil {
+
+ public static String getFQTypeName(IJavaProject jp, String toParse) throws Exception {
+ String fQName = fromOutputLocation(jp, toParse);
+ return fQName;
+ }
+
+ private static String fromOutputLocation(IJavaProject jp, String toParse) throws Exception {
+ if (jp.getOutputLocation() != null) {
+ Set outputFolders = getOutputFolders(jp);
+ if (outputFolders != null) {
+ for (IContainer iContainer : outputFolders) {
+ String parseTypeFromPath = parseTypeFromPath(iContainer.getRawLocation(), toParse);
+ if (parseTypeFromPath != null) {
+ return parseTypeFromPath;
+ }
+ }
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Will parse the type from a Bean resource path, given a base path for a project (e.g a project's output folder).
+ * This will attempt to find a common root between the resource path and the base path, and relativize the remaining part
+ * which is assumed to be the type.
+ * @param base path
+ * @param resourcePath
+ * @return parsed type, or null if nothing parsed
+ */
+ private static String parseTypeFromPath(IPath base, String resourcePath) {
+ if (base != null) {
+ String baseVal = base.toOSString();
+ if (baseVal != null) {
+ java.nio.file.Path basePath = Paths.get(baseVal);
+ java.nio.file.Path pathContainingType = Paths.get(resourcePath);
+ if (pathContainingType.startsWith(basePath)) {
+ try {
+ java.nio.file.Path relativize = basePath.relativize(pathContainingType);
+ return relativize.toString();
+ } catch (Exception e) {
+ //Ignore, it means outputPath and resource path do not share common root
+ }
+ }
+ }
+ }
+ return null;
+ }
+
+ public static Set getOutputFolders(IJavaProject jp) {
+ IContainer defaultOutput = getDefaultOutputFolder(jp);
+ if (defaultOutput!=null) {
+ return Collections.singleton(getDefaultOutputFolder(jp));
+ } else {
+ return Collections.emptySet();
+ }
+ //TODO: other output folders (i.e indivudla source folders can specifiy separate output folders)
+ }
+
+ public static IContainer getDefaultOutputFolder(IJavaProject jp) {
+ try {
+ IPath loc = jp.getOutputLocation();
+ String pname = loc.segment(0);
+ if (loc.segmentCount()==1) {
+ //project is its own output folder. Discouraged... but possible
+ return ResourcesPlugin.getWorkspace().getRoot().getProject(pname);
+ } else {
+ return ResourcesPlugin.getWorkspace().getRoot().getProject(pname).getFolder(loc.removeFirstSegments(1));
+ }
+ } catch (Exception e) {
+ Log.log(e);
+ }
+ return null;
+ }
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/JobUtil.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/JobUtil.java
new file mode 100644
index 000000000..88d0b97a6
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/JobUtil.java
@@ -0,0 +1,208 @@
+/*******************************************************************************
+ * Copyright (c) 2012, 2016 Pivotal Software, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal Software, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.util;
+
+import java.lang.reflect.InvocationTargetException;
+import java.time.Duration;
+import java.util.concurrent.Callable;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.TimeoutException;
+
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.core.runtime.SubMonitor;
+import org.eclipse.core.runtime.jobs.ISchedulingRule;
+import org.eclipse.core.runtime.jobs.Job;
+import org.eclipse.jface.operation.IRunnableContext;
+import org.eclipse.jface.operation.IRunnableWithProgress;
+import org.eclipse.swt.widgets.Display;
+import org.eclipse.ui.progress.UIJob;
+import org.springsource.ide.eclipse.commons.frameworks.core.FrameworkCoreActivator;
+import org.springsource.ide.eclipse.commons.livexp.util.Log;
+
+public class JobUtil {
+
+ public interface JobBody {
+ void run(IProgressMonitor mon) throws Exception;
+ }
+
+ public static T interruptAfter(Duration waitFor, Callable body) throws Exception {
+ Thread self = Thread.currentThread();
+ Job job = new Job("Interupter") {
+ @Override
+ protected IStatus run(IProgressMonitor arg0) {
+ self.interrupt();
+ return Status.OK_STATUS;
+ }
+ };
+ job.setSystem(true);
+ job.schedule(waitFor.toMillis());
+ try {
+ return body.call();
+ } catch (InterruptedException e) {
+ Log.log(e);
+ throw new TimeoutException();
+ } finally {
+ job.cancel();
+ }
+ }
+
+ /**
+ * Should ideally not be used except for testing. Eclipse UI should provide a runnable context like
+ * a progress service via the workbench.
+ */
+ public static final IRunnableContext DEFAULT_BACKGROUND_RUNNABLE_CONTEXT = new IRunnableContext() {
+
+ @Override
+ public void run(boolean arg0, boolean arg1, final IRunnableWithProgress runnableWithProgress)
+ throws InvocationTargetException, InterruptedException {
+ if (runnableWithProgress != null) {
+ Job job = new Job("Running a background job.") {
+
+ @Override
+ public IStatus run(IProgressMonitor monitor) {
+ try {
+ runnableWithProgress.run(monitor);
+ } catch (InvocationTargetException | InterruptedException e) {
+ return UIJob.errorStatus(e);
+ }
+ return Status.OK_STATUS;
+ }
+ };
+ job.setSystem(true);
+ job.schedule();
+
+ }
+ }
+ };
+
+ /**
+ * Create a scheduling rule that conflicts only with itself and only
+ * contains itself. Jobs that want to have a 'light' impact on blocking
+ * other jobs but still some guarantee that they won't trample over other
+ * things that require access to some internal shared resource that only
+ * they can access should use this rule to protect the resource.
+ */
+ public static ISchedulingRule lightRule(final String name) {
+ return new ISchedulingRule() {
+ public boolean contains(ISchedulingRule rule) {
+ return rule == this;
+ }
+
+ public boolean isConflicting(ISchedulingRule rule) {
+ return rule == this || rule.contains(this);
+ }
+
+ public String toString() {
+ return name;
+ };
+ };
+ }
+
+ /**
+ * Runs a job in the background through a progress service that provides UI
+ * progress. Because the progress service provides UI progress, the initial
+ * launching of the services is done from the UI thread BEFORE the
+ * background job is started . A progress service is required and cannot be
+ * null.
+ *
+ */
+ public static void runBackgroundJobWithUIProgress(final IRunnableWithProgress runnableWithProgress,
+ final IRunnableContext progressService, final String jobLabel) throws Exception {
+ // This outer runnable launches the background job
+ final IRunnableWithProgress outerRunnable = new IRunnableWithProgress() {
+ public void run(final IProgressMonitor monitor) throws InvocationTargetException, InterruptedException {
+ monitor.beginTask(jobLabel, IProgressMonitor.UNKNOWN);
+ // Fork outside UI thread
+ Job job = new Job(jobLabel) {
+ @Override
+ public IStatus run(IProgressMonitor monitor) {
+ SubMonitor subMonitor = SubMonitor.convert(monitor);
+ subMonitor.setTaskName(jobLabel);
+ try {
+ runnableWithProgress.run(subMonitor);
+ } catch (Throwable e) {
+ FrameworkCoreActivator.log(e);
+ } finally {
+ subMonitor.done();
+ }
+ return Status.OK_STATUS;
+ }
+
+ };
+ job.schedule();
+ }
+ };
+
+ // Progress services needs to be launched in UI thread.
+ Exception[] error = new Exception[1];
+ Display.getDefault().syncExec(() -> {
+ try {
+ progressService.run(true, true, outerRunnable);
+ } catch (InvocationTargetException e) {
+ error[0] = e;
+ } catch (InterruptedException e) {
+ error[0] = e;
+ }
+ });
+
+ if (error[0] != null) {
+ throw error[0];
+ }
+ }
+
+ public static CompletableFuture runQuietlyInJob(String jobName, JobBody doit) {
+ CompletableFuture f = new CompletableFuture<>();
+ Job job = new Job(jobName) {
+
+ @Override
+ protected IStatus run(IProgressMonitor monitor) {
+ try {
+ doit.run(monitor);
+ f.complete(null);
+ } catch (Throwable e) {
+ f.completeExceptionally(e);
+ } finally {
+ monitor.done();
+ }
+ return Status.OK_STATUS;
+ }
+
+ };
+ job.setSystem(true);
+ job.schedule();
+ return f;
+ }
+
+ public static CompletableFuture runInJob(String jobName, JobBody doit) {
+ CompletableFuture f = new CompletableFuture<>();
+ Job job = new Job(jobName) {
+
+ @Override
+ protected IStatus run(IProgressMonitor monitor) {
+ try {
+ doit.run(monitor);
+ f.complete(null);
+ } catch (Throwable e) {
+ f.completeExceptionally(e);
+ } finally {
+ monitor.done();
+ }
+ return Status.OK_STATUS;
+ }
+
+ };
+ job.schedule();
+ return f;
+ }
+
+}
diff --git a/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/StringUtils.java b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/StringUtils.java
new file mode 100644
index 000000000..332b08c34
--- /dev/null
+++ b/eclipse-language-servers/org.springsource.ide.eclipse.commons.frameworks.core/src/org/springsource/ide/eclipse/commons/frameworks/core/util/StringUtils.java
@@ -0,0 +1,136 @@
+/*******************************************************************************
+ * Copyright (c) 2018 Pivotal, Inc.
+ * 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Pivotal, Inc. - initial API and implementation
+ *******************************************************************************/
+package org.springsource.ide.eclipse.commons.frameworks.core.util;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.StringTokenizer;
+
+public class StringUtils {
+
+ public static boolean hasText(String val) {
+ return val!=null && !val.trim().isEmpty();
+ }
+
+ /**
+ * Convert a {@code String} array into a delimited {@code String} (e.g. CSV).
+ *