IT. Expert System.

Android Reference

UrlQuerySanitizer

android.net

Class UrlQuerySanitizer

java.lang.Object
- android.net.UrlQuerySanitizer

```
public class UrlQuerySanitizer
extends Object
```
Sanitizes the Query portion of a URL. Simple example: UrlQuerySanitizer sanitizer = new UrlQuerySanitizer(); sanitizer.setAllowUnregisteredParamaters(true); sanitizer.parseUrl("http://example.com/?name=Joe+User"); String name = sanitizer.getValue("name")); // name now contains "Joe_User" Register ValueSanitizers to customize the way individual parameters are sanitized: UrlQuerySanitizer sanitizer = new UrlQuerySanitizer(); sanitizer.registerParamater("name", UrlQuerySanitizer.createSpaceLegal()); sanitizer.parseUrl("http://example.com/?name=Joe+User"); String name = sanitizer.getValue("name")); // name now contains "Joe User". (The string is first decoded, which // converts the '+' to a ' '. Then the string is sanitized, which // converts the ' ' to an '_'. (The ' ' is converted because the default unregistered parameter sanitizer does not allow any special characters, and ' ' is a special character.) There are several ways to create ValueSanitizers. In order of increasing sophistication:
1. Call one of the UrlQuerySanitizer.createXXX() methods.
2. Construct your own instance of UrlQuerySanitizer.IllegalCharacterValueSanitizer.
3. Subclass UrlQuerySanitizer.ValueSanitizer to define your own value sanitizer.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`UrlQuerySanitizer.IllegalCharacterValueSanitizer` Sanitize values based on which characters they contain.
`class`	`UrlQuerySanitizer.ParameterValuePair` A simple tuple that holds parameter-value pairs.
`static interface`	`UrlQuerySanitizer.ValueSanitizer` A functor used to sanitize a single query value.

Constructor Summary

Constructors
Constructor and Description

UrlQuerySanitizer()
Constructs a UrlQuerySanitizer.

UrlQuerySanitizer(String url)
Constructs a UrlQuerySanitizer and parse a URL.

