org.pfsw.net.http

Class UserAgent

java.lang.Object

org.pfsw.net.http.UserAgent

public class UserAgent
extends java.lang.Object

A class that handles communication via HTTP for a client. That is, it executes requests and receives the corresponding responses.

Constructor Summary

Constructors

Constructor and Description
UserAgent()
UserAgent(java.net.Proxy proxy)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(java.lang.String name, java.lang.String value) Add a header value to the header with the given name.
protected void	applyRequestHeaders(java.net.HttpURLConnection connection, Headers headerDef)
protected void	applyUserAgent(java.net.HttpURLConnection connection)
protected boolean	canHaveContent(int responseCode)
int	getConnectTimeout()
java.lang.String	getHeader(java.lang.String name) Returns a single value (the first) of the header with the given name.
protected Headers	getHeaders()
protected Logger	getLogger()
java.net.Proxy	getProxy() Returns the user agent's proxy.
int	getReadTimeout()
java.lang.String	getUserAgentName()
boolean	hasProxy()
protected boolean	isSupposedToHaveContent(ServerResponse response)
protected java.net.HttpURLConnection	openHttpConnection(java.net.URL url)
void	removeHeader(java.lang.String name) Returns the header with the given name and all its associated values.
protected ServerResponse	retrieveResponse(java.net.HttpURLConnection connection, IResponseStreamHandler responseStreamHandler)
ServerResponse	sendRequest(ClientRequest request) Sends a request based on the given request definition and the user agent's own state.
ServerResponse	sendRequest(ClientRequest request, IResponseStreamHandler responseStreamHandler) Sends a request based on the given request definition and the user agent's own state.
protected void	sendRequestBody(java.net.HttpURLConnection connection, ClientRequest request)
void	setConnectTimeout(int connectTimeout)
void	setHeader(java.lang.String name, java.lang.String value) A a header with a single value.
void	setProxy(java.net.Proxy proxy) Sets the user agent's proxy.
void	setReadTimeout(int readTimeout)
void	setUserAgentName(java.lang.String userAgentName)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAgent

public UserAgent()

UserAgent

public UserAgent(java.net.Proxy proxy)

Method Detail

getProxy

public java.net.Proxy getProxy()

Returns the user agent's proxy. If null is provided, it means that the system property settings regarding HTTP proxy are respected.

setProxy

public void setProxy(java.net.Proxy proxy)

Sets the user agent's proxy. If null is provided, it means that the system property settings regarding HTTP proxy are respected.

addHeader

public void addHeader(java.lang.String name,
             java.lang.String value)

Add a header value to the header with the given name. If the header does not exist yet it will be created.

setHeader

public void setHeader(java.lang.String name,
             java.lang.String value)

A a header with a single value. If the header does not exist yet it will be created, otherwise its value(s) will be replaced by the given value.

getHeader

public java.lang.String getHeader(java.lang.String name)

Returns a single value (the first) of the header with the given name. If the header does not exist null will be returned.

removeHeader

public void removeHeader(java.lang.String name)

Returns the header with the given name and all its associated values.

sendRequest

public ServerResponse sendRequest(ClientRequest request)
                           throws java.io.IOException

Sends a request based on the given request definition and the user agent's own state.

Parameters:

request - The definition of the request to be sent (must not be null).

Returns:

A response object containing all data received from the server.

Throws:

java.io.IOException - Any problem during remote communication.

sendRequest

public ServerResponse sendRequest(ClientRequest request,
                         IResponseStreamHandler responseStreamHandler)
                           throws java.io.IOException

Sends a request based on the given request definition and the user agent's own state.

Parameters:

request - The definition of the request to be sent (must not be null).

responseStreamHandler - An optional (may be null) handler for the response stream. If provided the ServerResponse methods hasContentData(), getContentData(), getConentText(), getContentReader() must not be used anymore!

Returns:

A response object containing the data received from the server except maybe the content body if that was handled already by the given responseStreamHandler.

Throws:

java.io.IOException - Any problem during remote communication.

getReadTimeout

public int getReadTimeout()

setReadTimeout

public void setReadTimeout(int readTimeout)

getConnectTimeout

public int getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

getUserAgentName

public java.lang.String getUserAgentName()

setUserAgentName

public void setUserAgentName(java.lang.String userAgentName)

hasProxy

public boolean hasProxy()

openHttpConnection

protected java.net.HttpURLConnection openHttpConnection(java.net.URL url)
                                                 throws java.io.IOException

Throws:

java.io.IOException

sendRequestBody

protected void sendRequestBody(java.net.HttpURLConnection connection,
                   ClientRequest request)
                        throws java.io.IOException

Throws:

java.io.IOException

applyUserAgent

protected void applyUserAgent(java.net.HttpURLConnection connection)

applyRequestHeaders

protected void applyRequestHeaders(java.net.HttpURLConnection connection,
                       Headers headerDef)

retrieveResponse

protected ServerResponse retrieveResponse(java.net.HttpURLConnection connection,
                              IResponseStreamHandler responseStreamHandler)
                                   throws java.io.IOException

Throws:

java.io.IOException

isSupposedToHaveContent

protected boolean isSupposedToHaveContent(ServerResponse response)

canHaveContent

protected boolean canHaveContent(int responseCode)

getHeaders

protected Headers getHeaders()

getLogger

protected Logger getLogger()