Package de.espirit.firstspirit.access

Interface UrlCreator

All Known Subinterfaces:

UrlCreator

@Deprecated
public interface UrlCreator

Deprecated.

since 5.0.3, use the interface UrlCreator.

Note: Since FirstSpirit v5 implementors should implement the new interface UrlFactory.
The url creation during the generate process are delegated to implementations of this interface. Created instances have a lifecycle: The methods init(GenerationContext) and setUrlPrefix(String) are called once in this order before any other methods are called. The method cleanUp() is called when the instance is no longer used. Instances should hold no static state. Instances are not used concurrently from different threads.

Since:

4.0.17

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	UrlCreator.Mode	Deprecated. since 5.0.3 - use UrlCreator.Mode.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ABSOLUTE_URL	Deprecated. since 5.0.3 - use UrlCreator.ABSOLUTE_URL.
static final int	ABSOLUTE_URL_NO_PREFIX	Deprecated. since 5.0.3 - use UrlCreator.ABSOLUTE_URL_NO_PREFIX.
static final List<UrlCreator.Mode>	MODES	Deprecated. since 5.0.3 - use UrlCreator.MODES.
static final int	RELATIVE_URL	Deprecated. since 5.0.3 - use UrlCreator.RELATIVE_URL.

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Deprecated. See UrlCreator.cleanUp().
String	getFilename(ContentProducer node, TemplateSet templateSet, Language language, String pageSuffix)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0.3 - use UrlCreator.getFilename(ContentProducer, TemplateSet, Language, PageParams).
String	getFilename(Media media, Language lang, Resolution res)	Deprecated. See UrlCreator.getFilename(Media, Language, Resolution).
String	getFilename(String type, String name, String extension, Language language)	Deprecated. See UrlCreator.getFilename(String, String, String, Language).
String	getUrl(ContentProducer node, Language language, TemplateSet templateSet, PageParams pageParams, int mode)	Deprecated. See UrlCreator.getUrl(ContentProducer, Language, TemplateSet, PageParams, int).
String	getUrl(Media media, Language language, Resolution resolution, int mode)	Deprecated. See UrlCreator.getUrl(Media, Language, Resolution, int).
String	getUrl(String type, String name, String extension, Language language, int mode)	Deprecated. See UrlCreator.getUrl(String, String, String, Language, int).
@Nullable String	getUrlPrefix()	Deprecated. See UrlCreator.getUrlPrefix().
void	init(GenerationContext gc)	Deprecated. Initialization callback.
void	setUrlPrefix(String value)	Deprecated. Set an url prefix.

Field Details

MODES

@Deprecated
static final List<UrlCreator.Mode> MODES

Deprecated.

since 5.0.3 - use UrlCreator.MODES.

Since:

4.0.52

RELATIVE_URL

@Deprecated
static final int RELATIVE_URL

Deprecated.

since 5.0.3 - use UrlCreator.RELATIVE_URL.

Since:

4.0.52

ABSOLUTE_URL

@Deprecated
static final int ABSOLUTE_URL

Deprecated.

since 5.0.3 - use UrlCreator.ABSOLUTE_URL.

Since:

4.0.52

ABSOLUTE_URL_NO_PREFIX

@Deprecated
static final int ABSOLUTE_URL_NO_PREFIX

Deprecated.

since 5.0.3 - use UrlCreator.ABSOLUTE_URL_NO_PREFIX.

Since:

4.0.52

Method Details

init

void init(GenerationContext gc)

Deprecated.

Initialization callback. This method is called before any other method to initialize this instance.

Parameters:

gc - the generation context from where this url creator will be used

Since:

4.0.17

getUrlPrefix

@Nullable
@Nullable String getUrlPrefix()

Deprecated.

See UrlCreator.getUrlPrefix().

Since:

4.0.17

setUrlPrefix

void setUrlPrefix(String value)

Deprecated.

Set an url prefix. Not every url creator needs an url prefix, so this call may be ignored. This method is called before the instance is used and after the instance is initialized.

Parameters:

value - the new url prefix.

Since:

4.0.17

See Also:

• getUrlPrefix()

getFilename

@Deprecated(forRemoval=true)
String getFilename(ContentProducer node,
 TemplateSet templateSet,
 Language language,
 String pageSuffix)

Deprecated, for removal: This API element is subject to removal in a future version.

since 5.0.3 - use UrlCreator.getFilename(ContentProducer, TemplateSet, Language, PageParams).

This method is no longer used by FirstSpirit since v5. Implementors may throw an UnsupportedOperationException. FirstSpirit now relies on this method.

Since:

4.0.95

getUrl

String getUrl(ContentProducer node,
 Language language,
 TemplateSet templateSet,
 PageParams pageParams,
 int mode)

Deprecated.

See UrlCreator.getUrl(ContentProducer, Language, TemplateSet, PageParams, int).

Since:

4.1

getFilename

String getFilename(Media media,
 Language lang,
 Resolution res)
            throws IOException

Deprecated.

See UrlCreator.getFilename(Media, Language, Resolution).

Throws:

IOException

Since:

4.0.17

getUrl

String getUrl(Media media,
 Language language,
 Resolution resolution,
 int mode)
       throws IOException

Deprecated.

See UrlCreator.getUrl(Media, Language, Resolution, int).

Throws:

IOException

Since:

4.0.17

getFilename

String getFilename(String type,
 String name,
 String extension,
 Language language)

Deprecated.

See UrlCreator.getFilename(String, String, String, Language).

Since:

4.0.120

getUrl

String getUrl(String type,
 String name,
 String extension,
 Language language,
 int mode)

Deprecated.

See UrlCreator.getUrl(String, String, String, Language, int).

Since:

4.0.17

cleanUp

void cleanUp()

Deprecated.

See UrlCreator.cleanUp().

Since:

4.0.63