001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 *
019 */
020package org.apache.directory.api.ldap.codec.actions.bindRequest;
021
022
023import org.apache.directory.api.asn1.DecoderException;
024import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
025import org.apache.directory.api.asn1.ber.tlv.TLV;
026import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
027import org.apache.directory.api.ldap.codec.decorators.BindRequestDecorator;
028import org.apache.directory.api.ldap.model.message.BindRequest;
029import org.apache.directory.api.util.Strings;
030import org.slf4j.Logger;
031import org.slf4j.LoggerFactory;
032
033
034/**
035 * The action used to store the BindRequest credentials.
036 * <pre>
037 * SaslCredentials ::= SEQUENCE {
038 *     ...
039 *     credentials OCTET STRING OPTIONAL }
040 * </pre>
041 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
042 */
043public class StoreSaslCredentials extends GrammarAction<LdapMessageContainer<BindRequestDecorator>>
044{
045    /** The logger */
046    private static final Logger LOG = LoggerFactory.getLogger( StoreSaslCredentials.class );
047
048    /** Speedup for logs */
049    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
050
051
052    /**
053     * Instantiates a new action.
054     */
055    public StoreSaslCredentials()
056    {
057        super( "Store SASL credentials" );
058    }
059
060
061    /**
062     * {@inheritDoc}
063     */
064    public void action( LdapMessageContainer<BindRequestDecorator> container ) throws DecoderException
065    {
066        BindRequest bindRequestMessage = container.getMessage();
067
068        // Get the Value and store it in the BindRequest
069        TLV tlv = container.getCurrentTLV();
070
071        // We have to handle the special case of a 0 length
072        // credentials
073        if ( tlv.getLength() == 0 )
074        {
075            bindRequestMessage.setCredentials( Strings.EMPTY_BYTES );
076        }
077        else
078        {
079            bindRequestMessage.setCredentials( tlv.getValue().getData() );
080        }
081
082        // We can have an END transition
083        container.setGrammarEndAllowed( true );
084
085        if ( IS_DEBUG )
086        {
087            LOG.debug( "The credentials are : {}", Strings.dumpBytes( bindRequestMessage
088                .getCredentials() ) );
089        }
090    }
091}