org.apache.sling.distribution.packaging.impl

Class DistributionPackageWrapper

java.lang.Object

org.apache.sling.distribution.packaging.impl.DistributionPackageWrapper

All Implemented Interfaces:

DistributionPackage

public class DistributionPackageWrapper
extends Object
implements DistributionPackage

Package wrapper meant to be extended and provide just simple overridden methods.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DistributionPackageWrapper(DistributionPackage wrappedPackage)

Method Summary

Modifier and Type	Method and Description
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
@NotNull String	getId() get package id.
@NotNull DistributionPackageInfo	getInfo() gets an additional info holder for this package.
long	getSize()
@NotNull String	getType() get the type of package
DistributionPackage	getWrappedPackage()

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributionPackageWrapper

protected DistributionPackageWrapper(DistributionPackage wrappedPackage)

Method Detail

getId

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

Returns:

the package id

getType

@NotNull
public @NotNull String getType()

Description copied from interface: DistributionPackage

get the type of package

Specified by:

getType in interface DistributionPackage

Returns:

the package type

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.

Specified by:

createInputStream in interface DistributionPackage

Returns:

an InputStream

Throws:

IOException

getSize

public long getSize()

Specified by:

getSize in interface DistributionPackage

Returns:

the size in bytes

close

public void close()

Description copied from interface: DistributionPackage

closes all resources associated with this instance

Specified by:

close in interface DistributionPackage

delete

public void delete()

Description copied from interface: DistributionPackage

releases all resources associated with this package

Specified by:

delete in interface DistributionPackage

getInfo

@NotNull
public @NotNull DistributionPackageInfo getInfo()

Description copied from interface: DistributionPackage

gets an additional info holder for this package. The additional info object contains control information rather than content information. For example info.origin can be used to skip distributing back to the originating endpoint.

Specified by:

getInfo in interface DistributionPackage

Returns:

the associated metadata to this package

getWrappedPackage

public DistributionPackage getWrappedPackage()