A B C D E F G H I J L M N O P R S T U V X

A

AbstractPageManager - class org.jpublish.page.AbstractPageManager.
An abstract implementation of the PageManager interface which provides behavior common to all PageManager implementations.
AbstractPageManager() - Constructor for class org.jpublish.page.AbstractPageManager
 
AbstractRepository - class org.jpublish.repository.AbstractRepository.
The AbstractRepository base class can be used as a superclass for repository implementations.
AbstractRepository() - Constructor for class org.jpublish.repository.AbstractRepository
 
Action - interface org.jpublish.action.Action.
The Action interface represents a single programmatic action.
ActionManager - class org.jpublish.action.ActionManager.
 
ActionManager(SiteContext) - Constructor for class org.jpublish.action.ActionManager
 
addAction(String, Action) - Method in class org.jpublish.action.ActionManager
 

B

build(String, String, int) - Method in class org.jpublish.util.URLUtilities
Build a URL using the given path, protocol and port.
buildSecure(String) - Method in class org.jpublish.util.URLUtilities
Build an HTTPS (Secure Socket Layer) method relative to the application context using the given path.
buildSecure(String, int) - Method in class org.jpublish.util.URLUtilities
Build an HTTPS (Secure Socket Layer) method relative to the application context using the given path.
buildStandard(String) - Method in class org.jpublish.util.URLUtilities
Build an HTTP URL relative to the application context using the given path.
buildStandard(String, int) - Method in class org.jpublish.util.URLUtilities
Build an HTTP URL relative to the application context using the given path.

C

Configurable - interface org.jpublish.Configurable.
Classes which implement this interface can be configured from a JDOM Element.
Content - interface org.jpublish.Content.
 

D

DBRepository - class org.jpublish.repository.db.DBRepository.
 
DBRepository() - Constructor for class org.jpublish.repository.db.DBRepository
 
DEFAULT_MIME_TYPE - Static variable in class org.jpublish.util.MimeTypeMap
The default mime type if none is set.
disableCheckReservedNames(Object) - Method in class org.jpublish.JPublishContext
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.jpublish.servlet.JPublishServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.jpublish.servlet.JPublishServlet
 

E

EJB - class org.jpublish.EJB.
A wrapper for an EJB (specifically the Home interface).
EJB(String, String) - Constructor for class org.jpublish.EJB
Construct an EJB object
enableCheckReservedNames(Object) - Method in class org.jpublish.JPublishContext
Enable the reserved name check so that external code cannot overwrite JPublish defined variables.
encode(String) - Method in class org.jpublish.util.URLUtilities
Percent-encode the given String.
execute(String, VelocityContext) - Method in class org.jpublish.action.ActionManager
 
execute(VelocityContext) - Method in class org.jpublish.action.PathAction
Execute the script.
execute(VelocityContext) - Method in interface org.jpublish.action.Action
Execute the action using the given context.
execute(VelocityContext) - Method in class org.jpublish.action.ScriptAction
Execute the action script represented by this ScriptAction.
execute(VelocityContext) - Method in class org.jpublish.example.action.TestPathAction
 
execute(VelocityContext) - Method in class org.jpublish.example.action.GlobalAction
 
execute(VelocityContext) - Method in class org.jpublish.example.action.GenerateFortuneCookieAction
 
executeActions(VelocityContext) - Method in class org.jpublish.Page
Execute the page actions using the given VelocityContext.
executeGlobalActions(VelocityContext) - Method in class org.jpublish.action.ActionManager
 
executePathActions(String, VelocityContext) - Method in class org.jpublish.action.ActionManager
 
executeStartupActions() - Method in class org.jpublish.action.ActionManager
 
ExtendedFileSystemRepository - class org.jpublish.repository.filesystem.ExtendedFileSystemRepository.
The ExtendedFileSystemRepository allows actions to be bound to content elements through XML configuration files.
ExtendedFileSystemRepository() - Constructor for class org.jpublish.repository.filesystem.ExtendedFileSystemRepository
 

F

