org.apache.sling.distribution.packaging.impl

Class ReferencePackage

java.lang.Object

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

org.apache.sling.distribution.packaging.impl.ReferencePackage

All Implemented Interfaces:

DistributionPackage, SharedDistributionPackage

public class ReferencePackage
extends AbstractDistributionPackage

A reference package wraps an actual DistributionPackage providing a reference to it by its DistributionPackage.getId().

Field Summary

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

PACKAGES_ROOT

Constructor Summary

Constructors

Constructor and Description
ReferencePackage(DistributionPackage distributionPackage)

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
InputStream	createInputStream() creates a package stream.
void	delete() releases all resources associated with this package
String	getDigestAlgorithm()
String	getDigestMessage()
String	getId() get package id.
long	getSize()
String	getType() get the type of package
static String	idFromReference(String reference)
static boolean	isReference(String string)
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

getInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferencePackage

public ReferencePackage(DistributionPackage distributionPackage)

Method Detail

acquire

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

Description copied from interface: SharedDistributionPackage

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

release

public void release(@Nonnull
                    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.

createInputStream

@Nonnull
public 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

getType

@Nonnull
public String getType()

Description copied from interface: DistributionPackage

get the type of package

Specified by:

getType in interface DistributionPackage

Overrides:

getType in class AbstractDistributionPackage

Returns:

the package type

getId

@Nonnull
public String getId()

Description copied from interface: DistributionPackage

get package id. the id is a unique string that can be used to identify the package

Specified by:

getId in interface DistributionPackage

Overrides:

getId in class AbstractDistributionPackage

Returns:

the package id

getDigestAlgorithm

@Nullable
public String getDigestAlgorithm()

Overrides:

getDigestAlgorithm in class AbstractDistributionPackage

getDigestMessage

public String getDigestMessage()

Overrides:

getDigestMessage in class AbstractDistributionPackage

isReference

public static boolean isReference(String string)

idFromReference

@CheckForNull
public static String idFromReference(String reference)