Top Inners Fields Constructors Methods
org.apache.tomcat.util.http

public final Class Parameters

extends Object
Class Inheritance
Imports
java.io.IOException, java.nio.charset.Charset, .StandardCharsets, java.util.ArrayList, .Collections, .Enumeration, .LinkedHashMap, .Map, org.apache.juli.logging.Log, .LogFactory, org.apache.tomcat.util.buf.ByteChunk, .MessageBytes, .StringUtils, .UDecoder, org.apache.tomcat.util.log.UserDataHelper, org.apache.tomcat.util.res.StringManager

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
Parameters.FailReason

Field Summary

Modifier and TypeField and Description
private Charset
charset

private final MessageBytes
decodedQuery

private static final Charset
DEFAULT_BODY_CHARSET

private static final Charset
DEFAULT_URI_CHARSET

private boolean
didQueryParameters

private int
limit

private static final Log
log

private static final UserDataHelper
maxParamCountLog

private final ByteChunk
origName

private final ByteChunk
origValue

private int
parameterCount

private final Map<String, ArrayList<String>>
paramHashValues

private Parameters.FailReason
parseFailedReason

Set to the reason for the failure (the first failure if there is more than one) if there were failures during parameter parsing.

private MessageBytes
queryMB

private Charset
queryStringCharset

private static final StringManager
sm

private final ByteChunk
tmpName

private final ByteChunk
tmpValue

private UDecoder
urlDec

private static final UserDataHelper
userDataLog

Constructor Summary

AccessConstructor and Description
public
Parameters()

Method Summary

Modifier and TypeMethod and Description
public void
addParameter(String key, String value)

public Charset
getCharset()

public String
getParameter(String name)

public Enumeration<String>
getParameterNames()

public String[]
getParameterValues(String name)

public Parameters.FailReason
getParseFailedReason()

public void
handleQueryParameters()

Process the query string into parameters

public boolean
isParseFailed()

public void
processParameters(byte[] bytes, int start, int len)

private void
processParameters(byte[] bytes, int start, int len, Charset charset)

public void
processParameters(MessageBytes data, Charset charset)

public void
recycle()

public void
setCharset(Charset charset)

public void
setLimit(int limit)

public void
setParseFailedReason(Parameters.FailReason failReason)

public void
setQuery(MessageBytes queryMB)

public void
setQueryStringCharset(Charset queryStringCharset)

public void
setURLDecoder(UDecoder u)

public int
size()

public String
toString()

Overrides java.lang.Object.toString.

Debug purpose

private void
urlDecode(ByteChunk bc)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

charsetback to summary
private Charset charset
decodedQueryback to summary
private final MessageBytes decodedQuery
DEFAULT_BODY_CHARSETback to summary
private static final Charset DEFAULT_BODY_CHARSET
DEFAULT_URI_CHARSETback to summary
private static final Charset DEFAULT_URI_CHARSET
didQueryParametersback to summary
private boolean didQueryParameters
limitback to summary
private int limit
logback to summary
private static final Log log
maxParamCountLogback to summary
private static final UserDataHelper maxParamCountLog
origNameback to summary
private final ByteChunk origName
origValueback to summary
private final ByteChunk origValue
parameterCountback to summary
private int parameterCount
paramHashValuesback to summary
private final Map<String, ArrayList<String>> paramHashValues
parseFailedReasonback to summary
private Parameters.FailReason parseFailedReason

Set to the reason for the failure (the first failure if there is more than one) if there were failures during parameter parsing.

queryMBback to summary
private MessageBytes queryMB
queryStringCharsetback to summary
private Charset queryStringCharset
smback to summary
private static final StringManager sm
tmpNameback to summary
private final ByteChunk tmpName
tmpValueback to summary
private final ByteChunk tmpValue
urlDecback to summary
private UDecoder urlDec
userDataLogback to summary
private static final UserDataHelper userDataLog

Constructor Detail

Parametersback to summary
public Parameters()

Method Detail

