com.day.jcr.vault.fs

Class DirectoryArtifact

java.lang.Object

com.day.jcr.vault.fs.DirectoryArtifact

All Implemented Interfaces:

Artifact, Dumpable, ExportArtifact, ImportArtifact

public class DirectoryArtifact
extends Object
implements ExportArtifact, ImportArtifact

Implements a generic directory artifact.

Constructor Summary

Constructors

Constructor and Description
DirectoryArtifact(String name) Constructs a new directory type artifact with the given repository name.
DirectoryArtifact(String name, String extension) Constructs a new directory type artifact with the given repository name and extension

Method Summary

Modifier and Type	Method and Description
void	dump(DumpContext ctx, boolean isLast) Dumps some human readable information using the given context.
long	getContentLength() Returns the length of the serialized data if it's known without doing the actual serialization.
String	getContentType() Returns the content type of the serialized data or null if the type is not known or cannot be determined.
String	getExtension() Returns the (repository) extension of this artifact.
VaultInputSource	getInputSource() Returns an input source to the contents of this artifact.
InputStream	getInputStream() Returns the input stream to the contents of this artifact.
long	getLastModified() Returns the last modified date or 0 if not known.
String	getPlatformPath() Returns the relative path of this artifact in platform format including the extension.
AccessType	getPreferredAccess() Returns the preferred access value for this artifact.
String	getRelativePath() Returns the relative (repository) path of this artifact in respect to it's parent node.
SerializationType	getSerializationType() Returns the serialization type of this artifact.
ArtifactType	getType() Returns the type of this artifact.
void	spool(OutputStream out) Writes the content to the given output stream and closes it afterwards.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryArtifact

public DirectoryArtifact(String name)

Constructs a new directory type artifact with the given repository name.

Parameters:

name - the repository name for this artifact.

DirectoryArtifact

public DirectoryArtifact(String name,
                         String extension)

Constructs a new directory type artifact with the given repository name and extension

Parameters:

name - the repository name for this artifact.

extension - the extension for this artifact

Method Detail

getSerializationType

public SerializationType getSerializationType()

Returns the serialization type of this artifact.

Specified by:

getSerializationType in interface Artifact

Returns:

the serialization type of this artifact.

getPreferredAccess

public AccessType getPreferredAccess()

Returns the preferred access value for this artifact.

Specified by:

getPreferredAccess in interface Artifact

Returns:

always AccessType.NONE

spool

public void spool(OutputStream out)
           throws IOException,
                  RepositoryException

Writes the content to the given output stream and closes it afterwards. This is the preferred method to use for output-artifacts.

Specified by:

spool in interface Artifact

Parameters:

out - the output stream to spool to

Throws:

IOException - if an I/O error occurs

RepositoryException - if a repository error occurs

getInputStream

public InputStream getInputStream()
                           throws IOException,
                                  RepositoryException

Returns the input stream to the contents of this artifact. This is the preferred method to use for input-artifacts.

Specified by:

getInputStream in interface Artifact

Returns:

a input stream to the contents of this artifact.

Throws:

IOException - if an I/O error occurs

RepositoryException - if a repository error occurs

getInputSource

public VaultInputSource getInputSource()
                                throws IOException,
                                       RepositoryException

Returns an input source to the contents of this artifact. This is also preferred for AccessType.STREAM.

Specified by:

getInputSource in interface Artifact

Returns:

an input source.

Throws:

IOException - if an I/O error occurs.

RepositoryException - of a repository error occurs.

getContentLength

public long getContentLength()

Returns the length of the serialized data if it's known without doing the actual serialization.

Specified by:

getContentLength in interface Artifact

Returns:

the length or -1 if the length cannot be determined.

getLastModified

public long getLastModified()

Returns the last modified date or 0 if not known.

Specified by:

getLastModified in interface Artifact

Returns:

the last modified date or 0

getPlatformPath

public String getPlatformPath()

Description copied from interface: Artifact

Returns the relative path of this artifact in platform format including the extension. eg: "_cq_nodeType.cnd" or "en/.content.xml" and eventual intermediate extensions. eg: "image.png.dir/.content.xml"

Specified by:

getPlatformPath in interface Artifact

Returns:

the relative platform path

getExtension

public String getExtension()

Description copied from interface: Artifact

Returns the (repository) extension of this artifact. eg: ".jsp"

Specified by:

getExtension in interface Artifact

Returns:

the (repository) extension of this artifact.

getRelativePath

public String getRelativePath()

Description copied from interface: Artifact

Returns the relative (repository) path of this artifact in respect to it's parent node. eg: "myNodeType"

Specified by:

getRelativePath in interface Artifact

Returns:

the final name

getType

public ArtifactType getType()

Description copied from interface: Artifact

Returns the type of this artifact.

Specified by:

getType in interface Artifact

Returns:

the type of this artifact.

getContentType

public String getContentType()

Description copied from interface: Artifact

Returns the content type of the serialized data or null if the type is not known or cannot be determined.

Specified by:

getContentType in interface Artifact

Returns:

the content type or null.

dump

public void dump(DumpContext ctx,
                 boolean isLast)

Description copied from interface: Dumpable

Dumps some human readable information using the given context.

Specified by:

dump in interface Dumpable

Parameters:

ctx - the dump context

isLast - specifies if this is the last element to dump on this level