Skip to content

Commit

Permalink
Renamed the package
Browse files Browse the repository at this point in the history
Renamed the package from it.trv.vendorsftpconnection to it.trvi.vendorsftpconnection.
  • Loading branch information
StefanoTrv committed Sep 14, 2021
1 parent e1c3911 commit 891dbbe
Show file tree
Hide file tree
Showing 10 changed files with 23 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .idea/artifacts/SFTPConnectionWithAmazonVendor.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions .idea/runConfigurations.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
A small Java library that implements the sending and receiving of messages to and from the Amazon Vendor servers, using the SFTP protocol as specified in the document "Amazon SFTP Guide".

## Index
* [Release notes](#release-notes)
* [Introduction](#introduction)
* [The connection settings file](#the-connection-settings-file)
* [Documentation](#documentation)
Expand All @@ -13,14 +14,18 @@ A small Java library that implements the sending and receiving of messages to an
* [MessageReceptionException](#messagereceptionexception)
* [Conclusion](#conclusion)

## Release notes
* **1.0.1**: Renamed package: "it.trv.vendorsftpconnection" -> "it.trvi.vendorsftpconnection"
* **1.0.0**: Initial release

## Introduction
The objective of this package is to provide a simple tool to exchange messages with the Amazon Vendor servers using the SFTP protocol. It sends and receives the messages as raw text, so it's up to the users of this library to ensure the content of the messages is consistent and processed correctly. It uses the JSch library by JCraft to create and manage the actual SFTP sessions.

Knowledge of the Amazon Vendor documentation is needed to understand and use this tool and this documentation correctly. This package is a way to make the process of establishing a working connection with Amazon's SFTP servers faster, but knowing and understanding how this connection is set up and how it works is still necessary. The document "Amazon SFTP Guide" is the one that requires the most attention for the purposes of this package. If you need help creating the SSH keys, I suggest you follow [this guide](https://www.ssh.com/ssh/keygen/).

As stated in the license, this software is provided "as is" without warranty of any kind. I'm not responsible for any issue and/or damage that this software may cause. Please read the full license for more legal jargon. This package has undergone limited testing, because I have no longer access to an Amazon Vendor account; please report any error or problem you might find, and I'll try to fix it to the best of my ability.

All the classes in this library are contained in the package "`it.trv.vendorsftpconnection`".
All the classes in this library are contained in the package "`it.trvi.vendorsftpconnection`".

## The connection settings file
This file contains some of the information necessary to create a new session with the SFTP servers: the path to this file is one of the parameters that must be specified when establishing a connection. It contains the following data:
Expand Down
Binary file modified SFTPConnectionWithAmazonVendor.jar
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
Class use to validate a new SFTP connection with the Amazon Vendor server, by passing the tests for the connection required by Amazon.
*/
package it.trv.vendorsftpconnection;
package it.trvi.vendorsftpconnection;

import javax.swing.*;
import java.io.IOException;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package it.trv.vendorsftpconnection;
package it.trvi.vendorsftpconnection;

public class ConnectionException extends Exception{
public ConnectionException(String errorMessage) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package it.trv.vendorsftpconnection;
package it.trvi.vendorsftpconnection;

import java.util.NoSuchElementException;
import java.util.concurrent.TimeoutException;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package it.trv.vendorsftpconnection;
package it.trvi.vendorsftpconnection;

public class MessageForwardingException extends Exception{
public MessageForwardingException(String errorMessage) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package it.trv.vendorsftpconnection;
package it.trvi.vendorsftpconnection;

public class MessageReceptionException extends Exception{
public MessageReceptionException(String errorMessage) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package it.trv.vendorsftpconnection;
package it.trvi.vendorsftpconnection;

import com.jcraft.jsch.Channel;
import com.jcraft.jsch.ChannelSftp;
Expand Down

0 comments on commit 891dbbe

Please sign in to comment.