org.pageseeder.bridge.net

Class PSHTTPConnection

java.lang.Object

org.pageseeder.bridge.net.PSHTTPConnection

public final class PSHTTPConnection
extends Object

Wraps an HTTP connection to PageSeeder.

Note: This class was initially forked from Bastille 0.8.29

Since:

0.2.0

Version:

0.3.32

Author:

Christophe Lauret

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PSHTTPConnection.Method Not strictly HTTP method as multipart request use a separate method.

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameterPart(String name, String value) Add a parameter as part of a multipart request.
void	addPart(File part) Add a part to the request from a file (write the contents directly to the stream).
void	addPart(InputStream in, String filename) Add a part to the request from input stream (write the contents directly to the stream).
void	addXMLPart(String part) Add a part to the request (write the contents directly to the stream).
void	addXMLPart(String part, Map<String,String> headers) Add a part to the request (write the contents directly to the stream).
void	closeOutput() Closes the output stream when writing to the connection.
protected static PSHTTPConnection	connect(PSHTTPResource resource, PSHTTPConnection.Method type, PSCredentials credentials) Create a PageSeeder connection for the specified URL and method.
HttpURLConnection	connection() Returns the underlying HTTP connection.
String	getContentType() Returns the content type of the underlying HTTP connection.
int	getResponseCode() Returns the response code of the underlying HTTP connection.
String	getResponseMessage() Returns the response message of the underlying HTTP connection.
PSSession	getSession() The session may have been updated after the connection was made.
PSHTTPConnection.Method	method() Returns the type of connection.
void	process(PSHTTPResponseInfo response, org.xml.sax.helpers.DefaultHandler handler) Process the specified PageSeeder connection.
void	process(PSHTTPResponseInfo response, OutputStream out) Process the specified PageSeeder connection.
void	process(PSHTTPResponseInfo response, org.pageseeder.xmlwriter.XMLWriter xml) Process the specified PageSeeder connection.
PSHTTPResponseInfo	process(PSHTTPResponseInfo response, org.pageseeder.xmlwriter.XMLWriter xml, Templates templates) Process the specified PageSeeder connection.
PSHTTPResponseInfo	process(PSHTTPResponseInfo response, org.pageseeder.xmlwriter.XMLWriter xml, Templates templates, Map<String,String> parameters) Process the specified PageSeeder connection.
PSHTTPResource	resource() Returns the PageSeeder resource corresponding to the URL.

Methods inherited from class java.lang.Object

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

Method Detail

addXMLPart

public void addXMLPart(String part)
                throws IOException

Add a part to the request (write the contents directly to the stream).

Parameters:

part - The encoding to specify in the Part's header

Throws:

IOException - Should any error occur while writing the part on the output

addXMLPart

public void addXMLPart(String part,
              Map<String,String> headers)
                throws IOException

Add a part to the request (write the contents directly to the stream).

Parameters:

part - The encoding to specify in the Part's header

headers - A list of headers added to this XML Part ('content-type' header is ignored)

Throws:

IOException - Should any error occur while writing

addPart

public void addPart(File part)
             throws IOException

Add a part to the request from a file (write the contents directly to the stream).

Parameters:

part - File for part

Throws:

IOException - Should any error occur while writing

addPart

public void addPart(InputStream in,
           String filename)
             throws IOException

Add a part to the request from input stream (write the contents directly to the stream).

Parameters:

in - Input stream for part content

filename - The filename for the part

Throws:

IOException - Should any error occur while writing

addParameterPart

public void addParameterPart(String name,
                    String value)
                      throws IOException

Add a parameter as part of a multipart request.

Parameters:

name - the name of the parameter

value - the value of the parameter

Throws:

IOException - Should any error occur while writing

closeOutput

public void closeOutput()
                 throws IOException

Closes the output stream when writing to the connection.

This method does nothing if the output stream hasn't been created.

Throws:

IOException - If thrown by the close method.

getResponseCode

public int getResponseCode()
                    throws IOException

