ClientConfiguration (Apache CXF Runtime JAX-RS Frontend 2.6.16 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
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
`ClientConfiguration()`

Method Summary
`org.apache.cxf.Bus`	`getBus()` Gets the bus
`org.apache.cxf.transport.Conduit`	`getConduit()` Gets the conduit responsible for a transport-level communication with the remote service.
`org.apache.cxf.endpoint.ConduitSelector`	`getConduitSelector()` Gets the conduit selector
`org.apache.cxf.transport.http.HTTPConduit`	`getHttpConduit()` Gets 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>>`	`getInFaultInterceptors()`
`List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>>`	`getInInterceptors()`
`List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>>`	`getOutFaultInterceptors()`
`List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>>`	`getOutInterceptors()`
`Map<String,Object>`	`getRequestContext()` Get the map of properties which affect the requests only.
`Map<String,Object>`	`getResponseContext()` Get the map of properties which affect the responses only.
`long`	`getSynchronousTimeout()`
`boolean`	`isResponseExpectedForOneway()` Indicates if Response may still be expected for oneway requests.
`void`	`setBus(org.apache.cxf.Bus bus)` Sets the bus
`void`	`setConduitSelector(org.apache.cxf.endpoint.ConduitSelector cs)` Sets the conduit selector
`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 catch `ServerWebApplicationException` exceptions instead.
`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.
`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 catch `ClientWebApplicationException` exceptions instead.
`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.
`void`	`setSynchronousTimeout(long synchronousTimeout)` Sets the synchronous timeout

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

ClientConfiguration

public ClientConfiguration()

Method Detail

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:: setConduitSelector in interface org.apache.cxf.endpoint.ConduitSelectorHolder

Parameters:: cs - the selector

getConduitSelector

public org.apache.cxf.endpoint.ConduitSelector getConduitSelector()

Gets the conduit selector

Specified by:: getConduitSelector in interface org.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:: getInFaultInterceptors in interface org.apache.cxf.interceptor.InterceptorProvider

getInInterceptors

public List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> getInInterceptors()

Specified by:: getInInterceptors in interface org.apache.cxf.interceptor.InterceptorProvider

getOutFaultInterceptors

public List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> getOutFaultInterceptors()

Specified by:: getOutFaultInterceptors in interface org.apache.cxf.interceptor.InterceptorProvider

getOutInterceptors

public List<org.apache.cxf.interceptor.Interceptor<? extends org.apache.cxf.message.Message>> getOutInterceptors()

Specified by:: getOutInterceptors in interface org.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 catch ServerWebApplicationException exceptions 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 catch ClientWebApplicationException exceptions 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

public Map<String,Object> 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

public Map<String,Object> 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