Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GH-9427: Improve nullability for remote path expression (#9434)

Browse Source 
Fixes: #9427

Issue link: https://github.com/spring-projects/spring-integration/issues/9427

The `expression` of the `AbstractRemoteFileOutboundGateway` could be `null` and
ignored for some expressions making a DSL factories inconsistent

* Improve `AbstractRemoteFileOutboundGateway` constructor JavaDocs explaining
`expression` argument in more details
* Add `@Nullable` for this `expression` arg in all the `AbstractRemoteFileOutboundGateway` implementations
* Add new DSL factory method for `outboundGateway()` without this `expression` for those commands when it is not needed
This commit is contained in:
Artem Bilan
2024-08-30 11:52:44 -04:00
committed by GitHub
parent dc02dec4de
commit c27cc4b11c
7 changed files with 267 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
spring-integration-file/src/main/java/org/springframework/integration/file/remote/gateway/AbstractRemoteFileOutboundGateway.java
View File

@@ -153,10 +153,14 @@ public abstract class AbstractRemoteFileOutboundGateway<F> extends AbstractReply
/**
* Construct an instance with the supplied session factory,
* a command ('ls', 'get' etc.), and an expression to determine the filename.
* a command ('ls', 'get' etc.), and an expression to determine the remote path (file or directory).
* The expression is treated as a remote directory for {@code ls} and {@code nlst} commands
* and can be {@code null} if remote file protocol supports it with a meaning of root directory (or use home).
* The {@code put} and {@code mput} commands ignore this expression and fully rely on the payload.
* If expression is not provided, it falls back to the {@code payload}.
* @param sessionFactory the session factory.
* @param command the command.
* @param expression the filename expression.
* @param expression the remote path.
*/
public AbstractRemoteFileOutboundGateway(SessionFactory<F> sessionFactory, String command,
@Nullable String expression) {
@@ -166,10 +170,14 @@ public abstract class AbstractRemoteFileOutboundGateway<F> extends AbstractReply
/**
* Construct an instance with the supplied session factory,
* a command ('ls', 'get' etc.), and an expression to determine the filename.
* a command ('ls', 'get' etc.), and an expression to determine the remote path (file or directory).
* The expression is treated as a remote directory for {@code ls} and {@code nlst} commands
* and can be {@code null} if remote file protocol supports it with a meaning of root directory (or use home).
* The {@code put} and {@code mput} commands ignore this expression and fully rely on the payload.
* If expression is not provided, it falls back to the {@code payload}.
* @param sessionFactory the session factory.
* @param command the command.
* @param expression the filename expression.
* @param expression the remote path.
*/
public AbstractRemoteFileOutboundGateway(SessionFactory<F> sessionFactory, Command command,
@Nullable String expression) {
@@ -180,10 +188,14 @@ public abstract class AbstractRemoteFileOutboundGateway<F> extends AbstractReply
/**
* Construct an instance with the supplied remote file template,
* a command ('ls', 'get' etc.), and an expression to determine the filename.
* a command ('ls', 'get' etc.), and an expression to determine the remote path (file or directory).
* The expression is treated as a remote directory for {@code ls} and {@code nlst} commands
* and can be {@code null} if remote file protocol supports it with a meaning of root directory (or use home).
* The {@code put} and {@code mput} commands ignore this expression and fully rely on the payload.
* If expression is not provided, it falls back to the {@code payload}.
* @param remoteFileTemplate the remote file template.
* @param command the command.
* @param expression the filename expression.
* @param expression the remote path.
*/
public AbstractRemoteFileOutboundGateway(RemoteFileTemplate<F> remoteFileTemplate, String command,
@Nullable String expression) {
@@ -193,10 +205,14 @@ public abstract class AbstractRemoteFileOutboundGateway<F> extends AbstractReply
/**
* Construct an instance with the supplied remote file template,
* a command ('ls', 'get' etc.), and an expression to determine the filename.
* a command ('ls', 'get' etc.), and an expression to determine the remote path (file or directory).
* The expression is treated as a remote directory for {@code ls} and {@code nlst} commands
* and can be {@code null} if remote file protocol supports it with a meaning of root directory (or use home).
* The {@code put} and {@code mput} commands ignore this expression and fully rely on the payload.
* If expression is not provided, it falls back to the {@code payload}.
* @param remoteFileTemplate the remote file template.
* @param command the command.
* @param expressionArg the filename expression.
* @param expressionArg the remote path.
*/
public AbstractRemoteFileOutboundGateway(RemoteFileTemplate<F> remoteFileTemplate, Command command,
@Nullable String expressionArg) {