com.filenet.wcm.toolkit.server.util.prefs
Class WcmBootstrapPrefs

java.lang.Object
  extended byjava.util.Dictionary
      extended byjava.util.Hashtable
          extended byjava.util.Properties
              extended bycom.filenet.wcm.toolkit.server.util.prefs.WcmBootstrapPrefs
All Implemented Interfaces:
java.lang.Cloneable, java.util.Map, java.io.Serializable

public class WcmBootstrapPrefs
extends java.util.Properties

This class provides access to the bootstrap.properties configuration file.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.Properties
defaults
 
Constructor Summary
WcmBootstrapPrefs()
          Default constructor
WcmBootstrapPrefs(java.util.Locale locale, javax.servlet.ServletContext servletContext)
          Instantiates a new object using config path
WcmBootstrapPrefs(java.util.Locale locale, java.lang.String filePath)
          Instantiates a new object using complete file path
WcmBootstrapPrefs(javax.servlet.ServletContext servletContext)
          Instantiates a new object using config path
WcmBootstrapPrefs(java.lang.String filePath)
          Instantiates a new object using complete file path
 
Method Summary
 boolean getAcceptTokens()
          Tells whether or not the framework should consume user tokens.
 boolean getAllowGuest()
          Gets whether or not guests are allowed.
 java.lang.String getApplicationName()
          Gets the preferred application string name.
 java.lang.String getBannerImageHeight()
          Gets the height to display the banner in.
 java.lang.String getBannerImagePath()
          Gets the location of the banner graphic.
 java.lang.String getBannerImageWidth()
          Gets the width to display the banner in.
 int getComponentSortOrderOffset()
          Returns the component sort order offset that is used to add new Component Relationship object.
 java.lang.String getConfigFilePath()
          Deprecated. this will return null
 java.lang.String getCvlDisplayRangeMax()
          Gets the range maximum for displaying CVL lists.
 java.lang.String getDocumentationServer()
          Gets the URL of the documentation server.
 boolean getGenerateTokens()
          Tells whether or not the framework should generate user tokens.
 java.lang.String getGuestPassword()
          Gets the guest user password.
 java.lang.String getGuestUser()
          Gets the guest user name.
 java.lang.String getInstallDir()
           
 java.lang.String getIsraInterfaceServletURL()
           
 java.lang.String getJavaHTTPPort()
          Gets the direct HTTP port on the Java application server.
 int getMergeFileRefreshInterval()
           
 java.lang.String getMergeFileVersionId()
           
 java.lang.String getMergeFileVersionSeriesId()
           
 java.lang.String getPrefsObjectStoreName()
          Gets the object store id string name.
 boolean getPromptAddOnSend()
          Tells whether or not outlook should add when a send is executed.
 boolean getSetContainmentNameOnAdd()
          This setting determines containment name setting behavior when a document is added via Workplace or WebDAV.
 boolean getShowChoiceValue()
           
 boolean getShowFolderInheritance()
          Tells whether or not to display the Folder Inheritance Behavior settings in site preference.
 java.lang.String getSSLInfo()
          Gets the SSL host:port value.
 int getTokenTimeoutInterval()
          Get the value in minutes of the amount of time the token will be accepted from its creation.
 boolean getUseEnhancedTimeZoneDetection()
           
 boolean isEProcessConfigured()
          Returns a boolean that indicates whether eProcess is enabled or disabled.
 boolean isUsingLocalPreferences()
           
protected  void loadDefaults()
          Sets the bootstrap preference fields to their default values (null if not listed): Preference Name: "Workplace" Allow Guests: False Banner Path: images/web/common/Banner.gif Banner Width: 220 Banner Height: 45 eProcess Enabled: True
 void reload()
          Loads the file and set up member variables.
 void reload(java.util.Locale locale)
          Loads the file and set up member variables.
 void save()
          Saves the file.
 void setAcceptTokens(boolean value)
          Specify whether or not the framework should consume user tokens to attempt sign in using a request-supplied user token (WcmParameter.USER_TOKEN).
 void setAllowGuest(boolean allow)
          Sets whether or not guest are allowed.
 void setApplicationName(java.lang.String appName)
          Sets he preferred application string name.
 void setBannerImageHeight(int height)
          Sets the height for the banner graphic.
 void setBannerImagePath(java.lang.String imagePath)
          Sets the image URL of the banner graphic.
 void setBannerImageWidth(int width)
          Sets the width for the banner graphic.
 void setDocumentationServer(java.lang.String url)
          Sets the URL of the documentation server.
 void setGenerateTokens(boolean value)
          Specify whether or not the framework should produce user tokens via the getUserToken op of setCredentials, or the ChangeApp controller event.
 void setGuestPassword(java.lang.String password)
          Sets the guest user password.
 void setGuestUser(java.lang.String guestUserID)
          Sets the guest user name.
 void setIsraInterfaceServletURL(java.lang.String israInterfaceServletURL)
           
 void setJavaHTTPPort(java.lang.String port)
          Sets the direct HTTP port on the Java application server.
 void setPrefsObjectStoreName(java.lang.String newObjectStoreName)
          Sets the object store id string name.
 void setPromptAddOnSend(boolean value)
          Tells whether or not outlook should add when a send is executed.
 void setSSLInfo(java.lang.String newSSLInfo)
          Sets the SSL host:port value.
 void setTokenTimeoutInterval(int value)
          Set the value in minutes of the amount of time the token will be accepted from its creation.
 void setUseEnhancedTimeZoneDetection(boolean value)
           
 void store(java.io.OutputStream out, java.lang.String header)
          Sets the SSL host:port value.
 
Methods inherited from class java.util.Properties
getProperty, getProperty, list, list, load, propertyNames, save, setProperty
 
Methods inherited from class java.util.Hashtable
clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WcmBootstrapPrefs

public WcmBootstrapPrefs()
Default constructor


WcmBootstrapPrefs

public WcmBootstrapPrefs(java.util.Locale locale,
                         java.lang.String filePath)
                  throws java.io.IOException
Instantiates a new object using complete file path

Parameters:
locale - the client locale
filePath - location of bootstrap file
Throws:
java.io.IOException - if any IO errors occur

WcmBootstrapPrefs

public WcmBootstrapPrefs(java.lang.String filePath)
                  throws java.io.IOException
Instantiates a new object using complete file path

Parameters:
filePath - location of bootstrap file

WcmBootstrapPrefs

public WcmBootstrapPrefs(java.util.Locale locale,
                         javax.servlet.ServletContext servletContext)
                  throws java.io.IOException
Instantiates a new object using config path

Parameters:
locale - the client locale
servletContext - ServletContext of application
Throws:
java.io.IOException - if any IO errors occur

WcmBootstrapPrefs

public WcmBootstrapPrefs(javax.servlet.ServletContext servletContext)
                  throws java.io.IOException
Instantiates a new object using config path

Parameters:
servletContext - ServletContext of application
Throws:
java.io.IOException - if any IO errors occur
Method Detail

getInstallDir

public java.lang.String getInstallDir()

getGenerateTokens

public boolean getGenerateTokens()
Tells whether or not the framework should generate user tokens.

Returns:
true or false

setGenerateTokens

public void setGenerateTokens(boolean value)
Specify whether or not the framework should produce user tokens via the getUserToken op of setCredentials, or the ChangeApp controller event.

Parameters:
value - - boolean true or false.

getIsraInterfaceServletURL

public java.lang.String getIsraInterfaceServletURL()

setIsraInterfaceServletURL

public void setIsraInterfaceServletURL(java.lang.String israInterfaceServletURL)

getUseEnhancedTimeZoneDetection

public boolean getUseEnhancedTimeZoneDetection()

setUseEnhancedTimeZoneDetection

public void setUseEnhancedTimeZoneDetection(boolean value)

getAcceptTokens

public boolean getAcceptTokens()
Tells whether or not the framework should consume user tokens.

Returns:
true or false

getPromptAddOnSend

public boolean getPromptAddOnSend()
Tells whether or not outlook should add when a send is executed.

Returns:
true or false

setPromptAddOnSend

public void setPromptAddOnSend(boolean value)
Tells whether or not outlook should add when a send is executed.

Parameters:
value - - boolean true or false.

getShowFolderInheritance

public boolean getShowFolderInheritance()
Tells whether or not to display the Folder Inheritance Behavior settings in site preference.

Returns:
true or false

getComponentSortOrderOffset

public int getComponentSortOrderOffset()
Returns the component sort order offset that is used to add new Component Relationship object. If the value is not greater than 0, then the default value of 1000 will be returned.

Returns:
int The offset value

setAcceptTokens

public void setAcceptTokens(boolean value)
Specify whether or not the framework should consume user tokens to attempt sign in using a request-supplied user token (WcmParameter.USER_TOKEN).

Parameters:
value - - boolean true or false.

getTokenTimeoutInterval

public int getTokenTimeoutInterval()
Get the value in minutes of the amount of time the token will be accepted from its creation. When acceptTokens is set to true.

Returns:
Integer value 1 to 15 minutes. Default is 1 minute.

setTokenTimeoutInterval

public void setTokenTimeoutInterval(int value)
Set the value in minutes of the amount of time the token will be accepted from its creation. When acceptTokens is set to true.

Parameters:
value - - Number of minutes to set the timeout.

getSSLInfo

public java.lang.String getSSLInfo()
Gets the SSL host:port value.

Returns:
The String value.

setDocumentationServer

public void setDocumentationServer(java.lang.String url)
Sets the URL of the documentation server.

Parameters:
url - String

getDocumentationServer

public java.lang.String getDocumentationServer()
Gets the URL of the documentation server.

Returns:
String

getApplicationName

public java.lang.String getApplicationName()
Gets the preferred application string name.

Returns:
String

setApplicationName

public void setApplicationName(java.lang.String appName)
Sets he preferred application string name.

Parameters:
appName - String

setSSLInfo

public void setSSLInfo(java.lang.String newSSLInfo)
Sets the SSL host:port value.

Parameters:
newSSLInfo - value

setJavaHTTPPort

public void setJavaHTTPPort(java.lang.String port)
Sets the direct HTTP port on the Java application server.

Parameters:
port - String

getJavaHTTPPort

public java.lang.String getJavaHTTPPort()
Gets the direct HTTP port on the Java application server.

Returns:
String

getGuestUser

public java.lang.String getGuestUser()
Gets the guest user name.

Returns:
The String value.

setGuestUser

public void setGuestUser(java.lang.String guestUserID)
Sets the guest user name.

Parameters:
guestUserID - value

getGuestPassword

public java.lang.String getGuestPassword()
Gets the guest user password.

Returns:
The String value.

setGuestPassword

public void setGuestPassword(java.lang.String password)
Sets the guest user password.

Parameters:
password - value

getAllowGuest

public boolean getAllowGuest()
Gets whether or not guests are allowed.

Returns:
true or false.

isEProcessConfigured

public boolean isEProcessConfigured()
Returns a boolean that indicates whether eProcess is enabled or disabled.

Returns:
Boolean

getPrefsObjectStoreName

public java.lang.String getPrefsObjectStoreName()
Gets the object store id string name.

Returns:
String

setPrefsObjectStoreName

public void setPrefsObjectStoreName(java.lang.String newObjectStoreName)
Sets the object store id string name.

Parameters:
newObjectStoreName - String

setAllowGuest

public void setAllowGuest(boolean allow)
Sets whether or not guest are allowed.

Parameters:
allow - boolean value

getBannerImagePath

public java.lang.String getBannerImagePath()
Gets the location of the banner graphic.

Returns:
The String value.

setBannerImagePath

public void setBannerImagePath(java.lang.String imagePath)
Sets the image URL of the banner graphic.

Parameters:
imagePath -

getBannerImageWidth

public java.lang.String getBannerImageWidth()
Gets the width to display the banner in.

Returns:
The String value.

setBannerImageWidth

public void setBannerImageWidth(int width)
Sets the width for the banner graphic.

Parameters:
width -

getBannerImageHeight

public java.lang.String getBannerImageHeight()
Gets the height to display the banner in.

Returns:
The int value.

setBannerImageHeight

public void setBannerImageHeight(int height)
Sets the height for the banner graphic.

Parameters:
height -

getMergeFileVersionId

public java.lang.String getMergeFileVersionId()

getMergeFileVersionSeriesId

public java.lang.String getMergeFileVersionSeriesId()

getMergeFileRefreshInterval

public int getMergeFileRefreshInterval()

getShowChoiceValue

public boolean getShowChoiceValue()

getSetContainmentNameOnAdd

public boolean getSetContainmentNameOnAdd()
This setting determines containment name setting behavior when a document is added via Workplace or WebDAV. true (default) - when a new Document is created, the RCR associated with the Document has its ContainmentName property set to the Document's Name property plus a file extension. false - when a Document is created, the RCR associated with the Document has its ContainmentName property set as it would have been in prior to AE 4.0.

Returns:

getCvlDisplayRangeMax

public java.lang.String getCvlDisplayRangeMax()
Gets the range maximum for displaying CVL lists.

Returns:
The String value.

getConfigFilePath

public java.lang.String getConfigFilePath()
Deprecated. this will return null


isUsingLocalPreferences

public boolean isUsingLocalPreferences()

loadDefaults

protected void loadDefaults()
Sets the bootstrap preference fields to their default values (null if not listed): Preference Name: "Workplace" Allow Guests: False Banner Path: images/web/common/Banner.gif Banner Width: 220 Banner Height: 45 eProcess Enabled: True


reload

public void reload(java.util.Locale locale)
            throws java.io.IOException
Loads the file and set up member variables.

Parameters:
locale - client locale
Throws:
java.io.IOException - if any IO errors occur

reload

public void reload()
            throws java.io.IOException
Loads the file and set up member variables.

Throws:
java.io.IOException - if any IO errors occur

save

public void save()
          throws java.io.IOException
Saves the file.

Throws:
java.io.IOException - if any IO errors occur

store

public void store(java.io.OutputStream out,
                  java.lang.String header)
           throws java.io.IOException
Sets the SSL host:port value.

Parameters:
out -
header -
Throws:
java.io.IOException - if any IO errors occur


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.