Package org.apache.cxf.jaxrs.client

Class AbstractClient

java.lang.Object

org.apache.cxf.jaxrs.client.AbstractClient

All Implemented Interfaces:

Client

Direct Known Subclasses:

ClientProxyImpl, WebClient

public abstract class AbstractClient
extends Object
implements Client

Common proxy and http-centric client implementation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractClient.AbstractBodyWriter
protected class	AbstractClient.AbstractClientAsyncResponseInterceptor

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientConfiguration	cfg
static String	EXECUTOR_SERVICE_PROPERTY
protected static String	HTTP_SCHEME
protected static String	KEEP_CONDUIT_ALIVE
protected static String	REQUEST_CONTEXT
protected static String	RESPONSE_CONTEXT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractClient(ClientState initialState)

Method Summary

Modifier and Type	Method	Description
Client	accept(String... types)	Set HTTP Accept header
Client	accept(javax.ws.rs.core.MediaType... types)	Set HTTP Accept header
Client	acceptEncoding(String... encs)	Set HTTP Accept-Encoding header
Client	acceptLanguage(String... languages)	Set HTTP Accept-Language header
protected void	addMatrixQueryParamsToBuilder(javax.ws.rs.core.UriBuilder ub, String paramName, ParameterType pt, Annotation[] anns, Object... pValues)
Client	authorization(Object auth)	Set HTTP Authorization header
protected URI	calculateNewRequestURI(Map<String,Object> reqContext)
protected void	checkClientException(Message outMessage, Exception ex)
protected void	checkClosed()
protected Object	checkIfBodyEmpty(Object body, String contentType)
void	close()	Release the internal state and configuration associated with this client
protected void	completeExchange(Exchange exchange, boolean proxy)
protected String	convertParamValue(Object pValue, Annotation[] anns)
protected String	convertParamValue(Object pValue, Class<?> pClass, Annotation[] anns)
protected javax.ws.rs.WebApplicationException	convertToWebApplicationException(javax.ws.rs.core.Response r)
Client	cookie(javax.ws.rs.core.Cookie cookie)	Set HTTP Cookie header
protected Exchange	createExchange(Message m, Exchange exchange)
protected Message	createMessage(Object body, String httpMethod, javax.ws.rs.core.MultivaluedMap<String,String> headers, URI currentURI, Exchange exchange, Map<String,Object> invocationContext, boolean proxy)
protected void	doRunInterceptorChain(Message m)
Client	encoding(String enc)	Set HTTP Content-Encoding header
protected static ParameterizedType	findCallbackType(Class<?> cls)
URI	getBaseURI()	Get the base URI this Client has been intialized with
protected static Class<?>	getCallbackClass(Type outType)
protected static Type	getCallbackType(javax.ws.rs.client.InvocationCallback<?> callback)
ClientConfiguration	getConfiguration()
protected List<?>	getContentsList(Object body)
protected javax.ws.rs.core.UriBuilder	getCurrentBuilder()
URI	getCurrentURI()	Get the current URI this Client is working with
javax.ws.rs.core.MultivaluedMap<String,String>	getHeaders()	Get the copy of request headers
protected Map<String,Object>	getRequestContext(Message outMessage)
javax.ws.rs.core.Response	getResponse()	Get the response state if any
protected ClientState	getState()
protected javax.ws.rs.core.MultivaluedMap<String,String>	getTemplateParametersMap(URITemplate template, List<Object> values)
Client	header(String name, Object... values)	Set arbitrary HTTP Header
Client	headers(javax.ws.rs.core.MultivaluedMap<String,String> map)	Set HTTP Headers
Client	language(String language)	Set HTTP Content-Language header
Client	match(javax.ws.rs.core.EntityTag tag, boolean ifNot)	Set HTTP If-Match or If-None-Match header
Client	modified(Date date, boolean ifNot)	Set HTTP If-Modified-Since or If-Unmodified-Since header
protected String[]	parseQuotedHeaderValue(String originalValue)
protected void	prepareConduitSelector(Message message, URI currentURI, boolean proxy)
protected Object[]	preProcessResult(Message message)
Client	query(String name, Object... values)	Update the current URI query parameters
protected <T> T	readBody(javax.ws.rs.core.Response r, Message outMessage, Class<T> cls, Type type, Annotation[] anns)
void	removeAllHeaders()
protected static void	reportMessageHandlerProblem(String name, Class<?> cls, javax.ws.rs.core.MediaType ct, Throwable ex)
Client	reset()	Reset the headers and response state if any
protected void	resetBaseAddress(URI uri)
protected void	resetCurrentBuilder(URI uri)
protected void	resetResponse()
protected void	resetResponseStateImmediatelyIfNeeded()
protected boolean	responseStreamCanBeClosed(Message outMessage, Class<?> cls)
protected abstract Object	retryInvoke(URI newRequestURI, javax.ws.rs.core.MultivaluedMap<String,String> headers, Object body, Exchange exchange, Map<String,Object> invContext)
protected Object[]	retryInvoke(BindingOperationInfo oi, Object[] params, Map<String,Object> context, Exchange exchange)
protected void	setAsyncMessageObserverIfNeeded(Exchange exchange)
protected void	setConfiguration(ClientConfiguration config)
protected void	setContexts(Message message, Exchange exchange, Map<String,Object> context, boolean proxy)
protected void	setEmptyRequestPropertyIfNeeded(Message outMessage, Object body)
protected void	setPlainOperationNameProperty(Message outMessage, String name)
protected javax.ws.rs.core.Response.ResponseBuilder	setResponseBuilder(Message outMessage, Exchange exchange)
protected void	setSupportOnewayResponseProperty(Message outMessage)
protected static MessageObserver	setupInFaultObserver(ClientConfiguration cfg)
protected static PhaseInterceptorChain	setupInInterceptorChain(ClientConfiguration cfg)
protected static PhaseInterceptorChain	setupOutInterceptorChain(ClientConfiguration cfg)
Client	type(String type)	Set HTTP Content-Type header
Client	type(javax.ws.rs.core.MediaType ct)	Set HTTP Content-Type header
protected void	waitForResponseCode(Exchange exchange)
protected <T> void	writeBody(T o, Message outMessage, Class<?> cls, Type type, Annotation[] anns, OutputStream os)

