/*
    *  Licensed to the Apache Software Foundation (ASF) under one
    *  or more contributor license agreements.  See the NOTICE file
    *  distributed with this work for additional information
    *  regarding copyright ownership.  The ASF licenses this file
    *  to you under the Apache License, Version 2.0 (the
    *  "License"); you may not use this file except in compliance
    *  with the License.  You may obtain a copy of the License at
    *
   *    https://www.apache.org/licenses/LICENSE-2.0
   *
   *  Unless required by applicable law or agreed to in writing,
   *  software distributed under the License is distributed on an
   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   *  KIND, either express or implied.  See the License for the
   *  specific language governing permissions and limitations
   *  under the License.
   *
   */
  package org.apache.directory.api.ldap.model.schema.normalizers;
  
  
  import java.text.ParseException;
  
  import org.apache.directory.api.i18n.I18n;
  import org.apache.directory.api.ldap.model.constants.SchemaConstants;
  import org.apache.directory.api.ldap.model.exception.LdapException;
  import org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException;
  import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
  import org.apache.directory.api.ldap.model.schema.Normalizer;
  import org.apache.directory.api.ldap.model.schema.PrepareString;
  import org.apache.directory.api.util.GeneralizedTime;
  import org.apache.directory.api.util.GeneralizedTime.Format;
  import org.apache.directory.api.util.GeneralizedTime.FractionDelimiter;
  import org.apache.directory.api.util.GeneralizedTime.TimeZoneFormat;
  
  
  /**
   * Normalizer which normalize a time following those rules :
   * <ul>
   * <li>if minutes are ommited, then they are replaced by 00</li>
   * <li>if seconds are ommited, then they are replaced by 00</li>
   * <li>if fraction is 0 or omitted, it is replaced by 000</li>
   * <li>the time is supposed to be expressed in Zulu (GMT), so 
   * increment is applied to hours/days/yeah, and a Z is added at the end</li>
   * </ul>
   * 
   * Note : there is no Substring for this type of values.
   *
   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
   */
  @SuppressWarnings("serial")
  public class GeneralizedTimeNormalizer extends Normalizer
  {
      /**
       * Creates a new instance of GeneralizedTimeNormalizer.
       */
      public GeneralizedTimeNormalizer()
      {
          super( SchemaConstants.GENERALIZED_TIME_MATCH_MR_OID );
      }
  
  
      /**
       * {@inheritDoc}
       */
      @Override
      public String normalize( String value ) throws LdapException
      {
          return normalize( value, PrepareString.AssertionType.ATTRIBUTE_VALUE );
      }
  
  
      /**
       * {@inheritDoc}
       */
      @Override
      public String normalize( String value, PrepareString.AssertionType assertionType ) throws LdapException
      {
          if ( value == null )
          {
              throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err(
                  I18n.ERR_13724_INVALID_VALUE, value ) );
          }
          
          // Special case : the PPolicy "0000010000Z", for permanently locked accounts
          if ( "000001010000Z".equals( value ) )
          {
              return value;
          }
          
          try
          {
              GeneralizedTime time = new GeneralizedTime( value );
              return time.toGeneralizedTime( Format.YEAR_MONTH_DAY_HOUR_MIN_SEC_FRACTION,
                  FractionDelimiter.DOT, 3, TimeZoneFormat.Z );
          }
          catch ( ParseException pe )
          {
             throw new LdapInvalidAttributeValueException( ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX, I18n.err(
                 I18n.ERR_13724_INVALID_VALUE, value ), pe );
         }
     }
 }