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.api.ldap.model.schema.syntaxCheckers;
21  
22  
23  import java.text.ParseException;
24  
25  import org.apache.directory.api.ldap.model.constants.SchemaConstants;
26  import org.apache.directory.api.ldap.model.schema.SyntaxChecker;
27  import org.apache.directory.api.ldap.model.schema.parsers.LdapSyntaxDescriptionSchemaParser;
28  import org.apache.directory.api.util.Strings;
29  import org.slf4j.Logger;
30  import org.slf4j.LoggerFactory;
31  
32  
33  /**
34   * A SyntaxChecker which verifies that a value follows the
35   * LDAP syntax descripton syntax according to RFC 4512, par 4.2.2:
36   * 
37   * <pre>
38   * SyntaxDescription = LPAREN WSP
39   *    numericoid                 ; object identifier
40   *    [ SP "DESC" SP qdstring ]  ; description
41   *    extensions WSP RPAREN      ; extensions
42   * </pre>
43   * 
44   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
45   */
46  @SuppressWarnings("serial")
47  public class LdapSyntaxDescriptionSyntaxChecker extends SyntaxChecker
48  {
49      /** A logger for this class */
50      private static final Logger LOG = LoggerFactory.getLogger( LdapSyntaxDescriptionSyntaxChecker.class );
51  
52      /** The schema parser used to parse the LdapSyntax description Syntax */
53      private LdapSyntaxDescriptionSchemaParser schemaParser = new LdapSyntaxDescriptionSchemaParser();
54  
55  
56      /**
57       * 
58       * Creates a new instance of LdapSyntaxDescriptionSyntaxChecker.
59       *
60       */
61      public LdapSyntaxDescriptionSyntaxChecker()
62      {
63          super( SchemaConstants.LDAP_SYNTAX_DESCRIPTION_SYNTAX );
64      }
65  
66  
67      /**
68       * {@inheritDoc}
69       */
70      public boolean isValidSyntax( Object value )
71      {
72          String strValue = null;
73  
74          if ( value == null )
75          {
76              LOG.debug( "Syntax invalid for 'null'" );
77              return false;
78          }
79  
80          if ( value instanceof String )
81          {
82              strValue = ( String ) value;
83          }
84          else if ( value instanceof byte[] )
85          {
86              strValue = Strings.utf8ToString( ( byte[] ) value );
87          }
88          else
89          {
90              strValue = value.toString();
91          }
92  
93          try
94          {
95              schemaParser.parseLdapSyntaxDescription( strValue );
96              LOG.debug( "Syntax valid for '{}'", value );
97  
98              return true;
99          }
100         catch ( ParseException pe )
101         {
102             LOG.debug( "Syntax invalid for '{}'", value );
103             return false;
104         }
105     }
106 }