Methods inherited from class java.lang.Object

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

Field Detail

EXECUTOR_SERVICE_PROPERTY

public static final String EXECUTOR_SERVICE_PROPERTY

See Also:

Constant Field Values

REQUEST_CONTEXT

protected static final String REQUEST_CONTEXT

See Also:

Constant Field Values

RESPONSE_CONTEXT

protected static final String RESPONSE_CONTEXT

See Also:

Constant Field Values

KEEP_CONDUIT_ALIVE

protected static final String KEEP_CONDUIT_ALIVE

See Also:

Constant Field Values

HTTP_SCHEME

protected static final String HTTP_SCHEME

See Also:

Constant Field Values

cfg

protected ClientConfiguration cfg

Constructor Detail

AbstractClient

protected AbstractClient(ClientState initialState)

Method Detail

query

public Client query(String name,
                    Object... values)

Update the current URI query parameters

Specified by:

query in interface Client

Parameters:

name - query name

values - query values

Returns:

updated WebClient

header

public Client header(String name,
                     Object... values)

Set arbitrary HTTP Header

Specified by:

header in interface Client

Parameters:

name - header name

values - list of header values

Returns:

the updated Client

headers

public Client headers(javax.ws.rs.core.MultivaluedMap<String,String> map)

Set HTTP Headers

Specified by:

headers in interface Client

Parameters:

map - headers

Returns:

the updated Client

accept

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

Set HTTP Accept header

Specified by:

accept in interface Client

Parameters:

types - list of JAXRS MediaTypes representing Accept header values

Returns:

the updated Client

type

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

Set HTTP Content-Type header

Specified by:

type in interface Client

Parameters:

ct - JAXRS MediaType representing Content-Type value

Returns:

the updated Client

type

public Client type(String type)

Set HTTP Content-Type header

Specified by:

type in interface Client

Parameters:

type - Content-Type value

Returns:

the updated Client

accept

