com.zeroc.Ice.DispatchInterceptor Maven / Gradle / Ivy
Show all versions of ice Show documentation
//
// Copyright (c) ZeroC, Inc. All rights reserved.
//
package com.zeroc.Ice;
import java.util.concurrent.CompletionStage;
/**
* Base class that allows a server to intercept incoming requests.
* The application must derive a concrete class from DispatchInterceptor
* that implements the {@link DispatchInterceptor#dispatch} operation. An instance of this derived
* class can be registered with an object adapter like any other servant.
*
* A dispatch interceptor is useful particularly to automatically retry requests
* that have failed due to a recoverable error condition.
**/
public abstract class DispatchInterceptor implements com.zeroc.Ice.Object
{
/**
* Called by the Ice run time to dispatch an incoming request. The implementation
* of dispatch must dispatch the request to the actual servant.
*
* @param request The details of the incoming request.
* @return A completion stage if dispatched asynchronously, null otherwise.
* @throws UserException A user exception that propagates out of this method will be
* marshaled as the result.
*
* @see Request
**/
public abstract CompletionStage dispatch(Request request)
throws UserException;
/** @hidden */
@Override
public CompletionStage _iceDispatch(com.zeroc.IceInternal.Incoming in, Current current)
throws UserException
{
try
{
return dispatch(in);
}
catch(java.lang.Throwable ex)
{
//
// If the input parameters weren't read, make sure we skip them here. It's needed to read the
// encoding version used by the client to eventually marshal the user exception. It's also needed
// if we dispatch a batch oneway request to read the next batch request.
//
if(current.encoding == null || (current.encoding.major == 0 && current.encoding.minor == 0))
{
in.skipReadParams();
}
throw ex;
}
}
}