org.glassfish.jersey.client.proxy.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jersey-proxy-client Show documentation

Jersey extension module providing support for (proxy-based) high-level client API.

There is a newer version: 4.0.0-M1

/*
 * Copyright (c) 2012, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

/**
 * This package defines a high-level (proxy-based) client API.
 * The API enables utilization of the server-side JAX-RS annotations
 * to describe the server-side resources and dynamically generate client-side
 * proxy objects for them.
 * 
 * Consider a server which exposes a resource at http://localhost:8080. The resource
 * can be described by the following interface:
 * 
 *
 *  * @Path("myresource")
 * public interface MyResourceIfc {
 *     @GET
 *     @Produces("text/plain")
 *     String get();
 *
 *     @POST
 *     @Consumes("application/xml")
 *     @Produces("application/xml")
 *     MyBean postEcho(MyBean bean);
 *
 *     @Path("{id}")
 *     @GET
 *     @Produces("text/plain")
 *     String getById(@PathParam("id") String id);
 * }
 * 
 *
 * 
 * You can use WebResourceFactory class defined
 * in this package to access the server-side resource using this interface.
 * Here is an example:
 * 
 *
 *  * Client client = ClientBuilder.newClient();
 * WebTarget target = client.target("http://localhost:8080/");
 * MyResourceIfc resource = WebResourceFactory.newResource(MyResourceIfc.class, target);
 *
 * String responseFromGet = resource.get();
 * MyBean responseFromPost = resource.postEcho(myBeanInstance);
 * String responseFromGetById = resource.getById("abc");
 * 
 */
package org.glassfish.jersey.client.proxy;