C# Class SobekCM.Core.Client.SobekEngineClient_AdminEndpoints

Gateway to administrative-related endpoints exposed by the SobekCM engine not already supported by another service/endpoint
Inheritance: MicroservicesClientBase
ファイルを表示 Open project: MarkVSullivan/SobekCM-Web-Application Class Usage Examples

Public Methods

Method Description
Get_Admin_Settings ( Custom_Tracer Tracer ) : SobekCM.Core.Settings.Admin_Setting_Collection

Gets the administrative setting values, which includes display information along with the current value and key
Get_Authentication_Configuration ( Custom_Tracer Tracer ) : Authentication_Configuration

Gets the authentication configuration information, read from the configuration files
Get_Brief_Item_Mapping_Configuration ( Custom_Tracer Tracer ) : BriefItemMapping_Configuration

Gets the brief-item mapping configuration information, read from the configuration files
Get_Complete_Configuration ( Custom_Tracer Tracer ) : InstanceWide_Configuration

Gets the complete configuration information, read from the configuration files
Get_Complete_Configuration ( string Engine_URL, MicroservicesClient Engine_Protocol, Custom_Tracer Tracer ) : InstanceWide_Configuration

Gets the complete configuration information, read from the configuration files
Get_Configuration_Reading_Log ( Custom_Tracer Tracer ) : List

Gets the configuration reading log which lists which config files were read, etc..
Get_Contact_Form_Configuration ( Custom_Tracer Tracer ) : ContactForm_Configuration

Gets the contact form configuration information, read from the configuration files
Get_Engine_Configuration ( Custom_Tracer Tracer ) : Engine_Server_Configuration

Gets the engine configuration information, read from the configuration files
Get_Extensions_Configuration ( Custom_Tracer Tracer ) : Extension_Configuration

Gets the extensions configuration information, read from the configuration files
Get_Metadata_Configuration ( Custom_Tracer Tracer ) : Metadata_Configuration

Gets the metadata configuration information, read from the configuration files
Get_OAI_PMH_Configuration ( Custom_Tracer Tracer ) : OAI_PMH_Configuration

Gets the oai-pmh configuration information, read from the configuration files
Get_Quality_Control_Tool_Configuration ( Custom_Tracer Tracer ) : QualityControl_Configuration

Gets the qc tool configuration information, read from the configuration files
Get_Static_Resources_Configuration ( Custom_Tracer Tracer ) : StaticResources_Configuration

Gets the static resources ( mostly links to images, javascript, css, etc.. ), read from the configuration files
Get_UI_Citation_Configuration ( Custom_Tracer Tracer ) : CitationConfig

Gets the citation (UI) configuration information, read from the configuration files
Get_UI_Map_Editor_Configuration ( Custom_Tracer Tracer ) : MapEditor_Configuration

Gets the map editor (UI) configuration information, read from the configuration files
Get_UI_Template_Elements_Configuration ( Custom_Tracer Tracer ) : TemplateElementsConfig

Gets the template element mapping (UI) configuration information, read from the configuration files
Get_UI_Viewers_Configuration ( Custom_Tracer Tracer ) : WriterViewerConfig

Gets the viewers (UI) configuration information, read from the configuration files
Get_User_Interface_Configuration ( Custom_Tracer Tracer ) : InstanceWide_UI_Configuration

Gets the user-interface configuration information, read from the configuration files
Plugin_Disable ( string Code, Custom_Tracer Tracer ) : EnableExtensionMessage

Dsable an existing plug-in/extension
Plugin_Enable ( string Code, Custom_Tracer Tracer ) : EnableExtensionMessage

Enable an existing plug-in/extension
SobekEngineClient_AdminEndpoints ( MicroservicesClient_Configuration ConfigObj ) : System

Constructor for a new instance of the SobekEngineClient_AdminEndpoints class

Method Details

Get_Admin_Settings() public method

Gets the administrative setting values, which includes display information along with the current value and key
public Get_Admin_Settings ( Custom_Tracer Tracer ) : SobekCM.Core.Settings.Admin_Setting_Collection
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Settings.Admin_Setting_Collection

Get_Authentication_Configuration() public method

Gets the authentication configuration information, read from the configuration files
public Get_Authentication_Configuration ( Custom_Tracer Tracer ) : Authentication_Configuration
Tracer SobekCM.Tools.Custom_Tracer
return Authentication_Configuration

Get_Brief_Item_Mapping_Configuration() public method

Gets the brief-item mapping configuration information, read from the configuration files
public Get_Brief_Item_Mapping_Configuration ( Custom_Tracer Tracer ) : BriefItemMapping_Configuration
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Configuration.BriefItemMapping_Configuration

Get_Complete_Configuration() public method

Gets the complete configuration information, read from the configuration files
public Get_Complete_Configuration ( Custom_Tracer Tracer ) : InstanceWide_Configuration
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Configuration.InstanceWide_Configuration

