ucar.unidata.io.http

Class HTTPRandomAccessFile

java.lang.Object

ucar.unidata.io.RandomAccessFile

ucar.unidata.io.RemoteRandomAccessFile

ucar.unidata.io.http.HTTPRandomAccessFile

All Implemented Interfaces:

java.io.Closeable, java.io.DataInput, java.io.DataOutput, java.lang.AutoCloseable, FileCacheable, ReadableRemoteFile

public final class HTTPRandomAccessFile
extends RemoteRandomAccessFile

Gives access to files over HTTP, using "Accept-Ranges" HTTP header to do random access.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTTPRandomAccessFile.Provider Hook into service provider interface for RandomAccessFileProvider.

Field Summary

Fields inherited from class ucar.unidata.io.RemoteRandomAccessFile

defaultMaxReadCacheSize, defaultRemoteFileBufferSize, defaultRemoteFileTimeout, url

Fields inherited from class ucar.unidata.io.RandomAccessFile

allFiles, BIG_ENDIAN, bigEndian, buffer, bufferModified, bufferStart, dataEnd, dataSize, debugAccess, debugLeaks, defaultBufferSize, endOfFile, file, fileChannel, filePosition, LITTLE_ENDIAN, location, openFiles, readonly, showOpen, showRead

Constructor Summary

Constructors

Constructor and Description
HTTPRandomAccessFile(java.lang.String url)
HTTPRandomAccessFile(java.lang.String url, int bufferSize, long maxRemoteCacheSize)

Method Summary

Modifier and Type	Method and Description
void	closeRemote() Close any resources used to enable remote reading.
long	getLastModified() Always returns 0L, as we cannot easily determine the last time that a remote file was modified.
long	length() Get the length of the file.
int	readRemote(long pos, byte[] buff, int offset, int len) Read directly from remote file, without going through the buffer.

Methods inherited from class ucar.unidata.io.RemoteRandomAccessFile

close, read_, readToByteChannel

Methods inherited from class ucar.unidata.io.RandomAccessFile

acquire, acquire, eject, enableDefaultGlobalFileCache, flush, getAllFiles, getBufferSize, getDebugLeaks, getDebugNbytes, getDebugNseeks, getFilePointer, getGlobalFileCache, getLocation, getMaxOpenFileCount, getOpenFileCount, getOpenFiles, getRandomAccessFile, isAtEndOfFile, isDirectory, order, order, reacquire, read, read, read, readBoolean, readBuffer, readByte, readBytes, readBytes, readChar, readDouble, readDouble, readFloat, readFloat, readFully, readFully, readInt, readInt, readIntUnbuffered, readLine, readLine, readLong, readLong, readShort, readShort, readString, readString, readStringMax, readStringMax, readUnsignedByte, readUnsignedShort, readUTF, release, searchForward, seek, setBufferSize, setDebugAccess, setDebugLeaks, setExtendMode, setFileCache, setGlobalFileCache, setMinLength, shutdown, skipBytes, skipBytes, toString, unread, write, write, write, writeBoolean, writeBoolean, writeByte, writeBytes, writeBytes, writeBytes, writeChar, writeChar, writeChar, writeChar, writeChar, writeChar, writeChars, writeChars, writeChars, writeDouble, writeDouble, writeDouble, writeDouble, writeDouble, writeDouble, writeFloat, writeFloat, writeFloat, writeFloat, writeFloat, writeFloat, writeInt, writeInt, writeInt, writeInt, writeInt, writeInt, writeLong, writeLong, writeLong, writeLong, writeLong, writeLong, writeShort, writeShort, writeShort, writeShort, writeShort, writeShort, writeUTF

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPRandomAccessFile

public HTTPRandomAccessFile(java.lang.String url)
                     throws java.io.IOException

Throws:

java.io.IOException

HTTPRandomAccessFile

public HTTPRandomAccessFile(java.lang.String url,
                            int bufferSize,
                            long maxRemoteCacheSize)
                     throws java.io.IOException

Throws:

java.io.IOException

Method Detail

closeRemote

public void closeRemote()

Description copied from interface: ReadableRemoteFile

Close any resources used to enable remote reading. For example, HTTPSession from httpservices, or S3Client from the AWS SDK

readRemote

public int readRemote(long pos,
                      byte[] buff,
                      int offset,
                      int len)
               throws java.io.IOException

Read directly from remote file, without going through the buffer.

Parameters:

pos - start here in the file

buff - put data into this buffer

offset - buffer offset

len - this number of bytes

Returns:

actual number of bytes read

Throws:

java.io.IOException - on io error

length

public long length()

Description copied from class: RandomAccessFile

Get the length of the file. The data in the buffer (which may not have been written the disk yet) is taken into account.

Overrides:

length in class RandomAccessFile

Returns:

the length of the file in bytes.

getLastModified

public long getLastModified()

Always returns 0L, as we cannot easily determine the last time that a remote file was modified.

Specified by:

getLastModified in interface FileCacheable

Overrides:

getLastModified in class RandomAccessFile

Returns:

0L, always.