Returns the response code of the underlying HTTP connection.

Returns:

the response code of the underlying HTTP connection.

Throws:

IOException - If thrown by the underlying HTTP connection.

See Also:

HttpURLConnection.getResponseCode()

getResponseMessage

public String getResponseMessage()
                          throws IOException

Returns the response message of the underlying HTTP connection.

Returns:

the response message of the underlying HTTP connection.

Throws:

IOException - If thrown by the underlying HTTP connection.

See Also:

HttpURLConnection.getResponseMessage()

getContentType

public String getContentType()
                      throws IOException

Returns the content type of the underlying HTTP connection.

Returns:

the content type of the underlying HTTP connection.

Throws:

IOException - If thrown by the underlying HTTP connection.

See Also:

URLConnection.getContentType()

connection

public HttpURLConnection connection()

Returns the underlying HTTP connection.

This method can be useful to perform additional operations on the connection which are not provided by this class.

Returns:

the underlying HTTP connection.

resource

public PSHTTPResource resource()

Returns the PageSeeder resource corresponding to the URL.

Returns:

the PageSeeder resource corresponding to the URL.

method

public PSHTTPConnection.Method method()

Returns the type of connection.

Returns:

the type of connection.

getSession

public PSSession getSession()

The session may have been updated after the connection was made.

Returns:

the session

process

public void process(PSHTTPResponseInfo response,
           OutputStream out)
             throws IOException

Process the specified PageSeeder connection.

Parameters:

response - the response info

out - where the output should be copied.

Throws:

IOException - If an error occurs when trying to write the XML.

process

public void process(PSHTTPResponseInfo response,
           org.xml.sax.helpers.DefaultHandler handler)
             throws IOException

Process the specified PageSeeder connection.

If the handler is not specified, the xml writer receives a copy of the PageSeeder XML.

Parameters:

response - the response info

handler - the handler for the XML (can be used to rewrite the XML)

Throws:

IOException - If an error occurs when trying to write the XML.

process

public void process(PSHTTPResponseInfo response,
           org.pageseeder.xmlwriter.XMLWriter xml)
             throws IOException

Process the specified PageSeeder connection.

The xml writer receives a copy of the PageSeeder XML.

Parameters:

response - The response object.

xml - The XML to copy from PageSeeder

Throws:

IOException - If an error occurs when trying to write the XML.

process

public PSHTTPResponseInfo process(PSHTTPResponseInfo response,
                         org.pageseeder.xmlwriter.XMLWriter xml,
                         Templates templates)
                           throws IOException

Process the specified PageSeeder connection.

Templates can be specified to transform the XML.

Parameters:

response - The PageSeeder response metadata to update

xml - The XML to copy from PageSeeder

templates - A set of templates to process the XML (optional)

Returns:

The updated response metadata.

Throws:

IOException - If an error occurs when trying to write the XML.

process

public PSHTTPResponseInfo process(PSHTTPResponseInfo response,
                         org.pageseeder.xmlwriter.XMLWriter xml,
                         Templates templates,
                         Map<String,String> parameters)
                           throws IOException

Process the specified PageSeeder connection.

Templates can be specified to transform the XML.

Parameters:

response - The PageSeeder response metadata to update

xml - The XML to copy from PageSeeder

templates - A set of templates to process the XML (optional)

parameters - Parameters to send to the XSLT transformer (optional)

Returns:

The updated response metadata.

Throws:

IOException - If an error occurs when trying to write the XML.

connect

protected static PSHTTPConnection connect(PSHTTPResource resource,
                       PSHTTPConnection.Method type,
                       PSCredentials credentials)
                                   throws IOException

Create a PageSeeder connection for the specified URL and method.

The connection is configured to:

• Follow redirects
• Be used for output
• Ignore cache by default

Parameters:

resource - The resource to connect to.

type - The type of connection.

credentials - The user login to use (optional).

Returns:

A newly opened connection to the specified URL

Throws:

IOException - Should an exception be returns while opening the connection