oracle.ifs.server

Class FileSystemMediaDriver

java.lang.Object

oracle.ifs.server.FileSystemMediaDriver

All Implemented Interfaces:

CustomMediaDriver

public class FileSystemMediaDriver
extends Object
implements CustomMediaDriver

FileSystemMediaDriver is a custom media driver that stores content on a file system.

The FileSystemMediaDriver allows content to be stored on a file system. No more content is stored in the database, only the document's metadata is stored in the database.

The location on the filesystem where the files are stored is set in a property that is defined on the CustomMediaDriverSpecification. Two other properties are defined as well:

• IFS.MEDIACUSTOM.FILESYSTEMMEDIADRIVER.PROPERTY.BasePath: base path where files are stored
• IFS.MEDIACUSTOM.FILESYSTEMMEDIADRIVER.PROPERTY.RelativePathFormat: Relative path format. This is directory hierarchy under the base path
• IFS.MEDIACUSTOM.FILESYSTEMMEDIADRIVER.PROPERTY.DeleteFileFromFileSystem: boolean indicating whether the files on the file system should be retained or deleted

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_BASE_PATH The name of the MediaCustom property whose string value is the base path property name.
static String	PROPERTY_DELETE_FILE The name of the MediaCustom property whose string value is the Delete from filesystem property name.
static String	PROPERTY_FILE_PREFIX The name of the MediaCustom property whose string value is the FilePrefix property name.
static String	PROPERTY_RELATIVE_PATH_FORMAT The name of the MediaCustom property whose string value is the relative path format property name.

Constructor Summary

Constructors

Constructor and Description
FileSystemMediaDriver() Default constructor

Method Summary

Modifier and Type	Method and Description
void	destroyContent(S_MediaCustom media, String address, Long cid, AttributeValue[] mediaOptions) Destroys content with the specified content address.
InputStream	getContent(S_MediaCustom media, String address) Gets the content for the specified content address.
long	getContentSize(S_MediaCustom media, String address) Gets the content size, in bytes, for the specified content address.
static TimeZone	getDefaultTimeZone(S_LibrarySession session) Gets the default TimeZone.
RandomAccessDriver	getRandomAccessorDriver(S_MediaCustom media, String address) Gets a RandomAccessDriver for the specified content address.
void	initialize(S_CustomMediaDriverSpecification cmds) Initializes this CustomMediaDriver.
String	setContent(S_MediaCustom media, Long cid, InputStream is, AttributeValue[] mediaOptions) Stores content from the supplied InputStream.
String	setContentReference(S_MediaCustom media, Long cid, String contentReference, AttributeValue[] mediaOptions) Stores content determined from a specified content reference.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_BASE_PATH

public static final String PROPERTY_BASE_PATH

The name of the MediaCustom property whose string value is the base path property name.

The base path is the actual absolute path on the filesystem where the content will be stored.

See Also:

Constant Field Values

(Published)

PROPERTY_RELATIVE_PATH_FORMAT

public static final String PROPERTY_RELATIVE_PATH_FORMAT

The name of the MediaCustom property whose string value is the relative path format property name.

The relative path format uses the date and time patterns defined in the SimpleDateFormat class.

See Also:

SimpleDateFormat, Constant Field Values

(Published)

PROPERTY_DELETE_FILE

public static final String PROPERTY_DELETE_FILE

The name of the MediaCustom property whose string value is the Delete from filesystem property name.

The DeleteFileFromFileSystem property defines whether files should be removed from the filesystem if content is removed from the database.

See Also:

Constant Field Values

(Published)

PROPERTY_FILE_PREFIX

public static final String PROPERTY_FILE_PREFIX

The name of the MediaCustom property whose string value is the FilePrefix property name.

The FilePrefix property defines the prefix used when creating new files on the FileSystemMedia.

See Also:

Constant Field Values

(Published)

Constructor Detail

FileSystemMediaDriver

public FileSystemMediaDriver()

Default constructor

Method Detail

initialize

public void initialize(S_CustomMediaDriverSpecification cmds)
                throws IfsException

Initializes this CustomMediaDriver.

Specified by:

initialize in interface CustomMediaDriver

Parameters:

cmds - the CustomMediaDriver specification

Throws:

IfsException - 13800: if the operation fails

getContent

public InputStream getContent(S_MediaCustom media,
                              String address)
                       throws IfsException

Gets the content for the specified content address.

Specified by:

getContent in interface CustomMediaDriver

Parameters:

media - the MediaCustom instance

address - the content address

Returns:

the content

Throws:

IfsException - 13801: if the operation fails

getContentSize

public long getContentSize(S_MediaCustom media,
                           String address)
                    throws IfsException

Gets the content size, in bytes, for the specified content address.

Specified by:

getContentSize in interface CustomMediaDriver

Parameters:

media - the MediaCustom instance

address - the content address

Returns:

the size

Throws:

IfsException - 13802: if the operation fails

setContent

public String setContent(S_MediaCustom media,
                         Long cid,
                         InputStream is,
                         AttributeValue[] mediaOptions)
                  throws IfsException

Stores content from the supplied InputStream.

Specified by:

setContent in interface CustomMediaDriver

Parameters:

media - the MediaCustom instance

cid - the content id

is - the content

mediaOptions - a set of name/value pairs whose semantics are determined by the CustomMediaDriver implementation, or null for no media options

Returns:

the content address

Throws:

IfsException - 13803: if the operation fails

setContentReference

public String setContentReference(S_MediaCustom media,
                                  Long cid,
                                  String contentReference,
                                  AttributeValue[] mediaOptions)
                           throws IfsException

Stores content determined from a specified content reference.

The interpretation of contentReference is determined by the CustomMediaDriver implementation. Some implementations may store its value, while others may resolve its value (in a implementation determined fashion) to other content and store that content instead.

Specified by:

setContentReference in interface CustomMediaDriver

Parameters:

media - the MediaCustom instance

cid - the content id

contentReference - the content reference

mediaOptions - a set of name/value pairs whose semantics are determined by the CustomMediaDriver implementation, or null for no media options

Returns:

the content address

Throws:

IfsException - 13804: if the operation fails

getRandomAccessorDriver

public RandomAccessDriver getRandomAccessorDriver(S_MediaCustom media,
                                                  String address)
                                           throws IfsException

Gets a RandomAccessDriver for the specified content address.

Specified by:

getRandomAccessorDriver in interface CustomMediaDriver

Parameters:

media - the MediaCustom instance

address - the content address

Returns:

the RandomAccessDriver

Throws:

IfsException - 13805: if the operation fails

destroyContent

public void destroyContent(S_MediaCustom media,
                           String address,
                           Long cid,
                           AttributeValue[] mediaOptions)
                    throws IfsException

Destroys content with the specified content address.

Specified by:

destroyContent in interface CustomMediaDriver

Parameters:

media - the MediaCustom instance

address - the content address

cid - the content id

mediaOptions - a set of name/value pairs whose semantics are determined by the CustomMediaDriver implementation, or null for no media options

Throws:

IfsException - 13806: if the operation fails

getDefaultTimeZone

public static TimeZone getDefaultTimeZone(S_LibrarySession session)
                                   throws IfsException

Gets the default TimeZone.

Parameters:

session - session context

Returns:

the default TimeZone

Throws:

IfsException - if the operation fails