Chapter 10. S-RAMP
10.1. S-RAMP Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
SOA Repository Artifact Model and Protocol (S-RAMP) is supported by a Technical Committee at OASIS. It is a specification of SOA repository that provides a common data model and protocol for interacting with a repository of SOA artifacts. For more information, see https://www.oasis-open.org/committees/s-ramp/charter.php.
S-RAMP supports interoperability between repository implementations by standardizing on a data model and API. The S-RAMP specification includes the following:
- A foundation document that describes the core concepts.
- An Atom based protocol binding document that describes an Atom based API.
An S-RAMP repository primarily stores artifacts. An artifact comprises of the following metadata:
- Core Properties
- Custom Properties
- Classifiers
- Relationships
10.2. S-RAMP Console Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
10.2.1. S-RAMP Dashboard Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
The S-RAMP Dashboard is where you can import artifacts and modify them. A list of DTGov data is presented in the Repository view. Additionally, the following core properties are presendted for configuration:
- Type
- Date Created
- Date Last Modified
- Created By
- Last Modified
- Origin (Any, Primary or Derived)
10.2.2. Accessing the S-RAMP Dashboard Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
You can view S-RAMP's graphical interface in your browser. The S-RAMP dashboard gives you a full visual representation of all the options available to you. Browse the menu options and buttons to see what's on offer.
Procedure 10.1. Task
- In a browser, navigate to http://localhost:8080/s-ramp-ui .
- Enter your administrator username and password when prompted.
Result
The S-RAMP dashboard will be displayed.
10.3. S-RAMP Management CLI Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
10.3.1. Connect to the S-RAMP Server Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
Connecting to the S-RAMP server gives you access to the S-RAMP dashboard and repository. This allows you to access artifacts and their metadata in one place. Once you have signed in, you can browse the repository and inspect your data.
- Open a command terminal and navigate to
EAP_HOME/bindirectory. - Start the JBoss EAP server by entering following command:
$ ./standalone.sh - Open another terminal and type
./s-ramp.sh. Then typeconnectand press Tab key. The command will auto-complete to says-ramp:connect http://localhost:8080/s-ramp-server.Enter username and password to connect via the S-RAMP shell. The username and password are defined in sramp.properties.
Result
When you press Tab key, the command will auto-complete to say s-ramp:connect http://localhost:8080/s-ramp-server and when you press the return key the cursor will go from red to green indicating successful connection to S-ramp server.
10.3.2. Browse the S-RAMP Repository Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
Running the commands in this task will allow you to access the S-RAMP repository and peruse its contents. You can view server output and metadata for artifacts. This lets you view additional details of indexed items.
- Run this command:
s-ramp:query /s-rampHere is an example of the output of this command:Querying the S-RAMP repository: /s-ramp Atom Feed (9 entries) Idx Type Name --- ---- ---- 1 ImageDocument user-properties.png 2 Document overlord.demo.CheckDeployment-taskform.flt 3 BrmsPkgDocument SRAMPPackage.pkg 4 ImageDocument overlord.demo.SimpleReleaseProcess-image.png 5 ImageDocument run-build-install.png 6 Document overlord.demo.SimpleReleaseProcess-taskform.flt 7 ImageDocument audio-input-microphone-3.png 8 BpmnDocument overlord.demo.SimpleReleaseProcess.bpmn 9 TextDocument HttpClientWorkDefinitions.wid - To obtain the metaData of overlord.demo.SimpleReleaseProcess.bpmn (which is number 8 in the list in the output example), issue this command:
s-ramp:getMetaData feed:8Meta Data for: 31b3acbc-cda8-4856-9e34-d3e645283035 -------------- -- Core S-RAMP Info -- Type: BpmnDocument Model: ext UUID: 31b3acbc-cda8-4856-9e34-d3e645283035 Name: overlord.demo.SimpleReleaseProcess.bpmn Derived: false Created By: anonymous Created On: 2013-03-08T14:00:37.036-05:00 Modified By: anonymous Modified On: 2013-03-18T14:58:46.328-04:00 s-ramp>