public Client accept(String... types)

Set HTTP Accept header

Specified by:

accept in interface Client

Parameters:

types - list of Accept header values

Returns:

the updated Client

cookie

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

Set HTTP Cookie header

Specified by:

cookie in interface Client

Parameters:

cookie - Cookie value

Returns:

the updated Client

authorization

public Client authorization(Object auth)

Set HTTP Authorization header

Specified by:

authorization in interface Client

Parameters:

auth - Authorization value

Returns:

the updated Client

modified

public Client modified(Date date,
                       boolean ifNot)

Set HTTP If-Modified-Since or If-Unmodified-Since header

Specified by:

modified in interface Client

Parameters:

date - Date value, will be formated as "EEE, dd MMM yyyy HH:mm:ss zzz"

ifNot - if true then If-Unmodified-Since is set, If-Modified-Since otherwise

Returns:

the updated Client

language

public Client language(String language)

Set HTTP Content-Language header

Specified by:

language in interface Client

Parameters:

language - Content-Language header value

Returns:

the updated Client

match

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

Set HTTP If-Match or If-None-Match header

Specified by:

match in interface Client

Parameters:

tag - ETag value

ifNot - if true then If-None-Match is set, If-Match otherwise

Returns:

the updated Client

acceptLanguage

public Client acceptLanguage(String... languages)

Set HTTP Accept-Language header

Specified by:

acceptLanguage in interface Client

Parameters:

languages - list of Accept-Language header values

Returns:

the updated Client

acceptEncoding

public Client acceptEncoding(String... encs)

Set HTTP Accept-Encoding header

Specified by:

acceptEncoding in interface Client

Parameters:

encs - list of Accept-Encoding header value

Returns:

the updated Client

encoding

public Client encoding(String enc)

Set HTTP Content-Encoding header

Specified by:

encoding in interface Client

Parameters:

enc - Content-Encoding header value

Returns:

the updated Client

getHeaders

public javax.ws.rs.core.MultivaluedMap<String,String> getHeaders()

Get the copy of request headers

Specified by:

getHeaders in interface Client

Returns:

request headers

getBaseURI

public URI getBaseURI()

Get the base URI this Client has been intialized with

Specified by:

getBaseURI in interface Client

Returns:

base URI

getCurrentURI

public URI getCurrentURI()

Get the current URI this Client is working with

Specified by:

getCurrentURI in interface Client

Returns:

current URI

getResponse

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

Get the response state if any

Specified by:

getResponse in interface Client

Returns:

JAXRS Response response

reset

public Client reset()

Reset the headers and response state if any

Specified by:

reset in interface Client

Returns:

the updated Client

close

public void close()

Description copied from interface: Client

Release the internal state and configuration associated with this client

Specified by:

close in interface Client

removeAllHeaders

public void removeAllHeaders()

getState

protected ClientState getState()

getCurrentBuilder

protected javax.ws.rs.core.UriBuilder getCurrentBuilder()

resetResponse

protected void resetResponse()

resetBaseAddress

protected void resetBaseAddress(URI uri)

resetCurrentBuilder

protected void resetCurrentBuilder(URI uri)

getTemplateParametersMap

protected javax.ws.rs.core.MultivaluedMap<String,String> getTemplateParametersMap(URITemplate template,
                                                                                        List<Object> values)

setResponseBuilder

protected javax.ws.rs.core.Response.ResponseBuilder setResponseBuilder(Message outMessage,
                                                                       Exchange exchange)
                                                                throws Exception

Throws:

Exception

writeBody

protected <T> void writeBody(T o,
                             Message outMessage,
                             Class<?> cls,
                             Type type,
                             Annotation[] anns,
                             OutputStream os)

convertToWebApplicationException

protected javax.ws.rs.WebApplicationException convertToWebApplicationException(javax.ws.rs.core.Response r)

readBody

protected <T> T readBody(javax.ws.rs.core.Response r,
                         Message outMessage,
                         Class<T> cls,
                         Type type,
                         Annotation[] anns)

responseStreamCanBeClosed

protected boolean responseStreamCanBeClosed(Message outMessage,
                                            Class<?> cls)

