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.kdcReq;
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 KDC-REQ 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 KdcReqStatesEnum implements States
034{
035    // Start
036    START_STATE, // 0
037
038    // ----- KDC-REQ component --------------------------------------
039    KDC_REQ_SEQ_STATE, // 1
040
041    KDC_REQ_PVNO_TAG_STATE, // 2
042    KDC_REQ_PVNO_STATE, // 3
043
044    KDC_REQ_MSG_TYPE_TAG_STATE, // 4
045    KDC_REQ_MSG_TYPE_STATE, // 5
046
047    KDC_REQ_PA_DATA_OR_REQ_BODY_STATE, // 6
048
049    KDC_REQ_PA_DATA_TAG_STATE, // 7
050    KDC_REQ_PA_DATA_SEQ_STATE, // 8
051    KDC_REQ_PA_DATA_STATE, // 9
052
053    KDC_REQ_KDC_REQ_BODY_STATE, // 10
054
055    // End
056    LAST_KDC_REQ_STATE; // 11
057
058    /**
059     * Get the grammar name
060     *
061     * @param grammar The grammar code
062     * @return The grammar name
063     */
064    public String getGrammarName( int grammar )
065    {
066        return "KDC_REQ_GRAMMAR";
067    }
068
069
070    /**
071     * Get the grammar name
072     *
073     * @param grammar The grammar class
074     * @return The grammar name
075     */
076    public String getGrammarName( Grammar<KdcReqContainer> grammar )
077    {
078        if ( grammar instanceof KdcReqGrammar )
079        {
080            return "KDC_REQ_GRAMMAR";
081        }
082        else
083        {
084            return "UNKNOWN GRAMMAR";
085        }
086    }
087
088
089    /**
090     * Get the string representing the state
091     *
092     * @param state The state number
093     * @return The String representing the state
094     */
095    public String getState( int state )
096    {
097        return ( ( state == LAST_KDC_REQ_STATE.ordinal() ) ? "KDC_REQ_END_STATE" : name() );
098    }
099
100
101    /**
102     * {@inheritDoc}
103     */
104    public boolean isEndState()
105    {
106        return this == LAST_KDC_REQ_STATE;
107    }
108
109
110    /**
111     * {@inheritDoc}
112     */
113    public KdcReqStatesEnum getStartState()
114    {
115        return START_STATE;
116    }
117}