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.typedData;
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.typedData.actions.StoreDataValue;
030import org.apache.directory.shared.kerberos.codec.typedData.actions.StoreTdType;
031import org.apache.directory.shared.kerberos.codec.typedData.actions.TypedDataInit;
032import org.slf4j.Logger;
033import org.slf4j.LoggerFactory;
034
035
036/**
037 * This class implements the TypedData 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 TypedDataGrammar extends AbstractGrammar<TypedDataContainer>
044{
045    /** The logger */
046    static final Logger LOG = LoggerFactory.getLogger( TypedDataGrammar.class );
047
048    /** A speedup for logger */
049    static final boolean IS_DEBUG = LOG.isDebugEnabled();
050
051    /** The instance of grammar. TypedDataGrammar is a singleton */
052    private static Grammar<TypedDataContainer> instance = new TypedDataGrammar();
053
054
055    /**
056     * Creates a new TypedDataGrammar object.
057     */
058    @SuppressWarnings("unchecked")
059    private TypedDataGrammar()
060    {
061        setName( TypedDataGrammar.class.getName() );
062
063        // Create the transitions table
064        super.transitions = new GrammarTransition[TypedDataStatesEnum.LAST_TYPED_DATA_STATE.ordinal()][256];
065
066        // ============================================================================================
067        // TypedData
068        // ============================================================================================
069        // --------------------------------------------------------------------------------------------
070        // Transition from TypedData init to TypedData SEQ OF
071        // --------------------------------------------------------------------------------------------
072        // TypedData   ::= SEQUENCE OF
073        super.transitions[TypedDataStatesEnum.START_STATE.ordinal()][UniversalTag.SEQUENCE.getValue()] =
074            new GrammarTransition<TypedDataContainer>(
075                TypedDataStatesEnum.START_STATE,
076                TypedDataStatesEnum.TYPED_DATA_SEQ_SEQ_STATE,
077                UniversalTag.SEQUENCE,
078                new TypedDataInit() );
079
080        // --------------------------------------------------------------------------------------------
081        // Transition from TypedData SEQ OF to SEQ
082        // --------------------------------------------------------------------------------------------
083        // TypedData  ::= SEQUENCE OF SEQUENCE {
084        super.transitions[TypedDataStatesEnum.TYPED_DATA_SEQ_SEQ_STATE.ordinal()][UniversalTag.SEQUENCE.getValue()] =
085            new GrammarTransition<TypedDataContainer>(
086                TypedDataStatesEnum.TYPED_DATA_SEQ_SEQ_STATE,
087                TypedDataStatesEnum.TYPED_DATA_SEQ_STATE,
088                UniversalTag.SEQUENCE,
089                new CheckNotNullLength<TypedDataContainer>() );
090
091        // --------------------------------------------------------------------------------------------
092        // Transition from TypedData SEQ OF to tdType tag
093        // --------------------------------------------------------------------------------------------
094        // TypedData  ::= SEQUENCE OF SEQUENCE {
095        //         data-type     [0]
096        super.transitions[TypedDataStatesEnum.TYPED_DATA_SEQ_STATE.ordinal()][KerberosConstants.TYPED_DATA_TDTYPE_TAG] =
097            new GrammarTransition<TypedDataContainer>(
098                TypedDataStatesEnum.TYPED_DATA_SEQ_STATE,
099                TypedDataStatesEnum.TYPED_DATA_TDTYPE_TAG_STATE,
100                KerberosConstants.TYPED_DATA_TDTYPE_TAG,
101                new CheckNotNullLength<TypedDataContainer>() );
102
103        // --------------------------------------------------------------------------------------------
104        // Transition from adtype tag to tdtype value
105        // --------------------------------------------------------------------------------------------
106        // TypedData  ::= SEQUENCE OF SEQUENCE {
107        //         data-type     [0] Int32,
108        super.transitions[TypedDataStatesEnum.TYPED_DATA_TDTYPE_TAG_STATE.ordinal()][UniversalTag.INTEGER.getValue()] =
109            new GrammarTransition<TypedDataContainer>(
110                TypedDataStatesEnum.TYPED_DATA_TDTYPE_TAG_STATE,
111                TypedDataStatesEnum.TYPED_DATA_TDTYPE_STATE,
112                UniversalTag.INTEGER,
113                new StoreTdType() );
114
115        // --------------------------------------------------------------------------------------------
116        // Transition from ad-type value to ad-data tag
117        // --------------------------------------------------------------------------------------------
118        // TypedData   ::= SEQUENCE OF SEQUENCE {
119        //         ...
120        //         data-value     [1]
121        super.transitions[TypedDataStatesEnum.TYPED_DATA_TDTYPE_STATE.ordinal()][KerberosConstants.TYPED_DATA_TDDATA_TAG] =
122            new GrammarTransition<TypedDataContainer>(
123                TypedDataStatesEnum.TYPED_DATA_TDTYPE_STATE,
124                TypedDataStatesEnum.TYPED_DATA_TDDATA_TAG_STATE,
125                KerberosConstants.TYPED_DATA_TDDATA_TAG,
126                new CheckNotNullLength<TypedDataContainer>() );
127
128        // --------------------------------------------------------------------------------------------
129        // Transition from ad-data tag to ad-data value
130        // --------------------------------------------------------------------------------------------
131        // TypedData   ::= SEQUENCE OF SEQUENCE {
132        //         ...
133        //         data-value     [1] (OCTET STRING)
134        super.transitions[TypedDataStatesEnum.TYPED_DATA_TDDATA_TAG_STATE.ordinal()][UniversalTag.OCTET_STRING
135            .getValue()] =
136            new GrammarTransition<TypedDataContainer>(
137                TypedDataStatesEnum.TYPED_DATA_TDDATA_TAG_STATE,
138                TypedDataStatesEnum.TYPED_DATA_TDDATA_STATE,
139                UniversalTag.OCTET_STRING,
140                new StoreDataValue() );
141
142        // --------------------------------------------------------------------------------------------
143        // Transition from ad-data value to SEQUENCE
144        // --------------------------------------------------------------------------------------------
145        // TypedData   ::= SEQUENCE {
146        //         ...
147        //         data-value     [1] (OCTET STRING)
148        super.transitions[TypedDataStatesEnum.TYPED_DATA_TDDATA_STATE.ordinal()][UniversalTag.SEQUENCE.getValue()] =
149            new GrammarTransition<TypedDataContainer>(
150                TypedDataStatesEnum.TYPED_DATA_TDDATA_STATE,
151                TypedDataStatesEnum.TYPED_DATA_SEQ_STATE,
152                UniversalTag.SEQUENCE,
153                new CheckNotNullLength<TypedDataContainer>() );
154    }
155
156
157    // ~ Methods
158    // ------------------------------------------------------------------------------------
159
160    /**
161     * Get the instance of this grammar
162     *
163     * @return An instance on the TypedData Grammar
164     */
165    public static Grammar<TypedDataContainer> getInstance()
166    {
167        return instance;
168    }
169}