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.etypeInfoEntry;
021
022
023import org.apache.directory.api.asn1.actions.CheckNotNullLength;
024import org.apache.directory.api.asn1.ber.grammar.AbstractGrammar;
025import org.apache.directory.api.asn1.ber.grammar.Grammar;
026import org.apache.directory.api.asn1.ber.grammar.GrammarTransition;
027import org.apache.directory.api.asn1.ber.tlv.UniversalTag;
028import org.apache.directory.shared.kerberos.KerberosConstants;
029import org.apache.directory.shared.kerberos.codec.etypeInfoEntry.actions.ETypeInfoEntryInit;
030import org.apache.directory.shared.kerberos.codec.etypeInfoEntry.actions.StoreEType;
031import org.apache.directory.shared.kerberos.codec.etypeInfoEntry.actions.StoreSalt;
032import org.slf4j.Logger;
033import org.slf4j.LoggerFactory;
034
035
036/**
037 * This class implements the ETYPE-INFO-ENTRY structure. All the actions are declared
038 * in this class. As it is a singleton, these declaration are only done once. If
039 * an action is to be added or modified, this is where the work is to be done !
040 *
041 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
042 */
043public final class ETypeInfoEntryGrammar extends AbstractGrammar<ETypeInfoEntryContainer>
044{
045    /** The logger */
046    static final Logger LOG = LoggerFactory.getLogger( ETypeInfoEntryGrammar.class );
047
048    /** A speedup for logger */
049    static final boolean IS_DEBUG = LOG.isDebugEnabled();
050
051    /** The instance of grammar. ETypeInfoEntryGrammar is a singleton */
052    private static Grammar<ETypeInfoEntryContainer> instance = new ETypeInfoEntryGrammar();
053
054
055    /**
056     * Creates a new ETypeInfoEntryGrammar object.
057     */
058    @SuppressWarnings("unchecked")
059    private ETypeInfoEntryGrammar()
060    {
061        setName( ETypeInfoEntryGrammar.class.getName() );
062
063        // Create the transitions table
064        super.transitions = new GrammarTransition[ETypeInfoEntryStatesEnum.LAST_ETYPE_INFO_ENTRY_STATE.ordinal()][256];
065
066        // ============================================================================================
067        // ETYPE-INFO-ENTRY
068        // ============================================================================================
069        // --------------------------------------------------------------------------------------------
070        // Transition from ETYPE-INFO-ENTRY init to ETYPE-INFO-ENTRY SEQ
071        // --------------------------------------------------------------------------------------------
072        // ETYPE-INFO-ENTRY         ::= SEQUENCE {
073        super.transitions[ETypeInfoEntryStatesEnum.START_STATE.ordinal()][UniversalTag.SEQUENCE.getValue()] =
074            new GrammarTransition<ETypeInfoEntryContainer>(
075                ETypeInfoEntryStatesEnum.START_STATE,
076                ETypeInfoEntryStatesEnum.ETYPE_INFO_ENTRY_SEQ_STATE,
077                UniversalTag.SEQUENCE,
078                new ETypeInfoEntryInit() );
079
080        // --------------------------------------------------------------------------------------------
081        // Transition from ETYPE-INFO-ENTRY SEQ to etype tag
082        // --------------------------------------------------------------------------------------------
083        // ETYPE-INFO-ENTRY         ::= SEQUENCE {
084        //         etype           [0]
085        super.transitions[ETypeInfoEntryStatesEnum.ETYPE_INFO_ENTRY_SEQ_STATE.ordinal()][KerberosConstants.TRANSITED_ENCODING_TR_TYPE_TAG] =
086            new GrammarTransition<ETypeInfoEntryContainer>(
087                ETypeInfoEntryStatesEnum.ETYPE_INFO_ENTRY_SEQ_STATE,
088                ETypeInfoEntryStatesEnum.ETYPE_INFO_ENTRY_ETYPE_TAG_STATE,
089                KerberosConstants.TRANSITED_ENCODING_TR_TYPE_TAG,
090                new CheckNotNullLength<ETypeInfoEntryContainer>() );
091
092        // --------------------------------------------------------------------------------------------
093        // Transition from etype tag to etype value
094        // --------------------------------------------------------------------------------------------
095        // ETYPE-INFO-ENTRY         ::= SEQUENCE {
096        //         etype           [0] Int32,
097        super.transitions[ETypeInfoEntryStatesEnum.ETYPE_INFO_ENTRY_ETYPE_TAG_STATE.ordinal()][UniversalTag.INTEGER
098            .getValue()] =
099            new GrammarTransition<ETypeInfoEntryContainer>(
100                ETypeInfoEntryStatesEnum.ETYPE_INFO_ENTRY_ETYPE_TAG_STATE,
101                ETypeInfoEntryStatesEnum.ETYPE_INFO_ENTRY_ETYPE_STATE,
102                UniversalTag.INTEGER,
103                new StoreEType() );
104
105        // --------------------------------------------------------------------------------------------
106        // Transition from etype value to salt tag
107        // --------------------------------------------------------------------------------------------
108        // ETYPE-INFO-ENTRY         ::= SEQUENCE {
109        //         ...
110        //         salt            [1]
111        super.transitions[ETypeInfoEntryStatesEnum.ETYPE_INFO_ENTRY_ETYPE_STATE.ordinal()][KerberosConstants.TRANSITED_ENCODING_CONTENTS_TAG] =
112            new GrammarTransition<ETypeInfoEntryContainer>(
113                ETypeInfoEntryStatesEnum.ETYPE_INFO_ENTRY_ETYPE_STATE,
114                ETypeInfoEntryStatesEnum.ETYPE_INFO_ENTRY_SALT_TAG_STATE,
115                KerberosConstants.TRANSITED_ENCODING_CONTENTS_TAG,
116                new CheckNotNullLength<ETypeInfoEntryContainer>() );
117
118        // --------------------------------------------------------------------------------------------
119        // Transition from salt tag to salt value
120        // --------------------------------------------------------------------------------------------
121        // ETYPE-INFO-ENTRY         ::= SEQUENCE {
122        //         ...
123        //         salt            [1] OCTET STRING OPTIONAL
124        super.transitions[ETypeInfoEntryStatesEnum.ETYPE_INFO_ENTRY_SALT_TAG_STATE.ordinal()][UniversalTag.OCTET_STRING
125            .getValue()] =
126            new GrammarTransition<ETypeInfoEntryContainer>(
127                ETypeInfoEntryStatesEnum.ETYPE_INFO_ENTRY_SALT_TAG_STATE,
128                ETypeInfoEntryStatesEnum.ETYPE_INFO_ENTRY_SALT_STATE,
129                UniversalTag.OCTET_STRING,
130                new StoreSalt() );
131    }
132
133
134    /**
135     * Get the instance of this grammar
136     *
137     * @return An instance on the ETYPE-INFO-ENTRY Grammar
138     */
139    public static Grammar<ETypeInfoEntryContainer> getInstance()
140    {
141        return instance;
142    }
143}