votorola.a

Class PollwikiVS

java.lang.Object

PollwikiVS

All Implemented Interfaces:

Pollwiki

@ThreadSafe
public final class PollwikiVS
extends Object
implements Pollwiki

A pollwiki from the viewpoint of a vote-server.

See Also:

VoteServer.pollwiki(), ../s/manual.xht#wiki

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PollwikiVS.ConstructionContext A context for configuring the construction of a PollwikiVS.

Constructor Summary

Constructors

Constructor and Description
PollwikiVS(PollwikiVS.ConstructionContext cc) Partially constructs a PollwikiVS for init to finish.

Method Summary

Methods

Modifier and Type	Method and Description
StringBuilder	appendPageSpecifier(String encodedPageName) Appends an already encoded page name to the wiki base URL.
WikiCache	cache() The cache of data from this pollwiki's database.
javax.ws.rs.core.UriBuilder	encodePageSpecifier(String pageName) Encodes a page name and appends it to the wiki base URL.
(package private) void	init(VoteServer vS) Completes the construction of this PollwikiVS.
boolean	maybeUgly() Answers whether the wiki URL might be based on the standard access URL ending in "index.php" for example, or is definitely based on a pretty alias per $wgUsePathInfo.
String	password() The password for the vote-server's wiki accounts, which go by the username Vobot.
PipeRecognizer	pipeRecognizer() A recognizer of pipes in the pollwiki.
String	positionPageName(String personName, String pollName) Returns the page name of the specified position.
int	revisionSeries() The identifier of the revision series, which is zero or greater.
URI	scriptURI() The base location for script execution in the pollwiki, without a trailing slash (/).
URI	uri() The base location for requesting pages from the pollwiki.

Methods inherited from class java.lang.Object

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

Constructor Detail

PollwikiVS

PollwikiVS(PollwikiVS.ConstructionContext cc)
     throws URISyntaxException

Partially constructs a PollwikiVS for init to finish.

Throws:

URISyntaxException

Method Detail

init

void init(VoteServer vS)
    throws IOException

Completes the construction of this PollwikiVS. Call once only.

Throws:

IOException

encodePageSpecifier

public javax.ws.rs.core.UriBuilder encodePageSpecifier(String pageName)

Encodes a page name and appends it to the wiki base URL. Usage example:

     String href = voteServer.pollwiki().encodePageSpecifier(
       "Main page" ).build().toASCIIString();

See Also:

appendPageSpecifier(String)

cache

public WikiCache cache()

The cache of data from this pollwiki's database.

password

public String password()

The password for the vote-server's wiki accounts, which go by the username Vobot. These accounts must be created in the pollwiki associated with the vote-server and in every remote wiki to which users patch differences or otherwise edit texts via the services of the vote-server.

See Also:

PollwikiVS.ConstructionContext.setPassword(String)

revisionSeries

public int revisionSeries()

The identifier of the revision series, which is zero or greater. The value is incremented whenever the vote-server is associated with a new pollwiki, or whenever the current pollwiki's revision history is altered by reassigning its revision identifiers.

See Also:

PollwikiVS.ConstructionContext.setRevisionSeries(int)

scriptURI

public URI scriptURI()

The base location for script execution in the pollwiki, without a trailing slash (/). If the pollwiki has a domain name then that name should be used here in its fully qualified form, even if the wiki is hosted locally along with the vote-server. Do not use "localhost" or the short host name alone, otherwise the vote-server may be unable to login via the MediaWiki API (1.16.1.). For example http://reluk.ca/mediawiki. Script requests may be constructed by appending the script path and parameters:

    scriptURI().toASCIIString() + "/index.php?oldid=1138"

See Also:

PollwikiVS.ConstructionContext.setScriptLocation(String), PollwikiVS.ConstructionContext.setScriptURI(URI)

uri

public URI uri()

The base location for requesting pages from the pollwiki. This is either the standard access location, such as "scriptURI/index.php" for example, or an alias without a trailing slash (/). In the latter case $wgUsePathInfo is assumed to be true. Page requests formed on this base should generally not be redirected by the wiki or relays of Crossforum Theatre state are likely to fail owing to a URL mismatch.

See Also:

appendPageSpecifier(String), maybeUgly(), PollwikiVS.ConstructionContext.setLocation(String), PollwikiVS.ConstructionContext.setURI(URI), $wgUsePathInfo

appendPageSpecifier

public StringBuilder appendPageSpecifier(String encodedPageName)

Description copied from interface: Pollwiki

Appends an already encoded page name to the wiki base URL. Usage example:

     String href = pollwiki.appendPageSpecifier( "Main_page" ).toString();

Specified by:

appendPageSpecifier in interface Pollwiki

See Also:

uri(), encodePageSpecifier(String)

maybeUgly

public boolean maybeUgly()

Description copied from interface: Pollwiki

Answers whether the wiki URL might be based on the standard access URL ending in "index.php" for example, or is definitely based on a pretty alias per $wgUsePathInfo.

Specified by:

maybeUgly in interface Pollwiki

See Also:

uri()

pipeRecognizer

public PipeRecognizer pipeRecognizer()

A recognizer of pipes in the pollwiki. This recognizer is based on a snapshot of the pollwiki's interface messages. Any change in the relevant messages (unusual) will go undetected by the recognizer until this PollwikiVS instance is recreated, e.g. by restarting the vote-server.

Specified by:

pipeRecognizer in interface Pollwiki

positionPageName

public String positionPageName(String personName,
                      String pollName)

Description copied from interface: Pollwiki

Returns the page name of the specified position.

Specified by:

positionPageName in interface Pollwiki

pollName - this parameter is ignored if the named person is actually a pipe.

See Also:

PositionID.pageName(String,String,PipeRecognizer), Category:Position