FileSystemPageManager - class org.jpublish.page.filesystem.FileSystemPageManager.
The PageManager is a central access point for locating pages.
FileSystemPageManager() - Constructor for class org.jpublish.page.filesystem.FileSystemPageManager
Construct a new PageManager using the given SiteContext.
FileSystemRepository - class org.jpublish.repository.filesystem.FileSystemRepository.
An implementation of the Repository interface which pulls content from the local file system.
FileSystemRepository() - Constructor for class org.jpublish.repository.filesystem.FileSystemRepository
 
findAction(String) - Method in class org.jpublish.action.ActionManager
Find an action with the given name.

G

GenerateFortuneCookieAction - class org.jpublish.example.action.GenerateFortuneCookieAction.
 
GenerateFortuneCookieAction() - Constructor for class org.jpublish.example.action.GenerateFortuneCookieAction
 
get(String) - Method in class org.jpublish.RepositoryWrapper
Get the content at the given path.
get(String) - Method in interface org.jpublish.Repository
Get the content from the given path.
get(String) - Method in class org.jpublish.repository.db.DBRepository
Get the content from the given path.
get(String) - Method in class org.jpublish.repository.filesystem.FileSystemRepository
Get the content from the given path.
get(String) - Method in class org.jpublish.repository.filesystem.ExtendedFileSystemRepository
 
get(String, boolean) - Method in class org.jpublish.RepositoryWrapper
Get the content at the given path, optinally merging it with the associated VelocityContext.
get(String, VelocityContext) - Method in interface org.jpublish.Repository
Get the content from the given path and merge it with the given context.
get(String, VelocityContext) - Method in class org.jpublish.repository.db.DBRepository
Get the content from the given path and merge it with the given context.
get(String, VelocityContext) - Method in class org.jpublish.repository.filesystem.FileSystemRepository
Get the content from the given path and merge it with the given context.
get(String, VelocityContext) - Method in class org.jpublish.repository.filesystem.ExtendedFileSystemRepository
 
getActionIdentifier() - Method in class org.jpublish.SiteContext
Get the action identifier which is used to trigger parameter actions.
getActionManager() - Method in class org.jpublish.SiteContext
Get the site's ActionManager.
getActionRoot() - Method in class org.jpublish.SiteContext
Get the directory where action scripts are stored.
getAttribute(String) - Method in class org.jpublish.servlet.HttpSessionWrap
 
getAttributeNames() - Method in class org.jpublish.servlet.HttpSessionWrap
 
getCreationTime() - Method in class org.jpublish.servlet.HttpSessionWrap
Get the creation time of the session.
getDefaultMimeType() - Method in class org.jpublish.SiteContext
Get the default mime type.
getDefaultMimeType() - Method in class org.jpublish.util.MimeTypeMap
Get the default mime type.
getDefaultPage() - Method in class org.jpublish.SiteContext
Get the default page.
getDefaultTemplate() - Method in class org.jpublish.SiteContext
Get the default template.
getDefinedActions() - Method in class org.jpublish.action.ActionManager
 
getEJBs() - Method in class org.jpublish.SiteContext
Get a Map of EJBHome interfaces.
getEJBs() - Method in class org.jpublish.Page
Get a Map of EJBHome interfaces.
getExposedEJBs() - Method in class org.jpublish.SiteContext
Get a Map of EJB Session beans which are exposed on the page directly.
getExposedEJBs() - Method in class org.jpublish.Page
Get a Map of EJB Session beans which are exposed on the page directly.
getFirstName() - Method in class org.jpublish.example.User
 
getFormManager() - Method in class org.jpublish.SiteContext
Get the site's FormManager.
getFullTemplateName() - Method in class org.jpublish.Page
Get the full template file name, with the .suffix attached.
getGlobalActions() - Method in class org.jpublish.action.ActionManager
 
getHome() - Method in class org.jpublish.EJB
Get the EJB home interface.
getId() - Method in class org.jpublish.servlet.HttpSessionWrap
Get the session ID
getLastAccessedTime() - Method in class org.jpublish.servlet.HttpSessionWrap
 
