The document describes the Apache Stratos metadata service which exposes REST APIs to manage cartridge metadata in a governance registry. The REST APIs allow adding and retrieving cartridge details structured as application-cartridge-property hierarchies stored in the registry. The metadata service listens for instance events to add or delete metadata and can be packaged as a standalone server or library.

1. Apache Stratos- Meta data service
Section 1 ­Overview
design
Explanation
Section 2 ­REST
API
Rest API for add the cartridge details to the Governance registry
Overview
Sample request
Example
Rest API for retrieve the cartridge details from the Governance registry
Overview
Example
Sample response
Section 3 ­Stratos
Meta data structure in Governance Registry
Data structure template
Section 4 ­Packaging

2. Section 1 -Overview design
Explanation
­Meta
data service exposes REST API which responsible for meta data update and data
retrieve ( Describe under section 2)
­Cartridge
agent responsible for called meta data service and subscribe his own meta
data
­In
the case of grouping of cartridge,cartridge needs to retrieve meta data of his
dependent cartridge through REST api

3. ­Assuming
that dependent cartridge type will be attached in the generate­params
­Meta
data service listening for topology
Once instance terminated event occurred, it will delete the meta data in the G­Reg
Section 2 - REST API
Rest API for add the cartridge details to the Governance registry
Overview
Description Subscribe the cartridge details to the G­Reg
URL metadataservice/cartridge/metadata/<APPLICATION_NAME>/
<CARTRIDGE_TYPE>
HTTP Method POST
Request/Response Format application/json
Sample request
{
“applicationName”:”app­A”,
"displayName":"MYSQL",
"description":"MYSQL Cartridge",
"type":"mysql",
"provider":"apache",
"host":"stratos.org",
"version":"7",
"property":[
{
“url”:”http://mysql.stratos.org”,
"username":"root",
"password":"admin"
}
]

4. }
Example
Use case: Subscribe the meta data when installing the mysql Cartridge. The example request is
as follows:
curl ­X
POST ­H
"Content­Type:
application/json" ­d
@mysql­request
­k
­v
­u
admin:admin
https://<SM_HOST>:9443/stratosmetadata/metadataservice/cartridge/metadata/app1/mysq
l
Sample response
{
"stratosAdminResponse": {
"message": "Successfully added the cartridge meta data details"
}
}
Rest API for retrieve the cartridge details from the Governance registry
Overview
Description Retrieve cartridge meta data from the G­Reg
URL metadataservice/cartridge/metadata/<APPLICATION_NAME>/
<CARTRIDGE_TYPE>
HTTP Method GET
Request/Response
Format
application/json
Example
Use case: Retrieve the meta data of the mysql cartridge. The example request is as follows:
curl ­X
GET ­H
"Content­Type:
application/json" ­k
­v
­u
admin:admin

5. https://<SM_HOST>:9443/stratosmetadata/metadataservice/cartridge/metadata/app1/mysql
Sample response
{
“applicationName”:”app­A”,
"displayName":"mysql",
"description":"mysql Cartridge",
"type":"mysql",
"provider":"apache",
"host":"stratos.org",
"version":"7",
"property":[
{
“url”:”http://mysql.stratos.org”,
"username":"root",
"password":"admin"
}
]
}

6. Section 3 - Stratos Meta data structure in Governance Registry
Data structure template
Application 1
­cartridge
1
­property
1(key/value)
­property
2
­cartridge
2
­property
1
­property
2
Application 2
­cartridge
1
­property
1
­property
2
­cartridge
2
­property
1
­property
2
Section 4 - Packaging
+Can be packed in a standalone server or single JVM
+Proposed component name : org.apache.stratos.metadataservice