org.exoplatform.services.wcm.friendly.impl

Class FriendlyServiceImpl

java.lang.Object

org.exoplatform.services.wcm.friendly.impl.FriendlyServiceImpl

All Implemented Interfaces:

FriendlyService

public class FriendlyServiceImpl
extends Object
implements FriendlyService

Constructor Summary

Constructors

Constructor and Description
FriendlyServiceImpl(org.exoplatform.container.xml.InitParams initParams)

Method Summary

Modifier and Type	Method and Description
void	addConfiguration(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.
void	setEnabled(boolean isEnabled)
void	setServletName(String servletName)

Methods inherited from class java.lang.Object

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

Constructor Detail

FriendlyServiceImpl

public FriendlyServiceImpl(org.exoplatform.container.xml.InitParams initParams)

Method Detail

addConfiguration

public void addConfiguration(FriendlyPlugin plugin)

Description copied from interface: FriendlyService

Allows to add configuration to the Friendly Service.

Specified by:

addConfiguration in interface FriendlyService

Parameters:

plugin - The Friendly plugin.

isEnabled

public boolean isEnabled()

Description copied from interface: FriendlyService

Checks if the Friendly Service is active.

Specified by:

isEnabled in interface FriendlyService

Returns:

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

setEnabled

public void setEnabled(boolean isEnabled)

getServletName

public String getServletName()

Description copied from interface: FriendlyService

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

Specified by:

getServletName in interface FriendlyService

Returns:

The servlet name.

setServletName

public void setServletName(String servletName)

addFriendly

public void addFriendly(String friendlyUri,
                        String unfriendlyUri)

Description copied from interface: FriendlyService

Adds a new {friendly, unfriendly} couple.

Specified by:

addFriendly in interface FriendlyService

Parameters:

friendlyUri - The friendly URI.

unfriendlyUri - The unfriendly URI.

getFriendlyUri

public String getFriendlyUri(String unfriendlyUri)

Description copied from interface: FriendlyService

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

Specified by:

getFriendlyUri in interface FriendlyService

Parameters:

unfriendlyUri - The current unfriendly URI.

Returns:

The friendly URI.

getUnfriendlyUri

public String getUnfriendlyUri(String friendlyUri)

Description copied from interface: FriendlyService

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

Specified by:

getUnfriendlyUri in interface FriendlyService

Parameters:

friendlyUri - The current friendly URI.

Returns:

The unfriendly URI.

removeFriendly

public void removeFriendly(String friendlyUri)

Description copied from interface: FriendlyService

Removes a friendly entry based on the friendly key.

Specified by:

removeFriendly in interface FriendlyService

Parameters:

friendlyUri - The friendly URI.

getFriendlies

public Map<String,String> getFriendlies()

Description copied from interface: FriendlyService

Gets all {friendly, unfriendly} entries.

Specified by:

getFriendlies in interface FriendlyService

Returns:

The map of entries.