com.bigdata.rdf.sail.webapp

Class ConnegUtil

java.lang.Object

com.bigdata.rdf.sail.webapp.ConnegUtil

public class ConnegUtil
extends Object

Helper class for content negotiation.

Author:

Bryan Thompson

Constructor Summary

Constructors

Constructor and Description
ConnegUtil(String acceptStr)

Method Summary

Methods

Modifier and Type	Method and Description
org.openrdf.query.resultio.BooleanQueryResultFormat	getBooleanQueryResultFormat() Return the best BooleanQueryResultFormat from the Accept header, where "best" is measured by the q parameter.
org.openrdf.query.resultio.BooleanQueryResultFormat	getBooleanQueryResultFormat(org.openrdf.query.resultio.BooleanQueryResultFormat fallback) Return the best BooleanQueryResultFormat from the Accept header, where "best" is measured by the q parameter.
CounterSetFormat	getCounterSetFormat() Return the best CounterSetFormat from the Accept header, where "best" is measured by the q parameter.
CounterSetFormat	getCounterSetFormat(CounterSetFormat fallback) Return the best RDCountersFormatFFormat from the Accept header, where "best" is measured by the q parameter.
static String	getMimeTypeForQueryParameterQueryRequest(String outputFormat, String... acceptHeaders) A utility method to check for a format string query parameter and update the mimetype for sending back results.
static String	getMimeTypeForQueryParameterServiceRequest(String outputFormat, String acceptHeader) A utility method to check for a format string query parameter and update the mimetype for sending back results.
PropertiesFormat	getPropertiesFormat() Return the best PropertiesFormat from the Accept header, where "best" is measured by the q parameter.
PropertiesFormat	getPropertiesFormat(PropertiesFormat fallback) Return the best PropertiesFormat from the Accept header, where "best" is measured by the q parameter.
org.openrdf.rio.RDFFormat	getRDFFormat() Return the best RDFFormat from the Accept header, where "best" is measured by the q parameter.
org.openrdf.rio.RDFFormat	getRDFFormat(org.openrdf.rio.RDFFormat fallback) Return the best RDFFormat from the Accept header, where "best" is measured by the q parameter.
<E> ConnegScore<E>[]	getScores(Class<E> cls) Return an ordered list of the ConnegScores for MIME Types which are consistent with the desired format type.
org.openrdf.query.resultio.TupleQueryResultFormat	getTupleQueryResultFormat() Return the best TupleQueryResultFormat from the Accept header, where "best" is measured by the q parameter.
org.openrdf.query.resultio.TupleQueryResultFormat	getTupleQueryResultFormat(org.openrdf.query.resultio.TupleQueryResultFormat fallback) Return the best TupleQueryResultFormat from the Accept header, where "best" is measured by the q parameter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnegUtil

public ConnegUtil(String acceptStr)

Parameters:

acceptStr - The Accept header.

Method Detail

getMimeTypeForQueryParameterQueryRequest

public static String getMimeTypeForQueryParameterQueryRequest(String outputFormat,
                                              String... acceptHeaders)

A utility method to check for a format string query parameter and update the mimetype for sending back results. This is to enable the use of the ?format=json style of interaction. See Trac Ticket #984. Checks if a query parameter "out" has been passed to set the response type. If found, it maps to the requested Accept Header. It currently supports json, sparql-results+json, xml, and sparql-results+xml.

Parameters:

req -

Returns:

The value of the format string, if present or the Accept Header.

See Also:

http://trac.blazegraph.com/ticket/984

getMimeTypeForQueryParameterServiceRequest

public static String getMimeTypeForQueryParameterServiceRequest(String outputFormat,
                                                String acceptHeader)

A utility method to check for a format string query parameter and update the mimetype for sending back results. This is to enable the use of the ?format=json style of interaction. See Trac Ticket #984. Checks if a query parameter "out" has been passed to set the response type. If found, it maps to the requested Accept Header. It currently supports json and xml. This method should be used for general HTTP requests rather than Sparql query results. TODO: Support HTML, XML, and RDF

