org.apache.cxf.jaxrs.client
Class WebClient

java.lang.Object
  org.apache.cxf.jaxrs.client.AbstractClient
      org.apache.cxf.jaxrs.client.WebClient

All Implemented Interfaces:

Client, InvocationHandlerAware

public class WebClient
extends AbstractClient

Field Summary

Fields inherited from class org.apache.cxf.jaxrs.client.AbstractClient

bus, conduitSelector, inInterceptors, outInterceptors, WILDCARD

Constructor Summary

protected	WebClient(java.lang.String baseAddress)
protected	WebClient(java.net.URI baseAddress)

Method Summary

WebClient	accept(javax.ws.rs.core.MediaType... types)
WebClient	accept(java.lang.String... types)
WebClient	acceptEncoding(java.lang.String... encodings)
WebClient	acceptLanguage(java.lang.String... languages)
WebClient	back(boolean fast)
static Client	client(java.lang.Object proxy) Converts proxy to Client
WebClient	cookie(javax.ws.rs.core.Cookie cookie)
static WebClient	create(java.lang.String baseAddress) Creates WebClient
static WebClient	create(java.lang.String baseAddress, java.util.List<?> providers) Creates WebClient
static WebClient	create(java.lang.String baseAddress, java.util.List<?> providers, java.lang.String configLocation) Creates a Spring-configuration aware WebClient
static WebClient	create(java.lang.String baseAddress, java.lang.String configLocation) Creates a Spring-configuration aware WebClient
static WebClient	create(java.lang.String baseAddress, java.lang.String username, java.lang.String password, java.lang.String configLocation) Creates a Spring-configuration aware WebClient which will do basic authentication
static WebClient	create(java.net.URI baseURI)
javax.ws.rs.core.Response	delete()
protected javax.ws.rs.core.Response	doChainedInvocation(java.lang.String httpMethod, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> headers, java.lang.Object body, java.lang.Class<?> responseClass)
protected javax.ws.rs.core.Response	doInvoke(java.lang.String httpMethod, java.lang.Object body, java.lang.Class<?> responseClass)
WebClient	encoding(java.lang.String encoding)
javax.ws.rs.core.Response	form(Form form)
javax.ws.rs.core.Response	form(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> values)
static WebClient	fromClient(Client client) Creates WebClient, baseURI will be set to Client currentURI
static WebClient	fromClient(Client client, boolean inheritHeaders)
javax.ws.rs.core.Response	get()
<T> T	get(java.lang.Class<T> responseClass)
protected java.net.HttpURLConnection	getConnection(java.lang.String methodName)
protected javax.ws.rs.core.Response	handleResponse(java.net.HttpURLConnection conn, org.apache.cxf.message.Message m, java.lang.Class<?> responseClass)
javax.ws.rs.core.Response	head()
WebClient	header(java.lang.String name, java.lang.Object... values)
WebClient	headers(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> map)
javax.ws.rs.core.Response	invoke(java.lang.String httpMethod, java.lang.Object body) Does HTTP invocation
<T> T	invoke(java.lang.String httpMethod, java.lang.Object body, java.lang.Class<T> responseClass)
WebClient	language(java.lang.String language)
WebClient	match(javax.ws.rs.core.EntityTag tag, boolean ifNot)
WebClient	matrix(java.lang.String name, java.lang.Object... values)
WebClient	modified(java.util.Date date, boolean ifNot)
javax.ws.rs.core.Response	options()
WebClient	path(java.lang.Object path)
javax.ws.rs.core.Response	post(java.lang.Object o)
<T> T	post(java.lang.Object o, java.lang.Class<T> responseClass)
javax.ws.rs.core.Response	put(java.lang.Object o)
WebClient	query(java.lang.String name, java.lang.Object... values)
WebClient	reset()
WebClient	to(java.lang.String newAddress, boolean forward)
WebClient	type(javax.ws.rs.core.MediaType ct)
WebClient	type(java.lang.String type)

Methods inherited from class org.apache.cxf.jaxrs.client.AbstractClient

createHttpConnection, createMessage, createSimpleMessage, getAccept, getBaseURI, getCurrentBuilder, getCurrentURI, getHeaders, getInvocationHandler, getResponse, getType, prepareConduitSelector, readBody, reportNoMessageHandler, resetBaseAddress, resetCurrentBuilder, resetResponse, setAllHeaders, setBus, setConduitSelector, setInInterceptors, setOutInterceptors, setResponseBuilder, setupInInterceptorChain, setupOutInterceptorChain, writeBody

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebClient

protected WebClient(java.lang.String baseAddress)

WebClient

protected WebClient(java.net.URI baseAddress)

Method Detail

create

public static WebClient create(java.lang.String baseAddress)

Creates WebClient

Parameters:

baseAddress - baseAddress

create

public static WebClient create(java.net.URI baseURI)

create

public static WebClient create(java.lang.String baseAddress,
                               java.util.List<?> providers)

Creates WebClient

Parameters:

baseURI - baseURI

providers - list of providers

create

public static WebClient create(java.lang.String baseAddress,
                               java.util.List<?> providers,
                               java.lang.String configLocation)

Creates a Spring-configuration aware WebClient

Parameters:

baseAddress - baseAddress

providers - list of providers

