View Javadoc
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.response;
21  
22  
23  import org.apache.directory.api.ldap.codec.api.LdapApiService;
24  import org.apache.directory.api.ldap.model.message.MessageTypeEnum;
25  import org.apache.directory.api.ldap.model.message.ModifyDnResponse;
26  import org.apache.directory.api.ldap.model.message.ModifyDnResponseImpl;
27  import org.dom4j.Element;
28  import org.dom4j.tree.DefaultElement;
29  
30  
31  /**
32   * DSML Decorator for ModDNResponse
33   * 
34   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
35   */
36  public class ModDNResponseDsml extends AbstractResultResponseDsml<ModifyDnResponse>
37      implements ModifyDnResponse
38  {
39      private static final String MOD_DN_RESPONSE_TAG = "modDNResponse";
40  
41  
42      /**
43       * Creates a new getDecoratedMessage() of ModDNResponseDsml.
44       * 
45       * @param codec The LDAP Service to use
46       */
47      public ModDNResponseDsml( LdapApiService codec )
48      {
49          super( codec, new ModifyDnResponseImpl() );
50      }
51  
52  
53      /**
54       * Creates a new getDecoratedMessage() of ModDNResponseDsml.
55       *
56       * @param codec The LDAP Service to use
57       * @param ldapMessage the message to decorate
58       */
59      public ModDNResponseDsml( LdapApiService codec, ModifyDnResponse ldapMessage )
60      {
61          super( codec, ldapMessage );
62      }
63  
64  
65      /**
66       * {@inheritDoc}
67       */
68      public MessageTypeEnum getType()
69      {
70          return getDecorated().getType();
71      }
72  
73  
74      /**
75       * {@inheritDoc}
76       */
77      public Element toDsml( Element root )
78      {
79          Element element = null;
80  
81          if ( root != null )
82          {
83              element = root.addElement( MOD_DN_RESPONSE_TAG );
84          }
85          else
86          {
87              element = new DefaultElement( MOD_DN_RESPONSE_TAG );
88          }
89  
90          LdapResultDsml ldapResultDsml = new LdapResultDsml( getCodecService(),
91              getDecorated().getLdapResult(), getDecorated() );
92          ldapResultDsml.toDsml( element );
93          return element;
94      }
95  }