Java Server Page (JSP) Files (Sun OpenSSO Enterprise 8.0 Developer's Guide)

Sun OpenSSO Enterprise 8.0 Developer's Guide

Java Server Page (JSP) Files

The authentication GUI pages are .jsp files with embedded JATO tags. You do not need to understand JATO to customize the GUI pages. Java server pages handle both the UI elements and the disciplines displayed through peer ViewBeans.

By default, JSP pages are installed and looked up in the following directory:

OpenSSO-Deploy-base/config/auth/default

Customizing the Login Page

The login page is a common page used by most authentication modules except for the Membership module. For all other modules, at run time the login page dynamically displays all necessary GUI elements for the user to enter the required credentials. For example, the LDAP authentication module login page dynamically displays the LDAP module header, LDAP user name, and password fields.

To access the default login page, use the following URL:

server-protocol://server-host.server-domain:server-port/service-deploy-uri/UI/Login

To access the default logout page, use the following URL:

server-protocol://server-host.server-domain:server-port/service-deploy-uri/UI/Logout

You can customize the following login page UI elements:

Module Header text
User Name label and field
Password label and field
Choice value label and field.

The field is a radio button by default, but can be change to a check box.
Image (at the module level)
Login button

Customizing JSP Templates

Use the JSP templates to customize the look and feel presented in the graphical user interface (GUI). Customizing JSP Templates provides descriptions of templates you can customize. The templates are located in the following directory:

OpenSSO-Deploy-base/config/auth/default

Table 13–2 Customizable JSP Templates


File Name	Purpose
`account_expired.jsp`	Informs the user that their account has expired and should contact the system administrator.
`auth_error_template.jsp`	Informs the user when an internal authentication error has occurred. This JSP usually indicates an authentication service configuration issue.
`authException.jsp`	Informs the user that an error has occurred during authentication.
`configuration.jsp`	Configuration error page that displays during the Self-Registration process.
`disclaimer.jsp`	Customizable disclaimer page used in the self-registration authentication module.
`Exception.jsp`	Informs the user that an error has occurred.
`invalidAuthlevel.jsp`	Informs the user that the authentication level invoked was invalid.
`invalid_domain.jsp`	Informs the user that no such domain exists.
`invalidPassword.jsp`	Informs the user that the password entered does not contain enough characters.
`invalidPCookieUserid.jsp`	Informs the user that a persistent cookie user name does not exist in the persistent cookie domain.
`Login.jsp`	This is a login and password template.
`login_denied.jsp`	Informs the user that no profile has been found in this domain.
`login_failed_template.jsp`	Informs the user that authentication has failed.
`Logout.jsp`	Informs the user that they have logged out.
`maxSessions.jsp`	Informs the user that the maximum sessions have been reached.
`membership.jsp`	A login page for the self-registration module.
`Message.jsp`	A generic message template for a general error not defined in one of the other error message pages.
`missingReqField.jsp`	Informs the user that a required field has not been completed.
`module_denied.jsp`	Informs the user that the user does not have access to the module.
`module_template.jsp`	Customizable module page.
`new_org.jsp`	Displayed when a user with a valid session in one organization wants to login to another organization.
`noConfig.jsp`	Informs the user that no module configuration has been defined.
`noConfirmation.jsp`	Informs the user that the password confirmation field has not been entered.
`noPassword.jsp`	Informs the user that no password has been entered.
`noUserName.jsp`	Informs the user that no user name has been entered. It links back to the login page.
`noUserProfile.jsp`	Informs the user that no profile has been found. It gives them the option to try again or select New User and links back to the login page.
`org_inactive.jsp`	Informs the user that the organization they are attempting to authenticate to is no longer active.
`passwordMismatch.jsp`	Called when the password and confirming password do not match.
`profileException.jsp`	Informs the user that an error has occurred while storing the user profile.
`Redirect.jsp`	Includes a link to a page that has been moved.
`register.jsp`	User self-registration page.
`session_timeout.jsp`	Informs the user that their current login session has timed out.
`userDenied.jsp`	Informs the user that they do not possess the necessary role (for role-based authentication.)
`userExists.jsp`	Called if a new user is registering with a user name that already exists.
`user_inactive.jsp`	Informs the user that they are not active.
`userPasswordSame.jsp`	Called if a new user is registering with a user name field and password field have the same value.
`wrongPassword.jsp`	Informs the user that the password entered is invalid.