Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Apache CXF API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.cxf.endpoint
Interface Client

All Superinterfaces:
ConduitSelectorHolder, InterceptorProvider, MessageObserver
All Known Implementing Classes:
ClientImpl
public interface Client
extends InterceptorProvider, MessageObserver, ConduitSelectorHolder

Field Summary
static String KEEP_CONDUIT_ALIVE
           
static String REQUEST_CONTEXT
           
static String RESPONSE_CONTEXT
           
 
Method Summary
 void destroy()
          Indicates that the client is no longer needed and that any resources it holds can now be freed.
 Bus getBus()
          Retrieves the Bus that was used to create the Client
 Conduit getConduit()
          Get the Conduit that messages for this client will be sent on.
 ConduitSelector getConduitSelector()
          Get the ConduitSelector responsible for retreiving the Conduit.
 Endpoint getEndpoint()
           
 Map<String,Object> getRequestContext()
          Gets the request context used for future invocations
 Map<String,Object> getResponseContext()
          Gets the response context from the last invocation on this thread
 Object[] invoke(BindingOperationInfo oi, Object... params)
          Invokes an operation synchronously
 Object[] invoke(BindingOperationInfo oi, Object[] params, Map<String,Object> context)
          Invokes an operation synchronously
 Object[] invoke(BindingOperationInfo oi, Object[] params, Map<String,Object> context, Exchange exchange)
          Invokes an operation synchronously
 void invoke(ClientCallback callback, BindingOperationInfo oi, Object... params)
          Invokes an operation asynchronously
 void invoke(ClientCallback callback, BindingOperationInfo oi, Object[] params, Exchange exchange)
          Invokes an operation asynchronously
 void invoke(ClientCallback callback, BindingOperationInfo oi, Object[] params, Map<String,Object> context)
          Invokes an operation asynchronously
 void invoke(ClientCallback callback, BindingOperationInfo oi, Object[] params, Map<String,Object> context, Exchange exchange)
          Invokes an operation asynchronously
 void invoke(ClientCallback callback, QName operationName, Object... params)
          Invokes an operation asynchronously
 void invoke(ClientCallback callback, String operationName, Object... params)
          Invokes an operation asynchronously
 Object[] invoke(QName operationName, Object... params)
          Invokes an operation synchronously
 Object[] invoke(String operationName, Object... params)
          Invokes an operation synchronously
 void invokeWrapped(ClientCallback callback, QName operationName, Object... params)
          Invokes an operation asynchronously
 void invokeWrapped(ClientCallback callback, String operationName, Object... params)
          Invokes an operation asynchronously
 Object[] invokeWrapped(QName operationName, Object... params)
          Invokes an operation synchronously
 Object[] invokeWrapped(String operationName, Object... params)
          Invokes an operation synchronously
 boolean isThreadLocalRequestContext()
          Checks if the Request context is thread local or global.
 void setConduitSelector(ConduitSelector selector)
          Set the ConduitSelector responsible for retreiving the Conduit.
 void setExecutor(Executor executor)
          Sets the executor which is used to process Asynchronous responses.
 void setThreadLocalRequestContext(boolean b)
          Sets whether the request context is thread local or global to this client.
 
Methods inherited from interface org.apache.cxf.interceptor.InterceptorProvider
getInFaultInterceptors, getInInterceptors, getOutFaultInterceptors, getOutInterceptors
 
Methods inherited from interface org.apache.cxf.transport.MessageObserver
onMessage
 

Field Detail

REQUEST_CONTEXT

static final String REQUEST_CONTEXT
See Also:
Constant Field Values

RESPONSE_CONTEXT

static final String RESPONSE_CONTEXT
See Also:
Constant Field Values

KEEP_CONDUIT_ALIVE

static final String KEEP_CONDUIT_ALIVE
See Also:
Constant Field Values
Method Detail

invoke

Object[] invoke(String operationName,
                Object... params)
                throws Exception
Invokes an operation synchronously

Parameters:
operationName - The name of the operation to be invoked. The service namespace will be used when looking up the BindingOperationInfo.
params - The params that matches the parts of the input message of the operation. If the BindingOperationInfo supports unwrapping, it assumes the params are in the "unwrapped" form. If params are in the wrapped form, use invokeWrapped
Returns:
The return values that matche the parts of the output message of the operation
Throws:
Exception

invoke

Object[] invoke(QName operationName,
                Object... params)
                throws Exception
Invokes an operation synchronously

Parameters:
operationName - The name of the operation to be invoked
params - The params that matches the parts of the input message of the operation. If the BindingOperationInfo supports unwrapping, it assumes the params are in the "unwrapped" form. If params are in the wrapped form, use invokeWrapped
Returns:
The return values that matche the parts of the output message of the operation
Throws:
Exception

invokeWrapped

Object[] invokeWrapped(String operationName,
                       Object... params)
                       throws Exception
Invokes an operation synchronously

Parameters:
operationName - The name of the operation to be invoked. The service namespace will be used when looking up the BindingOperationInfo.
params - The params that matches the parts of the input message of the operation
Returns:
The return values that matche the parts of the output message of the operation
Throws:
Exception

invokeWrapped

Object[] invokeWrapped(QName operationName,
                       Object... params)
                       throws Exception
Invokes an operation synchronously

Parameters:
operationName - The name of the operation to be invoked
params - The params that matches the parts of the input message of the operation
Returns:
The return values that matche the parts of the output message of the operation
Throws:
Exception

invoke

Object[] invoke(BindingOperationInfo oi,
                Object... params)
                throws Exception
Invokes an operation synchronously

Parameters:
oi - The operation to be invoked
params - The params that matches the parts of the input message of the operation
Returns:
The return values that matche the parts of the output message of the operation
Throws:
Exception

invoke

