[FOLIO-1583] Add mod-oai-pmh to folio-testing Created: 17/Oct/18  Updated: 12/Nov/18  Resolved: 08/Nov/18

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Story Priority: P3
Reporter: Craig McNally Assignee: Wayne Schneider
Resolution: Done Votes: 0
Labels: ci, integration, sprint50
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Sprint:

 Description   

Please add mod-oai-pmh to folio-testing.

Github:
https://github.com/folio-org/mod-oai-pmh

Docker:
https://hub.docker.com/r/folioci/mod-oai-pmh/tags/

ModuleDescriptor:

{
  "id": "mod-oai-pmh-1.0.0-SNAPSHOT.6",
  "name": "OAI-PMH Repository Module",
  "provides": [
    {
      "id": "oai-pmh",
      "version": "1.0",
      "handlers": [
        {
          "methods": ["GET"],
          "pathPattern": "/oai/records",
          "permissionsRequired": ["oai-pmh.records.collection.get"],
          "modulePermissions": [
            "inventory-storage.instances.collection.get",
            "inventory-storage.instances.item.get",
            "inventory-storage.items.collection.get"
          ]
        },
        {
          "methods": ["GET"],
          "pathPattern": "/oai/records/{id}",
          "permissionsRequired": ["oai-pmh.records.item.get"],
          "modulePermissions": [
            "inventory-storage.instances.item.get",
            "inventory-storage.items.item.get"
          ]
        },
        {
          "methods": ["GET"],
          "pathPattern": "/oai/repository_info",
          "permissionsRequired": ["oai-pmh.identify.get"],
          "modulePermissions": []
        },
        {
          "methods": ["GET"],
          "pathPattern": "/oia/identifiers",
          "permissionsRequired": ["oai-pmh.identifiers.collection.get"],
          "modulePermissions": [
            "inventory-storage.instances.collection.get",
            "inventory-storage.instances.item.get"
          ]
        },
        {
          "methods": ["GET"],
          "pathPattern": "/oai/metadata_formats",
          "permissionsRequired": ["oai-pmh.metadata-formats.collection.get"],
          "modulePermissions": [
            "inventory-storage.instances.collection.get",
            "inventory-storage.instances.item.get",
            "inventory-storage.items.collection.get"
          ]
        },
        {
          "methods": ["GET"],
          "pathPattern": "/oai/sets",
          "permissionsRequired": ["oai-pmh.set.collection.get"],
          "modulePermissions": []
        }
      ]
    }
  ],
  "requires": [
    {
      "id": "item-storage",
      "version": "6.0"
    },
    {
      "id": "instance-storage",
      "version": "5.0"
    }
  ],
  "permissionSets": [
    {
      "permissionName": "oai-pmh.records.item.get",
      "displayName": "OAI-PMH - retrieve individual record",
      "description": "Retrieve an individual metadata record"
    },
    {
      "permissionName": "oai-pmh.identify.get",
      "displayName": "OAI-PMH - get information about a repository",
      "description": "Get information about a repository"
    },
    {
      "permissionName": "oai-pmh.identifiers.collection.get",
      "displayName": "OAI-PMH - get headers list",
      "description": "Get headers list of record in specific format"
    },
    {
      "permissionName": "oai-pmh.metadata-formats.collection.get",
      "displayName": "OAI-PMH - get metadata formats available from a repository",
      "description": "Get metadata formats available from a repository"
    },
    {
      "permissionName": "oai-pmh.records.collection.get",
      "displayName": "OAI-PMH - get list of records",
      "description": "Get records from repository"
    },
    {
      "permissionName": "oai-pmh.set.collection.get",
      "displayName": "oai-pmh - get set structure of a repository",
      "description": "Get set structure of a repository"
    },
    {
      "permissionName": "oia-pmh.all",
      "displayName": "OAI-PMH - all permissions",
      "description": "Entire set of permissions needed to use OAI-PMH",
      "subPermissions": [
        "oai-pmh.records.item.get",
        "oai-pmh.identify.get",
        "oai-pmh.identifiers.collection.get",
        "oai-pmh.metadata-formats.collection.get",
        "oai-pmh.records.collection.get",
        "oai-pmh.set.collection.get"
      ]
    }
  ],
  "launchDescriptor": {
    "dockerImage": "${artifactId}:${version}",
    "dockerArgs": {
      "HostConfig": { "PortBindings": { "8081/tcp":  [{ "HostPort": "%p" }] } }
    },
    "dockerPull" : false
  }
}


 Comments   
Comment by Wayne Schneider [ 08/Nov/18 ]

We are adding this as requested to folio-testing.aws.indexdata.com, but not to the folio/testing-backend Vagrant VM due to memory limitations (see FOLIO-1548 Closed )

Comment by Wayne Schneider [ 08/Nov/18 ]

It appears that the module descriptor for mod-oai-pmh is not being published to the registry (due to config in Jenkinsfile). See https://github.com/folio-org/mod-oai-pmh/pull/26

Comment by Wayne Schneider [ 08/Nov/18 ]

mod-oai-pmh will be included in the next build of folio-testing.aws.indexdata.com.

Generated at Thu Feb 08 23:14:25 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.