View Javadoc
1   /*
2    *   Licensed to the Apache Software Foundation (ASF) under one
3    *   or more contributor license agreements.  See the NOTICE file
4    *   distributed with this work for additional information
5    *   regarding copyright ownership.  The ASF licenses this file
6    *   to you under the Apache License, Version 2.0 (the
7    *   "License"); you may not use this file except in compliance
8    *   with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *   Unless required by applicable law or agreed to in writing,
13   *   software distributed under the License is distributed on an
14   *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *   KIND, either express or implied.  See the License for the
16   *   specific language governing permissions and limitations
17   *   under the License.
18   *
19   */
20  
21  package org.apache.directory.api.ldap.extras.controls.ppolicy_impl;
22  
23  
24  import org.apache.directory.api.asn1.ber.grammar.States;
25  
26  
27  /**
28   * various states used in {@link PasswordPolicyGrammar}.
29   *
30   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31   */
32  public enum PasswordPolicyStates implements States
33  {
34      /** Initial state */
35      START_STATE,
36      
37      /** PasswordPolicyResponseValue ::= SEQUENCE  transition */
38      PPOLICY_SEQ_STATE,
39      
40      /** warning [0] CHOICE transition */
41      PPOLICY_WARNING_TAG_STATE,
42      
43      /** timeBeforeExpiration [0] INTEGER (0 .. maxInt) transition */
44      PPOLICY_TIME_BEFORE_EXPIRATION_STATE,
45      
46      /** graceAuthNsRemaining [1] INTEGER (0 .. maxInt) } OPTIONAL transition */
47      PPOLICY_GRACE_AUTHNS_REMAINING_STATE,
48      
49      /** error   [1] ENUMERATED transition */
50      PPOLICY_ERROR_TAG_STATE,
51  
52      /** end state */
53      END_STATE;
54  
55  
56      /**
57       * Get the grammar name
58       * 
59       * @return The grammar name
60       */
61      public String getGrammarName()
62      {
63          return "PASSWORD_POLICY_RESPONSE_CONTROL_GRAMMAR";
64      }
65  
66  
67      /**
68       * Get the string representing the state
69       * 
70       * @param state The state number
71       * @return The String representing the state
72       */
73      public String getState( int state )
74      {
75          return ( state == END_STATE.ordinal() ) ? "PASSWORD_POLICY_RESPONSE_CONTROL_GRAMMAR" : name();
76      }
77  
78  
79      /**
80       * {@inheritDoc}
81       */
82      @Override
83      public boolean isEndState()
84      {
85          return this == END_STATE;
86      }
87  
88  
89      /**
90       * {@inheritDoc}
91       */
92      @Override
93      public PasswordPolicyStates getStartState()
94      {
95          return START_STATE;
96      }
97  }