    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Interface org.w3c.tools.resources.ServerInterface

public interface ServerInterface
extends ServerHandler

##

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

##

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.

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.

checkpoint

     public abstract void checkpoint()

  Checkpoint all cached data, by saving them to disk.

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.

getProperties

     public abstract ObservableProperties getProperties()

  Get this server properties.

checkFileSystemSensitivity

     public abstract boolean checkFileSystemSensitivity()

  Is the underlying file-system case sensitive ?

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

getDocumentationURL

     public abstract String getDocumentationURL()

  Get the full URL of Jigsaw's documentation.

  Returns:
    A String encoded URL.

getClientDebug

     public abstract boolean getClientDebug()

  Get the client's debug flags from the properties.

getClientKeepConnection

     public abstract boolean getClientKeepConnection()

  Does this server wants clients to try keeping connections alive ?

getRequestTimeOut

     public abstract int getRequestTimeOut()

  Get the request allowed time slice from the properties.

getConnectionTimeOut

     public abstract int getConnectionTimeOut()

  Get the connection allowed idle time from the properties.

getClientThreadPriority

     public abstract int getClientThreadPriority()

  Get the client's threads priority from the properties.

getClientBufferSize

     public abstract int getClientBufferSize()

  Get the client's buffer size.

getHost

     public abstract String getHost()

  Get this server host name.

getPort

     public abstract int getPort()

  Get this server port number.

getRoot

     public abstract FramedResource getRoot()

  Get the server current root resource.

getURL

     public abstract URL getURL()

  Get the server URL.

getSoftware

     public abstract String getSoftware()

  Get the server software string.

getLocalPort

     public abstract int getLocalPort()

  Get the server local port

getRootDirectory

     public abstract File getRootDirectory()

  Get this server root directory.

getConfigDirectory

     public abstract File getConfigDirectory()

  Get this server config directory.

getAuthDirectory

     public abstract File getAuthDirectory()

  Get this server authentication directory.

getStoreDirectory

     public abstract File getStoreDirectory()

  Get this server store directory.

getIndexerDirectory

     public abstract File getIndexerDirectory()

getIndexersCatalog

     public abstract IndexersCatalog getIndexersCatalog()

getResourceSpace

     public abstract ResourceSpace getResourceSpace()

  Get this server resource space.

getDefaultContext

     public abstract ResourceContext getDefaultContext()

  Get the default resource context for that server.

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