Parameters:

req -

Returns:

The value of the format string, if present or the Accept Header.

See Also:

http://trac.blazegraph.com/ticket/984

getRDFFormat

public org.openrdf.rio.RDFFormat getRDFFormat()

Return the best RDFFormat from the Accept header, where "best" is measured by the q parameter.

Returns:

The best RDFFormat -or- null if no RDFFormat was requested.

getRDFFormat

public org.openrdf.rio.RDFFormat getRDFFormat(org.openrdf.rio.RDFFormat fallback)

Return the best RDFFormat from the Accept header, where "best" is measured by the q parameter.

Parameters:

fallback - The caller's default, which is returned if no match was specified.

Returns:

The best RDFFormat -or- fallback if no RDFFormat was requested.

getTupleQueryResultFormat

public org.openrdf.query.resultio.TupleQueryResultFormat getTupleQueryResultFormat()

Return the best TupleQueryResultFormat from the Accept header, where "best" is measured by the q parameter.

Returns:

The best TupleQueryResultFormat -or- null if no TupleQueryResultFormat was requested.

getTupleQueryResultFormat

public org.openrdf.query.resultio.TupleQueryResultFormat getTupleQueryResultFormat(org.openrdf.query.resultio.TupleQueryResultFormat fallback)

Return the best TupleQueryResultFormat from the Accept header, where "best" is measured by the q parameter.

Parameters:

fallback - The caller's default, which is returned if no match was specified.

Returns:

The best TupleQueryResultFormat -or- fallback if no TupleQueryResultFormat was requested.

getBooleanQueryResultFormat

public org.openrdf.query.resultio.BooleanQueryResultFormat getBooleanQueryResultFormat()

Return the best BooleanQueryResultFormat from the Accept header, where "best" is measured by the q parameter.

Returns:

The best BooleanQueryResultFormat -or- null if no BooleanQueryResultFormat was requested.

getBooleanQueryResultFormat

public org.openrdf.query.resultio.BooleanQueryResultFormat getBooleanQueryResultFormat(org.openrdf.query.resultio.BooleanQueryResultFormat fallback)

Return the best BooleanQueryResultFormat from the Accept header, where "best" is measured by the q parameter.

Parameters:

fallback - The caller's default, which is returned if no match was specified.

Returns:

The best BooleanQueryResultFormat -or- fallback if no BooleanQueryResultFormat was requested.

getPropertiesFormat

public PropertiesFormat getPropertiesFormat()

Return the best PropertiesFormat from the Accept header, where "best" is measured by the q parameter.

Returns:

The best PropertiesFormat -or- null if no PropertiesFormat was requested.

getPropertiesFormat

public PropertiesFormat getPropertiesFormat(PropertiesFormat fallback)

Return the best PropertiesFormat from the Accept header, where "best" is measured by the q parameter.

Parameters:

fallback - The caller's default, which is returned if no match was specified.

Returns:

The best PropertiesFormat -or- fallback if no PropertiesFormat was requested.

getCounterSetFormat

public CounterSetFormat getCounterSetFormat()

Return the best CounterSetFormat from the Accept header, where "best" is measured by the q parameter.

Returns:

The best CounterSetFormat -or- null if no CounterSetFormat was requested.

getCounterSetFormat

public CounterSetFormat getCounterSetFormat(CounterSetFormat fallback)

Return the best RDCountersFormatFFormat from the Accept header, where "best" is measured by the q parameter.

Parameters:

fallback - The caller's default, which is returned if no match was specified.

Returns:

The best CounterSetFormat -or- fallback if no CounterSetFormat was requested.

getScores

public <E> ConnegScore<E>[] getScores(Class<E> cls)

Return an ordered list of the ConnegScores for MIME Types which are consistent with the desired format type.

Parameters:

cls - The format type.

Returns:

The ordered list.

toString

public String toString()

Overrides:

toString in class Object