sirius.kernel.xml

Class Outcall

java.lang.Object

sirius.kernel.xml.Outcall

public class Outcall
extends Object

Used to call an URL and send or receive data.

This is basically a thin wrapper over HttpURLConnection which adds some boilder plate code and a bit of logging / monitoring.

Constructor Summary

Constructors

Constructor and Description
Outcall(URL url) Creates a new Outcall to the given URL.

Method Summary

Modifier and Type	Method and Description
Charset	getContentEncoding() Returns the charset used by the server to encode the response.
String	getData() Returns the result of the call as String.
String	getHeaderField(String name) Returns the response header with the given name.
InputStream	getInput() Provides access to the result of the call.
OutputStream	getOutput() Provides access to the input of the call.
Outcall	postData(Context params, Charset charset) Sents the given context as POST to the designated server.
void	setAuthParams(String user, String password) Sets the HTTP Authorization header.
void	setConnectTimeout(int timeoutMillis) Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by this outcall.
void	setCookie(String name, String value) Sets a HTTP cookie
void	setReadTimeout(int timeoutMillis) Sets the read timeout to a specified timeout, in milliseconds.
void	setRequestProperty(String name, String value) Sets the header of the HTTP call.

Methods inherited from class java.lang.Object

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

Constructor Detail

Outcall

public Outcall(URL url)
        throws IOException

Creates a new Outcall to the given URL.

Parameters:

url - the url to call

Throws:

IOException - in case of any IO error

Method Detail

postData

public Outcall postData(Context params,
                        Charset charset)
                 throws IOException

Sents the given context as POST to the designated server.

Parameters:

params - the data to POST

charset - the charset to use when encoding the post data

Returns:

the outcall itself for fluent method calls

Throws:

IOException - in case of any IO error

getInput

public InputStream getInput()
                     throws IOException

Provides access to the result of the call.

Once this method is called, the call will be started and data will be read.

Returns:

the stream returned by the call

Throws:

IOException - in case of any IO error

getOutput

public OutputStream getOutput()
                       throws IOException

Provides access to the input of the call.

Returns:

the stream of data sent to the call / url

Throws:

IOException - in case of any IO error

setRequestProperty

public void setRequestProperty(String name,
                               String value)

Sets the header of the HTTP call.

Parameters:

name - name of the header to set

value - value of the header to set

setAuthParams

public void setAuthParams(String user,
                          String password)
                   throws IOException

Sets the HTTP Authorization header.

Parameters:

user - the username to use

password - the password to use

Throws:

IOException - in case of any IO error

setConnectTimeout

public void setConnectTimeout(int timeoutMillis)

Sets a specified timeout value, in milliseconds, to be used when opening a communications link to the resource referenced by this outcall. If the timeout expires before the connection can be established, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout.

Parameters:

timeoutMillis - specifies the connect timeout value in milliseconds

setReadTimeout

public void setReadTimeout(int timeoutMillis)

Sets the read timeout to a specified timeout, in milliseconds. A non-zero value specifies the timeout when reading from Input stream when a connection is established to a resource. If the timeout expires before there is data available for read, a java.net.SocketTimeoutException is raised. A timeout of zero is interpreted as an infinite timeout.

Parameters:

timeoutMillis - specifies the timeout value to be used in milliseconds

getData

public String getData()
               throws IOException

Returns the result of the call as String.

Returns:

a String containing the complete result of the call

Throws:

IOException - in case of any IO error

getHeaderField

@Nullable
public String getHeaderField(String name)

Returns the response header with the given name.

Parameters:

name - the name of the header to fetch

Returns:

the value of the given header in the response or null if no header with this name was submitted.

getContentEncoding

public Charset getContentEncoding()

Returns the charset used by the server to encode the response.

Returns:

the charset used by the server or UTF-8 as default

setCookie

public void setCookie(String name,
                      String value)

Sets a HTTP cookie

Parameters:

name - name of the cookie

value - value of the cookie