7 | For further API reference and developer documentation, see the
8 | Spring
9 | Integration reference documentation.
10 | That documentation contains more detailed, developer-targeted
11 | descriptions, with conceptual overviews, definitions of terms,
12 | workarounds, and working code examples.
13 |
21 | If you are interested in commercial training, consultancy, and
22 | support for Spring Integration, please visit
23 | https://spring.io
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/.github/workflows/verify-staged-artifacts.yml:
--------------------------------------------------------------------------------
1 | name: Verify Staged Artifacts
2 |
3 | on:
4 | workflow_dispatch:
5 | inputs:
6 | releaseVersion:
7 | description: 'Release version like 3.0.0-M1, 3.1.0-RC1, 3.2.0 etc.'
8 | required: true
9 | type: string
10 |
11 | jobs:
12 | verify-staged-with-jfrog:
13 | runs-on: ubuntu-latest
14 | steps:
15 |
16 | - uses: jfrog/setup-jfrog-cli@v4
17 | env:
18 | JF_ENV_SPRING: ${{ secrets.JF_ARTIFACTORY_SPRING }}
19 |
20 | - name: Download Artifact from Staging Repo
21 | run: |
22 | fileToDownload=org/springframework/integration/spring-integration-aws/${{ inputs.releaseVersion }}/spring-integration-aws-${{ inputs.releaseVersion }}.jar
23 | jfrog rt download libs-staging-local/$fileToDownload
24 | if [ ! -f $fileToDownload ]
25 | then
26 | echo "::error title=No staged artifact::No spring-integration-aws-${{ inputs.releaseVersion }}.jar in staging repository"
27 | exit 1
28 | fi
--------------------------------------------------------------------------------
/src/dist/notice.txt:
--------------------------------------------------------------------------------
1 | ========================================================================
2 | == NOTICE file corresponding to section 4 d of the Apache License, ==
3 | == Version 2.0, in this case for the Spring Integration distribution. ==
4 | ========================================================================
5 |
6 | This product includes software developed by
7 | the Apache Software Foundation (https://www.apache.org).
8 |
9 | The end-user documentation included with a redistribution, if any,
10 | must include the following acknowledgement:
11 |
12 | "This product includes software developed by the Spring Framework
13 | Project (https://www.springframework.org)."
14 |
15 | Alternatively, this acknowledgement may appear in the software itself,
16 | if and wherever such third-party acknowledgements normally appear.
17 |
18 | The names "Spring", "Spring Framework", and "Spring Integration" must
19 | not be used to endorse or promote products derived from this software
20 | without prior written permission. For written permission, please contact
21 | enquiries@springsource.com.
22 |
--------------------------------------------------------------------------------
/.github/workflows/release.yml:
--------------------------------------------------------------------------------
1 | name: Release
2 |
3 | on:
4 | workflow_dispatch:
5 |
6 | run-name: Release current version for branch ${{ github.ref_name }}
7 |
8 | jobs:
9 | release:
10 | permissions:
11 | actions: write
12 | contents: write
13 | issues: write
14 |
15 | uses: spring-io/spring-github-workflows/.github/workflows/spring-artifactory-gradle-release.yml@main
16 | with:
17 | buildToolArgs: dist
18 | secrets:
19 | GH_ACTIONS_REPO_TOKEN: ${{ secrets.GH_ACTIONS_REPO_TOKEN }}
20 | DEVELOCITY_ACCESS_KEY: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
21 | JF_ARTIFACTORY_SPRING: ${{ secrets.JF_ARTIFACTORY_SPRING }}
22 | ARTIFACTORY_USERNAME: ${{ secrets.ARTIFACTORY_USERNAME }}
23 | ARTIFACTORY_PASSWORD: ${{ secrets.ARTIFACTORY_PASSWORD }}
24 | CENTRAL_TOKEN_USERNAME: ${{ secrets.CENTRAL_TOKEN_USERNAME }}
25 | CENTRAL_TOKEN_PASSWORD: ${{ secrets.CENTRAL_TOKEN_PASSWORD }}
26 | GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
27 | GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
28 | SPRING_RELEASE_CHAT_WEBHOOK_URL: ${{ secrets.SPRING_RELEASE_GCHAT_WEBHOOK_URL }}
--------------------------------------------------------------------------------
/src/test/java/org/springframework/integration/aws/inbound/subscriptionConfirmation.json:
--------------------------------------------------------------------------------
1 | {
2 | "Type": "SubscriptionConfirmation",
3 | "MessageId": "e267b24c-5532-472f-889d-c2cdd2143bbc",
4 | "Token": "111",
5 | "TopicArn": "arn:aws:sns:eu-west-1:111111111111:mySampleTopic",
6 | "Message": "You have chosen to subscribe to the topic arn:aws:sns:eu-west-1:721324560415:mySampleTopic.To confirm the subscription, visit the SubscribeURL included in this message.",
7 | "SubscribeURL": "https://sns.eu-west-1.amazonaws.com/?Action=ConfirmSubscription&TopicArn=arn:aws:sns:eu-west-1:111111111111:mySampleTopic&Token=111",
8 | "Timestamp": "2014-06-28T10:22:18.086Z",
9 | "SignatureVersion": "1",
10 | "Signature": "JLdRUR+uhP4cyVW6bRuUSAkUosFMJyO7g7WCAwEUJoB4y8vQE1uDUWGpbQSEbruVTjPEM8hFsf4/95NftfM0W5IgND1uSnv4P/4AYyL+q0bLOJlquzXrw4w2NX3QShS3y+r/gXzo7p/UP4NOr35MGCEGPqHAEe1Coc5S0eaP3JvKU6xY1tcop6ze2RNHTwzhM43dda2bnjPYogAJzA5uHfmSjs3cMVvPCckj3zdLyvxISp+RgrogdvlNyu9ycND1SxagmbzjkBaqvF/4aiSYFxsEXX4e9zuNuHGmXGWgm1ppYUGLSPPJruCsPUa7Ii1mYvpX7SezuFZlAAXXBk0mHg==",
11 | "SigningCertURL": "https://sns.eu-west-1.amazonaws.com/SimpleNotificationService-e372f8ca30337fdb084e8ac449342c77.pem"
12 | }
13 |
--------------------------------------------------------------------------------
/src/test/java/org/springframework/integration/aws/inbound/unsubscribeConfirmation.json:
--------------------------------------------------------------------------------
1 | {
2 | "Type": "UnsubscribeConfirmation",
3 | "MessageId": "7b9a6321-45d5-461a-bc35-9c2d18ed9dbe",
4 | "Token": "233",
5 | "TopicArn": "arn:aws:sns:eu-west-1:111111111111:mySampleTopic",
6 | "Message": "You have chosen to deactivate subscription arn:aws:sns:eu-west-1:111111111111:mySampleTopic:f64111de-e681-4820-a8be-474f64c1bbf8.\nTo cancel this operation and restore the subscription, visit the SubscribeURL included in this message.",
7 | "SubscribeURL": "https://sns.eu-west-1.amazonaws.com/?Action=ConfirmSubscription&TopicArn=arn:aws:sns:eu-west-1:721324560415:mySampleTopic&Token=233",
8 | "Timestamp": "2014-06-28T19:33:00.497Z",
9 | "SignatureVersion": "1",
10 | "Signature": "EAb0k1XoD2h+u4j2GB42wEFCVUFKEaS/2W+p+3wK1GfZDZn4LeDLbkxJ1LYF/A1CYL+sCJ4ZmLFI1axm0V/p+fESkNbKQoQotMgma+PtA6KnmRrKEU8O6nUELqeVPWFAoQ9ZsW9FCAXVDXoPxiqHNTH+tC7mzAsvajyp4aTm/POqkRKBl+A/7dHUqfHGup/FJhLNgTAciBZSloa5EuBKxInJQfoZjy3DU8qKXXhmKKRdyVwOGEuReo/njy4c3Phtn0+logu2PZUKqkGTuJZVbapHmcTq+0MqIh05sevLDmTEfBlsmNThhWIyCza/t68RRlqm9cRLjINSWfrv1Xkrpw==",
11 | "SigningCertURL": "https://sns.eu-west-1.amazonaws.com/SimpleNotificationService-e372f8ca30337fdb084e8ac449342c77.pem"
12 | }
13 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/event/KinesisIntegrationEvent.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2019-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.event;
18 |
19 | /**
20 | * A common event type for AWS Kinesis Channel Adapters.
21 | *
22 | * @author Artem Bilan
23 | *
24 | * @since 2.3
25 | */
26 | @SuppressWarnings("serial")
27 | public abstract class KinesisIntegrationEvent extends AwsIntegrationEvent {
28 |
29 | public KinesisIntegrationEvent(Object source) {
30 | super(source);
31 | }
32 |
33 | public KinesisIntegrationEvent(Object source, Throwable cause) {
34 | super(source, cause);
35 | }
36 |
37 | }
38 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/inbound/kinesis/ListenerMode.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2017-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.inbound.kinesis;
18 |
19 | import org.springframework.messaging.Message;
20 |
21 | /**
22 | * The listener mode, record or batch.
23 | *
24 | * @author Artem Bilan
25 | *
26 | * @since 1.1
27 | */
28 | public enum ListenerMode {
29 |
30 | /**
31 | * Each {@link Message} will be converted from a single {@code Record}.
32 | */
33 | record,
34 |
35 | /**
36 | * Each {@link Message} will contain {@code List} ( if not empty) of converted or raw
37 | * {@code Record}s.
38 | */
39 | batch
40 |
41 | }
42 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/event/AwsIntegrationEvent.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2019-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.event;
18 |
19 | import org.springframework.integration.events.IntegrationEvent;
20 |
21 | /**
22 | * A common event type for AWS Channel Adapters.
23 | *
24 | * @author Artem Bilan
25 | *
26 | * @since 2.3
27 | */
28 | @SuppressWarnings("serial")
29 | public abstract class AwsIntegrationEvent extends IntegrationEvent {
30 |
31 | public AwsIntegrationEvent(Object source) {
32 | super(source);
33 | }
34 |
35 | public AwsIntegrationEvent(Object source, Throwable cause) {
36 | super(source, cause);
37 | }
38 |
39 | }
40 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/event/KinesisShardEndedEvent.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2019-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.event;
18 |
19 | /**
20 | * An event emitted when shard is closed for consumption.
21 | *
22 | * @author Artem Bilan
23 | *
24 | * @since 2.3
25 | */
26 | @SuppressWarnings("serial")
27 | public class KinesisShardEndedEvent extends KinesisIntegrationEvent {
28 |
29 | private final String shardKey;
30 |
31 | public KinesisShardEndedEvent(Object source, String shardKey) {
32 | super(source);
33 | this.shardKey = shardKey;
34 | }
35 |
36 | public String getShardKey() {
37 | return this.shardKey;
38 | }
39 |
40 | }
41 |
--------------------------------------------------------------------------------
/src/test/java/org/springframework/integration/aws/inbound/notificationMessage.json:
--------------------------------------------------------------------------------
1 | {
2 | "Type": "Notification",
3 | "MessageId": "f2c15fec-c617-5b08-b54d-13c4099fec60",
4 | "TopicArn": "arn:aws:sns:eu-west-1:111111111111:mySampleTopic",
5 | "Subject": "foo",
6 | "Message": "bar",
7 | "Timestamp": "2014-06-28T14:12:24.418Z",
8 | "SignatureVersion": "1",
9 | "Signature": "XDvKSAnhxECrAmyIrs0Dsfbp/tnKD1IvoOOYTU28FtbUoxr/CgziuW87yZwTuSNNbHJbdD3BEjHS0vKewm0xBeQ0PToDkgtoORXo5RWnmShDQ2nhkthFhZnNulKtmFtRogjBtCwbz8sPnbOCSk21ruyXNdV2RUbdDalndAW002CWEQmYMxFSN6OXUtMueuT610aX+tqeYP4Z6+8WTWLWjAuVyy7rOI6KHYBcVDhKtskvTOPZ4tiVohtQdQbO2Gjuh1vblRzzwMkfaoFTSWImd4pFXxEsv/fq9aGIlqq9xEryJ0w2huFwI5gxyhvGt0RnTd9YvmAEC+WzdJDOqaDNxg==",
10 | "SigningCertURL": "https://sns.eu-west-1.amazonaws.com/SimpleNotificationService-e372f8ca30337fdb084e8ac449342c77.pem",
11 | "UnsubscribeURL": "https://sns.eu-west-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:eu-west-1:721324560415:mySampleTopic:9859a6c9-6083-4690-ab02-d1aead3442df",
12 | "MessageAttributes": {
13 | "AWS.SNS.MOBILE.MPNS.Type": {
14 | "Type": "String",
15 | "Value": "token"
16 | },
17 | "AWS.SNS.MOBILE.WNS.Type": {
18 | "Type": "String",
19 | "Value": "wns/badge"
20 | },
21 | "AWS.SNS.MOBILE.MPNS.NotificationClass": {
22 | "Type": "String",
23 | "Value": "realtime"
24 | }
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/inbound/kinesis/CheckpointMode.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2017-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.inbound.kinesis;
18 |
19 | /**
20 | * The listener mode, record or batch.
21 | *
22 | * @author Artem Bilan
23 | * @author Hervé Fortin
24 | *
25 | * @since 1.1
26 | */
27 | public enum CheckpointMode {
28 |
29 | /**
30 | * Checkpoint after each processed record. Makes sense only if
31 | * {@link ListenerMode#record} is used.
32 | */
33 | record,
34 |
35 | /**
36 | * Checkpoint after each processed batch of records.
37 | */
38 | batch,
39 |
40 | /**
41 | * Checkpoint on demand via provided to the message {@link Checkpointer} callback.
42 | */
43 | manual,
44 |
45 | /**
46 | * Checkpoint at fixed time intervals.
47 | * @since 2.2.0
48 | */
49 | periodic
50 |
51 | }
52 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/inbound/kinesis/Checkpointer.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2017-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.inbound.kinesis;
18 |
19 | /**
20 | * A callback for target record process to perform checkpoint on the related shard.
21 | *
22 | * @author Artem Bilan
23 | * @since 1.1
24 | */
25 | public interface Checkpointer {
26 |
27 | /**
28 | * Checkpoint the currently held sequence number if it is bigger than already stored.
29 | * @return true if checkpoint performed; false otherwise.
30 | */
31 | boolean checkpoint();
32 |
33 | /**
34 | * Checkpoint the provided sequence number, if it is bigger than already stored.
35 | * @param sequenceNumber the sequence number to checkpoint.
36 | * @return true if checkpoint performed; false otherwise.
37 | */
38 | boolean checkpoint(String sequenceNumber);
39 |
40 | }
41 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/support/filters/S3SimplePatternFileListFilter.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.support.filters;
18 |
19 | import software.amazon.awssdk.services.s3.model.S3Object;
20 |
21 | import org.springframework.integration.file.filters.AbstractSimplePatternFileListFilter;
22 |
23 | /**
24 | * Implementation of {@link AbstractSimplePatternFileListFilter} for Amazon S3.
25 | *
26 | * @author Artem Bilan
27 | */
28 | public class S3SimplePatternFileListFilter extends AbstractSimplePatternFileListFilter {
29 |
30 | public S3SimplePatternFileListFilter(String pattern) {
31 | super(pattern);
32 | }
33 |
34 | @Override
35 | protected String getFilename(S3Object file) {
36 | return (file != null) ? file.key() : null;
37 | }
38 |
39 | @Override
40 | protected boolean isDirectory(S3Object file) {
41 | return false;
42 | }
43 |
44 | }
45 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/support/filters/S3RegexPatternFileListFilter.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.support.filters;
18 |
19 | import java.util.regex.Pattern;
20 |
21 | import software.amazon.awssdk.services.s3.model.S3Object;
22 |
23 | import org.springframework.integration.file.filters.AbstractRegexPatternFileListFilter;
24 |
25 | /**
26 | * Implementation of {@link AbstractRegexPatternFileListFilter} for Amazon S3.
27 | *
28 | * @author Artem Bilan
29 | */
30 | public class S3RegexPatternFileListFilter extends AbstractRegexPatternFileListFilter {
31 |
32 | public S3RegexPatternFileListFilter(String pattern) {
33 | super(pattern);
34 | }
35 |
36 | public S3RegexPatternFileListFilter(Pattern pattern) {
37 | super(pattern);
38 | }
39 |
40 | @Override
41 | protected String getFilename(S3Object file) {
42 | return (file != null) ? file.key() : null;
43 | }
44 |
45 | @Override
46 | protected boolean isDirectory(S3Object file) {
47 | return false;
48 | }
49 |
50 | }
51 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/support/AwsRequestFailureException.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2017-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.support;
18 |
19 | import software.amazon.awssdk.awscore.AwsRequest;
20 |
21 | import org.springframework.messaging.Message;
22 | import org.springframework.messaging.MessagingException;
23 |
24 | /**
25 | * An exception that is the payload of an {@code ErrorMessage} when a send fails.
26 | *
27 | * @author Jacob Severson
28 | * @author Artem Bilan
29 | *
30 | * @since 1.1
31 | */
32 | public class AwsRequestFailureException extends MessagingException {
33 |
34 | private static final long serialVersionUID = 1L;
35 |
36 | private final transient AwsRequest request;
37 |
38 | public AwsRequestFailureException(Message message, AwsRequest request, Throwable cause) {
39 | super(message, cause);
40 | this.request = request;
41 | }
42 |
43 | public AwsRequest getRequest() {
44 | return this.request;
45 | }
46 |
47 | @Override
48 | public String toString() {
49 | return super.toString() + " [request=" + this.request + "]";
50 | }
51 |
52 | }
53 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/support/KplBackpressureException.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2025-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.support;
18 |
19 | import java.io.Serial;
20 |
21 | import com.amazonaws.services.kinesis.producer.UserRecord;
22 |
23 | /**
24 | * An exception triggered from the {@link org.springframework.integration.aws.outbound.KplMessageHandler}
25 | * while sending records to Kinesis when maximum number of records in flight exceeds the backpressure threshold.
26 | *
27 | * @author Siddharth Jain
28 | * @author Artem Bilan
29 | *
30 | * @since 3.0.9
31 | */
32 | public class KplBackpressureException extends RuntimeException {
33 |
34 | @Serial
35 | private static final long serialVersionUID = 1L;
36 |
37 | private final transient UserRecord userRecord;
38 |
39 | public KplBackpressureException(String message, UserRecord userRecord) {
40 | super(message);
41 | this.userRecord = userRecord;
42 | }
43 |
44 | /**
45 | * Get the {@link UserRecord} when this exception has been thrown.
46 | * @return the {@link UserRecord} when this exception has been thrown.
47 | */
48 | public UserRecord getUserRecord() {
49 | return this.userRecord;
50 | }
51 |
52 | }
53 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/outbound/ConvertingFromMessageConverter.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2017-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.outbound;
18 |
19 | import org.springframework.core.convert.converter.Converter;
20 | import org.springframework.messaging.Message;
21 | import org.springframework.messaging.MessageHeaders;
22 | import org.springframework.messaging.converter.MessageConverter;
23 | import org.springframework.util.Assert;
24 |
25 | /**
26 | * A simple {@link MessageConverter} that delegates to a {@link Converter}.
27 | *
28 | * @author Artem Bilan
29 | *
30 | * @since 2.3
31 | */
32 | class ConvertingFromMessageConverter implements MessageConverter {
33 |
34 | private final Converter delegate;
35 |
36 | ConvertingFromMessageConverter(Converter delegate) {
37 | Assert.notNull(delegate, "'delegate' must not be null");
38 | this.delegate = delegate;
39 | }
40 |
41 | @Override
42 | public Object fromMessage(Message message, Class targetClass) {
43 | return this.delegate.convert(message.getPayload());
44 | }
45 |
46 | @Override
47 | public Message toMessage(Object payload, MessageHeaders headers) {
48 | throw new UnsupportedOperationException();
49 | }
50 |
51 | }
52 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/inbound/S3InboundFileSynchronizingMessageSource.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.inbound;
18 |
19 | import java.io.File;
20 | import java.util.Comparator;
21 |
22 | import software.amazon.awssdk.services.s3.model.S3Object;
23 |
24 | import org.springframework.integration.file.remote.synchronizer.AbstractInboundFileSynchronizer;
25 | import org.springframework.integration.file.remote.synchronizer.AbstractInboundFileSynchronizingMessageSource;
26 |
27 | /**
28 | * A {@link org.springframework.integration.core.MessageSource} implementation for the
29 | * Amazon S3.
30 | *
31 | * @author Artem Bilan
32 | */
33 | public class S3InboundFileSynchronizingMessageSource
34 | extends AbstractInboundFileSynchronizingMessageSource {
35 |
36 | public S3InboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer synchronizer) {
37 | super(synchronizer);
38 | }
39 |
40 | public S3InboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer synchronizer,
41 | Comparator comparator) {
42 |
43 | super(synchronizer, comparator);
44 | }
45 |
46 | public String getComponentType() {
47 | return "aws:s3-inbound-channel-adapter";
48 | }
49 |
50 | }
51 |
--------------------------------------------------------------------------------
/publish-maven.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'maven-publish'
2 |
3 | publishing {
4 | publications {
5 | mavenJava(MavenPublication) {
6 | suppressAllPomMetadataWarnings()
7 | from components.java
8 | artifact docsZip
9 | artifact distZip
10 | pom {
11 | afterEvaluate {
12 | name = project.description
13 | description = project.description
14 | }
15 | url = linkScmUrl
16 | organization {
17 | name = 'Spring IO'
18 | url = 'https://spring.io/projects/spring-integration'
19 | }
20 | licenses {
21 | license {
22 | name = 'Apache License, Version 2.0'
23 | url = 'https://www.apache.org/licenses/LICENSE-2.0'
24 | distribution = 'repo'
25 | }
26 | }
27 | scm {
28 | url = linkScmUrl
29 | connection = linkScmConnection
30 | developerConnection = linkScmDevConnection
31 | }
32 | developers {
33 | developer {
34 | id = 'artembilan'
35 | name = 'Artem Bilan'
36 | email = 'artem.bilan@broadcom.com'
37 | roles = ['project lead']
38 | }
39 | }
40 | issueManagement {
41 | system = 'GitHub'
42 | url = linkIssue
43 | }
44 | }
45 | versionMapping {
46 | usage('java-api') {
47 | fromResolutionResult()
48 | }
49 | usage('java-runtime') {
50 | fromResolutionResult()
51 | }
52 | }
53 | }
54 | }
55 | }
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/support/SnsHeaderMapper.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2018-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.support;
18 |
19 | import java.nio.ByteBuffer;
20 |
21 | import software.amazon.awssdk.core.SdkBytes;
22 | import software.amazon.awssdk.services.sns.model.MessageAttributeValue;
23 |
24 | /**
25 | * The {@link AbstractMessageAttributesHeaderMapper} implementation for the mapping from
26 | * headers to SNS message attributes.
27 | *
28 | * On the Inbound side, the SNS message is fully mapped from the JSON to the message
29 | * payload. Only important HTTP headers are mapped to the message headers.
30 | *
31 | * @author Artem Bilan
32 | *
33 | * @since 2.0
34 | */
35 | public class SnsHeaderMapper extends AbstractMessageAttributesHeaderMapper {
36 |
37 | @Override
38 | protected MessageAttributeValue buildMessageAttribute(String dataType, Object value) {
39 | MessageAttributeValue.Builder messageAttributeValue =
40 | MessageAttributeValue.builder()
41 | .dataType(dataType);
42 | if (value instanceof ByteBuffer byteBuffer) {
43 | messageAttributeValue.binaryValue(SdkBytes.fromByteBuffer(byteBuffer));
44 | }
45 | else {
46 | messageAttributeValue.stringValue(value.toString());
47 | }
48 |
49 | return messageAttributeValue.build();
50 | }
51 |
52 | }
53 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/support/SqsHeaderMapper.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2018-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.support;
18 |
19 | import java.nio.ByteBuffer;
20 |
21 | import software.amazon.awssdk.core.SdkBytes;
22 | import software.amazon.awssdk.services.sqs.model.MessageAttributeValue;
23 |
24 | import org.springframework.messaging.MessageHeaders;
25 |
26 | /**
27 | * The {@link AbstractMessageAttributesHeaderMapper} implementation for the mapping from
28 | * headers to SQS message attributes.
29 | *
30 | * The
31 | * {@link io.awspring.cloud.sqs.listener.SqsMessageListenerContainer}
32 | * maps all the SQS message attributes to the {@link MessageHeaders}.
33 | *
34 | * @author Artem Bilan
35 | *
36 | * @since 2.0
37 | */
38 | public class SqsHeaderMapper extends AbstractMessageAttributesHeaderMapper {
39 |
40 | @Override
41 | protected MessageAttributeValue buildMessageAttribute(String dataType, Object value) {
42 | MessageAttributeValue.Builder messageAttributeValue =
43 | MessageAttributeValue.builder()
44 | .dataType(dataType);
45 | if (value instanceof ByteBuffer byteBuffer) {
46 | messageAttributeValue.binaryValue(SdkBytes.fromByteBuffer(byteBuffer));
47 | }
48 | else {
49 | messageAttributeValue.stringValue(value.toString());
50 | }
51 |
52 | return messageAttributeValue.build();
53 | }
54 |
55 | }
56 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/support/filters/S3PersistentAcceptOnceFileListFilter.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.support.filters;
18 |
19 | import software.amazon.awssdk.services.s3.model.S3Object;
20 |
21 | import org.springframework.integration.file.filters.AbstractPersistentAcceptOnceFileListFilter;
22 | import org.springframework.integration.metadata.ConcurrentMetadataStore;
23 |
24 | /**
25 | * Persistent file list filter using the server's file timestamp to detect if we've
26 | * already 'seen' this file.
27 | *
28 | * @author Artem Bilan
29 | */
30 | public class S3PersistentAcceptOnceFileListFilter extends AbstractPersistentAcceptOnceFileListFilter {
31 |
32 | public S3PersistentAcceptOnceFileListFilter(ConcurrentMetadataStore store, String prefix) {
33 | super(store, prefix);
34 | }
35 |
36 | @Override
37 | protected long modified(S3Object file) {
38 | return (file != null) ? file.lastModified().getEpochSecond() : 0L;
39 | }
40 |
41 | @Override
42 | protected String fileName(S3Object file) {
43 | return (file != null) ? file.key() : null;
44 | }
45 |
46 | /**
47 | * Always return false since no directory notion in S3.
48 | * @param file the {@link S3Object}
49 | * @return always false: S3 does not have a notion of directory
50 | * @since 2.5
51 | */
52 | @Override
53 | protected boolean isDirectory(S3Object file) {
54 | return false;
55 | }
56 |
57 | }
58 |
--------------------------------------------------------------------------------
/src/test/java/org/springframework/integration/aws/outbound/SnsBodyBuilderTests.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.outbound;
18 |
19 | import org.junit.jupiter.api.Test;
20 |
21 | import org.springframework.integration.aws.support.SnsBodyBuilder;
22 |
23 | import static org.assertj.core.api.Assertions.assertThat;
24 | import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
25 |
26 | /**
27 | * @author Artem Bilan
28 | */
29 | class SnsBodyBuilderTests {
30 |
31 | @Test
32 | void snsBodyBuilder() {
33 | assertThatIllegalArgumentException()
34 | .isThrownBy(() -> SnsBodyBuilder.withDefault(""))
35 | .withMessageContaining("defaultMessage must not be empty.");
36 |
37 | String message = SnsBodyBuilder.withDefault("foo").build();
38 | assertThat(message).isEqualTo("{\"default\":\"foo\"}");
39 |
40 | assertThatIllegalArgumentException()
41 | .isThrownBy(() -> SnsBodyBuilder.withDefault("foo").forProtocols("{\"foo\" : \"bar\"}").build())
42 | .withMessageContaining("protocols must not be empty.");
43 |
44 | assertThatIllegalArgumentException()
45 | .isThrownBy(() -> SnsBodyBuilder.withDefault("foo").forProtocols("{\"foo\" : \"bar\"}", "").build())
46 | .withMessageContaining("protocols must not contain empty elements.");
47 |
48 | message = SnsBodyBuilder.withDefault("foo").forProtocols("{\"foo\" : \"bar\"}", "sms").build();
49 |
50 | assertThat(message).isEqualTo("{\"default\":\"foo\",\"sms\":\"{\\\"foo\\\" : \\\"bar\\\"}\"}");
51 | }
52 |
53 | }
54 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/inbound/kinesis/KinesisMessageHeaderErrorMessageStrategy.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2018-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.inbound.kinesis;
18 |
19 | import java.util.Collections;
20 | import java.util.HashMap;
21 | import java.util.Map;
22 |
23 | import org.springframework.core.AttributeAccessor;
24 | import org.springframework.integration.aws.support.AwsHeaders;
25 | import org.springframework.integration.support.ErrorMessageStrategy;
26 | import org.springframework.integration.support.ErrorMessageUtils;
27 | import org.springframework.messaging.Message;
28 | import org.springframework.messaging.support.ErrorMessage;
29 |
30 | /**
31 | * The {@link ErrorMessageStrategy} implementation to build an {@link ErrorMessage} with
32 | * the {@link AwsHeaders#RAW_RECORD} header by the value from the the provided
33 | * {@link AttributeAccessor}.
34 | *
35 | * @author Artem Bilan
36 | * @since 2.0
37 | */
38 | public class KinesisMessageHeaderErrorMessageStrategy implements ErrorMessageStrategy {
39 |
40 | @Override
41 | public ErrorMessage buildErrorMessage(Throwable throwable, AttributeAccessor context) {
42 | Object inputMessage = context == null ? null
43 | : context.getAttribute(ErrorMessageUtils.INPUT_MESSAGE_CONTEXT_KEY);
44 |
45 | Map headers = context == null ? new HashMap<>()
46 | : Collections.singletonMap(AwsHeaders.RAW_RECORD, context.getAttribute(AwsHeaders.RAW_RECORD));
47 |
48 | return new ErrorMessage(throwable, headers, inputMessage instanceof Message ? (Message) inputMessage : null);
49 | }
50 |
51 | }
52 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/support/SnsAsyncTopicArnResolver.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2023-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.support;
18 |
19 | import io.awspring.cloud.sns.core.TopicArnResolver;
20 | import software.amazon.awssdk.arns.Arn;
21 | import software.amazon.awssdk.services.sns.SnsAsyncClient;
22 |
23 | import org.springframework.util.Assert;
24 |
25 | /**
26 | * A {@link TopicArnResolver} implementation to determine topic ARN by name against an {@link SnsAsyncClient}.
27 | *
28 | * @author Artem Bilan
29 | *
30 | * @since 3.0
31 | */
32 | public class SnsAsyncTopicArnResolver implements TopicArnResolver {
33 | private final SnsAsyncClient snsClient;
34 |
35 | public SnsAsyncTopicArnResolver(SnsAsyncClient snsClient) {
36 | Assert.notNull(snsClient, "snsClient is required");
37 | this.snsClient = snsClient;
38 | }
39 |
40 | /**
41 | * Resolve topic ARN by topic name. If topicName is already an ARN,
42 | * it returns {@link Arn}. If topicName is just a
43 | * string with a topic name, it attempts to create a topic
44 | * or if topic already exists, just returns its ARN.
45 | */
46 | @Override
47 | public Arn resolveTopicArn(String topicName) {
48 | Assert.notNull(topicName, "topicName must not be null");
49 | if (topicName.toLowerCase().startsWith("arn:")) {
50 | return Arn.fromString(topicName);
51 | }
52 | else {
53 | // if topic exists, createTopic returns successful response with topic arn
54 | return Arn.fromString(this.snsClient.createTopic(request -> request.name(topicName)).join().topicArn());
55 | }
56 | }
57 |
58 | }
59 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/support/S3SessionFactory.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.support;
18 |
19 | import software.amazon.awssdk.services.s3.S3Client;
20 | import software.amazon.awssdk.services.s3.model.S3Object;
21 |
22 | import org.springframework.integration.file.remote.session.SessionFactory;
23 | import org.springframework.integration.file.remote.session.SharedSessionCapable;
24 | import org.springframework.util.Assert;
25 |
26 | /**
27 | * An Amazon S3 specific {@link SessionFactory} implementation. Also, this class implements
28 | * {@link SharedSessionCapable} around the single instance, since the {@link S3Session} is
29 | * simple thread-safe wrapper for the {@link S3Client}.
30 | *
31 | * @author Artem Bilan
32 | * @author Xavier François
33 | */
34 | public class S3SessionFactory implements SessionFactory, SharedSessionCapable {
35 |
36 | private final S3Session s3Session;
37 |
38 | public S3SessionFactory() {
39 | this(S3Client.create());
40 | }
41 |
42 | public S3SessionFactory(S3Client amazonS3) {
43 | Assert.notNull(amazonS3, "'amazonS3' must not be null.");
44 | this.s3Session = new S3Session(amazonS3);
45 | }
46 |
47 | @Override
48 | public S3Session getSession() {
49 | return this.s3Session;
50 | }
51 |
52 | @Override
53 | public boolean isSharedSession() {
54 | return true;
55 | }
56 |
57 | @Override
58 | public void resetSharedSession() {
59 | // No-op. The S3Session is stateless and can be used concurrently.
60 | }
61 |
62 | public void setEndpoint(String endpoint) {
63 | this.s3Session.setEndpoint(endpoint);
64 | }
65 | }
66 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/support/UserRecordResponse.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2024-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.support;
18 |
19 | import java.util.List;
20 |
21 | import com.amazonaws.services.kinesis.producer.Attempt;
22 | import com.amazonaws.services.kinesis.producer.UserRecordResult;
23 | import software.amazon.awssdk.awscore.AwsResponse;
24 | import software.amazon.awssdk.core.SdkField;
25 | import software.amazon.awssdk.services.kinesis.model.KinesisResponse;
26 | import software.amazon.awssdk.services.kinesis.model.PutRecordResponse;
27 |
28 | /**
29 | * The {@link KinesisResponse} adapter for the KPL {@link UserRecordResult} response.
30 | *
31 | * @author Artem Bilan
32 | *
33 | * @since 3.0.8
34 | */
35 | public class UserRecordResponse extends KinesisResponse {
36 |
37 | private final String shardId;
38 |
39 | private final String sequenceNumber;
40 |
41 | private final List attempts;
42 |
43 | public UserRecordResponse(UserRecordResult userRecordResult) {
44 | super(PutRecordResponse.builder());
45 | this.shardId = userRecordResult.getShardId();
46 | this.sequenceNumber = userRecordResult.getSequenceNumber();
47 | this.attempts = userRecordResult.getAttempts();
48 | }
49 |
50 | public String shardId() {
51 | return this.shardId;
52 | }
53 |
54 | public String sequenceNumber() {
55 | return this.sequenceNumber;
56 | }
57 |
58 | public List attempts() {
59 | return this.attempts;
60 | }
61 |
62 | @Override
63 | public AwsResponse.Builder toBuilder() {
64 | throw new UnsupportedOperationException();
65 | }
66 |
67 | @Override
68 | public List> sdkFields() {
69 | throw new UnsupportedOperationException();
70 | }
71 |
72 | }
73 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/support/S3RemoteFileTemplate.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.support;
18 |
19 | import java.io.IOException;
20 | import java.io.UncheckedIOException;
21 |
22 | import software.amazon.awssdk.services.s3.S3Client;
23 | import software.amazon.awssdk.services.s3.model.S3Object;
24 |
25 | import org.springframework.integration.file.remote.ClientCallback;
26 | import org.springframework.integration.file.remote.RemoteFileTemplate;
27 | import org.springframework.integration.file.remote.session.SessionFactory;
28 |
29 | /**
30 | * An Amazon S3 specific {@link RemoteFileTemplate} extension.
31 | *
32 | * @author Artem Bilan
33 | */
34 | public class S3RemoteFileTemplate extends RemoteFileTemplate {
35 |
36 | public S3RemoteFileTemplate() {
37 | this(new S3SessionFactory());
38 | }
39 |
40 | public S3RemoteFileTemplate(S3Client amazonS3) {
41 | this(new S3SessionFactory(amazonS3));
42 | }
43 |
44 | /**
45 | * Construct a {@link RemoteFileTemplate} with the supplied session factory.
46 | * @param sessionFactory the session factory.
47 | */
48 | public S3RemoteFileTemplate(SessionFactory sessionFactory) {
49 | super(sessionFactory);
50 | }
51 |
52 | @SuppressWarnings("unchecked")
53 | @Override
54 | public T executeWithClient(final ClientCallback callback) {
55 | return callback.doWithClient((C) this.sessionFactory.getSession().getClientInstance());
56 | }
57 |
58 | @Override
59 | public boolean exists(final String path) {
60 | try {
61 | return this.sessionFactory.getSession().exists(path);
62 | }
63 | catch (IOException ex) {
64 | throw new UncheckedIOException("Failed to check the path " + path, ex);
65 | }
66 | }
67 |
68 | }
69 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/support/SnsBodyBuilder.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.support;
18 |
19 | import java.util.HashMap;
20 | import java.util.Map;
21 |
22 | import org.springframework.util.Assert;
23 |
24 | /**
25 | * A utility class to simplify an SNS Message body building. Can be used from the
26 | * {@code SnsMessageHandler#bodyExpression} definition or directly in case of manual
27 | * {@link software.amazon.awssdk.services.sns.model.PublishRequest} building.
28 | *
29 | * @author Artem Bilan
30 | */
31 | public final class SnsBodyBuilder {
32 |
33 | private final Map snsMessage = new HashMap<>();
34 |
35 | private SnsBodyBuilder(String defaultMessage) {
36 | Assert.hasText(defaultMessage, "defaultMessage must not be empty.");
37 | this.snsMessage.put("default", defaultMessage);
38 | }
39 |
40 | public SnsBodyBuilder forProtocols(String message, String... protocols) {
41 | Assert.hasText(message, "message must not be empty.");
42 | Assert.notEmpty(protocols, "protocols must not be empty.");
43 | for (String protocol : protocols) {
44 | Assert.hasText(protocol, "protocols must not contain empty elements.");
45 | this.snsMessage.put(protocol, message);
46 | }
47 | return this;
48 | }
49 |
50 | public String build() {
51 | StringBuilder stringBuilder = new StringBuilder("{");
52 | for (Map.Entry entry : this.snsMessage.entrySet()) {
53 | stringBuilder.append("\"").append(entry.getKey()).append("\":\"")
54 | .append(entry.getValue().replaceAll("\"", "\\\\\"")).append("\",");
55 | }
56 | return stringBuilder.substring(0, stringBuilder.length() - 1) + "}";
57 | }
58 |
59 | public static SnsBodyBuilder withDefault(String defaultMessage) {
60 | return new SnsBodyBuilder(defaultMessage);
61 | }
62 |
63 | }
64 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.adoc:
--------------------------------------------------------------------------------
1 | = Contributor Code of Conduct
2 |
3 | As contributors and maintainers of this project, and in the interest of fostering an open
4 | and welcoming community, we pledge to respect all people who contribute through reporting
5 | issues, posting feature requests, updating documentation, submitting pull requests or
6 | patches, and other activities.
7 |
8 | We are committed to making participation in this project a harassment-free experience for
9 | everyone, regardless of level of experience, gender, gender identity and expression,
10 | sexual orientation, disability, personal appearance, body size, race, ethnicity, age,
11 | religion, or nationality.
12 |
13 | Examples of unacceptable behavior by participants include:
14 |
15 | * The use of sexualized language or imagery
16 | * Personal attacks
17 | * Trolling or insulting/derogatory comments
18 | * Public or private harassment
19 | * Publishing other's private information, such as physical or electronic addresses,
20 | without explicit permission
21 | * Other unethical or unprofessional conduct
22 |
23 | Project maintainers have the right and responsibility to remove, edit, or reject comments,
24 | commits, code, wiki edits, issues, and other contributions that are not aligned to this
25 | Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors
26 | that they deem inappropriate, threatening, offensive, or harmful.
27 |
28 | By adopting this Code of Conduct, project maintainers commit themselves to fairly and
29 | consistently applying these principles to every aspect of managing this project. Project
30 | maintainers who do not follow or enforce the Code of Conduct may be permanently removed
31 | from the project team.
32 |
33 | This Code of Conduct applies both within project spaces and in public spaces when an
34 | individual is representing the project or its community.
35 |
36 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
37 | contacting a project maintainer at spring-code-of-conduct@pivotal.io . All complaints will
38 | be reviewed and investigated and will result in a response that is deemed necessary and
39 | appropriate to the circumstances. Maintainers are obligated to maintain confidentiality
40 | with regard to the reporter of an incident.
41 |
42 | This Code of Conduct is adapted from the
43 | https://contributor-covenant.org[Contributor Covenant], version 1.3.0, available at
44 | https://contributor-covenant.org/version/1/3/0/[contributor-covenant.org/version/1/3/0/]
45 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/support/S3FileInfo.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.support;
18 |
19 | import java.util.Date;
20 |
21 | import software.amazon.awssdk.services.s3.model.S3Object;
22 |
23 | import org.springframework.integration.file.remote.AbstractFileInfo;
24 | import org.springframework.util.Assert;
25 |
26 | /**
27 | * An Amazon S3 {@link org.springframework.integration.file.remote.FileInfo}
28 | * implementation.
29 | *
30 | * @author Christian Tzolov
31 | * @author Artem Bilan
32 | *
33 | * @since 1.1
34 | */
35 | public class S3FileInfo extends AbstractFileInfo {
36 |
37 | private final S3Object s3Object;
38 |
39 | public S3FileInfo(S3Object s3Object) {
40 | Assert.notNull(s3Object, "s3Object must not be null");
41 | this.s3Object = s3Object;
42 | }
43 |
44 | @Override
45 | public boolean isDirectory() {
46 | return false;
47 | }
48 |
49 | @Override
50 | public boolean isLink() {
51 | return false;
52 | }
53 |
54 | @Override
55 | public long getSize() {
56 | return this.s3Object.size();
57 | }
58 |
59 | @Override
60 | public long getModified() {
61 | return this.s3Object.lastModified().getEpochSecond();
62 | }
63 |
64 | @Override
65 | public String getFilename() {
66 | return this.s3Object.key();
67 | }
68 |
69 | /**
70 | * A permissions representation string. Throws {@link UnsupportedOperationException}
71 | * to avoid extra {@link software.amazon.awssdk.services.s3.S3Client#getObjectAcl} REST call.
72 | * The target application amy choose to do that by its logic.
73 | * @return the permissions representation string.
74 | */
75 | @Override
76 | public String getPermissions() {
77 | throw new UnsupportedOperationException("Use [AmazonS3.getObjectAcl()] to obtain permissions.");
78 | }
79 |
80 | @Override
81 | public S3Object getFileInfo() {
82 | return this.s3Object;
83 | }
84 |
85 | @Override
86 | public String toString() {
87 | return "FileInfo [isDirectory=" + isDirectory() + ", isLink=" + isLink() + ", Size=" + getSize()
88 | + ", ModifiedTime=" + new Date(getModified()) + ", Filename=" + getFilename() + ", RemoteDirectory="
89 | + getRemoteDirectory() + "]";
90 | }
91 |
92 | }
93 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/inbound/S3StreamingMessageSource.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.inbound;
18 |
19 | import java.util.Collection;
20 | import java.util.Comparator;
21 | import java.util.List;
22 | import java.util.stream.Collectors;
23 |
24 | import software.amazon.awssdk.services.s3.model.S3Object;
25 |
26 | import org.springframework.integration.aws.support.S3FileInfo;
27 | import org.springframework.integration.aws.support.S3Session;
28 | import org.springframework.integration.aws.support.filters.S3PersistentAcceptOnceFileListFilter;
29 | import org.springframework.integration.file.remote.AbstractFileInfo;
30 | import org.springframework.integration.file.remote.AbstractRemoteFileStreamingMessageSource;
31 | import org.springframework.integration.file.remote.RemoteFileTemplate;
32 | import org.springframework.integration.metadata.SimpleMetadataStore;
33 |
34 | /**
35 | * A {@link AbstractRemoteFileStreamingMessageSource} implementation for the Amazon S3.
36 | *
37 | * @author Christian Tzolov
38 | * @author Artem Bilan
39 | *
40 | * @since 1.1
41 | */
42 | public class S3StreamingMessageSource extends AbstractRemoteFileStreamingMessageSource {
43 |
44 | public S3StreamingMessageSource(RemoteFileTemplate template) {
45 | super(template, null);
46 | }
47 |
48 | @SuppressWarnings("this-escape")
49 | public S3StreamingMessageSource(RemoteFileTemplate template, Comparator comparator) {
50 | super(template, comparator);
51 | doSetFilter(new S3PersistentAcceptOnceFileListFilter(new SimpleMetadataStore(), "s3StreamingMessageSource"));
52 | }
53 |
54 | @Override
55 | protected List> asFileInfoList(Collection collection) {
56 | return collection.stream().map(S3FileInfo::new).collect(Collectors.toList());
57 | }
58 |
59 | @Override
60 | public String getComponentType() {
61 | return "aws:s3-inbound-streaming-channel-adapter";
62 | }
63 |
64 | @Override
65 | protected AbstractFileInfo poll() {
66 | AbstractFileInfo file = super.poll();
67 | if (file != null) {
68 | S3Session s3Session = (S3Session) getRemoteFileTemplate().getSession();
69 | file.setRemoteDirectory(s3Session.normalizeBucketName(file.getRemoteDirectory()));
70 | }
71 | return file;
72 | }
73 |
74 | @Override
75 | protected boolean isDirectory(S3Object file) {
76 | return false;
77 | }
78 |
79 | }
80 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @rem
2 | @rem Copyright 2015 the original author or authors.
3 | @rem
4 | @rem Licensed under the Apache License, Version 2.0 (the "License");
5 | @rem you may not use this file except in compliance with the License.
6 | @rem You may obtain a copy of the License at
7 | @rem
8 | @rem https://www.apache.org/licenses/LICENSE-2.0
9 | @rem
10 | @rem Unless required by applicable law or agreed to in writing, software
11 | @rem distributed under the License is distributed on an "AS IS" BASIS,
12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | @rem See the License for the specific language governing permissions and
14 | @rem limitations under the License.
15 | @rem
16 | @rem SPDX-License-Identifier: Apache-2.0
17 | @rem
18 |
19 | @if "%DEBUG%"=="" @echo off
20 | @rem ##########################################################################
21 | @rem
22 | @rem Gradle startup script for Windows
23 | @rem
24 | @rem ##########################################################################
25 |
26 | @rem Set local scope for the variables with windows NT shell
27 | if "%OS%"=="Windows_NT" setlocal
28 |
29 | set DIRNAME=%~dp0
30 | if "%DIRNAME%"=="" set DIRNAME=.
31 | @rem This is normally unused
32 | set APP_BASE_NAME=%~n0
33 | set APP_HOME=%DIRNAME%
34 |
35 | @rem Resolve any "." and ".." in APP_HOME to make it shorter.
36 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
37 |
38 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
39 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
40 |
41 | @rem Find java.exe
42 | if defined JAVA_HOME goto findJavaFromJavaHome
43 |
44 | set JAVA_EXE=java.exe
45 | %JAVA_EXE% -version >NUL 2>&1
46 | if %ERRORLEVEL% equ 0 goto execute
47 |
48 | echo. 1>&2
49 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
50 | echo. 1>&2
51 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2
52 | echo location of your Java installation. 1>&2
53 |
54 | goto fail
55 |
56 | :findJavaFromJavaHome
57 | set JAVA_HOME=%JAVA_HOME:"=%
58 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
59 |
60 | if exist "%JAVA_EXE%" goto execute
61 |
62 | echo. 1>&2
63 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
64 | echo. 1>&2
65 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2
66 | echo location of your Java installation. 1>&2
67 |
68 | goto fail
69 |
70 | :execute
71 | @rem Setup the command line
72 |
73 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
74 |
75 |
76 | @rem Execute Gradle
77 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
78 |
79 | :end
80 | @rem End local scope for the variables with windows NT shell
81 | if %ERRORLEVEL% equ 0 goto mainEnd
82 |
83 | :fail
84 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
85 | rem the _cmd.exe /c_ return code!
86 | set EXIT_CODE=%ERRORLEVEL%
87 | if %EXIT_CODE% equ 0 set EXIT_CODE=1
88 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
89 | exit /b %EXIT_CODE%
90 |
91 | :mainEnd
92 | if "%OS%"=="Windows_NT" endlocal
93 |
94 | :omega
95 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/inbound/S3InboundFileSynchronizer.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.inbound;
18 |
19 | import java.io.File;
20 | import java.io.IOException;
21 |
22 | import software.amazon.awssdk.services.s3.S3Client;
23 | import software.amazon.awssdk.services.s3.model.S3Object;
24 |
25 | import org.springframework.expression.EvaluationContext;
26 | import org.springframework.expression.common.LiteralExpression;
27 | import org.springframework.integration.aws.support.S3Session;
28 | import org.springframework.integration.aws.support.S3SessionFactory;
29 | import org.springframework.integration.aws.support.filters.S3PersistentAcceptOnceFileListFilter;
30 | import org.springframework.integration.file.remote.session.Session;
31 | import org.springframework.integration.file.remote.session.SessionFactory;
32 | import org.springframework.integration.file.remote.synchronizer.AbstractInboundFileSynchronizer;
33 | import org.springframework.integration.metadata.SimpleMetadataStore;
34 | import org.springframework.lang.Nullable;
35 |
36 | /**
37 | * An implementation of {@link AbstractInboundFileSynchronizer} for Amazon S3.
38 | *
39 | * @author Artem Bilan
40 | */
41 | public class S3InboundFileSynchronizer extends AbstractInboundFileSynchronizer {
42 |
43 | public S3InboundFileSynchronizer() {
44 | this(new S3SessionFactory());
45 | }
46 |
47 | public S3InboundFileSynchronizer(S3Client amazonS3) {
48 | this(new S3SessionFactory(amazonS3));
49 | }
50 |
51 | /**
52 | * Create a synchronizer with the {@link SessionFactory} used to acquire
53 | * {@link Session} instances.
54 | * @param sessionFactory The session factory.
55 | */
56 | @SuppressWarnings("this-escape")
57 | public S3InboundFileSynchronizer(SessionFactory sessionFactory) {
58 | super(sessionFactory);
59 | doSetRemoteDirectoryExpression(new LiteralExpression(null));
60 | doSetFilter(new S3PersistentAcceptOnceFileListFilter(new SimpleMetadataStore(), "s3MessageSource"));
61 | }
62 |
63 | @Override
64 | protected boolean isFile(S3Object file) {
65 | return true;
66 | }
67 |
68 | @Override
69 | protected String getFilename(S3Object file) {
70 | return (file != null ? file.key() : null);
71 | }
72 |
73 | @Override
74 | protected long getModified(S3Object file) {
75 | return file.lastModified().getEpochSecond();
76 | }
77 |
78 | @Override
79 | protected boolean copyFileToLocalDirectory(String remoteDirectoryPath,
80 | @Nullable EvaluationContext localFileEvaluationContext, S3Object remoteFile,
81 | File localDirectory, Session session) throws IOException {
82 |
83 | return super.copyFileToLocalDirectory(((S3Session) session).normalizeBucketName(remoteDirectoryPath),
84 | localFileEvaluationContext, remoteFile, localDirectory, session);
85 | }
86 |
87 | @Override
88 | protected String protocol() {
89 | return "s3";
90 | }
91 |
92 | }
93 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/inbound/kinesis/ShardCheckpointer.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2017-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.inbound.kinesis;
18 |
19 | import java.math.BigInteger;
20 |
21 | import org.apache.commons.logging.Log;
22 | import org.apache.commons.logging.LogFactory;
23 |
24 | import org.springframework.integration.metadata.ConcurrentMetadataStore;
25 | import org.springframework.integration.metadata.MetadataStore;
26 | import org.springframework.lang.Nullable;
27 |
28 | /**
29 | * An internal {@link Checkpointer} implementation based on provided {@link MetadataStore}
30 | * and {@code key} for shard.
31 | *
32 | * The instances of this class is created by the
33 | * {@link KinesisMessageDrivenChannelAdapter} for each {@code ShardConsumer}.
34 | *
35 | * @author Artem Bilan
36 | * @since 1.1
37 | */
38 | class ShardCheckpointer implements Checkpointer {
39 |
40 | private static final Log logger = LogFactory.getLog(ShardCheckpointer.class);
41 |
42 | private final ConcurrentMetadataStore checkpointStore;
43 |
44 | private final String key;
45 |
46 | private volatile String highestSequence;
47 |
48 | private volatile String lastCheckpointValue;
49 |
50 | private volatile boolean active = true;
51 |
52 | ShardCheckpointer(ConcurrentMetadataStore checkpointStore, String key) {
53 | this.checkpointStore = checkpointStore;
54 | this.key = key;
55 | }
56 |
57 | @Override
58 | public boolean checkpoint() {
59 | return checkpoint(this.highestSequence);
60 | }
61 |
62 | @Override
63 | public boolean checkpoint(String sequenceNumber) {
64 | if (this.active) {
65 | String existingSequence = getCheckpoint();
66 | if (existingSequence == null
67 | || new BigInteger(existingSequence).compareTo(new BigInteger(sequenceNumber)) < 0) {
68 | if (existingSequence != null) {
69 | return this.checkpointStore.replace(this.key, existingSequence, sequenceNumber);
70 | }
71 | else {
72 | boolean stored = this.checkpointStore.putIfAbsent(this.key, sequenceNumber) == null;
73 | if (stored) {
74 | this.lastCheckpointValue = sequenceNumber;
75 | }
76 | return stored;
77 | }
78 | }
79 | }
80 | else {
81 | if (logger.isInfoEnabled()) {
82 | logger.info("The [" + this + "] has been closed. Checkpoints aren't accepted anymore.");
83 | }
84 | }
85 |
86 | return false;
87 | }
88 |
89 | void setHighestSequence(String highestSequence) {
90 | this.highestSequence = highestSequence;
91 | }
92 |
93 | @Nullable
94 | String getHighestSequence() {
95 | return this.highestSequence;
96 | }
97 |
98 | @Nullable
99 | String getCheckpoint() {
100 | this.lastCheckpointValue = this.checkpointStore.get(this.key);
101 | return this.lastCheckpointValue;
102 | }
103 |
104 | @Nullable
105 | String getLastCheckpointValue() {
106 | return this.lastCheckpointValue;
107 | }
108 |
109 | void remove() {
110 | this.checkpointStore.remove(this.key);
111 | }
112 |
113 | void close() {
114 | this.active = false;
115 | }
116 |
117 | @Override
118 | public String toString() {
119 | return "ShardCheckpointer{" + "key='" + this.key + '\'' + ", lastCheckpointValue='" + this.lastCheckpointValue
120 | + '\'' + '}';
121 | }
122 |
123 | }
124 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/support/AwsHeaders.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.support;
18 |
19 | /**
20 | * The AWS specific message headers constants.
21 | *
22 | * @author Artem Bilan
23 | */
24 | public abstract class AwsHeaders {
25 |
26 | private static final String PREFIX = "aws_";
27 |
28 | /**
29 | * The {@value QUEUE} header for sending data to SQS.
30 | */
31 | public static final String QUEUE = PREFIX + "queue";
32 |
33 | /**
34 | * The {@value TOPIC} header for sending/receiving data over SNS.
35 | */
36 | public static final String TOPIC = PREFIX + "topic";
37 |
38 | /**
39 | * The {@value MESSAGE_ID} header for SQS/SNS message ids.
40 | */
41 | public static final String MESSAGE_ID = PREFIX + "messageId";
42 |
43 | /**
44 | * The {@value NOTIFICATION_STATUS} header for SNS notification status.
45 | */
46 | public static final String NOTIFICATION_STATUS = PREFIX + "notificationStatus";
47 |
48 | /**
49 | * The {@value SNS_MESSAGE_TYPE} header for SNS message type.
50 | */
51 | public static final String SNS_MESSAGE_TYPE = PREFIX + "snsMessageType";
52 |
53 | /**
54 | * The {@value SHARD} header to represent Kinesis shardId.
55 | */
56 | public static final String SHARD = PREFIX + "shard";
57 |
58 | /**
59 | * The {@value RECEIVED_STREAM} header for receiving data from Kinesis.
60 | */
61 | public static final String RECEIVED_STREAM = PREFIX + "receivedStream";
62 |
63 | /**
64 | * The {@value RECEIVED_PARTITION_KEY} header for receiving data from Kinesis.
65 | */
66 | public static final String RECEIVED_PARTITION_KEY = PREFIX + "receivedPartitionKey";
67 |
68 | /**
69 | * The {@value RECEIVED_SEQUENCE_NUMBER} header for receiving data from Kinesis.
70 | */
71 | public static final String RECEIVED_SEQUENCE_NUMBER = PREFIX + "receivedSequenceNumber";
72 |
73 | /**
74 | * The {@value STREAM} header for sending data to Kinesis.
75 | */
76 | public static final String STREAM = PREFIX + "stream";
77 |
78 | /**
79 | * The {@value PARTITION_KEY} header for sending data to Kinesis.
80 | */
81 | public static final String PARTITION_KEY = PREFIX + "partitionKey";
82 |
83 | /**
84 | * The {@value SEQUENCE_NUMBER} header for sending data to SQS/Kinesis.
85 | */
86 | public static final String SEQUENCE_NUMBER = PREFIX + "sequenceNumber";
87 |
88 | /**
89 | * The {@value CHECKPOINTER} header for checkpoint the shard sequenceNumber.
90 | */
91 | public static final String CHECKPOINTER = PREFIX + "checkpointer";
92 |
93 | /**
94 | * The {@value SERVICE_RESULT} header represents a
95 | * {@link com.amazonaws.AmazonWebServiceResult}.
96 | */
97 | public static final String SERVICE_RESULT = PREFIX + "serviceResult";
98 |
99 | /**
100 | * The {@value RAW_RECORD} header represents received Kinesis record(s).
101 | */
102 | public static final String RAW_RECORD = PREFIX + "rawRecord";
103 |
104 | /**
105 | * The {@value TRANSFER_LISTENER} header for
106 | * {@link software.amazon.awssdk.transfer.s3.progress.TransferListener}
107 | * callback used in the {@link org.springframework.integration.aws.outbound.S3MessageHandler}
108 | * for file uploads.
109 | */
110 | public static final String TRANSFER_LISTENER = PREFIX + "transferListener";
111 |
112 | }
113 |
--------------------------------------------------------------------------------
/src/main/java/org/springframework/integration/aws/inbound/SqsMessageDrivenChannelAdapter.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package org.springframework.integration.aws.inbound;
18 |
19 | import java.util.Arrays;
20 | import java.util.Collection;
21 |
22 | import io.awspring.cloud.sqs.config.SqsMessageListenerContainerFactory;
23 | import io.awspring.cloud.sqs.listener.MessageListener;
24 | import io.awspring.cloud.sqs.listener.SqsContainerOptions;
25 | import io.awspring.cloud.sqs.listener.SqsHeaders;
26 | import io.awspring.cloud.sqs.listener.SqsMessageListenerContainer;
27 | import software.amazon.awssdk.services.sqs.SqsAsyncClient;
28 |
29 | import org.springframework.integration.endpoint.MessageProducerSupport;
30 | import org.springframework.integration.support.management.IntegrationManagedResource;
31 | import org.springframework.jmx.export.annotation.ManagedAttribute;
32 | import org.springframework.jmx.export.annotation.ManagedResource;
33 | import org.springframework.messaging.Message;
34 | import org.springframework.messaging.support.GenericMessage;
35 | import org.springframework.util.Assert;
36 |
37 | /**
38 | * The {@link MessageProducerSupport} implementation for the Amazon SQS
39 | * {@code receiveMessage}. Works in 'listener' manner and delegates hard to the
40 | * {@link SqsMessageListenerContainer}.
41 | *
42 | * @author Artem Bilan
43 | * @author Patrick Fitzsimons
44 | *
45 | * @see SqsMessageListenerContainerFactory
46 | * @see SqsMessageListenerContainerFactory
47 | * @see MessageListener
48 | * @see SqsHeaders
49 | */
50 | @ManagedResource
51 | @IntegrationManagedResource
52 | public class SqsMessageDrivenChannelAdapter extends MessageProducerSupport {
53 |
54 | private final SqsMessageListenerContainerFactory.Builder