org.exoplatform.services.seo

Interface SEOService

public interface SEOService

Supplies APIs to manage SEO data of pages or content. This service includes some major functions that allow you to add, store, get or remove metadata of pages or content.

Level API:

Experimental

Method Summary

Modifier and Type	Method and Description
org.exoplatform.services.seo.PageMetadataModel	getContentMetadata(ArrayList<String> params, String language) Gets metadata of a content page.
javax.jcr.Node	getContentNode(String contentPath) Gets the content node by a given path.
List<String>	getFrequencyOptions() Gets a list of options for frequency.
String	getHash(String uri) Creates a hash key from the page reference or the UUID of the node.
org.exoplatform.services.seo.PageMetadataModel	getMetadata(ArrayList<String> params, String pageReference, String language) Gets metadata of a portal or content page.
org.exoplatform.services.seo.PageMetadataModel	getPageMetadata(String pageReference, 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.
void	removePageMetadata(org.exoplatform.services.seo.PageMetadataModel metaModel, String portalName, boolean onContent, String language) Removes metadata from a given page.
void	storeMetadata(org.exoplatform.services.seo.PageMetadataModel metaModel, String portalName, boolean onContent, String language) Stores metadata of a given page/content.

Method Detail

storeMetadata

void storeMetadata(org.exoplatform.services.seo.PageMetadataModel metaModel,
                   String portalName,
                   boolean onContent,
                   String language)
            throws Exception

Stores metadata of a given page/content.

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

getMetadata

org.exoplatform.services.seo.PageMetadataModel getMetadata(ArrayList<String> params,
                                                           String pageReference,
                                                           String language)
                                                    throws Exception

Gets metadata of a portal or content page.

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

getPageMetadata

org.exoplatform.services.seo.PageMetadataModel getPageMetadata(String pageReference,
                                                               String language)
                                                        throws Exception

Gets metadata of a portal page.

Parameters:

pageReference - Reference of the page.

language - Language of the page.

Returns:

The page metadata.

Throws:

Exception - The exception

getContentMetadata

org.exoplatform.services.seo.PageMetadataModel getContentMetadata(ArrayList<String> params,
                                                                  String language)
                                                           throws Exception

Gets metadata of a content page.

Parameters:

params - The parameters list of a content page.

language - Language of the page.

Returns:

The page metadata.

Throws:

Exception - The exception

removePageMetadata

void removePageMetadata(org.exoplatform.services.seo.PageMetadataModel metaModel,
                        String portalName,
                        boolean onContent,
                        String language)
                 throws Exception

Removes metadata from a given page.

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

getContentNode

javax.jcr.Node getContentNode(String contentPath)
                       throws Exception

Gets the content node by a given path.

Parameters:

contentPath - The given path.

Throws:

Exception - The exception

getHash

String getHash(String uri)
        throws Exception

Creates a hash key from the page reference or the UUID of the node.

Parameters:

uri - The page reference of the node.

Returns:

The hash key.

Throws:

Exception - The exception

getSitemap

String getSitemap(String portalName)
           throws Exception

Gets a sitemap of a given site.

Parameters:

portalName - Name of the given site.

Returns:

The sitemap.

Throws:

Exception - The exception

getRobots

String getRobots(String portalName)
          throws Exception

Gets robots content of a given site.

Parameters:

portalName - Name of the given site.

Returns:

The robots content.

Throws:

Exception - The exception

getRobotsIndexOptions

List<String> getRobotsIndexOptions()
                            throws Exception

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

Returns:

The list of options (INDEX and NOINDEX).

Throws:

Exception - The exception

getRobotsFollowOptions

List<String> getRobotsFollowOptions()
                             throws Exception

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

Returns:

The list of options (FOLLOW and NOFOLLOW).

Throws:

Exception - The exception

getFrequencyOptions

List<String> getFrequencyOptions()
                          throws Exception

Gets a list of options for frequency.

Returns:

The list of options.

Throws:

Exception - The exception

getState

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

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

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

getSEOLanguages

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

Gets all SEO languages of a given page.

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