From e3d4773bc72b084309bd77b07320977221f9eb2e Mon Sep 17 00:00:00 2001
From: Nicolas Capponi <nicolas.capponi@forgerock.com>
Date: Fri, 22 May 2015 09:26:19 +0000
Subject: [PATCH] OPENDJ-2040 Provide annotations for tracking of server modifications during migration to SDK

---
 opendj-server-legacy/src/main/java/org/opends/server/util/ActivateOnceNewConfigFrameworkIsUsed.java |   40 ++++++++
 opendj-server-legacy/src/main/java/org/opends/server/util/ActivateOnceSDKSchemaIsUsed.java          |   40 ++++++++
 opendj-server-legacy/src/main/java/org/opends/server/util/ModifyOnceSDKSchemaIsUsed.java            |   40 ++++++++
 opendj-server-legacy/src/main/java/org/opends/server/util/ModifyOnceNewConfigFrameworkIsUsed.java   |   42 ++++++++
 opendj-server-legacy/src/main/java/org/opends/server/util/RemoveOnceSDKSchemaIsUsed.java            |   40 ++++++++
 opendj-server-legacy/src/main/java/org/opends/server/util/RemoveOnceNewConfigFrameworkIsUsed.java   |   40 ++++++++
 6 files changed, 242 insertions(+), 0 deletions(-)

diff --git a/opendj-server-legacy/src/main/java/org/opends/server/util/ActivateOnceNewConfigFrameworkIsUsed.java b/opendj-server-legacy/src/main/java/org/opends/server/util/ActivateOnceNewConfigFrameworkIsUsed.java
new file mode 100644
index 0000000..cb30c95
--- /dev/null
+++ b/opendj-server-legacy/src/main/java/org/opends/server/util/ActivateOnceNewConfigFrameworkIsUsed.java
@@ -0,0 +1,40 @@
+/*
+ * 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.opends.server.util;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * Temporary annotation to remind that annotated code should be activated once the
+ * new configuration framework is used in place of legacy one.
+ */
+@Retention(RetentionPolicy.SOURCE)
+public @interface ActivateOnceNewConfigFrameworkIsUsed
+{
+  /** Optional comment on activation. */
+  String value() default "";
+}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/util/ActivateOnceSDKSchemaIsUsed.java b/opendj-server-legacy/src/main/java/org/opends/server/util/ActivateOnceSDKSchemaIsUsed.java
new file mode 100644
index 0000000..ed8ca77
--- /dev/null
+++ b/opendj-server-legacy/src/main/java/org/opends/server/util/ActivateOnceSDKSchemaIsUsed.java
@@ -0,0 +1,40 @@
+/*
+ * 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.opends.server.util;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * Temporary annotation to remind that annotated code should be activated once the
+ * SDK schema is used in place of legacy server schema.
+ */
+@Retention(RetentionPolicy.SOURCE)
+public @interface ActivateOnceSDKSchemaIsUsed
+{
+  /** Optional comment on activation. */
+  String value() default "";
+}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/util/ModifyOnceNewConfigFrameworkIsUsed.java b/opendj-server-legacy/src/main/java/org/opends/server/util/ModifyOnceNewConfigFrameworkIsUsed.java
new file mode 100644
index 0000000..2917f30
--- /dev/null
+++ b/opendj-server-legacy/src/main/java/org/opends/server/util/ModifyOnceNewConfigFrameworkIsUsed.java
@@ -0,0 +1,42 @@
+/*
+ * 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.opends.server.util;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * Temporary annotation to remind that annotated code should be modified once
+ * the new configuration framework is used in place of legacy one.
+ * <p>
+ * Failing to modify the code would lead to errors.
+ */
+@Retention(RetentionPolicy.SOURCE)
+public @interface ModifyOnceNewConfigFrameworkIsUsed
+{
+  /** Optional comment on modification. */
+  String value() default "";
+}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/util/ModifyOnceSDKSchemaIsUsed.java b/opendj-server-legacy/src/main/java/org/opends/server/util/ModifyOnceSDKSchemaIsUsed.java
new file mode 100644
index 0000000..4e77c1f
--- /dev/null
+++ b/opendj-server-legacy/src/main/java/org/opends/server/util/ModifyOnceSDKSchemaIsUsed.java
@@ -0,0 +1,40 @@
+/*
+ * 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.opends.server.util;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * Temporary annotation to remind that annotated code could be modified once the
+ * SDK schema is used in place of legacy server schema.
+ */
+@Retention(RetentionPolicy.SOURCE)
+public @interface ModifyOnceSDKSchemaIsUsed
+{
+  /** Optional comment on modification. */
+  String value() default "";
+}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/util/RemoveOnceNewConfigFrameworkIsUsed.java b/opendj-server-legacy/src/main/java/org/opends/server/util/RemoveOnceNewConfigFrameworkIsUsed.java
new file mode 100644
index 0000000..fc188f4
--- /dev/null
+++ b/opendj-server-legacy/src/main/java/org/opends/server/util/RemoveOnceNewConfigFrameworkIsUsed.java
@@ -0,0 +1,40 @@
+/*
+ * 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.opends.server.util;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * Temporary annotation to remind that annotated code could be removed once the
+ * new configuration framework is used in place of legacy one.
+ */
+@Retention(RetentionPolicy.SOURCE)
+public @interface RemoveOnceNewConfigFrameworkIsUsed
+{
+  /** Optional comment on removal. */
+  String value() default "";
+}
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/util/RemoveOnceSDKSchemaIsUsed.java b/opendj-server-legacy/src/main/java/org/opends/server/util/RemoveOnceSDKSchemaIsUsed.java
new file mode 100644
index 0000000..b02f107
--- /dev/null
+++ b/opendj-server-legacy/src/main/java/org/opends/server/util/RemoveOnceSDKSchemaIsUsed.java
@@ -0,0 +1,40 @@
+/*
+ * 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.opends.server.util;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * Temporary annotation to remind that annotated code could be removed once the
+ * SDK schema is used in place of legacy server schema.
+ */
+@Retention(RetentionPolicy.SOURCE)
+public @interface RemoveOnceSDKSchemaIsUsed
+{
+  /** Optional comment on removal. */
+  String value() default "";
+}

--
Gitblit v1.10.0