|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
An interface represents cache for blob (binary) files like images, PDFs, text blocks, etc.
| Method Summary | |
String |
getBlobGUID(TableId tableId,
RecordId recordId)
Returns the GUID for the cached binary object (blob). |
String |
getBlobGUID(TableId tableId,
RecordId recordId,
ImageVariantId variantId)
Returns the GUID for the cached binary object (blob). |
String |
getBlobPath(String guid)
Returns the relative file path for the binary object (blob) by its GUID. |
String |
getBlobPath(TableId tableId,
RecordId recordId)
Returns the relative file path for the binary object (blob). |
String |
getBlobPath(TableId tableId,
RecordId recordId,
ImageVariantId variantId)
Returns the relative file path for the binary object (blob). |
String |
getCacheDirectory()
Returns the path of directory in the file system where the cached objects will be stored. |
int |
getMaximumCacheSize()
Returns the maximum cache size (total size of cached files) in kilobytes. |
String |
getRegionName()
Returns the data region name that used while retrieving blob objects from repository. |
RepositoryIdentifier |
getRepository()
Returns the repository where blob objects are stored. |
String |
getServerName()
Returns the name of MDM server that runs repository containing blob objects. |
int |
getStartupType()
Returns the startup type. |
void |
preload(TableId tableId)
Pre-loads all objects from the specified table until the cache is full. |
void |
preload(TableId tableId,
ImageVariantId variantId)
Pre-loads all objects with the specified variant ID from the specified table until the cache is full. |
| Method Detail |
public String getServerName()
public RepositoryIdentifier getRepository()
public String getRegionName()
public String getCacheDirectory()
public int getStartupType()
BlobCacheManager.ON_STARTUP_ALWAYS_REMOVE_FILES,
BlobCacheManager.ON_STARTUP_IF_NO_CACHE_REMOVE_FILES,
BlobCacheManager.ON_STARTUP_NEVER_REMOVE_FILESpublic int getMaximumCacheSize()
public String getBlobPath(TableId tableId,
RecordId recordId)
throws BlobCacheException
Note, the variant THUMBNAIL of a PDF is a generated image containing the first page of the PDF. To retrieve the PDF itself, use the variant ORIGINAL.
tableId - a table IdrecordId - a record Id
BlobCacheException - if there is any error while retrieving blob path.getBlobPath(TableId, RecordId, ImageVariantId),
ImageVariantId.ORIGINAL,
ImageVariantId.THUMBNAIL
public String getBlobPath(TableId tableId,
RecordId recordId,
ImageVariantId variantId)
throws BlobCacheException
ImageVariantId.THUMBNAIL
variant will be returned.
tableId - a table IdrecordId - a record IdvariantId - the image or PDF variant Id
BlobCacheException - if there is any error while retrieving blob path or
if specified variant ID does not exist (relevant only for 'Images' and 'PDFs' tables).
public void preload(TableId tableId,
ImageVariantId variantId)
throws BlobCacheException
ImageVariantId.ORIGINAL or
ImageVariantId.THUMBNAIL and if any other value is specified then exception is thrown.
tableId - a table IdvariantId - a variant Id
BlobCacheException - if there is any error while pre-loading or
if specified variant ID does not exist (relevant only for 'Images' and 'PDFs' tables).
public void preload(TableId tableId)
throws BlobCacheException
ImageVariantId.THUMBNAIL will be loaded.
tableId - a table Id
BlobCacheException - if there is any error while pre-loading.
public String getBlobGUID(TableId tableId,
RecordId recordId)
throws BlobCacheException
tableId - a table IdrecordId - a record Id
BlobCacheException - if there is any error while retrieving blob path.
public String getBlobGUID(TableId tableId,
RecordId recordId,
ImageVariantId variantId)
throws BlobCacheException
ImageVariantId.THUMBNAIL
variant will be returned.
tableId - a table IdrecordId - a record IdvariantId - the image or PDF variant Id
BlobCacheException - if there is any error while retrieving blob path or
if specified variant ID does not exist (relevant only for 'Images' and 'PDFs' tables).
public String getBlobPath(String guid)
throws BlobCacheException
guid - a GUID of cached blob
BlobCacheException - if blob object with specified GUID does not exist in the cache or
if there is any error while retrieving blob object.
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Copyright 2004-2007 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.
These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.