IConversationFlowListener.Builder

java.lang.Object
- com.sap.smp.client.httpc.listeners.IConversationFlowListener.Builder

Enclosing interface:

IConversationFlowListener
```
public static class IConversationFlowListener.Builder
extends java.lang.Object
```
Internally used builder class. An instance of this type can be acquired using IConversationFlowListener.prepareFor().

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IConversationFlowListener`	`build()` Creates a new `IConversationFlowListener` with the listeners configured by the various methods before this method is called.
`IConversationFlowListener.Builder`	`cancellationByRequestFilter(ICancellationByRequestFilterListener cancellationByRequestFilterListener)` Sets the listener to invoke when a request filter cancels a conversation.
`IConversationFlowListener.Builder`	`cancellationByRequestListener(ICancellationByRequestListenerListener cancellationByRequestListenerListener)` Sets the listener to invoke when a request listener cancels a conversation.
`IConversationFlowListener.Builder`	`cancellationByResponseFilter(ICancellationByResponseFilterListener cancellationByResponseFilterListener)` Sets the listener to invoke when a response filter cancels a conversation.
`IConversationFlowListener.Builder`	`communicationError(ICommunicationErrorListener communicationErrorListener)` Sets the listener to invoke when a conversation runs into a low-level IO error.
`IConversationFlowListener.Builder`	`completion(IConversationCompletionListener conversationCompletionListener)` Sets the listener to invoke when a conversation completes, either successfully or with an error.
`IConversationFlowListener.Builder`	`externalCancellation(IExternalCancellationListener externalCancellationListener)` Sets the listener to invoke when a conversation is cancelled externally (i.e.
`IConversationFlowListener.Builder`	`maximumRestartsReached(IMaximumRestartsReachedListener maximumRestartsReachedListener)` Sets the listener to invoke when a conversation has been restarted too many times.

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

- Method Detail
  - cancellationByRequestFilter
```
public IConversationFlowListener.Builder cancellationByRequestFilter(ICancellationByRequestFilterListener cancellationByRequestFilterListener)
```
    Sets the listener to invoke when a request filter cancels a conversation.
    
    Parameters:
    
    cancellationByRequestFilterListener - the listener to set, can be null
    
    Returns:
    
    this, for method chaining
  - cancellationByRequestListener
```
public IConversationFlowListener.Builder cancellationByRequestListener(ICancellationByRequestListenerListener cancellationByRequestListenerListener)
```
    Sets the listener to invoke when a request listener cancels a conversation.
    
    Parameters:
    
    cancellationByRequestListenerListener - the listener to set, can be null
    
    Returns:
    
    this, for method chaining
  - cancellationByResponseFilter
```
public IConversationFlowListener.Builder cancellationByResponseFilter(ICancellationByResponseFilterListener cancellationByResponseFilterListener)
```
    Sets the listener to invoke when a response filter cancels a conversation.
    
    Parameters:
    
    cancellationByResponseFilterListener - the listener to set, can be null
    
    Returns:
    
    this, for method chaining
  - externalCancellation
```
public IConversationFlowListener.Builder externalCancellation(IExternalCancellationListener externalCancellationListener)
```
    Sets the listener to invoke when a conversation is cancelled externally (i.e. using IHttpConversation.cancel()).
    
    Parameters:
    
    externalCancellationListener - the listener to set, can be null
    
    Returns:
    
    this, for method chaining
  - maximumRestartsReached
```
public IConversationFlowListener.Builder maximumRestartsReached(IMaximumRestartsReachedListener maximumRestartsReachedListener)
```
    Sets the listener to invoke when a conversation has been restarted too many times.
    
    Parameters:
    
    maximumRestartsReachedListener - the listener to set, can be null
    
    Returns:
    
    this, for method chaining
  - communicationError
```
public IConversationFlowListener.Builder communicationError(ICommunicationErrorListener communicationErrorListener)
```
    Sets the listener to invoke when a conversation runs into a low-level IO error.
    
    Parameters:
    
    communicationErrorListener - the listener to set, can be null
    
    Returns:
    
    this, for method chaining
  - completion
```
public IConversationFlowListener.Builder completion(IConversationCompletionListener conversationCompletionListener)
```
    Sets the listener to invoke when a conversation completes, either successfully or with an error. Always invoked at the end.
    
    Parameters:
    
    conversationCompletionListener - the listener to set, can be null
    
    Returns:
    
    this, for method chaining
  - build
```
public IConversationFlowListener build()
```
    Creates a new IConversationFlowListener with the listeners configured by the various methods before this method is called. Any changes to individual event listeners on this builder will not affect the set of listeners used by the returned object.
    You can use a builder as many times you want. Each time this method is called it will take a snapshot of the currently configured listenerd in this instance and compose a new flow listener object using them.
    
    Unconfigured events are simply discarded by the returned listener instance.
    
    Returns:
    
    a newly created flow listener instance containing all the configured listeners, always non-null

Class IConversationFlowListener.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

cancellationByRequestFilter

cancellationByRequestListener

cancellationByResponseFilter

externalCancellation

maximumRestartsReached

communicationError

completion

build