SeoService

java.lang.Object
- com.ibm.commerce.soccom.seo.SeoService

```
public class SeoService
extends java.lang.Object
```
This class uses the CacheClient to retrieve and cache Search Engine Optimized (SEO) content from the WebSphere sMash Social Commerce adapter. You can use static methods to retrieve a string representation of the SEO content and then embed that content in a JSP or JSPF file with the corresponding Dojo widget declaration. When one of the public static methods is called, the CacheClient attempts to locate and return the requested content from the JSP cache. If the SEO content is not found in the cache, a string that contains the <noscript> tag is returned and the cache is updated asynchronously so that subsequent requests can succeed. You must ensure that the WorkManager responsible for updating the cache is also configured from the WebSphere Application Server Administration Console and the JNDI name for the cache is added to the com.ibm.commerce.soccom.seo .config.properties file.

EXAMPLE:
<div id="Reviews" dojoType="dijit.layout.ContentPane"> <div id="ReviewsWidgetForItems" dojoType="ibm.social.Reviews" resourceType="${itemResourceType}" resourceId="${partNumber}" itemDescription="${itemDescription}"> </div> <div class="noscript"> <% out.write( com.ibm.commerce.soccom.seo.CacheClient.getReviewContent((String)pageContext.getAttribute("partNumber"))); %>

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` The IBM copyright notice field.
`static java.lang.String`	`DEFAULT_ENCODING` The default character set encoding of web resources (UTF-8).
`static java.lang.String`	`EMPTY_CONTENT` The string representation of no content.

Constructor Summary

Constructors
Constructor and Description

SeoService()

Constructors
Constructor and Description
`SeoService()`

Method Summary

Methods
Modifier and Type	Method and Description
`static java.lang.String`	`get(java.lang.String uri, java.lang.String cacheDependecyId)` Retrieves the SEO content for the resource at the specified URI.
`static java.lang.String`	`getBlogContent(java.lang.String id, java.lang.String cacheDependencyId)` Retrieves the SEO content enclosed in the <noscript> tag for the specified blog.
`static SeoService`	`getInstance()` Retrieves the singleton instance of the CacheClient.
`static java.lang.String`	`getPhotoGalleryContent(java.lang.String id, java.lang.String cacheDependencyId)` Retrieves the SEO content enclosed in the <noscript> tag for the specified photo gallery.
`static java.lang.String`	`getReviewContent(java.lang.String id, java.lang.String cacheDepencyId)` Retrieves the SEO content enclosed in the <noscript> tag for the specified review.
`static java.lang.String`	`getUserBlogContent(java.lang.String user, java.lang.String cacheDependencyId)` Retrieves the SEO content enclosed in the <noscript> tag for blog entries created by the specified shopper.
`static java.lang.String`	`getUserPhotoGalleryContent(java.lang.String user, java.lang.String cacheDependencyId)` Retrieves the SEO content enclosed in the <noscript> tag for photos created by the specified shopper.
`static java.lang.String`	`getUserReviewContent(java.lang.String user, java.lang.String cacheDependencyId)` Retrieves the SEO content enclosed in the <noscript> tag for reviews created by the specified shopper.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    The IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENCODING
```
public static final java.lang.String DEFAULT_ENCODING
```
    The default character set encoding of web resources (UTF-8).
    
    See Also:
    
    Constant Field Values
  - EMPTY_CONTENT
```
public static final java.lang.String EMPTY_CONTENT
```
    The string representation of no content. This is an empty string.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SeoService
```
public SeoService()
```
- Method Detail
  - getInstance
```
public static SeoService getInstance()
```
    Retrieves the singleton instance of the CacheClient.
    
    Returns:
    
    An instance of the CacheClient.
  - getBlogContent
```
public static java.lang.String getBlogContent(java.lang.String id,
                              java.lang.String cacheDependencyId)
```
    Retrieves the SEO content enclosed in the <noscript> tag for the specified blog.
    
    Parameters:
    
    id - The ID of the blog to retrieve
    
    cacheDependencyId - The cache ID of the JSP file or servlet to invalidate on the first request or an invalid SEO request.
    
    Returns:
    
    The static HTML representation of the ibm.social.Blog widget.
  - getUserBlogContent
```
public static java.lang.String getUserBlogContent(java.lang.String user,
                                  java.lang.String cacheDependencyId)
```
    Retrieves the SEO content enclosed in the <noscript> tag for blog entries created by the specified shopper.
    
    Parameters:
    
    user - The user who created the content to retrieve.
    
    cacheDependencyId - The cache ID of the JSP file or servlet to invalidate on the first request or an invalid SEO request.
    
    Returns:
    
    The static HTML representation of the ibm.social.Blog widget.
  - getPhotoGalleryContent
```
public static java.lang.String getPhotoGalleryContent(java.lang.String id,
                                      java.lang.String cacheDependencyId)
```
    Retrieves the SEO content enclosed in the <noscript> tag for the specified photo gallery.
    
    Parameters:
    
    id - The ID of the gallery to retrieved.
    
    cacheDependencyId - The cache ID of the JSP file or servlet to invalidate on the first request or an invalid SEO request.
    
    Returns:
    
    The static HTML representation of the ibm.social.PhotoGallery widget.
  - getUserPhotoGalleryContent
```
public static java.lang.String getUserPhotoGalleryContent(java.lang.String user,
                                          java.lang.String cacheDependencyId)
```
    Retrieves the SEO content enclosed in the <noscript> tag for photos created by the specified shopper.
    
    Parameters:
    
    user - The user who created the content to retrieve.
    
    cacheDependencyId - The cache ID of the JSP file or servlet to invalidate on the first request or an invalid SEO request.
    
    Returns:
    
    The static HTML representation of the ibm.social.PhotoGallery widget.
  - getReviewContent
```
public static java.lang.String getReviewContent(java.lang.String id,
                                java.lang.String cacheDepencyId)
```
    Retrieves the SEO content enclosed in the <noscript> tag for the specified review.
    
    Parameters:
    
    id - The ID of the product to retrieve reviews for.
    
    cacheDepencyId - The cache ID of the JSP file or servlet to invalidate on the first request or an invalid SEO request.
    
    Returns:
    
    The static HTML representation of the ibm.social.Reviews widget.
  - getUserReviewContent
```
public static java.lang.String getUserReviewContent(java.lang.String user,
                                    java.lang.String cacheDependencyId)
```
    Retrieves the SEO content enclosed in the <noscript> tag for reviews created by the specified shopper.
    
    Parameters:
    
    user - The user who created the content to retrieve.
    
    cacheDependencyId - The cache ID of the JSP file or servlet to invalidate on the first request or an invalid SEO request.
    
    Returns:
    
    The static HTML representation of the ibm.social.Reviews widget.
  - get
```
public static java.lang.String get(java.lang.String uri,
                   java.lang.String cacheDependecyId)
```
    Retrieves the SEO content for the resource at the specified URI. If the resource is not found in the cache, an empty string is returned and a worker thread is spawned to get the resource and cache it.
    
    Parameters:
    
    uri - The URI of the service to retrieve.
    
    cacheDependecyId - The cache id of the JSP/Servlet to invalidate on the first request or an invalid SEO request.
    
    Returns:
    
    The string representation of the resource located at the given URI.

Class SeoService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT

DEFAULT_ENCODING

EMPTY_CONTENT

Constructor Detail

SeoService

Method Detail

getInstance

getBlogContent

getUserBlogContent

getPhotoGalleryContent

getUserPhotoGalleryContent

getReviewContent

getUserReviewContent

get