All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface org.w3c.tools.resources.ServerInterface

public interface ServerInterface
extends ServerHandler

Method Index

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

Methods

 o errlog
 public abstract void errlog(Resource from,
                             String msg)
Another nice way of reporting errors from a Resource.

Parameters:
from - The resource that trigered the error.
msg - The error message.
 o loadResource
 public abstract ResourceReference loadResource(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.
 o checkpoint
 public abstract void checkpoint()
Checkpoint all cached data, by saving them to disk.

 o loadRoot
 public abstract ResourceReference loadRoot(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.
 o getProperties
 public abstract ObservableProperties getProperties()
Get this server properties.

 o checkFileSystemSensitivity
 public abstract boolean checkFileSystemSensitivity()
Is the underlying file-system case sensitive ?

Returns:
A boolean, true if file system is case sensitive, false otherwise.
 o getDocumentationURL
 public abstract String getDocumentationURL()
Get the full URL of Jigsaw's documentation.

Returns:
A String encoded URL.
 o getClientDebug
 public abstract boolean getClientDebug()
Get the client's debug flags from the properties.

 o getClientKeepConnection
 public abstract boolean getClientKeepConnection()
Does this server wants clients to try keeping connections alive ?

 o getRequestTimeOut
 public abstract int getRequestTimeOut()
Get the request allowed time slice from the properties.

 o getConnectionTimeOut
 public abstract int getConnectionTimeOut()
Get the connection allowed idle time from the properties.

 o getClientThreadPriority
 public abstract int getClientThreadPriority()
Get the client's threads priority from the properties.

 o getClientBufferSize
 public abstract int getClientBufferSize()
Get the client's buffer size.

 o getHost
 public abstract String getHost()
Get this server host name.

 o getPort
 public abstract int getPort()
Get this server port number.

 o getRoot
 public abstract FramedResource getRoot()
Get the server current root resource.

 o getURL
 public abstract URL getURL()
Get the server URL.

 o getSoftware
 public abstract String getSoftware()
Get the server software string.

 o getLocalPort
 public abstract int getLocalPort()
Get the server local port

 o getRootDirectory
 public abstract File getRootDirectory()
Get this server root directory.

 o getConfigDirectory
 public abstract File getConfigDirectory()
Get this server config directory.

 o getAuthDirectory
 public abstract File getAuthDirectory()
Get this server authentication directory.

 o getStoreDirectory
 public abstract File getStoreDirectory()
Get this server store directory.

 o getIndexerDirectory
 public abstract File getIndexerDirectory()
 o getIndexersCatalog
 public abstract IndexersCatalog getIndexersCatalog()
 o getResourceSpace
 public abstract ResourceSpace getResourceSpace()
Get this server resource space.

 o getDefaultContext
 public abstract ResourceContext getDefaultContext()
Get the default resource context for that server.

 o perform
 public abstract 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.
Throws: ResourceException
If some error not relative to the protocol occurs.

All Packages  Class Hierarchy  This Package  Previous  Next  Index