org.exoplatform.services.seo.impl

Class SEOServiceImpl

java.lang.Object

org.exoplatform.services.seo.impl.SEOServiceImpl

All Implemented Interfaces:

SEOService

public class SEOServiceImpl
extends Object
implements SEOService

Created by The eXo Platform SAS Author : eXoPlatform exo@exoplatform.com Jun 17, 2011

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_CACHE_ENTRY
static String	LANGUAGES
static String	METADATA_BASE_PATH
static String	METADATA_CONTENT_PATH
static String	METADATA_PAGE_PATH
static String	ROBOTS_NAME
static String	SITEMAP_NAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getCachedEntries()
PageMetadataModel	getContentMetadata(ArrayList<String> params, String language) Gets metadata of a content page.
javax.jcr.Node	getContentNode(String seoPath) Gets the content node by a given path.
List<String>	getFrequencyOptions() Gets a list of options for frequency.
String	getHash(String uri) Returns hash
PageMetadataModel	getMetadata(ArrayList<String> params, String pageReference, String language) Gets metadata of a portal or content page.
PageMetadataModel	getPageMetadata(String pageUri, String language) Gets metadata of a portal page.
String	getRobots(String portalName) Gets robots content of a given site.
List<String>	getRobotsFollowOptions() Gets a list of options (FOLLOW and NOFOLLOW) for robots to follow.
List<String>	getRobotsIndexOptions() Gets a list of options (INDEX and NOINDEX) for robots to index.
List<Locale>	getSEOLanguages(String portalName, String seoPath, boolean onContent) Gets all SEO languages of a given page.
String	getSitemap(String portalName) Gets a sitemap of a given site.
String	getState(String path, String language, boolean onContent) Gets state of a page for its language of a given page.
boolean	isCached()
void	removePageMetadata(PageMetadataModel metaModel, String portalName, boolean onContent, String language) Removes metadata from a given page.
void	setCached(boolean isCached)
void	storeMetadata(PageMetadataModel metaModel, String portalName, boolean onContent, String language) Stores metadata of a given page/content.
void	updateRobots(javax.jcr.Node dummyNode, String portalName)
void	updateSiteMap(String uri, float priority, String frequency, boolean visibleSitemap, String portalName) Update sitemap content for portal

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_CACHE_ENTRY

public static final String EMPTY_CACHE_ENTRY

See Also:

Constant Field Values

METADATA_BASE_PATH

public static String METADATA_BASE_PATH

LANGUAGES

public static final String LANGUAGES

See Also:

Constant Field Values

METADATA_PAGE_PATH

public static String METADATA_PAGE_PATH

METADATA_CONTENT_PATH

public static String METADATA_CONTENT_PATH

SITEMAP_NAME

public static String SITEMAP_NAME

ROBOTS_NAME

public static String ROBOTS_NAME

Constructor Detail

SEOServiceImpl

public SEOServiceImpl(org.exoplatform.container.xml.InitParams initParams)
               throws Exception

Constructor method

Parameters:

initParams - The initial parameters

Throws:

Exception

Method Detail

getRobotsIndexOptions

public List<String> getRobotsIndexOptions()

Gets a list of options (INDEX and NOINDEX) for robots to index.

Specified by:

getRobotsIndexOptions in interface SEOService

Returns:

The list of options (INDEX and NOINDEX).

getRobotsFollowOptions

public List<String> getRobotsFollowOptions()

Gets a list of options (FOLLOW and NOFOLLOW) for robots to follow.

Specified by:

getRobotsFollowOptions in interface SEOService

Returns:

The list of options (FOLLOW and NOFOLLOW).

getFrequencyOptions

public List<String> getFrequencyOptions()

Gets a list of options for frequency.

Specified by:

getFrequencyOptions in interface SEOService

Returns:

The list of options.

storeMetadata

public void storeMetadata(PageMetadataModel metaModel,
                          String portalName,
                          boolean onContent,
                          String language)
                   throws Exception

Stores metadata of a given page/content.

Specified by:

storeMetadata in interface SEOService

Parameters:

metaModel - Metadata of the page/content.

portalName - Name of the site that contains the given page/content.