getLastModified() - Method in class org.jpublish.page.PageCacheEntry
Get the last modification time.
getLastModified(String) - Method in interface org.jpublish.Repository
Get the last modified time in milliseconds for the given path.
getLastModified(String) - Method in class org.jpublish.repository.db.DBRepository
Get the last modified time in milliseconds for the given path.
getLastModified(String) - Method in class org.jpublish.repository.filesystem.FileSystemRepository
Get the last modified time in milliseconds for the given path.
getLastModified(String) - Method in class org.jpublish.repository.filesystem.ExtendedFileSystemRepository
 
getLastName() - Method in class org.jpublish.example.User
 
getMaxInactiveInterval() - Method in class org.jpublish.servlet.HttpSessionWrap
 
getMimeType(String) - Method in class org.jpublish.util.MimeTypeMap
Get the mime type for the given file extension.
getMimeTypeMap() - Method in class org.jpublish.SiteContext
Get the site's MimeType map.
getName() - Method in class org.jpublish.ReservedNameException
Get the reserved name.
getName() - Method in interface org.jpublish.Repository
Get the name of the repository.
getName() - Method in class org.jpublish.repository.db.DBRepository
Get the name of the repository.
getName() - Method in class org.jpublish.repository.filesystem.FileSystemRepository
Get the name of the repository.
getName() - Method in class org.jpublish.repository.filesystem.ExtendedFileSystemRepository
 
getPage() - Method in class org.jpublish.page.PageCacheEntry
Get the page for this cache entry.
getPage(String) - Method in interface org.jpublish.PageManager
Get a Page instance from the given path.
getPage(String) - Method in class org.jpublish.page.filesystem.FileSystemPageManager
Get a Page instance from the given path.
getPageActions() - Method in class org.jpublish.Page
Get a List of page actions.
getPageManager() - Method in class org.jpublish.SiteContext
Get the site's PageManager.
getPageName() - Method in class org.jpublish.Page
Get the page name.
getPageRoot() - Method in class org.jpublish.SiteContext
Get the directory where page configuration files are stored.
getPageType() - Method in class org.jpublish.Page
Get the page type.
getPath() - Method in class org.jpublish.Page
Get the request path.
getPath() - Method in class org.jpublish.action.PathAction
Get the path for matching.
getPathActions() - Method in class org.jpublish.action.ActionManager
 
getRepositories() - Method in class org.jpublish.SiteContext
Get a list of all registered repositories.
getRepository(String) - Method in class org.jpublish.SiteContext
Get a Repository by name.
getRoot() - Method in class org.jpublish.page.filesystem.FileSystemPageManager
Get the root directory for pages.
getRoot() - Method in class org.jpublish.repository.filesystem.FileSystemRepository
Get the root directory for locating content.
getRoot() - Method in class org.jpublish.repository.filesystem.ExtendedFileSystemRepository
 
getSessionContext() - Method in class org.jpublish.servlet.HttpSessionWrap
Deprecated.  
getStartupActions() - Method in class org.jpublish.action.ActionManager
 
getStaticResourceLoader() - Method in class org.jpublish.SiteContext
Get the static resource loader.
getStaticRoot() - Method in class org.jpublish.SiteContext
Get the directory where static files are stored.
getSuffixes() - Method in class org.jpublish.util.MimeType
Return a list of suffixes for this mime type.
getTemplateName() - Method in class org.jpublish.Page
Get the template name.
getTemplateRoot() - Method in class org.jpublish.SiteContext
Get the directory where templates are stored.
getTitle() - Method in class org.jpublish.Page
Return the page title.
getValue(String) - Method in class org.jpublish.servlet.HttpSessionWrap
Deprecated.  
getValueNames() - Method in class org.jpublish.servlet.HttpSessionWrap
Deprecated.  
getWebInfPath() - Method in class org.jpublish.SiteContext
Get the File for the WEB-INF directory.
GlobalAction - class org.jpublish.example.action.GlobalAction.
 
GlobalAction() - Constructor for class org.jpublish.example.action.GlobalAction
 

H

HttpSessionWrap - class org.jpublish.servlet.HttpSessionWrap.
A concrete wrapper for the HttpSession interface.
HttpSessionWrap(HttpSession) - Constructor for class org.jpublish.servlet.HttpSessionWrap
Construct an HttpSessionWrap around the given session.

