JBoss.orgCommunity Documentation

Overlord S-RAMP Guide

SOA Repository Artifact Model and Protocol

1. Introduction to S-RAMP
1.1. The S-RAMP Specification
1.2. Purpose
1.3. Overview
1.4. Core Properties
1.5. Custom Properties
1.6. Classifiers
1.7. Relationships
2. Getting Started
2.1. Prerequisites
2.2. Download, Installation and Configuration
2.3. Check your Installation
3. User Management
3.1. Overview
3.2. Required Roles
3.3. Adding a User
3.3.1. JBoss EAP 6.1
3.3.2. JBoss Fuse 6.1
3.3.3. Tomcat 7
4. S-RAMP Data Models
4.1. Core Data Model (core)
4.2. XML Schema (XSD) Data Model (xsd)
4.3. WSDL Data Model (wsdl)
4.4. Policy Data Model (policy)
4.5. SOA Data Model (soa)
4.6. Service Implementation Data Model (serviceImplementation)
4.7. Custom/Extension Data Models (ext)
4.8. Teiid Data Models (Teiid)
5. Query Language
6. S-RAMP REST API
6.1. Overview
6.2. Adding Artifacts
6.3. Updating Artifacts
6.4. Deleting Artifacts
6.5. Querying
6.5.1. Queries
6.5.2. Feeds
6.6. Getting Full Artifact
6.7. Batch changes: S-RAMP Archives (Packages)
7. Overlord S-RAMP Implementation
7.1. Overview
7.2. Server
7.2.1. Description
7.2.2. Configuring
7.2.3. Security (Authentication)
7.2.4. Security (Authorization)
7.2.5. Extending: Custom Deriver
7.3. Client
7.3.1. Basic Usage
7.3.2. Extended Feature: Ontologies
7.3.3. Extended Feature: Auditing
7.3.4. Extending: Custom Expander
8. Overlord S-RAMP REST API Endpoints
8.1. API: Get Service Document
8.2. API: Publish Artifact
8.2.1. Publish a Document Style Artifact
8.2.2. Publish a Non-Document Style Artifact
8.2.3. Publish a Document Style Artifact with Meta-Data
8.3. API: Update Artifact
8.4. API: Update Artifact Content
8.5. API: Get Artifact
8.6. API: Get Artifact Content
8.7. API: Delete Artifact
8.8. API: Get Artifact Feed (by model)
8.9. API: Get Artifact Feed (by type)
8.10. API: Query
8.11. API: Query
8.12. API: Batch Processing
8.13. API: Add Ontology
8.14. API: List Ontologies
8.15. API: Update Ontology
8.16. API: Get Ontology
8.17. API: Delete Ontology
8.18. API: Get Artifact Audit History
8.19. API: Get User Audit History
8.20. API: Add Artifact Audit Entry
8.21. API: Get Artifact Audit Entry
9. The S-RAMP Browser (UI)
9.1. Overview
9.2. Configuration
9.2.1. Security (Authentication)
9.2.2. Security (Authorization)
10. Overlord S-RAMP Command Line
10.1. Connecting to S-RAMP server
10.2. Browsing the S-RAMP repository
10.3. Updating artifact MetaData
10.3.1. Properties
10.3.2. Custom Properties
10.3.3. Classifications
10.4. Querying the S-RAMP Repository using XPath2 Syntax
10.5. Extending the S-RAMP CLI
11. Overlord S-RAMP Maven Integration
11.1. Overview
11.2. Enabling the S-RAMP Wagon
11.3. Deploying to S-RAMP
11.4. Adding S-RAMP Artifacts as Dependencies
11.5. A Note About Authentication
12. S-RAMP Samples
Bibliography