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   *    https://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.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  import org.apache.directory.api.util.Strings;
27  
28  
29  /**
30   * A SyntaxChecker which verifies that a value is a Boolean according to RFC 4517.
31   * 
32   * From RFC 4517 :
33   * 
34   * <pre>
35   * Boolean = "TRUE" / "FALSE"
36   * </pre>
37   *
38   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
39   */
40  @SuppressWarnings("serial")
41  public final class BooleanSyntaxChecker extends SyntaxChecker
42  {
43      /**
44       * A static instance of BooleanSyntaxChecker
45       */
46      public static final BooleanSyntaxChecker INSTANCE = new BooleanSyntaxChecker( SchemaConstants.BOOLEAN_SYNTAX );
47      
48      /**
49       * A static Builder for this class
50       */
51      public static final class Builder extends SCBuilder<BooleanSyntaxChecker>
52      {
53          /**
54           * The Builder constructor
55           */
56          private Builder()
57          {
58              super( SchemaConstants.BOOLEAN_SYNTAX );
59          }
60          
61          
62          /**
63           * Create a new instance of BooleanSyntaxChecker
64           * @return A new instance of BooleanSyntaxChecker
65           */
66          @Override
67          public BooleanSyntaxChecker build()
68          {
69              return new BooleanSyntaxChecker( oid );
70          }
71      }
72  
73      
74      /**
75       * Creates a new instance of BooleanSyntaxChecker.
76       * 
77       * @param oid The OID to use for this SyntaxChecker
78       */
79      private BooleanSyntaxChecker( String oid )
80      {
81          super( oid );
82      }
83  
84      
85      /**
86       * @return An instance of the Builder for this class
87       */
88      public static Builder builder()
89      {
90          return new Builder();
91      }
92  
93  
94      /**
95       * {@inheritDoc}
96       */
97      @Override
98      public boolean isValidSyntax( Object value )
99      {
100         String strValue;
101 
102         if ( value == null )
103         {
104             if ( LOG.isDebugEnabled() )
105             {
106                 LOG.debug( I18n.err( I18n.ERR_13210_SYNTAX_INVALID, "null" ) );
107             }
108             
109             return false;
110         }
111 
112         if ( value instanceof String )
113         {
114             strValue = ( String ) value;
115         }
116         else if ( value instanceof byte[] )
117         {
118             strValue = Strings.utf8ToString( ( byte[] ) value );
119         }
120         else
121         {
122             strValue = value.toString();
123         }
124 
125         if ( strValue.length() == 0 )
126         {
127             if ( LOG.isDebugEnabled() )
128             {
129                 LOG.debug( I18n.err( I18n.ERR_13210_SYNTAX_INVALID, strValue ) );
130             }
131             
132             return false;
133         }
134 
135         boolean valid = "TRUE".equalsIgnoreCase( strValue ) || "FALSE".equalsIgnoreCase( strValue );
136 
137         if ( LOG.isDebugEnabled() )
138         {
139             if ( valid )
140             {
141                 LOG.debug( I18n.msg( I18n.MSG_13701_SYNTAX_VALID, strValue ) );
142             }
143             else
144             {
145                 LOG.debug( I18n.err( I18n.ERR_13210_SYNTAX_INVALID, strValue ) );
146             }
147         }
148 
149         return valid;
150     }
151 }