Object[] invoke(BindingOperationInfo oi,
                Object[] params,
                Map<String,Object> context)
                throws Exception
Invokes an operation synchronously

Parameters:
oi - The operation to be invoked
params - The params that matches the parts of the input message of the operation
context - Optional (can be null) contextual information for the invocation
Returns:
The return values that matche the parts of the output message of the operation
Throws:
Exception

invoke

Object[] invoke(BindingOperationInfo oi,
                Object[] params,
                Map<String,Object> context,
                Exchange exchange)
                throws Exception
Invokes an operation synchronously

Parameters:
oi - The operation to be invoked
params - The params that matches the parts of the input message of the operation
context - Optional (can be null) contextual information for the invocation
exchange - The Exchange to be used for the invocation
Returns:
The return values that matche the parts of the output message of the operation
Throws:
Exception

invoke

void invoke(ClientCallback callback,
            String operationName,
            Object... params)
            throws Exception
Invokes an operation asynchronously

Parameters:
callback - The callback that is called when the response is ready
operationName - The name of the operation to be invoked. The service namespace will be used when looking up the BindingOperationInfo.
params - The params that matches the parts of the input message of the operation. If the BindingOperationInfo supports unwrapping, it assumes the params are in the "unwrapped" form. If params are in the wrapped form, use invokeWrapped
Throws:
Exception

invoke

void invoke(ClientCallback callback,
            QName operationName,
            Object... params)
            throws Exception
Invokes an operation asynchronously

Parameters:
callback - The callback that is called when the response is ready
operationName - The name of the operation to be invoked
params - The params that matches the parts of the input message of the operation. If the BindingOperationInfo supports unwrapping, it assumes the params are in the "unwrapped" form. If params are in the wrapped form, use invokeWrapped
Throws:
Exception

invokeWrapped

void invokeWrapped(ClientCallback callback,
                   String operationName,
                   Object... params)
                   throws Exception
Invokes an operation asynchronously

Parameters:
callback - The callback that is called when the response is ready
operationName - The name of the operation to be invoked. The service namespace will be used when looking up the BindingOperationInfo.
params - The params that matches the parts of the input message of the operation
Throws:
Exception

invokeWrapped

void invokeWrapped(ClientCallback callback,
                   QName operationName,
                   Object... params)
                   throws Exception
Invokes an operation asynchronously

Parameters:
callback - The callback that is called when the response is ready
operationName - The name of the operation to be invoked
params - The params that matches the parts of the input message of the operation
Throws:
Exception

invoke

void invoke(ClientCallback callback,
            BindingOperationInfo oi,
            Object... params)
            throws Exception
Invokes an operation asynchronously

Parameters:
callback - The callback that is called when the response is ready
oi - The operation to be invoked
params - The params that matches the parts of the input message of the operation
Throws:
Exception

invoke

void invoke(ClientCallback callback,
            BindingOperationInfo oi,
            Object[] params,
            Map<String,Object> context)
            throws Exception
Invokes an operation asynchronously

Parameters:
callback - The callback that is called when the response is ready
oi - The operation to be invoked
params - The params that matches the parts of the input message of the operation
context - contextual information for the invocation
Throws:
Exception

invoke

void invoke(ClientCallback callback,
            BindingOperationInfo oi,
            Object[] params,
            Exchange exchange)
            throws Exception
Invokes an operation asynchronously

Parameters:
callback - The callback that is called when the response is ready
oi - The operation to be invoked
params - The params that matches the parts of the input message of the operation
exchange - The Exchange to be used for the invocation
Throws:
Exception

invoke

void invoke(ClientCallback callback,
            BindingOperationInfo oi,
            Object[] params,
            Map<String,Object> context,
            Exchange exchange)
            throws Exception
Invokes an operation asynchronously

Parameters:
callback - The callback that is called when the response is ready
oi - The operation to be invoked
params - The params that matches the parts of the input message of the operation
context - Optional (can be null) contextual information for the invocation
exchange - Optional (can be null) The Exchange to be used for the invocation
Throws:
Exception

getRequestContext

Map<String,Object> getRequestContext()
Gets the request context used for future invocations

Returns:
context The context

getResponseContext

Map<String,Object> getResponseContext()
Gets the response context from the last invocation on this thread

Returns:
context The context

setThreadLocalRequestContext

void setThreadLocalRequestContext(boolean b)
Sets whether the request context is thread local or global to this client. By default, the request context is "global" in that any values set in the context are seen by all threads using this client. If set to true, the context is changed to be a ThreadLocal and values set are not seen by other threads.

Parameters:
b -

isThreadLocalRequestContext

boolean isThreadLocalRequestContext()
Checks if the Request context is thread local or global.

Returns:
true if the request context is a thread local

getEndpoint

Endpoint getEndpoint()

getConduit

Conduit getConduit()
Get the Conduit that messages for this client will be sent on.

Returns:
Conduit

getConduitSelector

ConduitSelector getConduitSelector()
Get the ConduitSelector responsible for retreiving the Conduit.

Specified by:
getConduitSelector in interface ConduitSelectorHolder
Returns:
the current ConduitSelector

setConduitSelector

void setConduitSelector(ConduitSelector selector)
Set the ConduitSelector responsible for retreiving the Conduit.

Specified by:
setConduitSelector in interface ConduitSelectorHolder
Parameters:
selector - the ConduitSelector to use

destroy

void destroy()
Indicates that the client is no longer needed and that any resources it holds can now be freed.

setExecutor

void setExecutor(Executor executor)
Sets the executor which is used to process Asynchronous responses. The default is to use the threads provided by the transport. (example: the JMS listener threads)

Parameters:
executor -

getBus

Bus getBus()
Retrieves the Bus that was used to create the Client

Returns:
the Bus
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Apache CXF API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Apache CXF