org.entityfs.zip
Class ZipFileSystemBuilder

java.lang.Object
  org.entityfs.impl.AbstractFileSystemBuilder<T>
      org.entityfs.impl.impl.AbstractFileSystemBuilderImpl<ZipFileSystemBuilder>
          org.entityfs.zip.ZipFileSystemBuilder

All Implemented Interfaces:

FileSystemBuilder<ZipFileSystemBuilder>

public class ZipFileSystemBuilder
extends AbstractFileSystemBuilderImpl<ZipFileSystemBuilder>

This is a builder class for building read only Zip file-backed file systems.

A limitation of the Zip file system is that it must be built upon a Zip file in a file-backed file system. This is because Java's ZipFile class only can be built from a File object.

The Zip file system must be closed when it is not needed anymore. If a file entity is used for the zip file, it is locked for reading by the Zip file system. The lock is released when the file system is closed.

Since:

1.0

Author:

Karl Gustafsson

Field Summary

Fields inherited from interface org.entityfs.FileSystemBuilder

DEFAULT_BUFFER_SIZE

Constructor Summary

ZipFileSystemBuilder()
Create a builder with default settings: LogAdapter: DefaultLogAdapter.DEFAULT_ADAPTER EntityValidityControlStrategy: null (no one else should have write access to the backend)

Method Summary

protected AdapterFactory	createAdapterFactory()
protected FileSystemImplementation	createFileSystem(SupportObjects fso, FileSystemDelegate fsd)
protected FileSystemDelegate	createFileSystemDelegate(FileSystemAdapter fsa)
boolean	isLockingSupported() Does the file system being built support locking?
protected boolean	isReadOnly()
ZipFileSystemBuilder	setZipFile(EFile f) Set the Zip file.
ZipFileSystemBuilder	setZipFile(File f) Set the Zip file.
ZipFileSystemBuilder	setZipFile(ZipFile f) Set the Zip file.
protected Collection<String>	validate()

Methods inherited from class org.entityfs.impl.impl.AbstractFileSystemBuilderImpl

create, createDefaultChildEntityManagerFactory, enableEvents, getChildEntityManagerFactory, getEventManager, isFileSystemSupportedByAllCapabilities, setChildEntityManagerFactory, setEventManager

Methods inherited from class org.entityfs.impl.AbstractFileSystemBuilder

addCapabilityProvider, addCapabilityProviders, disableAccessControls, disableEntityValidityControls, enableLocking, getAccessController, getBufferSize, getCapabilityProviders, getCapabilityProvidersInternal, getEntityValidityControlStrategy, getLockAcquiringStrategy, getLockAdapterFactory, getLockCommandExecutor, getLogAdapter, getName, getThis, setAccessController, setBufferSize, setEntityValidityControlStrategy, setLockAcquiringStrategy, setLockAdapterFactory, setLockCommandExecutor, setLogAdapter, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipFileSystemBuilder

public ZipFileSystemBuilder()

Create a builder with default settings:

• LogAdapter: DefaultLogAdapter.DEFAULT_ADAPTER
• EntityValidityControlStrategy: null (no one else should have write access to the backend)

Method Detail

setZipFile

public ZipFileSystemBuilder setZipFile(File f)

Set the Zip file.

Parameters:

f - The Zip file.

Returns:

this.

setZipFile

public ZipFileSystemBuilder setZipFile(EFile f)
                                throws IllegalArgumentException

Set the Zip file.

Parameters:

f - The Zip file.

Returns:

this.

Throws:

IllegalArgumentException - If the file is not in a file-backed file system.

setZipFile

public ZipFileSystemBuilder setZipFile(ZipFile f)

Set the Zip file.

Parameters:

f - The Zip file.

Returns:

this.

isLockingSupported

public boolean isLockingSupported()

Description copied from interface: FileSystemBuilder

Does the file system being built support locking?

Returns:

false.

See Also:

FileSystemBuilder.enableLocking()

validate

protected Collection<String> validate()

Overrides:

validate in class AbstractFileSystemBuilder<ZipFileSystemBuilder>

isReadOnly

protected boolean isReadOnly()

Specified by:

isReadOnly in class AbstractFileSystemBuilderImpl<ZipFileSystemBuilder>

Returns:

true, always.

createAdapterFactory

protected AdapterFactory createAdapterFactory()

Specified by:

createAdapterFactory in class AbstractFileSystemBuilderImpl<ZipFileSystemBuilder>

createFileSystemDelegate

protected FileSystemDelegate createFileSystemDelegate(FileSystemAdapter fsa)

Specified by:

createFileSystemDelegate in class AbstractFileSystemBuilderImpl<ZipFileSystemBuilder>

createFileSystem

protected FileSystemImplementation createFileSystem(SupportObjects fso,
                                                    FileSystemDelegate fsd)

Specified by:

createFileSystem in class AbstractFileSystemBuilderImpl<ZipFileSystemBuilder>