com.exalead.mercury.mami.search.v20

Class ThumbnailCommand

java.lang.Object

com.exalead.mercury.mami.search.v20.Command

com.exalead.mercury.mami.search.v20.BaseFetchCommand

com.exalead.mercury.mami.search.v20.ThumbnailCommand

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class ThumbnailCommand
extends BaseFetchCommand
implements com.exalead.util.Checkable, java.io.Serializable

Abstract class for a fetch command.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.search.v20.BaseFetchCommand

BaseFetchCommand.Transformer<T>, BaseFetchCommand.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowUnsecurePrecomputedThumbnails
java.lang.String	convertAddresses
static boolean	DEFAULT_ALLOW_UNSECURE_PRECOMPUTED_THUMBNAILS
static int	DEFAULT_DEFAULT_HEIGHT
static int	DEFAULT_DEFAULT_WIDTH
static int	DEFAULT_MAX_CONCURRENT_COMPUTATIONS
int	defaultHeight
int	defaultWidth
int	maxConcurrentComputations
ThumbnailsCache	thumbnailsCache

Fields inherited from class com.exalead.mercury.mami.search.v20.Command

base, DEFAULT_BASE

Constructor Summary

Constructors

Constructor and Description
ThumbnailCommand()
ThumbnailCommand(ThumbnailCommand o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(BaseFetchCommand.Transformer<T> transformer, T[] t)
void	accept(BaseFetchCommand.Visitor visitor)
<T> T	accept(Command.Transformer<T> transformer, T[] t)
void	accept(Command.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this ThumbnailCommand.
static ThumbnailCommand	fromString(java.lang.String s) String representation of this ThumbnailCommand.
java.lang.String	getConvertAddresses() Semicolon separated list of convert instance names or urls to use.
int	getDefaultHeight() Height of the computed thumbnail, if not specified in request
int	getDefaultWidth() Width of the computed thumbnail, if not specified in request
int	getMaxConcurrentComputations() Maximum number of concurrent thumbnail computations. Thumbnail queries that do not require a computation (cache hits) are not considered.
ThumbnailsCache	getThumbnailsCache() Cache for the thumbnails computed on the fly
boolean	isAllowUnsecurePrecomputedThumbnails() When security is enforced on the fetch request, should a precomputed thumbnail be returned, if any. Security is not enforced on precomputed thumbnails: any logged user knowing the URL of a document could retrieve its precomputed thumbnail.
ThumbnailCommand	makeCopy() Creates and returns a deep copy of this ThumbnailCommand.
static ThumbnailCommand	readFrom(java.io.InputStream is) Read this ThumbnailCommand from an XML fragment.
void	setAllowUnsecurePrecomputedThumbnails(boolean allowUnsecurePrecomputedThumbnails) When security is enforced on the fetch request, should a precomputed thumbnail be returned, if any. Security is not enforced on precomputed thumbnails: any logged user knowing the URL of a document could retrieve its precomputed thumbnail.
void	setConvertAddresses(java.lang.String convertAddresses) Semicolon separated list of convert instance names or urls to use.
void	setDefaultHeight(int defaultHeight) Height of the computed thumbnail, if not specified in request
void	setDefaultWidth(int defaultWidth) Width of the computed thumbnail, if not specified in request
void	setMaxConcurrentComputations(int maxConcurrentComputations) Maximum number of concurrent thumbnail computations. Thumbnail queries that do not require a computation (cache hits) are not considered.
void	setThumbnailsCache(ThumbnailsCache thumbnailsCache) Cache for the thumbnails computed on the fly
java.lang.String	toString() String representation of this ThumbnailCommand.
ThumbnailCommand	withAllowUnsecurePrecomputedThumbnails(boolean allowUnsecurePrecomputedThumbnails)
ThumbnailCommand	withAllowUnsecurePrecomputedThumbnails(java.lang.Boolean allowUnsecurePrecomputedThumbnails)
ThumbnailCommand	withBase(java.lang.String base)
ThumbnailCommand	withConvertAddresses(java.lang.String convertAddresses)
ThumbnailCommand	withDefaultHeight(int defaultHeight)
ThumbnailCommand	withDefaultHeight(java.lang.Integer defaultHeight)
ThumbnailCommand	withDefaultWidth(int defaultWidth)
ThumbnailCommand	withDefaultWidth(java.lang.Integer defaultWidth)
ThumbnailCommand	withMaxConcurrentComputations(int maxConcurrentComputations)
ThumbnailCommand	withMaxConcurrentComputations(java.lang.Integer maxConcurrentComputations)
ThumbnailCommand	withThumbnailsCache(ThumbnailsCache thumbnailsCache)
void	writeTo(java.io.OutputStream os) Write this ThumbnailCommand as an XML fragment

Methods inherited from class com.exalead.mercury.mami.search.v20.Command

getBase, setBase

Methods inherited from class java.lang.Object

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

Field Detail

maxConcurrentComputations

public int maxConcurrentComputations

DEFAULT_MAX_CONCURRENT_COMPUTATIONS

public static final int DEFAULT_MAX_CONCURRENT_COMPUTATIONS

See Also:

Constant Field Values

defaultWidth

public int defaultWidth

DEFAULT_DEFAULT_WIDTH

public static final int DEFAULT_DEFAULT_WIDTH

See Also:

Constant Field Values

defaultHeight

public int defaultHeight

DEFAULT_DEFAULT_HEIGHT

public static final int DEFAULT_DEFAULT_HEIGHT

See Also:

Constant Field Values

thumbnailsCache

public ThumbnailsCache thumbnailsCache

allowUnsecurePrecomputedThumbnails

public boolean allowUnsecurePrecomputedThumbnails

DEFAULT_ALLOW_UNSECURE_PRECOMPUTED_THUMBNAILS

public static final boolean DEFAULT_ALLOW_UNSECURE_PRECOMPUTED_THUMBNAILS

See Also:

Constant Field Values

convertAddresses

public java.lang.String convertAddresses

Constructor Detail

ThumbnailCommand

public ThumbnailCommand()

ThumbnailCommand

public ThumbnailCommand(ThumbnailCommand o)

Copy constructor

Method Detail

withBase

public ThumbnailCommand withBase(java.lang.String base)

Overrides:

withBase in class BaseFetchCommand

setMaxConcurrentComputations

public void setMaxConcurrentComputations(int maxConcurrentComputations)

Maximum number of concurrent thumbnail computations.
Thumbnail queries that do not require a computation (cache hits) are not considered.

getMaxConcurrentComputations

public int getMaxConcurrentComputations()

Maximum number of concurrent thumbnail computations.
Thumbnail queries that do not require a computation (cache hits) are not considered.

withMaxConcurrentComputations

public ThumbnailCommand withMaxConcurrentComputations(int maxConcurrentComputations)

withMaxConcurrentComputations

public ThumbnailCommand withMaxConcurrentComputations(java.lang.Integer maxConcurrentComputations)

setDefaultWidth

public void setDefaultWidth(int defaultWidth)

Width of the computed thumbnail, if not specified in request

getDefaultWidth

public int getDefaultWidth()

Width of the computed thumbnail, if not specified in request

withDefaultWidth

public ThumbnailCommand withDefaultWidth(int defaultWidth)

withDefaultWidth

public ThumbnailCommand withDefaultWidth(java.lang.Integer defaultWidth)

setDefaultHeight

public void setDefaultHeight(int defaultHeight)

Height of the computed thumbnail, if not specified in request

getDefaultHeight

public int getDefaultHeight()

Height of the computed thumbnail, if not specified in request

withDefaultHeight

public ThumbnailCommand withDefaultHeight(int defaultHeight)

withDefaultHeight

public ThumbnailCommand withDefaultHeight(java.lang.Integer defaultHeight)

setThumbnailsCache

public void setThumbnailsCache(ThumbnailsCache thumbnailsCache)

Cache for the thumbnails computed on the fly

getThumbnailsCache

public ThumbnailsCache getThumbnailsCache()

Cache for the thumbnails computed on the fly

withThumbnailsCache

public ThumbnailCommand withThumbnailsCache(ThumbnailsCache thumbnailsCache)

setAllowUnsecurePrecomputedThumbnails

public void setAllowUnsecurePrecomputedThumbnails(boolean allowUnsecurePrecomputedThumbnails)

When security is enforced on the fetch request, should a precomputed thumbnail
be returned, if any.

Security is not enforced on precomputed thumbnails: any logged user
knowing the URL of a document could retrieve its precomputed thumbnail.

isAllowUnsecurePrecomputedThumbnails

public boolean isAllowUnsecurePrecomputedThumbnails()

When security is enforced on the fetch request, should a precomputed thumbnail
be returned, if any.

Security is not enforced on precomputed thumbnails: any logged user
knowing the URL of a document could retrieve its precomputed thumbnail.

withAllowUnsecurePrecomputedThumbnails

public ThumbnailCommand withAllowUnsecurePrecomputedThumbnails(boolean allowUnsecurePrecomputedThumbnails)

withAllowUnsecurePrecomputedThumbnails

public ThumbnailCommand withAllowUnsecurePrecomputedThumbnails(java.lang.Boolean allowUnsecurePrecomputedThumbnails)

setConvertAddresses

public void setConvertAddresses(java.lang.String convertAddresses)

Semicolon separated list of convert instance names or urls to use.

getConvertAddresses

public java.lang.String getConvertAddresses()

Semicolon separated list of convert instance names or urls to use.

withConvertAddresses

public ThumbnailCommand withConvertAddresses(java.lang.String convertAddresses)

makeCopy

public ThumbnailCommand makeCopy()

Creates and returns a deep copy of this ThumbnailCommand.

Overrides:

makeCopy in class BaseFetchCommand

readFrom

public static ThumbnailCommand readFrom(java.io.InputStream is)
                                 throws javax.xml.bind.JAXBException

Read this ThumbnailCommand from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this ThumbnailCommand as an XML fragment

Overrides:

writeTo in class BaseFetchCommand

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static ThumbnailCommand fromString(java.lang.String s)
                                   throws javax.xml.bind.JAXBException,
                                          java.io.UnsupportedEncodingException

String representation of this ThumbnailCommand.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ThumbnailCommand.

Overrides:

toString in class BaseFetchCommand

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this ThumbnailCommand.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class BaseFetchCommand

Throws:

com.exalead.util.TypedException

accept

public void accept(BaseFetchCommand.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class BaseFetchCommand

Throws:

com.exalead.util.TypedException

accept

public void accept(Command.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class Command

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(BaseFetchCommand.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class BaseFetchCommand

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(Command.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class Command

Throws:

com.exalead.util.TypedException