Difference between revisions of "APEL/SSM2Overview"

From EGIWiki
Jump to: navigation, search
m (Corrected contact email address)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
* Back to [[APEL/SSM]]
 
* Back to [[APEL/SSM]]
  
'''These notes refer to SSM version 2.  See [[APEL/SSMOverview]] for notes on SSM1.''' Please send suggestions and queries to apel-ssm-test@jiscmail.ac.uk
+
'''These notes refer to SSM version 2. ''' Please send suggestions and queries to [mailto:apel-admins@stfc.ac.uk apel-admins@stfc.ac.uk]
 +
 
  
 
== Introduction ==
 
== Introduction ==
Line 16: Line 17:
 
The SSM is designed to have a simple interface, which isolates it from any other components it may be used with.
 
The SSM is designed to have a simple interface, which isolates it from any other components it may be used with.
  
==== Very simplified version ====
+
==== Simplified version ====
# The sending and receiving SSMs are configured to communicate using a specified topic.
+
# The sending and receiving SSMs are configured to communicate using a specified queue.
 
# A file is written to the sending SSM's 'outgoing' directory (by some other process) - see [[APEL/SSM2AddingFiles]].
 
# A file is written to the sending SSM's 'outgoing' directory (by some other process) - see [[APEL/SSM2AddingFiles]].
# The file disappears from outgoing directory.
+
# The file disappears from outgoing directory when <code>ssmsend</code> is run.
# The file appears in receiving SSM's 'incoming' directory.
+
# The file appears in receiving SSM's 'incoming' directory if <code>ssmreceive</code> is running.
 +
 
  
 +
Once the sending and receiving SSMs are configured and running correctly, to send a message, put a file in the correct outgoing directory with the correct name, run <code>ssmsend</code>, and it will disappear.  It will arrive in the incoming directory of the receiving SSM.
  
Once the sending and receiving SSMs are configured and running correctly (this is not yet a trivial process), the details of this process are not important.  If you are sending a message, put a file in the correct outgoing directory and it will disappear.  It will promptly appear in the incoming directory of the receiving SSM.
+
* '''Next:''' [[APEL/SSM2Installation|SSM2 installation instructions]]
  
 
[[Category:Accounting]]
 
[[Category:Accounting]]

Latest revision as of 14:50, 5 November 2015

These notes refer to SSM version 2. Please send suggestions and queries to apel-admins@stfc.ac.uk


Introduction

The Secure Stomp Messenger (SSM) is a python package designed to send arbitrary files using ActiveMQ and the STOMP protocol. Its key features are:

  • It uses the underlying filesystem to store outgoing and / or incoming messages
  • It sends arbitrary files from a client to a server SSM
  • It can use any broker configured to use STOMP
  • Files are signed and may be encrypted during transit using X509 certificates

Interface

The SSM is designed to have a simple interface, which isolates it from any other components it may be used with.

Simplified version

  1. The sending and receiving SSMs are configured to communicate using a specified queue.
  2. A file is written to the sending SSM's 'outgoing' directory (by some other process) - see APEL/SSM2AddingFiles.
  3. The file disappears from outgoing directory when ssmsend is run.
  4. The file appears in receiving SSM's 'incoming' directory if ssmreceive is running.


Once the sending and receiving SSMs are configured and running correctly, to send a message, put a file in the correct outgoing directory with the correct name, run ssmsend, and it will disappear. It will arrive in the incoming directory of the receiving SSM.