architecture
WebApplicationDiagram Web Application

Gives an overview of the Web Application TeamWeb, in particular with the responsibilities each of the components (Servlets, JSPs and TagLibs) has.

displayName Team Web
ejbModuleName teamweb
shapeType WebApplicationDiagram
webWelcomeFileList login.jsp
JSP Summary
AccountManagement 
AddCommunity 
AddUserThis part of the page allows new users to join the system.
AddUserFailedCalled each time when a user tried to add a new user with a name that already existed.
AuthentificateA little form that allows the user to authentificate himself with his username and password.
AuthentificationFailedCalled each time when a user tried to log on with a wrong username - password combination.
Bookmarks 
BrowserTitle 
CategoryOverview 
CheckBrowser 
Communication 
Communicator 
Communities 
CommunitiesX 
Community 
CommunityOverview 
CommunitySelector 
ExceptionThis page is displayed to the user whenever an uncaught exception occured.
Feedback 
Footer 
GuestLogin 
Header 
HistoryThis is the frameset for the history window.
JoinSecretCommunity 
LoginThis page displays a dialog where the user can either authentificate himself with an existing username and its password or add a new User.
LoginDataResent 
Logoff 
Navigation 
NoFramesThis page is included in all pages defining framesets.
Note 
NoteEditor 
NoteOverview 
PageLoadingException 
PageStatistics 
PartySelectorThis is the top frame of History.
Privacy 
ResendLoginData 
ScopeSelector 
SessionOverviewThis is the center-left frame of the History window.
StartupThis is the very first page that is loaded by the system.
StatsScope 
StatusBar 
SystemStatsShows the current status of the system with all statistical data.
Tutorial-1 
Tutorial-2 
TWFieldTestPresentation 
UserProfile 
UserSelector 
UserSessionThis is the center-right frame of the History window.
WelcomeThis page is used by the UserManagementServlet when login has succeeded.
WindowThis is the actual TeamWeb-Browser, which is opened whenever a new browser window is opened and at startup.
 

Note Summary
Note1 
Note11 
Note12 
Note13 
Note15 
Note2 
Note3 
Note4 
Note5 
Note6 
Note7 
Note8 
Note9 
 

WebFiles Summary
ImagesContains all the images used in TeamWeb.
IncludesContains all the fragments that are included with JSPs.
 

Diagram Elements Detail

AccountManagement

backgroundColor 204,204,255
name AccountManagement
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/accountManagement.jsp

Hyperlinks

to JSP UserProfile


AddCommunity

name AddCommunity
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/communities/addCommunity.jsp

AddUser
This part of the page allows new users to join the system. This requires that privacy.html is included in the same page for the link to that file to work!

backgroundColor 204,255,204
name AddUser
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/userManagement/addUser.jsp

AddUserFailed
Called each time when a user tried to add a new user with a name that already existed.

backgroundColor 255,204,204
name AddUserFailed
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/userManagement/addUserFailed.jsp

Hyperlinks

to JSP AddUser

to JSP Authentificate


Authentificate
A little form that allows the user to authentificate himself with his username and password.

backgroundColor 204,255,204
name Authentificate
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/userManagement/authentificate.jsp

AuthentificationFailed
Called each time when a user tried to log on with a wrong username - password combination. After 3 times, no further attempts to login are allowed. Incrementing the counter is done by UserManagementSupport.

backgroundColor 255,204,204
name AuthentificationFailed
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/userManagement/authentificationFailed.jsp

Hyperlinks

to JSP Authentificate

to JSP AddUser


Bookmarks

name Bookmarks
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/history/bookmarks.jsp

BrowserTitle

name BrowserTitle
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/tracking/browserTitle.jsp

CategoryOverview

name CategoryOverview
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/history/categoryOverview.jsp

CheckBrowser

name CheckBrowser
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/checkBrowser.jsp

Hyperlinks

to JSP Login


Communication

backgroundColor 204,204,255
name Communication
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/communication/communication.jsp

Hyperlinks

to JSP StatusBar

to JSP ScopeSelector

to JSP Note

to JSP NoteOverview


Communicator

backgroundColor 204,204,255
name Communicator
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/communication/communicator.jsp

Hyperlinks

to JSP Communication


Communities

backgroundColor 204,204,255
name Communities
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/communities/communities.jsp

CommunitiesX

backgroundColor 204,204,255
name CommunitiesX
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/communities.jsp

Hyperlinks

to JSP Community


Community

backgroundColor 204,204,255
name Community
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/communities/community.jsp

Hyperlinks

to JSP UserProfile

to JSP NoteEditor


CommunityOverview

name CommunityOverview
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/communities/communitiesOverview.jsp

CommunitySelector

name CommunitySelector
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/history/communitySelector.jsp

Exception
This page is displayed to the user whenever an uncaught exception occured. It also is responsible for logging the exception and sending a message to the author of the system.

backgroundColor 255,0,0
name Exception
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/exception.jsp