Constructors
Constructor and Description
`UrlQuerySanitizer()` Constructs a UrlQuerySanitizer.
`UrlQuerySanitizer(String url)` Constructs a UrlQuerySanitizer and parse a URL.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addSanitizedEntry(String parameter, String value)` Record a sanitized parameter-value pair.
`protected void`	`clear()` Clear the existing entries.
`protected int`	`decodeHexDigit(char c)` Convert a character that represents a hexidecimal digit into an integer.
`static UrlQuerySanitizer.ValueSanitizer`	`getAllButNulAndAngleBracketsLegal()` Return a value sanitizer that allows any special characters except angle brackets ('<' and '>') and Nul ('\0').
`static UrlQuerySanitizer.ValueSanitizer`	`getAllButNulLegal()` Return a value sanitizer that allows everything except Nul ('\0') characters.
`static UrlQuerySanitizer.ValueSanitizer`	`getAllButWhitespaceLegal()` Return a value sanitizer that allows everything except Nul ('\0') characters, space (' '), and other whitespace characters.
`static UrlQuerySanitizer.ValueSanitizer`	`getAllIllegal()` Return a value sanitizer that does not allow any special characters, and also does not allow script URLs.
`boolean`	`getAllowUnregisteredParamaters()` Get whether or not unregistered parameters are allowed.
`static UrlQuerySanitizer.ValueSanitizer`	`getAmpAndSpaceLegal()` Return a value sanitizer that does not allow any special characters except ampersand ('&') and space (' ').
`static UrlQuerySanitizer.ValueSanitizer`	`getAmpLegal()` Return a value sanitizer that does not allow any special characters except ampersand ('&').
`UrlQuerySanitizer.ValueSanitizer`	`getEffectiveValueSanitizer(String parameter)` Get the effective value sanitizer for a parameter.
`List<UrlQuerySanitizer.ParameterValuePair>`	`getParameterList()` An array list of all of the parameter value pairs in the sanitized query, in the order they appeared in the query.
`Set<String>`	`getParameterSet()` Get a set of all of the parameters found in the sanitized query.
`boolean`	`getPreferFirstRepeatedParameter()` Get whether or not the first occurrence of a repeated parameter is preferred.
`static UrlQuerySanitizer.ValueSanitizer`	`getSpaceLegal()` Return a value sanitizer that does not allow any special characters except space (' ').
`UrlQuerySanitizer.ValueSanitizer`	`getUnregisteredParameterValueSanitizer()` Get the current value sanitizer used when processing unregistered parameter values.
`static UrlQuerySanitizer.ValueSanitizer`	`getUrlAndSpaceLegal()` Return a value sanitizer that allows all the characters used by encoded URLs and allows spaces, which are not technically legal in encoded URLs, but commonly appear anyway.
`static UrlQuerySanitizer.ValueSanitizer`	`getUrlLegal()` Return a value sanitizer that allows all the characters used by encoded URLs.
`String`	`getValue(String parameter)` Get the value for a parameter in the current sanitized query.
`UrlQuerySanitizer.ValueSanitizer`	`getValueSanitizer(String parameter)` Get the value sanitizer for a parameter.
`boolean`	`hasParameter(String parameter)` Check if a parameter exists in the current sanitized query.
`protected boolean`	`isHexDigit(char c)` Test if a character is a hexidecimal digit.
`protected void`	`parseEntry(String parameter, String value)` Parse an escaped parameter-value pair.
`void`	`parseQuery(String query)` Parse a query.
`void`	`parseUrl(String url)` Parse the query parameters out of an encoded URL.
`void`	`registerParameter(String parameter, UrlQuerySanitizer.ValueSanitizer valueSanitizer)` Register a value sanitizer for a particular parameter.
`void`	`registerParameters(String[] parameters, UrlQuerySanitizer.ValueSanitizer valueSanitizer)` Register a value sanitizer for an array of parameters.
`void`	`setAllowUnregisteredParamaters(boolean allowUnregisteredParamaters)` Set whether or not unregistered parameters are allowed.
`void`	`setPreferFirstRepeatedParameter(boolean preferFirstRepeatedParameter)` Set whether or not the first occurrence of a repeated parameter is preferred.
`void`	`setUnregisteredParameterValueSanitizer(UrlQuerySanitizer.ValueSanitizer sanitizer)` Set the value sanitizer used when processing unregistered parameter values.
`String`	`unescape(String string)` Unescape an escaped string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UrlQuerySanitizer
```
public UrlQuerySanitizer()
```
    Constructs a UrlQuerySanitizer.
    Defaults:
    - unregistered parameters are not allowed.
    - the last instance of a repeated parameter is preferred.
    - The default value sanitizer is an AllIllegal value sanitizer.
  - UrlQuerySanitizer
```
public UrlQuerySanitizer(String url)
```
    Constructs a UrlQuerySanitizer and parse a URL. This constructor is provided for convenience when the default parsing behavior is acceptable.
    Because the URL is parsed before the constructor returns, there isn't a chance to configure the sanitizer to change the parsing behavior.
    UrlQuerySanitizer sanitizer = new UrlQuerySanitizer(myUrl); String name = sanitizer.getValue("name");
    Defaults:
    - unregistered parameters are allowed.
    - the last instance of a repeated parameter is preferred.
    - The default value sanitizer is an AllIllegal value sanitizer.
- Method Detail
  - getUnregisteredParameterValueSanitizer
```
public UrlQuerySanitizer.ValueSanitizer getUnregisteredParameterValueSanitizer()
```
    Get the current value sanitizer used when processing unregistered parameter values.
    Note: The default unregistered parameter value sanitizer is one that doesn't allow any special characters, similar to what is returned by calling createAllIllegal.
    
    Returns:
    the current ValueSanitizer used to sanitize unregistered parameter values.
  - setUnregisteredParameterValueSanitizer
```
public void setUnregisteredParameterValueSanitizer(UrlQuerySanitizer.ValueSanitizer sanitizer)
```
    Set the value sanitizer used when processing unregistered parameter values.
    
    Parameters:
    sanitizer - set the ValueSanitizer used to sanitize unregistered parameter values.
  - getAllIllegal
```
public static final UrlQuerySanitizer.ValueSanitizer getAllIllegal()
```
    Return a value sanitizer that does not allow any special characters, and also does not allow script URLs.
    
    Returns:
    a value sanitizer
  - getAllButNulLegal
```
public static final UrlQuerySanitizer.ValueSanitizer getAllButNulLegal()
```
    Return a value sanitizer that allows everything except Nul ('\0') characters. Script URLs are allowed.
    
    Returns:
    a value sanitizer
  - getAllButWhitespaceLegal
```
public static final UrlQuerySanitizer.ValueSanitizer getAllButWhitespaceLegal()
```
    Return a value sanitizer that allows everything except Nul ('\0') characters, space (' '), and other whitespace characters. Script URLs are allowed.
    
    Returns:
    a value sanitizer
  - getUrlLegal
```
public static final UrlQuerySanitizer.ValueSanitizer getUrlLegal()
```
    Return a value sanitizer that allows all the characters used by encoded URLs. Does not allow script URLs.
    
    Returns:
    a value sanitizer
  - getUrlAndSpaceLegal
```
public static final UrlQuerySanitizer.ValueSanitizer getUrlAndSpaceLegal()
```
    Return a value sanitizer that allows all the characters used by encoded URLs and allows spaces, which are not technically legal in encoded URLs, but commonly appear anyway. Does not allow script URLs.
    
    Returns:
    a value sanitizer
  - getAmpLegal
```
public static final UrlQuerySanitizer.ValueSanitizer getAmpLegal()
```
    Return a value sanitizer that does not allow any special characters except ampersand ('&'). Does not allow script URLs.
    
    Returns:
    a value sanitizer
  - getAmpAndSpaceLegal
```
public static final UrlQuerySanitizer.ValueSanitizer getAmpAndSpaceLegal()
```
    Return a value sanitizer that does not allow any special characters except ampersand ('&') and space (' '). Does not allow script URLs.
    
    Returns:
    a value sanitizer
  - getSpaceLegal
```
public static final UrlQuerySanitizer.ValueSanitizer getSpaceLegal()
```
    Return a value sanitizer that does not allow any special characters except space (' '). Does not allow script URLs.
    
    Returns:
    a value sanitizer
  - getAllButNulAndAngleBracketsLegal
```
public static final UrlQuerySanitizer.ValueSanitizer getAllButNulAndAngleBracketsLegal()
```
    Return a value sanitizer that allows any special characters except angle brackets ('<' and '>') and Nul ('\0'). Allows script URLs.
    
    Returns:
    a value sanitizer
  - parseUrl
```
public void parseUrl(String url)
```
    Parse the query parameters out of an encoded URL. Works by extracting the query portion from the URL and then calling parseQuery(). If there is no query portion it is treated as if the query portion is an empty string.
    
    Parameters:
    url - the encoded URL to parse.
  - parseQuery
```
public void parseQuery(String query)
```
    Parse a query. A query string is any number of parameter-value clauses separated by any non-zero number of ampersands. A parameter-value clause is a parameter followed by an equal sign, followed by a value. If the equal sign is missing, the value is assumed to be the empty string.
    
    Parameters:
    query - the query to parse.
  - getParameterSet
```
public Set<String> getParameterSet()
```
    Get a set of all of the parameters found in the sanitized query.
    Note: Do not modify this set. Treat it as a read-only set.
    
    Returns:
    all the parameters found in the current query.
  - getParameterList
```
public List<UrlQuerySanitizer.ParameterValuePair> getParameterList()
```
    An array list of all of the parameter value pairs in the sanitized query, in the order they appeared in the query. May contain duplicate parameters.
    Note: Do not modify this list. Treat it as a read-only list.
  - hasParameter
```
public boolean hasParameter(String parameter)
```
    Check if a parameter exists in the current sanitized query.
    
    Parameters:
    parameter - the unencoded name of a parameter.
    
    Returns:
    true if the paramater exists in the current sanitized queary.
  - getValue
```
public String getValue(String parameter)
```
    Get the value for a parameter in the current sanitized query. Returns null if the parameter does not exit.
    
    Parameters:
    parameter - the unencoded name of a parameter.
    
    Returns:
    the sanitized unencoded value of the parameter, or null if the parameter does not exist.
  - registerParameter
```
public void registerParameter(String parameter,
                     UrlQuerySanitizer.ValueSanitizer valueSanitizer)