configLocation - classpath location of Spring configuration resource, can be null

Returns:

WebClient instance

create

public static WebClient create(java.lang.String baseAddress,
                               java.lang.String configLocation)

Creates a Spring-configuration aware WebClient

Parameters:

baseAddress - baseAddress

configLocation - classpath location of Spring configuration resource, can be null

Returns:

WebClient instance

create

public static WebClient create(java.lang.String baseAddress,
                               java.lang.String username,
                               java.lang.String password,
                               java.lang.String configLocation)

Creates a Spring-configuration aware WebClient which will do basic authentication

Parameters:

baseAddress - baseAddress

username - username

password - password

configLocation - classpath location of Spring configuration resource, can be null

Returns:

WebClient instance

fromClient

public static WebClient fromClient(Client client)

Creates WebClient, baseURI will be set to Client currentURI

Parameters:

client - existing client

fromClient

public static WebClient fromClient(Client client,
                                   boolean inheritHeaders)

client

public static Client client(java.lang.Object proxy)

Converts proxy to Client

Parameters:

proxy - the proxy

Returns:

proxy as a Client

invoke

public javax.ws.rs.core.Response invoke(java.lang.String httpMethod,
                                        java.lang.Object body)

Does HTTP invocation

Parameters:

httpMethod - HTTP method

body - request body, can be null

Returns:

JAXRS Response, entity may hold a string representaion of error message if client or server error occured

post

public javax.ws.rs.core.Response post(java.lang.Object o)

put

public javax.ws.rs.core.Response put(java.lang.Object o)

get

public javax.ws.rs.core.Response get()

head

public javax.ws.rs.core.Response head()

options

public javax.ws.rs.core.Response options()

delete

public javax.ws.rs.core.Response delete()

form

public javax.ws.rs.core.Response form(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> values)

form

public javax.ws.rs.core.Response form(Form form)

invoke

public <T> T invoke(java.lang.String httpMethod,
                    java.lang.Object body,
                    java.lang.Class<T> responseClass)

post

public <T> T post(java.lang.Object o,
                  java.lang.Class<T> responseClass)

get

public <T> T get(java.lang.Class<T> responseClass)

path

public WebClient path(java.lang.Object path)

query

public WebClient query(java.lang.String name,
                       java.lang.Object... values)

matrix

public WebClient matrix(java.lang.String name,
                        java.lang.Object... values)

to

public WebClient to(java.lang.String newAddress,
                    boolean forward)

back

public WebClient back(boolean fast)

type

public WebClient type(javax.ws.rs.core.MediaType ct)

Specified by:

type in interface Client

Overrides:

type in class AbstractClient

type

public WebClient type(java.lang.String type)

Specified by:

type in interface Client

Overrides:

type in class AbstractClient

accept

public WebClient accept(javax.ws.rs.core.MediaType... types)

Specified by:

accept in interface Client

Overrides:

accept in class AbstractClient

accept

public WebClient accept(java.lang.String... types)

Specified by:

accept in interface Client

Overrides:

accept in class AbstractClient

language

public WebClient language(java.lang.String language)

Specified by:

language in interface Client

Overrides:

language in class AbstractClient

acceptLanguage

public WebClient acceptLanguage(java.lang.String... languages)

Specified by:

acceptLanguage in interface Client

Overrides:

acceptLanguage in class AbstractClient

encoding

public WebClient encoding(java.lang.String encoding)

Specified by:

encoding in interface Client

Overrides:

encoding in class AbstractClient

acceptEncoding

public WebClient acceptEncoding(java.lang.String... encodings)

Specified by:

acceptEncoding in interface Client

Overrides:

acceptEncoding in class AbstractClient

match

public WebClient match(javax.ws.rs.core.EntityTag tag,
                       boolean ifNot)

Specified by:

match in interface Client

Overrides:

match in class AbstractClient

modified

public WebClient modified(java.util.Date date,
                          boolean ifNot)

Specified by:

modified in interface Client

Overrides:

modified in class AbstractClient

cookie

public WebClient cookie(javax.ws.rs.core.Cookie cookie)

Specified by:

cookie in interface Client

Overrides:

cookie in class AbstractClient

header

public WebClient header(java.lang.String name,
                        java.lang.Object... values)

Specified by:

header in interface Client

Overrides:

header in class AbstractClient

headers

public WebClient headers(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> map)

Specified by:

headers in interface Client

Overrides:

headers in class AbstractClient

reset

public WebClient reset()

Specified by:

reset in interface Client

Overrides:

reset in class AbstractClient

doInvoke

protected javax.ws.rs.core.Response doInvoke(java.lang.String httpMethod,
                                             java.lang.Object body,
                                             java.lang.Class<?> responseClass)

doChainedInvocation

protected javax.ws.rs.core.Response doChainedInvocation(java.lang.String httpMethod,
                                                        javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> headers,
                                                        java.lang.Object body,
                                                        java.lang.Class<?> responseClass)

handleResponse

protected javax.ws.rs.core.Response handleResponse(java.net.HttpURLConnection conn,
                                                   org.apache.cxf.message.Message m,
                                                   java.lang.Class<?> responseClass)

getConnection

protected java.net.HttpURLConnection getConnection(java.lang.String methodName)