com.communote.server.core.blog.export

Interface PermalinkGenerator

All Known Implementing Classes:

DefaultPermalinkGenerator, PermalinkGenerationManagement

public interface PermalinkGenerator

Interface for defining generation of permanent links.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERMA_ID_NOTES The permalink identifier for notes
static String	PERMA_ID_TAGS The permalink identifier for tags
static String	PERMA_ID_TOPICS The permalink identifier for topics.
static String	PERMA_ID_USERS The permalink identifier for users

Method Summary

Modifier and Type	Method and Description
String	extractPermaLinkIdentifier(String[] uriFragments) Get the type of perma link (one of the constants PERMA_ID_TOPICS etc)
String	getBlogLink(String blogAlias) Calls getBlogLink(String, boolean) with secure parameter set to false.
String	getBlogLink(String blogAlias, boolean secure)
String	getNoteLink(String blogAlias, Long noteId) Calls getNoteLink(String, Long, boolean) with secure parameter set to false.
String	getNoteLink(String blogAlias, Long noteId, boolean secure)
String	getTagLink(long tagId) Calls getTagLink(String, boolean) with secure parameter set to false.
String	getTagLink(long tagId, boolean secure)
String	getTagLink(String tag) Deprecated. Use getTagLink(long) instead.
String	getTagLink(String tag, boolean secure) Deprecated. Use getTagLink(long, boolean) instead.
String	getUserLink(String userAlias) Calls getUserLink(String,boolean) with secure parameter set to false.
String	getUserLink(String userAlias, boolean secure)

Field Detail

PERMA_ID_TOPICS

static final String PERMA_ID_TOPICS

The permalink identifier for topics.

See Also:

Constant Field Values

PERMA_ID_USERS

static final String PERMA_ID_USERS

The permalink identifier for users

See Also:

Constant Field Values

PERMA_ID_TAGS

static final String PERMA_ID_TAGS

The permalink identifier for tags

See Also:

Constant Field Values

PERMA_ID_NOTES

static final String PERMA_ID_NOTES

The permalink identifier for notes

See Also:

Constant Field Values

Method Detail

extractPermaLinkIdentifier

String extractPermaLinkIdentifier(String[] uriFragments)

Get the type of perma link (one of the constants PERMA_ID_TOPICS etc)

Parameters:

uriFragments - the splitted uri fragments

Returns:

the perma link identifier (that is 'blogs', 'users', 'tags' ...)

getBlogLink

String getBlogLink(String blogAlias)

Calls getBlogLink(String, boolean) with secure parameter set to false.

Parameters:

blogAlias - the alias of the blog to get the link for

Returns:

the absolute perma link for the blog

getBlogLink

String getBlogLink(String blogAlias,
                   boolean secure)

Parameters:

blogAlias - the alias of the blog to get the link for

secure - If true https will be used.

Returns:

the absolute perma link for the blog

getNoteLink

String getNoteLink(String blogAlias,
                   Long noteId)

Calls getNoteLink(String, Long, boolean) with secure parameter set to false.

Parameters:

blogAlias - the blog alias of the note to get the link for

noteId - the id of the note to get the link for

Returns:

the perma link for the note

getNoteLink

String getNoteLink(String blogAlias,
                   Long noteId,
                   boolean secure)

Parameters:

blogAlias - the blog alias of the note to get the link for

noteId - the id of the note to get the link for

secure - If true, https will be used.

Returns:

the perma link for the note

getTagLink

String getTagLink(long tagId)

Calls getTagLink(String, boolean) with secure parameter set to false.

Parameters:

tagId - The tag to get the link for

Returns:

The permanent link for the tag.

getTagLink

String getTagLink(long tagId,
                  boolean secure)

Parameters:

tagId - the tag to get the link for

secure - If true, https will be used.

Returns:

the perma link for the tag

getTagLink

@Deprecated
String getTagLink(String tag)

Deprecated. Use getTagLink(long) instead.

Calls getTagLink(String, boolean) with secure parameter set to false.

Parameters:

tag - The tag to get the link for

Returns:

The permanent link for the tag.

getTagLink

@Deprecated
String getTagLink(String tag,
                              boolean secure)

Deprecated. Use getTagLink(long, boolean) instead.

Parameters:

tag - the tag to get the link for

secure - If true, https will be used.

Returns:

the perma link for the tag

getUserLink

String getUserLink(String userAlias)

Calls getUserLink(String,boolean) with secure parameter set to false.

Parameters:

userAlias - the alias of the user to get the link for

Returns:

the perma link for the user

getUserLink

String getUserLink(String userAlias,
                   boolean secure)

Parameters:

userAlias - the alias of the user to get the link for

secure - If true, https will be used.

Returns:

the perma link for the user