com.sun.jersey.api.client.UniformInterface 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.config.ClientConfig;
/**
* A 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 type, other than {@link ClientResponse},
* 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.
*
* In the following cases it is necessary to close the response, when response
* processing has completed, to ensure that underlying resources are
* correctly released.
*
* If a response entity is declared of the type
* {@link ClientResponse}
* or of a type that is assignable to {@link java.io.Closeable}
* (such as {@link java.io.InputStream}) then the response must be either:
* 1) closed by invoking the method
* {@link ClientResponse#close() } or
* {@link java.io.Closeable#close}; or 2) all bytes of response entity must be
* read.
*
* If a {@link UniformInterfaceException} is
* thrown then by default the response entity is automatically buffered and
* the underlying resources are correctly released. See the following property
* for more details:
* {@link ClientConfig#PROPERTY_BUFFER_RESPONSE_ENTITY_ON_EXCEPTION}.
*
* @author [email protected]
* @see com.sun.jersey.api.client
*/
public interface UniformInterface {
/**
* Invoke the HEAD method.
*
* @return the HTTP response.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
ClientResponse head() throws ClientHandlerException;
/**
* Invoke the OPTIONS method.
*
* @param the type of the response.
* @param c the type of the returned response.
* @return an instance of type c.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and c is not the type
* {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T options(Class c) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the OPTIONS method.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and gt does not
* represent the type {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T options(GenericType gt) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the GET method.
*
* @param the type of the response.
* @param c the type of the returned response.
* @return an instance of type c.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and c is not the type
* {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T get(Class c) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the GET method.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and gt does not
* represent the type {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T get(GenericType gt) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the PUT method with no request entity or response.
*
* If the status code is less than 300 and a representation is present
* then that representation is ignored.
*
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
void put() throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the PUT method with a request entity but no response.
*
* If the status code is less than 300 and a representation is present
* then that representation is ignored.
*
* @param requestEntity the request entity.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
void put(Object requestEntity) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the PUT method with no request entity that returns a response.
*
* @param the type of the response.
* @param c the type of the returned response.
* @return an instance of type c.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and c is not the type
* {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T put(Class c) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the PUT method with a request entity that returns a response.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and gt does not
* represent the type {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T put(GenericType gt) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the PUT method with a request entity that returns a response.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and c is not the type
* {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T put(Class c, Object requestEntity)
throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the PUT method with a request entity that returns a response.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and gt does not
* represent the type {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T put(GenericType gt, Object requestEntity)
throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the POST method with no request entity or response.
*
* If the status code is less than 300 and a representation is present
* then that representation is ignored.
*
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
void post() throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the POST method with a request entity but no response.
*
* If the status code is less than 300 and a representation is present
* then that representation is ignored.
*
* @param requestEntity the request entity.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
void post(Object requestEntity) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the POST method with no request entity that returns a response.
*
* @param the type of the response.
* @param c the type of the returned response.
* @return an instance of type c.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and c is not the type
* {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T post(Class c) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the POST method with a request entity that returns a response.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and gt does not
* represent the type {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T post(GenericType gt) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the POST method with a request entity that returns a response.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and c is not the type
* {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T post(Class c, Object requestEntity)
throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the POST method with a request entity that returns a response.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and gt does not
* represent the type {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T post(GenericType gt, Object requestEntity)
throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the DELETE method with no request entity or response.
*
* If the status code is less than 300 and a representation is present
* then that representation is ignored.
*
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
void delete() throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the DELETE method with a request entity but no response.
*
* If the status code is less than 300 and a representation is present
* then that representation is ignored.
*
* @param requestEntity the request entity.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
void delete(Object requestEntity) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the DELETE method with no request entity that returns a response.
*
* @param the type of the response.
* @param c the type of the returned response.
* @return an instance of type c.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and c is not the type
* {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T delete(Class c) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the DELETE method with a request entity that returns a response.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and gt does not
* represent the type {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T delete(GenericType gt) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the DELETE method with a request entity that returns a response.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and c is not the type
* {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T delete(Class c, Object requestEntity)
throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke the DELETE method with a request entity that returns a response.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and gt does not
* represent the type {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T delete(GenericType gt, Object requestEntity)
throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke a HTTP method with no request entity or response.
*
* If the status code is less than 300 and a representation is present
* then that representation is ignored.
*
* @param method the HTTP method.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
void method(String method) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke a HTTP method with a request entity but no response.
*
* If the status code is less than 300 and a representation is present
* then that representation is ignored.
*
* @param method the HTTP method.
* @param requestEntity the request entity.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
void method(String method, Object requestEntity)
throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke a HTTP method with no request entity that returns a response.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and c is not the type
* {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T method(String method, Class c) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke a HTTP method with no request entity that returns a response.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and gt does not
* represent the type {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T method(String method, GenericType gt) throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke a HTTP method with a request entity that returns a response.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and c is not the type
* {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T method(String method, Class c, Object requestEntity)
throws UniformInterfaceException, ClientHandlerException;
/**
* Invoke a HTTP method with a request entity that returns a response.
*
* @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.
* @throws UniformInterfaceException if the status of the HTTP response is
* greater than or equal to 300 and gt does not
* represent the type {@link ClientResponse}.
* @throws ClientHandlerException if the client handler fails to process
* the request or response.
*/
T method(String method, GenericType gt, Object requestEntity)
throws UniformInterfaceException, ClientHandlerException;
}