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.padata;
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.padata.actions.PaDataInit;
030import org.apache.directory.shared.kerberos.codec.padata.actions.StoreDataType;
031import org.apache.directory.shared.kerberos.codec.padata.actions.StorePaDataValue;
032import org.slf4j.Logger;
033import org.slf4j.LoggerFactory;
034
035
036/**
037 * This class implements the PaData 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 PaDataGrammar extends AbstractGrammar<PaDataContainer>
044{
045    /** The logger */
046    static final Logger LOG = LoggerFactory.getLogger( PaDataGrammar.class );
047
048    /** A speedup for logger */
049    static final boolean IS_DEBUG = LOG.isDebugEnabled();
050
051    /** The instance of grammar. PaDataGrammar is a singleton */
052    private static Grammar<PaDataContainer> instance = new PaDataGrammar();
053
054
055    /**
056     * Creates a new PaDataGrammar object.
057     */
058    @SuppressWarnings("unchecked")
059    private PaDataGrammar()
060    {
061        setName( PaDataGrammar.class.getName() );
062
063        // Create the transitions table
064        super.transitions = new GrammarTransition[PaDataStatesEnum.LAST_PADATA_STATE.ordinal()][256];
065
066        // ============================================================================================
067        // PaData
068        // ============================================================================================
069        // --------------------------------------------------------------------------------------------
070        // Transition from PaData init to PaData SEQ OF
071        // --------------------------------------------------------------------------------------------
072        // PA-DATA         ::= SEQUENCE {
073        super.transitions[PaDataStatesEnum.START_STATE.ordinal()][UniversalTag.SEQUENCE.getValue()] =
074            new GrammarTransition<PaDataContainer>(
075                PaDataStatesEnum.START_STATE,
076                PaDataStatesEnum.PADATA_SEQ_STATE,
077                UniversalTag.SEQUENCE,
078                new PaDataInit() );
079
080        // --------------------------------------------------------------------------------------------
081        // Transition from PaData SEQ to padata-type tag
082        // --------------------------------------------------------------------------------------------
083        // PA-DATA         ::= SEQUENCE {
084        //       padata-type     [1]
085        super.transitions[PaDataStatesEnum.PADATA_SEQ_STATE.ordinal()][KerberosConstants.PADATA_TYPE_TAG] =
086            new GrammarTransition<PaDataContainer>(
087                PaDataStatesEnum.PADATA_SEQ_STATE,
088                PaDataStatesEnum.PADATA_TYPE_TAG_STATE,
089                KerberosConstants.PADATA_TYPE_TAG,
090                new CheckNotNullLength<PaDataContainer>() );
091
092        // --------------------------------------------------------------------------------------------
093        // Transition from PaData type tag to padata-type
094        // --------------------------------------------------------------------------------------------
095        // PA-DATA         ::= SEQUENCE {
096        //       padata-type     [1] Int32
097        super.transitions[PaDataStatesEnum.PADATA_TYPE_TAG_STATE.ordinal()][UniversalTag.INTEGER.getValue()] =
098            new GrammarTransition<PaDataContainer>(
099                PaDataStatesEnum.PADATA_TYPE_TAG_STATE,
100                PaDataStatesEnum.PADATA_TYPE_STATE,
101                UniversalTag.INTEGER,
102                new StoreDataType() );
103
104        // --------------------------------------------------------------------------------------------
105        // Transition from padata-type to padata-value tag
106        // --------------------------------------------------------------------------------------------
107        // PA-DATA         ::= SEQUENCE {
108        //          padata-value    [2]
109        super.transitions[PaDataStatesEnum.PADATA_TYPE_STATE.ordinal()][KerberosConstants.PADATA_VALUE_TAG] =
110            new GrammarTransition<PaDataContainer>(
111                PaDataStatesEnum.PADATA_TYPE_STATE,
112                PaDataStatesEnum.PADATA_VALUE_TAG_STATE,
113                KerberosConstants.PADATA_VALUE_TAG,
114                new CheckNotNullLength<PaDataContainer>() );
115
116        // --------------------------------------------------------------------------------------------
117        // Transition from padata-value tag to padata-value
118        // --------------------------------------------------------------------------------------------
119        // PA-DATA         ::= SEQUENCE {
120        //          padata-value    [2] OCTET STRING
121        super.transitions[PaDataStatesEnum.PADATA_VALUE_TAG_STATE.ordinal()][UniversalTag.OCTET_STRING.getValue()] =
122            new GrammarTransition<PaDataContainer>(
123                PaDataStatesEnum.PADATA_VALUE_TAG_STATE,
124                PaDataStatesEnum.PADATA_VALUE_STATE,
125                UniversalTag.OCTET_STRING,
126                new StorePaDataValue() );
127    }
128
129
130    /**
131     * Get the instance of this grammar
132     *
133     * @return An instance on the PaData Grammar
134     */
135    public static Grammar<PaDataContainer> getInstance()
136    {
137        return instance;
138    }
139}