completeExchange

protected void completeExchange(Exchange exchange,
                                boolean proxy)

preProcessResult

protected Object[] preProcessResult(Message message)
                             throws Exception

Throws:

Exception

checkClientException

protected void checkClientException(Message outMessage,
                                    Exception ex)
                             throws Exception

Throws:

Exception

waitForResponseCode

protected void waitForResponseCode(Exchange exchange)

calculateNewRequestURI

protected URI calculateNewRequestURI(Map<String,Object> reqContext)

doRunInterceptorChain

protected void doRunInterceptorChain(Message m)

retryInvoke

protected Object[] retryInvoke(BindingOperationInfo oi,
                               Object[] params,
                               Map<String,Object> context,
                               Exchange exchange)
                        throws Exception

Throws:

Exception

retryInvoke

protected abstract Object retryInvoke(URI newRequestURI,
                                      javax.ws.rs.core.MultivaluedMap<String,String> headers,
                                      Object body,
                                      Exchange exchange,
                                      Map<String,Object> invContext)
                               throws Throwable

Throws:

Throwable

addMatrixQueryParamsToBuilder

protected void addMatrixQueryParamsToBuilder(javax.ws.rs.core.UriBuilder ub,
                                             String paramName,
                                             ParameterType pt,
                                             Annotation[] anns,
                                             Object... pValues)

convertParamValue

protected String convertParamValue(Object pValue,
                                   Annotation[] anns)

convertParamValue

protected String convertParamValue(Object pValue,
                                   Class<?> pClass,
                                   Annotation[] anns)

reportMessageHandlerProblem

protected static void reportMessageHandlerProblem(String name,
                                                  Class<?> cls,
                                                  javax.ws.rs.core.MediaType ct,
                                                  Throwable ex)

parseQuotedHeaderValue

protected String[] parseQuotedHeaderValue(String originalValue)

getConfiguration

public ClientConfiguration getConfiguration()

setConfiguration

protected void setConfiguration(ClientConfiguration config)

prepareConduitSelector

protected void prepareConduitSelector(Message message,
                                      URI currentURI,
                                      boolean proxy)

setupOutInterceptorChain

protected static PhaseInterceptorChain setupOutInterceptorChain(ClientConfiguration cfg)

setupInInterceptorChain

protected static PhaseInterceptorChain setupInInterceptorChain(ClientConfiguration cfg)

setupInFaultObserver

protected static MessageObserver setupInFaultObserver(ClientConfiguration cfg)

setSupportOnewayResponseProperty

protected void setSupportOnewayResponseProperty(Message outMessage)

checkClosed

protected void checkClosed()

createMessage

protected Message createMessage(Object body,
                                String httpMethod,
                                javax.ws.rs.core.MultivaluedMap<String,String> headers,
                                URI currentURI,
                                Exchange exchange,
                                Map<String,Object> invocationContext,
                                boolean proxy)

setEmptyRequestPropertyIfNeeded

protected void setEmptyRequestPropertyIfNeeded(Message outMessage,
                                               Object body)

checkIfBodyEmpty

protected Object checkIfBodyEmpty(Object body,
                                  String contentType)

getRequestContext

protected Map<String,Object> getRequestContext(Message outMessage)

getContentsList

protected List<?> getContentsList(Object body)

createExchange

protected Exchange createExchange(Message m,
                                  Exchange exchange)

setAsyncMessageObserverIfNeeded

protected void setAsyncMessageObserverIfNeeded(Exchange exchange)

setContexts

protected void setContexts(Message message,
                           Exchange exchange,
                           Map<String,Object> context,
                           boolean proxy)

setPlainOperationNameProperty

protected void setPlainOperationNameProperty(Message outMessage,
                                             String name)

getCallbackType

protected static Type getCallbackType(javax.ws.rs.client.InvocationCallback<?> callback)

findCallbackType

protected static ParameterizedType findCallbackType(Class<?> cls)

getCallbackClass

protected static Class<?> getCallbackClass(Type outType)

resetResponseStateImmediatelyIfNeeded

protected void resetResponseStateImmediatelyIfNeeded()