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;
024import java.text.ParseException;
025
026import org.apache.directory.api.i18n.I18n;
027import org.apache.directory.api.ldap.model.constants.SchemaConstants;
028import org.apache.directory.api.ldap.model.entry.StringValue;
029import org.apache.directory.api.ldap.model.entry.Value;
030import org.apache.directory.api.ldap.model.exception.LdapException;
031import org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException;
032import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
033import org.apache.directory.api.ldap.model.schema.Normalizer;
034import org.apache.directory.api.ldap.model.schema.PrepareString;
035import org.apache.directory.api.util.GeneralizedTime;
036import org.apache.directory.api.util.GeneralizedTime.Format;
037import org.apache.directory.api.util.GeneralizedTime.FractionDelimiter;
038import org.apache.directory.api.util.GeneralizedTime.TimeZoneFormat;
039
040
041/**
042 * Normalizer which normalize a time following those rules :
043 * <ul>
044 * <li>if minutes are ommited, then they are replaced by 00</li>
045 * <li>if seconds are ommited, then they are replaced by 00</li>
046 * <li>if fraction is 0 or omitted, it is replaced by 000</li>
047 * <li>the time is supposed to be expressed in Zulu (GMT), so 
048 * increment is applied to hours/days/yeah, and a Z is added at the end</li>
049 * </ul>
050 *
051 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
052 */
053@SuppressWarnings("serial")
054public class GeneralizedTimeNormalizer extends Normalizer
055{
056    /**
057     * Creates a new instance of GeneralizedTimeNormalizer.
058     */
059    public GeneralizedTimeNormalizer()
060    {
061        super( SchemaConstants.GENERALIZED_TIME_MATCH_MR_OID );
062    }
063
064
065    /**
066     * {@inheritDoc}
067     */
068    @Override
069    public Value<?> normalize( Value<?> value ) throws LdapException
070    {
071        try
072        {
073            String normalized = PrepareString.normalize( value.getString(), PrepareString.StringType.DIRECTORY_STRING );
074
075            return new StringValue( normalized );
076        }
077        catch ( IOException ioe )
078        {
079            throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err(
080                I18n.ERR_04224, value ), ioe );
081        }
082    }
083
084
085    /**
086     * {@inheritDoc}
087     */
088    @Override
089    public String normalize( String value ) throws LdapException
090    {
091        try
092        {
093            String prepared = PrepareString.normalize( value, PrepareString.StringType.DIRECTORY_STRING );
094
095            GeneralizedTime time = new GeneralizedTime( prepared );
096
097            return time.toGeneralizedTime( Format.YEAR_MONTH_DAY_HOUR_MIN_SEC_FRACTION,
098                FractionDelimiter.DOT, 3, TimeZoneFormat.Z );
099        }
100        catch ( IOException ioe )
101        {
102            throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err(
103                I18n.ERR_04224, value ), ioe );
104        }
105        catch ( ParseException pe )
106        {
107            throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err(
108                I18n.ERR_04224, value ), pe );
109        }
110    }
111}