Package dap4.servlet

Class DapController

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

dap4.servlet.DapController

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public abstract class DapController
extends javax.servlet.http.HttpServlet

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	BIG_ENDIAN
protected static DapCache	cache
protected static String	DATAEXT
static boolean	DEBUG
static long	DEFAULTBINARYWRITELIMIT
protected static String	DMREXT
protected static String	DSREXT
static boolean	DUMPDATA
static boolean	DUMPDMR
protected static String[]	ENDINGS
protected static String	FAVICON
protected boolean	initialized
protected static boolean	IS_BIG_ENDIAN
protected static String	LITTLE_ENDIAN
static boolean	PARSEDEBUG
static boolean	TESTING

Constructor Summary

Constructors

Constructor	Description
DapController()

Method Summary

Modifier and Type	Method	Description
protected void	addCommonHeaders(DapRequest drq)
protected abstract void	doCapabilities(DapRequest drq, dap4.core.util.DapContext cxt)	Process a capabilities request.
protected void	doData(DapRequest drq, dap4.core.util.DapContext cxt)	Process a DataDMR request.
protected void	doDMR(DapRequest drq, dap4.core.util.DapContext cxt)	Process a DMR request.
protected void	doDSR(DapRequest drq, dap4.core.util.DapContext cxt)	Process a DSR request.
protected abstract void	doFavicon(String icopath, dap4.core.util.DapContext cxt)	Process a favicon request.
abstract long	getBinaryWriteLimit()	Get the maximum # of bytes per request
protected static DapCache	getCache()
protected DapRequest	getRequestState(javax.servlet.http.HttpServletRequest rq, javax.servlet.http.HttpServletResponse rsp)	Merge the servlet inputs into a single object for easier transport as well as adding value.
abstract String	getResourcePath(DapRequest drq, String location)	Convert a URL path into an absolute file path Note that it is assumed than any leading servlet prefix has been removed.
abstract String	getServletID()	Get the servlet name (with no leading or trailing slashes)
void	handleRequest(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	init()
void	initialize()	Initialize servlet/controller
static String	printDMR(dap4.core.dmr.DapDataset dmr)
protected void	senderror(DapRequest drq, int httpcode, Throwable t)	Generate an error based on the parameters
protected static void	setCache(DapCache cache)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

TESTING

public static boolean TESTING

DEBUG

public static boolean DEBUG

DUMPDMR

public static boolean DUMPDMR

DUMPDATA

public static boolean DUMPDATA

PARSEDEBUG

public static boolean PARSEDEBUG

BIG_ENDIAN

protected static final String BIG_ENDIAN

See Also:

Constant Field Values

LITTLE_ENDIAN

protected static final String LITTLE_ENDIAN

See Also:

Constant Field Values

IS_BIG_ENDIAN

protected static boolean IS_BIG_ENDIAN

DMREXT

protected static final String DMREXT

See Also:

Constant Field Values

DATAEXT

protected static final String DATAEXT

See Also:

Constant Field Values

DSREXT

protected static final String DSREXT

See Also:

Constant Field Values

ENDINGS

protected static final String[] ENDINGS

FAVICON

protected static final String FAVICON

See Also:

Constant Field Values

DEFAULTBINARYWRITELIMIT

public static final long DEFAULTBINARYWRITELIMIT

See Also:

Constant Field Values

cache

protected static DapCache cache

initialized

protected boolean initialized

Constructor Detail

DapController

public DapController()

Method Detail

setCache

protected static void setCache(DapCache cache)

getCache

protected static DapCache getCache()

doFavicon

protected abstract void doFavicon(String icopath,
                                  dap4.core.util.DapContext cxt)
                           throws IOException

Process a favicon request.

Parameters:

icopath - The path to the icon

cxt - The dap context

Throws:

IOException

doCapabilities

protected abstract void doCapabilities(DapRequest drq,
                                       dap4.core.util.DapContext cxt)
                                throws IOException

Process a capabilities request. Currently, does nothing (but see D4TSServlet.doCapabilities).

Parameters:

cxt - The dapontext

Throws:

IOException

getResourcePath

public abstract String getResourcePath(DapRequest drq,
                                       String location)
                                throws dap4.core.util.DapException

Convert a URL path into an absolute file path Note that it is assumed than any leading servlet prefix has been removed.

Parameters:

drq - dap request

location - suffix of url path

Returns:

Throws:

IOException

dap4.core.util.DapException

getBinaryWriteLimit

public abstract long getBinaryWriteLimit()

Get the maximum # of bytes per request

Returns:

size

getServletID

public abstract String getServletID()

Get the servlet name (with no leading or trailing slashes)

Returns:

name

init

public void init()

Overrides:

init in class javax.servlet.GenericServlet

initialize

public void initialize()

Initialize servlet/controller

handleRequest

public void handleRequest(javax.servlet.http.HttpServletRequest req,
                          javax.servlet.http.HttpServletResponse res)
                   throws IOException

Throws:

IOException

doDSR

protected void doDSR(DapRequest drq,
                     dap4.core.util.DapContext cxt)
              throws IOException

Process a DSR request. * @param cxt The dap context

Throws:

IOException

doDMR

protected void doDMR(DapRequest drq,
                     dap4.core.util.DapContext cxt)
              throws IOException

Process a DMR request.

Parameters:

cxt - The dap context

Throws:

IOException

doData

protected void doData(DapRequest drq,
                      dap4.core.util.DapContext cxt)
               throws IOException

Process a DataDMR request. Note that if this throws an exception, then it has not yet started to output a response. It a response had been initiated, then the exception would produce an error chunk.

* @param cxt The dap context

Throws:

IOException

addCommonHeaders

protected void addCommonHeaders(DapRequest drq)
                         throws IOException

Throws:

IOException

getRequestState

protected DapRequest getRequestState(javax.servlet.http.HttpServletRequest rq,
                                     javax.servlet.http.HttpServletResponse rsp)
                              throws IOException

Merge the servlet inputs into a single object for easier transport as well as adding value.

Parameters:

rq - A Servlet request object

rsp - A Servlet response object

Returns:

the union of the servlet request and servlet response arguments from the servlet engine.

Throws:

IOException

senderror

protected void senderror(DapRequest drq,
                         int httpcode,
                         Throwable t)
                  throws IOException

Generate an error based on the parameters

Parameters:

drq - DapRequest

httpcode - 0=>no code specified

t - exception that caused the error; may be null

Throws:

IOException

printDMR

public static String printDMR(dap4.core.dmr.DapDataset dmr)