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   *     https://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.extras.controls.syncrepl_impl;
21  
22  
23  import org.apache.directory.api.asn1.DecoderException;
24  import org.apache.directory.api.asn1.ber.tlv.BerValue;
25  import org.apache.directory.api.asn1.util.Asn1Buffer;
26  import org.apache.directory.api.ldap.codec.api.AbstractControlFactory;
27  import org.apache.directory.api.ldap.codec.api.ControlFactory;
28  import org.apache.directory.api.ldap.codec.api.LdapApiService;
29  import org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest.SyncRequestValue;
30  import org.apache.directory.api.ldap.extras.controls.syncrepl.syncRequest.SyncRequestValueImpl;
31  import org.apache.directory.api.ldap.model.message.Control;
32  
33  
34  /**
35   * A {@link ControlFactory} which creates {@link SyncRequestValue} controls.
36   *
37   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
38   * @version $Rev$, $Date$
39   */
40  public class SyncRequestValueFactory extends AbstractControlFactory<SyncRequestValue>
41  {
42      /**
43       * Creates a new instance of SyncRequestValueFactory.
44       *
45       * @param codec The codec for this factory.
46       */
47      public SyncRequestValueFactory( LdapApiService codec )
48      {
49          super( codec, SyncRequestValue.OID );
50      }
51  
52  
53      /**
54       * {@inheritDoc}
55       */
56      @Override
57      public SyncRequestValue newControl()
58      {
59          return new SyncRequestValueImpl();
60      }
61  
62  
63      @Override
64      public void encodeValue( Asn1Buffer buffer, Control control )
65      {
66          int start = buffer.getPos();
67          SyncRequestValue syncRequestValue = ( SyncRequestValue ) control;
68          
69          // The reloadHint if not false
70          if ( syncRequestValue.isReloadHint() )
71          {
72              BerValue.encodeBoolean( buffer, true );
73          }
74  
75          // The cookie, if any
76          if ( syncRequestValue.getCookie() != null )
77          {
78              BerValue.encodeOctetString( buffer, syncRequestValue.getCookie() );
79          }
80          
81          // The mode
82          BerValue.encodeEnumerated( buffer, syncRequestValue.getMode().getValue() );
83  
84          // The sequence
85          BerValue.encodeSequence( buffer, start );
86      }
87  
88  
89      /**
90       * {@inheritDoc}
91       */
92      @Override
93      public void decodeValue( Control control, byte[] controlBytes ) throws DecoderException
94      {
95          decodeValue( new SyncRequestValueContainer( control ), control, controlBytes );
96      }
97  }