I

init(ServletConfig) - Method in class org.jpublish.servlet.JPublishServlet
Initialize the servlet.
invalidate() - Method in class org.jpublish.servlet.HttpSessionWrap
 
isBinary() - Method in interface org.jpublish.Content
Return true if this content represents a binrary entity.
isNew() - Method in class org.jpublish.servlet.HttpSessionWrap
 

J

JPublishContext - class org.jpublish.JPublishContext.
The JPublishContext overrides the Velocity context to add name checking as a security measure so that code cannot replace standard variables.
JPublishContext(Object) - Constructor for class org.jpublish.JPublishContext
 
JPublishException - exception org.jpublish.JPublishException.
 
JPublishException() - Constructor for class org.jpublish.JPublishException
Construct a JPublishException.
JPublishException(String) - Constructor for class org.jpublish.JPublishException
Construct a JPublishException.
JPublishException(String, Throwable) - Constructor for class org.jpublish.JPublishException
Construct a new JPublishException with the given message and nested exception.
JPublishRuntimeException - exception org.jpublish.JPublishRuntimeException.
 
JPublishRuntimeException() - Constructor for class org.jpublish.JPublishRuntimeException
Construct a JPublishRuntimeException.
JPublishRuntimeException(String) - Constructor for class org.jpublish.JPublishRuntimeException
Construct a JPublishRuntimeException.
JPublishRuntimeException(String, Throwable) - Constructor for class org.jpublish.JPublishRuntimeException
Construct a new JPublishRuntimeException with the given message and nested exception.
JPublishServlet - class org.jpublish.servlet.JPublishServlet.
This class is the entry point for requests to the JPublish framework.
JPublishServlet() - Constructor for class org.jpublish.servlet.JPublishServlet
 

L

load() - Method in class org.jpublish.util.LogSystem
 
load(File, OutputStream) - Method in class org.jpublish.StaticResourceLoader
Load the resource from the given file and write it to the given OutputStream.
load(InputStream) - Method in class org.jpublish.SiteContext
Load the site configuration from the given InputStream.
load(InputStream) - Method in class org.jpublish.Page
Load the page configuration from the page's XML stream.
loadConfiguration(Element) - Method in interface org.jpublish.Configurable
Load the class configuration from the given JDOM Element.
loadConfiguration(Element) - Method in class org.jpublish.repository.db.DBRepository
Load the repository's configuration from the given JDOM element.
loadConfiguration(Element) - Method in class org.jpublish.repository.filesystem.FileSystemRepository
Load the repository's configuration from the given JDOM element.
loadConfiguration(Element) - Method in class org.jpublish.repository.filesystem.ExtendedFileSystemRepository
 
LogSystem - class org.jpublish.util.LogSystem.
The log system will attempt to find the log properties file based on the log path from the servlet init.
LogSystem(String, File) - Constructor for class org.jpublish.util.LogSystem
Construct and initialize the LogSystem.

M

match(String, String) - Static method in class org.jpublish.util.PathUtilities
Match a path which may contain a wildcard.
MimeType - class org.jpublish.util.MimeType.
 
MimeType() - Constructor for class org.jpublish.util.MimeType
Construct a MimeType object.
MimeTypeMap - class org.jpublish.util.MimeTypeMap.
Data structure representing a mime type map.
MimeTypeMap() - Constructor for class org.jpublish.util.MimeTypeMap
 

N

NS - Static variable in interface org.jpublish.XMLConstants
The XML namespace for the JPublish namespace.
NS_PREFIX - Static variable in interface org.jpublish.XMLConstants
The XML namespace prefix for the JPublish namespace.
NS_URL - Static variable in interface org.jpublish.XMLConstants
The XML URL for the JPublish namespace.

O

org.jpublish - package org.jpublish
 
org.jpublish.action - package org.jpublish.action
 
org.jpublish.example - package org.jpublish.example
 
org.jpublish.example.action - package org.jpublish.example.action
 
org.jpublish.page - package org.jpublish.page
 
org.jpublish.page.filesystem - package org.jpublish.page.filesystem
 