```
    Register a value sanitizer for a particular parameter. Can also be used to replace or remove an already-set value sanitizer.
    Registering a non-null value sanitizer for a particular parameter makes that parameter a registered parameter.
    
    Parameters:
    parameter - an unencoded parameter name
    valueSanitizer - the value sanitizer to use for a particular parameter. May be null in order to unregister that parameter.
    See Also:
    getAllowUnregisteredParamaters()
  - registerParameters
```
public void registerParameters(String[] parameters,
                      UrlQuerySanitizer.ValueSanitizer valueSanitizer)
```
    Register a value sanitizer for an array of parameters.
    
    Parameters:
    parameters - An array of unencoded parameter names.
    valueSanitizer -
    See Also:
    registerParameter(java.lang.String, android.net.UrlQuerySanitizer.ValueSanitizer)
  - setAllowUnregisteredParamaters
```
public void setAllowUnregisteredParamaters(boolean allowUnregisteredParamaters)
```
    Set whether or not unregistered parameters are allowed. If they are not allowed, then they will be dropped when a query is sanitized.
    Defaults to false.
    
    Parameters:
    allowUnregisteredParamaters - true to allow unregistered parameters.
    See Also:
    getAllowUnregisteredParamaters()
  - getAllowUnregisteredParamaters
```
public boolean getAllowUnregisteredParamaters()
```
    Get whether or not unregistered parameters are allowed. If not allowed, they will be dropped when a query is parsed.
    
    Returns:
    true if unregistered parameters are allowed.
    See Also:
    setAllowUnregisteredParamaters(boolean)
  - setPreferFirstRepeatedParameter
```
public void setPreferFirstRepeatedParameter(boolean preferFirstRepeatedParameter)
```
    Set whether or not the first occurrence of a repeated parameter is preferred. True means the first repeated parameter is preferred. False means that the last repeated parameter is preferred.
    The preferred parameter is the one that is returned when getParameter is called.
    defaults to false.
    
    Parameters:
    preferFirstRepeatedParameter - True if the first repeated parameter is preferred.
    See Also:
    getPreferFirstRepeatedParameter()
  - getPreferFirstRepeatedParameter
```
public boolean getPreferFirstRepeatedParameter()
```
    Get whether or not the first occurrence of a repeated parameter is preferred.
    
    Returns:
    true if the first occurrence of a repeated parameter is preferred.
    See Also:
    setPreferFirstRepeatedParameter(boolean)
  - parseEntry
```
protected void parseEntry(String parameter,
              String value)
