com.groupdocs.viewer.config
Interface IBackEndConfiguration

All Known Subinterfaces:
IServiceConfiguration

public interface IBackEndConfiguration

Author:
Alex Bobkov

Method Summary
 String getApplicationPath()
          Get application path
ex: http://localhost:8080/
 String getBasePath()
          Get absolute storage path
Path where all document will be stored (accessible by application)
 String getEncryptionKey()
          Get encrypt key
Encrypt key is used for token id's generations.
 Integer getExpirationDate()
          Get expiration date
Expiration date for generated token id's from file uploads.
 String getLicensePath()
          Get absolute path to license file
 String getLocalesPath()
          Get locales path
Path where custom locale files are stored.
 Long getMaxCacheSize()
          Get maximum size of temp files directory
 String getUploadPath()
          Get upload path
Default upload path is storage path.
 Boolean isUseAuthorization()
          Deprecated. 
 Boolean isUseBrowserCache()
          Browser cache flag
Prevent browsers from storing images in cache
 Boolean isUseCache()
          Image cache flag
This flag work only in image based engine.
 

Method Detail

getApplicationPath

String getApplicationPath()
Get application path
ex: http://localhost:8080/

Returns:
application path

getBasePath

String getBasePath()
Get absolute storage path
Path where all document will be stored (accessible by application)

Returns:
storage path

getEncryptionKey

String getEncryptionKey()
Get encrypt key
Encrypt key is used for token id's generations.
Key must be 16 characters length or null

Returns:
encrypt key

getExpirationDate

Integer getExpirationDate()
Get expiration date
Expiration date for generated token id's from file uploads.
Set 0 to unlimited.

Returns:
expiration date

getLicensePath

String getLicensePath()
Get absolute path to license file

Returns:
license file path

getLocalesPath

String getLocalesPath()
Get locales path
Path where custom locale files are stored.

Returns:
locales path

getMaxCacheSize

Long getMaxCacheSize()
Get maximum size of temp files directory

Returns:
max size

isUseAuthorization

@Deprecated
Boolean isUseAuthorization()
Deprecated. 

Get use authorization flag

Returns:
boolean value

isUseBrowserCache

Boolean isUseBrowserCache()
Browser cache flag
Prevent browsers from storing images in cache

Returns:
boolean value

isUseCache

Boolean isUseCache()
Image cache flag
This flag work only in image based engine. If this flag set to false, images are not stored in temp directory.

Returns:
boolean value

getUploadPath

String getUploadPath()
Get upload path
Default upload path is storage path.
Define path in case uploaded files should be stored in different path or return null.
Path is relative

Returns:
upload path


Copyright © 2014. All rights reserved.