Package lumis.portal.website

Class WebsiteManager.UnmodifiableWebsite

  • All Implemented Interfaces:
    IWebsite, IWebsitesSPI
    Enclosing class:
    WebsiteManager
    public static final class WebsiteManager.UnmodifiableWebsite
extends java.lang.Object
implements IWebsitesSPI
    Unmodifiable Website implementation.

    Throws UnsupportedOperationException in methods that changes the wrapped website in any manner.

    Since:
    6.2.0
    Version:
    $Revision$ $Date$

    • Method Detail

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • getId

        public java.lang.String getId()
        Description copied from interface: IWebsite
        Returns the identifier of this website.
        Specified by:
        getId in interface IWebsite
        Returns:
        the identifier of this website.

      • getName

        public java.lang.String getName()
        Description copied from interface: IWebsite
        Returns the name of this website. This name is used only for display, and has no functional impact.
        Specified by:
        getName in interface IWebsite
        Returns:
        the website name.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • getWebRootBaseFolder

        public IWebRootPortalBaseFolder getWebRootBaseFolder()
        Description copied from interface: IWebsite
        Returns the base folder that corresponds to the web root folder of this website.

        The base folder corresponds to the folder referenced by the evaluation of the configuration in this website's web root path.

        Specified by:
        getWebRootBaseFolder in interface IWebsite
        Returns:
        the web root base folder.
        See Also:
        IPortalBaseFolder

      • getRootChannelId

        public java.lang.String getRootChannelId()
        Description copied from interface: IWebsite
        Returns the identifier of the root channel of this web site.
        Specified by:
        getRootChannelId in interface IWebsite
        Returns:
        the identifier of the root channel, of null if there is no root channel defined for this website.

      • isDefaultWebsite

        public boolean isDefaultWebsite()
        Description copied from interface: IWebsite
        Returns whether this website is the default website.

        The default website is used to respond to requests that did not match the base URLs of any website.

        Specified by:
        isDefaultWebsite in interface IWebsite
        Returns:
        true if this website is the default website, false otherwise.

      • isForceMainURLsNavigation

        public boolean isForceMainURLsNavigation()
        Description copied from interface: IWebsite
        Returns whether this website forces the navigation to occur on its main base URLs, instead of on its additional base URLs.

        When this property is enabled, this website redirects requests targeting the additional base URLs to the main base URLs.

        Specified by:
        isForceMainURLsNavigation in interface IWebsite
        Returns:
        true if this website forces the navigation to occurs on its main base URLs, false otherwise.

      • getMainNonSecureBaseURL

        public IWebsiteMainBaseURL getMainNonSecureBaseURL()
        Description copied from interface: IWebsite
        Returns the main non-secure base URL of this website.

        This base URL is used to generate absolute non-secure (HTTP) URLs to this website.

        Specified by:
        getMainNonSecureBaseURL in interface IWebsite
        Returns:
        the main non-secure base URL of this website.

      • getMainSecureBaseURL

        public IWebsiteMainBaseURL getMainSecureBaseURL()
        Description copied from interface: IWebsite
        Returns the main secure base URL of this website.

        This base URL is used to generate absolute secure (HTTPS) URLs to this website.

        Specified by:
        getMainSecureBaseURL in interface IWebsite
        Returns:
        the main secure base URL of this website.

      • getAdditionalBaseURLs

        public java.util.Collection<IWebsiteBaseURL> getAdditionalBaseURLs()
        Description copied from interface: IWebsite
        Returns the additional base URLs of this web site.

        The main base URLs are not included in the returned collection.

        Specified by:
        getAdditionalBaseURLs in interface IWebsite
        Returns:
        a unmodifiable collection containing the persistent additional base URLs of this website. It may not reflect changes done in the additional base URLs present in this website after it is obtained. If this website has no additional base URL, an empty collection is returned.

      • getModifiableClone

        public Website getModifiableClone()
        Clones this website returning a modifiable Website instance.
        Returns:
        the modifiable website instance.
        Since:
        8.1.0

      • getGoogleAnalyticsAPIKey

        public java.lang.String getGoogleAnalyticsAPIKey()
        Description copied from interface: IWebsitesSPI
        Returns the Google Analytics API access key.
        Specified by:
        getGoogleAnalyticsAPIKey in interface IWebsitesSPI
        Returns:
        the Google Analytics API access key.

      • getGoogleMapsAPIKey

        public java.lang.String getGoogleMapsAPIKey()
        Description copied from interface: IWebsitesSPI
        Returns the Google Maps API access key.
        Specified by:
        getGoogleMapsAPIKey in interface IWebsitesSPI
        Returns:
        the Google Maps API access key.