SobekCM.Core Namespace

Classes contain all the information about aggregations, both complete aggrgeations and language-specific versions, as well classes that hold data about the child pages and other child objects to the aggrgegations.

Contains the main classes which collectively comprise the application state for the running instance of SobekCM

Brief item object is used to pass information about a single digital resource to the ui-layer via the engine. While this retains most the information from the SobekCM_Item class, the data is somewhat simplified and normalized when passed out via the REST API.

Client classes used for accessing the endpoints exposed via the SobekCM engine

Classes contain much of the configuration information used throughout the SobekCM system, such as the OAI-PMH, Shibboleth, quality control, and contact form settings, as well as classes to support mulitple web languages. Configuration information is very static and is usually read from config files located under the applications. The readers and writers for this configuration files are generally in the SobekCM Engine library.

Class is used to store information about individual items within a single title and made available to the ui-layer via the endpoints on the SobekCM engine

Contains the cached data manager and methods for clearing the cache (or caching server) as well as retrieving and storing objects.

Messages used to wrap responses between the engine and ui-layer.

General classes to support a client that relies on a configuration file to find all the microservice endpoints to be exposed

Classes that hold the basic navigational information for a single query and can be used to write the URL for other specific possible requests.

Classes used to support OAI-PMH serving of digital resource metadata.

Classes hold the search result information returned from a database or solr/lucene search

Contains information about a single metadata field, useful for building the search strings for querying both the database and solr/lucene.

Interface is used to determine that some action should be completed before or after serialization, and must be checked on both sides of the REST API communication

Classes hold all the setting information related to this instance. Setting information is more prone to change than configurations and are usually stored within the database. The builders and database calls to populate these setting objects are in the SobekCM Engine library.

Classes are used to store the sitemap information for a tree of top-level static resources within an instance.

Contains the objects used to control the web skin (a.k.a. interface) which determines the overall appearance of the digital library

Contains all the data about a single authenticated user including all the top-level permissions granted and aggregation-specific permissions.

Contains the classes used when to hold all the information about a single static html content page served through the instance, either at the top-level or under an aggrgeation.

Class represents information for an email to be sent by the system

A single milestone entry in the history of an entity

Interface is implemented for classes that require some additional configuration to occur around serialization events