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.apache.directory.shared.kerberos.KerberosTime;
031import org.slf4j.Logger;
032import org.slf4j.LoggerFactory;
033
034
035/**
036 * The action used to read the KerberosTime
037 *
038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039 */
040public abstract class AbstractReadKerberosTime<E extends Asn1Container> extends GrammarAction<E>
041{
042    /** The logger */
043    private static final Logger LOG = LoggerFactory.getLogger( AbstractReadKerberosTime.class );
044
045    /** Speedup for logs */
046    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
047
048
049    /**
050     * Instantiates a new AbstractReadKerberosTime action.
051     */
052    public AbstractReadKerberosTime( String name )
053    {
054        super( name );
055    }
056
057
058    /**
059     *
060     * set the KerberosTime on the ASN.1 object present in the container
061     *
062     * @param krbtime the KerberosTime decoded from the TLV
063     * @param container the ASN.1 object's container
064     */
065    protected abstract void setKerberosTime( KerberosTime krbtime, E container );
066
067
068    /**
069     * {@inheritDoc}
070     */
071    public final void action( E container ) throws DecoderException
072    {
073        TLV tlv = container.getCurrentTLV();
074
075        // The Length should not be null and should be 15
076        if ( tlv.getLength() != 15 )
077        {
078            LOG.error( I18n.err( I18n.ERR_01308_ZERO_LENGTH_TLV ) );
079
080            // This will generate a PROTOCOL_ERROR
081            throw new DecoderException( I18n.err( I18n.ERR_01309_EMPTY_TLV ) );
082        }
083
084        // The value is the KerberosTime
085        BerValue value = tlv.getValue();
086        String date = Strings.utf8ToString( value.getData() );
087
088        try
089        {
090            KerberosTime krbTime = new KerberosTime( date );
091
092            if ( IS_DEBUG )
093            {
094                LOG.debug( "decoded kerberos time is : {}", krbTime );
095            }
096
097            setKerberosTime( krbTime, container );
098        }
099        catch ( IllegalArgumentException iae )
100        {
101            LOG.error( I18n.err( I18n.ERR_01308_ZERO_LENGTH_TLV ) );
102
103            // This will generate a PROTOCOL_ERROR
104            throw new DecoderException( I18n.err( I18n.ERR_01309_EMPTY_TLV ) );
105        }
106    }
107}