Module org.apache.jena.arq

Package org.apache.jena.http

Class HttpOp

java.lang.Object

org.apache.jena.http.HttpOp

public class HttpOp
extends Object

This is a collection of convenience operations for HTTP requests, mostly in support of RDF handling and common, basic use cases for HTTP. It is not comprehensive. For more complicated requirements of HTTP, then the application can use HttpClient directly.

Authentication can be handled by supplying a HttpClient which has been built with an Authenticator or for challenge response (basic and digest) see AuthEnv.

Operations throw HttpException when the response is not 2xx, except for "httpGetString" and "httpPostRtnString" which return null for a 404 response.

Also supported:

• GET and return a string
• GET and return a JSON structure

See Also:

• HttpRDF
• GSP

Method Summary

Modifier and Type	Method	Description
static void	httpDelete(String url)	DELETE
static void	httpDelete(HttpClient httpClient, String url)	DELETE
static TypedInputStream	httpGet(String url)	Perform an HTTP GET to a URL, with "Accept" header "*/*".
static TypedInputStream	httpGet(String url, String acceptHeader)	Perform an HTTP GET to a URL.
static TypedInputStream	httpGet(HttpClient httpClient, String url)	Perform an HTTP GET to a URL.
static TypedInputStream	httpGet(HttpClient httpClient, String url, String acceptHeader)	Perform an HTTP GET to a URL.
static void	httpGetDiscard(String url)	Perform an HTTP and discard the body.
static JsonValue	httpGetJson(String url)
static String	httpGetString(String url)	Perform an HTTP and return the body as a string, Return null for a "404 Not Found".
static String	httpGetString(String url, String acceptHeader)	Perform an HTTP and return the body as a string, Return null for a "404 Not Found".
static String	httpGetString(HttpClient httpClient, String url)	Perform an HTTP and return the body as a string.
static String	httpGetString(HttpClient httpClient, String url, String acceptHeader)	Perform an HTTP and return the body as a string.
static String	httpGetStringEx(String url)	Perform an HTTP and return the body as a string.
static String	httpHead(String url)	HEAD request, return the Content-Type (if any).
static String	httpHead(String url, String acceptHeader)	HEAD request, return the Content-Type (if any).
static String	httpHead(HttpClient httpClient, String url)	HEAD request, return the Content-Type (if any).
static String	httpHead(HttpClient httpClient, String url, String acceptHeader)	HEAD request, return the Content-Type (if any).
static String	httpOptions(String url)	OPTIONS.
static String	httpOptions(HttpClient httpClient, String url)	OPTIONS.
static void	httpPatch(String url, String contentType, HttpRequest.BodyPublisher body)	PATCH
static void	httpPatch(HttpClient httpClient, String url, String contentType, HttpRequest.BodyPublisher body)	PATCH
static void	httpPost(String url)	POST
static void	httpPost(String url, String contentType, String body)	POST to a URL with content=type and string.
static void	httpPost(String url, String contentType, HttpRequest.BodyPublisher body)	POST
static void	httpPost(HttpClient httpClient, String url, String contentType, HttpRequest.BodyPublisher body)	POST
static void	httpPostForm(String url, Params params)	POST params as a HTML form.
static TypedInputStream	httpPostForm(String url, Params params, String acceptString)	POST params as a HTML form.
static JsonValue	httpPostRtnJSON(String url)
static String	httpPostRtnString(String url)	POST (without a body) - like httpGetString but uses POST - expects a response.
static String	httpPostRtnString(HttpClient httpClient, String url)	POST (without a body) - like httpGetString but uses POST - expects a response.
static TypedInputStream	httpPostStream(String url)	POST - the application MUST close the InputStream.
static TypedInputStream	httpPostStream(String url, String acceptHeader)	POST - the application MUST close the InputStream.
static TypedInputStream	httpPostStream(String url, String contentType, String bodyContent)	POST - the application MUST close the InputStream.
static TypedInputStream	httpPostStream(String url, String contentType, HttpRequest.BodyPublisher bodyContent)	POST - the application MUST close the InputStream.
static TypedInputStream	httpPostStream(String url, String contentType, HttpRequest.BodyPublisher bodyContent, String acceptHeader)	POST - the application MUST close the InputStream.
static TypedInputStream	httpPostStream(HttpClient httpClient, String url)	POST - the application MUST close the InputStream.
static TypedInputStream	httpPostStream(HttpClient httpClient, String url, String acceptHeader)	POST - the application MUST close the InputStream.
static TypedInputStream	httpPostStream(HttpClient httpClient, String url, String contentType, HttpRequest.BodyPublisher bodyContent)	POST - the application MUST close the InputStream.
static TypedInputStream	httpPostStream(HttpClient httpClient, String url, String contentType, HttpRequest.BodyPublisher bodyContent, String acceptHeader)	POST - the application MUST close the InputStream.
static void	httpPut(String url, String contentType, HttpRequest.BodyPublisher body)	PUT
static void	httpPut(HttpClient httpClient, String url, String contentType, HttpRequest.BodyPublisher body)	PUT

