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.intermediateResponse;
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.asn1.util.Oid;
027import org.apache.directory.api.i18n.I18n;
028import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
029import org.apache.directory.api.ldap.codec.decorators.IntermediateResponseDecorator;
030import org.apache.directory.api.ldap.model.message.IntermediateResponse;
031import org.apache.directory.api.util.Strings;
032import org.slf4j.Logger;
033import org.slf4j.LoggerFactory;
034
035
036/**
037 * The action used to store a IntermediateResponse Name
038 * <pre>
039 * IntermediateResponse ::= [APPLICATION 25] SEQUENCE {
040 *     responseName [0] LDAPOID OPTIONAL,
041 * </pre>
042 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
043 */
044public class StoreIntermediateResponseName extends GrammarAction<LdapMessageContainer<IntermediateResponseDecorator>>
045{
046    /** The logger */
047    private static final Logger LOG = LoggerFactory.getLogger( StoreIntermediateResponseName.class );
048
049    /** Speedup for logs */
050    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
051
052
053    /**
054     * Instantiates a new response name action.
055     */
056    public StoreIntermediateResponseName()
057    {
058        super( "Store response name" );
059    }
060
061
062    /**
063     * {@inheritDoc}
064     */
065    public void action( LdapMessageContainer<IntermediateResponseDecorator> container ) throws DecoderException
066    {
067        // We can get the IntermediateResponse Object
068        IntermediateResponse intermediateResponse = container.getMessage();
069
070        // Get the Value and store it in the IntermediateResponse
071        TLV tlv = container.getCurrentTLV();
072
073        // We have to handle the special case of a 0 length matched
074        // OID.
075        if ( tlv.getLength() == 0 )
076        {
077            String msg = I18n.err( I18n.ERR_04095 );
078            LOG.error( msg );
079            // This will generate a PROTOCOL_ERROR
080            throw new DecoderException( msg );
081        }
082        else
083        {
084            byte[] responseNameBytes = tlv.getValue().getData();
085
086            String oidStr = Strings.utf8ToString( responseNameBytes );
087
088            if ( Oid.isOid( oidStr ) )
089            {
090                Oid.isOid( oidStr );
091                intermediateResponse.setResponseName( oidStr );
092            }
093            else
094            {
095                String msg = "The Intermediate Response name is not a valid OID : "
096                    + Strings.utf8ToString( responseNameBytes ) + " ("
097                    + Strings.dumpBytes( responseNameBytes ) + ") is invalid";
098                LOG.error( "{} : {}", msg, oidStr );
099
100                // Rethrow the exception, we will get a PROTOCOL_ERROR
101                throw new DecoderException( msg );
102            }
103        }
104
105        // We can have an END transition
106        container.setGrammarEndAllowed( true );
107
108        if ( IS_DEBUG )
109        {
110            LOG.debug( "OID read : {}", intermediateResponse.getResponseName() );
111        }
112    }
113}