Servertec

Utils

Documentation

Conventions

Command Line

Java API

AccessLogEntry

DString

ErrorLogEntry

EventLogEntry

iws

Logger

ServletManager

Utils

Servlet API

Servlets

Config Files

Classes

Directory Tree

Return

java.lang.Object
 |
 +--stec.net.Utils

public final class Utils

Includes methods for encoding/decoding URLs, encoding/parsing/extracting cookies, parsing character set and getting arguments.

Methods

Method	Description
concatPaths	Concatenates two path strings.
concatURIs	Concatenates two URI strings.
encodeCookie	Converts the given Cookie into a string.
extractCookie	Returns the named Cookie from the given array of Cookies.
getArgs	Returns any arguments sent with the request.
getItem	Used to read the specified item.
getParameters	Returns any parameters sent with the request.
load	Used to read and parse the specified configuration file.
parseCharacterEncoding	Returns the character set using the given content type.
parseCookieHeader	Returns an array of Cookies using the given cookie header.
readLine	Reads a line from the specified input stream to the given byte buffer starting at the specified offset, up to the given given number of bytes.

concatPaths

Concatenates two path strings.

Syntax

public final static String concatPaths(String path1, String path2)

Parameters

path1	the first path.
path2	the second path.

Returns

String

the resultant path.

Throws

Nothing

Example

String path = Utils.concatPaths(basedir, filepath);

concatURIs

Concatenates two URI strings.

Syntax

public final static String concatURIs(String uri1, String uri2)

Parameters

uri1	the first URI.
uri2	the second URI.

Returns

String

the resultant URI.

Throws

Nothing

Example

String uri = Utils.concatURIs(baseuri, uri);

encodeCookie

Converts the given Cookie into a string.

Syntax

public final static String encodeCookie(Cookie cookie)

Parameters

the Cookie to encode.

Returns

String

the encoded Cookie.

Throws

Nothing

Example

String sCookie = Utils.encodeCookie(cookie);

extractCookie

Returns the named Cookie from the given array of Cookies.

Syntax

public final static Cookie extractCookie(Cookie[] cookies, String name)

Parameters

cookies	the array of cookies to use.
name	the name of the cookie to extract.

Returns

the associated Cookie, null if not found.

Throws

Nothing

Example

Cookie cookie = Utils.extractCookie(cookies, key);

getArgs

Returns any arguments sent with request. Arguments are found before any parameters.

Syntax

public final static String getArgs(HttpServletRequest request)

Parameters

request

the client's request.

Returns

String

any arguments, null if none found.

Throws

Nothing

Example

String args = Utils.getArgs(request);

getItem

Used to read the specified item.

Syntax

public final static String getItem(String filename) throws IOException
public final static String getItem(InputStream input_stream) throws IOException

Parameters

filename	the name of the item to read.
input_stream	an InputStream to the item to read.

Returns

String

the file read.

Throws

IOException

Thrown when any IO error occurs.

Notes

Reads items relative to Servertec Internet Server's base directory.

Example

String item = Utils.getItem(filename);

getParameters

Returns any parameters sent with request. Parameters are found after any arguments.

Syntax

public final static String getParameters(HttpServletRequest request)

Parameters

request

the client's request.

Returns

String

any parameters, null if none found.

Throws

Nothing

Example

String params = Utils.getParameters(request);

load

Used to read and parse the specified configuration file.

Syntax

public final static Hashtable load(String filename) throws IOException

Parameters

filename

the name of the configuration file to read.

Returns

Hashtable

contains key,value pairs.

Throws

IOException

Thrown when any IO error occurs.

Notes

Reads configuration files relative to Servertec Internet Server's base directory.

Example

Hashtable servlets = Utils.getItem("/config/servlets.ini");

parseCharacterEncoding

Returns the character set using the given content type.

Syntax

public final static String parseCharacterEncoding(String contentType)

Parameters

contentType

the content type.

Returns

String

the character set, if charset is not found then ISO-8859-1 is used.

Throws

Nothing

Example

String charset = Utils.parseCharacterEncoding(contentType);

parseCookieHeader

Returns an array of Cookies using the given cookie header.

Syntax

public final static Cookie[] parseCookieHeader(String header)

Parameters

header

the cookie header.

Returns

Cookie[]

an array of Cookies.

Throws

Nothing

Example

Cookie[] cookies = Utils.parseCookieHeader(header);

readLine

Reads a line from the specified input stream to the given byte buffer starting at the specified offset, up to the given given number of bytes.

Syntax

public final static int readLine(byte[] buffer,
                                 int offset,
                                 int length)
                                 throws IOException

Parameters

buffer	the byte array that the line will be read into.
offset	the starting index.
length	the maximum number of bytes to read.

Returns

int	the number of bytes read, -1 if end of stream.

Throws

IOException.

Thrown if an input exception occurred.

Example

int bytesRead = Utils.readLine(buffer, 0, buffer.length);

top of page