Restructured the project creating a router directory for the router bundle implementa...

[xmlrouter] / router / impl / src / main / java / org / wamblee / xmlrouter / impl / XMLRouterConfiguration.java

diff --git a/router/impl/src/main/java/org/wamblee/xmlrouter/impl/XMLRouterConfiguration.java b/router/impl/src/main/java/org/wamblee/xmlrouter/impl/XMLRouterConfiguration.java
new file mode 100644 (file)
index 0000000..600aac3
--- /dev/null
+++ b/router/impl/src/main/java/org/wamblee/xmlrouter/impl/XMLRouterConfiguration.java
@@ -0,0 +1,48 @@
+/*
+ * Copyright 2005-2011 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
+ * 
+ *      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.wamblee.xmlrouter.impl;
+
+import org.wamblee.general.Pair;
+
+/**
+ * The XML Router configuration contains both configuration data as well as
+ * derived data used by the XML router. It is important that all this data is
+ * consistent. Therefore, this class provides a read-write locking mechanism for
+ * accessing the data.
+ * 
+ * @author Erik Brakkee
+ * 
+ */
+public interface XMLRouterConfiguration {
+
+    /**
+     * Atomically get the configuration. The XMLRouter uses this to get a
+     * snapshot of the configuration data for handling a single message. In this
+     * way a consistent configuration is used for each event.
+     * 
+     * @return Configuration.
+     */
+    Pair<ExtendedRouterConfig, TransformationPaths> getConfig();
+
+    /**
+     * Atomically sets the configuration and updates derived data. There will be
+     * a short time during which read attempts will fail.
+     * 
+     * @param aConfig
+     *            Configuration to set.
+     */
+    void setRouterConfig(ExtendedRouterConfig aConfig);
+}