org.apache.commons.httpclient

Class HttpConstants


public class HttpConstants
extends Object

HTTP content conversion routines.

Field Summary

static String
DEFAULT_CONTENT_CHARSET
Default content encoding chatset
static String
HTTP_ELEMENT_CHARSET
Character set used to encode HTTP protocol elements

Method Summary

static byte[]
getAsciiBytes(String data)
Converts the specified string to byte array of ASCII characters.
static String
getAsciiString(byte[] data)
Converts the byte array of ASCII characters to a string.
static String
getAsciiString(byte[] data, int offset, int length)
Converts the byte array of ASCII characters to a string.
static byte[]
getBytes(String data)
Converts the specified string to a byte array of HTTP element characters.
static byte[]
getContentBytes(String data)
Converts the specified string to a byte array of HTTP content characters using default HTTP content encoding (ISO-8859-1) This method is to be used when encoding content of HTTP request/response
static byte[]
getContentBytes(String data, String charset)
Converts the specified string to a byte array of HTTP content charachetrs This method is to be used when encoding content of HTTP request/response If the specified charset is not supported, default HTTP content encoding (ISO-8859-1) is applied
static String
getContentString(byte[] data)
Converts the byte array of HTTP content characters to a string using default HTTP content encoding (ISO-8859-1) This method is to be used when decoding content of HTTP request/response
static String
getContentString(byte[] data, int offset, int length)
Converts the byte array of HTTP content characters to a string using default HTTP content encoding (ISO-8859-1) This method is to be used when decoding content of HTTP request/response
static String
getContentString(byte[] data, int offset, int length, String charset)
Converts the byte array of HTTP content characters to a string This method is to be used when decoding content of HTTP request/response If the specified charset is not supported, default HTTP content encoding (ISO-8859-1) is applied
static String
getContentString(byte[] data, String charset)
Converts the byte array of HTTP content characters to a string This method is to be used when decoding content of HTTP request/response If the specified charset is not supported, default HTTP content encoding (ISO-8859-1) is applied
static String
getString(byte[] data)
Converts the byte array of HTTP element characters to a string This method is to be used when decoding content of HTTP elements (such as response headers)
static String
getString(byte[] data, int offset, int length)
Converts the byte array of HTTP element characters to a string This method is to be used when decoding content of HTTP elements (such as response headers)

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_CONTENT_CHARSET

public static final String DEFAULT_CONTENT_CHARSET
Default content encoding chatset
Field Value:
"ISO-8859-1"

HTTP_ELEMENT_CHARSET

public static final String HTTP_ELEMENT_CHARSET
Character set used to encode HTTP protocol elements
Field Value:
"US-ASCII"

Method Details

getAsciiBytes

public static byte[] getAsciiBytes(String data)
Converts the specified string to byte array of ASCII characters.
Parameters:
data - the string to be encoded
Returns:
The string as a byte array.

getAsciiString

public static String getAsciiString(byte[] data)
Converts the byte array of ASCII characters to a string. This method is to be used when decoding content of HTTP elements (such as response headers)
Parameters:
data - the byte array to be encoded
Returns:
The string representation of the byte array

getAsciiString

public static String getAsciiString(byte[] data,
                                    int offset,
                                    int length)
Converts the byte array of ASCII characters to a string. This method is to be used when decoding content of HTTP elements (such as response headers)
Parameters:
data - the byte array to be encoded
offset - the index of the first byte to encode
length - the number of bytes to encode
Returns:
The string representation of the byte array

getBytes

public static byte[] getBytes(String data)
Converts the specified string to a byte array of HTTP element characters. This method is to be used when encoding content of HTTP elements (such as request headers)
Parameters:
data - the string to be encoded
Returns:
The resulting byte array.

getContentBytes

public static byte[] getContentBytes(String data)
Converts the specified string to a byte array of HTTP content characters using default HTTP content encoding (ISO-8859-1) This method is to be used when encoding content of HTTP request/response
Parameters:
data - the string to be encoded
Returns:
The byte array as above.

getContentBytes

public static byte[] getContentBytes(String data,
                                     String charset)
Converts the specified string to a byte array of HTTP content charachetrs This method is to be used when encoding content of HTTP request/response If the specified charset is not supported, default HTTP content encoding (ISO-8859-1) is applied
Parameters:
data - the string to be encoded
charset - the desired character encoding
Returns:
The resulting byte array.

getContentString

public static String getContentString(byte[] data)
Converts the byte array of HTTP content characters to a string using default HTTP content encoding (ISO-8859-1) This method is to be used when decoding content of HTTP request/response
Parameters:
data - the byte array to be encoded
Returns:
The string representation of the byte array.

getContentString

public static String getContentString(byte[] data,
                                      int offset,
                                      int length)
Converts the byte array of HTTP content characters to a string using default HTTP content encoding (ISO-8859-1) This method is to be used when decoding content of HTTP request/response
Parameters:
data - the byte array to be encoded
offset - the index of the first byte to encode
length - the number of bytes to encode
Returns:
The string representation of the byte array.

getContentString

public static String getContentString(byte[] data,
                                      int offset,
                                      int length,
                                      String charset)
Converts the byte array of HTTP content characters to a string This method is to be used when decoding content of HTTP request/response If the specified charset is not supported, default HTTP content encoding (ISO-8859-1) is applied
Parameters:
data - the byte array to be encoded
offset - the index of the first byte to encode
length - the number of bytes to encode
charset - the desired character encoding
Returns:
The result of the conversion.

getContentString

public static String getContentString(byte[] data,
                                      String charset)
Converts the byte array of HTTP content characters to a string This method is to be used when decoding content of HTTP request/response If the specified charset is not supported, default HTTP content encoding (ISO-8859-1) is applied
Parameters:
data - the byte array to be encoded
charset - the desired character encoding
Returns:
The result of the conversion.

getString

public static String getString(byte[] data)
Converts the byte array of HTTP element characters to a string This method is to be used when decoding content of HTTP elements (such as response headers)
Parameters:
data - the byte array to be encoded
Returns:
The resulting string.

getString

public static String getString(byte[] data,
                               int offset,
                               int length)
Converts the byte array of HTTP element characters to a string This method is to be used when decoding content of HTTP elements (such as response headers)
Parameters:
data - the byte array to be encoded
offset - the index of the first byte to encode
length - the number of bytes to encode
Returns:
The resulting string.