HAI Use Case: Administrator Logs into the Hyrax Admin Interface: Difference between revisions

Latest revision as of 22:01, 8 November 2010

Point Of Contact: Nathan Potter

Description

The Administrator logs into the Hyrax Admin Interface.

Goal

Provide a secure login and session for Administrators to operate the Hyrax Admin Interface.

Summary

The Administrator uses a web browser to access the URL for the Hyrax Admin Interface. When accessed the server returns a secure authentication challenge. Once the Administrator has provided correct authentication credentials all subsequent interactions with the HAI are secure (encrypted) until the session times out or the Administrator logs off.

Actors

Administrator

Preconditions

The Administrator has access too, and authentication credentials for, a running Hyrax server.

Triggers

One or more of:

Hyrax needs re configuration.
Hyrax needs to be restarted.
The Administrator needs/wants to view the Hyrax logs.

Basic Flow

The Administrator points their browser at the URL for their HAI.
The HAI returns a secure page containing an authentication challenge.
The Administrator enters their authentication credentials.
The HAI Administrators credentials are recognized.
From this point on all pages sent from the HAI to the Administrator are secured through encryption (https??)
The HAI returns it's home page.

Alternate Flow

The Administrator points their browser at the URL for their HAI.
The HAI returns a secure page containing an authentication challenge.
The Administrator enters their authentication credentials.
The HAI Administrators credentials are NOT recognized.
The HAI returns it's an authentication failure page.

Post Conditions

The Administrator has an active session with the HAI which provides secure pages for controlling a Hyrax instance.

Activity Diagram

Here a diagram is given to show the flow of events that surrounds the use case.

Notes

There is always some piece of information that is required that has no other place to go. This is the place for that information.

Resources

In order to support the capabilities described in this Use Case, a set of resources must be available and/or configured. These resources include data and services, and the systems that offer them. This section will call out examples of these resources.

Resource	Owner	Description	Availability	Source System
name	Organization that owns/ manages resource	Short description of the resource	How often the resource is available	Name of system which provides resource

@@ Line 1: / Line 1: @@
-'''Point Of Contact:''' ''A Human''
+[[Category:HAI]]
+'''Point Of Contact:''' ''[[User:ndp | Nathan Potter]]''
 == Description ==
-<font size="-2" color="green">''Give a short descriptive name for the use case to serve as a unique identifier.''</font>
+The Administrator logs into the Hyrax Admin Interface.
 == Goal ==
-<font size="-2" color="green">''The goal briefly describes what the user intends to achieve with this use case.''</font>
+Provide a secure login and session for Administrators to operate the Hyrax Admin Interface.
 == Summary ==
-<font size="-2" color="green">''Give a summary of the use case to capture the essence of the use case (no longer than a page). It provides a quick overview and includes the goal and principal actor.''</font>
+The Administrator uses a web browser to access the URL for the Hyrax Admin Interface. When accessed the server returns a secure authentication challenge. Once the Administrator has provided correct authentication  credentials all subsequent interactions with the HAI are secure (encrypted) until the session times out or the Administrator logs off.
 == Actors ==
-<font size="-2" color="green">''List actors, people or things outside the system that either acts on the system (primary actors) or is acted on by the system (secondary actors). Primary actors are ones that invoke the use case and benefit from the result. Identify sensors, models, portals and relevant data resources. Identify the primary actor and briefly describe role.''</font>
+* Administrator
 == Preconditions ==
-<font size="-2" color="green">''Here we state any assumptions about the state of the system that must be met for the trigger (below) to initiate the use case. Any assumptions about other systems can also be stated here, for example, weather conditions. List all preconditions.''</font>
+The Administrator has access too, and authentication credentials for, a running Hyrax server.
 == Triggers ==
-<font size="-2" color="green">''Here we describe in detail the event or events that brings about the execution of this use case. Triggers can be external, temporal, or internal. They can be single events or when a set of conditions are met, List all triggers and relationships.''</font>
+One or more of:
+* Hyrax needs re configuration.
+* Hyrax needs to be restarted.
+* The Administrator needs/wants to view the Hyrax logs.
 == Basic Flow ==
-<font size="-2" color="green">''Often referred to as the primary scenario or course of events. In the basic flow we describe the flow that would be followed if the use case where to follow its main plot from start to end. Error states or alternate states that might be highlighted are not included here. This gives any browser of the document a quick view of how the system will work. Here the flow can be documented as a list, a conversation or as a story.(as much as required)''</font>
+# The Administrator points their browser at the URL for their HAI.
+# The HAI returns a secure page containing an authentication challenge.
+# The Administrator enters their authentication credentials.
+# The HAI Administrators credentials are recognized.
+# From this point on all pages sent from the HAI to the Administrator are secured through encryption (https??)
+# The HAI returns it's home page.
 == Alternate Flow ==
-<font size="-2" color="green">''Here we give any alternate flows that might occur. May include flows that involve error conditions. Or flows that fall outside of the basic flow.''</font>
+# The Administrator points their browser at the URL for their HAI.
+# The HAI returns a secure page containing an authentication challenge.
+# The Administrator enters their authentication credentials.
+# The HAI Administrators credentials are NOT recognized.
+# The HAI returns it's an authentication failure page.
 == Post Conditions ==
-<font size="-2" color="green">''Here we give any conditions that will be true of the state of the system after the use case has been completed.''</font>
+# The Administrator has an active session with the HAI which provides secure pages for controlling a Hyrax instance.
 == Activity Diagram ==