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.actions.bindRequest;
21  
22  
23  import org.apache.directory.api.asn1.DecoderException;
24  import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
25  import org.apache.directory.api.asn1.ber.tlv.TLV;
26  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
27  import org.apache.directory.api.ldap.codec.decorators.BindRequestDecorator;
28  import org.apache.directory.api.ldap.model.message.BindRequest;
29  import org.apache.directory.api.util.StringConstants;
30  import org.apache.directory.api.util.Strings;
31  import org.slf4j.Logger;
32  import org.slf4j.LoggerFactory;
33  
34  
35  /**
36   * The action used to store the BindRequest credentials.
37   * <pre>
38   * SaslCredentials ::= SEQUENCE {
39   *     ...
40   *     credentials OCTET STRING OPTIONAL }
41   * </pre>
42   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
43   */
44  public class StoreSaslCredentials extends GrammarAction<LdapMessageContainer<BindRequestDecorator>>
45  {
46      /** The logger */
47      private static final Logger LOG = LoggerFactory.getLogger( StoreSaslCredentials.class );
48  
49      /** Speedup for logs */
50      private static final boolean IS_DEBUG = LOG.isDebugEnabled();
51  
52  
53      /**
54       * Instantiates a new action.
55       */
56      public StoreSaslCredentials()
57      {
58          super( "Store SASL credentials" );
59      }
60  
61  
62      /**
63       * {@inheritDoc}
64       */
65      public void action( LdapMessageContainer<BindRequestDecorator> container ) throws DecoderException
66      {
67          BindRequest bindRequestMessage = container.getMessage();
68  
69          // Get the Value and store it in the BindRequest
70          TLV tlv = container.getCurrentTLV();
71  
72          // We have to handle the special case of a 0 length
73          // credentials
74          if ( tlv.getLength() == 0 )
75          {
76              bindRequestMessage.setCredentials( StringConstants.EMPTY_BYTES );
77          }
78          else
79          {
80              bindRequestMessage.setCredentials( tlv.getValue().getData() );
81          }
82  
83          // We can have an END transition
84          container.setGrammarEndAllowed( true );
85  
86          if ( IS_DEBUG )
87          {
88              LOG.debug( "The credentials are : {}", Strings.dumpBytes( bindRequestMessage
89                  .getCredentials() ) );
90          }
91      }
92  }