com.exalead.mercury.mami.search.v20

Class ThumbnailsCache

java.lang.Object

com.exalead.mercury.mami.search.v20.ThumbnailsCache

All Implemented Interfaces:

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

Direct Known Subclasses:

LocalThumbnailsCache

public abstract class ThumbnailsCache
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Cache for thumbnails computed on the fly

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_HEIGHT
static int	DEFAULT_MAX_WIDTH
static boolean	DEFAULT_SECURE
int	maxHeight
int	maxWidth
boolean	secure

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ThumbnailsCache.
static ThumbnailsCache	fromString(java.lang.String s) String representation of this ThumbnailsCache.
int	getMaxHeight() Maximum height of thumbnails for them to be cacheable
int	getMaxWidth() Maximum width of thumbnails for them to be cacheable
boolean	isSecure() Thumbnails are only cached and retrieved if enforce_security is set to false for the request. If false, thumbnails are always cached and retrieved. Warning: any logged user knowing the URL of a document could then retrieve a thumbnail for it.
ThumbnailsCache	makeCopy()
static ThumbnailsCache	readFrom(java.io.InputStream is) Read this ThumbnailsCache from an XML fragment.
void	setMaxHeight(int maxHeight) Maximum height of thumbnails for them to be cacheable
void	setMaxWidth(int maxWidth) Maximum width of thumbnails for them to be cacheable
void	setSecure(boolean secure) Thumbnails are only cached and retrieved if enforce_security is set to false for the request. If false, thumbnails are always cached and retrieved. Warning: any logged user knowing the URL of a document could then retrieve a thumbnail for it.
java.lang.String	toString() String representation of this ThumbnailsCache.
ThumbnailsCache	withMaxHeight(int maxHeight)
ThumbnailsCache	withMaxHeight(java.lang.Integer maxHeight)
ThumbnailsCache	withMaxWidth(int maxWidth)
ThumbnailsCache	withMaxWidth(java.lang.Integer maxWidth)
ThumbnailsCache	withSecure(boolean secure)
ThumbnailsCache	withSecure(java.lang.Boolean secure)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

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

Field Detail

secure

public boolean secure

DEFAULT_SECURE

public static final boolean DEFAULT_SECURE

See Also:

Constant Field Values

maxHeight

public int maxHeight

DEFAULT_MAX_HEIGHT

public static final int DEFAULT_MAX_HEIGHT

See Also:

Constant Field Values

maxWidth

public int maxWidth

DEFAULT_MAX_WIDTH

public static final int DEFAULT_MAX_WIDTH

See Also:

Constant Field Values

Constructor Detail

ThumbnailsCache

public ThumbnailsCache()

ThumbnailsCache

public ThumbnailsCache(ThumbnailsCache o)

Copy constructor

Method Detail

setSecure

public void setSecure(boolean secure)

Thumbnails are only cached and retrieved if enforce_security is set to false for the request.
If false, thumbnails are always cached and retrieved.
Warning: any logged user knowing the URL of a document could then retrieve a thumbnail for it.

isSecure

public boolean isSecure()

Thumbnails are only cached and retrieved if enforce_security is set to false for the request.
If false, thumbnails are always cached and retrieved.
Warning: any logged user knowing the URL of a document could then retrieve a thumbnail for it.

withSecure

public ThumbnailsCache withSecure(boolean secure)

withSecure

public ThumbnailsCache withSecure(java.lang.Boolean secure)

setMaxHeight

public void setMaxHeight(int maxHeight)

Maximum height of thumbnails for them to be cacheable

getMaxHeight

public int getMaxHeight()

Maximum height of thumbnails for them to be cacheable

withMaxHeight

public ThumbnailsCache withMaxHeight(int maxHeight)

withMaxHeight

public ThumbnailsCache withMaxHeight(java.lang.Integer maxHeight)

setMaxWidth

public void setMaxWidth(int maxWidth)

Maximum width of thumbnails for them to be cacheable

getMaxWidth

public int getMaxWidth()

Maximum width of thumbnails for them to be cacheable

withMaxWidth

public ThumbnailsCache withMaxWidth(int maxWidth)

withMaxWidth

public ThumbnailsCache withMaxWidth(java.lang.Integer maxWidth)

makeCopy

public ThumbnailsCache makeCopy()

readFrom

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

Read this ThumbnailsCache 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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ThumbnailsCache.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ThumbnailsCache.

Overrides:

toString in class java.lang.Object

check

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

Checks this ThumbnailsCache.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException