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.actions;
021
022
023import org.apache.directory.api.asn1.DecoderException;
024import org.apache.directory.api.asn1.ber.Asn1Container;
025import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
026import org.apache.directory.api.asn1.ber.tlv.BerValue;
027import org.apache.directory.api.asn1.ber.tlv.TLV;
028import org.apache.directory.api.i18n.I18n;
029import org.apache.directory.api.util.Strings;
030import org.slf4j.Logger;
031import org.slf4j.LoggerFactory;
032
033
034/**
035 * The action used to read the Realm
036 *
037 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
038 */
039public abstract class AbstractReadRealm<E extends Asn1Container> extends GrammarAction<E>
040{
041    /** The logger */
042    private static final Logger LOG = LoggerFactory.getLogger( AbstractReadRealm.class );
043
044    /** Speedup for logs */
045    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
046
047
048    /**
049     * Instantiates a new AbstractReadRealm action.
050     */
051    public AbstractReadRealm( String name )
052    {
053        super( name );
054    }
055
056
057    /**
058     * sets the relam value on the ASN.1 object present in the container
059     *
060     * @param realm the realm name
061     * @param container the container holding ASN.1 object
062     */
063    protected abstract void setRealm( String realm, E container );
064
065
066    /**
067     * {@inheritDoc}
068     */
069    public final void action( E container ) throws DecoderException
070    {
071        TLV tlv = container.getCurrentTLV();
072
073        // The Length should not be null
074        if ( tlv.getLength() == 0 )
075        {
076            LOG.error( I18n.err( I18n.ERR_01308_ZERO_LENGTH_TLV ) );
077
078            // This will generate a PROTOCOL_ERROR
079            throw new DecoderException( I18n.err( I18n.ERR_01309_EMPTY_TLV ) );
080        }
081
082        // The value is the realm
083        BerValue value = tlv.getValue();
084        String realm = Strings.utf8ToString( value.getData() );
085
086        if ( IS_DEBUG )
087        {
088            LOG.debug( "read realm value : {}", realm );
089        }
090
091        setRealm( realm, container );
092    }
093}