addParameterback to summary
public void addParameter(String key, String value) throws IllegalStateException
getCharsetback to summary
public Charset getCharset()
getParameterback to summary
public String getParameter(String name)
getParameterNamesback to summary
public Enumeration<String> getParameterNames()
getParameterValuesback to summary
public String[] getParameterValues(String name)
getParseFailedReasonback to summary
public Parameters.FailReason getParseFailedReason()
handleQueryParametersback to summary
public void handleQueryParameters()

Process the query string into parameters

isParseFailedback to summary
public boolean isParseFailed()
processParametersback to summary
public void processParameters(byte[] bytes, int start, int len)
processParametersback to summary
private void processParameters(byte[] bytes, int start, int len, Charset charset)
processParametersback to summary
public void processParameters(MessageBytes data, Charset charset)
recycleback to summary
public void recycle()
setCharsetback to summary
public void setCharset(Charset charset)
setLimitback to summary
public void setLimit(int limit)
setParseFailedReasonback to summary
public void setParseFailedReason(Parameters.FailReason failReason)
setQueryback to summary
public void setQuery(MessageBytes queryMB)
setQueryStringCharsetback to summary
public void setQueryStringCharset(Charset queryStringCharset)
setURLDecoderback to summary
public void setURLDecoder(UDecoder u)
sizeback to summary
public int size()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Debug purpose

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations
@Override
urlDecodeback to summary
private void urlDecode(ByteChunk bc) throws IOException
org.apache.tomcat.util.http back to summary

public final Enum Parameters.FailReason

extends Enum<Parameters.FailReason>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final Parameters.FailReason
CLIENT_DISCONNECT

public static final Parameters.FailReason
INVALID_CONTENT_TYPE

public static final Parameters.FailReason
IO_ERROR

public static final Parameters.FailReason
MULTIPART_CONFIG_INVALID

public static final Parameters.FailReason
NO_NAME

public static final Parameters.FailReason
POST_TOO_LARGE

public static final Parameters.FailReason
REQUEST_BODY_INCOMPLETE

Deprecated Unused. Will be removed in Tomcat 11.0.x onwards
Same as CLIENT_DISCONNECT.
public static final Parameters.FailReason
TOO_MANY_PARAMETERS

public static final Parameters.FailReason
UNKNOWN

public static final Parameters.FailReason
URL_DECODING

Constructor Summary

AccessConstructor and Description
private
FailReason()

Method Summary

Modifier and TypeMethod and Description
public static Parameters.FailReason
valueOf(String name)

public static Parameters.FailReason[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CLIENT_DISCONNECTback to summary
public static final Parameters.FailReason CLIENT_DISCONNECT
INVALID_CONTENT_TYPEback to summary
public static final Parameters.FailReason INVALID_CONTENT_TYPE
IO_ERRORback to summary
public static final Parameters.FailReason IO_ERROR
MULTIPART_CONFIG_INVALIDback to summary
public static final Parameters.FailReason MULTIPART_CONFIG_INVALID
NO_NAMEback to summary
public static final Parameters.FailReason NO_NAME
POST_TOO_LARGEback to summary
public static final Parameters.FailReason POST_TOO_LARGE
REQUEST_BODY_INCOMPLETEback to summary
public static final Parameters.FailReason REQUEST_BODY_INCOMPLETE

Deprecated

Unused. Will be removed in Tomcat 11.0.x onwards

Same as CLIENT_DISCONNECT.

Annotations
@Deprecated
TOO_MANY_PARAMETERSback to summary
public static final Parameters.FailReason TOO_MANY_PARAMETERS
UNKNOWNback to summary
public static final Parameters.FailReason UNKNOWN
URL_DECODINGback to summary
public static final Parameters.FailReason URL_DECODING

Constructor Detail

FailReasonback to summary
private FailReason()

Method Detail

valueOfback to summary
public static Parameters.FailReason valueOf(String name)
valuesback to summary
public static Parameters.FailReason[] values()