/*
|
* 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 2008 Sun Microsystems, Inc.
|
* Portions Copyright 2014 ForgeRock AS
|
*/
|
package org.opends.server.admin;
|
|
|
|
import java.util.ResourceBundle;
|
|
import org.opends.server.admin.std.meta.RootCfgDefn;
|
import org.opends.server.core.DirectoryServer;
|
import org.opends.server.schema.ObjectClassSyntax;
|
import org.forgerock.opendj.ldap.ByteString;
|
import org.opends.server.types.ObjectClass;
|
|
|
|
/**
|
* Common methods for hooking in the test components.
|
*/
|
public final class TestCfg {
|
|
/**
|
* A one-to-many relation between the root and test-parent
|
* components.
|
*/
|
private static final InstantiableRelationDefinition<TestParentCfgClient, TestParentCfg> RD_TEST_ONE_TO_MANY_PARENT;
|
|
/**
|
* A one-to-zero-or-one relation between the root and a test-parent
|
* component.
|
*/
|
private static final OptionalRelationDefinition<TestParentCfgClient, TestParentCfg> RD_TEST_ONE_TO_ZERO_OR_ONE_PARENT;
|
|
// Create a one-to-many relation for test-parent components.
|
static {
|
InstantiableRelationDefinition.Builder<TestParentCfgClient, TestParentCfg> builder = new InstantiableRelationDefinition.Builder<TestParentCfgClient, TestParentCfg>(
|
RootCfgDefn.getInstance(), "test-one-to-many-parent",
|
"test-one-to-many-parents", TestParentCfgDefn.getInstance());
|
RD_TEST_ONE_TO_MANY_PARENT = builder.getInstance();
|
}
|
|
// Create a one-to-many relation for test-parent components.
|
static {
|
OptionalRelationDefinition.Builder<TestParentCfgClient, TestParentCfg> builder = new OptionalRelationDefinition.Builder<TestParentCfgClient, TestParentCfg>(
|
RootCfgDefn.getInstance(), "test-one-to-zero-or-one-parent",
|
TestParentCfgDefn.getInstance());
|
RD_TEST_ONE_TO_ZERO_OR_ONE_PARENT = builder.getInstance();
|
}
|
|
// Test parent object class definition.
|
private static ObjectClass TEST_PARENT_OCD = null;
|
|
// Test child object class definition.
|
private static ObjectClass TEST_CHILD_OCD = null;
|
|
|
|
/**
|
* Registers test parent and child object class definitions and any
|
* required resource bundles.
|
* <p>
|
* Unit tests which call this method <b>must</b> call
|
* {@link #cleanup()} on completion.
|
*
|
* @throws Exception
|
* If an unexpected error occurred.
|
*/
|
public synchronized static void setUp() throws Exception {
|
if (TEST_PARENT_OCD == null) {
|
String ocd = "( 1.3.6.1.4.1.26027.1.2.4455114401 "
|
+ "NAME 'ds-cfg-test-parent-dummy' "
|
+ "SUP top STRUCTURAL "
|
+ "MUST ( cn $ ds-cfg-java-class $ "
|
+ "ds-cfg-enabled $ ds-cfg-attribute-type ) "
|
+ "MAY ( ds-cfg-base-dn $ ds-cfg-group-dn $ "
|
+ "ds-cfg-filter $ ds-cfg-conflict-behavior ) "
|
+ "X-ORIGIN 'OpenDS Directory Server' )";
|
ByteString b = ByteString.valueOf(ocd);
|
|
TEST_PARENT_OCD = ObjectClassSyntax.decodeObjectClass(b, DirectoryServer
|
.getSchema(), false);
|
}
|
|
if (TEST_CHILD_OCD == null) {
|
String ocd = "( 1.3.6.1.4.1.26027.1.2.4455114402 "
|
+ "NAME 'ds-cfg-test-child-dummy' "
|
+ "SUP top STRUCTURAL "
|
+ "MUST ( cn $ ds-cfg-java-class $ "
|
+ "ds-cfg-enabled $ ds-cfg-attribute-type ) "
|
+ "MAY ( ds-cfg-base-dn $ ds-cfg-group-dn $ "
|
+ "ds-cfg-filter $ ds-cfg-conflict-behavior $"
|
+ "ds-cfg-rotation-policy) " + "X-ORIGIN 'OpenDS Directory Server' )";
|
ByteString b = ByteString.valueOf(ocd);
|
|
TEST_CHILD_OCD = ObjectClassSyntax.decodeObjectClass(b, DirectoryServer
|
.getSchema(), false);
|
}
|
|
{
|
// Register the test parent object class.
|
DirectoryServer.registerObjectClass(TEST_PARENT_OCD, true);
|
|
// Register the test parent resource bundle.
|
TestParentCfgDefn d = TestParentCfgDefn.getInstance();
|
d.initialize();
|
String baseName = d.getClass().getName();
|
ResourceBundle resourceBundle = ResourceBundle.getBundle(baseName);
|
ManagedObjectDefinitionI18NResource.getInstance().setResourceBundle(d,
|
resourceBundle);
|
}
|
|
{
|
// Register the test child object class.
|
DirectoryServer.registerObjectClass(TEST_CHILD_OCD, true);
|
|
// Register the test child resource bundle.
|
TestChildCfgDefn d = TestChildCfgDefn.getInstance();
|
d.initialize();
|
String baseName = d.getClass().getName();
|
ResourceBundle resourceBundle = ResourceBundle.getBundle(baseName);
|
ManagedObjectDefinitionI18NResource.getInstance().setResourceBundle(d,
|
resourceBundle);
|
}
|
|
// Ensure that the relations are registered (do this after things
|
// that can fail and leave tests in a bad state).
|
RootCfgDefn.getInstance().registerRelationDefinition(
|
RD_TEST_ONE_TO_MANY_PARENT);
|
RootCfgDefn.getInstance().registerRelationDefinition(
|
RD_TEST_ONE_TO_ZERO_OR_ONE_PARENT);
|
LDAPProfile.getInstance().pushWrapper(new MockLDAPProfile());
|
}
|
|
|
|
/**
|
* Deregisters the test configurations from the administration
|
* framework.
|
*/
|
public static void cleanup() {
|
LDAPProfile.getInstance().popWrapper();
|
|
{
|
AbstractManagedObjectDefinition<?, ?> root = RootCfgDefn.getInstance();
|
root.deregisterRelationDefinition(RD_TEST_ONE_TO_MANY_PARENT);
|
root.deregisterRelationDefinition(RD_TEST_ONE_TO_ZERO_OR_ONE_PARENT);
|
|
DirectoryServer.deregisterObjectClass(TEST_PARENT_OCD);
|
TestParentCfgDefn d = TestParentCfgDefn.getInstance();
|
ManagedObjectDefinitionI18NResource.getInstance().removeResourceBundle(d);
|
}
|
|
{
|
DirectoryServer.deregisterObjectClass(TEST_CHILD_OCD);
|
TestChildCfgDefn d = TestChildCfgDefn.getInstance();
|
ManagedObjectDefinitionI18NResource.getInstance().removeResourceBundle(d);
|
}
|
|
}
|
|
|
|
/**
|
* Gets the one-to-many relation between the root and test-parent
|
* components.
|
* <p>
|
* Unit tests which call this method <b>must</b> have already
|
* called {@link #setUp()}.
|
*
|
* @return Returns the one-to-many relation between the root and
|
* test-parent components.
|
*/
|
public static InstantiableRelationDefinition<TestParentCfgClient, TestParentCfg> getTestOneToManyParentRelationDefinition() {
|
return RD_TEST_ONE_TO_MANY_PARENT;
|
}
|
|
|
|
/**
|
* Gets the one-to-zero-or-one relation between the root and a
|
* test-parent component.
|
* <p>
|
* Unit tests which call this method <b>must</b> have already
|
* called {@link #setUp()}.
|
*
|
* @return Returns the one-to-zero-or-one relation between the root
|
* and a test-parent component.
|
*/
|
public static OptionalRelationDefinition<TestParentCfgClient, TestParentCfg> getTestOneToZeroOrOneParentRelationDefinition() {
|
return RD_TEST_ONE_TO_ZERO_OR_ONE_PARENT;
|
}
|
|
|
|
/**
|
* Initializes a property definition and its default behavior.
|
*
|
* @param pd
|
* The property definition to be initialized.
|
* @throws Exception
|
* If the property definition could not be initialized.
|
*/
|
public static void initializePropertyDefinition(PropertyDefinition<?> pd)
|
throws Exception {
|
pd.initialize();
|
pd.getDefaultBehaviorProvider().initialize();
|
}
|
|
|
|
/**
|
* Adds a constraint temporarily with test child definition.
|
*
|
* @param constraint
|
* The constraint.
|
*/
|
public static void addConstraint(Constraint constraint) {
|
TestChildCfgDefn.getInstance().registerConstraint(constraint);
|
}
|
|
|
|
/**
|
* Adds a property definition temporarily with test child
|
* definition, replacing any existing property definition with the
|
* same name.
|
*
|
* @param pd
|
* The property definition.
|
*/
|
public static void addPropertyDefinition(PropertyDefinition<?> pd) {
|
TestChildCfgDefn.getInstance().registerPropertyDefinition(pd);
|
}
|
|
|
|
/**
|
* Removes a constraint from the test child definition.
|
*
|
* @param constraint
|
* The constraint.
|
*/
|
public static void removeConstraint(Constraint constraint) {
|
TestChildCfgDefn.getInstance().deregisterConstraint(constraint);
|
}
|
|
|
|
// Prevent instantiation.
|
private TestCfg() {
|
// No implementation required.
|
}
|
|
}
|
