introducing HookBranchProvider to get informations about changed branches during a hook, see issue #668

scm-core/src/main/java/sonia/scm/repository/api/HookBranchProvider.java

@@ -0,0 +1,61 @@
+/**
+ * Copyright (c) 2014, 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.repository.api;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.util.List;
+
+/**
+ * The HookBranchProvider returns informations about branch changes during the
+ * current hook.
+ *
+ * @author Sebastian Sdorra
+ * @since 1.45
+ */
+public interface HookBranchProvider
+{
+
+  /**
+   * Returns the list of created or modified branch names.
+   *
+   * @return list of created or modified branches
+   */
+  public List<String> getCreatedOrModified();
+
+  /**
+   * Returns the list deleted or closed branch names.
+   *
+   * @return list of deleted or closed branches
+   */
+  public List<String> getDeletedOrClosed();
+}

scm-core/src/main/java/sonia/scm/repository/api/HookContext.java

@@ -43,8 +43,9 @@ import sonia.scm.repository.spi.HookContextProvider;
 
 /**
  * The context for all repository hooks. With the {@link HookContext} class it
- * is able to send messages back to the client and retrieve {@link Changeset}s
- * which are added during this push/commit.
+ * is able to send messages back to the client, retrieve {@link Changeset}s
+ * which are added during this push/commit and gives informations about changed 
+ * branches.
  *
  * @author Sebastian Sdorra
  * @since 1.33
@@ -78,12 +79,37 @@ public final class HookContext
 
   //~--- get methods ----------------------------------------------------------
 
+  /**
+   * Returns a {@link HookBranchProvider} which is able to return informations
+   * about changed branches during the current hook.
+   *
+   * @return {@link HookBranchProvider}
+   * 
+   * @throws HookFeatureIsNotSupportedException if the feature is not supported 
+   *  by the underlying provider
+   * 
+   * @since 1.45
+   */
+  public HookBranchProvider getBranchProvider()
+  {
+    if (logger.isDebugEnabled())
+    {
+      logger.debug("create branch provider for repository {}",
+        repository.getName());
+    }
+
+    return provider.getBranchProvider();
+  }
+
   /**
    * Returns a {@link HookChangesetBuilder} which is able to return all
    * {@link Changeset}'s during this push/commit.
    *
    *
    * @return {@link HookChangesetBuilder}
+   * 
+   * @throws HookFeatureIsNotSupportedException if the feature is not supported 
+   *  by the underlying provider
    */
   public HookChangesetBuilder getChangesetProvider()
   {
@@ -111,6 +137,9 @@ public final class HookContext
    *
    * @return {@link HookMessageProvider} which is able to send message back to
    * the scm client
+   * 
+   * @throws HookFeatureIsNotSupportedException if the feature is not supported 
+   *  by the underlying provider
    */
   public HookMessageProvider getMessageProvider()
   {
@@ -138,12 +167,12 @@ public final class HookContext
 
   //~--- fields ---------------------------------------------------------------
 
-  /** Field description */
-  private PreProcessorUtil preProcessorUtil;
+  /** pre processor util */
+  private final PreProcessorUtil preProcessorUtil;
 
-  /** Field description */
-  private HookContextProvider provider;
+  /** hook context provider */
+  private final HookContextProvider provider;
 
-  /** Field description */
-  private Repository repository;
+  /** repository */
+  private final Repository repository;
 }

scm-core/src/main/java/sonia/scm/repository/api/HookFeature.java

@@ -37,4 +37,23 @@ package sonia.scm.repository.api;
  * @author Sebastian Sdorra
  * @since 1.33
  */
-public enum HookFeature { MESSAGE_PROVIDER, CHANGESET_PROVIDER; }
+public enum HookFeature
+{
+
+  /**
+   * Hook message provider
+   */
+  MESSAGE_PROVIDER,
+
+  /**
+   * Hook changeset provider
+   */
+  CHANGESET_PROVIDER,
+
+  /**
+   * Hook branch provider
+   *
+   * @since 1.45
+   */
+  BRANCH_PROVIDER;
+}

scm-core/src/main/java/sonia/scm/repository/spi/HookContextProvider.java

@@ -33,6 +33,7 @@ package sonia.scm.repository.spi;
 
 //~--- non-JDK imports --------------------------------------------------------
 
+import sonia.scm.repository.api.HookBranchProvider;
 import sonia.scm.repository.api.HookException;
 import sonia.scm.repository.api.HookFeature;
 import sonia.scm.repository.api.HookFeatureIsNotSupportedException;
@@ -88,6 +89,17 @@ public abstract class HookContextProvider
    */
   public abstract Set<HookFeature> getSupportedFeatures();
 
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public HookBranchProvider getBranchProvider()
+  {
+    throw new HookFeatureIsNotSupportedException(HookFeature.BRANCH_PROVIDER);
+  }
+
   /**
    * Method description
    *