Methods inherited from class java.lang.Object

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

Method Details

httpGetString

public static String httpGetString(String url)

Perform an HTTP and return the body as a string, Return null for a "404 Not Found".

httpGetStringEx

public static String httpGetStringEx(String url)
                              throws HttpException

Perform an HTTP and return the body as a string. Throws HttpException on all non-success HTTP status codes including 404, unlike httpGetString(String).

Throws:

HttpException

httpGetDiscard

public static void httpGetDiscard(String url)
                           throws HttpException

Perform an HTTP and discard the body. Only useful to use GET as a ping-like operation on a URL Throws HttpException on all non-success HTTP status codes.

Throws:

HttpException

httpGetString

public static String httpGetString(String url,
 String acceptHeader)

Perform an HTTP and return the body as a string, Return null for a "404 Not Found".

httpGetString

public static String httpGetString(HttpClient httpClient,
 String url)

Perform an HTTP and return the body as a string. Return null for a "404 Not Found".

httpGetString

public static String httpGetString(HttpClient httpClient,
 String url,
 String acceptHeader)

Perform an HTTP and return the body as a string. Return null for a "404 Not Found".

httpPostRtnString

public static String httpPostRtnString(String url)

POST (without a body) - like httpGetString but uses POST - expects a response. Return null for a "404 Not Found".

httpPostRtnString

public static String httpPostRtnString(HttpClient httpClient,
 String url)

POST (without a body) - like httpGetString but uses POST - expects a response. Return null for a "404 Not Found".

httpPostForm

public static void httpPostForm(String url,
 Params params)

POST params as a HTML form.

httpPostForm

public static TypedInputStream httpPostForm(String url,
 Params params,
 String acceptString)

POST params as a HTML form.

httpPostRtnJSON

public static JsonValue httpPostRtnJSON(String url)

httpGetJson

public static JsonValue httpGetJson(String url)

httpGet

public static TypedInputStream httpGet(String url)

Perform an HTTP GET to a URL, with "Accept" header "*/*". The application MUST close the InputStream.

httpGet

public static TypedInputStream httpGet(String url,
 String acceptHeader)

Perform an HTTP GET to a URL. The application MUST close the InputStream.

httpGet

public static TypedInputStream httpGet(HttpClient httpClient,
 String url)

Perform an HTTP GET to a URL. The application MUST close the InputStream.

httpGet

public static TypedInputStream httpGet(HttpClient httpClient,
 String url,
 String acceptHeader)

Perform an HTTP GET to a URL. The application MUST close the InputStream.

httpPost

public static void httpPost(String url)

POST

httpPost

public static void httpPost(String url,
 String contentType,
 HttpRequest.BodyPublisher body)

POST

See Also:

• HttpRequest.BodyPublishers
• HttpRequest.BodyPublishers.ofFile(java.nio.file.Path)
• HttpRequest.BodyPublishers.ofString(java.lang.String)

httpPost

public static void httpPost(String url,
 String contentType,
 String body)

POST to a URL with content=type and string.

httpPost

public static void httpPost(HttpClient httpClient,
 String url,
 String contentType,
 HttpRequest.BodyPublisher body)

