/*
|
* 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.
|
*/
|
package org.opends.server.admin;
|
|
|
|
import org.opends.server.types.AttributeValue;
|
import org.opends.server.types.DN;
|
import org.opends.server.types.DirectoryException;
|
import org.opends.server.types.RDN;
|
import org.opends.server.util.StaticUtils;
|
|
|
|
/**
|
* A reference to another managed object.
|
*
|
* @param <C>
|
* The type of client managed object configuration that this
|
* reference refers to.
|
* @param <S>
|
* The type of server managed object configuration that this
|
* reference refers to.
|
*/
|
public final class Reference<C extends ConfigurationClient,
|
S extends Configuration> {
|
|
/**
|
* Parses a DN string value as a reference using the provided
|
* managed object path and relation definition.
|
*
|
* @param <C>
|
* The type of client managed object configuration that
|
* this reference refers to.
|
* @param <S>
|
* The type of server managed object configuration that
|
* this reference refers to.
|
* @param p
|
* The path of the referenced managed object's parent.
|
* @param rd
|
* The instantiable relation in the parent which contains
|
* the referenced managed object.
|
* @param s
|
* The DN string value.
|
* @return Returns the new reference based on the provided DN string
|
* value.
|
* @throws IllegalArgumentException
|
* If the DN string value could not be decoded as a DN or
|
* if the provided DN did not correspond to the provided
|
* path and relation.
|
*/
|
public static <C extends ConfigurationClient, S extends Configuration>
|
Reference<C, S> parseDN(
|
ManagedObjectPath<?, ?> p, InstantiableRelationDefinition<C, S> rd,
|
String s) throws IllegalArgumentException {
|
AbstractManagedObjectDefinition<?, ?> d = p.getManagedObjectDefinition();
|
RelationDefinition<?, ?> tmp = d.getRelationDefinition(rd.getName());
|
if (tmp != rd) {
|
throw new IllegalArgumentException("The relation \"" + rd.getName()
|
+ "\" is not associated with the definition \"" + d.getName() + "\"");
|
}
|
|
DN dn;
|
try {
|
dn = DN.decode(s);
|
} catch (DirectoryException e) {
|
throw new IllegalArgumentException("Unabled to decode the DN string: \""
|
+ s + "\"");
|
}
|
|
RDN rdn = dn.getRDN();
|
if (rdn == null) {
|
throw new IllegalArgumentException("Unabled to decode the DN string: \""
|
+ s + "\"");
|
}
|
|
AttributeValue av = rdn.getAttributeValue(0);
|
if (av == null) {
|
throw new IllegalArgumentException("Unabled to decode the DN string: \""
|
+ s + "\"");
|
}
|
|
String name = av.getValue().toString();
|
|
// Check that the DN was valid.
|
DN expected = p.child(rd, name).toDN();
|
if (!dn.equals(expected)) {
|
throw new IllegalArgumentException("Unabled to decode the DN string: \""
|
+ s + "\"");
|
}
|
|
return new Reference<C, S>(p, rd, name);
|
}
|
|
|
|
/**
|
* Parses a name as a reference using the provided managed object
|
* path and relation definition.
|
*
|
* @param <C>
|
* The type of client managed object configuration that
|
* this reference refers to.
|
* @param <S>
|
* The type of server managed object configuration that
|
* this reference refers to.
|
* @param p
|
* The path of the referenced managed object's parent.
|
* @param rd
|
* The instantiable relation in the parent which contains
|
* the referenced managed object.
|
* @param s
|
* The name of the referenced managed object.
|
* @return Returns the new reference based on the provided name.
|
* @throws IllegalArgumentException
|
* If the relation is not associated with the provided
|
* parent's definition, or if the provided name is empty.
|
*/
|
public static <C extends ConfigurationClient, S extends Configuration>
|
Reference<C, S> parseName(
|
ManagedObjectPath<?, ?> p, InstantiableRelationDefinition<C, S> rd,
|
String s) throws IllegalArgumentException {
|
// Sanity checks.
|
AbstractManagedObjectDefinition<?, ?> d = p.getManagedObjectDefinition();
|
RelationDefinition<?, ?> tmp = d.getRelationDefinition(rd.getName());
|
if (tmp != rd) {
|
throw new IllegalArgumentException("The relation \"" + rd.getName()
|
+ "\" is not associated with the definition \"" + d.getName() + "\"");
|
}
|
|
if (s.trim().length() == 0) {
|
throw new IllegalArgumentException("Empty names are not allowed");
|
}
|
|
return new Reference<C, S>(p, rd, s);
|
}
|
|
// The name of the referenced managed object.
|
private final String name;
|
|
// The path of the referenced managed object.
|
private final ManagedObjectPath<C, S> path;
|
|
// The instantiable relation in the parent which contains the
|
// referenced managed object.
|
private final InstantiableRelationDefinition<C, S> relation;
|
|
|
|
// Private constructor.
|
private Reference(ManagedObjectPath<?, ?> parent,
|
InstantiableRelationDefinition<C, S> relation, String name)
|
throws IllegalArgumentException {
|
this.relation = relation;
|
this.name = name;
|
this.path = parent.child(relation, name);
|
}
|
|
|
|
/**
|
* Gets the name of the referenced managed object.
|
*
|
* @return Returns the name of the referenced managed object.
|
*/
|
public String getName() {
|
return name;
|
}
|
|
|
|
/**
|
* Gets the normalized name of the referenced managed object.
|
*
|
* @return Returns the normalized name of the referenced managed
|
* object.
|
*/
|
public String getNormalizedName() {
|
PropertyDefinition<?> pd = relation.getNamingPropertyDefinition();
|
return normalizeName(pd);
|
}
|
|
|
|
/**
|
* Gets the DN of the referenced managed object.
|
*
|
* @return Returns the DN of the referenced managed object.
|
*/
|
public DN toDN() {
|
return path.toDN();
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
public String toString() {
|
return name;
|
}
|
|
|
|
// Normalize a value using the specified naming property definition
|
// if defined.
|
private <T> String normalizeName(PropertyDefinition<T> pd) {
|
if (pd != null) {
|
try {
|
T tvalue = pd.decodeValue(name);
|
return pd.normalizeValue(tvalue);
|
} catch (IllegalPropertyValueStringException e) {
|
// Fall through to default normalization.
|
}
|
}
|
|
// FIXME: should really use directory string normalizer.
|
String s = name.trim().replaceAll(" +", " ");
|
return StaticUtils.toLowerCase(s);
|
}
|
}
|
