Class ClientCookieEncoder

java.lang.Object
io.netty.handler.codec.http.cookie.CookieEncoder
io.netty.handler.codec.http.cookie.ClientCookieEncoder
public final class ClientCookieEncoder extends CookieEncoder
A RFC6265 compliant cookie encoder to be used client side, so only name=value pairs are sent. Note that multiple cookies are supposed to be sent at once in a single "Cookie" header. 
// Example
HttpRequest req = ...;
res.setHeader("Cookie", ClientCookieEncoder.encode("JSESSIONID", "1234"));
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    (package private) static final java.util.Comparator<Cookie>
    COOKIE_COMPARATOR
    Sort cookies into decreasing order of path length, breaking ties by sorting into increasing chronological order of creation time, as recommended by RFC 6265.
    static final ClientCookieEncoder
    LAX
    Lax instance that doesn't validate name and value, and (for methods that accept multiple cookies) keeps cookies in the order in which they were given.
    static final ClientCookieEncoder
    STRICT
    Strict encoder that validates that name and value chars are in the valid scope and (for methods that accept multiple cookies) sorts cookies into order of decreasing path length, as specified in RFC6265.

    Fields inherited from class CookieEncoder

    strict

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    ClientCookieEncoder(boolean strict)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    java.lang.String
    encode(Cookie cookie)
    Encodes the specified cookie into a Cookie header value.
    java.lang.String
    encode(Cookie... cookies)
    Encodes the specified cookies into a single Cookie header value.
    java.lang.String
    encode(java.lang.Iterable<? extends Cookie> cookies)
    Encodes the specified cookies into a single Cookie header value.
    private void
    encode(java.lang.StringBuilder buf, Cookie c)
     
    java.lang.String
    encode(java.lang.String name, java.lang.String value)
    Encodes the specified cookie into a Cookie header value.
    java.lang.String
    encode(java.util.Collection<? extends Cookie> cookies)
    Encodes the specified cookies into a single Cookie header value.

    Methods inherited from class CookieEncoder

    validateCookie

    Methods inherited from class java.lang.Object

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

  • Field Details

    • STRICT

      public static final ClientCookieEncoder STRICT
      Strict encoder that validates that name and value chars are in the valid scope and (for methods that accept multiple cookies) sorts cookies into order of decreasing path length, as specified in RFC6265.

    • LAX

      public static final ClientCookieEncoder LAX
      Lax instance that doesn't validate name and value, and (for methods that accept multiple cookies) keeps cookies in the order in which they were given.

  • Constructor Details

    • ClientCookieEncoder

      private ClientCookieEncoder(boolean strict)

  • Method Details

    • encode

      public java.lang.String encode(java.lang.String name, java.lang.String value)
      Encodes the specified cookie into a Cookie header value.
      Parameters:
      name - the cookie name
      value - the cookie value
      Returns:
      a Rfc6265 style Cookie header value

    • encode

      public java.lang.String encode(Cookie cookie)
      Encodes the specified cookie into a Cookie header value.
      Parameters:
      cookie - the specified cookie
      Returns:
      a Rfc6265 style Cookie header value

    • encode

      public java.lang.String encode(Cookie... cookies)
      Encodes the specified cookies into a single Cookie header value.
      Parameters:
      cookies - some cookies
      Returns:
      a Rfc6265 style Cookie header value, null if no cookies are passed.

    • encode

      public java.lang.String encode(java.util.Collection<? extends Cookie> cookies)
      Encodes the specified cookies into a single Cookie header value.
      Parameters:
      cookies - some cookies
      Returns:
      a Rfc6265 style Cookie header value, null if no cookies are passed.

    • encode

      public java.lang.String encode(java.lang.Iterable<? extends Cookie> cookies)
      Encodes the specified cookies into a single Cookie header value.
      Parameters:
      cookies - some cookies
      Returns:
      a Rfc6265 style Cookie header value, null if no cookies are passed.

    • encode

      private void encode(java.lang.StringBuilder buf, Cookie c)