com.ibm.wsspi.http

Interface HttpDateFormat



  • public interface HttpDateFormat
    Class to handle formatting and parsing of dates in the various allowed HTTP formats.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.String getASCIITime()
      Get the current time formatted for standard ASCII.
      java.lang.String getASCIITime(java.util.Date inDate)
      Get an ASCII complaint date string based on the given Date object.
      java.lang.String getASCIITime(long range)
      Get the current time formatted for standard ASCII, this will use a cached format value if that value is within the input range of the current time.
      byte[] getASCIITimeAsBytes()
      Get the current time formatted for standard ASCII.
      byte[] getASCIITimeAsBytes(long range)
      Get the current time formatted for standard ASCII, this will use a cached format value if that value is within the input range of the current time.
      java.lang.String getNCSATime()
      Get the current time formatted for NCSA.
      java.lang.String getNCSATime(java.util.Date inDate)
      Format the given Date object in the NCSA format.
      java.lang.String getNCSATime(long range)
      Get the current time formatted for NCSA, this will use a cached format value if that value is within the input range of the current time.
      byte[] getNCSATimeAsBytes()
      Get the current time formatted for NCSA.
      byte[] getNCSATimeAsBytes(long range)
      Get the current time formatted for NCSA, this will use a cached format value if that value is within the input range of the current time.
      java.lang.String getRFC1036Time()
      Get the current time formatted for RFC 1036.
      java.lang.String getRFC1036Time(java.util.Date inDate)
      Get an RFC1036 compliant date string based on the given Date object.
      java.lang.String getRFC1036Time(long range)
      Get the current time formatted for RFC 1036, this will use a cached format value if that value is within the input range of the current time.
      byte[] getRFC1036TimeAsBytes()
      Get the current time formatted for RFC 1036.
      byte[] getRFC1036TimeAsBytes(long range)
      Get the current time formatted for RFC 1036, this will use a cached format value if that value is within the input range of the current time.
      java.lang.String getRFC1123Time()
      Get an RFC1123 compliant date string based on the current time.
      java.lang.String getRFC1123Time(java.util.Date inDate)
      Get an RFC1123 compliant date string based on the given Date object.
      java.lang.String getRFC1123Time(long range)
      Get the time formatted for RFC 1123, this will use a cached format value if that value is within the input range of the current time.
      byte[] getRFC1123TimeAsBytes()
      Get the current time formatted for RFC 1123.
      byte[] getRFC1123TimeAsBytes(long range)
      Get the time formatted for RFC 1123, this will use a cached format value if that value is within the input range of the current time.
      java.lang.String getRFC2109Time()
      Get the current time formatted for RFC 2109.
      java.lang.String getRFC2109Time(java.util.Date inDate)
      Get an RFC2109 compliant date string based on the given Date object.
      java.lang.String getRFC2109Time(long range)
      Get the current time formatted for RFC 2109, this will use a cached format value if that value is within the input range of the current time.
      byte[] getRFC2109TimeAsBytes()
      Get the current time formatted for RFC 2109.
      byte[] getRFC2109TimeAsBytes(long range)
      Get the current time formatted for RFC 2109, this will use a cached format value if that value is within the input range of the current time.
      java.util.Date parseASCIITime(java.lang.String input)
      Parse the input string into an ASCII Date object.
      java.util.Date parseRFC1036Time(java.lang.String input)
      Parse the input string into an RFC1036 Date object.
      java.util.Date parseRFC1123Time(java.lang.String input)
      Parse in the input string into an RFC1123 Date object.
      java.util.Date parseRFC2109Time(java.lang.String input)
      Parse the input string into an RFC2109 Date object.
      java.util.Date parseTime(byte[] inBytes)
      Parse the input data into the matching Date format.
      java.util.Date parseTime(java.lang.String input)
      Parse the input data into the matching Date format.
    • Method Detail

      • getRFC1123TimeAsBytes

        byte[] getRFC1123TimeAsBytes()
        Get the current time formatted for RFC 1123.
        EEE, dd MMM yyyy HH:mm:ss z
        Returns:
        byte[]
      • getRFC1123TimeAsBytes

        byte[] getRFC1123TimeAsBytes(long range)
        Get the time formatted for RFC 1123, this will use a cached format value if that value is within the input range of the current time.
        EEE, dd MMM yyyy HH:mm:ss z
        Parameters:
        range - (milliseconds, -1 means use default, 0 means right now)
        Returns:
        byte[]
      • getRFC1123Time

        java.lang.String getRFC1123Time()
        Get an RFC1123 compliant date string based on the current time.
        EEE, dd MMM yyyy HH:mm:ss z
        Returns:
        String
      • getRFC1123Time

        java.lang.String getRFC1123Time(long range)
        Get the time formatted for RFC 1123, this will use a cached format value if that value is within the input range of the current time.
        EEE, dd MMM yyyy HH:mm:ss z
        Parameters:
        range - (milliseconds, -1 means use default, 0 means right now)
        Returns:
        String
      • getRFC1123Time

        java.lang.String getRFC1123Time(java.util.Date inDate)
        Get an RFC1123 compliant date string based on the given Date object.
        Parameters:
        inDate -
        Returns:
        String
      • getRFC1036TimeAsBytes

        byte[] getRFC1036TimeAsBytes()
        Get the current time formatted for RFC 1036.
        EEEEEEEEE, dd-MMM-yy HH:mm:ss z
        Returns:
        byte[]
      • getRFC1036TimeAsBytes

        byte[] getRFC1036TimeAsBytes(long range)
        Get the current time formatted for RFC 1036, this will use a cached format value if that value is within the input range of the current time.
        EEEEEEEEE, dd-MMM-yy HH:mm:ss z
        Parameters:
        range - (milliseconds, -1 means use default, 0 means right now)
        Returns:
        byte[]
      • getRFC1036Time

        java.lang.String getRFC1036Time()
        Get the current time formatted for RFC 1036.
        EEEEEEEEE, dd-MMM-yy HH:mm:ss z
        Returns:
        String
      • getRFC1036Time

        java.lang.String getRFC1036Time(long range)
        Get the current time formatted for RFC 1036, this will use a cached format value if that value is within the input range of the current time.
        EEEEEEEEE, dd-MMM-yy HH:mm:ss z
        Parameters:
        range - (milliseconds, -1 means use default, 0 means right now)
        Returns:
        String
      • getRFC1036Time

        java.lang.String getRFC1036Time(java.util.Date inDate)
        Get an RFC1036 compliant date string based on the given Date object.
        Parameters:
        inDate -
        Returns:
        String
      • getRFC2109TimeAsBytes

        byte[] getRFC2109TimeAsBytes()
        Get the current time formatted for RFC 2109.
        EEE, dd-MMM-YY HH:mm:ss GMT
        Returns:
        byte[]
      • getRFC2109TimeAsBytes

        byte[] getRFC2109TimeAsBytes(long range)
        Get the current time formatted for RFC 2109, this will use a cached format value if that value is within the input range of the current time.
        EEE, dd-MMM-YY HH:mm:ss GMT
        Parameters:
        range - (milliseconds, -1 means use default, 0 means right now)
        Returns:
        byte[]
      • getRFC2109Time

        java.lang.String getRFC2109Time()
        Get the current time formatted for RFC 2109.
        EEE, dd-MMM-YY HH:mm:ss GMT
        Returns:
        String
      • getRFC2109Time

        java.lang.String getRFC2109Time(long range)
        Get the current time formatted for RFC 2109, this will use a cached format value if that value is within the input range of the current time.
        EEE, dd-MMM-YY HH:mm:ss GMT
        Parameters:
        range - (milliseconds, -1 means use default, 0 means right now)
        Returns:
        String
      • getRFC2109Time

        java.lang.String getRFC2109Time(java.util.Date inDate)
        Get an RFC2109 compliant date string based on the given Date object.
        Parameters:
        inDate -
        Returns:
        String
      • getASCIITimeAsBytes

        byte[] getASCIITimeAsBytes()
        Get the current time formatted for standard ASCII.
        EEE MMM d HH:mm:ss yyyy
        Returns:
        byte[]
      • getASCIITimeAsBytes

        byte[] getASCIITimeAsBytes(long range)
        Get the current time formatted for standard ASCII, this will use a cached format value if that value is within the input range of the current time.
        EEE MMM d HH:mm:ss yyyy
        Parameters:
        range - (milliseconds, -1 means use default, 0 means right now)
        Returns:
        byte[]
      • getASCIITime

        java.lang.String getASCIITime()
        Get the current time formatted for standard ASCII.
        EEE MMM d HH:mm:ss yyyy
        Returns:
        String
      • getASCIITime

        java.lang.String getASCIITime(long range)
        Get the current time formatted for standard ASCII, this will use a cached format value if that value is within the input range of the current time.
        EEE MMM d HH:mm:ss yyyy
        Parameters:
        range - (milliseconds, -1 means use default, 0 means right now)
        Returns:
        String
      • getASCIITime

        java.lang.String getASCIITime(java.util.Date inDate)
        Get an ASCII complaint date string based on the given Date object.
        Parameters:
        inDate -
        Returns:
        String
      • getNCSATimeAsBytes

        byte[] getNCSATimeAsBytes()
        Get the current time formatted for NCSA.
        dd/MMM/yyyy:HH:mm:ss Z
        Returns:
        byte[]
      • getNCSATimeAsBytes

        byte[] getNCSATimeAsBytes(long range)
        Get the current time formatted for NCSA, this will use a cached format value if that value is within the input range of the current time.
        dd/MMM/yyyy:HH:mm:ss Z
        Parameters:
        range - (milliseconds, -1 means use default, 0 means right now)
        Returns:
        byte[]
      • getNCSATime

        java.lang.String getNCSATime()
        Get the current time formatted for NCSA.
        dd/MMM/yyyy:HH:mm:ss Z
        Returns:
        String
      • getNCSATime

        java.lang.String getNCSATime(long range)
        Get the current time formatted for NCSA, this will use a cached format value if that value is within the input range of the current time.
        dd/MMM/yyyy:HH:mm:ss Z
        Parameters:
        range - (milliseconds, -1 means use default, 0 means right now)
        Returns:
        String
      • getNCSATime

        java.lang.String getNCSATime(java.util.Date inDate)
        Format the given Date object in the NCSA format.
        Parameters:
        inDate -
        Returns:
        String
      • parseRFC1123Time

        java.util.Date parseRFC1123Time(java.lang.String input)
                                 throws java.text.ParseException
        Parse in the input string into an RFC1123 Date object.
        Parameters:
        input -
        Returns:
        Date
        Throws:
        java.text.ParseException
      • parseRFC1036Time

        java.util.Date parseRFC1036Time(java.lang.String input)
                                 throws java.text.ParseException
        Parse the input string into an RFC1036 Date object.
        Parameters:
        input -
        Returns:
        Date
        Throws:
        java.text.ParseException
      • parseRFC2109Time

        java.util.Date parseRFC2109Time(java.lang.String input)
                                 throws java.text.ParseException
        Parse the input string into an RFC2109 Date object.
        Parameters:
        input -
        Returns:
        Date
        Throws:
        java.text.ParseException
      • parseASCIITime

        java.util.Date parseASCIITime(java.lang.String input)
                               throws java.text.ParseException
        Parse the input string into an ASCII Date object.
        Parameters:
        input -
        Returns:
        Date
        Throws:
        java.text.ParseException
      • parseTime

        java.util.Date parseTime(java.lang.String input)
                          throws java.text.ParseException
        Parse the input data into the matching Date format. It will try RFC1123, then RFC1036, and finally ASCII until it finds a match, or it throws a ParseException if there was no match.
        Parameters:
        input -
        Returns:
        Date
        Throws:
        java.text.ParseException
      • parseTime

        java.util.Date parseTime(byte[] inBytes)
                          throws java.text.ParseException
        Parse the input data into the matching Date format. It will try RFC1123, then RFC1036, and finally ASCII until it finds a match, or it throws a ParseException if there was no match.
        Parameters:
        inBytes -
        Returns:
        Date
        Throws:
        java.text.ParseException