```
    Parse an escaped parameter-value pair. The default implementation unescapes both the parameter and the value, then looks up the effective value sanitizer for the parameter and uses it to sanitize the value. If all goes well then addSanitizedValue is called with the unescaped parameter and the sanitized unescaped value.
    
    Parameters:
    parameter - an escaped parameter
    value - an unsanitzied escaped value
  - addSanitizedEntry
```
protected void addSanitizedEntry(String parameter,
                     String value)
```
    Record a sanitized parameter-value pair. Override if you want to do additional filtering or validation.
    
    Parameters:
    parameter - an unescaped parameter
    value - a sanitized unescaped value
  - getValueSanitizer
```
public UrlQuerySanitizer.ValueSanitizer getValueSanitizer(String parameter)
```
    Get the value sanitizer for a parameter. Returns null if there is no value sanitizer registered for the parameter.
    
    Parameters:
    parameter - the unescaped parameter
    
    Returns:
    the currently registered value sanitizer for this parameter.
    See Also:
    registerParameter(String, android.net.UrlQuerySanitizer.ValueSanitizer)
  - getEffectiveValueSanitizer
```
public UrlQuerySanitizer.ValueSanitizer getEffectiveValueSanitizer(String parameter)
```
    Get the effective value sanitizer for a parameter. Like getValueSanitizer, except if there is no value sanitizer registered for a parameter, and unregistered paramaters are allowed, then the default value sanitizer is returned.
    
    Parameters:
    parameter - an unescaped parameter
    
    Returns:
    the effective value sanitizer for a parameter.
  - unescape
```
public String unescape(String string)
```
    Unescape an escaped string.
    - '+' characters are replaced by ' ' characters.
    - Valid "%xx" escape sequences are replaced by the corresponding unescaped character.
    - Invalid escape sequences such as %1z", are passed through unchanged.
    Parameters:
    string - the escaped string
    
    Returns:
    the unescaped string.
  - isHexDigit
```
protected boolean isHexDigit(char c)
```
    Test if a character is a hexidecimal digit. Both upper case and lower case hex digits are allowed.
    
    Parameters:
    c - the character to test
    
    Returns:
    true if c is a hex digit.
  - decodeHexDigit
```
protected int decodeHexDigit(char c)
```
    Convert a character that represents a hexidecimal digit into an integer. If the character is not a hexidecimal digit, then -1 is returned. Both upper case and lower case hex digits are allowed.
    
    Parameters:
    c - the hexidecimal digit.
    
    Returns:
    the integer value of the hexidecimal digit.
  - clear
```
protected void clear()
```
    Clear the existing entries. Called to get ready to parse a new query string.

Content

Android Reference

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary

License.

All information of this service is derived from the free sources and is provided solely in the form of quotations. This service provides information and interfaces solely for the familiarization (not ownership) and under the "as is" condition.

IT. Expert System.

Android Reference

UrlQuerySanitizer

Class UrlQuerySanitizer

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UrlQuerySanitizer

UrlQuerySanitizer

Method Detail

getUnregisteredParameterValueSanitizer

setUnregisteredParameterValueSanitizer

getAllIllegal

getAllButNulLegal

getAllButWhitespaceLegal

getUrlLegal

getUrlAndSpaceLegal

getAmpLegal

getAmpAndSpaceLegal

getSpaceLegal

getAllButNulAndAngleBracketsLegal

parseUrl

parseQuery

getParameterSet

getParameterList

hasParameter

getValue

registerParameter

registerParameters

setAllowUnregisteredParamaters

getAllowUnregisteredParamaters

setPreferFirstRepeatedParameter

getPreferFirstRepeatedParameter

parseEntry

addSanitizedEntry

getValueSanitizer

getEffectiveValueSanitizer

unescape

isHexDigit

decodeHexDigit

clear

Android Reference

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary