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.normalizers;
021    
022    
023    import java.io.IOException;
024    
025    import org.apache.directory.shared.i18n.I18n;
026    import org.apache.directory.shared.ldap.entry.StringValue;
027    import org.apache.directory.shared.ldap.entry.Value;
028    import org.apache.directory.shared.ldap.exception.LdapException;
029    import org.apache.directory.shared.ldap.exception.LdapInvalidAttributeValueException;
030    import org.apache.directory.shared.ldap.message.ResultCodeEnum;
031    import org.apache.directory.shared.ldap.schema.Normalizer;
032    import org.apache.directory.shared.ldap.schema.PrepareString;
033    
034    
035    /**
036     * Normalizer which trims down whitespace replacing multiple whitespace
037     * characters on the edges and within the string with a single space character
038     * thereby preserving tokenization order.
039     *
040     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
041     * @version $Rev: 928945 $
042     */
043    public class DeepTrimNormalizer extends Normalizer
044    {
045        /** The serial UID */
046        public static final long serialVersionUID = 1L;
047    
048        
049        /**
050         * Creates a new instance of DeepTrimNormalizer with OID known.
051         * 
052         * @param oid The MR OID to use with this Normalizer
053         */
054        public DeepTrimNormalizer( String oid )
055        {
056            super( oid );
057        }
058    
059    
060        /**
061         * Creates a new instance of DeepTrimNormalizer when the Normalizer must be
062         * instantiated before setting the OID.
063         */
064        public DeepTrimNormalizer()
065        {
066        }
067    
068    
069    
070       /**
071        * {@inheritDoc}
072        */
073       public Value<?> normalize( Value<?> value ) throws LdapException
074       {
075           try
076           {
077               String normalized = PrepareString.normalize( value.getString(), 
078                   PrepareString.StringType.DIRECTORY_STRING ); 
079               
080               return new StringValue( normalized ); 
081           }
082           catch ( IOException ioe )
083           {
084               throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err( I18n.ERR_04224, value ) );
085           }
086       }
087    
088    
089       /**
090        * {@inheritDoc}
091        */
092       public String normalize( String value ) throws LdapException
093       {
094           try
095           {
096               String normalized = PrepareString.normalize( value, 
097                   PrepareString.StringType.DIRECTORY_STRING ); 
098               
099               return normalized; 
100           }
101           catch ( IOException ioe )
102           {
103               throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err( I18n.ERR_04224, value ) );
104           }
105       }
106    }