From ed3dcf7e1bcbf8c5dbce3ccc89817bd0745678af Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Sun, 24 Jul 2011 15:49:33 +0200 Subject: [PATCH] added scripting api --- .../sonia/scm/script/ScmScriptContext.java | 76 ++++++++++++++++ .../scm/script/ScmScriptContextFactory.java | 56 ++++++++++++ .../sonia/scm/script/ScmScriptException.java | 88 +++++++++++++++++++ .../scm/script/ScmScriptLanguageNotFound.java | 66 ++++++++++++++ 4 files changed, 286 insertions(+) create mode 100644 scm-core/src/main/java/sonia/scm/script/ScmScriptContext.java create mode 100644 scm-core/src/main/java/sonia/scm/script/ScmScriptContextFactory.java create mode 100644 scm-core/src/main/java/sonia/scm/script/ScmScriptException.java create mode 100644 scm-core/src/main/java/sonia/scm/script/ScmScriptLanguageNotFound.java diff --git a/scm-core/src/main/java/sonia/scm/script/ScmScriptContext.java b/scm-core/src/main/java/sonia/scm/script/ScmScriptContext.java new file mode 100644 index 0000000000..bc210e98ac --- /dev/null +++ b/scm-core/src/main/java/sonia/scm/script/ScmScriptContext.java @@ -0,0 +1,76 @@ +/** + * Copyright (c) 2010, Sebastian Sdorra + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. Neither the name of SCM-Manager; nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://bitbucket.org/sdorra/scm-manager + * + */ + + + +package sonia.scm.script; + +//~--- JDK imports ------------------------------------------------------------ + +import java.io.IOException; +import java.io.InputStream; + +import java.util.Map; + +/** + * Executes scripts. + * + * @author Sebastian Sdorra + * @since 1.6 + */ +public interface ScmScriptContext +{ + + /** + * Executes the given script. + * + * + * @param input - The script in form of a {@link InputStream} + * + * @throws IOException + * @throws ScmScriptException + */ + public void eval(InputStream input) throws IOException, ScmScriptException; + + /** + * Executes the given script. + * + * + * @param input - The script in form of a {@link InputStream} + * @param additionalParams - + * additional parameters for the execution of the script + * + * @throws IOException + * @throws ScmScriptException + */ + public void eval(InputStream input, Map additionalParams) + throws IOException, ScmScriptException; +} diff --git a/scm-core/src/main/java/sonia/scm/script/ScmScriptContextFactory.java b/scm-core/src/main/java/sonia/scm/script/ScmScriptContextFactory.java new file mode 100644 index 0000000000..50bba8cd5e --- /dev/null +++ b/scm-core/src/main/java/sonia/scm/script/ScmScriptContextFactory.java @@ -0,0 +1,56 @@ +/** + * Copyright (c) 2010, Sebastian Sdorra + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. Neither the name of SCM-Manager; nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://bitbucket.org/sdorra/scm-manager + * + */ + + + +package sonia.scm.script; + +/** + * {@link ScmScriptContextFactory} is used to get a instance of + * {@link ScmScriptContext} for a specific language. + * + * @author Sebastian Sdorra + * @since 1.6 + */ +public interface ScmScriptContextFactory +{ + + /** + * Returns the {@link ScmScriptContext} for given language or null if no + * {@link ScmScriptContext} for the language exists. + * + * + * @param language of the {@link ScmScriptContext} + * + * @return null or the {@link ScmScriptContext} for the given language + */ + public ScmScriptContext getScriptContext(String language); +} diff --git a/scm-core/src/main/java/sonia/scm/script/ScmScriptException.java b/scm-core/src/main/java/sonia/scm/script/ScmScriptException.java new file mode 100644 index 0000000000..248b9beadf --- /dev/null +++ b/scm-core/src/main/java/sonia/scm/script/ScmScriptException.java @@ -0,0 +1,88 @@ +/** + * Copyright (c) 2010, Sebastian Sdorra + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. Neither the name of SCM-Manager; nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://bitbucket.org/sdorra/scm-manager + * + */ + + + +package sonia.scm.script; + +/** + * + * @author Sebastian Sdorra + * @since 1.6 + */ +public class ScmScriptException extends Exception +{ + + /** Field description */ + private static final long serialVersionUID = 7482561438306394531L; + + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + public ScmScriptException() {} + + /** + * Constructs ... + * + * + * @param message + */ + public ScmScriptException(String message) + { + super(message); + } + + /** + * Constructs ... + * + * + * @param cause + */ + public ScmScriptException(Throwable cause) + { + super(cause); + } + + /** + * Constructs ... + * + * + * @param message + * @param cause + */ + public ScmScriptException(String message, Throwable cause) + { + super(message, cause); + } +} diff --git a/scm-core/src/main/java/sonia/scm/script/ScmScriptLanguageNotFound.java b/scm-core/src/main/java/sonia/scm/script/ScmScriptLanguageNotFound.java new file mode 100644 index 0000000000..112465bbfd --- /dev/null +++ b/scm-core/src/main/java/sonia/scm/script/ScmScriptLanguageNotFound.java @@ -0,0 +1,66 @@ +/** + * Copyright (c) 2010, Sebastian Sdorra + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. Neither the name of SCM-Manager; nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://bitbucket.org/sdorra/scm-manager + * + */ + + + +package sonia.scm.script; + +/** + * This exception is thrown when a script language cannot be found. + * + * @author Sebastian Sdorra + * @since 1.6 + */ +public class ScmScriptLanguageNotFound extends ScmScriptException +{ + + /** Field description */ + private static final long serialVersionUID = 7055977823546091820L; + + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + public ScmScriptLanguageNotFound() {} + + /** + * Constructs ... + * + * + * @param message + */ + public ScmScriptLanguageNotFound(String message) + { + super(message); + } +}