dap4.servlet

Class DapController

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

dap4.servlet.DapController

All Implemented Interfaces:

java.io.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 and Description
protected static java.lang.String	BIG_ENDIAN
protected static long	binarywritelimit
protected java.nio.ByteOrder	byteorder
protected static DapCache	cache
protected boolean	compress
protected java.lang.String	controllerpath
protected static java.lang.String	DATAEXT
static boolean	DEBUG
static long	DEFAULTBINARYWRITELIMIT
protected static java.lang.String	DMREXT
protected DapDSR	dsrbuilder
protected static java.lang.String	DSREXT
protected static java.lang.String[]	ENDINGS
protected static java.lang.String	FAVICON
protected static boolean	IS_BIG_ENDIAN
protected static java.lang.String	LITTLE_ENDIAN
static boolean	PARSEDEBUG
protected java.lang.String	resourcepath
protected javax.servlet.ServletContext	servletcontext

Constructor Summary

Constructors

Constructor and Description
DapController(java.lang.String controllerpath)

Method Summary

Modifier and Type	Method and Description
protected void	addCommonHeaders(DapRequest drq)
protected CEConstraint	buildconstraint(DapRequest drq, java.lang.String sce, dap4.core.dmr.DapDataset dmr) If the request has a constraint, then parse it else use the universal constraint
protected abstract void	doCapabilities(DapRequest drq) Process a capabilities request.
protected void	doData(DapRequest drq) Process a DataDMR request.
protected void	doDMR(DapRequest drq) Process a DMR request.
protected void	doDSR(DapRequest drq) Process a DSR request.
protected abstract void	doFavicon(DapRequest drq, java.lang.String icopath) Process a favicon request.
protected 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.
protected abstract java.lang.String	getResourcePath(DapRequest drq, java.lang.String relpath) Convert a URL path into an absolute file path
void	handleRequest(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	init()
protected void	senderror(DapRequest drq, int httpcode, java.lang.Throwable t) Generate an error based on the parameters
static void	setBinaryWritelimit(long limit)
protected static void	setCache(DapCache cache)
void	setServletContext(javax.servlet.ServletContext servletContext)

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

DEBUG

public static final boolean DEBUG

See Also:

Constant Field Values

PARSEDEBUG

public static final boolean PARSEDEBUG

See Also:

Constant Field Values

BIG_ENDIAN

protected static final java.lang.String BIG_ENDIAN

See Also:

Constant Field Values

LITTLE_ENDIAN

protected static final java.lang.String LITTLE_ENDIAN

See Also:

Constant Field Values

IS_BIG_ENDIAN

protected static boolean IS_BIG_ENDIAN

DMREXT

protected static final java.lang.String DMREXT

See Also:

Constant Field Values

DATAEXT

protected static final java.lang.String DATAEXT

See Also:

Constant Field Values

DSREXT

protected static final java.lang.String DSREXT

See Also:

Constant Field Values

ENDINGS

protected static final java.lang.String[] ENDINGS

FAVICON

protected static final java.lang.String FAVICON

See Also:

Constant Field Values

DEFAULTBINARYWRITELIMIT

public static final long DEFAULTBINARYWRITELIMIT

See Also:

Constant Field Values

cache

protected static DapCache cache

binarywritelimit

protected static long binarywritelimit

compress

protected boolean compress

byteorder

protected transient java.nio.ByteOrder byteorder

dsrbuilder

protected transient DapDSR dsrbuilder

controllerpath

protected transient java.lang.String controllerpath

resourcepath

protected transient java.lang.String resourcepath

servletcontext

protected transient javax.servlet.ServletContext servletcontext

Constructor Detail

DapController

public DapController(java.lang.String controllerpath)

Method Detail

setCache

protected static void setCache(DapCache cache)

getCache

protected static DapCache getCache()

setBinaryWritelimit

public static void setBinaryWritelimit(long limit)

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

doFavicon

protected abstract void doFavicon(DapRequest drq,
                                  java.lang.String icopath)
                           throws java.io.IOException

Process a favicon request.

Parameters:

drq - The merged dap state

Throws:

java.io.IOException

doCapabilities

protected abstract void doCapabilities(DapRequest drq)
                                throws java.io.IOException

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

Parameters:

drq - The merged dap state

Throws:

java.io.IOException

getResourcePath

protected abstract java.lang.String getResourcePath(DapRequest drq,
                                                    java.lang.String relpath)
                                             throws java.io.IOException

Convert a URL path into an absolute file path

Parameters:

drq - The wrapped request info

Throws:

java.io.IOException

getBinaryWriteLimit

protected abstract long getBinaryWriteLimit()

Get the maximum # of bytes per request

Returns:

size

init

public void init()
          throws javax.servlet.ServletException

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

handleRequest

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

Throws:

java.io.IOException

doDSR

protected void doDSR(DapRequest drq)
              throws java.io.IOException

Process a DSR request.

Throws:

java.io.IOException

doDMR

protected void doDMR(DapRequest drq)
              throws java.io.IOException

Process a DMR request.

Parameters:

drq - The merged dap state

Throws:

java.io.IOException

doData

protected void doData(DapRequest drq)
               throws java.io.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.

Parameters:

drq - The merged dap state

Throws:

java.io.IOException

addCommonHeaders

protected void addCommonHeaders(DapRequest drq)
                         throws java.io.IOException

Throws:

java.io.IOException

getRequestState

protected DapRequest getRequestState(javax.servlet.http.HttpServletRequest rq,
                                     javax.servlet.http.HttpServletResponse rsp)
                              throws java.io.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:

java.io.IOException

senderror

protected void senderror(DapRequest drq,
                         int httpcode,
                         java.lang.Throwable t)
                  throws java.io.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:

java.io.IOException

buildconstraint

protected CEConstraint buildconstraint(DapRequest drq,
                                       java.lang.String sce,
                                       dap4.core.dmr.DapDataset dmr)
                                throws java.io.IOException

If the request has a constraint, then parse it else use the universal constraint

Parameters:

drq -

sce - string of the constraint

Returns:

parsed constraint

Throws:

java.io.IOException