/*
* 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-2009 Sun Microsystems, Inc.
*/
package org.opends.server.admin;
/**
* A strategy for serializing managed object paths.
* <p>
* This interface provides a generic means for serializing managed
* object paths into application specific forms. For example, a JNDI
* client would use this interface to construct <code>LdapName</code>
* objects from a path. Similarly, on the server side, a serialization
* strategy is used to construct <code>DN</code> instances from a
* path.
* <p>
* During serialization the serializer is invoked for each element in
* the managed object path in big-endian order, starting from the root
* and proceeding down to the leaf element.
*/
public interface ManagedObjectPathSerializer {
/**
* Append a managed object path element identified by an
* instantiable relation and an instance name.
*
* @param <C>
* The type of client managed object configuration that
* this path element references.
* @param <S>
* The type of server managed object configuration that
* this path element references.
* @param r
* The instantiable relation.
* @param d
* The managed object definition.
* @param name
* The instance name.
*/
<C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
InstantiableRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d, String name);
/**
* Append a managed object path element identified by an optional
* relation.
*
* @param <C>
* The type of client managed object configuration that
* this path element references.
* @param <S>
* The type of server managed object configuration that
* this path element references.
* @param r
* The optional relation.
* @param d
* The managed object definition.
*/
<C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
OptionalRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d);
/**
* Append a managed object path element identified by a singleton
* relation.
*
* @param <C>
* The type of client managed object configuration that
* this path element references.
* @param <S>
* The type of server managed object configuration that
* this path element references.
* @param r
* The singleton relation.
* @param d
* The managed object definition.
*/
<C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
SingletonRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d);
/**
* Append a managed object path element identified by a
* set relation.
*
* @param <C>
* The type of client managed object configuration that
* this path element references.
* @param <S>
* The type of server managed object configuration that
* this path element references.
* @param r
* The set relation.
* @param d
* The managed object definition.
*/
<C extends ConfigurationClient, S extends Configuration>
void appendManagedObjectPathElement(
SetRelationDefinition<? super C, ? super S> r,
AbstractManagedObjectDefinition<C, S> d);
}