1 files changed, 76 insertions, 0 deletions
diff --git a/trunk/qpid/java/client/src/main/java/org/apache/qpid/jms/failover/FailoverMethod.java b/trunk/qpid/java/client/src/main/java/org/apache/qpid/jms/failover/FailoverMethod.java
new file mode 100644
index 0000000000..d7ec46dea3
--- /dev/null
+++ b/trunk/qpid/java/client/src/main/java/org/apache/qpid/jms/failover/FailoverMethod.java
@@ -0,0 +1,76 @@
+/*
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ * 
+ *   http://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.apache.qpid.jms.failover;
+
+import org.apache.qpid.jms.BrokerDetails;
+
+public interface FailoverMethod
+{
+    public static final String SINGLE_BROKER = "singlebroker";
+    public static final String ROUND_ROBIN = "roundrobin";
+    public static final String RANDOM = "random";
+    /**
+     * Reset the Failover to initial conditions
+     */
+    void reset();
+
+    /**
+     *  Check if failover is possible for this method
+     *
+     * @return true if failover is allowed
+     */
+    boolean failoverAllowed();
+
+    /**
+     * Notification to the Failover method that a connection has been attained.
+     */
+    void attainedConnection();
+
+    /**
+     * If there is no current BrokerDetails the null will be returned.
+     * @return The current BrokerDetail value to use
+     */
+    BrokerDetails getCurrentBrokerDetails();
+
+    /**
+     *  Move to the next BrokerDetails if one is available.
+     * @return the next BrokerDetail or null if there is none.
+     */
+    BrokerDetails getNextBrokerDetails();
+
+    /**
+     * Set the currently active broker to be the new value.
+     * @param broker The new BrokerDetail value
+     */
+    void setBroker(BrokerDetails broker);
+
+    /**
+     * Set the retries for this method
+     * @param maxRetries the maximum number of time to retry this Method
+     */
+    void setRetries(int maxRetries);
+
+    /**
+     * @return The name of this method for display purposes.
+     */
+    String methodName();
+}