From e286d565ecb8780a2bea330e71f8ef01fee5176a Mon Sep 17 00:00:00 2001
From: Nicolas Capponi <nicolas.capponi@forgerock.com>
Date: Fri, 09 Sep 2016 09:45:25 +0000
Subject: [PATCH] OPENDJ-3089 Update javadoc of SchemaBackend and SchemaHandler
---
opendj-server-legacy/src/main/java/org/opends/server/core/SchemaHandler.java | 16 +++++++++++++---
opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java | 1 +
2 files changed, 14 insertions(+), 3 deletions(-)
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java b/opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java
index ab751bb..013e66c 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/backends/SchemaBackend.java
@@ -153,6 +153,7 @@
/** Will be used in the future to remove static calls to DirectoryServer. */
private ServerContext serverContext;
+ /** Manages access to the schema. */
private SchemaHandler schemaHandler;
/**
diff --git a/opendj-server-legacy/src/main/java/org/opends/server/core/SchemaHandler.java b/opendj-server-legacy/src/main/java/org/opends/server/core/SchemaHandler.java
index a4058f8..a6b4652 100644
--- a/opendj-server-legacy/src/main/java/org/opends/server/core/SchemaHandler.java
+++ b/opendj-server-legacy/src/main/java/org/opends/server/core/SchemaHandler.java
@@ -93,14 +93,24 @@
import com.forgerock.opendj.util.OperatingSystem;
/**
- * Responsible for loading the server schema.
+ * Responsible for access to the server's schema.
* <p>
- * The schema is loaded in three steps :
+ * The schema handler initializes the schema in four steps :
* <ul>
* <li>Start from the core schema.</li>
+ * <li>Add server specific syntaxes and matching rules</li>
* <li>Load schema elements from the schema providers defined in configuration.</li>
* <li>Load all schema files located in the schema directory.</li>
* </ul>
+ * <p>
+ * The schema handler provides read and write access to the schema.
+ * <p>
+ * As schema is immutable, there is no risk to alter it outside this handler.
+ * However, no long-lived reference should be kept on the schema because further schema
+ * updates would be missed. It is advised to retrieve the server's schema from the handler
+ * for any operation.
+ * <p>
+ * The server's schema can be updated using one of the {@code updateSchema()} method.
*/
public final class SchemaHandler
{
@@ -179,7 +189,7 @@
}
/**
- * Initialize this schema handler.
+ * Initializes this schema handler.
*
* @param serverContext
* The server context.
--
Gitblit v1.10.0