Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.store.raw.data.StreamFileContainer

Modifier and Type	Field and Description
private int	actionCode
private StorageFile	actionStorageFile
private BufferedInputStream	bufferedIn
private int	bufferSize
private byte[]	ciphertext
private BaseDataFileFactory	dataFactory
private DecryptInputStream	decryptIn
protected static final int	FIELD_HEADER_SIZE
protected static final int	FIELD_STATUS
private StorageFile	file
private InputStream	fileIn
private OutputStream	fileOut
protected static int	formatIdInteger Constant Fields of the class
protected ContainerKey	identity Fields of the class
protected static final int	LARGE_SLOT_SIZE
private LimitInputStream	limitIn
private FormatIdInputStream	logicalDataIn
private FormatIdOutputStream	logicalDataOut
protected static final int	MIN_BUFFER_SIZE
private DynamicByteArrayOutputStream	out
private StoredRecordHeader	recordHeader
private static final int	STORAGE_FILE_DELETE_ACTION
private static final int	STORAGE_FILE_EXISTS_ACTION
private static final int	STORAGE_FILE_GET_INPUT_STREAM_ACTION
private static final int	STORAGE_FILE_GET_OUTPUT_STREAM_ACTION
private static final int	STORAGE_FILE_MKDIRS_ACTION
private byte[]	zeroBytes

Access	Constructor and Description
pack-priv	StreamFileContainer(ContainerKey identity, BaseDataFileFactory dataFactory) Constructor.
pack-priv	StreamFileContainer(ContainerKey identity, BaseDataFileFactory dataFactory, Properties prop) Constructor when rowSource is passed to the constructor, it will be loaded into the container after the container has been created.

Method Summary

Modifier and Type	Method and Description
protected void	close() Close the stream file.
public boolean	fetchNext(Object[] row)
public void	getContainerProperties(Properties Property list to fill in. prop) Request the system properties associated with a stream container.
private static ContextService	getContextService() Must be private so that user code can't call this entry point.
protected StorageFile	getFileName(ContainerKey identity, boolean forCreate, boolean errorOK) Return a file name for the identity.
public ContainerKey	getIdentity() Request the container key associated with the stream container.
private static Object	getServiceModule(final Object serviceModule, final String factoryInterface) Must be private so that user code can't call this entry point.
public int	getTypeFormatId() Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId. Return my format identifier.
public void	load(RowSource The row source to get rows to load into this container. rowSource) load data into this container.
protected StreamFileContainer	Returns: The opened StreamFileContainer. open(boolean Currently only accepts false, updating and existing stream file container is not currently supported. forUpdate) Open a stream file container.
private synchronized boolean	privDelete(StorageFile file)
private synchronized boolean	privExists(StorageFile file)
private synchronized InputStream	privGetInputStream(StorageFile file)
private synchronized OutputStream	privGetOutputStream(StorageFile file)
private synchronized boolean	privMkdirs(StorageFile file)
public boolean	removeContainer() Close the stream file and remove the file.
public Object	run()
protected boolean	use(StreamContainerHandle handle) Can I use this container?
private void	writeColumn(Object column)
private void	writeToFile() Write the buffer to the file.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

actionCode	back to summary
private int actionCode

actionStorageFile	back to summary
private StorageFile actionStorageFile

bufferedIn	back to summary
private BufferedInputStream bufferedIn

bufferSize	back to summary
private int bufferSize

ciphertext	back to summary
private byte[] ciphertext

dataFactory	back to summary
private BaseDataFileFactory dataFactory

decryptIn	back to summary
private DecryptInputStream decryptIn

FIELD_HEADER_SIZE	back to summary
protected static final int FIELD_HEADER_SIZE

FIELD_STATUS	back to summary
protected static final int FIELD_STATUS

file	back to summary
private StorageFile file

fileIn	back to summary
private InputStream fileIn

fileOut	back to summary
private OutputStream fileOut

formatIdInteger	back to summary
protected static int formatIdInteger Constant Fields of the class

identity	back to summary
protected ContainerKey identity Fields of the class

LARGE_SLOT_SIZE	back to summary
protected static final int LARGE_SLOT_SIZE

