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 */
020
021package org.apache.directory.api.ldap.extras.controls.ppolicy_impl;
022
023
024import org.apache.directory.api.asn1.ber.grammar.States;
025
026
027/**
028 * various states used in {@link PasswordPolicyGrammar}.
029 *
030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031 */
032public enum PasswordPolicyStates implements States
033{
034    /** Initial state */
035    START_STATE,
036    
037    /** PasswordPolicyResponseValue ::= SEQUENCE  transition */
038    PPOLICY_SEQ_STATE,
039    
040    /** warning [0] CHOICE transition */
041    PPOLICY_WARNING_TAG_STATE,
042    
043    /** timeBeforeExpiration [0] INTEGER (0 .. maxInt) transition */
044    PPOLICY_TIME_BEFORE_EXPIRATION_STATE,
045    
046    /** graceAuthNsRemaining [1] INTEGER (0 .. maxInt) } OPTIONAL transition */
047    PPOLICY_GRACE_AUTHNS_REMAINING_STATE,
048    
049    /** error   [1] ENUMERATED transition */
050    PPOLICY_ERROR_TAG_STATE,
051
052    /** end state */
053    END_STATE;
054
055
056    /**
057     * Get the grammar name
058     * 
059     * @return The grammar name
060     */
061    public String getGrammarName()
062    {
063        return "PASSWORD_POLICY_RESPONSE_CONTROL_GRAMMAR";
064    }
065
066
067    /**
068     * Get the string representing the state
069     * 
070     * @param state The state number
071     * @return The String representing the state
072     */
073    public String getState( int state )
074    {
075        return ( state == END_STATE.ordinal() ) ? "PASSWORD_POLICY_RESPONSE_CONTROL_GRAMMAR" : name();
076    }
077
078
079    /**
080     * {@inheritDoc}
081     */
082    @Override
083    public boolean isEndState()
084    {
085        return this == END_STATE;
086    }
087
088
089    /**
090     * {@inheritDoc}
091     */
092    @Override
093    public PasswordPolicyStates getStartState()
094    {
095        return START_STATE;
096    }
097}