POST

See Also:

• HttpRequest.BodyPublishers.ofFile(java.nio.file.Path)
• HttpRequest.BodyPublishers.ofString(java.lang.String)

httpPostStream

public static TypedInputStream httpPostStream(String url)

POST - the application MUST close the InputStream.

httpPostStream

public static TypedInputStream httpPostStream(String url,
 String acceptHeader)

POST - the application MUST close the InputStream.

httpPostStream

public static TypedInputStream httpPostStream(HttpClient httpClient,
 String url)

POST - the application MUST close the InputStream.

httpPostStream

public static TypedInputStream httpPostStream(HttpClient httpClient,
 String url,
 String acceptHeader)

POST - the application MUST close the InputStream.

httpPostStream

public static TypedInputStream httpPostStream(String url,
 String contentType,
 HttpRequest.BodyPublisher bodyContent)

POST - the application MUST close the InputStream.

httpPostStream

public static TypedInputStream httpPostStream(String url,
 String contentType,
 String bodyContent)

POST - the application MUST close the InputStream.

httpPostStream

public static TypedInputStream httpPostStream(String url,
 String contentType,
 HttpRequest.BodyPublisher bodyContent,
 String acceptHeader)

POST - the application MUST close the InputStream.

httpPostStream

public static TypedInputStream httpPostStream(HttpClient httpClient,
 String url,
 String contentType,
 HttpRequest.BodyPublisher bodyContent)

POST - the application MUST close the InputStream.

httpPostStream

public static TypedInputStream httpPostStream(HttpClient httpClient,
 String url,
 String contentType,
 HttpRequest.BodyPublisher bodyContent,
 String acceptHeader)

POST - the application MUST close the InputStream.

httpPut

public static void httpPut(String url,
 String contentType,
 HttpRequest.BodyPublisher body)

PUT

See Also:

• HttpRequest.BodyPublishers.ofFile(java.nio.file.Path)
• HttpRequest.BodyPublishers.ofString(java.lang.String)

httpPut

public static void httpPut(HttpClient httpClient,
 String url,
 String contentType,
 HttpRequest.BodyPublisher body)

PUT

See Also:

• HttpRequest.BodyPublishers.ofFile(java.nio.file.Path)
• HttpRequest.BodyPublishers.ofString(java.lang.String)

httpPatch

public static void httpPatch(String url,
 String contentType,
 HttpRequest.BodyPublisher body)

PATCH

See Also:

• HttpRequest.BodyPublishers.ofFile(java.nio.file.Path)
• HttpRequest.BodyPublishers.ofString(java.lang.String)

httpPatch

public static void httpPatch(HttpClient httpClient,
 String url,
 String contentType,
 HttpRequest.BodyPublisher body)

PATCH

See Also:

• HttpRequest.BodyPublishers
• HttpRequest.BodyPublishers.ofFile(java.nio.file.Path)
• HttpRequest.BodyPublishers.ofString(java.lang.String)

httpDelete

public static void httpDelete(String url)

DELETE

httpDelete

public static void httpDelete(HttpClient httpClient,
 String url)

DELETE

httpOptions

public static String httpOptions(String url)

OPTIONS. Returns the HTTP response "Allow" field string.

httpOptions

public static String httpOptions(HttpClient httpClient,
 String url)

OPTIONS. Returns the HTTP response "Allow" field string.

httpHead

public static String httpHead(String url)

HEAD request, return the Content-Type (if any). Return null for success (200) but no content type. Throw HttpException for any response that is not 2xx.

httpHead

public static String httpHead(HttpClient httpClient,
 String url)

HEAD request, return the Content-Type (if any). Return null for success (200) but no content type. Throw HttpException for any response that is not 2xx.

httpHead

public static String httpHead(String url,
 String acceptHeader)

HEAD request, return the Content-Type (if any). Return null for success (200) but no content type. Throw HttpException for any response that is not 2xx.

httpHead

public static String httpHead(HttpClient httpClient,
 String url,
 String acceptHeader)

HEAD request, return the Content-Type (if any). Return null for success (200) but no content type. Throw HttpException for any response that is not 2xx.