Package org.eclipse.rdf4j.http.protocol
Class Protocol
- java.lang.Object
-
- org.eclipse.rdf4j.http.protocol.Protocol
-
public abstract class Protocol extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classProtocol.ActionDefines the action a particular transaction update is executing.static classProtocol.TIMEOUTDeprecated.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringACCEPT_PARAM_NAMEParameter name for the Accept parameter (may also be used as the name of the Accept HTTP header).static java.lang.StringACTION_PARAM_NAMEParameter name for the action parameter used in transactions.static java.lang.StringBASEURI_PARAM_NAMEParameter name for the base-URI parameter.static java.lang.StringBINDING_PREFIXParameter prefix for query-external variable bindings.static java.lang.StringCACHE_TIMEOUT_PROPERTYConfigurable system propertyrdf4j.server.txn.registry.timeoutfor specifying the transaction cache timeout (in seconds).static java.lang.StringCONFIGRelative location of the config resource.static java.lang.StringCONTEXT_PARAM_NAMEParameter name for the context parameter.static java.lang.StringCONTEXTSRelative location of the context list resource of a repository.static java.lang.StringDEFAULT_GRAPH_PARAM_NAMEParameter name for the default graph URI parameter.static intDEFAULT_TIMEOUTDefault timeout setting for transaction cache entries (in seconds).static java.lang.StringDISTINCT_PARAM_NAMEParameter name for the distinct parameter.static java.lang.StringFORM_MIME_TYPEMIME type for www forms: application/x-www-form-urlencoded.static java.lang.StringGRAPH_PARAM_NAMEParameter name for the graph parameter.static java.lang.StringINCLUDE_INFERRED_PARAM_NAMEParameter name for the 'includeInferred' parameter.static java.lang.StringINSERT_GRAPH_PARAM_NAMEParameter name for the default insert graph URI parameter.static java.lang.StringISOLATION_LEVEL_PARAM_NAMEDeprecated.Usetransaction-setting__isolation-levelinstead.static java.lang.StringLIMIT_PARAM_NAMEstatic java.lang.StringNAMED_GRAPH_PARAM_NAMEParameter name for the named graph URI parameter.static java.lang.StringNAMESPACESRelative location of the namespaces list resource of a repository.static java.lang.StringNULL_PARAM_VALUEParameter value for the NULL context.static java.lang.StringOBJECT_PARAM_NAMEParameter name for the 'object' parameter of statement query.static java.lang.StringOFFSET_PARAM_NAMEstatic java.lang.StringPREDICATE_PARAM_NAMEParameter name for the 'predicate' parameter of a statement query.static java.lang.StringPRESERVE_BNODE_ID_PARAM_NAMEParameter for server instruction to preserve blank node ids when parsing request data.static java.lang.StringPROTOCOLRelative location of the protocol resource.static java.lang.StringQUERY_LANGUAGE_PARAM_NAMEParameter name for the query language parameter.static java.lang.StringQUERY_PARAM_NAMEParameter name for the query parameter.static java.lang.StringREMOVE_GRAPH_PARAM_NAMEParameter name for the default remove graph URI parameter.static java.lang.StringREPOSITORIESRelative location of the repository list resource.static java.lang.StringSIZERelative location of the 'size' resource of a repository.static java.lang.StringSPARQL_QUERY_MIME_TYPEMIME type for SPARQL update: application/sparql-query.static java.lang.StringSPARQL_UPDATE_MIME_TYPEMIME type for SPARQL update: application/sparql-update.static java.lang.StringSTATEMENTSRelative location of the statement list resource of a repository.static java.lang.StringSUBJECT_PARAM_NAMEParameter name for the 'subject' parameter of a statement query.static java.lang.StringTIMEOUT_PARAM_NAMEstatic java.lang.StringTRANSACTION_SETTINGS_PREFIXPrefix for transaction settings in the query paramstatic java.lang.StringTRANSACTIONSRelative location of the transaction resources of a repository.static java.lang.StringTXN_MIME_TYPEMIME type for transactions: application/x-rdftransaction.static java.lang.StringUPDATE_PARAM_NAMEParameter name for the update parameter.static java.lang.StringUSING_GRAPH_PARAM_NAMEParameter name for the default graph URI parameter for update.static java.lang.StringUSING_NAMED_GRAPH_PARAM_NAMEParameter name for the named graph URI parameter for update.static java.lang.StringVERSIONProtocol version.
-
Constructor Summary
Constructors Constructor Description Protocol()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static ResourcedecodeContext(java.lang.String encodedValue, ValueFactory valueFactory)Decode a previously encoded context Resource.static Resource[]decodeContexts(java.lang.String[] encodedValues, ValueFactory valueFactory)Decode previously encoded contexts.static ResourcedecodeResource(java.lang.String encodedValue, ValueFactory valueFactory)Decode a previously encoded Resource.static IRIdecodeURI(java.lang.String encodedValue, ValueFactory valueFactory)Decode a previously encoded URI.static ValuedecodeValue(java.lang.String encodedValue, ValueFactory valueFactory)Decode a previously encoded value.static java.lang.StringencodeContext(Resource context)Encodes a context resource for use in a URL.static java.lang.String[]encodeContexts(Resource... contexts)Encode context resources for use in a URL.static java.lang.StringencodeValue(Value value)Encodes a value in a canonical serialized string format, for use in a URL query parameter.static java.lang.StringgetConfigLocation(java.lang.String serverLocation)Get the location of the server configuration resource on the specified server.static java.lang.StringgetContextsLocation(java.lang.String repositoryLocation)Get the location of the contexts lists resource for a specific repository.static java.lang.StringgetNamespacePrefixLocation(java.lang.String repositoryLocation, java.lang.String prefix)Get the location of the namespace with the specified prefix for a specific repository on the specified server.static java.lang.StringgetNamespacesLocation(java.lang.String repositoryLocation)Get the location of the namespaces lists resource for a specific repository on the specified server.static java.lang.StringgetProtocolLocation(java.lang.String serverLocation)Get the location of the protocol resource on the specified server.static java.lang.StringgetRepositoriesLocation(java.lang.String serverLocation)Get the location of the repository list resource on the specified server.static java.lang.StringgetRepositoryConfigLocation(java.lang.String repositoryLocation)Get the location of the config of a specific repository resource.static java.lang.StringgetRepositoryID(java.lang.String repositoryLocation)Extracts the repository ID from the repository location.static java.lang.StringgetRepositoryLocation(java.lang.String serverLocation, java.lang.String repositoryID)Get the location of a specific repository resource on the specified server.private static java.lang.StringgetServerDir(java.lang.String serverLocation)static java.lang.StringgetServerLocation(java.lang.String repositoryLocation)Extracts the server location from the repository location.static java.lang.StringgetSizeLocation(java.lang.String repositoryLocation)Get the location of the 'size' resource for a specific repository on the specified server.static java.lang.StringgetStatementsLocation(java.lang.String repositoryLocation)Get the location of the statements resource for a specific repository.static java.lang.StringgetTransactionsLocation(java.lang.String repositoryLocation)Get the location of the transaction resources for a specific repository.
-
-
-
Field Detail
-
CACHE_TIMEOUT_PROPERTY
public static final java.lang.String CACHE_TIMEOUT_PROPERTY
Configurable system propertyrdf4j.server.txn.registry.timeoutfor specifying the transaction cache timeout (in seconds).- See Also:
- Constant Field Values
-
DEFAULT_TIMEOUT
public static final int DEFAULT_TIMEOUT
Default timeout setting for transaction cache entries (in seconds).- See Also:
- Constant Field Values
-
VERSION
public static final java.lang.String VERSION
Protocol version.- 12: since RDF4J 3.5.0
- 11: since RDF4J 3.3.0
- 10: since RDF4J 3.1.0
- 9: since RDF4J 3.0.0
- See Also:
- Constant Field Values
-
SUBJECT_PARAM_NAME
public static final java.lang.String SUBJECT_PARAM_NAME
Parameter name for the 'subject' parameter of a statement query.- See Also:
- Constant Field Values
-
PREDICATE_PARAM_NAME
public static final java.lang.String PREDICATE_PARAM_NAME
Parameter name for the 'predicate' parameter of a statement query.- See Also:
- Constant Field Values
-
OBJECT_PARAM_NAME
public static final java.lang.String OBJECT_PARAM_NAME
Parameter name for the 'object' parameter of statement query.- See Also:
- Constant Field Values
-
INCLUDE_INFERRED_PARAM_NAME
public static final java.lang.String INCLUDE_INFERRED_PARAM_NAME
Parameter name for the 'includeInferred' parameter.- See Also:
- Constant Field Values
-
CONTEXT_PARAM_NAME
public static final java.lang.String CONTEXT_PARAM_NAME
Parameter name for the context parameter.- See Also:
- Constant Field Values
-
NULL_PARAM_VALUE
public static final java.lang.String NULL_PARAM_VALUE
Parameter value for the NULL context.- See Also:
- Constant Field Values
-
GRAPH_PARAM_NAME
public static final java.lang.String GRAPH_PARAM_NAME
Parameter name for the graph parameter.- See Also:
- Constant Field Values
-
UPDATE_PARAM_NAME
public static final java.lang.String UPDATE_PARAM_NAME
Parameter name for the update parameter.- See Also:
- Constant Field Values
-
BASEURI_PARAM_NAME
public static final java.lang.String BASEURI_PARAM_NAME
Parameter name for the base-URI parameter.- See Also:
- Constant Field Values
-
QUERY_PARAM_NAME
public static final java.lang.String QUERY_PARAM_NAME
Parameter name for the query parameter.- See Also:
- Constant Field Values
-
LIMIT_PARAM_NAME
public static final java.lang.String LIMIT_PARAM_NAME
- See Also:
- Constant Field Values
-
OFFSET_PARAM_NAME
public static final java.lang.String OFFSET_PARAM_NAME
- See Also:
- Constant Field Values
-
QUERY_LANGUAGE_PARAM_NAME
public static final java.lang.String QUERY_LANGUAGE_PARAM_NAME
Parameter name for the query language parameter.- See Also:
- Constant Field Values
-
TIMEOUT_PARAM_NAME
public static final java.lang.String TIMEOUT_PARAM_NAME
- See Also:
- Constant Field Values
-
REMOVE_GRAPH_PARAM_NAME
public static final java.lang.String REMOVE_GRAPH_PARAM_NAME
Parameter name for the default remove graph URI parameter.- See Also:
- Constant Field Values
-
INSERT_GRAPH_PARAM_NAME
public static final java.lang.String INSERT_GRAPH_PARAM_NAME
Parameter name for the default insert graph URI parameter.- See Also:
- Constant Field Values
-
USING_GRAPH_PARAM_NAME
public static final java.lang.String USING_GRAPH_PARAM_NAME
Parameter name for the default graph URI parameter for update.- See Also:
- Constant Field Values
-
USING_NAMED_GRAPH_PARAM_NAME
public static final java.lang.String USING_NAMED_GRAPH_PARAM_NAME
Parameter name for the named graph URI parameter for update.- See Also:
- Constant Field Values
-
DEFAULT_GRAPH_PARAM_NAME
public static final java.lang.String DEFAULT_GRAPH_PARAM_NAME
Parameter name for the default graph URI parameter.- See Also:
- Constant Field Values
-
NAMED_GRAPH_PARAM_NAME
public static final java.lang.String NAMED_GRAPH_PARAM_NAME
Parameter name for the named graph URI parameter.- See Also:
- Constant Field Values
-
ACCEPT_PARAM_NAME
public static final java.lang.String ACCEPT_PARAM_NAME
Parameter name for the Accept parameter (may also be used as the name of the Accept HTTP header).- See Also:
- Constant Field Values
-
ISOLATION_LEVEL_PARAM_NAME
@Deprecated(since="3.3.0") public static final java.lang.String ISOLATION_LEVEL_PARAM_NAME
Deprecated.Usetransaction-setting__isolation-levelinstead.Parameter name for the isolation level used in transactions.- See Also:
TRANSACTION_SETTINGS_PREFIX, Constant Field Values
-
TRANSACTION_SETTINGS_PREFIX
public static final java.lang.String TRANSACTION_SETTINGS_PREFIX
Prefix for transaction settings in the query param- Since:
- 3.3.0
- See Also:
- Constant Field Values
-
ACTION_PARAM_NAME
public static final java.lang.String ACTION_PARAM_NAME
Parameter name for the action parameter used in transactions.- See Also:
- Constant Field Values
-
DISTINCT_PARAM_NAME
public static final java.lang.String DISTINCT_PARAM_NAME
Parameter name for the distinct parameter.- See Also:
- Constant Field Values
-
PROTOCOL
public static final java.lang.String PROTOCOL
Relative location of the protocol resource.- See Also:
- Constant Field Values
-
CONFIG
public static final java.lang.String CONFIG
Relative location of the config resource.- See Also:
- Constant Field Values
-
REPOSITORIES
public static final java.lang.String REPOSITORIES
Relative location of the repository list resource.- See Also:
- Constant Field Values
-
STATEMENTS
public static final java.lang.String STATEMENTS
Relative location of the statement list resource of a repository.- See Also:
- Constant Field Values
-
TRANSACTIONS
public static final java.lang.String TRANSACTIONS
Relative location of the transaction resources of a repository.- See Also:
- Constant Field Values
-
CONTEXTS
public static final java.lang.String CONTEXTS
Relative location of the context list resource of a repository.- See Also:
- Constant Field Values
-
NAMESPACES
public static final java.lang.String NAMESPACES
Relative location of the namespaces list resource of a repository.- See Also:
- Constant Field Values
-
BINDING_PREFIX
public static final java.lang.String BINDING_PREFIX
Parameter prefix for query-external variable bindings.- See Also:
- Constant Field Values
-
SIZE
public static final java.lang.String SIZE
Relative location of the 'size' resource of a repository.- See Also:
- Constant Field Values
-
TXN_MIME_TYPE
public static final java.lang.String TXN_MIME_TYPE
MIME type for transactions: application/x-rdftransaction.- See Also:
- Constant Field Values
-
FORM_MIME_TYPE
public static final java.lang.String FORM_MIME_TYPE
MIME type for www forms: application/x-www-form-urlencoded.- See Also:
- Constant Field Values
-
SPARQL_QUERY_MIME_TYPE
public static final java.lang.String SPARQL_QUERY_MIME_TYPE
MIME type for SPARQL update: application/sparql-query.- See Also:
- Constant Field Values
-
SPARQL_UPDATE_MIME_TYPE
public static final java.lang.String SPARQL_UPDATE_MIME_TYPE
MIME type for SPARQL update: application/sparql-update.- See Also:
- Constant Field Values
-
PRESERVE_BNODE_ID_PARAM_NAME
public static final java.lang.String PRESERVE_BNODE_ID_PARAM_NAME
Parameter for server instruction to preserve blank node ids when parsing request data.- See Also:
- Constant Field Values
-
-
Method Detail
-
getServerDir
private static java.lang.String getServerDir(java.lang.String serverLocation)
-
getProtocolLocation
public static final java.lang.String getProtocolLocation(java.lang.String serverLocation)
Get the location of the protocol resource on the specified server.- Parameters:
serverLocation- the base location of a server implementing this REST protocol.- Returns:
- the location of the protocol resource on the specified server
-
getConfigLocation
public static final java.lang.String getConfigLocation(java.lang.String serverLocation)
Get the location of the server configuration resource on the specified server.- Parameters:
serverLocation- the base location of a server implementing this REST protocol.- Returns:
- the location of the server configuration resource on the specified server
-
getRepositoriesLocation
public static final java.lang.String getRepositoriesLocation(java.lang.String serverLocation)
Get the location of the repository list resource on the specified server.- Parameters:
serverLocation- the base location of a server implementing this REST protocol.- Returns:
- the location of the repository list resource on the specified server
-
getRepositoryLocation
public static final java.lang.String getRepositoryLocation(java.lang.String serverLocation, java.lang.String repositoryID)Get the location of a specific repository resource on the specified server.- Parameters:
serverLocation- the base location of a server implementing this REST protocol.repositoryID- the ID of the repository- Returns:
- the location of a specific repository resource on the specified server
-
getRepositoryConfigLocation
public static final java.lang.String getRepositoryConfigLocation(java.lang.String repositoryLocation)
Get the location of the config of a specific repository resource.- Parameters:
repositoryLocation- the location of a repository implementing this REST protocol.- Returns:
- the location of the configuration resource for the specified repository
-
getStatementsLocation
public static final java.lang.String getStatementsLocation(java.lang.String repositoryLocation)
Get the location of the statements resource for a specific repository.- Parameters:
repositoryLocation- the location of a repository implementing this REST protocol.- Returns:
- the location of the statements resource for the specified repository
-
getTransactionsLocation
public static final java.lang.String getTransactionsLocation(java.lang.String repositoryLocation)
Get the location of the transaction resources for a specific repository.- Parameters:
repositoryLocation- the location of a repository implementing this REST protocol.- Returns:
- the location of the transaction resources for the specified repository
-
getServerLocation
public static final java.lang.String getServerLocation(java.lang.String repositoryLocation)
Extracts the server location from the repository location.- Parameters:
repositoryLocation- the location of a repository implementing this REST protocol.- Returns:
- the location of the server resource for the specified repository.
-
getRepositoryID
public static final java.lang.String getRepositoryID(java.lang.String repositoryLocation)
Extracts the repository ID from the repository location.- Parameters:
repositoryLocation- the location of a repository implementing this REST protocol.- Returns:
- the ID of the repository.
-
getContextsLocation
public static final java.lang.String getContextsLocation(java.lang.String repositoryLocation)
Get the location of the contexts lists resource for a specific repository.- Parameters:
repositoryLocation- the location of a repository implementing this REST protocol.- Returns:
- the location of the contexts lists resource for the specified repository
-
getNamespacesLocation
public static final java.lang.String getNamespacesLocation(java.lang.String repositoryLocation)
Get the location of the namespaces lists resource for a specific repository on the specified server.- Parameters:
repositoryLocation- the base location of a server implementing this REST protocol.- Returns:
- the location of the namespaces lists resource for a specific repository on the specified server
-
getNamespacePrefixLocation
public static final java.lang.String getNamespacePrefixLocation(java.lang.String repositoryLocation, java.lang.String prefix)Get the location of the namespace with the specified prefix for a specific repository on the specified server.- Parameters:
repositoryLocation- the location of a repository implementing this REST protocol.prefix- the namespace prefix- Returns:
- the location of the the namespace with the specified prefix for a specific repository on the specified server
-
getSizeLocation
public static final java.lang.String getSizeLocation(java.lang.String repositoryLocation)
Get the location of the 'size' resource for a specific repository on the specified server.- Parameters:
repositoryLocation- the location of a repository implementing this REST protocol.- Returns:
- the location of the 'size' resource for a specific repository on the specified server
-
encodeValue
public static java.lang.String encodeValue(Value value)
Encodes a value in a canonical serialized string format, for use in a URL query parameter.- Parameters:
value- The value to encode, possibly null.- Returns:
- The protocol-serialized representation of the supplied value, or
NULL_PARAM_VALUEif the supplied value was null.
-
decodeValue
public static Value decodeValue(java.lang.String encodedValue, ValueFactory valueFactory)
Decode a previously encoded value.- Parameters:
encodedValue- the encoded valuevalueFactory- the factory to use for constructing the Value- Returns:
- the decoded Value
- See Also:
encodeValue(Value)
-
decodeResource
public static Resource decodeResource(java.lang.String encodedValue, ValueFactory valueFactory)
Decode a previously encoded Resource.- Parameters:
encodedValue- the encoded valuevalueFactory- the factory to use for constructing the Resource- Returns:
- the decoded Resource
- See Also:
encodeValue(Value)
-
decodeURI
public static IRI decodeURI(java.lang.String encodedValue, ValueFactory valueFactory)
Decode a previously encoded URI.- Parameters:
encodedValue- the encoded valuevalueFactory- the factory to use for constructing the URI- Returns:
- the decoded URI
- See Also:
encodeValue(Value)
-
encodeContext
public static java.lang.String encodeContext(Resource context)
Encodes a context resource for use in a URL.- Parameters:
context- The context to encode, possibly null.- Returns:
- The protocol-serialized representation of the supplied context, or
NULL_PARAM_VALUEif the supplied value was null.
-
decodeContext
public static Resource decodeContext(java.lang.String encodedValue, ValueFactory valueFactory)
Decode a previously encoded context Resource.- Parameters:
encodedValue- the encoded valuevalueFactory- the factory to use for constructing the Resource- Returns:
- the decoded Resource, or null if the encoded values was null or equal to
NULL_PARAM_VALUE
-
encodeContexts
public static java.lang.String[] encodeContexts(Resource... contexts)
Encode context resources for use in a URL.- Parameters:
contexts- the contexts to encode, must not be null.- Returns:
- the encoded contexts
- Throws:
java.lang.IllegalArgumentException- If the contexts is null.
-
decodeContexts
public static Resource[] decodeContexts(java.lang.String[] encodedValues, ValueFactory valueFactory)
Decode previously encoded contexts.- Parameters:
encodedValues- the encoded valuesvalueFactory- the factory to use for constructing the Resources- Returns:
- the decoded Resources, or an empty array if the supplied encodedValues was null.
-
-