/*
    * ====================================================================
    * 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
   *
   *   http://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.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  
  package org.apache.hc.client5.http.impl.cookie;
  
  import java.io.Serializable;
  import java.time.Instant;
  import java.util.Date;
  import java.util.HashMap;
  import java.util.Locale;
  import java.util.Map;
  
  import org.apache.hc.client5.http.cookie.SetCookie;
  import org.apache.hc.client5.http.utils.DateUtils;
  import org.apache.hc.core5.util.Args;
  
  /**
   * Default implementation of {@link SetCookie}.
   *
   * @since 4.0
   */
  public final class BasicClientCookie implements SetCookie, Cloneable, Serializable {
  
      private static final long serialVersionUID = -3869795591041535538L;
  
      /**
       * Default Constructor taking a name and a value. The value may be null.
       *
       * @param name The name.
       * @param value The value.
       */
      public BasicClientCookie(final String name, final String value) {
          super();
          Args.notNull(name, "Name");
          this.name = name;
          this.attribs = new HashMap<>();
          this.value = value;
      }
  
      /**
       * Returns the name.
       *
       * @return String name The name
       */
      @Override
      public String getName() {
          return this.name;
      }
  
      /**
       * Returns the value.
       *
       * @return String value The current value.
       */
      @Override
      public String getValue() {
          return this.value;
      }
  
      /**
       * Sets the value
       *
       * @param value
       */
      @Override
      public void setValue(final String value) {
          this.value = value;
      }
  
      /**
       * Returns the expiration {@link Date} of the cookie, or {@code null}
       * if none exists.
       * <p><strong>Note:</strong> the object returned by this method is
       * considered immutable. Changing it (e.g. using setTime()) could result
       * in undefined behaviour. Do so at your peril. </p>
      * @return Expiration {@link Date}, or {@code null}.
      *
      * @see #setExpiryDate(java.util.Date)
      *
      * @deprecated Use {@link #getExpiryInstant()}
      */
     @Deprecated
     @Override
     public Date getExpiryDate() {
         return DateUtils.toDate(cookieExpiryDate);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public Instant getExpiryInstant() {
         return cookieExpiryDate;
     }
 
     /**
      * Sets expiration date.
      * <p><strong>Note:</strong> the object returned by this method is considered
      * immutable. Changing it (e.g. using setTime()) could result in undefined
      * behaviour. Do so at your peril.</p>
      *
      * @param expiryDate the {@link Date} after which this cookie is no longer valid.
      *
      * @deprecated Use {{@link #setExpiryDate(Instant)}}
      *
      */
     @Deprecated
     @Override
     public void setExpiryDate (final Date expiryDate) {
         cookieExpiryDate = DateUtils.toInstant(expiryDate);
     }
 
     /**
      * Sets expiration date.
      * <p><strong>Note:</strong> the object returned by this method is considered
      * immutable. Changing it (e.g. using setTime()) could result in undefined behaviour. Do so at
      * your peril.</p>
      *
      * @param expiryInstant the {@link Instant} after which this cookie is no longer valid.
      * @see #getExpiryInstant()
      * @since 5.2
      */
     @Override
     public void setExpiryDate (final Instant expiryInstant) {
         cookieExpiryDate = expiryInstant;
     }
 
 
     /**
      * Returns {@code false} if the cookie should be discarded at the end
      * of the "session"; {@code true} otherwise.
      *
      * @return {@code false} if the cookie should be discarded at the end
      *         of the "session"; {@code true} otherwise
      */
     @Override
     public boolean isPersistent() {
         return null != cookieExpiryDate;
     }
 
 
     /**
      * Returns domain attribute of the cookie.
      *
      * @return the value of the domain attribute
      *
      * @see #setDomain(java.lang.String)
      */
     @Override
     public String getDomain() {
         return cookieDomain;
     }
 
     /**
      * Sets the domain attribute.
      *
      * @param domain The value of the domain attribute
      *
      * @see #getDomain
      */
     @Override
     public void setDomain(final String domain) {
         if (domain != null) {
             cookieDomain = domain.toLowerCase(Locale.ROOT);
         } else {
             cookieDomain = null;
         }
     }
 
 
     /**
      * Returns the path attribute of the cookie
      *
      * @return The value of the path attribute.
      *
      * @see #setPath(java.lang.String)
      */
     @Override
     public String getPath() {
         return cookiePath;
     }
 
     /**
      * Sets the path attribute.
      *
      * @param path The value of the path attribute
      *
      * @see #getPath
      *
      */
     @Override
     public void setPath(final String path) {
         cookiePath = path;
     }
 
     /**
      * @return {@code true} if this cookie should only be sent over secure connections.
      * @see #setSecure(boolean)
      */
     @Override
     public boolean isSecure() {
         return isSecure;
     }
 
     /**
      * Sets the secure attribute of the cookie.
      * <p>
      * When {@code true} the cookie should only be sent
      * using a secure protocol (https).  This should only be set when
      * the cookie's originating server used a secure protocol to set the
      * cookie's value.
      *
      * @param secure The value of the secure attribute
      *
      * @see #isSecure()
      */
     @Override
     public void setSecure (final boolean secure) {
         isSecure = secure;
     }
 
     /**
      * Sets the http-only attribute of the cookie.
      *
      * @param httpOnly true if this cookie is to be marked as
      * {@code httpOnly}, false otherwise
      *
      * @since 5.2
      */
     @Override
     public void setHttpOnly(final boolean httpOnly) {
         this.httpOnly = httpOnly;
     }
 
     /**
      * Returns true if this cookie has expired.
      * @param date Current time
      *
      * @return {@code true} if the cookie has expired.
      *
      * @deprecated Use {@link #isExpired(Instant)}
      */
     @Deprecated
     @Override
     public boolean isExpired(final Date date) {
         Args.notNull(date, "Date");
         return cookieExpiryDate != null
                 && cookieExpiryDate.compareTo(DateUtils.toInstant(date)) <= 0;
     }
 
     /**
      * Returns true if this cookie has expired.
      * @param instant Current time
      *
      * @return {@code true} if the cookie has expired.
      */
     @Override
     public boolean isExpired(final Instant instant) {
         Args.notNull(instant, "Instant");
         return cookieExpiryDate != null
                 && cookieExpiryDate.compareTo(instant) <= 0;
     }
 
     /**
      * @since 4.4
      *
      * @deprecated Use {@link #getCreationInstant()}.
      */
     @Deprecated
     @Override
     public Date getCreationDate() {
         return DateUtils.toDate(creationDate);
     }
 
     /**
      * @since 5.2
      */
     @Override
     public Instant getCreationInstant() {
         return creationDate;
     }
 
     /**
      * @return true if this Cookie has been marked as {@code httpOnly}, false otherwise
      * @see #setHttpOnly(boolean)
      * @since 5.2
      */
     @Override
     public boolean isHttpOnly() {
         return httpOnly;
     }
 
     /**
      * @since 4.4
      * @deprecated Use {@link #setCreationDate(Instant)}
      */
     @Deprecated
     public void setCreationDate(final Date creationDate) {
         this.creationDate = DateUtils.toInstant(creationDate);
     }
 
     /**
      * @since 5.2
      */
     public void setCreationDate(final Instant creationDate) {
         this.creationDate = creationDate;
     }
 
     public void setAttribute(final String name, final String value) {
         this.attribs.put(name, value);
     }
 
     @Override
     public String getAttribute(final String name) {
         return this.attribs.get(name);
     }
 
     @Override
     public boolean containsAttribute(final String name) {
         return this.attribs.containsKey(name);
     }
 
     /**
      * @since 4.4
      */
     public boolean removeAttribute(final String name) {
         return this.attribs.remove(name) != null;
     }
 
     @Override
     public Object clone() throws CloneNotSupportedException {
         final BasicClientCookie clone = (BasicClientCookie) super.clone();
         clone.attribs = new HashMap<>(this.attribs);
         return clone;
     }
 
     @Override
     public String toString() {
         final StringBuilder buffer = new StringBuilder();
         buffer.append("[name: ");
         buffer.append(this.name);
         buffer.append("; ");
         buffer.append("value: ");
         buffer.append(this.value);
         buffer.append("; ");
         buffer.append("domain: ");
         buffer.append(this.cookieDomain);
         buffer.append("; ");
         buffer.append("path: ");
         buffer.append(this.cookiePath);
         buffer.append("; ");
         buffer.append("expiry: ");
         buffer.append(this.cookieExpiryDate);
         buffer.append("]");
         return buffer.toString();
     }
 
    // ----------------------------------------------------- Instance Variables
 
     /** Cookie name */
     private final String name;
 
     /** Cookie attributes as specified by the origin server */
     private Map<String, String> attribs;
 
     /** Cookie value */
     private String value;
 
     /** Domain attribute. */
     private String cookieDomain;
 
     /** Expiration {@link Instant}. */
     private Instant cookieExpiryDate;
 
     /** Path attribute. */
     private String cookiePath;
 
     /** My secure flag. */
     private boolean isSecure;
 
     private Instant creationDate;
 
     /** The {@code httpOnly} flag. */
     private boolean httpOnly;
 
 }