com.lf.commons.io.ds

Class URLDataSource

java.lang.Object

com.lf.commons.io.AbstractDataSource

com.lf.commons.io.ds.URLDataSource

All Implemented Interfaces:

ConfigurableUnit, javax.activation.DataSource

public class URLDataSource
extends AbstractDataSource
implements ConfigurableUnit

Data source implementation representing FileObject objects (VFS).

Since:

1.6

Version:

$Revision: 1.4 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static java.net.URL	ICON_DEFAULT Default icon for document tabs.
static java.net.URL	ICON_ERROR Default icon to represent the error state (e.g. file does not exist).
protected org.apache.commons.vfs2.FileObject	url The managed content.
protected VFSConnection	vfsConn The managed content.

Fields inherited from class com.lf.commons.io.AbstractDataSource

action, ACTION_FILE_EDIT, ACTION_FILE_HEXEDIT, ACTION_FILE_OPEN, ACTION_UNKNOWN, ACTION_URL_EDIT, ACTION_URL_HEXEDIT, ACTION_URL_OPEN, date, encoding, formatProps, name, path, size, type

Constructor Summary

Constructors

Constructor and Description
URLDataSource() Constructor method for i18n purposes only.
URLDataSource(java.lang.String type, org.apache.commons.vfs2.FileObject url, VFSConnection vfsconn, int action) Init functionality.

Method Summary

Methods

Modifier and Type	Method and Description
void	configureUnit(java.lang.String id, Configuration config) Restores values from persistent data stores.
void	finish(java.io.OutputStream ostream) After the data has been written to the output stream it is flushed, closed and updated here.
VFSConnection	getConnection() Provides the VFS connection (optional).
javax.swing.Icon	getIcon() Provides the data source specific icon (optional).
java.io.InputStream	getInputStream() This method returns an InputStream representing the data and throws the appropriate exception if it can not do so.
java.io.OutputStream	getOutputStream() This method returns an OutputStream where the data can be written and throws the appropriate exception if it can not do so Note that a new OutputStream object must be returned each time this method is called, and the stream must be positioned at the location the data is to be written.
java.lang.String	getPath() Provides the path for this data source.
org.apache.commons.vfs2.FileObject	getURL() Provides the file object.
void	setURL(org.apache.commons.vfs2.FileObject url) Sets a new file reference (e.g. after save as".
void	storeUnit(java.lang.String id, Configuration config) Stores the current configuration values persistently.
void	unitRegistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was registered with a model.
void	unitUnregistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was unregistered with a model.

Methods inherited from class com.lf.commons.io.AbstractDataSource

finalize, getAction, getContentType, getDate, getDisplayAction, getEncoding, getFormatProperties, getName, getSize, loadTemporaryFile, setAction, setContentType, setDate, setEncoding, setFormatProperty, setName, setPath, setSize, storeTemporaryFile

Methods inherited from class java.lang.Object

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

Field Detail

ICON_DEFAULT

public static final java.net.URL ICON_DEFAULT

Default icon for document tabs.

ICON_ERROR

public static final java.net.URL ICON_ERROR

Default icon to represent the error state (e.g. file does not exist).

url

protected org.apache.commons.vfs2.FileObject url

The managed content.

vfsConn

protected VFSConnection vfsConn

The managed content.

Constructor Detail

URLDataSource

public URLDataSource()

Constructor method for i18n purposes only.

Since:

1.6

URLDataSource

public URLDataSource(java.lang.String type,
             org.apache.commons.vfs2.FileObject url,
             VFSConnection vfsconn,
             int action)

Init functionality.

Parameters:

type - The MIME type (default is "application/octet-stream", optional)

url - The managed content

vfsconn - The connection (optional)

action - The load action AbstractDataSource.FILE_OPEN, ...

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

Method Detail

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

This method returns an InputStream representing the data and throws the appropriate exception if it can not do so.

Note that a new InputStream object must be returned each time this method is called, and the stream must be positioned at the beginning of the data.

Specified by:

getInputStream in interface javax.activation.DataSource

Specified by:

getInputStream in class AbstractDataSource

Returns:

An input stream

Throws:

java.io.IOException - If an error occurred

java.lang.NullPointerException - If the loaded content is null

Since:

1.6

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

This method returns an OutputStream where the data can be written and throws the appropriate exception if it can not do so

Note that a new OutputStream object must be returned each time this method is called, and the stream must be positioned at the location the data is to be written.

Specified by:

getOutputStream in interface javax.activation.DataSource

Specified by:

getOutputStream in class AbstractDataSource

Returns:

An output stream

Throws:

java.io.IOException - If an error occurred

Since:

1.6

finish

public void finish(java.io.OutputStream ostream)
            throws java.io.IOException

After the data has been written to the output stream it is flushed, closed and updated here.

Specified by:

finish in class AbstractDataSource

Parameters:

ostream - An output stream

Throws:

java.io.IOException - If an error occurred

Since:

1.6

getURL

public org.apache.commons.vfs2.FileObject getURL()

Provides the file object.

Returns:

A network file, may be null

Since:

1.6

setURL

public void setURL(org.apache.commons.vfs2.FileObject url)

Sets a new file reference (e.g. after save as".

Parameters:

url - The network file

Since:

1.6

getIcon

public javax.swing.Icon getIcon()

Provides the data source specific icon (optional).

Specified by:

getIcon in class AbstractDataSource

Returns:

An icon, may be null

Since:

1.6

configureUnit

public void configureUnit(java.lang.String id,
                 Configuration config)

Restores values from persistent data stores.

Specified by:

configureUnit in interface ConfigurableUnit

Overrides:

configureUnit in class AbstractDataSource

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeUnit

public void storeUnit(java.lang.String id,
             Configuration config)

Stores the current configuration values persistently.

Specified by:

storeUnit in interface ConfigurableUnit

Overrides:

storeUnit in class AbstractDataSource

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

unitRegistered

public void unitRegistered(ApplicationModel model,
                  java.lang.String id)

Informs the configurable unit that it was registered with a model.

Specified by:

unitRegistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

unitUnregistered

public void unitUnregistered(ApplicationModel model,
                    java.lang.String id)

Informs the configurable unit that it was unregistered with a model.

Specified by:

unitUnregistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

getPath

public java.lang.String getPath()

Provides the path for this data source.

Overwritten to avoid connection credentials to be displayed by the GUI.

Overrides:

getPath in class AbstractDataSource

Returns:

The path

Since:

1.6

getConnection

public VFSConnection getConnection()

Provides the VFS connection (optional).

Returns:

The connection, null otherwise

Since:

1.6