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.passwordExpired_impl;
21  
22  import org.apache.directory.api.asn1.DecoderException;
23  import org.apache.directory.api.asn1.util.Asn1Buffer;
24  import org.apache.directory.api.i18n.I18n;
25  import org.apache.directory.api.ldap.codec.api.AbstractControlFactory;
26  import org.apache.directory.api.ldap.codec.api.ControlFactory;
27  import org.apache.directory.api.ldap.codec.api.LdapApiService;
28  import org.apache.directory.api.ldap.extras.controls.passwordExpired.PasswordExpiredResponse;
29  import org.apache.directory.api.ldap.extras.controls.passwordExpired.PasswordExpiredResponseImpl;
30  import org.apache.directory.api.ldap.model.message.Control;
31  import org.apache.directory.api.util.Strings;
32  
33  /**
34   * A {@link ControlFactory} which creates {@link PasswordExpiredResponse} controls.
35   *
36   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
37   */
38  public class PasswordExpiredResponseFactory extends AbstractControlFactory<PasswordExpiredResponse>
39  {
40      /**
41       * Creates a new instance of PasswordExpiredResponseFactory.
42       *
43       * @param codec The LDAP codec.
44       */
45      public PasswordExpiredResponseFactory( LdapApiService codec )
46      {
47          super( codec, PasswordExpiredResponse.OID );
48      }
49      
50  
51      /**
52       * {@inheritDoc}
53       */
54      @Override
55      public PasswordExpiredResponse newControl() 
56      {
57          return new PasswordExpiredResponseImpl();
58      }
59      
60  
61      /**
62       * {@inheritDoc}
63       */
64      @Override
65      public void decodeValue( Control control, byte[] controlBytes ) throws DecoderException 
66      {
67          try 
68          {
69              if ( !Strings.utf8ToString( controlBytes ).equals( "0" ) )
70              {
71                  throw new DecoderException( I18n.err( I18n.ERR_08110_BAD_PASSWORD_EXPIRED_VALUE, Strings.dumpBytes( controlBytes ) ) );
72              }
73          }
74          catch ( RuntimeException re ) 
75          {
76              throw new DecoderException( re.getMessage() );
77          }
78      }
79  
80  
81      /**
82       * {@inheritDoc}
83       */
84      @Override
85      public void encodeValue( Asn1Buffer buffer, Control control )
86      {
87          // Always '0'
88          buffer.put( ( byte ) 0x30 );
89      }
90  }