votorola.a.web.wic

Class VOWicket.ConstructionContext

java.lang.Object

VOWicket.ConstructionContext

Enclosing class:

VOWicket

@ThreadSafe
public static final class VOWicket.ConstructionContext
extends Object

A context for configuring the web interface. The web interface is configured by its startup configuration file, which contains a script (s) for that purpose. During construction of the web interface, an instance of this context is passed to s, via s::constructingVOWicket(wicCC).

After the interface is running, it itself is passed to s, via s::initializingVOWicket(wic).

Method Summary

Methods

Modifier and Type	Method and Description
Class<? extends Authenticator>	getAuthenticatorClass() The class of user authenticator for the web interface.
URI	getDefaultPageIcon() The location of default page icon, or null if the location is the default.
String	getHTMLHeaderInsert() The site-specific, customized insert for the 'head' section.
URI	getMirroredContextURI() The absolute URI of the static mirror of the context directory, or null if the context directory is not statically served.
String	getName() The name that nominally identifies the web interface and is used to construct its service email address.
SMTPTransportX.ConstructionContext	mailTransferService() The context for configuring access to the mail transfer server, through which outgoing messages (for email address authentication) are sent.
void	setAuthenticatorClass(Class<? extends Authenticator> cl) Sets the class of user authenticator for the web interface.
void	setDefaultPageIcon(String s) Sets the location of default page icon.
void	setDefaultPageIcon(URI uri) Sets the location of default page icon.
void	setHTMLHeaderInsert(String _htmlHeaderInsert) Sets the site-specific, customized insert for the 'head' section.
void	setMirroredContextLocation(String s) Sets absolute URI of the static mirror of the context directory.
void	setMirroredContextURI(URI uri) Sets absolute URI of the static mirror of the context directory.
void	setName(String _name) Sets the name that nominally identifies the web interface, and is used to construct its service email address.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAuthenticatorClass

public Class<? extends Authenticator> getAuthenticatorClass()

The class of user authenticator for the web interface.

See Also:

VOWicket.authenticator(), setAuthenticatorClass(Class)

setAuthenticatorClass

@ThreadRestricted(value="constructor")
public void setAuthenticatorClass(Class<? extends Authenticator> cl)

Sets the class of user authenticator for the web interface. Set it like this, for example:

   wicCC.setAuthenticatorClass(
     Packages.votorola.a.web.wic.authen.WikiAuthenticator );

The default class is OpenIDAuthenticator.

See Also:

VOWicket.authenticator()

getDefaultPageIcon

public URI getDefaultPageIcon()

The location of default page icon, or null if the location is the default.

See Also:

VOWicket.defaultPageIcon(), setDefaultPageIcon(String), setDefaultPageIcon(URI)

setDefaultPageIcon

@ThreadRestricted(value="constructor")
public void setDefaultPageIcon(String s)
                        throws URISyntaxException

Sets the location of default page icon. The default value is "vote-server/icon-16.png".

Throws:

URISyntaxException

See Also:

VOWicket.defaultPageIcon()

setDefaultPageIcon

@ThreadRestricted(value="constructor")
public void setDefaultPageIcon(URI uri)

Sets the location of default page icon. The default value is "vote-server/icon-16.png".

See Also:

VOWicket.defaultPageIcon()

getHTMLHeaderInsert

public String getHTMLHeaderInsert()

The site-specific, customized insert for the 'head' section.

See Also:

VOWicket.htmlHeaderInsert(), setHTMLHeaderInsert(String)

setHTMLHeaderInsert

@ThreadRestricted(value="constructor")
public void setHTMLHeaderInsert(String _htmlHeaderInsert)

Sets the site-specific, customized insert for the 'head' section.

See Also:

VOWicket.htmlHeaderInsert()

getMirroredContextURI

public URI getMirroredContextURI()

The absolute URI of the static mirror of the context directory, or null if the context directory is not statically served.

See Also:

VOWicket.mirroredContextURI(), setMirroredContextLocation(String), setMirroredContextURI(URI)

setMirroredContextLocation

@ThreadRestricted(value="constructor")
public void setMirroredContextLocation(String s)
                                throws URISyntaxException

Sets absolute URI of the static mirror of the context directory. The default value is null which means the context directory is not statically served.

Throws:

IllegalArgumentException - if the URI ends with a slash '/' character.

URISyntaxException

See Also:

VOWicket.mirroredContextURI()

setMirroredContextURI

@ThreadRestricted(value="constructor")
public void setMirroredContextURI(URI uri)

Sets absolute URI of the static mirror of the context directory. The default value is null which means the context directory is not statically served.

Throws:

IllegalArgumentException - if the URI ends with a slash '/' character.

See Also:

VOWicket.mirroredContextURI()

getName

public String getName()

The name that nominally identifies the web interface and is used to construct its service email address.

See Also:

VOWicket.name(), VOWicket.serviceEmail(), setName(String)

setName

@ThreadRestricted(value="constructor")
public void setName(String _name)

Sets the name that nominally identifies the web interface, and is used to construct its service email address. The default value is the vote-server name.

See Also:

VOWicket.name(), VOWicket.serviceEmail()

mailTransferService

public SMTPTransportX.ConstructionContext mailTransferService()

The context for configuring access to the mail transfer server, through which outgoing messages (for email address authentication) are sent.