Class CmsSiteBean

  • All Implemented Interfaces:
    java.io.Serializable

    public class CmsSiteBean
    extends java.lang.Object
    implements java.io.Serializable
    Dialog object for a single site.

    Since:
    9.0.0
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      CmsSiteBean()
      Default constructor.
      CmsSiteBean​(org.opencms.site.CmsSite site)
      Public constructor with a CmsSite as parameter.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.util.List<java.lang.String> getAliases()
      Returns the aliases.
      org.opencms.site.CmsAlternativeSiteRootMapping getAlternativeSiteRootMapping()
      Gets the alternative site root mapping.
      java.lang.String getErrorPage()
      Returns the errorPage.
      java.lang.String getFavicon()
      Returns the favicon.
      org.opencms.site.CmsSite getOriginalSite()
      Returns the originalSite.
      java.util.SortedMap<java.lang.String,​java.lang.String> getParameters()
      Gets the parameters.
      int getPort()
      Returns the port.
      float getPosition()
      Returns the position.
      java.util.List<java.lang.String> getRedirectAliases()
      Returns the list of aliases that are configured to redirect to the site's main URL.
      java.lang.String getSecureUrl()
      Returns the secureUrl.
      java.lang.String getServer()
      Returns the server.
      java.lang.String getServerName()
      Returns the serverName.
      java.lang.String getServerProtocol()
      Returns the serverProtocol.
      java.lang.String getSiteRoot()
      Returns the siteRoot.
      java.lang.String getSslMode()
      Gets the SSL mode.
      long getTimeOffset()
      Returns the timeOffset.
      java.lang.String getTitle()
      Returns the title.
      int hashCode()  
      boolean hasSecureServer()
      Returns the secureServer.
      boolean isExclusiveError()
      Returns the exclusiveError.
      boolean isExclusiveUrl()
      Returns the exclusiveUrl.
      boolean isSecureServer()
      Returns the secureServer.
      boolean isWebserver()
      Returns the web server.
      void setAlternativeSiteRootMapping​(org.opencms.site.CmsAlternativeSiteRootMapping alternativeSiteRootMapping)
      Sets the alternative site root mapping.
      void setErrorPage​(java.lang.String errorPage)
      Sets the errorPage.
      void setExclusiveError​(boolean exclusiveError)
      Sets the exclusiveError.
      void setExclusiveUrl​(boolean exclusiveUrl)
      Sets the exclusiveUrl.
      void setFavicon​(java.lang.String favicon)
      Sets the favicon.
      void setParameters​(java.util.SortedMap<java.lang.String,​java.lang.String> params)
      Sets the parameters.
      void setPort​(int port)
      Sets the port.
      void setPosition​(float position)
      Sets the position.
      void setSecureServer​(boolean secureServer)
      Sets the secureServer.
      void setSecureUrl​(java.lang.String secureUrl)
      Sets the secureUrl.
      void setServer​(java.lang.String server)
      Sets the server.
      void setServerName​(java.lang.String serverName)
      Sets the serverName.
      void setServerProtocol​(java.lang.String serverProtocol)
      Sets the serverProtocol.
      void setSiteRoot​(java.lang.String siteRoot)
      Sets the siteRoot.
      void setSslMode​(java.lang.String mode)
      Sets the SSL mode.
      void setTimeOffset​(long timeOffset)
      Sets the timeOffset.
      void setTitle​(java.lang.String title)
      Sets the title.
      void setWebserver​(boolean webserver)
      Sets the web server.
      org.opencms.site.CmsSite toCmsSite()
      Creates a new site object based on the members.
      org.opencms.site.CmsSite toCmsSite​(org.opencms.site.CmsSiteManagerImpl siteManager)
      Creates a new site object based on the members.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • 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 Detail

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
        See Also:
        Object.equals(java.lang.Object)
      • getAliases

        public java.util.List<java.lang.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 java.lang.String getErrorPage()
        Returns the errorPage.

        Returns:
        the errorPage
      • getFavicon

        public java.lang.String getFavicon()
        Returns the favicon.

        Returns:
        the favicon
      • getOriginalSite

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

        Returns:
        the originalSite
      • getParameters

        public java.util.SortedMap<java.lang.String,​java.lang.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 java.util.List<java.lang.String> getRedirectAliases()
        Returns the list of aliases that are configured to redirect to the site's main URL.

        Returns:
        the redirect aliases
      • getSecureUrl

        public java.lang.String getSecureUrl()
        Returns the secureUrl.

        Returns:
        the secureUrl
      • getServer

        public java.lang.String getServer()
        Returns the server.

        Returns:
        the server
      • getServerName

        public java.lang.String getServerName()
        Returns the serverName.

        Returns:
        the serverName
      • getServerProtocol

        public java.lang.String getServerProtocol()
        Returns the serverProtocol.

        Returns:
        the serverProtocol
      • getSiteRoot

        public java.lang.String getSiteRoot()
        Returns the siteRoot.

        Returns:
        the siteRoot
      • getSslMode

        public java.lang.String getSslMode()
        Gets the SSL mode.

        Returns:
        the SSL mode
      • getTimeOffset

        public long getTimeOffset()
        Returns the timeOffset.

        Returns:
        the timeOffset
      • getTitle

        public java.lang.String getTitle()
        Returns the title.

        Returns:
        the title
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
        See Also:
        Object.hashCode()
      • 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​(java.lang.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​(java.lang.String favicon)
        Sets the favicon.

        Parameters:
        favicon - the favicon to set
      • setParameters

        public void setParameters​(java.util.SortedMap<java.lang.String,​java.lang.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​(java.lang.String secureUrl)
        Sets the secureUrl.

        Parameters:
        secureUrl - the secureUrl to set
      • setServer

        public void setServer​(java.lang.String server)
        Sets the server.

        Parameters:
        server - the server to set
      • setServerName

        public void setServerName​(java.lang.String serverName)
        Sets the serverName.

        Parameters:
        serverName - the serverName to set
      • setServerProtocol

        public void setServerProtocol​(java.lang.String serverProtocol)
        Sets the serverProtocol.

        Parameters:
        serverProtocol - the serverProtocol to set
      • setSiteRoot

        public void setSiteRoot​(java.lang.String siteRoot)
        Sets the siteRoot.

        Parameters:
        siteRoot - the siteRoot to set
      • setSslMode

        public void setSslMode​(java.lang.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​(java.lang.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 java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()