org.owasp.webgoat.lessons

Class LessonAdapter

java.lang.Object

org.owasp.webgoat.session.Screen

org.owasp.webgoat.lessons.AbstractLesson

org.owasp.webgoat.lessons.LessonAdapter

All Implemented Interfaces:

Comparable<Object>

Direct Known Subclasses:

MenuToLessonMapperScreen, ProductsAdminScreen, RandomLessonAdapter, RefreshDBScreen, ReportCardScreen, SequentialLessonAdapter, SummaryReportCardScreen, UserAdminScreen, ViewDatabase

public abstract class LessonAdapter
extends AbstractLesson

This file is part of WebGoat, an Open Web Application Security Project utility. For details, please see http://www.owasp.org/ Copyright (c) 2002 - 20014 Bruce Mayhew This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. Getting Source ============== Source for this application is maintained at https://github.com/WebGoat/WebGoat, a repository for free software projects.

Since:

October 28, 2003

Version:

$Id: $Id

Author:

Bruce Mayhew WebGoat

Field Summary

Fields inherited from class org.owasp.webgoat.lessons.AbstractLesson

ADMIN_ROLE, CHALLENGE_ROLE, HACKED_ADMIN_ROLE, USER_ROLE

Fields inherited from class org.owasp.webgoat.session.Screen

MAIN_SIZE

Constructor Summary

Constructors

Constructor and Description
LessonAdapter()

Method Summary

Modifier and Type	Method and Description
protected org.apache.ecs.Element	createContent(WebSession s) Description of the Method
String	getCurrentAction(WebSession s) getCurrentAction.
protected org.apache.ecs.Element	getCustomCredits(String text, org.apache.ecs.Element e) Gets the credits attribute of the AbstractLesson object
protected Category	getDefaultCategory() Gets the category attribute of the LessonAdapter object.
protected boolean	getDefaultHidden() getDefaultHidden.
protected Integer	getDefaultRanking() getDefaultRanking.
int	getHintCount(WebSession s) Gets the hintCount attribute of the Lesson object
protected List<String>	getHints(WebSession s) getHints.
String	getInstructions(WebSession s) Gets the instructions attribute of the AbstractLesson object
Object	getSessionAttribute(WebSession s, String key) getSessionAttribute.
String	getSubmitMethod() provide a default submitMethod of lesson does not implement
String	getTitle() Fill in a descriptive title for this lesson.
protected org.apache.ecs.Element	makeSuccess(WebSession s) Description of the Method
void	restartLesson() Initiates lesson restart functionality.
void	setCurrentAction(WebSession s, String lessonScreen) setCurrentAction.
void	setSessionAttribute(WebSession s, String key, Object value) setSessionAttribute.

Methods inherited from class org.owasp.webgoat.lessons.AbstractLesson

compareTo, equals, getAvailableLanguages, getCategory, getDefaultLanguage, getFileMethod, getFileText, getFormAction, getHidden, getHint, getHintsPublic, getHtml_DELETE_ME, getLabelManager, getLessonName, getLessonPlan, getLessonPlanFileName, getLessonSolutionFileName, getLink, getName, getPage, getPath, getRanking, getRawSource, getRole, getScreenId, getServletLink, getSolution, getSource, getSourceFileName, getTemplatePage, getUserId, getUserName, getWebgoatContext, handleRequest, isAuthorized, isAuthorized, isCompleted, isEnterprise, makeWindowScript, readFromFile, readFromURL, readMethodFromFile, setHidden, setLessonPlanFileName, setLessonSolutionFileName, setRanking, setSourceFileName, setWebgoatContext, toString, update

Methods inherited from class org.owasp.webgoat.session.Screen

convertMetachars, convertMetacharsJavaCode, createLessonTracker, createLessonTracker, getContent, getContentLength, getLessonTracker, getLessonTracker, getLessonTracker, getSponsor, getSponsorLogoResource, makeLogo, makeMessages, output, pad, setContent

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LessonAdapter

