javax.ws.rs.client.package-info Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ehcache Show documentation
Show all versions of ehcache Show documentation
Ehcache is an open source, standards-based cache used to boost performance,
offload the database and simplify scalability. Ehcache is robust, proven and full-featured and
this has made it the most widely-used Java-based cache.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2011-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/**
* The JAX-RS client API
*
* The JAX-RS client API is a Java based API used to access Web resources.
* It is not restricted to resources implemented using JAX-RS.
* It provides a higher-level abstraction compared to a {@link java.net.HttpURLConnection
* plain HTTP communication API} as well as integration with the JAX-RS extension
* providers, in order to enable concise and efficient implementation of
* reusable client-side solutions that leverage existing and well
* established client-side implementations of HTTP-based communication.
*
* The JAX-RS Client API encapsulates the Uniform Interface Constraint –
* a key constraint of the REST architectural style – and associated data
* elements as client-side Java artifacts and supports a pluggable architecture
* by defining multiple extension points.
*
* Client API Bootstrapping and Configuration
* The main entry point to the API is a {@link javax.ws.rs.client.ClientBuilder}
* that is used to bootstrap {@link javax.ws.rs.client.Client} instances -
* {@link javax.ws.rs.core.Configurable configurable}, heavy-weight objects
* that manage the underlying communication infrastructure and serve as the root
* objects for accessing any Web resource. The following example illustrates the
* bootstrapping and configuration of a {@code Client} instance:
*
* Client client = ClientBuilder.newClient();
*
* client.property("MyProperty", "MyValue")
* .register(MyProvider.class)
* .enable(MyFeature.class);
*
*
* Accessing Web Resources
* A Web resource can be accessed using a fluent API in which method invocations
* are chained to configure and ultimately submit an HTTP request. The following
* example gets a {@code text/plain} representation of the resource identified by
* {@code "http://example.org/hello"}:
*
* Client client = ClientBuilder.newClient();
* Response res = client.target("http://example.org/hello").request("text/plain").get();
*
* Conceptually, the steps required to submit a request are the following:
*
* - obtain an {@link javax.ws.rs.client.Client} instance
* - create a {@link javax.ws.rs.client.WebTarget WebTarget} pointing at a Web resource
* - {@link javax.ws.rs.client.Invocation.Builder build} a request
* - submit a request to directly retrieve a response or get a prepared
* {@link javax.ws.rs.client.Invocation} for later submission
*
*
* As illustrated above, individual Web resources are in the JAX-RS Client API
* represented as resource targets. Each {@code WebTarget} instance is bound to a
* concrete URI, e.g. {@code "http://example.org/messages/123"},
* or a URI template, e.g. {@code "http://example.org/messages/{id}"}.
* That way a single target can either point at a particular resource or represent
* a larger group of resources (that e.g. share a common configuration) from which
* concrete resources can be later derived:
*
* // Parent target for all messages
* WebTarget messages = client.target("http://example.org/messages/{id}");
*
* WebTarget msg123 = messages.resolveTemplate("id", 123); // New target for http://example.org/messages/123
* WebTarget msg456 = messages.resolveTemplate("id", 456); // New target for http://example.org/messages/456
*
*
*Generic Invocations
* An {@link javax.ws.rs.client.Invocation} is a request that has been prepared
* and is ready for execution.
* Invocations provide a generic interface that enables a separation of concerns
* between the creator and the submitter. In particular, the submitter does not
* need to know how the invocation was prepared, but only whether it should be
* executed synchronously or asynchronously.
*
* Invocation inv1 = client.target("http://example.org/atm/balance")
* .queryParam("card", "111122223333").queryParam("pin", "9876")
* .request("text/plain").buildGet();
* Invocation inv2 = client.target("http://example.org/atm/withdrawal")
* .queryParam("card", "111122223333").queryParam("pin", "9876")
* .request().buildPost(text("50.0")));
*
* Collection invs = Arrays.asList(inv1, inv2);
* // Executed by the submitter
* Collection ress = Collections.transform(invs, new F() {
* public Response apply(Invocation inv) {return inv.invoke(); }
* });
*
*/
package javax.ws.rs.client;