Package org.apache.cxf.jaxrs.client
Class ClientConfiguration
java.lang.Object
org.apache.cxf.jaxrs.client.ClientConfiguration
- All Implemented Interfaces:
org.apache.cxf.endpoint.ConduitSelectorHolder,org.apache.cxf.interceptor.InterceptorProvider
public class ClientConfiguration
extends Object
implements org.apache.cxf.interceptor.InterceptorProvider, org.apache.cxf.endpoint.ConduitSelectorHolder
Represents the configuration of the current proxy or WebClient.
Given an instance with the name 'client', one can access its configuration
using a WebClient.getConfig(client) call.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.apache.cxf.BusgetBus()Gets the busorg.apache.cxf.transport.ConduitGets the conduit responsible for a transport-level communication with the remote service.org.apache.cxf.endpoint.ConduitSelectorGets the conduit selectororg.apache.cxf.endpoint.Endpointorg.apache.cxf.transport.http.HTTPConduitGets the HTTP conduit responsible for a transport-level communication with the remote service.List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>>List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>>List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>>List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>>Get the map of properties which affect the requests only.Get the map of properties which affect the responses only.longbooleanbooleanIndicates if Response may still be expected for oneway requests.booleanvoidsetBus(org.apache.cxf.Bus bus) Sets the busvoidsetConduitSelector(org.apache.cxf.endpoint.ConduitSelector cs) Sets the conduit selectorvoidsetInFaultInterceptors(List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> interceptors) Sets the list of in fault interceptors which will deal with the HTTP faults; the client code may choose to catchWebApplicationExceptionexceptions instead.voidsetInInterceptors(List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> interceptors) Sets the list of in interceptors which pre-process the responses from remote services.voidsetOutFaultInterceptors(List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> interceptors) Sets the list of out fault interceptors which will deal with the client-side faults; the client code may choose to catchClientExceptionexceptions instead.voidsetOutInterceptors(List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> interceptors) Sets the list of out interceptors which post-process the requests to the remote services.voidsetResetThreadLocalStateImmediately(boolean reset) voidsetShutdownBusOnClose(boolean shutdownBusOnClose) voidsetSynchronousTimeout(long synchronousTimeout) Sets the synchronous timeout
-
Constructor Details
-
ClientConfiguration
public ClientConfiguration()
-
-
Method Details
-
getSynchronousTimeout
public long getSynchronousTimeout() -
setSynchronousTimeout
public void setSynchronousTimeout(long synchronousTimeout) Sets the synchronous timeout- Parameters:
synchronousTimeout-
-
isResponseExpectedForOneway
public boolean isResponseExpectedForOneway()Indicates if Response may still be expected for oneway requests. For example, 202 in case of HTTP- Returns:
- true if the response can be expected
-
setConduitSelector
public void setConduitSelector(org.apache.cxf.endpoint.ConduitSelector cs) Sets the conduit selector- Specified by:
setConduitSelectorin interfaceorg.apache.cxf.endpoint.ConduitSelectorHolder- Parameters:
cs- the selector
-
getConduitSelector
public org.apache.cxf.endpoint.ConduitSelector getConduitSelector()Gets the conduit selector- Specified by:
getConduitSelectorin interfaceorg.apache.cxf.endpoint.ConduitSelectorHolder- Returns:
- the conduit the selector
-
setBus
public void setBus(org.apache.cxf.Bus bus) Sets the bus- Parameters:
bus- the bus
-
getBus
public org.apache.cxf.Bus getBus()Gets the bus- Returns:
- the bus
-
getInFaultInterceptors
public List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> getInFaultInterceptors()- Specified by:
getInFaultInterceptorsin interfaceorg.apache.cxf.interceptor.InterceptorProvider
-
getInInterceptors
public List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> getInInterceptors()- Specified by:
getInInterceptorsin interfaceorg.apache.cxf.interceptor.InterceptorProvider
-
getOutFaultInterceptors
public List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> getOutFaultInterceptors()- Specified by:
getOutFaultInterceptorsin interfaceorg.apache.cxf.interceptor.InterceptorProvider
-
getOutInterceptors
public List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> getOutInterceptors()- Specified by:
getOutInterceptorsin interfaceorg.apache.cxf.interceptor.InterceptorProvider
-
setInInterceptors
public void setInInterceptors(List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> interceptors) Sets the list of in interceptors which pre-process the responses from remote services.- Parameters:
interceptors- in interceptors
-
setOutInterceptors
public void setOutInterceptors(List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> interceptors) Sets the list of out interceptors which post-process the requests to the remote services.- Parameters:
interceptors- out interceptors
-
setInFaultInterceptors
public void setInFaultInterceptors(List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> interceptors) Sets the list of in fault interceptors which will deal with the HTTP faults; the client code may choose to catchWebApplicationExceptionexceptions instead.- Parameters:
interceptors- in fault interceptors
-
setOutFaultInterceptors
public void setOutFaultInterceptors(List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> interceptors) Sets the list of out fault interceptors which will deal with the client-side faults; the client code may choose to catchClientExceptionexceptions instead.- Parameters:
interceptors- out fault interceptors
-
getConduit
public org.apache.cxf.transport.Conduit getConduit()Gets the conduit responsible for a transport-level communication with the remote service.- Returns:
- the conduit
-
getHttpConduit
public org.apache.cxf.transport.http.HTTPConduit getHttpConduit()Gets the HTTP conduit responsible for a transport-level communication with the remote service.- Returns:
- the HTTP conduit
-
getResponseContext
Get the map of properties which affect the responses only. These additional properties may be optionally set after a proxy or WebClient has been created.- Returns:
- the response context properties
-
getRequestContext
Get the map of properties which affect the requests only. These additional properties may be optionally set after a proxy or WebClient has been created.- Returns:
- the request context properties
-
getEndpoint
public org.apache.cxf.endpoint.Endpoint getEndpoint() -
isShutdownBusOnClose
public boolean isShutdownBusOnClose() -
setShutdownBusOnClose
public void setShutdownBusOnClose(boolean shutdownBusOnClose) -
isResetThreadLocalStateImmediately
public boolean isResetThreadLocalStateImmediately() -
setResetThreadLocalStateImmediately
public void setResetThreadLocalStateImmediately(boolean reset)
-