Get_Complete_Configuration() public method

Gets the complete configuration information, read from the configuration files
public Get_Complete_Configuration ( string Engine_URL, MicroservicesClient Engine_Protocol, Custom_Tracer Tracer ) : InstanceWide_Configuration
Engine_URL string Engine endpoint URL to use for this request
Engine_Protocol MicroservicesClient Engine protocol to use to pull the configuration information
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Configuration.InstanceWide_Configuration

Get_Configuration_Reading_Log() public method

Gets the configuration reading log which lists which config files were read, etc..
public Get_Configuration_Reading_Log ( Custom_Tracer Tracer ) : List
Tracer SobekCM.Tools.Custom_Tracer
return List

Get_Contact_Form_Configuration() public method

Gets the contact form configuration information, read from the configuration files
public Get_Contact_Form_Configuration ( Custom_Tracer Tracer ) : ContactForm_Configuration
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Configuration.ContactForm_Configuration

Get_Engine_Configuration() public method

Gets the engine configuration information, read from the configuration files
public Get_Engine_Configuration ( Custom_Tracer Tracer ) : Engine_Server_Configuration
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Configuration.Engine.Engine_Server_Configuration

Get_Extensions_Configuration() public method

Gets the extensions configuration information, read from the configuration files
public Get_Extensions_Configuration ( Custom_Tracer Tracer ) : Extension_Configuration
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Configuration.Extensions.Extension_Configuration

Get_Metadata_Configuration() public method

Gets the metadata configuration information, read from the configuration files
public Get_Metadata_Configuration ( Custom_Tracer Tracer ) : Metadata_Configuration
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Resource_Object.Configuration.Metadata_Configuration

Get_OAI_PMH_Configuration() public method

Gets the oai-pmh configuration information, read from the configuration files
public Get_OAI_PMH_Configuration ( Custom_Tracer Tracer ) : OAI_PMH_Configuration
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Configuration.OAIPMH.OAI_PMH_Configuration

Get_Quality_Control_Tool_Configuration() public method

Gets the qc tool configuration information, read from the configuration files
public Get_Quality_Control_Tool_Configuration ( Custom_Tracer Tracer ) : QualityControl_Configuration
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Configuration.QualityControl_Configuration

Get_Static_Resources_Configuration() public method

Gets the static resources ( mostly links to images, javascript, css, etc.. ), read from the configuration files
public Get_Static_Resources_Configuration ( Custom_Tracer Tracer ) : StaticResources_Configuration
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.UI_Configuration.StaticResources.StaticResources_Configuration

Get_UI_Citation_Configuration() public method

Gets the citation (UI) configuration information, read from the configuration files
public Get_UI_Citation_Configuration ( Custom_Tracer Tracer ) : CitationConfig
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.UI_Configuration.Citation.CitationConfig

Get_UI_Map_Editor_Configuration() public method

Gets the map editor (UI) configuration information, read from the configuration files
public Get_UI_Map_Editor_Configuration ( Custom_Tracer Tracer ) : MapEditor_Configuration
Tracer SobekCM.Tools.Custom_Tracer
return MapEditor_Configuration

Get_UI_Template_Elements_Configuration() public method

Gets the template element mapping (UI) configuration information, read from the configuration files
public Get_UI_Template_Elements_Configuration ( Custom_Tracer Tracer ) : TemplateElementsConfig
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.UI_Configuration.TemplateElements.TemplateElementsConfig

Get_UI_Viewers_Configuration() public method

Gets the viewers (UI) configuration information, read from the configuration files
public Get_UI_Viewers_Configuration ( Custom_Tracer Tracer ) : WriterViewerConfig
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.UI_Configuration.Viewers.WriterViewerConfig

Get_User_Interface_Configuration() public method

Gets the user-interface configuration information, read from the configuration files
public Get_User_Interface_Configuration ( Custom_Tracer Tracer ) : InstanceWide_UI_Configuration
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.UI_Configuration.InstanceWide_UI_Configuration

Plugin_Disable() public method

Dsable an existing plug-in/extension
public Plugin_Disable ( string Code, Custom_Tracer Tracer ) : EnableExtensionMessage
Code string Code for the plug-in to disable
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Message.EnableExtensionMessage

Plugin_Enable() public method

Enable an existing plug-in/extension
public Plugin_Enable ( string Code, Custom_Tracer Tracer ) : EnableExtensionMessage
Code string Code for the plug-in to enable
Tracer SobekCM.Tools.Custom_Tracer
return SobekCM.Core.Message.EnableExtensionMessage

SobekEngineClient_AdminEndpoints() public method

Constructor for a new instance of the SobekEngineClient_AdminEndpoints class
public SobekEngineClient_AdminEndpoints ( MicroservicesClient_Configuration ConfigObj ) : System
ConfigObj SobekCM.Core.MicroservicesClient.MicroservicesClient_Configuration Fully constructed microservices client configuration
return System