All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.jersey.api.client.ClientRequest Maven / Gradle / Ivy

There is a newer version: 1.19.4
Show newest version
/*
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. 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 https://jersey.dev.java.net/CDDL+GPL.html
 * or jersey/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 jersey/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [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.client.impl.ClientRequestImpl;
import java.net.URI;
import java.util.Map;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.ext.RuntimeDelegate;
import javax.ws.rs.ext.RuntimeDelegate.HeaderDelegate;

/**
 * A client (out-bound) HTTP request.
 * 

* Instances may be created by using the static method {@link #create} and * methods on {@link ClientRequest.Builder}. * * @author [email protected] */ public abstract class ClientRequest { /** * Get the mutable property bag. * * @return the property bag. */ public abstract Map getProperties(); /** * Get a feature that is boolean property of the property bag. * * @param name the name of the feature; * @return true if the feature value is present and is an instance of * Boolean and that value is true, otherwise false. */ public boolean getPropertyAsFeature(String name) { return getPropertyAsFeature(name, false); } /** * Get a feature that is boolean property of the property bag. * * @param name the name of the feature; * @param defaultValue the default boolean value if the property is absent. * @return true if the feature value is present and is an instance of * Boolean and that value is true, otherwise the * defaultValue. */ public boolean getPropertyAsFeature(String name, boolean defaultValue) { Boolean v = (Boolean)getProperties().get(name); return (v != null) ? v : defaultValue; } /** * Get the URI of the request. The URI shall contain sufficient * components to correctly dispatch a request * * @return the URI of the request. */ public abstract URI getURI(); /** * Set the URI of the request. The URI shall contain sufficient * components to correctly dispatch a request * * @param uri the URI of the request. */ public abstract void setURI(URI uri); /** * Get the HTTP method of the request. * * @return the HTTP method. */ public abstract String getMethod(); /** * Set the HTTP method of the request. * * @param method the HTTP method. */ public abstract void setMethod(String method); /** * Get the entity of the request. * * @return the entity of the request. */ public abstract Object getEntity(); /** * Set the entity of the request. *

* 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. * * @param entity the entity of the request. */ public abstract void setEntity(Object entity); /** * Get the HTTP headers of the request. * * @return the HTTP headers of the request. */ public abstract MultivaluedMap getMetadata(); /** * Get the client request adapter. * * @return the client request adapter. */ public abstract ClientRequestAdapter getAdapter(); /** * Set the client request adapter. *

* If an existing adapter is set then usually this adapter wrapped in the * new adapter to be set such that the current adaption behaviour is * retained and augmented with the new adpation behaviour. * * @param adapter the client request adapter. */ public abstract void setAdapter(ClientRequestAdapter adapter); /** * Clone the request. * * @return the cloned request. */ @Override public abstract ClientRequest clone(); /** * Create a builder for building a new {@link ClientRequest} instance. * * @return the builder. */ public static final ClientRequest.Builder create() { return new Builder(); } /** * The builder for building a {@link ClientRequest} instance. */ public static final class Builder extends PartialRequestBuilder { /** * Build the {@link ClientRequest} instance. * * @param uri the URI of the request. * @param method the HTTP method. * @return the client request. */ public ClientRequest build(URI uri, String method) { ClientRequest ro = new ClientRequestImpl(uri, method, entity, metadata); entity = null; metadata = null; return ro; } } private static final RuntimeDelegate rd = RuntimeDelegate.getInstance(); /** * Convert a header value, represented as a general object, to the * string value. *

* This method defers to {@link RuntimeDelegate#createHeaderDelegate} to * obtain a {@link HeaderDelegate} to convert the value to a string. If * a {@link HeaderDelegate} is not found then the toString * is utilized. * * @param headerValue the header value as an object * @return the string value */ public static String getHeaderValue(Object headerValue) { HeaderDelegate hp = rd.createHeaderDelegate(headerValue.getClass()); return (hp != null) ? hp.toString(headerValue) : headerValue.toString(); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy