sk.baka.ambient.commons
Class IOUtils

java.lang.Object
  sk.baka.ambient.commons.IOUtils

public final class IOUtils
extends java.lang.Object

Contains IO and HTTP utility methods.

Author:

Martin Vysny

Nested Class Summary

static class

IOUtils.HttpRequest The http request

Method Summary

static void	cat(java.io.Reader r) Cat given reader to log.
static void	copy(java.io.InputStream in, java.io.OutputStream out, int bufferSize) Copies input stream to the output stream.
static java.lang.String	encodeURL(java.lang.String url) Encodes given URL as per URLEncoder.encode(String, String).
static java.lang.String	formatIP(int address) Formats IP address contained in an integer and returns it as a string.
static java.lang.String	getExt(java.lang.String name) Returns the extension of the file, starting with dot character.
static IOUtils.HttpRequest	parseRequest(java.lang.String request) Parses given HTTP request.
static void	parseXML(java.io.InputStream in, org.xml.sax.ContentHandler handler) Parses XML readable from given stream.
static java.lang.String	readLine(java.io.InputStream in) Reads a line from given stream.
static void	readRequest(java.io.InputStream in) Reads the request until an empty string is encountered.
static java.lang.String	removeTrailingSlash(java.lang.String name) Removes trailing slash from given file name.
static java.lang.String	stripExt(java.lang.String name) Strips extension from given name.
static void	writeHttpResponse(byte httpVer, int httpCode, boolean keepAlive, long size, java.lang.String resultMime, java.io.OutputStream out) Writes HTTP response.
static void	writeLine(java.io.OutputStream out) Writes an empty line to given stream.
static void	writeLine(java.lang.String string, java.io.OutputStream out) Writes a line to given stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

encodeURL

public static java.lang.String encodeURL(java.lang.String url)

Encodes given URL as per URLEncoder.encode(String, String). Uses UTF-8 encoding. Spaces are correctly represented as %20.

Parameters:

url - the URL to encode

Returns:

URL-friendly string.

parseXML

public static void parseXML(java.io.InputStream in,
                            org.xml.sax.ContentHandler handler)
                     throws java.io.IOException,
                            org.xml.sax.SAXException

Parses XML readable from given stream. Note that the parser is configured to be namespace-aware - Android bug prevents us to use non-namespace-aware parser.

Parameters:

in - the stream, always closed.

handler - handles XML events.

Throws:

org.xml.sax.SAXException - if parsing fails

java.io.IOException - if i/o error occurs

readLine

public static java.lang.String readLine(java.io.InputStream in)
                                 throws java.io.IOException

Reads a line from given stream. No charset decoding is performed - only ASCII characters are expected. The line is expected to be terminated by the \n character. All \r characters are ignored.

Parameters:

in - the stream to read from. This should be an BufferedInputStream implementation for performance reasons.

Returns:

the line. May return null on end-of-stream.

Throws:

java.io.IOException - if i/o error occurs.

writeLine

public static void writeLine(java.lang.String string,
                             java.io.OutputStream out)
                      throws java.io.IOException

Writes a line to given stream. No charset encoding is performed - only ASCII characters are expected. An additional \r\n characters will be written.

Parameters:

string - the string to write. It must consist of ASCII characters only.

out - the stream to write to.

Throws:

java.io.IOException - if i/o error occurs.

writeLine

public static void writeLine(java.io.OutputStream out)
                      throws java.io.IOException

Writes an empty line to given stream. An additional \r\n characters will be written.

Parameters:

out - the stream to write to.

Throws:

java.io.IOException - if i/o error occurs.

stripExt

public static java.lang.String stripExt(java.lang.String name)

Strips extension from given name. Does nothing if the file name does not have an extension.

Parameters:

name - the name to strip extension from

Returns:

stripped name.

copy

public static void copy(java.io.InputStream in,
                        java.io.OutputStream out,
                        int bufferSize)
                 throws java.io.IOException

Copies input stream to the output stream.

Parameters:

in - the input stream. Always closed.

out - the output stream. Always closed.

bufferSize - the buffer size in bytes

Throws:

java.io.IOException - thrown when i/o error occurs or when interrupted.

removeTrailingSlash

public static java.lang.String removeTrailingSlash(java.lang.String name)

Removes trailing slash from given file name.

Parameters:

name - the file name.

Returns:

file name without the trailing slash.

readRequest

public static void readRequest(java.io.InputStream in)
                        throws java.io.IOException

Reads the request until an empty string is encountered.

Parameters:

in - the stream to read from.

Throws:

java.io.IOException - if i/o error occurs.

parseRequest

public static IOUtils.HttpRequest parseRequest(java.lang.String request)
                                        throws ServerHttpException

Parses given HTTP request.

Parameters:

request - the request

Returns:

parsed request or null if the request is malformed.

Throws:

ServerHttpException - on HTTP error.

writeHttpResponse

public static void writeHttpResponse(byte httpVer,
                                     int httpCode,
                                     boolean keepAlive,
                                     long size,
                                     java.lang.String resultMime,
                                     java.io.OutputStream out)
                              throws java.io.IOException

Writes HTTP response. The response is not terminated by an empty line.

Parameters:

httpVer - the HTTP version, 0 or 1.

httpCode - the HTTP code.

keepAlive - if true then "keep-alive" is written. If false then "close" is written.

size - the size of the content. -1 if not known.

resultMime - response MIME type.

out - write the response here.

Throws:

java.io.IOException - if i/o error occurs

cat

public static void cat(java.io.Reader r)

Cat given reader to log.

Parameters:

r - the reader to cat.

formatIP

public static java.lang.String formatIP(int address)

Formats IP address contained in an integer and returns it as a string.

Parameters:

address - the IP to decode

Returns:

decoded IP.

getExt

public static java.lang.String getExt(java.lang.String name)

Returns the extension of the file, starting with dot character.

Parameters:

name - the file name to get the extension from.

Returns:

extension or empty string if the file does not have an extension.