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.krbSafe;
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 stores the KRB-SAFE 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 KrbSafeStatesEnum implements States
034{
035    // Start
036    START_STATE, // 0
037
038    // ----- KRB-SAFE component --------------------------------------
039    KRB_SAFE_TAG_STATE, // 1
040
041    KRB_SAFE_SEQ_STATE, // 2
042
043    KRB_SAFE_PVNO_TAG_STATE, // 3
044    KRB_SAFE_PVNO_STATE, // 4
045
046    KRB_SAFE_MSGTYPE_TAG_STATE, // 5
047    KRB_SAFE_MSGTYPE_STATE, // 6
048
049    KRB_SAFE_SAFE_BODY_TAG_STATE, // 7
050
051    KRB_SAFE_CKSUM_TAG_STATE, // 8
052
053    // End
054    LAST_KRB_SAFE_STATE; // 9
055
056    /**
057     * Get the grammar name
058     *
059     * @param grammar The grammar code
060     * @return The grammar name
061     */
062    public String getGrammarName( int grammar )
063    {
064        return "KRB_SAFE_GRAMMAR";
065    }
066
067
068    /**
069     * Get the grammar name
070     *
071     * @param grammar The grammar class
072     * @return The grammar name
073     */
074    public String getGrammarName( Grammar<KrbSafeContainer> grammar )
075    {
076        if ( grammar instanceof KrbSafeGrammar )
077        {
078            return "KRB_SAFE_GRAMMAR";
079        }
080        else
081        {
082            return "UNKNOWN GRAMMAR";
083        }
084    }
085
086
087    /**
088     * Get the string representing the state
089     *
090     * @param state The state number
091     * @return The String representing the state
092     */
093    public String getState( int state )
094    {
095        return ( ( state == LAST_KRB_SAFE_STATE.ordinal() ) ? "LAST_KRB_SAFE_STATE" : name() );
096    }
097
098
099    /**
100     * {@inheritDoc}
101     */
102    public boolean isEndState()
103    {
104        return this == LAST_KRB_SAFE_STATE;
105    }
106
107
108    /**
109     * {@inheritDoc}
110     */
111    public KrbSafeStatesEnum getStartState()
112    {
113        return START_STATE;
114    }
115}