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.codec.actions.request.bind;
21
22
23 import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
24 import org.apache.directory.api.asn1.ber.tlv.TLV;
25 import org.apache.directory.api.i18n.I18n;
26 import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
27 import org.apache.directory.api.ldap.model.message.BindRequest;
28 import org.apache.directory.api.util.Strings;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
31
32
33 /**
34 * The action used to store the BindRequest version MessageID.
35 * <pre>
36 * SaslCredentials ::= SEQUENCE {
37 * mechanism LDAPSTRING,
38 * ...
39 * </pre>
40 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
41 */
42 public class StoreSaslMechanism extends GrammarAction<LdapMessageContainer<BindRequest>>
43 {
44 /** The logger */
45 private static final Logger LOG = LoggerFactory.getLogger( StoreSaslMechanism.class );
46
47 /**
48 * Instantiates a new action.
49 */
50 public StoreSaslMechanism()
51 {
52 super( "Store SASL mechanism" );
53 }
54
55
56 /**
57 * {@inheritDoc}
58 */
59 @Override
60 public void action( LdapMessageContainer<BindRequest> container )
61 {
62 BindRequest bindRequestMessage = container.getMessage();
63 TLV tlv = container.getCurrentTLV();
64
65 // We have to handle the special case of a 0 length
66 // mechanism
67 if ( tlv.getLength() == 0 )
68 {
69 bindRequestMessage.setSaslMechanism( "" );
70 }
71 else
72 {
73 bindRequestMessage.setSaslMechanism( Strings.utf8ToString( tlv.getValue().getData() ) );
74 }
75
76 // We can have an END transition
77 container.setGrammarEndAllowed( true );
78
79 if ( LOG.isDebugEnabled() )
80 {
81 LOG.debug( I18n.msg( I18n.MSG_05118_THE_SASL_MECHANISM_IS, bindRequestMessage.getSaslMechanism() ) );
82 }
83 }
84 }