|
DJDoc v.1.0.0b-1 | ||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||
Action interface encapsulate the
business logic performed during an HTTP request in the operation of the
DJDoc web application.ActionServlet is the controller servlet of the DJDoc web
application.HitList.
HitList by adding the members of the specified collection
individually.
ApiEntity; adds a package to that set.
BunchEntity; adds an Item to that set.
Api interface represent Java APIs documented
with the Javadoc tool.ApiEntity is a persistence capable (via Hibernate) class.ApiEntity objects.
Apis class is a utility class used for registering and
deregistering APIs for the DJDoc web application.ApiVO is a concrete implementation of the
Api interface.ApiEntity
class.
UserStrategy.authenticate(HttpServletRequest, HttpServletResponse)
method retrieves the current user name from the user Principal
and looks up the corresponding User object in the database.
UserStrategy.authenticate(HttpServletRequest, HttpServletResponse)
method always returns an (existing or new) User with the name
1.
UserStrategy.authenticate(HttpServletRequest, HttpServletResponse)
method always returns an (existing or new) User with the name
specified by the timestamp at which the user accessed the system for the
first time.
BitAndTag is a custom JSP tag class which implements
support for the bitwise and-operation that is unfortunately not part of the
EL functionality.Bunch interface represent packages of Java
APIs documented with the Javadoc tool.BunchEntity is a persistence capable (via Hibernate) class.BunchHitEntity is a persistence capable (via Hibernate)
class.BunchList class represents a user-specific list of all
available packages of an API, together with information about the most
recently and most often accessed packages.BunchListAction class combines three functionalities:
Its main purpose is to store the last accessed API in the user session
(which causes the list of packages of that API to be cached in the session).BunchVO is a concrete implementation of the
Bunch interface.BunchEntity
class.
BusinessObject interface are
persistence capable classes.HitList.
BunchVOs.
ItemVOs.
Configuration is a utility class used for initially
loading all data of an API into the database.UserStrategy class assumes that the
servlet container has already authenticated the user and has stored the
user's data in a Principal object available to the request.BusinessObject from the database.
HttpServletRequest and enhancing
it with information about the request type as well as the names of the
requested API, package and/or file.${placeholder-name}) by specified values.
${placeholder-name}) by values specified
as System properties.
Comparator for sorting Hittable objects by
the total number they have been hit so far (in descending order).
FileAction is an implementation of the Action
interface which simply copies the content of a file into the response.BunchEntity from the
database by the API it is part of and by its name.
ItemEntity object from the
database by the BunchEntity it belongs to and its item name.
BunchHitEntity from
the database by the package and the user it references.
ItemHitEntity from
the database by the item and the user it references.
ApiEntity from the
database by its name.
Bunch object among this
BunchList's packages.
Hittable object among this
HittableList's members.
Item object among this
ItemList's class items.
Action instance of this
RequestType.
BunchList.
Hittable objects of this
HittableList.
ItemList.
SessionInfo.
Items
in the (last accessed) package of this SessionInfo.
Api from the API cache.
BunchEntity's Api.
Api object last used by the HTTP session
associated with this SessionInfo.
Api objects from the
API cache, sorted by their names.
Bunch this BunchHitEntity
references.
ItemEntity's package object.
Bunch (package) object last used by the
HTTP session associated with this SessionInfo.
ApiEntity
object.
BunchHitEntity objects of this
BunchEntity.
Api's description.
ApiVO's description.
BunchList.
Hittable objects of this HittableList.
ItemList.
SessionInfo.
Items
in the (last accessed) package of this SessionInfo.
BunchHitEntity's hit count.
BunchVO's hit count.
Hittable object's hit count.
ItemHitEntity's hit count.
ItemVO's hit count.
BunchHitEntity's hit date.
BunchVO's hit date.
Hittable object's hit date.
ItemHitEntity's hit date.
ItemVO's hit date.
ApiEntity's internal ID.
BunchEntity's internal ID.
BunchHitEntity's internal ID.
BusinessObject's internal ID.
ItemEntity's internal ID.
ItemHitEntity's internal ID.
UserEntity's internal ID.
Item this ItemHitEntity
references.
ItemHitEntity objects of this
ItemEntity.
BunchEntity
object.
ItemType on the
package-frame page.
Logger with a name equal to the
class from which this method is invoked.
Api's name.
ApiVO's name.
Bunch's name.
BunchVO's name.
Item's name.
ItemVO's name.
User's name.
UserVO's name.
Hittable objects of this HittableList belong.
UserEntity's password.
Api's path.
ApiVO's path.
BunchList.
Hittable objects of this HittableList.
ItemList.
SessionInfo.
Items in the (last accessed) package of this
SessionInfo.
RequestType.
SessionInfo's server info (web
application base URL) string.
SessionInfo object.
UserStrategy
class.
Api's stylesheet name.
ApiVO's stylesheet name.
Api's title.
ApiVO's title.
Item's item type.
ItemVO's item type.
ItemEntity's item type ID.
User this BunchHitEntity
references.
User this ItemHitEntity
references.
SessionInfo's User object.
User's view preferences.
UserVO's view preferences.
BunchList's API
has any previously accessed packages or not.
HittableList's
parent has any previously accessed members or not.
ItemList's
package has any previously accessed class items or not.
HibernateUtils class is a utility class used for managing
the configuration and usage of the Hibernate framework.BunchVO as hit.
Hittable object as hit.
ItemVO as hit.
Bunch object among this
BunchList's packages as currently accessed.
Hittable object among this
HittableList's members as currently accessed.
Item object among this
ItemList's class items as currently accessed.
HitList class is an implementation of the SortedSet
interface with a maximum size; attempts to add elements beyond that size
will result cause the last elements (with respect to the Set's
Comparator to be dropped from the set.Hittable interface is associated with objects that may be
hit, i.e. that have clickable hyperlinks on some HTML page.HittableList interface are aggregations of
Hittable objects, i.e. objects that can be "hit" or marked as
accessed.Item interface represent "types" of Java
APIs (i.e. interfaces, classes, exceptions, errors, enums, annotation types)
documented with the Javadoc tool.ItemType enum enumerates the different types of
Items.ItemEntity is a persistence capable (via Hibernate) class.ItemHitEntity is a persistence capable (via Hibernate)
class.ItemList class represents a user-specific list of all
available class items (i.e. classes, interfaces, enums etc.) of a package,
together with information about the most recently and most often accessed
items.ItemListAction class combines three functionalities:
Its main purpose is to store the last accessed API and the last accessed
package in the user session (which causes the list of classes and interfaces
of that package to be cached in the session).ItemVO is a concrete implementation of the
Item interface.ItemEntity
class.
Logging class is a utility class wrapping the access to the
Apache Log4J logging library.Comparator for sorting Hittable objects by
their respective natural order.
action package contains the Action interface
as well as several concret implementations representing all possible types of
requests.app package contains classes important for the DJDoc
web application operation.bo package contains the classes related to the DJDoc web
application's business object, i.e. the objects that are made persistent via
the Hibernate framework.servlet package contains classes related to the processing
of the HTTP servlet request and response cycles.util package contains classes that define data structures
and utility classes responsible for manipulating objects.Apis.
File object for it.
Comparator for sorting Hittable objects by
the time they have been hit for the last time (in descending order).
SimpleUserStrategy class; it
extracts a username string from a browser cookie sent in the request.
SameUserStrategy class is the most basic implementation
of the UserStrategy class.BusinessObject (which may be either
new or already existing) in the database.
ApiEntity objects from the
database.
BunchHitEntity objects with
a given ApiEntity and UserEntity from the
database.
ItemHitEntity objects with
a given BunchEntity and UserEntity from the
database.
Action.perform(DjdocRequest) method and
handles the communication from the server back to the client.
FileAction.perform(DjdocRequest) into the HTTP response output stream.
Action of the respective Item.ItemType.
RequestType and the
Action from the wrapped HTTP request,
executes it and stores the result object in the wrapped request.
SessionInfo class are container objects
storing session-wide data such as information about the server (in particular,
the logical name of the web application), the session's User object,
references to the last accessed Api and Bunch objects and
cached lists of the packages and class items last accessed by the user.BunchEntity's Api.
SessionInfo.
Bunch this BunchHitEntity
references.
ItemEntity's package object.
ApiEntity
object.
BunchHitEntity objects of this
BunchEntity.
SessionInfo.
ApiVO's description.
BunchHitEntity's hit count.
BunchVO's hit count.
Hittable object's hit count.
ItemHitEntity's hit count.
ItemVO's hit count.
BunchHitEntity's hit date.
BunchVO's hit date.
Hittable object's hit date.
ItemHitEntity's hit date.
ItemVO's hit date.
ApiEntity's internal ID.
BunchEntity's internal ID.
BunchHitEntity's internal ID.
ItemEntity's internal ID.
ItemHitEntity's internal ID.
UserEntity's internal ID.
Item this ItemHitEntity
references.
ItemHitEntity objects of this
ItemEntity.
BunchEntity
object.
ApiVO's name.
BunchVO's name.
ItemVO's name.
User's name.
UserVO's name.
UserEntity's password.
ApiVO's path.
SessionInfo object.
ApiVO's stylesheet name.
ApiVO's title.
ItemEntity's item type.
ItemVO's item type.
ItemEntity's item type ID.
UserStrategy via reflection.
User this BunchHitEntity
references.
User this ItemHitEntity
references.
User's view preferences.
UserVO's view preferences.
SimpleUserStrategy class is an implementation of the
UserStrategy class which - like the SameUserStrategy class -
does not interact with the container for authentication; every user accessing
the system for the first time will be given a unique name (actually the
current timestamp with millisecond precision) which is stored in a cookie.StartupServlet class serves purely as an initialization
class reading configuration files and setting up other parts of the web
application such as logging, persistence engine etc.StringUtils class is a utility class with various String
manipulation methods.SessionInfo's User object between "collapsed"
and "expanded".
User interface represent users of the
DJDoc web application.UserEntity is a persistence capable (via Hibernate) class.UserVO is a concrete implementation of the
User interface.UserEntity
class.
XmlUtils is a utility class used for manipulation of XML
files and/or structured data.
|
DJDoc v.1.0.0b-1 | ||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||