org.pageseeder.bridge.net

Class PSHTTPResource

java.lang.Object

org.pageseeder.bridge.net.PSHTTPResource

public final class PSHTTPResource
extends Object

Defines a resource to retrieve from PageSeeder.

Note: This class was initially forked from Bastille 0.8.29

Since:

0.2.0

Version:

0.2.27

Author:

Christophe Lauret

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PSHTTPResource.Builder A builder for this resource.

Constructor Summary

Constructors

Constructor and Description
PSHTTPResource(PSHTTPResourceType type, String name) Creates a new connection to the specified resource.

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(String name, String value) Add a parameter to this request.
String	body() Returns the body of the resource (used for PUT requests).
protected String	getPOSTFormURLEncodedContent() Returns the string to write the parameters sent via POST as application/x-www-form-urlencoded.
protected boolean	includeErrorContent() Indicates whether this resource should include the error content.
String	name() Returns the name of the resource to access.
protected Map<String,String>	parameters()
String	toString()
protected URL	toURL(PSCredentials credentials, boolean includePOSTParameters) Returns the URL to access this resource.
URL	toURL(PSSession session) Returns the URL to access this resource.
PSHTTPResourceType	type()

Methods inherited from class java.lang.Object

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

Constructor Detail

PSHTTPResource

public PSHTTPResource(PSHTTPResourceType type,
              String name)

Creates a new connection to the specified resource.

Parameters:

type - The type of resource.

name - The name of the resource to access (depends on the type of resource)

Method Detail

type

public PSHTTPResourceType type()

Returns:

The type of resource requested.

name

public String name()

Returns the name of the resource to access.

servlet

The full class name of the servlet (may include parameters)

service

The path name of the servlet (may include parameters)

resource

The full path of the resource (may include parameters)

Returns:

the name of the resource to access.

body

public String body()

Returns the body of the resource (used for PUT requests).

Returns:

the body of the resource.

addParameter

public void addParameter(String name,
                String value)

Add a parameter to this request.

Parameters:

name - The name of the parameter

value - The value of the parameter

includeErrorContent

protected boolean includeErrorContent()

Indicates whether this resource should include the error content.

Returns:

true to include the content of response even when the response code is greater than 400; false to only include the response when the response code is between 200 and 299.

toURL

public URL toURL(PSSession session)
          throws MalformedURLException

Returns the URL to access this resource.

If the user is specified, its details will be included in the URL so that the resource can be accessed on his behalf.

Parameters:

session - A PageSeeder session to access this resource.

Returns:

the URL to access this resource.

Throws:

MalformedURLException - If the URL is not well-formed

toString

public String toString()

Overrides:

toString in class Object

toURL

protected URL toURL(PSCredentials credentials,
        boolean includePOSTParameters)
             throws MalformedURLException

Returns the URL to access this resource.

If the user is specified, its details will be included in the URL so that the resource can be accessed on his behalf.

Parameters:

credentials - Authentication method to generate the URL

includePOSTParameters - Whether to include the parameters for POST requests.

Returns:

the URL to access this resource.

Throws:

MalformedURLException - If the URL is not well-formed

getPOSTFormURLEncodedContent

protected String getPOSTFormURLEncodedContent()

Returns the string to write the parameters sent via POST as application/x-www-form-urlencoded.

Returns:

the string to write the parameters sent via POST.

parameters

protected Map<String,String> parameters()

Returns:

the parameters used in this connector