onContent - Indicates whether the current page is content or portal.

Throws:

Exception - The exception

getState

public String getState(String path,
                       String language,
                       boolean onContent)
                throws Exception

Description copied from interface: SEOService

Gets state of a page for its language of a given page.

Specified by:

getState in interface SEOService

Parameters:

path - Path of the page.

language - Language of the page.

onContent - Indicates whether the given page is content or portal.

Returns:

The page state.

Throws:

Exception - The exception

getMetadata

public PageMetadataModel getMetadata(ArrayList<String> params,
                                     String pageReference,
                                     String language)
                              throws Exception

Description copied from interface: SEOService

Gets metadata of a portal or content page.

Specified by:

getMetadata in interface SEOService

Parameters:

params - The parameters list of a content page.

pageReference - Reference of the page.

language - Language of the page.

Returns:

The page metadata.

Throws:

Exception - The exception

getContentMetadata

public PageMetadataModel getContentMetadata(ArrayList<String> params,
                                            String language)
                                     throws Exception

Gets metadata of a content page.

Specified by:

getContentMetadata in interface SEOService

Parameters:

params - The parameters list of a content page.

language - Language of the page.

Returns:

The page metadata.

Throws:

Exception - The exception

getPageMetadata

public PageMetadataModel getPageMetadata(String pageUri,
                                         String language)
                                  throws Exception

Gets metadata of a portal page.

Specified by:

getPageMetadata in interface SEOService

Parameters:

pageUri - Reference of the page.

language - Language of the page.

Returns:

The page metadata.

Throws:

Exception - The exception

getSEOLanguages

public List<Locale> getSEOLanguages(String portalName,
                                    String seoPath,
                                    boolean onContent)
                             throws Exception

Description copied from interface: SEOService

Gets all SEO languages of a given page.

Specified by:

getSEOLanguages in interface SEOService

Parameters:

portalName - Name of the site that contains the given page.

seoPath - Path of the page.

onContent - Indicates whether the given page is content or portal.

Returns:

The list of SEO languages.

Throws:

Exception - The exception

removePageMetadata

public void removePageMetadata(PageMetadataModel metaModel,
                               String portalName,
                               boolean onContent,
                               String language)
                        throws Exception

Removes metadata from a given page.

Specified by:

removePageMetadata in interface SEOService

Parameters:

metaModel - Metadata of the given page.

portalName - Name of the site that contains the given page.

onContent - Indicates whether the current page is content or portal.

language - Language of the given page.

Throws:

Exception - The exception

updateSiteMap

public void updateSiteMap(String uri,
                          float priority,
                          String frequency,
                          boolean visibleSitemap,
                          String portalName)
                   throws Exception

Update sitemap content for portal

Parameters:

uri - The uri of page

priority - The priority of page

frequency - The frequency of page

visibleSitemap - visibleSitemap = true page is visible on sitemap visibleSitemap = false page is invisible on sitemap

portalName - The portal name

Throws:

Exception

updateRobots

public void updateRobots(javax.jcr.Node dummyNode,
                         String portalName)
                  throws Exception

Throws:

Exception

getSitemap

public String getSitemap(String portalName)
                  throws Exception

Gets a sitemap of a given site.

Specified by:

getSitemap in interface SEOService

Parameters:

portalName - Name of the given site.

Returns:

The sitemap.

Throws:

Exception - The exception

getRobots

public String getRobots(String portalName)
                 throws Exception

Gets robots content of a given site.

Specified by:

getRobots in interface SEOService

Parameters:

portalName - Name of the given site.

Returns:

The robots content.

Throws:

Exception - The exception

getHash

public String getHash(String uri)
               throws Exception

Returns hash

Specified by:

getHash in interface SEOService

Parameters:

uri - The uri of page

Returns:

Throws:

Exception

getContentNode

public javax.jcr.Node getContentNode(String seoPath)
                              throws Exception

Description copied from interface: SEOService

Gets the content node by a given path.

Specified by:

getContentNode in interface SEOService

Parameters:

seoPath - The given path.

Throws:

Exception - The exception

isCached

public boolean isCached()

getCachedEntries

public int getCachedEntries()

setCached

public void setCached(boolean isCached)