com.bigdata.rdf.sail.webapp.client

Class AbstractConnectOptions

java.lang.Object

com.bigdata.rdf.sail.webapp.client.AbstractConnectOptions

All Implemented Interfaces:

IMimeTypes

Direct Known Subclasses:

ConnectOptions

public class AbstractConnectOptions
extends Object
implements IMimeTypes

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCEPT_HEADER The Request Header value
static String	DEFAULT_BOOLEAN_ACCEPT_HEADER Used for BooleanQueryResultFormat responses.
static String	DEFAULT_GRAPH_ACCEPT_HEADER Used for RDFFormat responses.
static String	DEFAULT_SOLUTIONS_ACCEPT_HEADER Used for TupleQueryResultFormat responses.
String	method The HTTP method (GET, POST, etc).
Map<String,String>	requestHeaders Optional request headers.
Map<String,String[]>	requestParams Request parameters to be formatted as URL query parameters.
String	serviceURL The URL of the remote REST service.
boolean	update When true, the request is a non-idempotent operation (an UPDATE request or some kind) and must be directed to the leader for HA.

Fields inherited from interface com.bigdata.rdf.sail.webapp.client.IMimeTypes

MIME_APPLICATION_JSON, MIME_APPLICATION_URL_ENCODED, MIME_APPLICATION_XML, MIME_DEFAULT_BINARY, MIME_GRAPH_ML, MIME_PROPERTIES_XML, MIME_TEXT_HTML, MIME_TEXT_JAVASCRIPT, MIME_TEXT_PLAIN

Constructor Summary

Constructors

Constructor and Description
AbstractConnectOptions(String serviceURL)

Method Summary

Methods

Modifier and Type	Method and Description
static void	addQueryParams(StringBuilder urlString, Map<String,String[]> requestParams) Add any URL query parameters (for a GET request).
void	addRequestParam(String name)
void	addRequestParam(String name, String val)
void	addRequestParam(String name, String[] vals)
String	getAcceptHeader()
static org.apache.http.HttpEntity	getFormEntity(Map<String,String[]> requestParams) Variant of addQueryParams(StringBuilder, Map) that returns an entity for a POST request.
String	getHeader(String name)
String	getRequestParam(String name)
void	setAcceptHeader(String value)
void	setHeader(String name, String val)
String	toString()
static String	urlEncode(String in) Apply a UTF8 encoding to a component of a URL.

Methods inherited from class java.lang.Object

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

Field Detail

serviceURL

public final String serviceURL

The URL of the remote REST service.

method

public String method

The HTTP method (GET, POST, etc).

ACCEPT_HEADER

public static final transient String ACCEPT_HEADER

The Request Header value

See Also:

Constant Field Values

update

public boolean update

When true, the request is a non-idempotent operation (an UPDATE request or some kind) and must be directed to the leader for HA. When false, the request is an idempotent operation and should be load balanced over the available service for HA. This option is ignored for non-HA requests.

DEFAULT_GRAPH_ACCEPT_HEADER

public static final String DEFAULT_GRAPH_ACCEPT_HEADER

Used for RDFFormat responses.

DEFAULT_SOLUTIONS_ACCEPT_HEADER

public static final String DEFAULT_SOLUTIONS_ACCEPT_HEADER

Used for TupleQueryResultFormat responses.

DEFAULT_BOOLEAN_ACCEPT_HEADER

public static final String DEFAULT_BOOLEAN_ACCEPT_HEADER

Used for BooleanQueryResultFormat responses.

requestParams

public Map<String,String[]> requestParams

Request parameters to be formatted as URL query parameters.

requestHeaders

public Map<String,String> requestHeaders

Optional request headers.

Constructor Detail

AbstractConnectOptions

public AbstractConnectOptions(String serviceURL)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

addRequestParam

public void addRequestParam(String name,
                   String[] vals)

addRequestParam

public void addRequestParam(String name,
                   String val)

addRequestParam

public void addRequestParam(String name)

getRequestParam

public String getRequestParam(String name)

setHeader

public void setHeader(String name,
             String val)

setAcceptHeader

public void setAcceptHeader(String value)

getAcceptHeader

public String getAcceptHeader()

getHeader

public String getHeader(String name)

addQueryParams

public static void addQueryParams(StringBuilder urlString,
                  Map<String,String[]> requestParams)
                           throws UnsupportedEncodingException

Add any URL query parameters (for a GET request).

Throws:

UnsupportedEncodingException

See Also:

(Extension REST API does not support multiple context values), getFormEntity(Map)

getFormEntity

public static org.apache.http.HttpEntity getFormEntity(Map<String,String[]> requestParams)
                                                throws Exception

Variant of addQueryParams(StringBuilder, Map) that returns an entity for a POST request.

Add query params to an IMimeTypes.MIME_APPLICATION_URL_ENCODED entity.

Throws:

Exception

See Also:

TODO Rename either this or {@link #addQueryParams(StringBuilder, Map)} to align the method names since they serve the same purpose but for GET vs POST.

urlEncode

public static String urlEncode(String in)

Apply a UTF8 encoding to a component of a URL.

Parameters:

in - The text to be encoded.

Returns:

The UTF8 encoding of that text.

Throws:

RuntimeException - if the RemoteRepositoryDecls.UTF8 encoding is not available.

NullPointerException - if the argument is null.