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.principalName;
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.principalName.actions.PrincipalNameInit;
030import org.apache.directory.shared.kerberos.codec.principalName.actions.StoreNameString;
031import org.apache.directory.shared.kerberos.codec.principalName.actions.StoreNameType;
032import org.slf4j.Logger;
033import org.slf4j.LoggerFactory;
034
035
036/**
037 * This class implements the PrincipalName. 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 PrincipalNameGrammar extends AbstractGrammar<PrincipalNameContainer>
044{
045    /** The logger */
046    static final Logger LOG = LoggerFactory.getLogger( PrincipalNameGrammar.class );
047
048    /** A speedup for logger */
049    static final boolean IS_DEBUG = LOG.isDebugEnabled();
050
051    /** The instance of grammar. PrincipalNameGrammar is a singleton */
052    private static Grammar<PrincipalNameContainer> instance = new PrincipalNameGrammar();
053
054
055    /**
056     * Creates a new PrincipalNameGrammar object.
057     */
058    @SuppressWarnings("unchecked")
059    private PrincipalNameGrammar()
060    {
061        setName( PrincipalNameGrammar.class.getName() );
062
063        // Create the transitions table
064        super.transitions = new GrammarTransition[PrincipalNameStatesEnum.LAST_PRINCIPAL_NAME_STATE.ordinal()][256];
065
066        // ============================================================================================
067        // PrincipalName
068        // ============================================================================================
069        // --------------------------------------------------------------------------------------------
070        // Transition from PrincipalName init to PrincipalName SEQ
071        // --------------------------------------------------------------------------------------------
072        // PrincipalName   ::= SEQUENCE
073        super.transitions[PrincipalNameStatesEnum.START_STATE.ordinal()][UniversalTag.SEQUENCE.getValue()] =
074            new GrammarTransition<PrincipalNameContainer>(
075                PrincipalNameStatesEnum.START_STATE,
076                PrincipalNameStatesEnum.PRINCIPAL_NAME_SEQ_STATE,
077                UniversalTag.SEQUENCE,
078                new PrincipalNameInit() );
079
080        // --------------------------------------------------------------------------------------------
081        // Transition from PrincipalName SEQ to name-type tag
082        // --------------------------------------------------------------------------------------------
083        // PrincipalName   ::= SEQUENCE {
084        //         name-type       [0] Int32,
085        super.transitions[PrincipalNameStatesEnum.PRINCIPAL_NAME_SEQ_STATE.ordinal()][KerberosConstants.PRINCIPAL_NAME_NAME_TYPE_TAG] =
086            new GrammarTransition<PrincipalNameContainer>(
087                PrincipalNameStatesEnum.PRINCIPAL_NAME_SEQ_STATE,
088                PrincipalNameStatesEnum.PRINCIPAL_NAME_NAME_TYPE_TAG_STATE,
089                KerberosConstants.PRINCIPAL_NAME_NAME_TYPE_TAG,
090                new CheckNotNullLength<PrincipalNameContainer>() );
091
092        // --------------------------------------------------------------------------------------------
093        // Transition from name-type tag to name-type value
094        // --------------------------------------------------------------------------------------------
095        // PrincipalName   ::= SEQUENCE {
096        //         name-type       [0] Int32,
097        super.transitions[PrincipalNameStatesEnum.PRINCIPAL_NAME_NAME_TYPE_TAG_STATE.ordinal()][UniversalTag.INTEGER
098            .getValue()] =
099            new GrammarTransition<PrincipalNameContainer>(
100                PrincipalNameStatesEnum.PRINCIPAL_NAME_NAME_TYPE_TAG_STATE,
101                PrincipalNameStatesEnum.PRINCIPAL_NAME_NAME_TYPE_STATE,
102                UniversalTag.INTEGER,
103                new StoreNameType() );
104
105        // --------------------------------------------------------------------------------------------
106        // Transition from name-type value to name-string tag
107        // --------------------------------------------------------------------------------------------
108        // PrincipalName   ::= SEQUENCE {
109        //         name-type       [0] Int32,
110        //         name-string     [1]
111        super.transitions[PrincipalNameStatesEnum.PRINCIPAL_NAME_NAME_TYPE_STATE.ordinal()][KerberosConstants.PRINCIPAL_NAME_NAME_STRING_TAG] =
112            new GrammarTransition<PrincipalNameContainer>(
113                PrincipalNameStatesEnum.PRINCIPAL_NAME_NAME_TYPE_STATE,
114                PrincipalNameStatesEnum.PRINCIPAL_NAME_NAME_STRING_TAG_STATE,
115                KerberosConstants.PRINCIPAL_NAME_NAME_STRING_TAG,
116                new CheckNotNullLength<PrincipalNameContainer>() );
117
118        // --------------------------------------------------------------------------------------------
119        // Transition from name-string tag to name-string SEQ
120        // --------------------------------------------------------------------------------------------
121        // PrincipalName   ::= SEQUENCE {
122        //         name-type       [0] Int32,
123        //         name-string     [1] SEQUENCE OF
124        super.transitions[PrincipalNameStatesEnum.PRINCIPAL_NAME_NAME_STRING_TAG_STATE.ordinal()][UniversalTag.SEQUENCE
125            .getValue()] =
126            new GrammarTransition<PrincipalNameContainer>(
127                PrincipalNameStatesEnum.PRINCIPAL_NAME_NAME_STRING_TAG_STATE,
128                PrincipalNameStatesEnum.PRINCIPAL_NAME_NAME_STRING_SEQ_STATE,
129                UniversalTag.SEQUENCE,
130                new CheckNotNullLength<PrincipalNameContainer>() );
131
132        // --------------------------------------------------------------------------------------------
133        // Transition from name-string SEQ to name-string value
134        // --------------------------------------------------------------------------------------------
135        // PrincipalName   ::= SEQUENCE {
136        //         name-type       [0] Int32,
137        //         name-string     [1] SEQUENCE OF KerberosString
138        super.transitions[PrincipalNameStatesEnum.PRINCIPAL_NAME_NAME_STRING_SEQ_STATE.ordinal()][UniversalTag.GENERAL_STRING
139            .getValue()] =
140            new GrammarTransition<PrincipalNameContainer>(
141                PrincipalNameStatesEnum.PRINCIPAL_NAME_NAME_STRING_SEQ_STATE,
142                PrincipalNameStatesEnum.PRINCIPAL_NAME_NAME_STRING_SEQ_STATE,
143                UniversalTag.GENERAL_STRING,
144                new StoreNameString() );
145    }
146
147
148    /**
149     * Get the instance of this grammar
150     *
151     * @return An instance on the PrincipalName Grammar
152     */
153    public static Grammar<PrincipalNameContainer> getInstance()
154    {
155        return instance;
156    }
157}