RESTMetaDataGenerator

java.lang.Object
- com.ibm.commerce.rest.caching.RESTMetaDataGenerator

All Implemented Interfaces:

com.ibm.websphere.servlet.cache.MetaDataGenerator
```
public class RESTMetaDataGenerator
extends java.lang.Object
implements com.ibm.websphere.servlet.cache.MetaDataGenerator
```
RESTMetaDataGenerator is the sample implementation of do the identifier-id transformation for dependency-id. With this class, by default, it will convert the 'CategoryDisplay:storeId:categoryIdentifier::' to 'CategoryDisplay:storeId:categoryId::', and 'ProductDisplay:storeId:productIdentifier::' to 'ProductDisplay:storeId:productId::'. And the method extGenerateDependencyId is used for customization. Developer can override this method to add more logic for dependency conversion.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description

RESTMetaDataGenerator()

Constructors
Constructor and Description
`RESTMetaDataGenerator()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected BusinessContextType`	`buildBusinessContext(javax.servlet.http.HttpServletRequest request)` Build the business context.
`protected BusinessContextType`	`buildBusinessContext(java.lang.String storeId, java.lang.String previewToken, javax.servlet.http.HttpServletRequest httpRequest)` Build the business context.
`protected java.lang.String`	`extGenerateDependencyId(java.lang.String dataId, javax.servlet.http.HttpServletRequest httpRequest, com.ibm.ws.cache.servlet.FragmentInfo fragmentInfo)`
`void`	`initialize(com.ibm.websphere.servlet.cache.CacheConfig arg0)` Initialization
`void`	`setMetaData(com.ibm.websphere.servlet.cache.ServletCacheRequest request, javax.servlet.http.HttpServletResponse resp)` Set MetaData

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
```
  IBM copyright notice field.
  
  See Also:
  
  Constant Field Values

Constructor Detail
- RESTMetaDataGenerator
```
public RESTMetaDataGenerator()
```

Method Detail

initialize
```
public void initialize(com.ibm.websphere.servlet.cache.CacheConfig arg0)
```
Initialization

Specified by:

initialize in interface com.ibm.websphere.servlet.cache.MetaDataGenerator

Parameters:

arg0 -

setMetaData

public void setMetaData(com.ibm.websphere.servlet.cache.ServletCacheRequest request,
               javax.servlet.http.HttpServletResponse resp)

Set MetaData

Specified by:: setMetaData in interface com.ibm.websphere.servlet.cache.MetaDataGenerator
Parameters:: request -; resp -

buildBusinessContext

protected BusinessContextType buildBusinessContext(javax.servlet.http.HttpServletRequest request)
                                            throws java.lang.Exception

Build the business context.

Parameters:: request -
Returns:: BusinessContextType
Throws:: java.lang.Exception

buildBusinessContext

protected BusinessContextType buildBusinessContext(java.lang.String storeId,
                                       java.lang.String previewToken,
                                       javax.servlet.http.HttpServletRequest httpRequest)
                                            throws java.lang.Exception

Build the business context.

Parameters:: storeId -; previewToken -; httpRequest -
Returns:: BusinessContextType
Throws:: java.lang.Exception

extGenerateDependencyId

protected java.lang.String extGenerateDependencyId(java.lang.String dataId,
                                       javax.servlet.http.HttpServletRequest httpRequest,
                                       com.ibm.ws.cache.servlet.FragmentInfo fragmentInfo)
                                            throws java.lang.Exception

Parameters:: dataId -; httpRequest -; fragmentInfo -
Returns:: String
Throws:: java.lang.Exception

Class RESTMetaDataGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT

Constructor Detail

RESTMetaDataGenerator

Method Detail

initialize

setMetaData

buildBusinessContext

buildBusinessContext

extGenerateDependencyId