Package org.opencms.workplace.tools.sites

Class CmsSiteBean

java.lang.Object
org.opencms.workplace.tools.sites.CmsSiteBean
All Implemented Interfaces:
Serializable
public class CmsSiteBean extends Object implements Serializable
Dialog object for a single site.

Since:
9.0.0
See Also:

  • Constructor Details

    • CmsSiteBean

      public CmsSiteBean()
      Default constructor.

    • CmsSiteBean

      public CmsSiteBean(org.opencms.site.CmsSite site)
      Public constructor with a CmsSite as parameter.

      Parameters:
      site - the site

  • Method Details

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
      See Also:

    • getAliases

      public List<String> getAliases()
      Returns the aliases.

      Returns:
      the aliases

    • getAlternativeSiteRootMapping

      public org.opencms.site.CmsAlternativeSiteRootMapping getAlternativeSiteRootMapping()
      Gets the alternative site root mapping.
      Returns:
      the alternative site root mapping

    • getErrorPage

      public String getErrorPage()
      Returns the errorPage.

      Returns:
      the errorPage

    • getFavicon

      public String getFavicon()
      Returns the favicon.

      Returns:
      the favicon

    • getOriginalSite

      public org.opencms.site.CmsSite getOriginalSite()
      Returns the originalSite.

      Returns:
      the originalSite

    • getParameters

      public SortedMap<String,String> getParameters()
      Gets the parameters.

      Returns:
      the site parameters

    • getPort

      public int getPort()
      Returns the port.

      Returns:
      the port

    • getPosition

      public float getPosition()
      Returns the position.

      Returns:
      the position

    • getRedirectAliases

      public List<String> getRedirectAliases()
      Returns the list of aliases that are configured to redirect to the site's main URL.

      Returns:
      the redirect aliases

    • getSecureUrl

      public String getSecureUrl()
      Returns the secureUrl.

      Returns:
      the secureUrl

    • getServer

      public String getServer()
      Returns the server.

      Returns:
      the server

    • getServerName

      public String getServerName()
      Returns the serverName.

      Returns:
      the serverName

    • getServerProtocol

      public String getServerProtocol()
      Returns the serverProtocol.

      Returns:
      the serverProtocol

    • getSiteRoot

      public String getSiteRoot()
      Returns the siteRoot.

      Returns:
      the siteRoot

    • getSslMode

      public String getSslMode()
      Gets the SSL mode.

      Returns:
      the SSL mode

    • getTimeOffset

      public long getTimeOffset()
      Returns the timeOffset.

      Returns:
      the timeOffset

    • getTitle

      public String getTitle()
      Returns the title.

      Returns:
      the title

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
      See Also:

    • hasSecureServer

      public boolean hasSecureServer()
      Returns the secureServer.

      Returns:
      the secureServer

    • isExclusiveError

      public boolean isExclusiveError()
      Returns the exclusiveError.

      Returns:
      the exclusiveError

    • isExclusiveUrl

      public boolean isExclusiveUrl()
      Returns the exclusiveUrl.

      Returns:
      the exclusiveUrl

    • isSecureServer

      public boolean isSecureServer()
      Returns the secureServer.

      Returns:
      the secureServer

    • isWebserver

      public boolean isWebserver()
      Returns the web server.

      Returns:
      the web server

    • setAlternativeSiteRootMapping

      public void setAlternativeSiteRootMapping(org.opencms.site.CmsAlternativeSiteRootMapping alternativeSiteRootMapping)
      Sets the alternative site root mapping.
      Parameters:
      alternativeSiteRootMapping - the site root mapping

    • setErrorPage

      public void setErrorPage(String errorPage)
      Sets the errorPage.

      Parameters:
      errorPage - the errorPage to set

    • setExclusiveError

      public void setExclusiveError(boolean exclusiveError)
      Sets the exclusiveError.

      Parameters:
      exclusiveError - the exclusiveError to set

    • setExclusiveUrl

      public void setExclusiveUrl(boolean exclusiveUrl)
      Sets the exclusiveUrl.

      Parameters:
      exclusiveUrl - the exclusiveUrl to set

    • setFavicon

      public void setFavicon(String favicon)
      Sets the favicon.

      Parameters:
      favicon - the favicon to set

    • setParameters

      public void setParameters(SortedMap<String,String> params)
      Sets the parameters.

      Parameters:
      params - the parameters

    • setPort

      public void setPort(int port)
      Sets the port.

      Parameters:
      port - the port to set

    • setPosition

      public void setPosition(float position)
      Sets the position.

      Parameters:
      position - the position to set

    • setSecureServer

      public void setSecureServer(boolean secureServer)
      Sets the secureServer.

      Parameters:
      secureServer - the secureServer to set

    • setSecureUrl

      public void setSecureUrl(String secureUrl)
      Sets the secureUrl.

      Parameters:
      secureUrl - the secureUrl to set

    • setServer

      public void setServer(String server)
      Sets the server.

      Parameters:
      server - the server to set

    • setServerName

      public void setServerName(String serverName)
      Sets the serverName.

      Parameters:
      serverName - the serverName to set

    • setServerProtocol

      public void setServerProtocol(String serverProtocol)
      Sets the serverProtocol.

      Parameters:
      serverProtocol - the serverProtocol to set

    • setSiteRoot

      public void setSiteRoot(String siteRoot)
      Sets the siteRoot.

      Parameters:
      siteRoot - the siteRoot to set

    • setSslMode

      public void setSslMode(String mode)
      Sets the SSL mode.

      Parameters:
      mode - the SSL mode

    • setTimeOffset

      public void setTimeOffset(long timeOffset)
      Sets the timeOffset.

      Parameters:
      timeOffset - the timeOffset to set

    • setTitle

      public void setTitle(String title)
      Sets the title.

      Parameters:
      title - the title to set

    • setWebserver

      public void setWebserver(boolean webserver)
      Sets the web server.

      Parameters:
      webserver - the web server to set

    • toCmsSite

      public org.opencms.site.CmsSite toCmsSite()
      Creates a new site object based on the members.

      Returns:
      a new site object based on the members

    • toCmsSite

      public org.opencms.site.CmsSite toCmsSite(org.opencms.site.CmsSiteManagerImpl siteManager)
      Creates a new site object based on the members.

      This method with the siteManager parameter is mostly useful for testing, since usually only the global site manager instance is used.

      Parameters:
      siteManager - the site manager to use
      Returns:
      a new site object based on the members

    • toString

      public String toString()
      Overrides:
      toString in class Object
      See Also: