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 */ 020package org.apache.directory.api.ldap.model.schema.normalizers; 021 022 023import java.io.IOException; 024 025import org.apache.directory.api.i18n.I18n; 026import org.apache.directory.api.ldap.model.exception.LdapException; 027import org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException; 028import org.apache.directory.api.ldap.model.message.ResultCodeEnum; 029import org.apache.directory.api.ldap.model.schema.Normalizer; 030import org.apache.directory.api.ldap.model.schema.PrepareString; 031import org.apache.directory.api.ldap.model.schema.PreparedNormalizer; 032 033 034/** 035 * Normalizer which trims down whitespace replacing multiple whitespace 036 * characters on the edges and within the string with a single space character 037 * thereby preserving tokenization order - while doing all this in the same pass 038 * it lower cases all characters. 039 * 040 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 041 */ 042@SuppressWarnings("serial") 043public class DeepTrimToLowerNormalizer extends Normalizer implements PreparedNormalizer 044{ 045 /** 046 * Creates a new instance of DeepTrimToLowerNormalizer. 047 * 048 * @param oid The MR OID to use with this Normalizer 049 */ 050 public DeepTrimToLowerNormalizer( String oid ) 051 { 052 super( oid ); 053 } 054 055 056 /** 057 * Creates a new instance of DeepTrimToLowerNormalizer where the OID is 058 * set after instantiation. 059 */ 060 public DeepTrimToLowerNormalizer() 061 { 062 super(); 063 } 064 065 066 /** 067 * {@inheritDoc} 068 */ 069 @Override 070 public String normalize( String value ) throws LdapException 071 { 072 return normalize( value, PrepareString.AssertionType.ATTRIBUTE_VALUE ); 073 } 074 075 076 /** 077 * {@inheritDoc} 078 */ 079 @Override 080 public String normalize( String value, PrepareString.AssertionType assertionType ) throws LdapException 081 { 082 if ( value == null ) 083 { 084 return null; 085 } 086 087 String normValue = null; 088 089 try 090 { 091 // Transcoding is useless 092 // Map 093 String mapped = PrepareString.mapIgnoreCase( value ); 094 095 // Normalize 096 String normalized = PrepareString.normalize( mapped ); 097 098 char[] chars = normalized.toCharArray(); 099 100 // Prohibit 101 PrepareString.checkProhibited( chars ); 102 103 // Bidi is ignored 104 105 // Insignificant Characters Handling 106 switch ( assertionType ) 107 { 108 case ATTRIBUTE_VALUE : 109 normValue = PrepareString.insignificantSpacesStringValue( chars ); 110 break; 111 112 case SUBSTRING_INITIAL : 113 normValue = PrepareString.insignificantSpacesStringInitial( chars ); 114 break; 115 116 case SUBSTRING_ANY : 117 normValue = PrepareString.insignificantSpacesStringAny( chars ); 118 break; 119 120 case SUBSTRING_FINAL : 121 normValue = PrepareString.insignificantSpacesStringFinal( chars ); 122 break; 123 124 default : 125 // Do nothing 126 break; 127 } 128 129 return normValue; 130 } 131 catch ( IOException ioe ) 132 { 133 throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err( 134 I18n.ERR_13724_INVALID_VALUE, value ), ioe ); 135 } 136 } 137}