com.centrasite.control.config
Class GUIConfigurationExt

java.lang.Object
  extended by com.centrasite.configuration.gui.GUIConfigurationFile
      extended by com.centrasite.configuration.gui.GUIConfiguration
          extended by com.centrasite.control.config.GUIConfigurationExt

public class GUIConfigurationExt
extends com.centrasite.configuration.gui.GUIConfiguration

Handle the reading, storage and access of user specific configuration values.

The user specific configuration file will be stored in WebDAV to the path:

    /projects/CentraSite/Control/users/{username}/GUIConfiguration.xml.

This allows us to store user settings such as:

Example configuration:

<GUIConfiguration>
    <View>Technical</View>
    <UDDI>
        <URL>X:1</URL>
        <URL>X:2</URL>
    </UDDI>
    <Report>
        <SomeRep>
            <Column-A>
                <Width>0.7</Width>
                <Selected>true</Selected>
            </Column-A>
            <Column-B>
                <Width>0.3</Width>
                <Selected>false</Selected>
            </Column-B>
        </SomeRep>
    </Report>
</GUIConfiguration>


Field Summary
static int BOX_WIDTH_DEFAULT_VALUE
           
static java.lang.String rcs_id
           
 
Constructor Summary
GUIConfigurationExt(com.softwareag.cst.util.security.Credentials credentials, com.centrasite.util.RepositoryConnector repoConnector, com.centrasite.configuration.gui.GuiConfigurationInfo info)
          Get the GUI configuration properties from WebDAV for the specified user.
 
Method Summary
 void addUDDIUrl(java.lang.String url)
          Add entry to list of UDDI URLs.
 int getBoxWidth()
          Return the width of boxes to be displayed in Graphical Impact Analysis
 boolean getReportColumnSelected(ReportInterface ri, java.lang.String column)
          Is the specified column selected for viewing?
 double getReportColumnWidth(ReportInterface ri, java.lang.String column)
          Get the width for the specified column.
 boolean getReportExists(ReportInterface ri)
          Does settings for this Report exist ?
 boolean getShowDetailView()
          Return the value indicating whether to display the Detail View of Graphical Impact Analysis
 java.lang.String[] getUDDIUrls()
          Get list of UDDI URLs.
 java.lang.String getView()
          Get the selected view (business/technical/administrator).
 void setBoxWidth(java.lang.String boxWidthStr)
          Set the width of boxes to be displayed in Graphical Impact Analysis
 void setReportColumnSelected(ReportInterface ri, java.lang.String column, boolean selected)
          Is the specified column selected for viewing?
 void setReportColumnWidth(ReportInterface ri, java.lang.String column, double width)
          Set the width for the specified column.
 void setShowDetailView(boolean showDetailView)
          Set the value indicating whether to display the Detail View of Graphical Impact Analysis
 void setUDDIUrls(java.lang.String[] urls)
          Set list of UDDI URLs.
 void setView(java.lang.String view)
          Set the selected view (business/technical/administrator).
 
Methods inherited from class com.centrasite.configuration.gui.GUIConfiguration
getLanguage, getLastUsedBrowseByOption, getLastUsedImpactAnalysisFilter, getLastUsedTypeSelection, getPointSeparator, getTimeZone, getTimeZoneID, getTypesColumnCollabsable, getUserDateFormat, getUserLocale, getUserStarterPage, getUserTimeFormat, setLanguage, setLastUsedBrowseByOption, setLastUsedImpactAnalysisFilter, setLastUsedTypeSelection, setPointSeparator, setTimeZone, setTimeZoneID, setTypesColumnCollabsable, setUserDateFormat, setUserLocale, setUserStarterPage, setUserTimeFormat
 
Methods inherited from class com.centrasite.configuration.gui.GUIConfigurationFile
getCredentials, getFolder, getLocale, getRepositoryConnector, getUserConfigFile, getUserProp, saveConfiguration, setUserConfigFile, toMap
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

rcs_id

public static final java.lang.String rcs_id
See Also:
Constant Field Values

BOX_WIDTH_DEFAULT_VALUE

public static final int BOX_WIDTH_DEFAULT_VALUE
See Also:
Constant Field Values
Constructor Detail

GUIConfigurationExt

public GUIConfigurationExt(com.softwareag.cst.util.security.Credentials credentials,
                           com.centrasite.util.RepositoryConnector repoConnector,
                           com.centrasite.configuration.gui.GuiConfigurationInfo info)
Get the GUI configuration properties from WebDAV for the specified user.

Parameters:
credentials - user's credentials (domain, name, password)
repoConnector - RepositoryConnector
locale - locale for error messages/exceptions
Throws:
java.lang.RuntimeException - if a WebDAV error, IO or XML parsing error occurs
Method Detail

getView

public java.lang.String getView()
Get the selected view (business/technical/administrator).

Returns:
selected view

setView

public void setView(java.lang.String view)
Set the selected view (business/technical/administrator).

Parameters:
view - selected view

getUDDIUrls

public java.lang.String[] getUDDIUrls()
Get list of UDDI URLs.

Returns:
list of urls (maybe empty but not null)

setUDDIUrls

public void setUDDIUrls(java.lang.String[] urls)
Set list of UDDI URLs.

Parameters:
urls - list of urls (maybe empty but not null)

addUDDIUrl

public void addUDDIUrl(java.lang.String url)
Add entry to list of UDDI URLs.

Parameters:
url - to be added - will be ignored if already in list

getReportExists

public boolean getReportExists(ReportInterface ri)
Does settings for this Report exist ?

Parameters:
ri - report being checked
Returns:
true if selected otherwise false

getReportColumnSelected

public boolean getReportColumnSelected(ReportInterface ri,
                                       java.lang.String column)
Is the specified column selected for viewing?

Parameters:
ri - report being checked
column - column name
Returns:
true if selected otherwise false

setReportColumnSelected

public void setReportColumnSelected(ReportInterface ri,
                                    java.lang.String column,
                                    boolean selected)
Is the specified column selected for viewing?

Parameters:
ri - report being checked
column - column name
selected - true if selected otherwise false

getReportColumnWidth

public double getReportColumnWidth(ReportInterface ri,
                                   java.lang.String column)
Get the width for the specified column.

Parameters:
ri - report being checked
column - column name
Returns:
column width (relative not absolute)

setReportColumnWidth

public void setReportColumnWidth(ReportInterface ri,
                                 java.lang.String column,
                                 double width)
Set the width for the specified column.

Parameters:
ri - report being checked
column - column name
width - column width (relative not absolute)

setShowDetailView

public void setShowDetailView(boolean showDetailView)
Set the value indicating whether to display the Detail View of Graphical Impact Analysis


getShowDetailView

public boolean getShowDetailView()
                          throws javax.wvcm.WvcmException
Return the value indicating whether to display the Detail View of Graphical Impact Analysis

Returns:
true if to display the Detail View of Graphical Impact Analysis
Throws:
javax.wvcm.WvcmException

setBoxWidth

public void setBoxWidth(java.lang.String boxWidthStr)
Set the width of boxes to be displayed in Graphical Impact Analysis


getBoxWidth

public int getBoxWidth()
Return the width of boxes to be displayed in Graphical Impact Analysis

Returns:
width of boxes to be displayed in Graphical Impact Analysis
Throws:
javax.wvcm.WvcmException