JBoss.orgCommunity Documentation

SEOService

SEOService supplies APIs to manage SEO data of a page or a content. This service includes some major functions which enables you to add, store, get or remove the metadata of a page or a content.

Method Param Return Description
storePageMetadata(PageMetadataModel metaModel, String portalName, boolean onContent) throws Exception

metaModel: The metadata of a page/content stored.

portalName: The name of portal.

onContent: Indicate whether the current page is the content page or the portal page.

void Store the metadata of a page/content.
getMetadata(ArrayList<String> params, String pageReference) throws Exception

params: The parameters list of a content page.

pageReference: The reference of the page.

PageMetadataModel Return the metadata of a portal page or a content page.
getPageMetadata (String pageReference) throws Exception pageReference: The reference of the page. PageMetadataModel Return the metadata of a portal page.
getContentMetadata(ArrayList<String> params) throws Exception params: The parameters list of a content page. PageMetadataModel Return the metadata of a content page.
removePageMetadata(PageMetadataModel metaModel, String portalName, boolean onContent) throws Exception

metaModel: The metadata of a page/content stored.

portalName: The name of portal.

onContent: Indicate whether the current page is the content page or the portal page.

void Remove the metadata of a page.
getContentNode(String contentPath) throws Exception contentPath: The content path. Node Return the content node by the content path.
getHash(String uri) throws Exception uri: The page reference of the UUID of a node. string Create a key from the page reference or the UUID of the node.
getSitemap(String portalName) throws Exception portalName: The portal name. string Return a sitemap's content of a specific portal.
getRobots(String portalName) throws Exception portalName: The portal name. string Return Robots' content of a specific portal.
getRobotsIndexOptions() throws Exception N/A List<String> Return a list of options (INDEX and NOINDEX) for robots to index.
getRobotsFollowOptions() throws Exception N/A List<String> Return a list of options (FOLLOW and NOFOLLOW) for robots to follow.
getFrequencyOptions() throws Exception N/A List<String> Return a list of options for frequency.