Initial commit

git-svn-id: https://joinup.ec.europa.eu/svn/moa-idspss/trunk@2 d688527b-c9ab-4aba-bd8d-4036d912da1d

3 files changed, 203 insertions, 0 deletions

diff --git a/spss.server/src/at/gv/egovernment/moa/spss/server/transaction/TransactionContext.java b/spss.server/src/at/gv/egovernment/moa/spss/server/transaction/TransactionContext.java
new file mode 100644
index 000000000..407dbd4e9
--- /dev/null
+++ b/spss.server/src/at/gv/egovernment/moa/spss/server/transaction/TransactionContext.java
@@ -0,0 +1,90 @@
+package at.gv.egovernment.moa.spss.server.transaction;
+
+import java.security.cert.X509Certificate;
+
+import at.gv.egovernment.moa.spss.server.config.ConfigurationProvider;
+
+/**
+ * Contains information about the current request.
+ * 
+ * @author Stefan Knirsch
+ * @author Patrick Peck 
+ */
+public class TransactionContext {
+
+  /** The client certificate. */
+  private X509Certificate[] clientCertificate = null;
+  /** The transaction ID. */
+  private String transactionID = null;
+  /** The name of the request. */
+  private String requestName = null;
+  /** The configuration to use throughout the request. */
+  private ConfigurationProvider configuration = null;
+
+  /**
+   * Create a <code>TransactionContext</code> object.
+   * 
+   * @param transactionID A unique ID for this <code>TransactionContext</code>.
+   * @param clientCertificate The client certificate chain.
+   * @param configuration The MOA configuration to use for this transaction.
+   */
+  public TransactionContext(
+    String transactionID,
+    X509Certificate[] clientCertificate,
+    ConfigurationProvider configuration) {
+
+    this.transactionID = transactionID;
+    this.clientCertificate = clientCertificate;
+    this.configuration = configuration;
+  }
+
+  /**
+   * Returns the client certificate.
+   * 
+   * @return The client certificate chain, if SSL client authentication has been
+   * configured in the web server and has been used by the client. The 0th
+   * element of the array contains the client certificate. <code>null</code>
+   * otherwise.
+   */
+  public X509Certificate[] getClientCertificate() {
+    return clientCertificate;
+  }
+
+  /**
+   * Returns the unique transaction ID.
+   * 
+   * @return The transaction ID.
+   */
+  public String getTransactionID() {
+    return transactionID;
+  }
+
+  /**
+   * Returns the name of the request.
+   * 
+   * @return The name of the request.
+   */
+  public String getRequestName() {
+    return requestName;
+  }
+
+  /**
+   * Sets the name of the request.
+   * 
+   * @param requestName The request name to set.
+   */
+  public void setRequestName(String requestName) {
+    this.requestName = requestName;
+  }
+
+  /**
+   * Returns the <code>ConfigurationProvider</code> associated with this
+   * transaction.
+   * 
+   * @return The ConfigurationProvider associated with this transaction. 
+   */
+  public ConfigurationProvider getConfiguration() {
+    return configuration;
+  }
+
+}
diff --git a/spss.server/src/at/gv/egovernment/moa/spss/server/transaction/TransactionContextManager.java b/spss.server/src/at/gv/egovernment/moa/spss/server/transaction/TransactionContextManager.java
new file mode 100644
index 000000000..13127c3ae
--- /dev/null
+++ b/spss.server/src/at/gv/egovernment/moa/spss/server/transaction/TransactionContextManager.java
@@ -0,0 +1,62 @@
+package at.gv.egovernment.moa.spss.server.transaction;
+
+/**
+ * Provides each thread with an instance of <code>TransactionContext</code>.
+ * 
+ * The single instance of the <code>TransactionContextManager</code> should be
+ * used to access contextual information for each web service transaction, e.g.
+ * the transaction ID, MOA configuration, client certificate, etc.
+ * 
+ * @author Stefan Knirsch
+ * @author Patrick Peck
+ */
+public class TransactionContextManager {
+
+  /** The single instance of <code>TransactionContextManager</code> */ 
+  private static TransactionContextManager instance = null;
+  
+  /** Contains a single <code>TransactionContext</code> for each thread. */
+  private ThreadLocal context = null;
+
+  /**
+   * Get the single instance of <code>TransactionContextManager</code>.
+   *   
+   * @return The single instanc of <code>TransactionContextManager</code>.
+   */
+  public static synchronized TransactionContextManager getInstance() {
+    if (instance == null) {
+      instance = new TransactionContextManager();
+    }
+    return instance;
+  }
+
+  /**
+   * Creates a new <code>TransactionContextManager</code>.
+   * 
+   * Protected to disallow direct instantiation.
+   */
+  protected TransactionContextManager() {
+    context = new ThreadLocal();
+  }
+
+  /**
+   * Set the <code>TransactionContext</code> for the current thread.
+   * 
+   * @param txContext The <code>TransactionContext</code> for this thread.
+   */
+  public void setTransactionContext(TransactionContext txContext) {
+    context.set(txContext);
+  }
+
+  /**
+   * Get the <code>TransactionContext</code> for the current thread.
+   * 
+   * @return The <code>TransactionContext</code> for the current thread or
+   * <code>null</code>, if none has been set (or if this method is being invoked
+   * outside the bounds of a transaction).
+   */
+  public TransactionContext getTransactionContext() {
+    return (TransactionContext) context.get();
+  }
+
+}
diff --git a/spss.server/src/at/gv/egovernment/moa/spss/server/transaction/TransactionIDGenerator.java b/spss.server/src/at/gv/egovernment/moa/spss/server/transaction/TransactionIDGenerator.java
new file mode 100644
index 000000000..6eb07defe
--- /dev/null
+++ b/spss.server/src/at/gv/egovernment/moa/spss/server/transaction/TransactionIDGenerator.java
@@ -0,0 +1,51 @@
+package at.gv.egovernment.moa.spss.server.transaction;
+
+
+/**
+ * A generator for unique transaction IDs.
+ * 
+ * <p>The transaction IDs are of the form "<base>-<counter>", where:
+ * <ul> 
+ * <li><code>base</code> is initialized with the system time when this class is
+ * being loaded</li>
+ * <li><code>counter</code> is incremented sequentially on each call to
+ * <code>nextID()</code></li>
+ * </ul>
+ * </p>
+ * 
+ * <p> Assuming that it is highly unlikely that MOA servers are started at
+ * exactly the same time instant, the mechanism provided by this class should
+ * guarantee unique transaction IDs across multiple restarts and/or instances of
+ * the server.</p>
+ * 
+ * @author Patrick Peck
+ * @author Stefan Knirsch
+ */
+public class TransactionIDGenerator {
+
+  /** Request sequence number. */
+  private static long counter = 0;
+  /** The base value to which to append the sequence number. */
+  private static String base = null;
+
+  /**
+   * Set up the initial base value.
+   */
+  static {
+    synchronized (TransactionIDGenerator.class) {
+      base = Long.toString(System.currentTimeMillis());
+    }
+  }
+
+  /**
+   * Returns the next transaction ID.
+   * 
+   * @return The next transaction ID.
+   */
+  public static synchronized String nextID() {
+    counter++;
+
+    return (base + "-" + counter);
+  }
+
+}