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.ber.grammar.Grammar;
024import org.apache.directory.api.asn1.ber.grammar.States;
025
026
027/**
028 * This class store the PrincipalName grammar's constants. It is also used for debugging
029 * purpose
030 *
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public enum PrincipalNameStatesEnum implements States
034{
035    // Start
036    START_STATE, // 0
037
038    // ----- PrincipalName message --------------------------------------
039    PRINCIPAL_NAME_SEQ_STATE, // 1
040
041    PRINCIPAL_NAME_NAME_TYPE_TAG_STATE, // 2
042    PRINCIPAL_NAME_NAME_TYPE_STATE, // 3
043
044    PRINCIPAL_NAME_NAME_STRING_SEQ_STATE, // 4
045
046    PRINCIPAL_NAME_NAME_STRING_TAG_STATE, // 5
047    PRINCIPAL_NAME_NAME_STRING_STATE, // 6
048
049    // End
050    LAST_PRINCIPAL_NAME_STATE; // 7
051
052    /**
053     * Get the grammar name
054     *
055     * @param grammar The grammar code
056     * @return The grammar name
057     */
058    public String getGrammarName( int grammar )
059    {
060        return "PRINCIPAL_NAME_GRAMMAR";
061    }
062
063
064    /**
065     * Get the grammar name
066     *
067     * @param grammar The grammar class
068     * @return The grammar name
069     */
070    public String getGrammarName( Grammar<PrincipalNameContainer> grammar )
071    {
072        if ( grammar instanceof PrincipalNameGrammar )
073        {
074            return "PRINCIPAL_NAME_GRAMMAR";
075        }
076        else
077        {
078            return "UNKNOWN GRAMMAR";
079        }
080    }
081
082
083    /**
084     * Get the string representing the state
085     *
086     * @param state The state number
087     * @return The String representing the state
088     */
089    public String getState( int state )
090    {
091        return ( ( state == LAST_PRINCIPAL_NAME_STATE.ordinal() ) ? "PRINCIPAL_NAME_END_STATE" : name() );
092    }
093
094
095    /**
096     * {@inheritDoc}
097     */
098    public boolean isEndState()
099    {
100        return this == LAST_PRINCIPAL_NAME_STATE;
101    }
102
103
104    /**
105     * {@inheritDoc}
106     */
107    public PrincipalNameStatesEnum getStartState()
108    {
109        return START_STATE;
110    }
111}