View Javadoc
1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.hc.core5.http.protocol;
29  
30  import java.text.DateFormat;
31  import java.text.SimpleDateFormat;
32  import java.util.Date;
33  import java.util.Locale;
34  import java.util.TimeZone;
35  
36  import org.apache.hc.core5.annotation.Contract;
37  import org.apache.hc.core5.annotation.ThreadingBehavior;
38  
39  /**
40   * Generates a date in the format required by the HTTP protocol.
41   *
42   * @since 4.0
43   */
44  @Contract(threading = ThreadingBehavior.SAFE)
45  public class HttpDateGenerator {
46  
47      private static final int GRANULARITY_MILLIS = 1000;
48  
49      /** Date format pattern used to generate the header in RFC 1123 format. */
50      public static final String PATTERN_RFC1123 = "EEE, dd MMM yyyy HH:mm:ss zzz";
51  
52      /** The time zone to use in the date header. */
53      public static final TimeZone GMT = TimeZone.getTimeZone("GMT");
54  
55      /** Singleton instance. */
56      public static final HttpDateGeneratorttpDateGenerator.html#HttpDateGenerator">HttpDateGenerator INSTANCE = new HttpDateGenerator(PATTERN_RFC1123, Locale.US, GMT);
57  
58      private final DateFormat dateformat;
59      private long dateAsMillis;
60      private String dateAsText;
61  
62      HttpDateGenerator() {
63          super();
64          this.dateformat = new SimpleDateFormat(PATTERN_RFC1123, Locale.US);
65          this.dateformat.setTimeZone(GMT);
66      }
67  
68      private HttpDateGenerator(final String pattern, final Locale locale, final TimeZone timeZone) {
69          this.dateformat = new SimpleDateFormat(pattern, locale);
70          this.dateformat.setTimeZone(timeZone);
71      }
72  
73      public synchronized String getCurrentDate() {
74          final long now = System.currentTimeMillis();
75          if (now - this.dateAsMillis > GRANULARITY_MILLIS) {
76              // Generate new date string
77              this.dateAsText = this.dateformat.format(new Date(now));
78              this.dateAsMillis = now;
79          }
80          return this.dateAsText;
81      }
82  
83  }