Package uk.ac.warwick.sso.client.util.cookies

Class ServerCookieEncoder

  • public final class ServerCookieEncoder
extends java.lang.Object
    A RFC6265 compliant cookie encoder to be used server side, so some fields are sent (Version is typically ignored). As Netty's Cookie merges Expires and MaxAge into one single field, only Max-Age field is sent. Note that multiple cookies are supposed to be sent at once in a single "Set-Cookie" header.

    • Constructor Summary

      Constructors 
      Constructor Description
      ServerCookieEncoder​(boolean strict)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> encode​(java.lang.Iterable<? extends uk.ac.warwick.sso.client.core.Cookie> cookies)
      Batch encodes cookies into Set-Cookie header values.
      java.lang.String encode​(java.lang.String name, java.lang.String value)
      Encodes the specified cookie name-value pair into a Set-Cookie header value.
      java.util.List<java.lang.String> encode​(java.util.Collection<? extends uk.ac.warwick.sso.client.core.Cookie> cookies)
      Batch encodes cookies into Set-Cookie header values.
      java.lang.String encode​(uk.ac.warwick.sso.client.core.Cookie cookie)
      Encodes the specified cookie into a Set-Cookie header value.
      java.util.List<java.lang.String> encode​(uk.ac.warwick.sso.client.core.Cookie... cookies)
      Batch encodes cookies into Set-Cookie header values.
      protected void validateCookie​(java.lang.String name, java.lang.String value)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ServerCookieEncoder

        public ServerCookieEncoder​(boolean strict)

    • Method Detail

      • encode

        public java.lang.String encode​(java.lang.String name,
                               java.lang.String value)
        Encodes the specified cookie name-value pair into a Set-Cookie header value.
        Parameters:
        name - the cookie name
        value - the cookie value
        Returns:
        a single Set-Cookie header value

      • encode

        public java.lang.String encode​(uk.ac.warwick.sso.client.core.Cookie cookie)
        Encodes the specified cookie into a Set-Cookie header value.
        Parameters:
        cookie - the cookie
        Returns:
        a single Set-Cookie header value

      • encode

        public java.util.List<java.lang.String> encode​(uk.ac.warwick.sso.client.core.Cookie... cookies)
        Batch encodes cookies into Set-Cookie header values.
        Parameters:
        cookies - a bunch of cookies
        Returns:
        the corresponding bunch of Set-Cookie headers

      • encode

        public java.util.List<java.lang.String> encode​(java.util.Collection<? extends uk.ac.warwick.sso.client.core.Cookie> cookies)
        Batch encodes cookies into Set-Cookie header values.
        Parameters:
        cookies - a bunch of cookies
        Returns:
        the corresponding bunch of Set-Cookie headers

      • encode

        public java.util.List<java.lang.String> encode​(java.lang.Iterable<? extends uk.ac.warwick.sso.client.core.Cookie> cookies)
        Batch encodes cookies into Set-Cookie header values.
        Parameters:
        cookies - a bunch of cookies
        Returns:
        the corresponding bunch of Set-Cookie headers

      • validateCookie

        protected void validateCookie​(java.lang.String name,
                              java.lang.String value)