Apache CXF API

org.apache.cxf.endpoint
Interface Client

All Superinterfaces:
InterceptorProvider, MessageObserver

public interface Client
extends InterceptorProvider, MessageObserver


Field Summary
static java.lang.String REQUEST_CONTEXT
           
static java.lang.String REQUEST_METHOD
           
static java.lang.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.
 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()
           
 java.lang.Object[] invoke(BindingOperationInfo oi, java.lang.Object... params)
          Invokes an operation syncronously
 java.lang.Object[] invoke(BindingOperationInfo oi, java.lang.Object[] params, java.util.Map<java.lang.String,java.lang.Object> context)
          Invokes an operation syncronously
 java.lang.Object[] invoke(javax.xml.namespace.QName operationName, java.lang.Object... params)
          Invokes an operation syncronously
 java.lang.Object[] invoke(java.lang.String operationName, java.lang.Object... params)
          Invokes an operation syncronously
 java.lang.Object[] invokeWrapped(javax.xml.namespace.QName operationName, java.lang.Object... params)
          Invokes an operation syncronously
 java.lang.Object[] invokeWrapped(java.lang.String operationName, java.lang.Object... params)
          Invokes an operation syncronously
 void setConduitSelector(ConduitSelector selector)
          Set the ConduitSelector responsible for retreiving the Conduit.
 
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 java.lang.String REQUEST_CONTEXT
See Also:
Constant Field Values

RESPONSE_CONTEXT

static final java.lang.String RESPONSE_CONTEXT
See Also:
Constant Field Values

REQUEST_METHOD

static final java.lang.String REQUEST_METHOD
See Also:
Constant Field Values
Method Detail

invoke

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

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:
java.lang.Exception

invoke

java.lang.Object[] invoke(javax.xml.namespace.QName operationName,
                          java.lang.Object... params)
                          throws java.lang.Exception
Invokes an operation syncronously

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:
java.lang.Exception

invokeWrapped

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

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:
java.lang.Exception

invokeWrapped

java.lang.Object[] invokeWrapped(javax.xml.namespace.QName operationName,
                                 java.lang.Object... params)
                                 throws java.lang.Exception
Invokes an operation syncronously

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:
java.lang.Exception

invoke

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

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:
java.lang.Exception

invoke

java.lang.Object[] invoke(BindingOperationInfo oi,
                          java.lang.Object[] params,
                          java.util.Map<java.lang.String,java.lang.Object> context)
                          throws java.lang.Exception
Invokes an operation syncronously

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:
java.lang.Exception

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.

Returns:
the current ConduitSelector

setConduitSelector

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

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.


Apache CXF API

Apache CXF is an effort undergoing incubation at the Apache Software Foundation(ASF) and sponsored by the Apache Incubator PMC.