DOIP is the recommended interface for accessing Cordra. Use the client libraries to interact with Cordra using DOIP.
What is DOIP?
The Digital Object Interface Protocol (DOIP) is a protocol for accessing repository and registry systems in the Digital Object Architecture. It specifies a standard way for clients to interact with digital objects.
You can read the DOIP Specification for more information about DOIP and its various components; Cordra documentation also includes sections on DOIP and the DOIP API for HTTP Clients.
How does Cordra use DOIP?
Cordra implements the DOIP protocol to provide a standardized interface for interacting with digital objects.
Standard Operations
Supports standard DOIP operations like create, retrieve, update, delete, search, and list operations on digital objects.
Extensibility
Allows for custom operations to be defined and implemented, extending the functionality beyond the standard operations.
Authentication
Supports authentication mechanisms defined in the DOIP specification, including via public key infrastructure (PKI).
Client Libraries
Client libraries for Java, JavaScript, and Python simplify the development of applications that interact with Cordra via DOIP.
Client Libraries
DOIP Client Library - JavaScript Version
The DOIP Client Library - JavaScript Version can be used to develop JavaScript and TypeScript applications that interact with Cordra via DOIP.
The library can be installed via npm:
npm
See also the source code or download the library as a bundle.
The license for the DOIP Client Library - JavaScript Version is here.
JavaScript dependencies of @cnri/doip-client:
- @cnri/encoding: npm, source, API documentation, bundle
- @cnri/json-streaming: npm, source, API documentation, bundle
DOIP Client Library - Python Version
Coming soon.
DOIP Software Development Kit for Java
The DOIP SDK for Java can be used to develop Java applications that use DOIP for interacting with Cordra.
Additional details are discussed in this document. The SDK itself can be downloaded directly from here.
This SDK can be included in your application via Gradle or Maven as a dependency. Examples of how to use the client part of this SDK can be found here.
The license for DOIP SDK for Java is here.