Open service interface definition: Difference between revisions

Revision as of 20:39, 17 December 2005

Latest revision as of 06:51, 18 July 2023

(45 intermediate revisions by 28 users not shown)

Line 1:

{{no footnotes|date=July 2023}}

[[Image:oki-logo.gif|right]]

An '''Openopen Serviceservice Interfaceinterface Definitionsdefinition''' (OSIDs)'''OSID''') areis a programmatic interface specificationsspecification describing servicesa service. These interfaces are specified by the [[Open Knowledge Initiative]] ('''O.K.I.'''OKI) to implement a [[Serviceservice-oriented Oriented Architecturearchitecture]] (SOA) to achieve [[interoperability]] among applications across a varied base of underlying and changing technologies.

==Description==

== Rationale ==

'''Open Service Interface Definitions (OSIDs)''' are programmatic interface specifications describing services. These interfaces are specified by the [[Open Knowledge Initiative]] ('''O.K.I.''') to implement a [[Service Oriented Architecture]] (SOA) to achieve interoperability among applications across a varied base of underlying and changing technologies.

To preserve the investment in developmentsoftware engineering, program logic is separated from underlying technologies through the use of software interfaces each of which defines a contract between a service [[consumer]] and a [[service provider]]. This separation is the basis of any valid SOA. While some methods define the service interface boundary at a protocol or server level, OSIDs place the boundary at the application level to effectively insulate the consumer from [[Protocol (computing)|protocols]], server identities, and utility libraries that are in the ___domain to a service provider resulting in software which is easier to develop, longer -lasting, and usable across a wider array of computing environments.

OSIDs assist in [[software design]] and development by breaking up the problem space across service interface boundaries. Because network communication issues are addressed within a service provider and not at''below'' the interface, there isn't an assumption that every service provider implement a remote communications protocol (though many do). OSIDs are also used for communication and coordination among the various components of complex software which provide a means of organizing design and development activities for simplified [[project management]].

OSID providers (implementations) are often reused across a varied set of applications. Once software is made to understand the interface contract for a service, other compliant implementations may be used in its place. This achieves [[reusability]] at a high level (a service level) and also serves to easily scale software written for smaller more dedicated purposes.

An OSID provider implementation may be composed of an arbitrary number of other OSID providers. This layering technique is an obvious means of [[abstraction]]. When all the OSID providers implement the same service, this is called an ''adapter'' pattern. Adapter patterns are powerful techniques to federate, multiplex, or bridge different services contracting from the same interface without the modification to the application.

==Service Definitions==

===Repository= List ==

The '''Repository''' OSID defines interfaces for managing, searching and retrieving assets in a digital [[repository]].

===* Agent===

===Scheduling===

* Assessment

The '''Scheduling''' OSID defines interfaces for calendaring.

===* Authentication===

===* Authorization===

* CourseManagement

* Dictionary

===* Filing===

===* Grading===

===* Hierarchy===

===* Logging===

===User* Messaging===

* Repository

===* Scheduling===

* Workflow

===Workflow= References ==

The '''Workflow''' OSID defines interfaces for managing a process comprised of a sequence of steps of sub-processes.

*Baving, T., Cook, D., Green, T. 2005. [http://simba.cs.uct.ac.za/~honsproj/cgi-bin/view/2003/baving_green.zip/baving_green/coursetool/downloads/paper.pdf Baving, T., Cook, D., Green, T. ''Integrating the Educational Enterprise'']. 2003.]

===Asessment===

*Kraan, W. 2005. [http://www.okiproject.org/documents/OKIandIMS-WiresAndSocketsRevisited.pdf Kraan, W. ''O.K.I. and IMS, wires and sockets revisited''].]

The '''Assessment''' OSID defines interfaces for testing and feedback.

*Kahn, J. 2005. [http://www.okiproject.org/library/doc_41.html Kahn, J. ''Screen Shots: Repository OSID Interoperability'']. 2005.]

* [http://www.okiproject.org/filemgmt/visit.php?lid=44 Kumar, V., Merriman, J., Thorne, S. ''Open Knowledge Initiative Final Report''. 2004.]

* Kahn, J. 2005. [http://www.okiproject.org/documentsfilemgmt-data/files/RepositoryDevelopersGuide-Draft01v1.0.pdf Kahn, J. ''Repository Developer's Guide'']. 2006.]

* Kahn, J. 2005. [http://www.okiproject.org/documents/OKIManagingComplexity_rel_1_0.pdf Kahn, J. ''Managing Complexity and Surviving Technology Change'']. 2005.]

== External links ==

===User Messaging===

The '''User Messaging''' OSID defines interfaces for transporting messages among users or systems.

* {{Official website|http://osid.org}}

===Course Management===

* [https://okapia.atlassian.net/wiki/spaces/OSID/overview OSID wiki]

The '''Course Management''' OSID defines interfaces for describing academic curriculums.

* [https://web.archive.org/web/20081226161331/http://www.phpoki.org/ PHP OSIDs]

{{internet-stub}}

===Grading===

The '''Grading OSID''' defines interfaces for submitting grade reports.

[[Category:Software architecture]]

===Authentication===

[[Category:Service-oriented (business computing)]]

The '''Authentication''' OSID defines interfaces for performing user or system authentication.

===Authorization===

The '''Authorization''' OSID defines interfaces for managing and querying authorization roles of Agents or Groups.

===Agent===

The '''Agent''' OSID defines interfaces for identifing people.

===Hierarchy===

The '''Hierarchy''' OSID defines interfaces for managing arbitrary collections of objects.

===Identity===

The '''Id''' OSID defines an interface for managing identitifiers of objects.

===Filing===

The '''Filing''' OSID defines interfaces for manging files in file systems.

===Logging===

The '''Logging''' OSID defines interfaces for reading and writing log files.

==References==

*[[Open Knowledge Initiative]]: [http://sourceforge.net/projects/okiproject O.K.I.]

*Baving, T., Cook, D., Green, T. 2005. [http://simba.cs.uct.ac.za/~honsproj/cgi-bin/view/2003/baving_green.zip/baving_green/coursetool/downloads/paper.pdf ''Integrating the Educational Enterprise''].

*Kraan, W. 2005. [http://www.okiproject.org/documents/OKIandIMS-WiresAndSocketsRevisited.pdf ''O.K.I. and IMS, wires and sockets revisited''].

*Kahn, J. 2005. [http://www.okiproject.org/library/doc_41.html ''Screen Shots: Repository OSID Interoperability''].

*Kumar, V., Merriman, J., Thorne, S. 2004. [http://www.okiproject.org/documents/%20%20OKI%20Report%20to%20Mellon.pdf ''Open Knowledge Initiative Final Report''].

* Kahn, J. 2005. [http://www.okiproject.org/documents/RepositoryDevelopersGuide-Draft01.pdf ''Repository Developer's Guide''].

* Coppeto, T. 2005. [http://www.ontapsolutions.com/articles/oki/20050421-oki_impllayering.shtml ''OSID 2.0 Design Patterns: OSID Layering''].

* Kahn, J. 2005. [http://www.okiproject.org/documents/OKIManagingComplexity_rel_1_0.pdf ''Managing Complexity and Surviving Technology Change''].

[[Category:Software_architecture]]