limitIn	back to summary
private LimitInputStream limitIn

logicalDataIn	back to summary
private FormatIdInputStream logicalDataIn

logicalDataOut	back to summary
private FormatIdOutputStream logicalDataOut

MIN_BUFFER_SIZE	back to summary
protected static final int MIN_BUFFER_SIZE

out	back to summary
private DynamicByteArrayOutputStream out

recordHeader	back to summary
private StoredRecordHeader recordHeader

STORAGE_FILE_DELETE_ACTION	back to summary
private static final int STORAGE_FILE_DELETE_ACTION

STORAGE_FILE_EXISTS_ACTION	back to summary
private static final int STORAGE_FILE_EXISTS_ACTION

STORAGE_FILE_GET_INPUT_STREAM_ACTION	back to summary
private static final int STORAGE_FILE_GET_INPUT_STREAM_ACTION

STORAGE_FILE_GET_OUTPUT_STREAM_ACTION	back to summary
private static final int STORAGE_FILE_GET_OUTPUT_STREAM_ACTION

STORAGE_FILE_MKDIRS_ACTION	back to summary
private static final int STORAGE_FILE_MKDIRS_ACTION

zeroBytes	back to summary
private byte[] zeroBytes

Constructor Detail

StreamFileContainer	back to summary
pack-priv StreamFileContainer(ContainerKey identity, BaseDataFileFactory dataFactory) Constructor. Exceptions StandardException: Standard exception policy.

StreamFileContainer	back to summary
pack-priv StreamFileContainer(ContainerKey identity, BaseDataFileFactory dataFactory, Properties prop) throws StandardException Constructor when rowSource is passed to the constructor, it will be loaded into the container after the container has been created. Exceptions StandardException: Standard exception policy.

Method Detail

close	back to summary
protected void close() Close the stream file. Close this stream file, and all streams associated with it.

back to summary

protected void close()

Close the stream file.

Close this stream file, and all streams associated with it.

fetchNext	back to summary
public boolean fetchNext(Object[] row) throws StandardException

getContainerProperties	back to summary
public void getContainerProperties(Properties prop) throws StandardException Request the system properties associated with a stream container. Request the value of properties associated with a stream container. The following properties can be requested: derby.storage.streamFileBufferSize To get the value of a particular property add it to the property list, and on return the value of the property will be set to it's current value. For example: get_prop(ConglomerateController cc) { Properties prop = new Properties(); prop.put("derby.storage.streamFileBufferSize", ""); cc.getContainerProperties(prop); System.out.println( "stream table's buffer size = " + prop.getProperty("derby.storage.streamFileBufferSize"); } Parameters prop:Properties Property list to fill in. Exceptions StandardException: Standard exception policy.

getContainerProperties

back to summary

public void getContainerProperties(Properties prop) throws StandardException

Request the system properties associated with a stream container.

Request the value of properties associated with a stream container. The following properties can be requested: derby.storage.streamFileBufferSize

To get the value of a particular property add it to the property list, and on return the value of the property will be set to it's current value. For example: get_prop(ConglomerateController cc) { Properties prop = new Properties(); prop.put("derby.storage.streamFileBufferSize", ""); cc.getContainerProperties(prop); System.out.println( "stream table's buffer size = " + prop.getProperty("derby.storage.streamFileBufferSize"); }

Parameters

prop:Properties: Property list to fill in.

Exceptions

StandardException:: Standard exception policy.

getContextService	back to summary
private static ContextService getContextService() Must be private so that user code can't call this entry point.

getFileName	back to summary
protected StorageFile getFileName(ContainerKey identity, boolean forCreate, boolean errorOK) throws StandardException Return a file name for the identity. Return a valid file name for the identity, or null if the data directory for this segment cannot be created Exceptions StandardException: Segment directory cannot be created

getFileName

back to summary

protected StorageFile getFileName(ContainerKey identity, boolean forCreate, boolean errorOK) throws StandardException

Return a file name for the identity.

Return a valid file name for the identity, or null if the data directory for this segment cannot be created

Exceptions

StandardException:: Segment directory cannot be created

