46.3. Building the Client Invocation

Overview
링크 복사

After building the target URI, using the WebTarget builder class, the next step is to configure the other aspects of the request—such as HTTP headers, cookies, and so on—using the Invocation.Builder class. The final step in building the invocation is to invoke the appropriate HTTP verb (GET, POST, PUT, or DELETE) and provide a message body, if required.

Invocation.Builder class
링크 복사

The javax.ws.rs.client.Invocation.Builder builder class provides the part of the fluent API that enables you to build up the contents of the HTTP message and to invoke a HTTP method.

Create the invocation builder
링크 복사

To create an Invocation.Builder instance, invoke one of the request methods on a javax.ws.rs.client.WebTarget instance. For example:

// Java
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.client.Invocation.Builder;
...
WebTarget books = client.target("http://example.org/bookstore/books/123");
Invocation.Builder invbuilder = books.request();

// Java
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.client.Invocation.Builder;
...
WebTarget books = client.target("http://example.org/bookstore/books/123");
Invocation.Builder invbuilder = books.request();

Copy to Clipboard

Toggle word wrap

Define HTTP headers
링크 복사

You can add a HTTP header to the request message using the header method, as follows:

Invocation.Builder invheader = invbuilder.header("From", "fionn@example.org");

Invocation.Builder invheader = invbuilder.header("From", "fionn@example.org");

Copy to Clipboard

Toggle word wrap

Define cookies
링크 복사

You can add a cookie to the request message using the cookie method, as follows:

Invocation.Builder invcookie = invbuilder.cookie("myrestclient", "123xyz");

Invocation.Builder invcookie = invbuilder.cookie("myrestclient", "123xyz");

Copy to Clipboard

Toggle word wrap

Define properties
링크 복사

You can set a property in the context of this request using the property method, as follows:

Invocation.Builder invproperty = invbuilder.property("Name", "Value");

Invocation.Builder invproperty = invbuilder.property("Name", "Value");

Copy to Clipboard

Toggle word wrap

Define accepted media types, languages, or encodings
링크 복사

You can define accepted media types, languages, or encodings, as follows:

Invocation.Builder invmedia = invbuilder.accept("application/xml")
                                        .acceptLanguage("en-US")
                                        .acceptEncoding("gzip");

Invocation.Builder invmedia = invbuilder.accept("application/xml")
                                        .acceptLanguage("en-US")
                                        .acceptEncoding("gzip");

Copy to Clipboard

Toggle word wrap

Invoke HTTP method
링크 복사

The process of building a REST invocation is terminated by invoking a HTTP method, which performs the HTTP invocation. The following methods (inherited from the javax.ws.rs.client.SyncInvoker base class) can be invoked:

get
post
delete
put
head
trace
options

get
post
delete
put
head
trace
options

Copy to Clipboard

Toggle word wrap

If the specific HTTP verb you want to invoke is not on this list, you can use the generic method method to invoke any HTTP method.

Typed responses
링크 복사

All of the HTTP invocation methods are provided with an untyped variant and a typed variant (which takes an extra argument). If you invoke a request using the default get() method (taking no arguments), a javax.ws.rs.core.Response object is returned from the invocation. For example:

Response res = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml").get();

Response res = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml").get();

Copy to Clipboard

Toggle word wrap

It is also possible, however, to ask for the response to be returned as a specific type, using the get(Class<T>) method. For example, to invoke a request and ask for the response to be returned as a BookInfo object:

BookInfo res = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml").get(BookInfo.class);

BookInfo res = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml").get(BookInfo.class);

Copy to Clipboard

Toggle word wrap

In order for this to work, however, you must register a suitable entity provider with the Client instance, which is capable of mapping the response format, application/xml, to the requested type. For more details about entity providers, see Section 46.4, “Parsing Requests and Responses”.

Specifying the outgoing message in post or put
링크 복사

For HTTP methods that include a message body in the request (such as POST or PUT), you must specify the message body as the first argument of the method. The message body must be specified as a javax.ws.rs.client.Entity object, where the Entity encapsulates the message contents and its associated media type. For example, to invoke a POST method, where the message contents are provided as a String type:

import javax.ws.rs.client.Entity;
...
Response res = client.target("http://example.org/bookstore/registerbook")
                     .request("application/xml")
                     .put(Entity.entity("Red Hat Install Guide", "text/plain"));

import javax.ws.rs.client.Entity;
...
Response res = client.target("http://example.org/bookstore/registerbook")
                     .request("application/xml")
                     .put(Entity.entity("Red Hat Install Guide", "text/plain"));

Copy to Clipboard

Toggle word wrap

If necessary, the Entity.entity() constructor method will automatically map the supplied message instance to the specified media type, using the registered entity providers. It is always possible to specify the message body as a simple String type.

Delayed invocation
링크 복사

Instead of invoking the HTTP request right away (for example, by invoking the get() method), you have the option of creating an javax.ws.rs.client.Invocation object, which can be invoked at a later time. The Invocation object encapsulates all of the details of the pending invocation, including the HTTP method.

The following methods can be used to build an Invocation object:

buildGet
buildPost
buildDelete
buildPut
build

buildGet
buildPost
buildDelete
buildPut
build

Copy to Clipboard

Toggle word wrap

For example, to create a GET Invocation object and invoke it at a later time, you can use code like the following:

import javax.ws.rs.client.Invocation;
import javax.ws.rs.core.Response;
...
Invocation getBookInfo = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml").buildGet();
...
// Later on, in some other part of the application:
Response = getBookInfo.invoke();

import javax.ws.rs.client.Invocation;
import javax.ws.rs.core.Response;
...
Invocation getBookInfo = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml").buildGet();
...
// Later on, in some other part of the application:
Response = getBookInfo.invoke();

Copy to Clipboard

Toggle word wrap

Asynchronous invocation
링크 복사

The JAX-RS 2.0 client API supports asynchronous invocations on the client side. To make an asynchronous invocation, simply invoke the async() method in the chain of methods following request(). For example:

Future<Response> res = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml")
                     .async()
                     .get();

Future<Response> res = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml")
                     .async()
                     .get();

Copy to Clipboard

Toggle word wrap

When you make an asynchronous invocation, the returned value is a java.util.concurrent.Future object. For more details about asynchronous invocations, see Section 46.6, “Asynchronous Processing on the Client”.

이 콘텐츠는 선택한 언어로 제공되지 않습니다.

Overview
링크 복사

Invocation.Builder class
링크 복사

Create the invocation builder
링크 복사

Define HTTP headers
링크 복사

Define cookies
링크 복사

Define properties
링크 복사

Define accepted media types, languages, or encodings
링크 복사

Invoke HTTP method
링크 복사

Typed responses
링크 복사

Specifying the outgoing message in post or put
링크 복사

Delayed invocation
링크 복사

Asynchronous invocation
링크 복사

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat 소개

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

이 콘텐츠는 선택한 언어로 제공되지 않습니다.

46.3. Building the Client Invocation

Overview링크 복사링크가 클립보드에 복사되었습니다!

Invocation.Builder class링크 복사링크가 클립보드에 복사되었습니다!

Create the invocation builder링크 복사링크가 클립보드에 복사되었습니다!

Define HTTP headers링크 복사링크가 클립보드에 복사되었습니다!

Define cookies링크 복사링크가 클립보드에 복사되었습니다!

Define properties링크 복사링크가 클립보드에 복사되었습니다!

Define accepted media types, languages, or encodings링크 복사링크가 클립보드에 복사되었습니다!

Invoke HTTP method링크 복사링크가 클립보드에 복사되었습니다!

Typed responses링크 복사링크가 클립보드에 복사되었습니다!

Specifying the outgoing message in post or put링크 복사링크가 클립보드에 복사되었습니다!

Delayed invocation링크 복사링크가 클립보드에 복사되었습니다!

Asynchronous invocation링크 복사링크가 클립보드에 복사되었습니다!

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat 소개

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

Overview
링크 복사

Invocation.Builder class
링크 복사

Create the invocation builder
링크 복사

Define HTTP headers
링크 복사

Define cookies
링크 복사

Define properties
링크 복사

Define accepted media types, languages, or encodings
링크 복사

Invoke HTTP method
링크 복사

Typed responses
링크 복사

Specifying the outgoing message in post or put
링크 복사

Delayed invocation
링크 복사

Asynchronous invocation
링크 복사