|
Java example source code file (ServerCookieEncoder.java)
The ServerCookieEncoder.java Java example source code/* * Copyright 2015 The Netty Project * * The Netty Project licenses this file to you under the Apache License, * version 2.0 (the "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the * License for the specific language governing permissions and limitations * under the License. */ package io.netty.handler.codec.http.cookie; import static io.netty.handler.codec.http.cookie.CookieUtil.add; import static io.netty.handler.codec.http.cookie.CookieUtil.addQuoted; import static io.netty.handler.codec.http.cookie.CookieUtil.stringBuilder; import static io.netty.handler.codec.http.cookie.CookieUtil.stripTrailingSeparator; import static io.netty.util.internal.ObjectUtil.checkNotNull; import io.netty.handler.codec.http.HttpHeaderDateFormat; import io.netty.handler.codec.http.HttpRequest; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.Date; import java.util.HashMap; import java.util.Iterator; import java.util.List; import java.util.Map; /** * A <a href="http://tools.ietf.org/html/rfc6265">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. * * <pre> * // Example * {@link HttpRequest} req = ...; * res.setHeader("Cookie", {@link ServerCookieEncoder}.encode("JSESSIONID", "1234")); * </pre> * * @see ServerCookieDecoder */ public final class ServerCookieEncoder extends CookieEncoder { /** * Strict encoder that validates that name and value chars are in the valid scope * defined in RFC6265, and (for methods that accept multiple cookies) that only * one cookie is encoded with any given name. (If multiple cookies have the same * name, the last one is the one that is encoded.) */ public static final ServerCookieEncoder STRICT = new ServerCookieEncoder(true); /** * Lax instance that doesn't validate name and value, and that allows multiple * cookies with the same name. */ public static final ServerCookieEncoder LAX = new ServerCookieEncoder(false); private ServerCookieEncoder(boolean strict) { super(strict); } /** * Encodes the specified cookie name-value pair into a Set-Cookie header value. * * @param name the cookie name * @param value the cookie value * @return a single Set-Cookie header value */ public String encode(String name, String value) { return encode(new DefaultCookie(name, value)); } /** * Encodes the specified cookie into a Set-Cookie header value. * * @param cookie the cookie * @return a single Set-Cookie header value */ public String encode(Cookie cookie) { final String name = checkNotNull(cookie, "cookie").name(); final String value = cookie.value() != null ? cookie.value() : ""; validateCookie(name, value); StringBuilder buf = stringBuilder(); if (cookie.wrap()) { addQuoted(buf, name, value); } else { add(buf, name, value); } if (cookie.maxAge() != Long.MIN_VALUE) { add(buf, CookieHeaderNames.MAX_AGE, cookie.maxAge()); Date expires = new Date(cookie.maxAge() * 1000 + System.currentTimeMillis()); add(buf, CookieHeaderNames.EXPIRES, HttpHeaderDateFormat.get().format(expires)); } if (cookie.path() != null) { add(buf, CookieHeaderNames.PATH, cookie.path()); } if (cookie.domain() != null) { add(buf, CookieHeaderNames.DOMAIN, cookie.domain()); } if (cookie.isSecure()) { add(buf, CookieHeaderNames.SECURE); } if (cookie.isHttpOnly()) { add(buf, CookieHeaderNames.HTTPONLY); } return stripTrailingSeparator(buf); } /** Deduplicate a list of encoded cookies by keeping only the last instance with a given name. * * @param encoded The list of encoded cookies. * @param nameToLastIndex A map from cookie name to index of last cookie instance. * @return The encoded list with all but the last instance of a named cookie. */ private List<String> dedup(List Other Java examples (source code examples)Here is a short list of links related to this Java ServerCookieEncoder.java source code file: |
... this post is sponsored by my books ... | |
#1 New Release! |
FP Best Seller |
Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.
A percentage of advertising revenue from
pages under the /java/jwarehouse
URI on this website is
paid back to open source projects.