org.w3c.tools.resources
Interface ServerInterface

All Superinterfaces:

ServerHandler

All Known Implementing Classes:

AdminServer, httpd, httpsd, webdavd, webdavsd

public interface ServerInterface
extends ServerHandler

Method Summary

boolean	checkFileSystemSensitivity() Is the underlying file-system case sensitive ?
void	checkpoint() Checkpoint all cached data, by saving them to disk.
void	errlog(Resource from, java.lang.String msg) Another nice way of reporting errors from a Resource.
java.io.File	getAuthDirectory() Get this server authentication directory.
int	getClientBufferSize() Get the client's buffer size.
boolean	getClientDebug() Get the client's debug flags from the properties.
boolean	getClientKeepConnection() Does this server wants clients to try keeping connections alive ?
int	getClientThreadPriority() Get the client's threads priority from the properties.
java.io.File	getConfigDirectory() Get this server config directory.
int	getConnectionTimeOut() Get the connection allowed idle time from the properties.
ResourceContext	getDefaultContext() Get the default resource context for that server.
java.lang.String	getDocumentationURL() Get the full URL of Jigsaw's documentation.
java.lang.String	getHost() Get this server host name.
java.io.File	getIndexerDirectory()
IndexersCatalog	getIndexersCatalog()
int	getLocalPort() Get the server local port
int	getPort() Get this server port number.
ObservableProperties	getProperties() Get this server properties.
int	getRequestTimeOut() Get the request allowed time slice from the properties.
ResourceSpace	getResourceSpace() Get this server resource space.
ResourceStoreManager	getResourceStoreManager() Get the Resource store manager of this server
FramedResource	getRoot() Get the server current root resource.
java.io.File	getRootDirectory() Get this server root directory.
java.lang.String	getSoftware() Get the server software string.
java.io.File	getStoreDirectory() Get this server store directory.
java.io.File	getTempDirectory() Get temp directory
java.lang.String	getTrashDirectory() Get the tracsh directory
java.net.URL	getURL() Get the server URL.
ResourceReference	loadResource(java.lang.String name) Lookup in the root entry for some resource.
ResourceReference	loadRoot(java.lang.String name) Dynamically change the root resource for the server.
ReplyInterface	perform(RequestInterface request) Perform the given request on behalf of this server.

Methods inherited from interface org.w3c.jigsaw.daemon.ServerHandler

clone, errlog, getConfigResource, getIdentifier, getInetAddress, initialize, log, shutdown, start, trace

Method Detail

errlog

void errlog(Resource from,
            java.lang.String msg)

Another nice way of reporting errors from a Resource.

Parameters:

from - The resource that trigered the error.

msg - The error message.

loadResource

ResourceReference loadResource(java.lang.String name)

Lookup in the root entry for some resource.

Parameters:

name - The name of the resource to lookup in the root entry.

Returns:

The loaded resource, or null.

checkpoint

void checkpoint()

Checkpoint all cached data, by saving them to disk.

loadRoot

ResourceReference loadRoot(java.lang.String name)

Dynamically change the root resource for the server. This is kind a dangerous operation !

Parameters:

name - The name of the new root resource, to be found in the root entry.

Returns:

The new installed root resource, or null if we couldn't load the given resource.

getProperties

ObservableProperties getProperties()

Get this server properties.

checkFileSystemSensitivity

boolean checkFileSystemSensitivity()

Is the underlying file-system case sensitive ?

Returns:

A boolean, true if file system is case sensitive, false otherwise.

getDocumentationURL

java.lang.String getDocumentationURL()

Get the full URL of Jigsaw's documentation.

Returns:

A String encoded URL.

getTrashDirectory

java.lang.String getTrashDirectory()

Get the tracsh directory

getClientDebug

boolean getClientDebug()

Get the client's debug flags from the properties.

getClientKeepConnection

boolean getClientKeepConnection()

Does this server wants clients to try keeping connections alive ?

getRequestTimeOut

int getRequestTimeOut()

Get the request allowed time slice from the properties.

getConnectionTimeOut

int getConnectionTimeOut()

Get the connection allowed idle time from the properties.

getClientThreadPriority

int getClientThreadPriority()

Get the client's threads priority from the properties.

getClientBufferSize

int getClientBufferSize()

Get the client's buffer size.

getHost

java.lang.String getHost()

Get this server host name.

getPort

int getPort()

Get this server port number.

getRoot

FramedResource getRoot()

Get the server current root resource.

getURL

java.net.URL getURL()

Get the server URL.

getSoftware

java.lang.String getSoftware()

Get the server software string.

getLocalPort

int getLocalPort()

Get the server local port

getRootDirectory

java.io.File getRootDirectory()

Get this server root directory.

getConfigDirectory

java.io.File getConfigDirectory()

Get this server config directory.

getAuthDirectory

java.io.File getAuthDirectory()

Get this server authentication directory.

getStoreDirectory

java.io.File getStoreDirectory()

Get this server store directory.

getIndexerDirectory

java.io.File getIndexerDirectory()

getTempDirectory

java.io.File getTempDirectory()

Get temp directory

getIndexersCatalog

IndexersCatalog getIndexersCatalog()

getResourceSpace

ResourceSpace getResourceSpace()

Get this server resource space.

getDefaultContext

ResourceContext getDefaultContext()

Get the default resource context for that server.

getResourceStoreManager

ResourceStoreManager getResourceStoreManager()

Get the Resource store manager of this server

perform

ReplyInterface perform(RequestInterface request)
                       throws ProtocolException,
                              ResourceException

Perform the given request on behalf of this server.

Parameters:

request - The request to perform.

Returns:

A non-null Reply instance.

Throws:

ProtocolException - If some error occurs during processing the request.

ResourceException - If some error not relative to the protocol occurs.