Package org.ametys.core.util.path

Class PathSource

java.lang.Object

org.ametys.core.util.path.PathSource

All Implemented Interfaces:

ModifiableSource, ModifiableTraversableSource, MoveableSource, Source, TraversableSource

Direct Known Subclasses:

SkinSource

public class PathSource
extends Object
implements ModifiableTraversableSource, MoveableSource

A ModifiableTraversableSource for path objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	PathSource.PathSourceOutputStream	A file outputStream that will rename the temp file to the destination file upon close() and discard the temp file upon cancel().

Field Summary

Fields

Modifier and Type	Field	Description
protected Path	_path	The file
protected String	_scheme	The scheme
protected String	_uri	The URI of this source

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PathSource()	Empty constructor
	PathSource(String uri)	Builds a PathSource given an URI, which doesn't necessarily have to start with "file:"
	PathSource(String scheme, String uri, Path path)	Builds a PathSource, given an URI scheme, URI and a Path.
	PathSource(String scheme, Path path)	Builds a PathSource, given an URI scheme and a Path.

Method Summary

Modifier and Type	Method	Description
boolean	canCancel(OutputStream stream)	Can the data sent to an OutputStream returned by getOutputStream() be cancelled ?
void	cancel(OutputStream stream)	Cancel the data sent to an OutputStream returned by getOutputStream().
void	copyTo(Source destination)
void	delete()	Delete the source.
boolean	exists()
Source	getChild(String name)
Collection	getChildren()
long	getContentLength()
Path	getFile()	Get the associated file
InputStream	getInputStream()
long	getLastModified()
String	getMimeType()
String	getName()
OutputStream	getOutputStream()	Get an InputStream where raw bytes can be written to.
Source	getParent()
String	getScheme()
String	getURI()
SourceValidity	getValidity()
private void	init(String scheme, Path path)
boolean	isCollection()
void	makeCollection()
void	moveTo(Source destination)
void	refresh()

Methods inherited from class java.lang.Object

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

Field Detail

_path

protected Path _path

The file

_scheme

protected String _scheme

The scheme

_uri

protected String _uri

The URI of this source

Constructor Detail

PathSource

protected PathSource()

Empty constructor

PathSource

public PathSource(String uri)
           throws SourceException,
                  MalformedURLException

Builds a PathSource given an URI, which doesn't necessarily have to start with "file:"

Parameters:

uri - The filURI

Throws:

SourceException - If URL cannot be created

MalformedURLException - If URL is malformed

PathSource

public PathSource(String scheme,
                  Path path)
           throws SourceException

Builds a PathSource, given an URI scheme and a Path.

Parameters:

scheme - The scheme

path - The file

Throws:

SourceException - If url cannot be created

PathSource

public PathSource(String scheme,
                  String uri,
                  Path path)

Builds a PathSource, given an URI scheme, URI and a Path.

Parameters:

scheme - The scheme

uri - the URI

path - The file

Method Detail

init

private void init(String scheme,
                  Path path)
           throws SourceException

Throws:

SourceException

getFile

public Path getFile()

Get the associated file

Returns:

The underlying path

getContentLength

public long getContentLength()

Specified by:

getContentLength in interface Source

getInputStream

public InputStream getInputStream()
                           throws IOException,
                                  SourceNotFoundException

Specified by:

getInputStream in interface Source

Throws:

IOException

SourceNotFoundException

getLastModified

public long getLastModified()

Specified by:

getLastModified in interface Source

getMimeType

public String getMimeType()

Specified by:

getMimeType in interface Source

getScheme

public String getScheme()

Specified by:

getScheme in interface Source

getURI

public String getURI()

Specified by:

getURI in interface Source

getValidity

public SourceValidity getValidity()

Specified by:

getValidity in interface Source

refresh

public void refresh()

Specified by:

refresh in interface Source

exists

public boolean exists()

Specified by:

exists in interface Source

getChild

public Source getChild(String name)
                throws SourceException

Specified by:

getChild in interface TraversableSource

Throws:

SourceException

getChildren

public Collection getChildren()
                       throws SourceException

Specified by:

getChildren in interface TraversableSource

Throws:

SourceException

getName

public String getName()

Specified by:

getName in interface TraversableSource

getParent

public Source getParent()
                 throws SourceException

Specified by:

getParent in interface TraversableSource

Throws:

SourceException

isCollection

public boolean isCollection()

Specified by:

isCollection in interface TraversableSource

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Get an InputStream where raw bytes can be written to. The signification of these bytes is implementation-dependent and is not restricted to a serialized XML document. The output stream returned actually writes to a temp file that replaces the real one on close. This temp file is used as lock to forbid multiple simultaneous writes. The real file is updated atomically when the output stream is closed. The returned stream must be closed or cancelled by the calling code.

Specified by:

getOutputStream in interface ModifiableSource

Returns:

a stream to write to

Throws:

ConcurrentModificationException - if another thread is currently writing to this file.

IOException

canCancel

public boolean canCancel(OutputStream stream)

Can the data sent to an OutputStream returned by getOutputStream() be cancelled ?

Specified by:

canCancel in interface ModifiableSource

Returns:

true if the stream can be cancelled

cancel

public void cancel(OutputStream stream)
            throws SourceException

Cancel the data sent to an OutputStream returned by getOutputStream().

After cancel, the stream should no more be used.

Specified by:

cancel in interface ModifiableSource

Throws:

SourceException

delete

public void delete()
            throws SourceException

Delete the source.

Specified by:

delete in interface ModifiableSource

Throws:

SourceException

makeCollection

public void makeCollection()
                    throws SourceException

Specified by:

makeCollection in interface ModifiableTraversableSource

Throws:

SourceException

copyTo

public void copyTo(Source destination)
            throws SourceException

Specified by:

copyTo in interface MoveableSource

Throws:

SourceException

moveTo

public void moveTo(Source destination)
            throws SourceException

Specified by:

moveTo in interface MoveableSource

Throws:

SourceException