1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.dsmlv2;
21
22
23 import org.dom4j.Element;
24
25
26 /**
27 * This interface defines the methods that must be implemented to define a DSML Decorator
28 *
29 * @param <M> The message to decorate
30 *
31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public interface DsmlDecorator<M>
34 {
35 /**
36 * Converts the request/reponse to its XML representation in the DSMLv2 format
37 *
38 * @param root the root dom4j Element
39 * @return the dom4j Element corresponding to the entry.
40 */
41 Element toDsml( Element root );
42
43
44 /**
45 * Gets the Message this DsmlDecorator decorates.
46 *
47 * @return The decorated Message instance
48 */
49 M getDecorated();
50 }