sirius.kernel.xml

Class XMLCall

java.lang.Object

sirius.kernel.xml.XMLCall

public class XMLCall
extends Object

Simple call to send XML to a server (URL) and receive XML back.

Constructor Summary

Constructors

Constructor and Description
XMLCall()

Method Summary

Modifier and Type	Method and Description
XMLCall	addHeader(String name, String value) Adds a custom header field to the call
XMLStructuredInput	getInput() Provides access to the XML answer of the call.
Outcall	getOutcall() Returns the underlying Outcall.
XMLStructuredOutput	getOutput() Can be used to generate the XML request.
static XMLCall	to(URL url) Creates a new XMLCall for the given url with Content-Type 'text/xml'.
static XMLCall	to(URL url, String contentType) Creates a new XMLCall for the given url.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLCall

public XMLCall()

Method Detail

to

public static XMLCall to(URL url)
                  throws IOException

Creates a new XMLCall for the given url with Content-Type 'text/xml'.

Parameters:

url - the target URL to call

Returns:

an XMLCall which can be used to send and receive XML

Throws:

IOException - in case of an IO error

to

public static XMLCall to(URL url,
                         String contentType)
                  throws IOException

Creates a new XMLCall for the given url.

Parameters:

url - the target URL to call

contentType - the Content-Type to use

Returns:

a new instance to perform the xml call

Throws:

IOException - in case of an IO error

addHeader

public XMLCall addHeader(String name,
                         String value)

Adds a custom header field to the call

Parameters:

name - name of the field

value - value of the field

Returns:

returns the XML call itself for fluent method calls

getOutcall

public Outcall getOutcall()

Returns the underlying Outcall.

Returns:

the underlying outcall

getOutput

public XMLStructuredOutput getOutput()
                              throws IOException

Can be used to generate the XML request.

Returns:

the an input which can be used to generate an XML document which is sent to the URL

Throws:

IOException - in case of an IO error while sending the XML document

getInput

public XMLStructuredInput getInput()
                            throws IOException

Provides access to the XML answer of the call.

Returns:

the XML result of the call

Throws:

IOException - in case of an IO error while receiving the result