Note Links

to Note Note3


Feedback

name Feedback
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/feedback.jsp

Footer

backgroundColor 204,255,204
name Footer
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/includes/footer.jsp

Note Links

to Note Note12


GuestLogin

backgroundColor 204,255,204
name GuestLogin
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/userManagement/guestLogin.jsp

Header

backgroundColor 204,255,204
name Header
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/includes/header.jsp

Note Links

to Note Note11


History
This is the frameset for the history window. It contains the FormPartySelector on the top frame, the Overview on the center-left frame and the selected UserSession on the center-right frame.

backgroundColor 204,204,255
name History
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/history/history.jsp

Hyperlinks

to JSP StatusBar

to JSP PartySelector

to JSP SessionOverview

to JSP UserSession

to JSP CategoryOverview

to JSP Bookmarks

Note Links

to Note Note4


JoinSecretCommunity

name JoinSecretCommunity
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/communities/joinSecretCommunity.jsp

Login
This page displays a dialog where the user can either authentificate himself with an existing username and its password or add a new User.

name Login
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/userManagement/login.jsp

Hyperlinks

to JSP Welcome

to JSP Authentificate

to JSP AddUser

to JSP AddUserFailed

to JSP AuthentificationFailed

to JSP GuestLogin

to JSP ResendLoginData


LoginDataResent

name LoginDataResent
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/userManagement/loginDataResent.jsp

Logoff

name Logoff
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/userManagement/logoff.jsp

Hyperlinks

to JSP Feedback


Navigation

name Navigation
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/tracking/navigation.jsp

Hyperlinks

to JSP AccountManagement

to JSP CommunitiesX

to JSP History

to JSP Logoff

to JSP Communication

to JSP Communicator


NoFrames
This page is included in all pages defining framesets.

backgroundColor 204,255,204
name NoFrames
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/includes/noFrames.jsp

Note

backgroundColor 255,255,255
name Note
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/communication/note.jsp

Hyperlinks

to JSP NoteEditor


NoteEditor

backgroundColor 204,204,255
name NoteEditor
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/communication/noteEditor.jsp

NoteOverview

backgroundColor 255,255,255
name NoteOverview
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/communication/noteOverview.jsp

PageLoadingException

backgroundColor 255,0,0
name PageLoadingException
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/tracking/pageLoadingException.jsp

PageStatistics

name PageStatistics
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/statistics/pageStatistics.jsp

PartySelector
This is the top frame of History. It contains two comboboxes. The left one is called community-selector and contains the user himself as first and default element, followed by a list of the communities the user is a member of. The right one is called person-selector and contains the all-entry as first and default element, followed by a list of the members of the currently selected community that allow watching their history (for that community).

name PartySelector
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/history/partySelector.jsp

Privacy

backgroundColor 204,204,255
name Privacy
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/tracking/privacy.jsp

ResendLoginData

backgroundColor 204,255,204
name ResendLoginData
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/userManagement/resendLoginData.jsp

Hyperlinks

to JSP LoginDataResent


ScopeSelector

name ScopeSelector
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/communication/scopeSelector.jsp

SessionOverview
This is the center-left frame of the History window. Depending on the selection of ParySelector, this shows the user sessions, in reverse order (latest session first). For the current user, this also shows the current session as first element and selects that current session per default.

name SessionOverview
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/history/sessionOverview.jsp

Startup
This is the very first page that is loaded by the system. It defines a frameset with login.jsp in the large content frame and statusBar.jsp in a small frame on the bottom of the page.
Please also note the naming conventions for frames, windows and other elements:


  • Windows: TWWindowName

    This convention has been chosen to assure that no naming conflicts
    can ever exist between TeamWeb windows and windows other documents
    define.


  • Frames: TWFrameName

    This convention has been chosen to assure that no naming conflicts
    can ever exist between TeamWeb frames and frames other documents
    define.


  • Forms: FormName

    This simply includes the object type in the name which makes
    reading JavaScript code easier.



Frames this JSP defines:



  • TWFrameLogin:
    This frame is used for the login procedure and displays the help system
    while the user is browsing with the system. It should be kept open during
    a complete session!

    Default JSP: /userManagement/login.jsp


  • TWFrameGlobalStatusBar:
    This frame is used to display global status messages, e.g. when windows
    are closed or opened.

    Default JSP: /statusBar.jsp



Parameters this JSP accepts:



  • referrer (UserManagementServlet.PAR_REFERRER)
    This optional parameter can be used to call startup with a specified referrer, e.g. when redirecting to another TeamWeb-Server or when no sessions were supported on the first call to this.
    The parameter is read by the tag openSession.

backgroundColor 204,204,255
name Startup
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/startup.jsp

Hyperlinks

to JSP StatusBar

to JSP CheckBrowser


StatsScope

name StatsScope
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/statistics/statsScope.jsp

StatusBar

name StatusBar
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/statusBar.jsp

