Package org.springframework.integration.dsl

Class GatewayProxySpec

java.lang.Object
org.springframework.integration.dsl.GatewayProxySpec
All Implemented Interfaces:
ComponentsRegistration
public class GatewayProxySpec
extends java.lang.Object
implements ComponentsRegistration
A builder for the GatewayProxyFactoryBean options when MessagingGateway on the service interface cannot be declared.
Since:
5.2

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected GatewayMethodMetadata gatewayMethodMetadata  
    protected GatewayProxyFactoryBean gatewayProxyFactoryBean  
    protected org.springframework.messaging.MessageChannel gatewayRequestChannel  
    protected java.util.Map<java.lang.String,​org.springframework.expression.Expression> headerExpressions  
    protected static org.springframework.expression.spel.standard.SpelExpressionParser PARSER  

  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    protected GatewayProxySpec​(java.lang.Class<?> serviceInterface)  

  • Method Summary

    Modifier and Type Method Description
    GatewayProxySpec asyncExecutor​(java.util.concurrent.Executor executor)
    Provide a reference to an implementation of Executor to use for any of the interface methods that have a Future return type.
    GatewayProxySpec beanName​(java.lang.String beanName)
    Specify a bean name for the target GatewayProxyFactoryBean.
    GatewayProxySpec errorChannel​(java.lang.String errorChannelName)
    Identifies a channel that error messages will be sent to if a failure occurs in the gateway's proxy invocation.
    GatewayProxySpec errorChannel​(org.springframework.messaging.MessageChannel errorChannel)
    Identifies a channel that error messages will be sent to if a failure occurs in the gateway's proxy invocation.
    java.util.Map<java.lang.Object,​java.lang.String> getComponentsToRegister()  
    GatewayProxySpec header​(java.lang.String headerName, java.lang.Object value)
    Provides custom message header.
    GatewayProxySpec header​(java.lang.String headerName, java.util.function.Function<MethodArgsHolder,​?> valueFunction)
    Provides custom message header.
    GatewayProxySpec header​(java.lang.String headerName, org.springframework.expression.Expression valueExpression)
    Provides custom message header.
    GatewayProxySpec mapper​(MethodArgsMessageMapper mapper)
    An MethodArgsMessageMapper to map the method arguments to a Message.
    GatewayProxySpec payloadExpression​(java.lang.String expression)
    An expression that will be used to generate the payload for all methods in the service interface unless explicitly overridden by a method declaration.
    GatewayProxySpec payloadExpression​(org.springframework.expression.Expression expression)
    An expression that will be used to generate the payload for all methods in the service interface unless explicitly overridden by a method declaration.
    GatewayProxySpec payloadFunction​(java.util.function.Function<MethodArgsHolder,​?> defaultPayloadFunction)
    A Function that will be used to generate the payload for all methods in the service interface unless explicitly overridden by a method declaration.
    GatewayProxySpec proxyDefaultMethods​(boolean proxyDefaultMethods)
    Indicate if default methods on the interface should be proxied as well.
    GatewayProxySpec replyChannel​(java.lang.String channelName)
    Identifies the default channel the gateway proxy will subscribe to, to receive reply Messages, the payloads of which will be converted to the return type of the method signature.
    GatewayProxySpec replyChannel​(org.springframework.messaging.MessageChannel replyChannel)
    Identifies the default channel the gateway proxy will subscribe to, to receive reply Messages, the payloads of which will be converted to the return type of the method signature.
    GatewayProxySpec replyTimeout​(long replyTimeout)
    Allows to specify how long this gateway will wait for the reply Message before returning.
    GatewayProxySpec requestTimeout​(long requestTimeout)
    Provides the amount of time dispatcher would wait to send a Message.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait