thredds.server.config

Class HtmlConfig

java.lang.Object

thredds.server.config.HtmlConfig

public class HtmlConfig
extends java.lang.Object

_more_

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
HtmlConfig()

Method Summary

Modifier and Type	Method and Description
void	addHtmlConfigInfoToModel(java.util.Map<java.lang.String,java.lang.Object> model)
java.lang.String	getCatalogCssUrl() Return the URL to the CSS file used for catalog HTML pages.
java.lang.String	getDatasetIconAlt()
java.lang.String	getDatasetIconUrl() Return the URL to the icon document used for datasets in HTML catalog views.
java.lang.String	getFolderIconAlt()
java.lang.String	getFolderIconUrl() Return the URL to the icon document used for folders in HTML catalog views.
java.lang.String	getGoogleTrackingCode() Return the google tracking code for google analytics.
java.lang.String	getHostInstLogoAlt() Return the alternate text for the logo for the institution hosting this installation.
java.lang.String	getHostInstLogoUrl() Return the path to the logo file for the institution hosting this installation.
java.lang.String	getHostInstName() Return the name of the institution hosting this TDS installation.
java.lang.String	getHostInstUrl() Return the URL to a web page for the institution hosting this installation.
java.lang.String	getInstallLogoAlt() Return the alternate text for the logo for this TDS installation.
java.lang.String	getInstallLogoUrl() Return the path to the logo file for this TDS installation.
java.lang.String	getInstallName() Return the name of this TDS installation.
java.lang.String	getInstallUrl() Return the URL to the top level of this TDS installation.
java.lang.String	getPageCssUrl() Return the URL to the CSS file used for all non-catalog HTML pages.
java.lang.Boolean	getUseRemoteCatalogService() Return the config option that sets the default of whether or not to use remoteCatalogService for html representation of catalogRef's in client catalogs.
java.lang.String	getWebappContextPath()
java.lang.String	getWebappDocsUrl() Return the URL to the webapp documentation page.
java.lang.String	getWebappLogoAlt() Return the alternate text for the webapp logo.
java.lang.String	getWebappLogoUrl() Return the Url to the logo file for the webapp.
java.lang.String	getWebappName()
java.lang.String	getWebappUrl() Return the URL to the main web page for the webapp.
java.lang.String	getWebappVersion()
java.lang.String	getWebappVersionBuildDate()
void	init(java.lang.String webappName, java.lang.String webappVersion, java.lang.String webappVersionBuildDate, java.lang.String webappContextPath)
java.lang.String	prepareUrlStringForHtml(java.lang.String url) Return a URL ready to use in a generated HTML page from a URL that is either absolute or relative to the webapp context path.
void	setCatalogCssUrl(java.lang.String catalogCssUrl)
void	setDatasetIconAlt(java.lang.String datasetIconAlt)
void	setDatasetIconUrl(java.lang.String datasetIconUrl)
void	setFolderIconAlt(java.lang.String folderIconAlt)
void	setFolderIconUrl(java.lang.String folderIconUrl)
void	setGoogleTrackingCode(java.lang.String googleTrackingCode)
void	setHostInstLogoAlt(java.lang.String hostInstLogoAlt)
void	setHostInstLogoUrl(java.lang.String hostInstLogoUrl)
void	setHostInstName(java.lang.String hostInstName)
void	setHostInstUrl(java.lang.String hostInstUrl)
void	setInstallLogoAlt(java.lang.String installLogoAlt)
void	setInstallLogoUrl(java.lang.String installLogoUrl)
void	setInstallName(java.lang.String installName)
void	setInstallUrl(java.lang.String installUrl)
void	setPageCssUrl(java.lang.String pageCssUrl)
void	setUseRemoteCatalogService(java.lang.Boolean remoteCatalogService)
void	setWebappDocsUrl(java.lang.String webappDocsUrl)
void	setWebappLogoAlt(java.lang.String webappLogoAlt)
void	setWebappLogoUrl(java.lang.String webappLogoUrl)
void	setWebappUrl(java.lang.String webappUrl)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HtmlConfig

public HtmlConfig()

Method Detail

init

public void init(java.lang.String webappName,
                 java.lang.String webappVersion,
                 java.lang.String webappVersionBuildDate,
                 java.lang.String webappContextPath)

getWebappName

public java.lang.String getWebappName()

getWebappVersion

public java.lang.String getWebappVersion()

getWebappVersionBuildDate

public java.lang.String getWebappVersionBuildDate()

getWebappContextPath

public java.lang.String getWebappContextPath()

getWebappUrl

public java.lang.String getWebappUrl()

Return the URL to the main web page for the webapp.

Note: A relative URL is considered relative to the webapp context path. That is, it is relative to "http://server:port/thredds/".

Returns:

the URL to the main web page for the webapp.

setWebappUrl

public void setWebappUrl(java.lang.String webappUrl)

getWebappDocsUrl

public java.lang.String getWebappDocsUrl()

Return the URL to the webapp documentation page.

Note: A relative URL is considered relative to the webapp context path. That is, it is relative to "http://server:port/thredds/".

Returns:

the URL to the webapp documentation page.

setWebappDocsUrl

public void setWebappDocsUrl(java.lang.String webappDocsUrl)

getWebappLogoUrl

public java.lang.String getWebappLogoUrl()

Return the Url to the logo file for the webapp.

Note: A relative URL is considered relative to the webapp context path. That is, it is relative to "http://server:port/thredds/".

Returns:

the path to the logo file for the webapp.

setWebappLogoUrl

public void setWebappLogoUrl(java.lang.String webappLogoUrl)

getWebappLogoAlt

public java.lang.String getWebappLogoAlt()

Return the alternate text for the webapp logo.

Returns:

the alternate text for the webapp logo.

setWebappLogoAlt

public void setWebappLogoAlt(java.lang.String webappLogoAlt)

getPageCssUrl

public java.lang.String getPageCssUrl()

Return the URL to the CSS file used for all non-catalog HTML pages.

Note: A relative URL is considered relative to the webapp context path. That is, it is relative to "http://server:port/thredds/".

Returns:

the Url to the CSS file used for all non-catalog HTML pages.

setPageCssUrl

public void setPageCssUrl(java.lang.String pageCssUrl)

getCatalogCssUrl

public java.lang.String getCatalogCssUrl()

Return the URL to the CSS file used for catalog HTML pages.

Note: A relative URL is considered relative to the webapp context path. That is, it is relative to "http://server:port/thredds/".

Returns:

the URL to the CSS file used for catalog HTML pages.

setCatalogCssUrl

public void setCatalogCssUrl(java.lang.String catalogCssUrl)

getGoogleTrackingCode

public java.lang.String getGoogleTrackingCode()

Return the google tracking code for google analytics.

Returns:

the google tracking code for google analytics.

setGoogleTrackingCode

public void setGoogleTrackingCode(java.lang.String googleTrackingCode)

getFolderIconUrl

public java.lang.String getFolderIconUrl()

Return the URL to the icon document used for folders in HTML catalog views.

Note: A relative URL is considered relative to the webapp context path. That is, it is relative to "http://server:port/thredds/".

Returns:

the URL to the icon document used for folders in HTML catalog views.

setFolderIconUrl

public void setFolderIconUrl(java.lang.String folderIconUrl)

getFolderIconAlt

public java.lang.String getFolderIconAlt()

setFolderIconAlt

public void setFolderIconAlt(java.lang.String folderIconAlt)

getDatasetIconUrl

public java.lang.String getDatasetIconUrl()

Return the URL to the icon document used for datasets in HTML catalog views.

Note: A relative URL is considered relative to the webapp context path. That is, it is relative to "http://server:port/thredds/".

Returns:

the URL to the icon document used for datasets in HTML catalog views.

setDatasetIconUrl

public void setDatasetIconUrl(java.lang.String datasetIconUrl)

getDatasetIconAlt

public java.lang.String getDatasetIconAlt()

setDatasetIconAlt

public void setDatasetIconAlt(java.lang.String datasetIconAlt)

getInstallName

public java.lang.String getInstallName()

Return the name of this TDS installation.

Returns:

the name of this TDS installation.

setInstallName

public void setInstallName(java.lang.String installName)

getInstallUrl

public java.lang.String getInstallUrl()

Return the URL to the top level of this TDS installation.

Note: A relative URL is considered relative to the webapp context path. That is, it is relative to "http://server:port/thredds/".

Returns:

the URL to the top level of this installation.

setInstallUrl

public void setInstallUrl(java.lang.String installUrl)

getInstallLogoUrl

public java.lang.String getInstallLogoUrl()

Return the path to the logo file for this TDS installation.

Note: A relative URL is considered relative to the webapp context path. That is, it is relative to "http://server:port/thredds/".

Returns:

the path to the logo file for this installation of the webapp.

setInstallLogoUrl

public void setInstallLogoUrl(java.lang.String installLogoUrl)

getInstallLogoAlt

public java.lang.String getInstallLogoAlt()

Return the alternate text for the logo for this TDS installation.

Returns:

the alternate text for the logo for this installation.

setInstallLogoAlt

public void setInstallLogoAlt(java.lang.String installLogoAlt)

getHostInstName

public java.lang.String getHostInstName()

Return the name of the institution hosting this TDS installation.

Returns:

the name of the institution hosting this TDS installation.

setHostInstName

public void setHostInstName(java.lang.String hostInstName)

getHostInstUrl

public java.lang.String getHostInstUrl()

Return the URL to a web page for the institution hosting this installation.

Note: A relative URL is considered relative to the webapp context path. That is, it is relative to "http://server:port/thredds/".

Returns:

the URL to a web page for the institution hosting this installation.

setHostInstUrl

public void setHostInstUrl(java.lang.String hostInstUrl)

getHostInstLogoUrl

public java.lang.String getHostInstLogoUrl()

Return the path to the logo file for the institution hosting this installation.

Note: A relative URL is considered relative to the webapp context path. That is, it is relative to "http://server:port/thredds/".

Returns:

the path to the logo file for the institution hosting this installation.

setHostInstLogoUrl

public void setHostInstLogoUrl(java.lang.String hostInstLogoUrl)

getHostInstLogoAlt

public java.lang.String getHostInstLogoAlt()

Return the alternate text for the logo for the institution hosting this installation.

Returns:

the alternate text for the logo for the institution hosting this installation.

setHostInstLogoAlt

public void setHostInstLogoAlt(java.lang.String hostInstLogoAlt)

getUseRemoteCatalogService

public java.lang.Boolean getUseRemoteCatalogService()

Return the config option that sets the default of whether or not to use remoteCatalogService for html representation of catalogRef's in client catalogs.

Returns:

true: use remoteCatalogService, false: assume catalogRef's point to a TDS, so simply link the html url of the remote catalog.

setUseRemoteCatalogService

public void setUseRemoteCatalogService(java.lang.Boolean remoteCatalogService)

prepareUrlStringForHtml

public java.lang.String prepareUrlStringForHtml(java.lang.String url)

Return a URL ready to use in a generated HTML page from a URL that is either absolute or relative to the webapp context path. That is, if relative, it is relative to "http://server:port/thredds/".

For simplicity, all relative URLs are converted to URLs that are absolute paths. For instance, "catalog.xml" becomes "/thredds/catalog.xml".

Parameters:

url - the URL to prepare for use in HTML.

Returns:

a URL ready to use in a generated HTML page.

addHtmlConfigInfoToModel

public void addHtmlConfigInfoToModel(java.util.Map<java.lang.String,java.lang.Object> model)