Screen (webgoat-container 7.1 API)

java.lang.Object
- org.owasp.webgoat.session.Screen

Direct Known Subclasses:

AbstractLesson, AdminScreen, ErrorScreen, WelcomeScreen
```
public abstract class Screen
extends Object
```
************************************************************************************************* 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:

Jeff Williams Aspect Security

Field Summary

Fields
Modifier and Type Field and Description

static int MAIN_SIZE
Description of the Field

Fields
Modifier and Type	Field and Description
`static int`	`MAIN_SIZE` Description of the Field

Constructor Summary

Constructors
Constructor and Description

Screen()
Constructor for the Screen object

Constructors
Constructor and Description
`Screen()` Constructor for the Screen object

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected static String`	`convertMetachars(String token)` Description of the Method
`protected static String`	`convertMetacharsJavaCode(String token)` Description of the Method
`protected abstract org.apache.ecs.Element`	`createContent(WebSession s)` Description of the Method
`LessonTracker`	`createLessonTracker()` This allows the screens to provide a custom LessonTracker object if needed.
`LessonTracker`	`createLessonTracker(Properties props)` Creates a new lessonTracker object.
`String`	`getContent()` Getter for the field `content`.
`int`	`getContentLength()` Returns the content length of the the html.
`LessonTracker`	`getLessonTracker(WebSession s)` Gets the lessonTracker attribute of the AbstractLesson object
`LessonTracker`	`getLessonTracker(WebSession s, AbstractLesson lesson)` getLessonTracker.
`LessonTracker`	`getLessonTracker(WebSession s, String userNameOverride)` getLessonTracker.
`abstract String`	`getRole()` getRole.
`String`	`getSponsor()` getSponsor.
`String`	`getSponsorLogoResource()` getSponsorLogoResource.
`abstract String`	`getTitle()` Fill in a descriptive title for this lesson
`protected org.apache.ecs.Element`	`makeLogo()` Description of the Method
`protected org.apache.ecs.Element`	`makeMessages(WebSession s)` Description of the Method
`void`	`output(PrintWriter out)` Description of the Method
`protected static String`	`pad(int x)` Description of the Method
`protected void`	`setContent(org.apache.ecs.Element content)` Setter for the field `content`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MAIN_SIZE
```
public static int MAIN_SIZE
```
    Description of the Field
- Constructor Detail
  - Screen
```
public Screen()
```
    Constructor for the Screen object
- Method Detail
  - getRole
```
public abstract String getRole()
```
    getRole.
    
    Returns:
    
    a String object.
  - createContent
```
protected abstract org.apache.ecs.Element createContent(WebSession s)
```
    Description of the Method
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - createLessonTracker
```
public LessonTracker createLessonTracker(Properties props)
```
    Creates a new lessonTracker object.
    
    Parameters:
    
    props - The properties file that was used to persist the user data.
    
    Returns:
    
    Description of the Return Value
  - createLessonTracker
```
public LessonTracker createLessonTracker()
```
    This allows the screens to provide a custom LessonTracker object if needed.
    
    Returns:
    
    Description of the Return Value
  - getLessonTracker
```
public LessonTracker getLessonTracker(WebSession s)
```
    Gets the lessonTracker attribute of the AbstractLesson object
    
    Parameters:
    
    s - a WebSession object.
    
    Returns:
    
    The lessonTracker value
  - getLessonTracker
```
public LessonTracker getLessonTracker(WebSession s,
                                      String userNameOverride)
```
    getLessonTracker.
    
    Parameters:
    
    s - a WebSession object.
    
    userNameOverride - a String object.
    
    Returns:
    
    a LessonTracker object.
  - getLessonTracker
```
public LessonTracker getLessonTracker(WebSession s,
                                      AbstractLesson lesson)
```
    getLessonTracker.
    
    Parameters:
    
    s - a WebSession object.
    
    lesson - a AbstractLesson object.
    
    Returns:
    
    a LessonTracker object.
  - getTitle
```
public abstract String getTitle()
```
    Fill in a descriptive title for this lesson
    
    Returns:
    
    The title value
  - setContent
```
protected void setContent(org.apache.ecs.Element content)
```
    Setter for the field content.
    
    Parameters:
    
    content - a Element object.
  - makeLogo
```
protected org.apache.ecs.Element makeLogo()
```
    Description of the Method
    
    Returns:
    
    Description of the Return Value
  - getSponsor
```
public String getSponsor()
```
    getSponsor.
    
    Returns:
    
    a String object.
  - getSponsorLogoResource
```
public String getSponsorLogoResource()
```
    getSponsorLogoResource.
    
    Returns:
    
    a String object.
  - makeMessages
```
protected org.apache.ecs.Element makeMessages(WebSession s)
```
    Description of the Method
    
    Parameters:
    
    s - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - getContentLength
```
public int getContentLength()
```
    Returns the content length of the the html.
    
    Returns:
    
    a int.
  - output
```
public void output(PrintWriter out)
```
    Description of the Method
    
    Parameters:
    
    out - Description of the Parameter
  - getContent
```
public String getContent()
```
    Getter for the field content.
    
    Returns:
    
    a String object.
  - pad
```
protected static String pad(int x)
```
    Description of the Method
    
    Parameters:
    
    x - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - convertMetachars
```
protected static String convertMetachars(String token)
```
    Description of the Method
    
    Parameters:
    
    token - Description of the Parameter
    
    Returns:
    
    Description of the Return Value
  - convertMetacharsJavaCode
```
protected static String convertMetacharsJavaCode(String token)
```
    Description of the Method
    
    Parameters:
    
    token - Description of the Parameter
    
    Returns:
    
    Description of the Return Value

Class Screen

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAIN_SIZE

Constructor Detail

Screen

Method Detail

getRole

createContent

createLessonTracker

createLessonTracker

getLessonTracker

getLessonTracker

getLessonTracker

getTitle

setContent

makeLogo

getSponsor

getSponsorLogoResource

makeMessages

getContentLength

output

getContent

pad

convertMetachars

convertMetacharsJavaCode