com.sun.jersey.api.client.AsyncUniformInterface Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2011 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 com.sun.jersey.api.client;
import com.sun.jersey.api.client.async.ITypeListener;
import java.util.concurrent.Future;
/**
* An asynchronous uniform interface for invoking HTTP requests.
*
*
* Any Java type for a response entity, that is supported by the client
* configuration of the client, may be declared using
* Class<T> where T is the Java type, or
* using {@link GenericType} where the generic parameter is the Java type.
*
* Any Java type instance for a request entity, that is supported by the client
* configuration of the client, can be passed. If generic information is
* required then an instance of {@link javax.ws.rs.core.GenericEntity} may
* be used.
*
* A type of {@link ClientResponse} declared for the response entity
* may be used to obtain the status, headers and response entity. If any other
* type is declared and the response status is greater than or equal to
* 300 then a {@link UniformInterfaceException} exception will be thrown, from
* which the {@link ClientResponse} instance can be accessed.
*
* @see com.sun.jersey.api.client
* @author [email protected]
*/
public interface AsyncUniformInterface {
/**
* Invoke the HEAD method.
*
* @return the HTTP response.
*/
Future head();
/**
* Invoke the HEAD method.
*
* @param l the listener to receive asynchronous callbacks.
* @return a future that may be used to wait until the future completes and
* obtain the client response state, or cancel the request.
*/
Future head(ITypeListener l);
/**
* Invoke the OPTIONS method.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* c is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param c the type of the returned response.
* @return an instance of type c.
*/
Future options(Class c);
/**
* Invoke the OPTIONS method.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* gt is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param gt the generic type of the returned response.
* @return an instance of type represented by the generic type.
*/
Future options(GenericType gt);
/**
* Invoke the OPTIONS method.
*
* @param the type of the response.
* @param l the listener to receive asynchronous callbacks.
* @return a future that may be used to wait until the future completes and
* obtain the client response state, or cancel the request.
*/
Future options(ITypeListener l);
/**
* Invoke the GET method.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* c is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param c the type of the returned response.
* @return an instance of type c.
*/
Future get(Class c) throws UniformInterfaceException;
/**
* Invoke the GET method.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* gt is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param gt the generic type of the returned response.
* @return an instance of type represented by the generic type.
*/
Future get(GenericType gt) throws UniformInterfaceException;
/**
* Invoke the GET method.
*
* @param the type of the response.
* @param l the listener to receive asynchronous callbacks.
* @return a future that may be used to wait until the future completes and
* obtain the client response state, or cancel the request.
*/
Future get(ITypeListener l);
/**
* Invoke the PUT method with no request entity or response.
*
* If the status of the HTTP response is less than 300 and a representation
* is present then that representation is ignored.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300.
*
* @return a void future.
*/
Future put();
/**
* Invoke the PUT method with a request entity but no response.
*
* If the status of the HTTP response is less than 300 and a representation
* is present then that representation is ignored.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300.
*
* @param requestEntity the request entity.
* @return a void future.
*/
Future put(Object requestEntity);
/**
* Invoke the PUT method with no request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* c is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param c the type of the returned response.
* @return an instance of type c.
*/
Future put(Class c);
/**
* Invoke the PUT method with a request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* gt is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param gt the generic type of the returned response.
* @return an instance of type represented by the generic type.
*/
Future put(GenericType gt);
/**
* Invoke the PUT method.
*
* @param the type of the response.
* @param l the listener to receive asynchronous callbacks.
* @return a future that may be used to wait until the future completes and
* obtain the client response state, or cancel the request.
*/
Future put(ITypeListener l);
/**
* Invoke the PUT method with a request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* c is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param c the type of the returned response.
* @param requestEntity the request entity.
* @return an instance of type c.
*/
Future put(Class c, Object requestEntity);
/**
* Invoke the PUT method with a request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* gt is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param gt the generic type of the returned response.
* @param requestEntity the request entity.
* @return an instance of type represented by the generic type.
*/
Future put(GenericType gt, Object requestEntity);
/**
* Invoke the PUT method.
*
* @param the type of the response.
* @param l the listener to receive asynchronous callbacks.
* @param requestEntity the request entity.
* @return a future that may be used to wait until the future completes and
* obtain the client response state, or cancel the request.
*/
Future put(ITypeListener l, Object requestEntity);
/**
* Invoke the POST method with no request entity or response.
*
* If the status of the HTTP response is less than 300 and a representation
* is present then that representation is ignored.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300.
*
* @return a void future.
*/
Future post();
/**
* Invoke the POST method with a request entity but no response.
*
* If the status of the HTTP response is less than 300 and a representation
* is present then that representation is ignored.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300.
*
* @return a void future.
* @param requestEntity the request entity.
*/
Future post(Object requestEntity);
/**
* Invoke the POST method with no request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* c is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param c the type of the returned response.
* @return an instance of type c.
*/
Future post(Class c);
/**
* Invoke the POST method with a request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* gt is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param gt the generic type of the returned response.
* @return an instance of type represented by the generic type.
*/
Future post(GenericType gt);
/**
* Invoke the POST method.
*
* @param the type of the response.
* @param l the listener to receive asynchronous callbacks.
* @return a future that may be used to wait until the future completes and
* obtain the client response state, or cancel the request.
*/
Future post(ITypeListener l);
/**
* Invoke the POST method with a request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* c is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param c the type of the returned response.
* @param requestEntity the request entity.
* @return an instance of type c.
*/
Future post(Class c, Object requestEntity);
/**
* Invoke the POST method with a request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* gt is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param gt the generic type of the returned response.
* @param requestEntity the request entity.
* @return an instance of type represented by the generic type.
*/
Future post(GenericType gt, Object requestEntity);
/**
* Invoke the POST method.
*
* @param the type of the response.
* @param l the listener to receive asynchronous callbacks.
* @param requestEntity the request entity.
* @return a future that may be used to wait until the future completes and
* obtain the client response state, or cancel the request.
*/
Future post(ITypeListener l, Object requestEntity);
/**
* Invoke the DELETE method with no request entity or response.
*
* If the status of the HTTP response is less than 300 and a representation
* is present then that representation is ignored.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300.
*
* @return a void future.
*/
Future delete();
/**
* Invoke the DELETE method with a request entity but no response.
*
* If the status of the HTTP response is less than 300 and a representation
* is present then that representation is ignored.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300.
*
* @return a void future.
* @param requestEntity the request entity.
*/
Future delete(Object requestEntity);
/**
* Invoke the DELETE method with no request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* c is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param c the type of the returned response.
* @return an instance of type c.
*/
Future delete(Class c);
/**
* Invoke the DELETE method with a request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* gt is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param gt the generic type of the returned response.
* @return an instance of type represented by the generic type.
*/
Future delete(GenericType gt);
/**
* Invoke the DELETE method.
*
* @param the type of the response.
* @param l the listener to receive asynchronous callbacks.
* @return a future that may be used to wait until the future completes and
* obtain the client response state, or cancel the request.
*/
Future delete(ITypeListener l);
/**
* Invoke the DELETE method with a request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* c is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param c the type of the returned response.
* @param requestEntity the request entity.
* @return an instance of type c.
*/
Future delete(Class c, Object requestEntity);
/**
* Invoke the DELETE method with a request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* gt is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param gt the generic type of the returned response.
* @param requestEntity the request entity.
* @return an instance of type represented by the generic type.
*/
Future delete(GenericType gt, Object requestEntity);
/**
* Invoke the DELETE method.
*
* @param the type of the response.
* @param l the listener to receive asynchronous callbacks.
* @param requestEntity the request entity.
* @return a future that may be used to wait until the future completes and
* obtain the client response state, or cancel the request.
*/
Future delete(ITypeListener l, Object requestEntity);
/**
* Invoke a HTTP method with no request entity or response.
*
* If the status of the HTTP response is less than 300 and a representation
* is present then that representation is ignored.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300.
*
* @return a void future.
* @param method the HTTP method.
*/
Future method(String method);
/**
* Invoke a HTTP method with a request entity but no response.
*
* If the status of the HTTP response is less than 300 and a representation
* is present then that representation is ignored.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300.
*
* @return a void future.
* @param method the HTTP method.
* @param requestEntity the request entity.
*/
Future method(String method, Object requestEntity);
/**
* Invoke a HTTP method with no request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* c is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param method the HTTP method.
* @param c the type of the returned response.
* @return an instance of type c.
*/
Future method(String method, Class c);
/**
* Invoke a HTTP method with no request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* gt is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param method the HTTP method.
* @param gt the generic type of the returned response.
* @return an instance of type represented by the generic type.
*/
Future method(String method, GenericType gt);
/**
* Invoke a HTTP method with no request entity that returns a response.
*
* @param the type of the response.
* @param method the HTTP method.
* @param l the listener to receive asynchronous callbacks.
* @return a future that may be used to wait until the future completes and
* obtain the client response state, or cancel the request.
*/
Future method(String method, ITypeListener l);
/**
* Invoke a HTTP method with a request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* c is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param method the HTTP method.
* @param c the type of the returned response.
* @param requestEntity the request entity.
* @return an instance of type c.
*/
Future method(String method, Class c, Object requestEntity);
/**
* Invoke a HTTP method with a request entity that returns a response.
*
* The {@link Future#get} method will throw a UniformInterfaceException
* if the status of the HTTP response is greater than or equal to 300 and
* gt is not the type {@link ClientResponse}.
*
* @param the type of the response.
* @param method the HTTP method.
* @param gt the generic type of the returned response.
* @param requestEntity the request entity.
* @return an instance of type represented by the generic type.
*/
Future method(String method, GenericType gt, Object requestEntity);
/**
* Invoke a HTTP method with a request entity that returns a response.
*
* @param the type of the response.
* @param method the HTTP method.
* @param l the listener to receive asynchronous callbacks.
* @param requestEntity the request entity.
* @return a future that may be used to wait until the future completes and
* obtain the client response state, or cancel the request.
*/
Future method(String method, ITypeListener l, Object requestEntity);
}