org.apache.sling.distribution.packaging.impl

Class FileDistributionPackage

java.lang.Object

org.apache.sling.distribution.packaging.impl.AbstractDistributionPackage

org.apache.sling.distribution.packaging.impl.FileDistributionPackage

All Implemented Interfaces:

DistributionPackage, SharedDistributionPackage

public class FileDistributionPackage
extends AbstractDistributionPackage

A DistributionPackage based on a File.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FileDistributionPackage.PackageInputStream

Field Summary

Fields inherited from class org.apache.sling.distribution.packaging.impl.AbstractDistributionPackage

PACKAGES_ROOT

Constructor Summary

Constructors

Constructor and Description
FileDistributionPackage(@NotNull File file, @NotNull String type, @Nullable String digestAlgorithm, @Nullable String digestMessage)

Method Summary

Modifier and Type	Method and Description
void	acquire(String... holderNames) acquire a reference to this package and increase the reference count.
void	close() closes all resources associated with this instance
@NotNull InputStream	createInputStream() creates a package stream.
void	delete() releases all resources associated with this package
File	getFile()
long	getSize()
void	release(String... holderNames) release a reference to this package and decrease the reference count.

Methods inherited from class org.apache.sling.distribution.packaging.impl.AbstractDistributionPackage

getDigestAlgorithm, getDigestMessage, getId, getInfo, getType

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDistributionPackage

public FileDistributionPackage(@NotNull
                               @NotNull File file,
                               @NotNull
                               @NotNull String type,
                               @Nullable
                               @Nullable String digestAlgorithm,
                               @Nullable
                               @Nullable String digestMessage)

Method Detail

createInputStream

@NotNull
public @NotNull InputStream createInputStream()
                                                throws IOException

Description copied from interface: DistributionPackage

creates a package stream. a new stream is created for each call and it is the caller's obligation to close the stream.

Returns:

an InputStream

Throws:

IOException

getSize

public long getSize()

Returns:

the size in bytes

close

public void close()

Description copied from interface: DistributionPackage

closes all resources associated with this instance

delete

public void delete()

Description copied from interface: DistributionPackage

releases all resources associated with this package

getFile

public File getFile()

acquire

public void acquire(@NotNull
                    String... holderNames)

Description copied from interface: SharedDistributionPackage

acquire a reference to this package and increase the reference count.

release

public void release(@NotNull
                    String... holderNames)

Description copied from interface: SharedDistributionPackage

release a reference to this package and decrease the reference count. when no more references are hold the package DistributionPackage#delete method will be invoked.