Please wait. This can take some minutes ...
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.glassfish.jersey.client.JerseyInvocation Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2011-2012 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.
*/
package org.glassfish.jersey.client;
import java.lang.reflect.Type;
import java.net.URI;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.concurrent.Future;
import javax.ws.rs.BadRequestException;
import javax.ws.rs.ClientErrorException;
import javax.ws.rs.InternalServerErrorException;
import javax.ws.rs.NotAcceptableException;
import javax.ws.rs.NotAllowedException;
import javax.ws.rs.NotAuthorizedException;
import javax.ws.rs.NotFoundException;
import javax.ws.rs.NotSupportedException;
import javax.ws.rs.RedirectionException;
import javax.ws.rs.ServerErrorException;
import javax.ws.rs.ServiceUnavailableException;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.client.ClientException;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.Invocation;
import javax.ws.rs.client.InvocationCallback;
import javax.ws.rs.core.CacheControl;
import javax.ws.rs.core.Cookie;
import javax.ws.rs.core.GenericType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;
import org.glassfish.jersey.client.internal.LocalizationMessages;
import org.glassfish.jersey.internal.MapPropertiesDelegate;
import org.glassfish.jersey.internal.util.Producer;
import org.glassfish.jersey.internal.util.ReflectionHelper;
import org.glassfish.jersey.process.internal.RequestScope;
import com.google.common.util.concurrent.SettableFuture;
/**
* Jersey implementation of {@link javax.ws.rs.client.Invocation JAX-RS client-side
* request invocation} contract.
*
* @author Marek Potociar (marek.potociar at oracle.com)
*/
public class JerseyInvocation implements javax.ws.rs.client.Invocation {
private final ClientRequest requestContext;
private JerseyInvocation(Builder builder) {
validateHttpMethodAndEntity(builder.requestContext);
this.requestContext = new ClientRequest(builder.requestContext);
}
private enum EntityPresence {
MUST_BE_NULL,
MUST_BE_PRESENT,
OPTIONAL;
}
private static Map METHODS = initializeMap();
private static Map initializeMap() {
Map map = new HashMap();
map.put("DELETE", EntityPresence.MUST_BE_NULL);
map.put("GET", EntityPresence.MUST_BE_NULL);
map.put("HEAD", EntityPresence.MUST_BE_NULL);
map.put("OPTIONS", EntityPresence.MUST_BE_NULL);
map.put("POST", EntityPresence.OPTIONAL); // we allow to post null instead of entity
map.put("PUT", EntityPresence.MUST_BE_PRESENT);
map.put("TRACE", EntityPresence.MUST_BE_NULL);
return map;
}
private void validateHttpMethodAndEntity(ClientRequest request) {
final String method = request.getMethod();
final EntityPresence entityPresence = METHODS.get(method.toUpperCase());
if (entityPresence == EntityPresence.MUST_BE_NULL && request.hasEntity()) {
throw new IllegalStateException(LocalizationMessages.ERROR_HTTP_METHOD_ENTITY_NOT_NULL(method));
} else if (entityPresence == EntityPresence.MUST_BE_PRESENT && !request.hasEntity()) {
throw new IllegalStateException(LocalizationMessages.ERROR_HTTP_METHOD_ENTITY_NULL(method));
}
}
/**
* Jersey-specific {@link javax.ws.rs.client.Invocation.Builder client invocation builder}.
*/
public static class Builder implements javax.ws.rs.client.Invocation.Builder {
private final ClientRequest requestContext;
/**
* Create new Jersey-specific client invocation builder.
*
* @param uri invoked request URI.
* @param configuration Jersey client configuration.
*/
protected Builder(URI uri, ClientConfig configuration) {
this.requestContext = new ClientRequest(uri, configuration, new MapPropertiesDelegate());
}
/**
* Returns a reference to the mutable request context to be invoked.
*
* @return mutable request context to be invoked.
*/
ClientRequest request() {
return requestContext;
}
private void storeEntity(Entity> entity) {
if (entity != null) {
requestContext.variant(entity.getVariant());
requestContext.setEntity(entity.getEntity());
}
}
@Override
public JerseyInvocation build(String method) {
requestContext.setMethod(method);
return new JerseyInvocation(this);
}
@Override
public JerseyInvocation build(String method, Entity> entity) {
requestContext.setMethod(method);
storeEntity(entity);
return new JerseyInvocation(this);
}
@Override
public JerseyInvocation buildGet() {
requestContext.setMethod("GET");
return new JerseyInvocation(this);
}
@Override
public JerseyInvocation buildDelete() {
requestContext.setMethod("DELETE");
return new JerseyInvocation(this);
}
@Override
public JerseyInvocation buildPost(Entity> entity) {
requestContext.setMethod("POST");
storeEntity(entity);
return new JerseyInvocation(this);
}
@Override
public JerseyInvocation buildPut(Entity> entity) {
requestContext.setMethod("PUT");
storeEntity(entity);
return new JerseyInvocation(this);
}
@Override
public javax.ws.rs.client.AsyncInvoker async() {
return new AsyncInvoker(this);
}
@Override
public Builder acceptLanguage(Locale... locales) {
requestContext.acceptLanguage(locales);
return this;
}
@Override
public Builder acceptLanguage(String... locales) {
requestContext.acceptLanguage(locales);
return this;
}
@Override
public Builder cookie(Cookie cookie) {
requestContext.cookie(cookie);
return this;
}
@Override
public Invocation.Builder cookie(String name, String value) {
requestContext.cookie(new Cookie(name, value));
return this;
}
@Override
public Builder cacheControl(CacheControl cacheControl) {
requestContext.cacheControl(cacheControl);
return this;
}
@Override
public Builder header(String name, Object value) {
requestContext.getHeaders().add(name, value);
return this;
}
@Override
public Invocation.Builder headers(MultivaluedMap headers) {
requestContext.replaceHeaders(headers);
return this;
}
@Override
public ClientConfig configuration() {
return requestContext.getConfiguration();
}
@Override
public Response get() throws ClientException {
return method("GET");
}
@Override
public T get(Class responseType) throws ClientException, WebApplicationException {
return method("GET", responseType);
}
@Override
public T get(GenericType responseType) throws ClientException, WebApplicationException {
return method("GET", responseType);
}
@Override
public Response put(Entity> entity) throws ClientException {
return method("PUT", entity);
}
@Override
public T put(Entity> entity, Class responseType) throws ClientException, WebApplicationException {
return method("PUT", entity, responseType);
}
@Override
public T put(Entity> entity, GenericType responseType) throws ClientException, WebApplicationException {
return method("PUT", entity, responseType);
}
@Override
public Response post(Entity> entity) throws ClientException {
return method("POST", entity);
}
@Override
public T post(Entity> entity, Class responseType) throws ClientException, WebApplicationException {
return method("POST", entity, responseType);
}
@Override
public T post(Entity> entity, GenericType responseType) throws ClientException, WebApplicationException {
return method("POST", entity, responseType);
}
@Override
public Response delete() throws ClientException {
return method("DELETE");
}
@Override
public T delete(Class responseType) throws ClientException, WebApplicationException {
return method("DELETE", responseType);
}
@Override
public T delete(GenericType responseType) throws ClientException, WebApplicationException {
return method("DELETE", responseType);
}
@Override
public Response head() throws ClientException {
return method("HEAD");
}
@Override
public Response options() throws ClientException {
return method("OPTIONS");
}
@Override
public T options(Class responseType) throws ClientException, WebApplicationException {
return method("OPTIONS", responseType);
}
@Override
public T options(GenericType responseType) throws ClientException, WebApplicationException {
return method("OPTIONS", responseType);
}
@Override
public Response trace() throws ClientException {
return method("TRACE");
}
@Override
public T trace(Class responseType) throws ClientException, WebApplicationException {
return method("TRACE", responseType);
}
@Override
public T trace(GenericType responseType) throws ClientException, WebApplicationException {
return method("TRACE", responseType);
}
@Override
public Response method(String name) throws ClientException {
requestContext.setMethod(name);
return new JerseyInvocation(this).invoke();
}
@Override
public T method(String name, Class responseType) throws ClientException, WebApplicationException {
requestContext.setMethod(name);
return new JerseyInvocation(this).invoke(responseType);
}
@Override
public T method(String name, GenericType responseType) throws ClientException, WebApplicationException {
requestContext.setMethod(name);
return new JerseyInvocation(this).invoke(responseType);
}
@Override
public Response method(String name, Entity> entity) throws ClientException {
requestContext.setMethod(name);
storeEntity(entity);
return new JerseyInvocation(this).invoke();
}
@Override
public T method(String name, Entity> entity, Class responseType)
throws ClientException, WebApplicationException {
requestContext.setMethod(name);
storeEntity(entity);
return new JerseyInvocation(this).invoke(responseType);
}
@Override
public T method(String name, Entity> entity, GenericType responseType)
throws ClientException, WebApplicationException {
requestContext.setMethod(name);
storeEntity(entity);
return new JerseyInvocation(this).invoke(responseType);
}
}
private static class AsyncInvoker implements javax.ws.rs.client.AsyncInvoker {
private final JerseyInvocation.Builder builder;
private AsyncInvoker(JerseyInvocation.Builder request) {
this.builder = request;
this.builder.requestContext.setAsynchronous(true);
}
@Override
public Future get() {
return method("GET");
}
@Override
public Future get(Class responseType) {
return method("GET", responseType);
}
@Override
public Future get(GenericType responseType) {
return method("GET", responseType);
}
@Override
public Future get(InvocationCallback callback) {
return method("GET", callback);
}
@Override
public Future put(Entity> entity) {
return method("PUT", entity);
}
@Override
public Future put(Entity> entity, Class responseType) {
return method("PUT", entity, responseType);
}
@Override
public Future put(Entity> entity, GenericType responseType) {
return method("PUT", entity, responseType);
}
@Override
public Future put(Entity> entity, InvocationCallback callback) {
return method("PUT", entity, callback);
}
@Override
public Future post(Entity> entity) {
return method("POST", entity);
}
@Override
public Future post(Entity> entity, Class responseType) {
return method("POST", entity, responseType);
}
@Override
public Future post(Entity> entity, GenericType responseType) {
return method("POST", entity, responseType);
}
@Override
public Future post(Entity> entity, InvocationCallback callback) {
return method("POST", entity, callback);
}
@Override
public Future delete() {
return method("DELETE");
}
@Override
public Future delete(Class responseType) {
return method("DELETE", responseType);
}
@Override
public Future delete(GenericType responseType) {
return method("DELETE", responseType);
}
@Override
public Future delete(InvocationCallback callback) {
return method("DELETE", callback);
}
@Override
public Future head() {
return method("HEAD");
}
@Override
public Future head(InvocationCallback callback) {
return method("HEAD", callback);
}
@Override
public Future options() {
return method("OPTIONS");
}
@Override
public Future options(Class responseType) {
return method("OPTIONS", responseType);
}
@Override
public Future options(GenericType responseType) {
return method("OPTIONS", responseType);
}
@Override
public Future options(InvocationCallback callback) {
return method("OPTIONS", callback);
}
@Override
public Future trace() {
return method("TRACE");
}
@Override
public Future trace(Class responseType) {
return method("TRACE", responseType);
}
@Override
public Future trace(GenericType responseType) {
return method("TRACE", responseType);
}
@Override
public Future trace(InvocationCallback callback) {
return method("TRACE", callback);
}
@Override
public Future method(String name) {
builder.requestContext.setMethod(name);
return new JerseyInvocation(builder).submit();
}
@Override
public Future method(String name, Class responseType) {
builder.requestContext.setMethod(name);
return new JerseyInvocation(builder).submit(responseType);
}
@Override
public Future method(String name, GenericType responseType) {
builder.requestContext.setMethod(name);
return new JerseyInvocation(builder).submit(responseType);
}
@Override
public Future method(String name, InvocationCallback callback) {
builder.requestContext.setMethod(name);
return new JerseyInvocation(builder).submit(callback);
}
@Override
public Future method(String name, Entity> entity) {
builder.requestContext.setMethod(name);
builder.storeEntity(entity);
return new JerseyInvocation(builder).submit();
}
@Override
public Future method(String name, Entity> entity, Class responseType) {
builder.requestContext.setMethod(name);
builder.storeEntity(entity);
return new JerseyInvocation(builder).submit(responseType);
}
@Override
public Future method(String name, Entity> entity, GenericType responseType) {
builder.requestContext.setMethod(name);
builder.storeEntity(entity);
return new JerseyInvocation(builder).submit(responseType);
}
@Override
public Future method(String name, Entity> entity, InvocationCallback callback) {
builder.requestContext.setMethod(name);
builder.storeEntity(entity);
return new JerseyInvocation(builder).submit(callback);
}
}
@Override
public Response invoke() throws ClientException, WebApplicationException {
final ClientRuntime runtime = configuration().getRuntime();
final RequestScope requestScope = runtime.getRequestScope();
return requestScope.runInScope(new Producer() {
@Override
public Response call() throws ClientException {
return new ScopedJaxrsResponse(runtime.invoke(requestContext), requestScope);
}
});
}
@Override
public T invoke(final Class responseType) throws ClientException, WebApplicationException {
final ClientRuntime runtime = configuration().getRuntime();
final RequestScope requestScope = runtime.getRequestScope();
return requestScope.runInScope(new Producer() {
@Override
public T call() throws ClientException {
try {
return translate(runtime.invoke(requestContext), requestScope, responseType);
} catch (ClientException ex) {
if (ex.getCause() instanceof WebApplicationException) {
throw (WebApplicationException) ex.getCause();
}
throw ex;
}
}
});
}
@Override
public T invoke(final GenericType responseType) throws ClientException, WebApplicationException {
final ClientRuntime runtime = configuration().getRuntime();
final RequestScope requestScope = runtime.getRequestScope();
return requestScope.runInScope(new Producer() {
@Override
public T call() throws ClientException {
try {
return translate(runtime.invoke(requestContext), requestScope, responseType);
} catch (ClientException ex) {
if (ex.getCause() instanceof WebApplicationException) {
throw (WebApplicationException) ex.getCause();
}
throw ex;
}
}
});
}
@Override
public Future submit() {
final SettableFuture responseFuture = SettableFuture.create();
configuration().getRuntime().submit(requestContext, new ResponseCallback() {
@Override
public void completed(ClientResponse response, RequestScope scope) {
responseFuture.set(new ScopedJaxrsResponse(response, scope));
}
@Override
public void failed(ClientException error) {
responseFuture.setException(error);
}
});
return responseFuture;
}
@Override
public Future submit(final Class responseType) {
final SettableFuture responseFuture = SettableFuture.create();
configuration().getRuntime().submit(requestContext, new ResponseCallback() {
@Override
public void completed(ClientResponse response, RequestScope scope) {
try {
responseFuture.set(translate(response, scope, responseType));
} catch (ClientException ex) {
failed(ex);
}
}
@Override
public void failed(ClientException error) {
if (error.getCause() instanceof WebApplicationException) {
responseFuture.setException(error.getCause());
} else {
responseFuture.setException(error);
}
}
});
return responseFuture;
}
private T translate(ClientResponse response, RequestScope scope, Class responseType)
throws ClientException {
if (responseType == Response.class) {
return responseType.cast(new ScopedJaxrsResponse(response, scope));
}
if (response.getStatusInfo().getFamily() == Response.Status.Family.SUCCESSFUL) {
try {
return new InboundJaxrsResponse(response).readEntity(responseType);
} catch (ClientException ex) {
throw ex;
} catch (WebApplicationException ex) {
throw new ClientException(ex);
} catch (Exception ex) {
throw new ClientException(LocalizationMessages.UNEXPECTED_ERROR_RESPONSE_PROCESSING(), ex);
}
} else {
throw convertToException(new ScopedJaxrsResponse(response, scope));
}
}
@Override
public Future submit(final GenericType responseType) {
final SettableFuture responseFuture = SettableFuture.create();
configuration().getRuntime().submit(requestContext, new ResponseCallback() {
@Override
public void completed(ClientResponse response, RequestScope scope) {
try {
responseFuture.set(translate(response, scope, responseType));
} catch (ClientException ex) {
failed(ex);
}
}
@Override
public void failed(ClientException error) {
if (error.getCause() instanceof WebApplicationException) {
responseFuture.setException(error.getCause());
} else {
responseFuture.setException(error);
}
}
});
return responseFuture;
}
private T translate(ClientResponse response, RequestScope scope, GenericType responseType)
throws ClientException {
if (response.getStatusInfo().getFamily() == Response.Status.Family.SUCCESSFUL) {
try {
return new InboundJaxrsResponse(response).readEntity(responseType);
} catch (ClientException ex) {
throw ex;
} catch (WebApplicationException ex) {
throw new ClientException(ex);
} catch (Exception ex) {
throw new ClientException(LocalizationMessages.UNEXPECTED_ERROR_RESPONSE_PROCESSING(), ex);
}
} else {
throw convertToException(new ScopedJaxrsResponse(response, scope));
}
}
@Override
public Future submit(final InvocationCallback callback) {
final SettableFuture responseFuture = SettableFuture.create();
try {
ReflectionHelper.DeclaringClassInterfacePair pair =
ReflectionHelper.getClass(callback.getClass(), InvocationCallback.class);
final Type callbackParamType = ReflectionHelper.getParameterizedTypeArguments(pair)[0];
final Class callbackParamClass = ReflectionHelper.erasure(callbackParamType);
final ResponseCallback responseCallback = new ResponseCallback() {
@Override
public void completed(ClientResponse response, RequestScope scope) {
final T result;
if (callbackParamClass == Response.class) {
result = callbackParamClass.cast(new ScopedJaxrsResponse(response, scope));
responseFuture.set(result);
callback.completed(result);
} else if (response.getStatusInfo().getFamily() == Response.Status.Family.SUCCESSFUL) {
result = new InboundJaxrsResponse(response).readEntity(new GenericType(callbackParamType));
responseFuture.set(result);
callback.completed(result);
} else {
failed(convertToException(new ScopedJaxrsResponse(response, scope)));
}
}
@Override
public void failed(ClientException error) {
try {
if (error.getCause() instanceof WebApplicationException) {
responseFuture.setException(error.getCause());
} else {
responseFuture.setException(error);
}
} finally {
callback.failed(error);
}
}
};
configuration().getRuntime().submit(requestContext, responseCallback);
} catch (Throwable error) {
ClientException ce;
if (error instanceof ClientException) {
ce = (ClientException) error;
responseFuture.setException(ce);
} else if (error instanceof WebApplicationException) {
ce = new ClientException(error);
responseFuture.setException(error);
} else {
ce = new ClientException(error);
responseFuture.setException(ce);
}
callback.failed(ce);
}
return responseFuture;
}
private ClientException convertToException(Response response) {
try {
WebApplicationException webAppException;
final int statusCode = response.getStatus();
switch (Response.Status.fromStatusCode(statusCode)) {
case BAD_REQUEST:
webAppException = new BadRequestException(response);
break;
case UNAUTHORIZED:
webAppException = new NotAuthorizedException(response);
break;
case NOT_FOUND:
webAppException = new NotFoundException(response);
break;
case METHOD_NOT_ALLOWED:
webAppException = new NotAllowedException(response);
break;
case NOT_ACCEPTABLE:
webAppException = new NotAcceptableException(response);
break;
case UNSUPPORTED_MEDIA_TYPE:
webAppException = new NotSupportedException(response);
break;
case INTERNAL_SERVER_ERROR:
webAppException = new InternalServerErrorException(response);
break;
case SERVICE_UNAVAILABLE:
webAppException = new ServiceUnavailableException(response);
break;
default:
switch (response.getStatusInfo().getFamily()) {
case REDIRECTION:
webAppException = new RedirectionException(response);
break;
case CLIENT_ERROR:
webAppException = new ClientErrorException(response);
break;
case SERVER_ERROR:
webAppException = new ServerErrorException(response);
break;
default:
webAppException = new WebApplicationException(response);
}
}
return new ClientException(webAppException);
} catch (Throwable t) {
return new ClientException(LocalizationMessages.RESPONSE_TO_EXCEPTION_CONVERSION_FAILED(), t);
}
}
@Override
public ClientConfig configuration() {
return requestContext.getConfiguration();
}
/**
* Returns a reference to the mutable request context to be invoked.
*
* @return mutable request context to be invoked.
*/
ClientRequest request() {
return requestContext;
}
}