public LessonAdapter()

Method Detail

createContent

protected org.apache.ecs.Element createContent(WebSession s)

Description of the Method Description of the Method

Specified by:

createContent in class Screen

Parameters:

s - Description of the Parameter

Returns:

Description of the Return Value

getDefaultCategory

protected Category getDefaultCategory()

Gets the category attribute of the LessonAdapter object. The default category is "General" Only override this method if you wish to create a new category or if you wish this lesson to reside within a category other the "General"

Specified by:

getDefaultCategory in class AbstractLesson

Returns:

The category value

getDefaultHidden

protected boolean getDefaultHidden()

getDefaultHidden.

Specified by:

getDefaultHidden in class AbstractLesson

Returns:

a boolean.

restartLesson

public void restartLesson()

Initiates lesson restart functionality. Lessons should override this for lesson specific actions

Specified by:

restartLesson in class AbstractLesson

getDefaultRanking

protected Integer getDefaultRanking()

getDefaultRanking.

Specified by:

getDefaultRanking in class AbstractLesson

Returns:

a Integer object.

getHintCount

public int getHintCount(WebSession s)

Gets the hintCount attribute of the Lesson object Gets the hintCount attribute of the LessonAdapter object

Overrides:

getHintCount in class AbstractLesson

Parameters:

s - The user's WebSession

Returns:

The hintCount value

getHints

protected List<String> getHints(WebSession s)

getHints.

Fill in a minor hint that will help people who basically get it, but are stuck on somthing silly. Hints will be returned to the user in the order they appear below. The user must click on the "next hint" button before the hint will be displayed.

Specified by:

getHints in class AbstractLesson

Parameters:

s - a WebSession object.

Returns:

a List object.

getSubmitMethod

public String getSubmitMethod()

provide a default submitMethod of lesson does not implement

Specified by:

getSubmitMethod in class AbstractLesson

Returns:

a String object.

getInstructions

public String getInstructions(WebSession s)

Gets the instructions attribute of the AbstractLesson object Gets the instructions attribute of the LessonAdapter object. Instructions will rendered as html and will appear below the control area and above the actual lesson area. Instructions should provide the user with the general setup and goal of the lesson.

Specified by:

getInstructions in class AbstractLesson

Parameters:

s - a WebSession object.

Returns:

The instructions value

getTitle

public String getTitle()

Fill in a descriptive title for this lesson. The title of the lesson. This will appear above the control area at the top of the page. This field will be rendered as html.

Specified by:

getTitle in class AbstractLesson

Returns:

The title value

getCurrentAction

public String getCurrentAction(WebSession s)

getCurrentAction.

Specified by:

getCurrentAction in class AbstractLesson

Parameters:

s - a WebSession object.

Returns:

a String object.

setCurrentAction

public void setCurrentAction(WebSession s,
                             String lessonScreen)

setCurrentAction.

Specified by:

setCurrentAction in class AbstractLesson

Parameters:

s - a WebSession object.

lessonScreen - a String object.

getSessionAttribute

public Object getSessionAttribute(WebSession s,
                                  String key)

getSessionAttribute.

Parameters:

s - a WebSession object.

key - a String object.

Returns:

a Object object.

setSessionAttribute

public void setSessionAttribute(WebSession s,
                                String key,
                                Object value)

setSessionAttribute.

Parameters:

s - a WebSession object.

key - a String object.

value - a Object object.

makeSuccess

protected org.apache.ecs.Element makeSuccess(WebSession s)

Description of the Method

Parameters:

s - Description of the Parameter

Returns:

Description of the Return Value

getCustomCredits

protected org.apache.ecs.Element getCustomCredits(String text,
                                                  org.apache.ecs.Element e)

Gets the credits attribute of the AbstractLesson object

Parameters:

text - a String object.

e - a Element object.

Returns:

The credits value