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.shared.kerberos.codec.krbError.actions;
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.BerValue;
026import org.apache.directory.api.asn1.ber.tlv.TLV;
027import org.apache.directory.api.i18n.I18n;
028import org.apache.directory.api.util.Strings;
029import org.apache.directory.shared.kerberos.codec.krbError.KrbErrorContainer;
030import org.apache.directory.shared.kerberos.messages.KrbError;
031import org.slf4j.Logger;
032import org.slf4j.LoggerFactory;
033
034
035/**
036 * The action used to read the KrbError etext
037 *
038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039 */
040public class StoreEText extends GrammarAction<KrbErrorContainer>
041{
042    /** The logger */
043    private static final Logger LOG = LoggerFactory.getLogger( StoreEText.class );
044
045    /** Speedup for logs */
046    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
047
048
049    /**
050     * Instantiates a new AbstractReadRealm action.
051     */
052    public StoreEText()
053    {
054        super( "KRB-ERROR etext" );
055    }
056
057
058    /**
059     * {@inheritDoc}
060     */
061    public final void action( KrbErrorContainer krbErrorContainer ) throws DecoderException
062    {
063        TLV tlv = krbErrorContainer.getCurrentTLV();
064
065        // The Length should not be null
066        if ( tlv.getLength() == 0 )
067        {
068            LOG.error( I18n.err( I18n.ERR_01308_ZERO_LENGTH_TLV ) );
069
070            // This will generate a PROTOCOL_ERROR
071            throw new DecoderException( I18n.err( I18n.ERR_01309_EMPTY_TLV ) );
072        }
073
074        // The value is the realm
075        BerValue value = tlv.getValue();
076        String eText = Strings.utf8ToString( value.getData() );
077
078        KrbError krbError = krbErrorContainer.getKrbError();
079        krbError.setEText( eText );
080
081        if ( IS_DEBUG )
082        {
083            LOG.debug( "eText: {}", eText );
084        }
085
086        krbErrorContainer.setGrammarEndAllowed( true );
087    }
088}