org.jpublish.repository - package org.jpublish.repository
 
org.jpublish.repository.db - package org.jpublish.repository.db
 
org.jpublish.repository.filesystem - package org.jpublish.repository.filesystem
 
org.jpublish.servlet - package org.jpublish.servlet
 
org.jpublish.util - package org.jpublish.util
 

P

Page - class org.jpublish.Page.
A representation of a single web page.
Page(SiteContext, String, String, String) - Constructor for class org.jpublish.Page
Construct a new Page for the given path.
PageCacheEntry - class org.jpublish.page.PageCacheEntry.
A cache entry for a Page.
PageCacheEntry(Page, long) - Constructor for class org.jpublish.page.PageCacheEntry
Construct a new PageCacheEntry for the given page.
PageManager - interface org.jpublish.PageManager.
The PageManager is a central access point for locating pages.
PathAction - class org.jpublish.action.PathAction.
An action which is executed when a particular path is matched.
PathAction(String, Action) - Constructor for class org.jpublish.action.PathAction
Construct a new PathAction.
PathUtilities - class org.jpublish.util.PathUtilities.
 
printStackTrace(PrintWriter) - Method in class org.jpublish.JPublishRuntimeException
 
printStackTrace(PrintWriter) - Method in class org.jpublish.JPublishException
 
put(String, Object) - Method in class org.jpublish.JPublishContext
Put the given value into the context.
putValue(String, Object) - Method in class org.jpublish.servlet.HttpSessionWrap
Deprecated.  

R

reload() - Method in class org.jpublish.SiteContext
Reload the site configuration.
remove(String) - Method in class org.jpublish.JPublishContext
Remove the given value from the context.
removeAction(String) - Method in class org.jpublish.action.ActionManager
 
removeAttribute(String) - Method in class org.jpublish.servlet.HttpSessionWrap
 
removeValue(String) - Method in class org.jpublish.servlet.HttpSessionWrap
Deprecated.  
Repository - interface org.jpublish.Repository.
A common interface which all repositories must implement.
RepositoryWrapper - class org.jpublish.RepositoryWrapper.
A wrapper around any repository.
RepositoryWrapper(Repository, VelocityContext) - Constructor for class org.jpublish.RepositoryWrapper
Construct a new RepositoryWrapper over the given repository using the given context for merging.
ReservedNameException - exception org.jpublish.ReservedNameException.
Exception which is thrown when an action attempts to put a value into the context using a reserved name.
ReservedNameException(String) - Constructor for class org.jpublish.ReservedNameException
Construct a ReservedNameException for the given name.
ReservedNameException(String, String) - Constructor for class org.jpublish.ReservedNameException
Construct a ReservedNameException for the given name with the given message.

S

ScriptAction - class org.jpublish.action.ScriptAction.
An action which is implemented in a BSF supported scripting language.
ScriptAction(SiteContext, File) - Constructor for class org.jpublish.action.ScriptAction
Construct a new ScriptAction for the given script.
ScriptAction(SiteContext, String) - Constructor for class org.jpublish.action.ScriptAction
Construct a new ScriptAction for the given script.
setActionIdentifier(String) - Method in class org.jpublish.SiteContext
Set the action identifier.
setActionRoot(File) - Method in class org.jpublish.SiteContext
Set the directory where action scripts are stored.
setActionRoot(String) - Method in class org.jpublish.SiteContext
Set the directory where action scripts are stored.
setAttribute(String, Object) - Method in class org.jpublish.servlet.HttpSessionWrap
 
setContentQuery(String) - Method in class org.jpublish.repository.db.DBRepository
 
setDefaultMimeType(String) - Method in class org.jpublish.SiteContext
Set the default mime type.
setDefaultMimeType(String) - Method in class org.jpublish.util.MimeTypeMap
Set the default mime type.
setDefaultPage(String) - Method in class org.jpublish.SiteContext
Set the default page.
setDefaultTemplate(String) - Method in class org.jpublish.SiteContext
Set the default template.
setFirstName(String) - Method in class org.jpublish.example.User
 
setLastModified(long) - Method in class org.jpublish.page.PageCacheEntry
Set the last modification time (in milliseconds).
setLastModifiedQuery(String) - Method in class org.jpublish.repository.db.DBRepository
 
setLastName(String) - Method in class org.jpublish.example.User
 
setMaxInactiveInterval(int) - Method in class org.jpublish.servlet.HttpSessionWrap
 
setPageRoot(File) - Method in class org.jpublish.SiteContext
Set the directory where page configuration files are stored.
setPageRoot(String) - Method in class org.jpublish.SiteContext
Set the directory where page configuration files are stored.
setPassword(String) - Method in class org.jpublish.repository.db.DBRepository
 
setRoot(String) - Method in class org.jpublish.repository.filesystem.FileSystemRepository
Set the root directory for locating content.
setRoot(String) - Method in class org.jpublish.repository.filesystem.ExtendedFileSystemRepository
 
setSiteContext(SiteContext) - Method in interface org.jpublish.PageManager
Set the SiteContext.
setSiteContext(SiteContext) - Method in interface org.jpublish.Repository
Set the SiteContext.
setSiteContext(SiteContext) - Method in class org.jpublish.page.AbstractPageManager
Set the SiteContext.
setSiteContext(SiteContext) - Method in class org.jpublish.repository.AbstractRepository
Set the repository's reference to the current SiteContext.
setStaticRoot(File) - Method in class org.jpublish.SiteContext
Set the directory where static files are stored.
setStaticRoot(String) - Method in class org.jpublish.SiteContext
Set the directory where static files are stored.
setTemplateName(String) - Method in class org.jpublish.Page
Set the template name.
setTemplateRoot(File) - Method in class org.jpublish.SiteContext
Set the directory where templates are stored.
setTemplateRoot(String) - Method in class org.jpublish.SiteContext
Set the directory where templates are stored.
setTitle(String) - Method in class org.jpublish.Page
Set the title.
setURL(String) - Method in class org.jpublish.repository.db.DBRepository
 
setUsername(String) - Method in class org.jpublish.repository.db.DBRepository
 
setWebInfPath(File) - Method in class org.jpublish.SiteContext
Set the File for the WEB-INF directory.
siteContext - Variable in class org.jpublish.page.AbstractPageManager
 
siteContext - Variable in class org.jpublish.repository.AbstractRepository
 
SiteContext - class org.jpublish.SiteContext.
This class contains configuration information for a particular site.
SiteContext(File) - Constructor for class org.jpublish.SiteContext
Construct a new SiteContext using the given File to load the context's configuration.
StaticResourceLoader - class org.jpublish.StaticResourceLoader.
A class for loading static web resources.
StaticResourceLoader() - Constructor for class org.jpublish.StaticResourceLoader
Construct a new StaticResourceLoader.
syslog - Static variable in class org.jpublish.util.LogSystem
 

T

TestObject - class org.jpublish.example.TestObject.
 
TestObject() - Constructor for class org.jpublish.example.TestObject
 
TestPathAction - class org.jpublish.example.action.TestPathAction.
 
TestPathAction() - Constructor for class org.jpublish.example.action.TestPathAction
 
toString() - Method in interface org.jpublish.Content
Return a String representation of the content.

U

URL_PATH_SEPARATOR - Static variable in class org.jpublish.util.URLUtilities
The URL path separator.
URLUtilities - class org.jpublish.util.URLUtilities.
 
URLUtilities(HttpServletRequest, HttpServletResponse) - Constructor for class org.jpublish.util.URLUtilities
 
User - class org.jpublish.example.User.
 
User() - Constructor for class org.jpublish.example.User
 
UsernameValidator - class org.jpublish.example.UsernameValidator.
 
UsernameValidator() - Constructor for class org.jpublish.example.UsernameValidator
 

V

validate(FormElement, FormData) - Method in class org.jpublish.example.UsernameValidator
Validate the given FormData.

X

XMLConstants - interface org.jpublish.XMLConstants.
XML constants for the JPublish namespace.

A B C D E F G H I J L M N O P R S T U V X

Copyright (C) 2001 Anthony Eden. All Rights Reserved.