init

java/org/apache/tomcat/util/http/CookieProcessor.java

@@ -0,0 +1,51 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one or more
+ *  contributor license agreements.  See the NOTICE file distributed with
+ *  this work for additional information regarding copyright ownership.
+ *  The ASF 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 org.apache.tomcat.util.http;
+
+import java.nio.charset.Charset;
+
+import javax.servlet.http.Cookie;
+
+public interface CookieProcessor {
+
+    /**
+     * Parse the provided headers into server cookie objects.
+     *
+     * @param headers       The HTTP headers to parse
+     * @param serverCookies The server cookies object to populate with the
+     *                      results of the parsing
+     */
+    void parseCookieHeader(MimeHeaders headers, ServerCookies serverCookies);
+
+    /**
+     * Generate the {@code Set-Cookie} HTTP header value for the given Cookie.
+     *
+     * @param cookie The cookie for which the header will be generated
+     *
+     * @return The header value in a form that can be added directly to the
+     *         response
+     */
+    String generateHeader(Cookie cookie);
+
+    /**
+     * Obtain the character set that will be used when converting between bytes
+     * and characters when parsing and/or generating HTTP headers for cookies.
+     *
+     * @return The character set used for byte<->character conversions
+     */
+    Charset getCharset();
+}