001 /* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020 package org.apache.directory.shared.ldap.schema.syntaxCheckers; 021 022 023 import org.apache.directory.shared.ldap.constants.SchemaConstants; 024 import org.apache.directory.shared.ldap.schema.SyntaxChecker; 025 import org.apache.directory.shared.ldap.util.StringTools; 026 import org.slf4j.Logger; 027 import org.slf4j.LoggerFactory; 028 029 030 /** 031 * A SyntaxChecker which verifies that a value is a Directory String according to RFC 4517. 032 * 033 * From RFC 4517 : 034 * DirectoryString = 1*UTF8 035 * 036 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 037 * @version $Rev: 437007 $ 038 */ 039 public class DirectoryStringSyntaxChecker extends SyntaxChecker 040 { 041 /** A logger for this class */ 042 private static final Logger LOG = LoggerFactory.getLogger( DirectoryStringSyntaxChecker.class ); 043 044 /** The serialVersionUID */ 045 private static final long serialVersionUID = 1L; 046 047 /** 048 * Creates a new instance of DirectoryStringSyntaxChecker. 049 */ 050 public DirectoryStringSyntaxChecker() 051 { 052 super( SchemaConstants.DIRECTORY_STRING_SYNTAX ); 053 } 054 055 056 /** 057 * {@inheritDoc} 058 */ 059 public boolean isValidSyntax( Object value ) 060 { 061 String strValue = null; 062 063 if ( value == null ) 064 { 065 LOG.debug( "Syntax invalid for '{}'", value ); 066 return false; 067 } 068 069 if ( value instanceof String ) 070 { 071 strValue = ( String ) value; 072 } 073 else if ( value instanceof byte[] ) 074 { 075 strValue = StringTools.utf8ToString( ( byte[] ) value ); 076 } 077 else 078 { 079 strValue = value.toString(); 080 } 081 082 // If the value was an invalid UTF8 string, then it's length 083 // will be 0 as the StringTools.utf8ToString() call will 084 // return an empty string 085 if ( strValue.length() == 0 ) 086 { 087 LOG.debug( "Syntax invalid for '{}'", value ); 088 return false; 089 } 090 091 // In any other case, we have to check that the 092 // string does not contains the '0xFFFD' character 093 for ( char c:strValue.toCharArray() ) 094 { 095 if ( c == 0xFFFD ) 096 { 097 LOG.debug( "Syntax invalid for '{}'", value ); 098 return false; 099 } 100 } 101 102 LOG.debug( "Syntax valid for '{}'", value ); 103 return true; 104 } 105 }