getIdentity	back to summary
public ContainerKey getIdentity() Request the container key associated with the stream container.

getServiceModule	back to summary
private static Object getServiceModule(final Object serviceModule, final String factoryInterface) Must be private so that user code can't call this entry point.

getTypeFormatId	back to summary
public int getTypeFormatId() Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId. Return my format identifier. Returns:int Doc from org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId. The identifier. (A UUID stuffed in an array of 16 bytes).

getTypeFormatId

back to summary

public int getTypeFormatId()

Implements org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.

Return my format identifier.

Returns:int

Doc from org.apache.derby.iapi.services.io.TypedFormat.getTypeFormatId.

The identifier. (A UUID stuffed in an array of 16 bytes).

load	back to summary
public void load(RowSource rowSource) throws StandardException load data into this container. populate the stream container with data in the rowSource Parameters rowSource:RowSource The row source to get rows to load into this container. Exceptions StandardException: Standard exception policy.

load

back to summary

public void load(RowSource rowSource) throws StandardException

load data into this container.

populate the stream container with data in the rowSource

Parameters

rowSource:RowSource: The row source to get rows to load into this container.

Exceptions

StandardException:: Standard exception policy.

open	back to summary
protected StreamFileContainer open(boolean forUpdate) throws StandardException Open a stream file container. Open a container. Open the file that maps to this container, if the file does not exist then we assume the container was never created and return. If the file exists but we have trouble opening it then we throw some exception. Parameters forUpdate:boolean Currently only accepts false, updating and existing stream file container is not currently supported. Returns:StreamFileContainer The opened StreamFileContainer. Exceptions StandardException: Standard exception policy.

open

back to summary

protected StreamFileContainer open(boolean forUpdate) throws StandardException

Open a stream file container.

Open a container. Open the file that maps to this container, if the file does not exist then we assume the container was never created and return. If the file exists but we have trouble opening it then we throw some exception.

Parameters

forUpdate:boolean: Currently only accepts false, updating and existing stream file container is not currently supported.

Returns:StreamFileContainer

The opened StreamFileContainer.

Exceptions

StandardException:: Standard exception policy.

privDelete	back to summary
private synchronized boolean privDelete(StorageFile file)

privExists	back to summary
private synchronized boolean privExists(StorageFile file)

privGetInputStream	back to summary
private synchronized InputStream privGetInputStream(StorageFile file) throws FileNotFoundException

privGetOutputStream	back to summary
private synchronized OutputStream privGetOutputStream(StorageFile file) throws FileNotFoundException

privMkdirs	back to summary
private synchronized boolean privMkdirs(StorageFile file) throws IOException

removeContainer	back to summary
public boolean removeContainer() throws StandardException Close the stream file and remove the file. Exceptions StandardException: Segment directory cannot be created

removeContainer

back to summary

public boolean removeContainer() throws StandardException

Close the stream file and remove the file.

Exceptions

StandardException:: Segment directory cannot be created

run	back to summary
public Object run() throws IOException

use	back to summary
protected boolean use(StreamContainerHandle handle) throws StandardException Can I use this container? This method always return true right now. In the future when there are different uses for this container, we may need to add qualifications for this. Exceptions StandardException: Standard exception policy.

use

back to summary

protected boolean use(StreamContainerHandle handle) throws StandardException

Can I use this container?

This method always return true right now. In the future when there are different uses for this container, we may need to add qualifications for this.

Exceptions

StandardException:: Standard exception policy.

writeColumn	back to summary
private void writeColumn(Object column) throws StandardException, IOException

writeToFile

back to summary

private void writeToFile() throws StandardException

Write the buffer to the file.

If the database is encrypted, the dataFactory.getEncryptionBlockSize() - 1 reserved bytes will be used to pad the byte array to be dataFactory.getEncryptionBlockSize() aligned. Before the bytes are encrypted and written to the file stream, the actual length of the byte array is written out as a compressed integer. This number will be used when decrypting the data. If the database is not encrypted, then, we don't reserve the bytes upfront, and we simple just write the bytes out to the file stream.

Exceptions

StandardException:: Standard exception policy.

pack-priv Class StreamFileContainer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail