VOWicket (Votorola Java API)

All Implemented Interfaces:

IEventSink, ISessionStore.UnboundListener
```
@ThreadSafe
public final class VOWicket
extends WebApplication
```
The Wicket web interface. The home page is WP_Server.

See Also:
../../../s/manual.xht#web

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VOWicket.ConstructionContext
A context for configuring the web interface.

Nested Classes
Modifier and Type	Class and Description
`static class`	`VOWicket.ConstructionContext` A context for configuring the web interface.

Field Summary
- Fields inherited from class org.apache.wicket.Application
  CONFIGURATION

Constructor Summary

Constructors
Constructor and Description

VOWicket()

Constructors
Constructor and Description
`VOWicket()`

Method Summary

Methods
Modifier and Type	Method and Description
`Authenticator`	`authenticator()` The user authenticator for this web interface.
`static String`	`contextPathToVoteServerName(String servletContextPath)` Returns the name of the vote-server associated with the specified context path.
`CookieManager`	`cookieManager()` The default cookie manager for outgoing requests.
`URI`	`defaultPageIcon()` The location of the default page icon.
`ScheduledExecutorService`	`executor()` The general-purpose web executor, an asynchronous executor that runs on a single thread, the "web executor" thread.
`static VOWicket`	`get()` Returns the intance of VOWicket associated with the current thread.
`Class<? extends Page>`	`getHomePage()`
`String`	`htmlHeaderInsert()` The site-specific, customized insert for the 'head' section of every HTML page.
`protected void`	`init()`
`boolean`	`isExecutorThread()` Answers whether the calling thread is the web executor thread.
`Object`	`mailLock()` Lock object for mail facilities.
`MailSender`	`mailSender()` Access to the SMTP mail transfer service.
`Session`	`mailSession()` The mail session for this run of the web interface.
`URI`	`mirroredContextURI()` The absolute URI of the static mirror of the context directory, or null if the context directory is not statically served.
`String`	`name()` The name that nominally identifies this web interface.
`static NavBar`	`navBar()` The top navigation bar for navigating among the pages of the vote-server.
`protected IConverterLocator`	`newConverterLocator()`
`Session`	`newSession(Request request, Response response)`
`protected void`	`onDestroy()`
`WP_Activity.ApplicationScope`	`scopeActivity()` The application scope for instances of WP_Activity.
`WP_Draft.ApplicationScope`	`scopeDraft()` The application scope for instances of WP_Draft.
`String`	`serviceEmail()` The email address that nominally identifies the web interface.
`Spool`	`spool()` The spool that is unwound prior to destruction of the web interface.
`(package private) File`	`startupConfigurationFile()` The startup configuration file 'vowicket.js' for this web interface.
`VoteServer.Run`	`vsRun()` The vote-server run for which this web interface is provided.

Methods inherited from class org.apache.wicket.Application
configure, createRequestCycle, decorateHeaderResponse, exists, fetchCreateAndSetSession, get, getApplicationKeys, getApplicationListeners, getApplicationSettings, getBehaviorInstantiationListeners, getComponentInitializationListeners, getComponentInstantiationListeners, getComponentOnAfterRenderListeners, getComponentPostOnBeforeRenderListeners, getComponentPreOnBeforeRenderListeners, getConverterLocator, getDebugSettings, getExceptionMapperProvider, getExceptionSettings, getFrameworkSettings, getHeaderContributorListenerCollection, getInitializers, getMapperContext, getMarkupSettings, getMetaData, getName, getPageFactory, getPageManagerContext, getPageManagerProvider, getPageRendererProvider, getPageSettings, getRequestCycleListeners, getRequestCycleProvider, getRequestCycleSettings, getRequestLogger, getRequestLoggerSettings, getResourceReferenceRegistry, getResourceSettings, getRootRequestMapper, getRootRequestMapperAsCompound, getSecuritySettings, getSessionListeners, getSessionSettings, getSessionStore, getSessionStoreProvider, getSharedResources, getStoreSettings, initApplication, initializeComponents, newMapperContext, newPageFactory, newRequestLogger, newResourceReferenceRegistry, newSharedResources, onEvent, setApplicationSettings, setDebugSettings, setExceptionSettings, setFrameworkSettings, setHeaderResponseDecorator, setMarkupSettings, setMetaData, setName, setPageManagerProvider, setPageRendererProvider, setPageSettings, setRequestCycleProvider, setRequestCycleSettings, setRequestLoggerSettings, setResourceSettings, setRootRequestMapper, setSecuritySettings, setSessionSettings, setSessionStoreProvider, setStoreSettings, usesDeploymentConfig, usesDevelopmentConfig, validateInit

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

- Constructor Detail
  - VOWicket
```
public VOWicket()
```
- Method Detail
  - init
```
protected void init()
```
    Overrides:
    
    init in class WebApplication
  - authenticator
```
public Authenticator authenticator()
```
    The user authenticator for this web interface.
    
    See Also:
    VOWicket.ConstructionContext.setAuthenticatorClass(Class)
  - contextPathToVoteServerName
```
public static String contextPathToVoteServerName(String servletContextPath)
```
    Returns the name of the vote-server associated with the specified context path.
    
    See Also:
    ServletContext.getContextPath()
  - cookieManager
```
public CookieManager cookieManager()
```
    The default cookie manager for outgoing requests. It accepts cookies from all domains. It stores them for a single run only. It is strictly for outgoing requests from this web interface to others; not for incoming requests, which instead are handled via the servlet API. Use it on a case by case basis. Do not set it as a global default. It modifies the incoming responses by removing their Set-Cookie headers and there is no efficient, thread-safe way to disable it where it is unwanted.
  - defaultPageIcon
```
public URI defaultPageIcon()
```
    The location of the default page icon.
    
    See Also:
    VOWicket.ConstructionContext.setDefaultPageIcon(String), VOWicket.ConstructionContext.setDefaultPageIcon(URI)
  - executor
```
public ScheduledExecutorService executor()
```
    The general-purpose web executor, an asynchronous executor that runs on a single thread, the "web executor" thread.
    
    See Also:
    isExecutorThread()
  - htmlHeaderInsert
```
public String htmlHeaderInsert()
```
    The site-specific, customized insert for the 'head' section of every HTML page. The format is strict XHTML.
    
    Returns:
    the insert string, or null if there is none.
    See Also:
    VOWicket.ConstructionContext.setHTMLHeaderInsert(String)
  - isExecutorThread
```
public boolean isExecutorThread()
```
    Answers whether the calling thread is the web executor thread.
    
    See Also:
    executor()
  - mailLock
```
public Object mailLock()
```
    Lock object for mail facilities. This object's monitor lock synchronizes all access to members that are annotated @ThreadRestricted("holds mailLock").
  - mailSender
```
@ThreadRestricted(value="holds mailLock")
public MailSender mailSender()
```
    Access to the SMTP mail transfer service.
  - mailSession
```
@ThreadRestricted(value="holds mailLock")
public Session mailSession()
```
    The mail session for this run of the web interface.
  - mirroredContextURI
```
public URI mirroredContextURI()
```
    The absolute URI of the static mirror of the context directory, or null if the context directory is not statically served. The URI is specified without a trailing slash (/).
    
    See Also:
    VOWicket.ConstructionContext.setMirroredContextLocation(String), VOWicket.ConstructionContext.setMirroredContextURI(URI), VRequestCycle.staticContextLocation()
  - name
```
public String name()
```
    The name that nominally identifies this web interface. It must be valid as the local part (before the '@') of an email address, per VoterService.name().
    
    See Also:
    serviceEmail()
  - navBar
```
public static NavBar navBar()
```
    The top navigation bar for navigating among the pages of the vote-server.
  - scopeActivity
```
public WP_Activity.ApplicationScope scopeActivity()
```
    The application scope for instances of WP_Activity.
  - scopeDraft
```
public WP_Draft.ApplicationScope scopeDraft()
```
    The application scope for instances of WP_Draft.
  - serviceEmail
```
public String serviceEmail()
```
    The email address that nominally identifies the web interface. It is constructed from the interface and server names, as:
```
INTERFACE-NAME@SERVER-NAME
```
    Email authentication messages to users will be sent from this address. The mail meta-service ought to respond helpfully to any message that happens to be sent in reply, to this address.
    See Also:
    VOWicket.ConstructionContext.setName(String), MailMetaService, MailMetaService.serviceEmail(VoterService)
  - spool
```
public Spool spool()
```
    The spool that is unwound prior to destruction of the web interface.
  - startupConfigurationFile
```
File startupConfigurationFile()
```
    The startup configuration file 'vowicket.js' for this web interface. The language is JavaScript. There are restrictions on the character encoding.
    
    See Also:
    ../../manual.xht#vowicket.js
  - vsRun
```
public final VoteServer.Run vsRun()
```
    The vote-server run for which this web interface is provided.
  - get
```
public static VOWicket get()
```
    Returns the intance of VOWicket associated with the current thread.
    
    See Also:
    Session.get()
  - getHomePage
```
public Class<? extends Page> getHomePage()
```
    Specified by:
    
    getHomePage in class Application
  - newConverterLocator
```
protected IConverterLocator newConverterLocator()
```
    Overrides:
    
    newConverterLocator in class Application
  - newSession
```
public Session newSession(Request request,
                 Response response)
```
    Overrides:
    
    newSession in class WebApplication
  - onDestroy
```
protected void onDestroy()
```
    Overrides:
    
    onDestroy in class Application

Class VOWicket

Nested Class Summary

Field Summary

Fields inherited from class org.apache.wicket.Application

Constructor Summary

Method Summary

Methods inherited from class org.apache.wicket.protocol.http.WebApplication

Methods inherited from class org.apache.wicket.Application

Methods inherited from class java.lang.Object

Constructor Detail

VOWicket

Method Detail

init

authenticator

contextPathToVoteServerName

cookieManager

defaultPageIcon

executor

htmlHeaderInsert

isExecutorThread

mailLock

mailSender

mailSession

mirroredContextURI

name

navBar

scopeActivity

scopeDraft

serviceEmail

spool

startupConfigurationFile

vsRun

get

getHomePage

newConverterLocator

newSession

onDestroy