eventweb.prov

Class ByteFileProv

java.lang.Object

eventweb.prov.ByteFileProv

All Implemented Interfaces:

ByteDataProv, RsrcProv, Debuggable

public class ByteFileProv
extends java.lang.Object
implements ByteDataProv

File resource provider.

This provider returns files as byte streams. The actual data type of the file doesn't matter.

Version:

1.0.4 08/10/16

Author:

Stephen W. Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	DEP_LIST Class dependencies
protected java.io.FileInputStream	fromFile
protected static Logger	log
static java.lang.String[]	rsrcList Supported resource requests
static java.lang.String	VERSION Class version

Fields inherited from interface eventweb.prov.ByteDataProv

IF_VERSION

Constructor Summary

Constructors

Constructor and Description
ByteFileProv(java.lang.String rootPath)

Method Summary

Methods

Modifier and Type	Method and Description
void	closeRsrc() Close the resource
int	getBytes(byte[] buffer) Get bytes from the resource.
boolean	isDebugging() Get debug state.
boolean	openRsrc(java.net.URL reqUrl) Open a resource
void	quiesce() Stop accepting new requests and release resources.
long	rsrcLength() Get the size of the resource.
void	setDebugging(boolean debug) Set or clear debugging

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

Class version

DEP_LIST

public static final java.lang.String[] DEP_LIST

Class dependencies

rsrcList

public static final java.lang.String[] rsrcList

Supported resource requests

log

protected static Logger log

fromFile

protected java.io.FileInputStream fromFile

Constructor Detail

ByteFileProv

public ByteFileProv(java.lang.String rootPath)

Method Detail

setDebugging

public void setDebugging(boolean debug)

Description copied from interface: Debuggable

Set or clear debugging

Specified by:

setDebugging in interface Debuggable

Parameters:

debug - If true, debugging is turned on, otherwise, debugging is turned off.

isDebugging

public boolean isDebugging()

Description copied from interface: Debuggable

Get debug state.

Specified by:

isDebugging in interface Debuggable

Returns:

true, If debugging is turned on, otherwise false

openRsrc

public boolean openRsrc(java.net.URL reqUrl)

Description copied from interface: ByteDataProv

Open a resource

Specified by:

openRsrc in interface ByteDataProv

Parameters:

reqUrl - URL for the resource to open.

Returns:

true if successful.

closeRsrc

public void closeRsrc()

Description copied from interface: ByteDataProv

Close the resource

Specified by:

closeRsrc in interface ByteDataProv

rsrcLength

public long rsrcLength()

Description copied from interface: ByteDataProv

Get the size of the resource.

Specified by:

rsrcLength in interface ByteDataProv

Returns:

size of resource, in bytes.

getBytes

public int getBytes(byte[] buffer)

Description copied from interface: ByteDataProv

Get bytes from the resource.

Specified by:

getBytes in interface ByteDataProv

Parameters:

buffer - Buffer to receive the bytes.

Returns:

number of bytes copied to buffer.

quiesce

public void quiesce()

Stop accepting new requests and release resources.

Specified by:

quiesce in interface RsrcProv