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  package org.apache.directory.shared.kerberos.codec.padata;
21  
22  
23  import org.apache.directory.api.asn1.actions.CheckNotNullLength;
24  import org.apache.directory.api.asn1.ber.grammar.AbstractGrammar;
25  import org.apache.directory.api.asn1.ber.grammar.Grammar;
26  import org.apache.directory.api.asn1.ber.grammar.GrammarTransition;
27  import org.apache.directory.api.asn1.ber.tlv.UniversalTag;
28  import org.apache.directory.shared.kerberos.KerberosConstants;
29  import org.apache.directory.shared.kerberos.codec.padata.actions.PaDataInit;
30  import org.apache.directory.shared.kerberos.codec.padata.actions.StoreDataType;
31  import org.apache.directory.shared.kerberos.codec.padata.actions.StorePaDataValue;
32  import org.slf4j.Logger;
33  import org.slf4j.LoggerFactory;
34  
35  
36  /**
37   * This class implements the PaData structure. All the actions are declared
38   * in this class. As it is a singleton, these declaration are only done once. If
39   * an action is to be added or modified, this is where the work is to be done !
40   *
41   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
42   */
43  public final class PaDataGrammar extends AbstractGrammar<PaDataContainer>
44  {
45      /** The logger */
46      static final Logger LOG = LoggerFactory.getLogger( PaDataGrammar.class );
47  
48      /** A speedup for logger */
49      static final boolean IS_DEBUG = LOG.isDebugEnabled();
50  
51      /** The instance of grammar. PaDataGrammar is a singleton */
52      private static Grammar<PaDataContainer> instance = new PaDataGrammar();
53  
54  
55      /**
56       * Creates a new PaDataGrammar object.
57       */
58      @SuppressWarnings("unchecked")
59      private PaDataGrammar()
60      {
61          setName( PaDataGrammar.class.getName() );
62  
63          // Create the transitions table
64          super.transitions = new GrammarTransition[PaDataStatesEnum.LAST_PADATA_STATE.ordinal()][256];
65  
66          // ============================================================================================
67          // PaData
68          // ============================================================================================
69          // --------------------------------------------------------------------------------------------
70          // Transition from PaData init to PaData SEQ OF
71          // --------------------------------------------------------------------------------------------
72          // PA-DATA         ::= SEQUENCE {
73          super.transitions[PaDataStatesEnum.START_STATE.ordinal()][UniversalTag.SEQUENCE.getValue()] =
74              new GrammarTransition<PaDataContainer>(
75                  PaDataStatesEnum.START_STATE,
76                  PaDataStatesEnum.PADATA_SEQ_STATE,
77                  UniversalTag.SEQUENCE,
78                  new PaDataInit() );
79  
80          // --------------------------------------------------------------------------------------------
81          // Transition from PaData SEQ to padata-type tag
82          // --------------------------------------------------------------------------------------------
83          // PA-DATA         ::= SEQUENCE {
84          //       padata-type     [1]
85          super.transitions[PaDataStatesEnum.PADATA_SEQ_STATE.ordinal()][KerberosConstants.PADATA_TYPE_TAG] =
86              new GrammarTransition<PaDataContainer>(
87                  PaDataStatesEnum.PADATA_SEQ_STATE,
88                  PaDataStatesEnum.PADATA_TYPE_TAG_STATE,
89                  KerberosConstants.PADATA_TYPE_TAG,
90                  new CheckNotNullLength<PaDataContainer>() );
91  
92          // --------------------------------------------------------------------------------------------
93          // Transition from PaData type tag to padata-type
94          // --------------------------------------------------------------------------------------------
95          // PA-DATA         ::= SEQUENCE {
96          //       padata-type     [1] Int32
97          super.transitions[PaDataStatesEnum.PADATA_TYPE_TAG_STATE.ordinal()][UniversalTag.INTEGER.getValue()] =
98              new GrammarTransition<PaDataContainer>(
99                  PaDataStatesEnum.PADATA_TYPE_TAG_STATE,
100                 PaDataStatesEnum.PADATA_TYPE_STATE,
101                 UniversalTag.INTEGER,
102                 new StoreDataType() );
103 
104         // --------------------------------------------------------------------------------------------
105         // Transition from padata-type to padata-value tag
106         // --------------------------------------------------------------------------------------------
107         // PA-DATA         ::= SEQUENCE {
108         //          padata-value    [2]
109         super.transitions[PaDataStatesEnum.PADATA_TYPE_STATE.ordinal()][KerberosConstants.PADATA_VALUE_TAG] =
110             new GrammarTransition<PaDataContainer>(
111                 PaDataStatesEnum.PADATA_TYPE_STATE,
112                 PaDataStatesEnum.PADATA_VALUE_TAG_STATE,
113                 KerberosConstants.PADATA_VALUE_TAG,
114                 new CheckNotNullLength<PaDataContainer>() );
115 
116         // --------------------------------------------------------------------------------------------
117         // Transition from padata-value tag to padata-value
118         // --------------------------------------------------------------------------------------------
119         // PA-DATA         ::= SEQUENCE {
120         //          padata-value    [2] OCTET STRING
121         super.transitions[PaDataStatesEnum.PADATA_VALUE_TAG_STATE.ordinal()][UniversalTag.OCTET_STRING.getValue()] =
122             new GrammarTransition<PaDataContainer>(
123                 PaDataStatesEnum.PADATA_VALUE_TAG_STATE,
124                 PaDataStatesEnum.PADATA_VALUE_STATE,
125                 UniversalTag.OCTET_STRING,
126                 new StorePaDataValue() );
127     }
128 
129 
130     /**
131      * Get the instance of this grammar
132      *
133      * @return An instance on the PaData Grammar
134      */
135     public static Grammar<PaDataContainer> getInstance()
136     {
137         return instance;
138     }
139 }