Hyperlinks

to JSP Privacy


SystemStats
Shows the current status of the system with all statistical data.

backgroundColor 255,255,0
name SystemStats
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/statistics/systemStats.jsp

Tutorial-1

backgroundColor 255,255,0
name Tutorial-1
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/manual/tutorial-1.jsp

Tutorial-2

backgroundColor 255,255,0
name Tutorial-2
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/manual/tutorial-2.jsp

TWFieldTestPresentation

backgroundColor 255,255,0
name TWFieldTestPresentation
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/manual/twFieldTestPresentation.jsp

UserProfile

backgroundColor 204,204,255
name UserProfile
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/userManagement/userProfile.jsp

Hyperlinks

to JSP NoteEditor


UserSelector

name UserSelector
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/history/userSelector.jsp

UserSession
This is the center-right frame of the History window. It displays the user session that has been selected in Overview. Each entry of the session is displayed with its time, URL and title of the page. The entries are listed in reverse order (latest element first).

name UserSession
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/history/userSession.jsp

Welcome
This page is used by the UserManagementServlet when login has succeeded. It allows the user to log off and opens the TeamWeb browser window.

name Welcome
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/userManagement/welcome.jsp

Hyperlinks

to JSP Logoff

to JSP Window

to JSP Feedback


Window
This is the actual TeamWeb-Browser, which is opened whenever a new browser window is opened and at startup.


Frames this JSP defines:



  • TWFrameTitle:
    This frame is used for displaying the title of the page that is being
    displayed.

    Default JSP: /tracking/browserTitle.jsp


  • TWFrameStatsScope:
    This frame is used to chose the scope for the statistics, which is either the user himself, one of the communities he is a member of, or all TeamWeb-users.

    Default JSP: /statistics/statsScope.jsp


  • TWFrameNavigation:
    This frame provides most of the UI elements of TeamWeb, e.g. for accessing pages by their URL, opening the windows for communities, account-management, bookmarks, history etc., reading own messages, setting bookmarks etc..

    Default JSP: /tracking/navigation.jsp


  • TWFrameContent:
    The frame which is used to display the content that is currently browsed.

    Default JSP: none


  • TWFrameStatistics:
    A frame which displays statistics about the currently viewed web page.

    Default JSP: /blank.html


  • TWFrameStatusBar:
    The status bar which is used to display status information.

    Default JSP: /statusBar.jsp



Parameters this JSP accepts:



  • xxx (UserManagementServlet.PAR_XXX)
    Description.

backgroundColor 204,204,255
name Window
shapeType JSP
jspsource $PROJECT_DIR$/app/teamweb/tracking/window.jsp

Hyperlinks

to JSP BrowserTitle

to JSP Navigation

to JSP StatsScope

to JSP StatusBar

to JSP PageStatistics

to JSP PageLoadingException


Note1

backgroundColor 255,255,204
text Servlets are used to implement
the control/logic of the system.

Note11

backgroundColor 255,255,204
text Contains a reference to the CSS
for TeamWeb. Can be customized
so that users can configure their
look and feel with "skins".

Note12

backgroundColor 255,255,204
text Contains a link so that users can
send me eMail and the CSS and
XHTML validation gifs and links.

Note13

backgroundColor 255,255,204
text Tag Libraries are used to make
the application more modular
and avoid too much Java code
in the JSPs.

Note15

backgroundColor 204,204,255
text Pages that are opened in own
and/or new windows are
marked with light blue.

Note2

backgroundColor 255,255,204
text JSPs with Taglibs are used
to implement the view/GUI
of the system.

Note3

backgroundColor 255,255,204
text This page is shown whenever an
uncaught exception occured (that is:
a bug must be fixed).

Note4

backgroundColor 255,255,204
text Depending on the parameters of
History, either the Bookmarks or
the History is shown.

Note5

backgroundColor 255,255,204
text Contains static and dynamic fragments
like the page footer, privacy notes etc.
that are not specific to a particular
section of the system.

Note6

backgroundColor 255,255,204
text Contains all graphical resources
like buttons, banners etc.

Note7

backgroundColor 204,255,204
text Fragment JSPs or HTML pages
that are used by other JSPs to
build a complete page are
marked green.

Note8

backgroundColor 255,204,204
text Application exception/error
message pages are marked
with light red.

Note9

backgroundColor 255,255,0
text JSPs that do not directly
belong to the system.

Images
Contains all the images used in TeamWeb.

name Images
shapeType WebFiles
jspsource $PROJECT_DIR$/app/teamweb/images/

Note Links

to Note Note6


Includes
Contains all the fragments that are included with JSPs. In particular, a standard header with the CSS and footer that is displayed below each page.

backgroundColor 204,255,204
name Includes
shapeType WebFiles
jspsource $PROJECT_DIR$/app/teamweb/includes/

Note Links

to Note Note5



©2001-2002, Holger (David) Wagner