sirius.biz.jdbc.storage

Class DownloadBuilder

java.lang.Object

sirius.biz.jdbc.storage.DownloadBuilder

public class DownloadBuilder
extends Object

Represents a builder for download URLs for stored objects.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DownloadBuilder(Storage storage, String bucket, String objectKey) Creates a new builder with a direct reference to the storage and the object key.
protected	DownloadBuilder(Storage storage, VirtualObject object) Creates a new builder with a direct reference to the storage and the object.

Method Summary

Modifier and Type	Method and Description
DownloadBuilder	asDownload(String filename) Make the URL a downlod url using the given filename.
Optional<String>	buildURL() Builds the effective URL according to the parameters specified wrapped in an Optional.
DownloadBuilder	eternallyValid() Makes this URL eternally valid (authenticated).
String	getAddonText()
String	getBaseURL()
String	getBucket()
String	getFileExtension()
String	getFilename()
String	getObjectKey()
String	getPhysicalKey()
boolean	isEternallyValid()
DownloadBuilder	withAddonText(String text) Permits to add additional text to the URL which is ignored by the storage layer.
DownloadBuilder	withBaseURL(String baseURL) Specifies the base URL to use.
DownloadBuilder	withFileExtension(String fileExtension) Specifies the file extension to append to the URL.
DownloadBuilder	withVersion(String version) Specifies the version of the file to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadBuilder

protected DownloadBuilder(Storage storage,
                          String bucket,
                          String objectKey)

Creates a new builder with a direct reference to the storage and the object key.

Parameters:

storage - the storage implementation

bucket - the bucket in which the object is placed

objectKey - the object key to download

DownloadBuilder

protected DownloadBuilder(Storage storage,
                          VirtualObject object)

Creates a new builder with a direct reference to the storage and the object.

Parameters:

storage - the storage implementation

object - the object key download

Method Detail

withFileExtension

public DownloadBuilder withFileExtension(String fileExtension)

Specifies the file extension to append to the URL.

Parameters:

fileExtension - the extension to append

Returns:

the builder itself for fluent method calls

withVersion

public DownloadBuilder withVersion(String version)

Specifies the version of the file to use.

The syntax is a comma separated string of key-value pairs in the form of key:value. The available keys are size for the requested maximum size, min for the minimum size and imageFormat for the imageFormat. The value for the size key has to be in the format <width>x<height>.

If no external command line command is setup for the image conversion only "png" and "jpg" are supported as formats. The Default version which is used is the jpg format.

Example: The version size:500x500,min:100x100,imageFormat:png would scale an image with 1000x800 pixels to 500x400. An image with 1000x150 would be scaled to 500x75 and then extended with a white border to 500x100. An image with 400x50 pixels would not be scaled but extended to 400x100. All files would be in png format.

Parameters:

version - the name of the version to use

Returns:

the builder itself for fluent method calls

asDownload

public DownloadBuilder asDownload(String filename)

Make the URL a downlod url using the given filename.

Parameters:

filename - the filename to send to the browser

Returns:

the builder itself for fluent method calls

withBaseURL

public DownloadBuilder withBaseURL(String baseURL)

Specifies the base URL to use.

Parameters:

baseURL - the base URL to use

Returns:

the builder itself for fluent method calls

eternallyValid

public DownloadBuilder eternallyValid()

Makes this URL eternally valid (authenticated).

Returns:

the builder itself for fluent method calls

withAddonText

public DownloadBuilder withAddonText(String text)

Permits to add additional text to the URL which is ignored by the storage layer.

This might be used to add SEO texts for image URLs...

Parameters:

text - the text to include in the URL (will be escaped properly).

Returns:

the builder itself for fluent method calls

buildURL

public Optional<String> buildURL()

Builds the effective URL according to the parameters specified wrapped in an Optional.

Optional.empty() is returned when the file cannot be found in the storage engine.

Returns:

the url generated by this builder wrapped in an Optional or Optional.empty() if no file was found in the storage engine

getObjectKey

public String getObjectKey()

getFileExtension

public String getFileExtension()

getFilename

public String getFilename()

getBaseURL

public String getBaseURL()

getPhysicalKey

public String getPhysicalKey()

getBucket

public String getBucket()

isEternallyValid

public boolean isEternallyValid()

getAddonText

public String getAddonText()