001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     * 
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     * 
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License.
018     * 
019     */
020    package org.apache.directory.api.dsmlv2;
021    
022    
023    import org.dom4j.Element;
024    
025    
026    /**
027     * This interface defines the methods that must be implemented to define a DSML Decorator
028     * 
029     * @param <M> The message to decorate
030     *
031     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032     */
033    public interface DsmlDecorator<M>
034    {
035        /**
036         * Converts the request/reponse to its XML representation in the DSMLv2 format
037         * 
038         * @param root the root dom4j Element
039         * @return the dom4j Element corresponding to the entry.
040         */
041        Element toDsml( Element root );
042    
043    
044        /**
045         * Gets the Message this DsmlDecorator decorates.
046         * 
047         * @return The decorated Message instance
048         */
049        M getDecorated();
050    }