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.ldap.codec.controls.search.subentries;
21  
22  
23  import org.apache.directory.api.ldap.codec.api.CodecControl;
24  import org.apache.directory.api.ldap.codec.api.ControlFactory;
25  import org.apache.directory.api.ldap.codec.api.LdapApiService;
26  import org.apache.directory.api.ldap.model.message.controls.Subentries;
27  
28  
29  /**
30   * A factory for creating {@link Subentries} Controls and their 
31   * {@link SubentriesDecorator} objects.
32   *
33   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34   * @version $Rev$, $Date$
35   */
36  public class SubentriesFactory implements ControlFactory<Subentries>
37  {
38      /** The LDAP codec service */
39      private LdapApiService codec;
40  
41  
42      /**
43       * Creates a new instance of SubentriesFactory.
44       *
45       * @param codec The LDAP service instance
46       */
47      public SubentriesFactory( LdapApiService codec )
48      {
49          this.codec = codec;
50      }
51  
52  
53      /**
54       * 
55       * {@inheritDoc}
56       */
57      @Override
58      public String getOid()
59      {
60          return Subentries.OID;
61      }
62  
63  
64      /**
65       * 
66       * {@inheritDoc}
67       */
68      @Override
69      public CodecControl<Subentries> newCodecControl()
70      {
71          return new SubentriesDecorator( codec );
72      }
73  
74  
75      /**
76       * 
77       * {@inheritDoc}
78       */
79      @Override
80      public CodecControl<Subentries> newCodecControl( Subentries control )
81      {
82          return new SubentriesDecorator( codec, control );
83      }
84  }