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, eCopyOfUuidSyntaxCheckerither 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.api.ldap.model.schema.syntaxCheckers;
21  
22  
23  import org.apache.directory.api.i18n.I18n;
24  import org.apache.directory.api.ldap.model.constants.SchemaConstants;
25  import org.apache.directory.api.ldap.model.schema.SyntaxChecker;
26  
27  
28  /**
29   * An CSN SID syntax checker.
30   * 
31   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32   */
33  @SuppressWarnings("serial")
34  public final class CsnSidSyntaxChecker extends SyntaxChecker
35  {
36      /**
37       * A static instance of CsnSidSyntaxChecker
38       */
39      public static final CsnSidSyntaxChecker INSTANCE = new CsnSidSyntaxChecker( SchemaConstants.CSN_SID_SYNTAX );
40      
41      /**
42       * A static Builder for this class
43       */
44      public static final class Builder extends SCBuilder<CsnSidSyntaxChecker>
45      {
46          /**
47           * The Builder constructor
48           */
49          private Builder()
50          {
51              super( SchemaConstants.CSN_SID_SYNTAX );
52          }
53          
54          
55          /**
56           * Create a new instance of CsnSidSyntaxChecker
57           * @return A new instance of CsnSidSyntaxChecker
58           */
59          @Override
60          public CsnSidSyntaxChecker build()
61          {
62              return new CsnSidSyntaxChecker( oid );
63          }
64      }
65  
66      
67      /**
68       * Creates a new instance of CsnSyntaxChecker.
69       * 
70       * @param oid The OID to use for this SyntaxChecker
71       */
72      private CsnSidSyntaxChecker( String oid )
73      {
74          super( oid );
75      }
76  
77      
78      /**
79       * @return An instance of the Builder for this class
80       */
81      public static Builder builder()
82      {
83          return new Builder();
84      }
85  
86  
87      /**
88       * {@inheritDoc}
89       */
90      @Override
91      public boolean isValidSyntax( Object value )
92      {
93          if ( value == null )
94          {
95              if ( LOG.isDebugEnabled() )
96              {
97                  LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, "null" ) );
98              }
99              
100             return false;
101         }
102 
103         if ( !( value instanceof String ) )
104         {
105             if ( LOG.isDebugEnabled() )
106             {
107                 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
108             }
109             
110             return false;
111         }
112 
113         String sidStr = ( String ) value;
114 
115         if ( sidStr.length() > 3 )
116         {
117             if ( LOG.isDebugEnabled() )
118             {
119                 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
120             }
121             
122             return false;
123         }
124 
125         // The SID must be an hexadecimal number between 0x00 and 0xFFF
126 
127         try
128         {
129             int sid = Integer.parseInt( sidStr, 16 );
130 
131             if ( ( sid < 0 ) || ( sid > 0x0fff ) )
132             {
133                 if ( LOG.isDebugEnabled() )
134                 {
135                     LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
136                 }
137                 
138                 return false;
139             }
140         }
141         catch ( NumberFormatException nfe )
142         {
143             if ( LOG.isDebugEnabled() )
144             {
145                 LOG.debug( I18n.err( I18n.ERR_04488_SYNTAX_INVALID, value ) );
146             }
147             
148             return false;
149         }
150 
151         if ( LOG.isDebugEnabled() )
152         {
153             LOG.debug( I18n.msg( I18n.MSG_04489_SYNTAX_VALID, value ) );
154         }
155         
156         return true;
157     }
158 }