nxm.ice.net

Class HSource

java.lang.Object

nxm.ice.net.HSource

Direct Known Subclasses:

HArchive, HDisplay, HFile, HFiles, HMessage, HQuery, HSystem

public class HSource
extends java.lang.Object

Provides the interface for all objects that are capable of providing data in response to an HTTP request. Objects should override the handleRequest method to fill in the HPage with the appropriate response.

Author:

Jeff Schoen, J. Czechowski IV

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	name
HServer	server

Constructor Summary

Constructors

Constructor and Description
HSource() Creates a new instance without the name set.
HSource(java.lang.String name) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	canHandleRequest(java.lang.String uri) Returns true if this data source can handle the request for the specified uri.
java.lang.String	getName() Returns the name of this resource
boolean	handleHeadRequest()
void	handleRequest(java.lang.String uri, HPage hp) Invoked to write the data from this source into the specified HPage.
void	setServer(HServer server)

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

server

public HServer server

Constructor Detail

HSource

public HSource()

Creates a new instance without the name set.

Since NeXtMidas 2.1.1: Use HSource(String).

HSource

public HSource(java.lang.String name)

Creates a new instance.

Parameters:

name - The name to use.

Method Detail

getName

public java.lang.String getName()

Returns the name of this resource

Returns:

Name string

canHandleRequest

public boolean canHandleRequest(java.lang.String uri)

Returns true if this data source can handle the request for the specified uri.

Parameters:

uri - URL for this call

Returns:

True if can handle request

handleRequest

public void handleRequest(java.lang.String uri,
                          HPage hp)

Invoked to write the data from this source into the specified HPage.

Parameters:

uri - The Request string containing the request parameters.

hp - The HPage to write the data into.

handleHeadRequest

public boolean handleHeadRequest()

setServer

public void setServer(HServer server)