Package com.exedio.cope.pattern

Class MediaPath

java.lang.Object

com.exedio.cope.Feature

com.exedio.cope.Pattern

com.exedio.cope.pattern.MediaPath

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Media, MediaFilter, MediaRedirect

public abstract class MediaPath
extends Pattern

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	MediaPath.Locator	Represents a resource to be delivered the media servlet.
static final class	MediaPath.Log	Deprecated.
static final class	MediaPath.NotFound

Constructor Summary

Constructors

Constructor	Description
MediaPath()

Method Summary

Modifier and Type	Method	Description
protected final void	commit()
abstract void	doGetAndCommit(HttpServletRequest request, HttpServletResponse response, Item item)	The implementor MUST commit the transaction, if the method completes normally (without exception).
abstract String	getContentType(Item item)
final List<MediaRequestLog>	getExceptionLogs()
final List<MediaRequestLog>	getGuessedUrlLogs()
final MediaInfo	getInfo()
final List<MediaRequestLog>	getInvalidSpecialLogs()
final List<MediaRequestLog>	getIsNullLogs()
Date	getLastModified(Item item)	The default implementation returns null.
final MediaPath.Locator	getLocator(Item item)	Returns a locator the content of this media path is available under, if a MediaServlet is properly installed.
final String	getNamedURL(Item item, String name)	Deprecated. Use getURL(Item) and MediaUrlCatchphraseProvider.getMediaUrlCatchphrase(MediaPath) instead.
final List<MediaRequestLog>	getNoSuchItemLogs()
static final int	getNoSuchPath()
static final List<MediaRequestLog>	getNoSuchPathLogs()
final List<MediaRequestLog>	getNotAnItemLogs()
final List<MediaRequestLog>	getNotComputableLogs()
final String	getURL(Item item)	Returns a URL the content of this media path is available under, if a MediaServlet is properly installed.
final void	incrementDelivered()	For testing only.
boolean	isContentTypeWrapped()
boolean	isFinal()	Returns, whether the contents of this media path may change or not.
abstract boolean	isMandatory()	A MediaPath is "mandatory" if getContentType(Item) and getLocator(Item) will not return null for any item.
Condition	isNotNull()	Returns a condition matching all items, for which getLocator(Item) does not return null.
Condition	isNotNull(Join join)	Returns a condition matching all items, for which getLocator(Item) does not return null.
Condition	isNull()	Returns a condition matching all items, for which getLocator(Item) returns null.
Condition	isNull(Join join)	Returns a condition matching all items, for which getLocator(Item) returns null.
final boolean	isUrlFingerPrinted()
final boolean	isUrlGuessingPrevented()
static final boolean	isUrlGuessingPreventedSecurely(ConnectProperties properties)
protected final MediaPath.NotFound	notFoundIsNull()
protected final MediaPath.NotFound	notFoundNotComputable()
protected void	onMount()	Here you can do additional initialization not yet done in the constructor.

Methods inherited from class com.exedio.cope.Pattern

addSource, addSource, addSource, addSource, addSourceFeature, addSourceFeature, addSourceFeature, annotationField, equals, getGeneratedTypes, getSourceFeatures, getSourceFeaturesGather, getSourceFields, getSources, getSourceTypes, getType, hashCode, initialize, newSourceType, newSourceType, newSourceType, newSourceType, newSourceType, newSourceType, newType, newType, registerSource

Methods inherited from class com.exedio.cope.Feature

afterModelCreated, getAbstractType, getAnnotation, getID, getLocalizationKeys, getName, getPattern, isAnnotationPresent, isSourceAlready, mount, readResolve, requireMounted, toString, toString, writeReplace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MediaPath

public MediaPath()

Method Details

onMount

protected void onMount()

Description copied from class: Pattern

Here you can do additional initialization not yet done in the constructor. In this method you can call methods Pattern.getType() and Feature.getName() for the first time.

Overrides:

onMount in class Pattern

isUrlGuessingPrevented

public final boolean isUrlGuessingPrevented()

isUrlFingerPrinted

public final boolean isUrlFingerPrinted()

isContentTypeWrapped

public boolean isContentTypeWrapped()

getLocator

public final MediaPath.Locator getLocator(@Nonnull
 Item item)

Returns a locator the content of this media path is available under, if a MediaServlet is properly installed. Returns null, if there is no such content.

getURL

public final String getURL(@Nonnull
 Item item)

Returns a URL the content of this media path is available under, if a MediaServlet is properly installed. Returns null, if there is no such content.

See Also:

• MediaPath.Locator.getURLByConnect()

isUrlGuessingPreventedSecurely

public static final boolean isUrlGuessingPreventedSecurely(ConnectProperties properties)

notFoundIsNull

protected final MediaPath.NotFound notFoundIsNull()

notFoundNotComputable

protected final MediaPath.NotFound notFoundNotComputable()

getNoSuchPath

public static final int getNoSuchPath()

getInfo

public final MediaInfo getInfo()

incrementDelivered

public final void incrementDelivered()

For testing only. TODO

getNoSuchPathLogs

public static final List<MediaRequestLog> getNoSuchPathLogs()

getExceptionLogs

public final List<MediaRequestLog> getExceptionLogs()

getInvalidSpecialLogs

public final List<MediaRequestLog> getInvalidSpecialLogs()

getGuessedUrlLogs

public final List<MediaRequestLog> getGuessedUrlLogs()

getNotAnItemLogs

public final List<MediaRequestLog> getNotAnItemLogs()

getNoSuchItemLogs

public final List<MediaRequestLog> getNoSuchItemLogs()

getIsNullLogs

public final List<MediaRequestLog> getIsNullLogs()

getNotComputableLogs

public final List<MediaRequestLog> getNotComputableLogs()

commit

protected final void commit()

isMandatory

public abstract boolean isMandatory()

A MediaPath is "mandatory" if getContentType(Item) and getLocator(Item) will not return null for any item.

getContentType

public abstract String getContentType(@Nonnull
 Item item)

isFinal

public boolean isFinal()

Returns, whether the contents of this media path may change or not. The default implementation returns false.

getLastModified

public Date getLastModified(Item item)

The default implementation returns null.

Parameters:

item - the item which has the LastModified information

doGetAndCommit

public abstract void doGetAndCommit(HttpServletRequest request,
 HttpServletResponse response,
 Item item)
                             throws IOException,
MediaPath.NotFound

The implementor MUST commit the transaction, if the method completes normally (without exception). Otherwise the implementor may or may not commit the transaction.

Throws:

IOException

MediaPath.NotFound

isNull

public Condition isNull()

Returns a condition matching all items, for which getLocator(Item) returns null.

Throws:

UnsupportedOperationException - if the condition is not supported by this path

isNull

public Condition isNull(Join join)

Returns a condition matching all items, for which getLocator(Item) returns null.

Parameters:

join - the join the returned condition should be bound to

Throws:

UnsupportedOperationException - if the condition is not supported by this path

isNotNull

public Condition isNotNull()

Returns a condition matching all items, for which getLocator(Item) does not return null.

Throws:

UnsupportedOperationException - if the condition is not supported by this path

isNotNull

public Condition isNotNull(Join join)

Returns a condition matching all items, for which getLocator(Item) does not return null.

Parameters:

join - the join the returned condition should be bound to

Throws:

UnsupportedOperationException - if the condition is not supported by this path

getNamedURL

@Deprecated
public final String getNamedURL(Item item,
 String name)

Deprecated.

Use getURL(Item) and MediaUrlCatchphraseProvider.getMediaUrlCatchphrase(MediaPath) instead.

Parameters:

name - is ignored