|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.util.prefs.WcmConfiguration
This class providers access to site and user preferences
Field Summary | |
protected static java.lang.String |
APPLICATION_ENGINE_ADMINS
|
protected java.lang.String |
appName
|
protected static java.lang.String |
basePath
|
protected static WcmBootstrapPrefs |
bootstrap
|
protected boolean |
bUseLocalFile
|
protected java.lang.String |
configFilePath
|
protected WcmServerCredentials |
credentials
|
protected WcmDataStore |
dataStore
|
protected static boolean |
ENABLE_DEBUG_TRACE
|
protected java.lang.String |
objectStoreName
|
protected static java.lang.String |
PREFS_DOCUMENT_CLASS
|
static java.lang.String |
PREFS_DOCUMENT_CLASS_ID
|
protected static java.lang.String |
PREFS_FILE_NAME
|
protected static java.lang.String |
PREFS_FOLDER_CLASS
|
protected static java.lang.String |
PREFS_FOLDER_NAME
|
protected static java.lang.String |
PREFS_MIME_TYPE
|
protected static java.util.Map |
prefsFoldersExist
|
protected com.filenet.wcm.api.Session |
session
|
protected com.filenet.wcm.api.Document |
sitePrefsDocument
|
protected java.lang.String |
sitePrefsDocumentName
|
protected static java.util.Map |
sitePrefsMap
|
protected java.lang.String |
sitePrefsMapKey
|
protected WcmPrefsObject |
userPrefs
|
protected com.filenet.wcm.api.Document |
userPrefsDocument
|
protected java.lang.String |
userPrefsDocumentName
|
Constructor Summary | |
WcmConfiguration(WcmDataStore ds,
java.lang.String prefsObjectStoreName,
java.lang.String applicationName)
|
Method Summary | |
protected com.filenet.wcm.api.Document |
addNewDocument(WcmPrefsObject content,
java.lang.String documentTitle,
boolean site,
com.filenet.wcm.api.Permissions permissions)
|
java.lang.String |
addSitePrefsDocument()
Adds new Site preferences document |
java.lang.String |
addUserPrefsDocument()
Adds new User Preferences Document |
void |
cancelCheckoutSitePreferences()
Cancels checkout of Site Preferences document |
void |
checkinSitePreferences()
Checks in Site Preferences |
java.lang.String |
checkoutSitePreferences()
Checks out Site Preferences |
java.lang.String |
createNewSitePrefs()
Creates new Site Preferences Document |
java.lang.String |
createNewUserPrefs()
|
protected com.filenet.wcm.api.Folder |
createPreferencesFolder()
|
protected static void |
debugTrace(java.lang.Object o)
|
static java.lang.String |
getBasePath()
Deprecated. use application context to get resource files |
static WcmBootstrapPrefs |
getBootstrapPrefs()
Returns WcmBootstrapPrefs object |
protected com.filenet.wcm.api.Permissions |
getSitePreferencesPermissions()
|
WcmPrefsObject |
getSitePrefsObject()
Returns Site Preferences Object |
WcmPrefsObject |
getUserPrefsObject()
Returns User Preferences Object |
void |
initialize(WcmDataStore ds,
java.lang.String prefsObjectStoreName,
java.lang.String applicationName)
Initializes WcmConfiguration |
static boolean |
isEProcessConfigured()
Returns true if eProcess is enabled in bootstrap.properties |
boolean |
isSitePreferencesCheckedOut()
Returns true if site preferences document is checked out |
static void |
loadBootstrap(java.util.Locale locale,
javax.servlet.ServletContext context)
Loads bootstrap |
static void |
loadBootstrap(java.util.Locale locale,
java.lang.String filePath)
Loads bootstrap |
static void |
loadBootstrap(javax.servlet.ServletContext context)
Loads bootstrap |
static void |
loadBootstrap(java.lang.String filePath)
Loads bootstrap |
void |
loadSitePreferences()
Lodas Site Preferences |
void |
loadUserPreferences()
Loads user preferences from the Object Store |
static void |
reloadBootstrap()
Reloads bootstrap |
static void |
reloadBootstrap(java.util.Locale locale)
Reloads bootstrap |
void |
resetSitePreferences(java.lang.String applicationName)
|
protected com.filenet.wcm.api.TransportInputStream |
retrieveDocument(com.filenet.wcm.api.Document document)
|
protected com.filenet.wcm.api.TransportInputStream |
retrieveDocument(java.lang.String docName)
|
protected com.filenet.wcm.api.TransportInputStream |
retrieveDocumentByPath(java.lang.String path)
|
void |
saveBootstrapPreferences()
|
java.lang.String |
saveSitePreferences()
Saves Site Preferences |
java.lang.String |
saveSitePreferences(boolean keepCheckout)
Saves Site Preferences |
java.lang.String |
saveUserPreferences()
Saves User Preferences |
static void |
setBasePath(java.lang.String path)
Deprecated. use application context to get resource files |
protected void |
setSitePrefsObject(WcmPrefsObject pSitePrefs)
|
protected void |
setUserPrefsObject(WcmPrefsObject pUserPrefs)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String PREFS_DOCUMENT_CLASS_ID
protected static final java.lang.String PREFS_DOCUMENT_CLASS
protected static final java.lang.String PREFS_FOLDER_CLASS
protected static final java.lang.String PREFS_FOLDER_NAME
protected static final java.lang.String PREFS_MIME_TYPE
protected static final java.lang.String PREFS_FILE_NAME
protected static final java.lang.String APPLICATION_ENGINE_ADMINS
protected static final boolean ENABLE_DEBUG_TRACE
protected static WcmBootstrapPrefs bootstrap
protected static java.lang.String basePath
protected static java.util.Map sitePrefsMap
protected static java.util.Map prefsFoldersExist
protected WcmPrefsObject userPrefs
protected com.filenet.wcm.api.Document userPrefsDocument
protected com.filenet.wcm.api.Document sitePrefsDocument
protected WcmServerCredentials credentials
protected com.filenet.wcm.api.Session session
protected java.lang.String userPrefsDocumentName
protected java.lang.String sitePrefsDocumentName
protected boolean bUseLocalFile
protected java.lang.String appName
protected java.lang.String objectStoreName
protected java.lang.String sitePrefsMapKey
protected WcmDataStore dataStore
protected java.lang.String configFilePath
Constructor Detail |
public WcmConfiguration(WcmDataStore ds, java.lang.String prefsObjectStoreName, java.lang.String applicationName) throws java.lang.Exception
Method Detail |
public void initialize(WcmDataStore ds, java.lang.String prefsObjectStoreName, java.lang.String applicationName) throws java.lang.Exception
ds
- prefsObjectStoreName
- applicationName
-
java.lang.Exception
public void resetSitePreferences(java.lang.String applicationName)
protected com.filenet.wcm.api.TransportInputStream retrieveDocument(java.lang.String docName)
protected com.filenet.wcm.api.TransportInputStream retrieveDocumentByPath(java.lang.String path)
protected com.filenet.wcm.api.TransportInputStream retrieveDocument(com.filenet.wcm.api.Document document)
public void saveBootstrapPreferences() throws java.lang.Exception
java.lang.Exception
public java.lang.String addUserPrefsDocument() throws java.lang.Exception
java.lang.Exception
public java.lang.String createNewUserPrefs() throws java.lang.Exception
java.lang.Exception
public void loadUserPreferences() throws java.lang.Exception
WcmConfigurationInterface
loadUserPreferences
in interface WcmConfigurationInterface
java.lang.Exception
public static void reloadBootstrap(java.util.Locale locale) throws java.io.IOException
locale
- the client locale
java.io.IOException
public static void reloadBootstrap() throws java.io.IOException
java.io.IOException
public static void loadBootstrap(java.util.Locale locale, java.lang.String filePath) throws java.io.IOException
locale
- filePath
-
java.io.IOException
public static void loadBootstrap(java.lang.String filePath) throws java.io.IOException
filePath
-
java.io.IOException
public static void loadBootstrap(java.util.Locale locale, javax.servlet.ServletContext context) throws java.io.IOException
context
-
java.io.IOException
public static void loadBootstrap(javax.servlet.ServletContext context) throws java.io.IOException
context
-
java.io.IOException
public static boolean isEProcessConfigured()
public void loadSitePreferences() throws java.lang.Exception
loadSitePreferences
in interface WcmConfigurationInterface
java.lang.Exception
protected com.filenet.wcm.api.Permissions getSitePreferencesPermissions() throws java.lang.Exception
java.lang.Exception
public java.lang.String addSitePrefsDocument() throws java.lang.Exception
java.lang.Exception
public java.lang.String createNewSitePrefs() throws java.lang.Exception
java.lang.Exception
public java.lang.String saveSitePreferences() throws java.lang.Exception
saveSitePreferences
in interface WcmConfigurationInterface
java.lang.Exception
public java.lang.String saveSitePreferences(boolean keepCheckout) throws java.lang.Exception
keepCheckout
- boolean true to keep the site preferences checked out.
java.lang.Exception
public java.lang.String saveUserPreferences() throws java.lang.Exception
saveUserPreferences
in interface WcmConfigurationInterface
java.lang.Exception
public void cancelCheckoutSitePreferences()
public boolean isSitePreferencesCheckedOut()
public java.lang.String checkoutSitePreferences() throws java.lang.Exception
java.lang.Exception
public void checkinSitePreferences() throws java.lang.Exception
java.lang.Exception
protected com.filenet.wcm.api.Document addNewDocument(WcmPrefsObject content, java.lang.String documentTitle, boolean site, com.filenet.wcm.api.Permissions permissions) throws java.lang.Exception
java.lang.Exception
protected com.filenet.wcm.api.Folder createPreferencesFolder()
protected static void debugTrace(java.lang.Object o)
public static void setBasePath(java.lang.String path)
public static java.lang.String getBasePath()
public static WcmBootstrapPrefs getBootstrapPrefs()
protected void setSitePrefsObject(WcmPrefsObject pSitePrefs)
public WcmPrefsObject getSitePrefsObject()
getSitePrefsObject
in interface WcmConfigurationInterface
protected void setUserPrefsObject(WcmPrefsObject pUserPrefs)
public WcmPrefsObject getUserPrefsObject()
getUserPrefsObject
in interface WcmConfigurationInterface
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |