C# Class SobekCM.Library.AdminViewer.Builder_AdminViewer

Gives the current SobekCM status and allows an authenticated system admin to temporarily halt the builder remotely via a database flag
This class extends the abstract_AdminViewer class.

MySobek Viewers are used for registration and authentication with mySobek, as well as performing any task which requires authentication, such as online submittal, metadata editing, and system administrative tasks.

During a valid html request, the following steps occur:
  • Application state is built/verified by the Application_State_Builder
  • Request is analyzed by the QueryString_Analyzer and output as a Navigation_Object
  • Main writer is created for rendering the output, in his case the Html_MainWriter
  • The HTML writer will create the necessary subwriter. Since this action requires authentication, an instance of the MySobek_HtmlSubwriter class is created.
  • The mySobek subwriter creates an instance of this viewer allow the system administrator to view and update the status of the SobekCM builder application.
Inheritance: abstract_AdminViewer
ファイルを表示 Open project: MarkVSullivan/SobekCM-Web-Application

Public Methods

Method Description
Builder_AdminViewer ( RequestCache RequestSpecificValues ) : System

Constructor for a new instance of the Builder_AdminViewer class

Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void

Add the HTML to be displayed in the main SobekCM viewer area

This class does nothing, since the alias list is added as controls, not HTML

Write_ItemNavForm_Closing ( TextWriter Output, Custom_Tracer Tracer ) : void

This is an opportunity to write HTML directly into the main form, without using the pop-up html form architecture

This text will appear within the ItemNavForm form tags

Write_Within_HTML_Head ( TextWriter Output, Custom_Tracer Tracer ) : bool

Write any additional values within the HTML Head of the final served page

Private Methods

Method Description
add_builder_logs ( TextWriter Output, string Base_URL, Custom_Tracer Tracer ) : void
add_builder_scheduled_tasks ( TextWriter Output, string Base_URL, Custom_Tracer Tracer ) : void
add_builder_status ( TextWriter Output, string Base_URL, Custom_Tracer Tracer ) : void

Method Details

Builder_AdminViewer() public method

Constructor for a new instance of the Builder_AdminViewer class
public Builder_AdminViewer ( RequestCache RequestSpecificValues ) : System
RequestSpecificValues RequestCache All the necessary, non-global data specific to the current request
return System

Write_HTML() public method

Add the HTML to be displayed in the main SobekCM viewer area
This class does nothing, since the alias list is added as controls, not HTML
public Write_HTML ( TextWriter Output, Custom_Tracer Tracer ) : void
Output System.IO.TextWriter Textwriter to write the HTML for this viewer
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return void

Write_ItemNavForm_Closing() public method

This is an opportunity to write HTML directly into the main form, without using the pop-up html form architecture
This text will appear within the ItemNavForm form tags
public Write_ItemNavForm_Closing ( TextWriter Output, Custom_Tracer Tracer ) : void
Output System.IO.TextWriter Textwriter to write the pop-up form HTML for this viewer
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return void

Write_Within_HTML_Head() public method

Write any additional values within the HTML Head of the final served page
public Write_Within_HTML_Head ( TextWriter Output, Custom_Tracer Tracer ) : bool
Output System.IO.TextWriter Output stream currently within the HTML head tags
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return bool