From 647af85ddd8e3e8277caafe85239852e8e430cd3 Mon Sep 17 00:00:00 2001
From: Nicolas Capponi <nicolas.capponi@forgerock.com>
Date: Thu, 19 Nov 2015 08:49:54 +0000
Subject: [PATCH] OPENDJ-2437 Add transactionId control
---
opendj-sdk/opendj-core/src/main/resources/com/forgerock/opendj/ldap/core.properties | 8 ++
opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/TransactionIdControl.java | 154 +++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 161 insertions(+), 1 deletions(-)
diff --git a/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/TransactionIdControl.java b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/TransactionIdControl.java
new file mode 100644
index 0000000..1ea2c62
--- /dev/null
+++ b/opendj-sdk/opendj-core/src/main/java/org/forgerock/opendj/ldap/controls/TransactionIdControl.java
@@ -0,0 +1,154 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License, Version 1.0 only
+ * (the "License"). You may not use this file except in compliance
+ * with the License.
+ *
+ * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
+ * or http://forgerock.org/license/CDDLv1.0.html.
+ * See the License for the specific language governing permissions
+ * and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at legal-notices/CDDLv1_0.txt.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information:
+ * Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ *
+ *
+ * Copyright 2015 ForgeRock AS.
+ */
+package org.forgerock.opendj.ldap.controls;
+
+import static com.forgerock.opendj.ldap.CoreMessages.*;
+
+import org.forgerock.opendj.ldap.ByteString;
+import org.forgerock.opendj.ldap.DecodeException;
+import org.forgerock.opendj.ldap.DecodeOptions;
+import org.forgerock.util.Reject;
+
+/**
+ * Control to provide a transaction ID.
+ * <p>
+ * The transaction ID is related to Common Audit : it is used for tracking the
+ * processing of a user-interaction as it passes through the Forgerock stack
+ * <p>
+ * The control's value is the UTF-8 encoding of the transaction ID.
+ */
+public final class TransactionIdControl implements Control
+{
+
+ /** OID for this control. */
+ public static final String OID = "1.3.6.1.4.1.36733.2.1.5.1";
+
+ /** A decoder which can be used for decoding the simple paged results control. */
+ public static final ControlDecoder<TransactionIdControl> DECODER = new ControlDecoder<TransactionIdControl>()
+ {
+
+ @Override
+ public TransactionIdControl decodeControl(final Control control, final DecodeOptions options)
+ throws DecodeException
+ {
+ Reject.ifNull(control);
+
+ if (control instanceof TransactionIdControl)
+ {
+ return (TransactionIdControl) control;
+ }
+
+ if (!control.getOID().equals(OID))
+ {
+ throw DecodeException.error(ERR_TRANSACTION_ID_CONTROL_BAD_OID.get(control.getOID(), OID));
+ }
+
+ if (!control.hasValue())
+ {
+ // The control must always have a value.
+ throw DecodeException.error(ERR_TRANSACTION_ID_CONTROL_DECODE_NULL.get());
+ }
+
+ return new TransactionIdControl(control.getValue().toString());
+ }
+
+ @Override
+ public String getOID()
+ {
+ return OID;
+ }
+ };
+
+ /**
+ * Creates a new transactionId control.
+ *
+ * @param transactionId
+ * The transaction id to provide through this control.
+ * @return The new control.
+ * @throws NullPointerException
+ * If {@code transactionId} was {@code null}.
+ */
+ public static TransactionIdControl newControl(final String transactionId)
+ {
+ Reject.ifNull(transactionId);
+ return new TransactionIdControl(transactionId);
+ }
+
+ /** The control value transactionId element. */
+ private final String transactionId;
+
+ private TransactionIdControl(final String transactionId)
+ {
+ this.transactionId = transactionId;
+ }
+
+ /**
+ * Returns the transaction id.
+ *
+ * @return The transaction id.
+ */
+ public String getTransactionId()
+ {
+ return transactionId;
+ }
+
+ @Override
+ public String getOID()
+ {
+ return OID;
+ }
+
+ @Override
+ public ByteString getValue()
+ {
+ return ByteString.valueOfUtf8(transactionId);
+ }
+
+ @Override
+ public boolean hasValue()
+ {
+ return true;
+ }
+
+ @Override
+ public boolean isCritical()
+ {
+ // This control is never critical.
+ return false;
+ }
+
+ @Override
+ public String toString()
+ {
+ final StringBuilder builder = new StringBuilder();
+ builder.append("TransactionIdControl(oid=");
+ builder.append(getOID());
+ builder.append(", transactionId=");
+ builder.append(transactionId);
+ builder.append(")");
+ return builder.toString();
+ }
+}
diff --git a/opendj-sdk/opendj-core/src/main/resources/com/forgerock/opendj/ldap/core.properties b/opendj-sdk/opendj-core/src/main/resources/com/forgerock/opendj/ldap/core.properties
index 98d3d9c..555a3be 100755
--- a/opendj-sdk/opendj-core/src/main/resources/com/forgerock/opendj/ldap/core.properties
+++ b/opendj-sdk/opendj-core/src/main/resources/com/forgerock/opendj/ldap/core.properties
@@ -1645,7 +1645,13 @@
m (minute), h (hour), D (date), M (month) and Y (year)
ERR_INVALID_COMPACTED_UNSIGNED_INT="Expected a compacted unsigned int (value less than %d), \
but got a compacted unsigned long: %d
-
+ERR_TRANSACTION_ID_CONTROL_BAD_OID=Cannot decode the provided \
+ control as a transaction id control because it contained the OID '%s', \
+ when '%s' was expected
+ERR_TRANSACTION_ID_CONTROL_DECODE_NULL=Cannot decode the provided ASN.1 \
+ element as a transaction id control because it did not have a value, when \
+ a value must always be provided
+
# Labels for generated documentation
DOC_LOCALE_TAG=Code tag: %s
DOC_LOCALE_OID=Collation order object identifier: %s
--
Gitblit v1.10.0