org.exoplatform.services.wcm.friendly

Interface FriendlyService

public interface FriendlyService

Provides support for friendly URL in Content.

For example: If URL is http://mysite.com/portal/public/acme/detail?path=/repository/collaboration/sites content/live/acme/web contents/news/news1 where the friendly key could be: acme with unfriendly value as: /public/acme/detail?path=/repository/collaboration/sites content/live/acme/web contents, the friendly URL becomes: http://mysite.com/portal/content/acme/news/news1.

Level API:

Experimental

Method Summary

Modifier and Type	Method and Description
void	addConfiguration(org.exoplatform.services.wcm.friendly.impl.FriendlyPlugin plugin) Allows to add configuration to the Friendly Service.
void	addFriendly(String friendlyUri, String unfriendlyUri) Adds a new {friendly, unfriendly} couple.
Map<String,String>	getFriendlies() Gets all {friendly, unfriendly} entries.
String	getFriendlyUri(String unfriendlyUri) Gets the friendly URI corresponding to an unfriendly URI.
String	getServletName() Uses a servlet in the portal app to forward the friendly URL to its corresponding unfriendly one.
String	getUnfriendlyUri(String friendlyUri) Gets the unfriendly URI corresponding to a friendly URI.
boolean	isEnabled() Checks if the Friendly Service is active.
void	removeFriendly(String friendlyUri) Removes a friendly entry based on the friendly key.

Method Detail

getServletName

String getServletName()

Uses a servlet in the portal app to forward the friendly URL to its corresponding unfriendly one. By default, the servelt name is "content".

Returns:

The servlet name.

isEnabled

boolean isEnabled()

Checks if the Friendly Service is active.

Returns:

"True" if the Friendly Service is active. Otherwise, it returns "false".

addConfiguration

void addConfiguration(org.exoplatform.services.wcm.friendly.impl.FriendlyPlugin plugin)

Allows to add configuration to the Friendly Service.

Parameters:

plugin - The Friendly plugin.

getFriendlyUri

String getFriendlyUri(String unfriendlyUri)

Gets the friendly URI corresponding to an unfriendly URI.

For example:
friendly = acme
unfriendly = /public/acme/detail?path=/repository/collaboration/sites content/live/acme/web contents

Parameters:

unfriendlyUri - The current unfriendly URI.

Returns:

The friendly URI.

getUnfriendlyUri

String getUnfriendlyUri(String friendlyUri)

Gets the unfriendly URI corresponding to a friendly URI.
For example:
friendly = acme
unfriendly = /public/acme/detail?path=/repository/collaboration/sites content/live/acme/web contents

Parameters:

friendlyUri - The current friendly URI.

Returns:

The unfriendly URI.

addFriendly

void addFriendly(String friendlyUri,
                 String unfriendlyUri)

Adds a new {friendly, unfriendly} couple.

Parameters:

friendlyUri - The friendly URI.

unfriendlyUri - The unfriendly URI.

removeFriendly

void removeFriendly(String friendlyUri)

Removes a friendly entry based on the friendly key.

Parameters:

friendlyUri - The friendly URI.

getFriendlies

Map<String,String> getFriendlies()

Gets all {friendly, unfriendly} entries.

Returns:

The map of entries.