Package akka.http.scaladsl.model

Class HttpHeader$

  • public class HttpHeader$
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static HttpHeader$ MODULE$
      Static reference to the singleton instance of this Scala object.

    • Constructor Summary

      Constructors 
      Constructor Description
      HttpHeader$()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <T extends HttpHeader>
      akka.util.OptionVal<T>      		 fastFind​(java.lang.Class<T> clazz, scala.collection.immutable.Seq<HttpHeader> headers)
      INTERNAL API
      HttpHeader.ParsingResult parse​(java.lang.String name, java.lang.String value, HeaderParser.Settings settings)
      Attempts to parse the given header name and value string into a header model instance.
      scala.Option<scala.Tuple2<java.lang.String,​java.lang.String>> unapply​(HttpHeader header)
      Extract name and value from a header.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • MODULE$

        public static final HttpHeader$ MODULE$
        Static reference to the singleton instance of this Scala object.

    • Constructor Detail

      • HttpHeader$

        public HttpHeader$()

    • Method Detail

      • unapply

        public scala.Option<scala.Tuple2<java.lang.String,​java.lang.String>> unapply​(HttpHeader header)
        Extract name and value from a header. CAUTION: The name must be matched in *all-lowercase*!.
        Parameters:
        header - (undocumented)
        Returns:
        (undocumented)

      • parse

        public HttpHeader.ParsingResult parse​(java.lang.String name,
                                      java.lang.String value,
                                      HeaderParser.Settings settings)
        Attempts to parse the given header name and value string into a header model instance.

        This process has several possible outcomes:

        1. The header name corresponds to a properly modelled header and a) the value is valid for this header type. In this case the method returns a ParsingResult.Ok with the respective header instance and no errors. b) the value consists of a number elements, some of which valid and some invalid, and the header type supports partial value parsing. In this case the method returns a ParsingResult.Ok with the respective header instance holding the valid value elements and an ErrorInfo for each invalid value. c) the value has invalid elements and the header type doesn't support partial value parsing. In this case the method returns a ParsingResult.Ok with a RawHeader instance and a single ErrorInfo for the value parsing problem.

        2. The header name does not correspond to a properly modelled header but the header name and the value are both syntactically legal according to the basic header requirements from the HTTP specification. (http://tools.ietf.org/html/rfc7230#section-3.2) In this case the method returns a ParsingResult.Ok with a RawHeader instance and no errors.

        3. The header name or value are illegal according to the basic requirements for HTTP headers (http://tools.ietf.org/html/rfc7230#section-3.2). In this case the method returns a ParsingResult.Error.

        Parameters:
        name - (undocumented)
        value - (undocumented)
        settings - (undocumented)
        Returns:
        (undocumented)

      • fastFind

        public <T extends HttpHeader> akka.util.OptionVal<T> fastFind​(java.lang.Class<T> clazz,
                                                              scala.collection.immutable.Seq<HttpHeader> headers)
        INTERNAL API