Cookie header parser based on RFC6265

The parsing of cookies using RFC6265 is more relaxed that the specification in the following ways:

Values 0x80 to 0xFF are permitted in cookie-octet to support the use of UTF-8 in cookie values as used by HTML 5.
For cookies without a value, the '=' is not required after the name as some browsers do not sent it.

Implementation note:
This class has been carefully tuned. Before committing any changes, ensure that the TesterCookiePerformance unit test continues to give results within 1% for the old and new parsers.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	Cookie.ByteBuffer Custom implementation that skips many of the safety checks in `java.nio.ByteBuffer`.

Field Summary

Modifier and Type	Field and Description
private static final byte	COMMA_BYTE
private static final byte	DEL_BYTE
private static final byte[]	EMPTY_BYTES
private static final byte	EQUALS_BYTE
private static final UserDataHelper	invalidCookieLog
private static final boolean[]	isCookieOctet
private static final boolean[]	isText
private static final Log	log
private static final byte	QUOTE_BYTE
private static final byte	SEMICOLON_BYTE
private static final byte	SLASH_BYTE
private static final StringManager	sm
private static final byte	SPACE_BYTE
private static final byte	TAB_BYTE

Constructor Summary

Access	Constructor and Description
private	Cookie()

Method Summary

Modifier and Type	Method and Description
private static void	logInvalidHeader(int start, Cookie.ByteBuffer bb)
public static void	parseCookie(byte[] bytes, int offset, int len, ServerCookies serverCookies)
private static Cookie.ByteBuffer	readCookieValueRfc6265(Cookie.ByteBuffer bb) Similar to readCookieValue() but treats a comma as part of an invalid value.
private static Cookie.ByteBuffer	readToken(Cookie.ByteBuffer bb)
private static SkipResult	skipByte(Cookie.ByteBuffer bb, byte target)
private static void	skipLWS(Cookie.ByteBuffer bb)
private static void	skipUntilSemiColon(Cookie.ByteBuffer bb)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

COMMA_BYTE	back to summary
private static final byte COMMA_BYTE

DEL_BYTE	back to summary
private static final byte DEL_BYTE

EMPTY_BYTES	back to summary
private static final byte[] EMPTY_BYTES

EQUALS_BYTE	back to summary
private static final byte EQUALS_BYTE

invalidCookieLog	back to summary
private static final UserDataHelper invalidCookieLog

isCookieOctet	back to summary
private static final boolean[] isCookieOctet

isText	back to summary
private static final boolean[] isText

log	back to summary
private static final Log log

QUOTE_BYTE	back to summary
private static final byte QUOTE_BYTE

SEMICOLON_BYTE	back to summary
private static final byte SEMICOLON_BYTE

SLASH_BYTE	back to summary
private static final byte SLASH_BYTE

sm	back to summary
private static final StringManager sm

SPACE_BYTE	back to summary
private static final byte SPACE_BYTE

TAB_BYTE	back to summary
private static final byte TAB_BYTE

Constructor Detail

Method Detail

parseCookie	back to summary
public static void parseCookie(byte[] bytes, int offset, int len, ServerCookies serverCookies)

org.apache.tomcat.util.http.parser back to summary

private Class Cookie.ByteBuffer

Class Inheritance

extends Object

java.lang.Object
org.apache.tomcat.util.http.parser.Cookie.ByteBuffer

Custom implementation that skips many of the safety checks in java.nio.ByteBuffer.

Modifier and Type	Field and Description
private final byte[]	bytes
private int	limit
private int	position

Access	Constructor and Description
pack-priv	ByteBuffer(byte[] bytes, int offset, int len)

Method Summary

Modifier and Type	Method and Description
public byte[]	array()
public byte	get()
public boolean	hasRemaining()
public int	limit()
public int	position()
public void	position(int position)
public int	remaining()
public void	rewind()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

bytes	back to summary
private final byte[] bytes

limit	back to summary
private int limit

position	back to summary
private int position

ByteBuffer	back to summary
pack-priv ByteBuffer(byte[] bytes, int offset, int len)

Method Detail

array	back to summary
public byte[] array()

get	back to summary
public byte get()

hasRemaining	back to summary
public boolean hasRemaining()

limit	back to summary
public int limit()

position	back to summary
public int position()

position	back to summary
public void position(int position)

remaining	back to summary
public int remaining()

rewind	back to summary
public void rewind()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class Cookie

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Cookie.ByteBuffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail