Package lumis.portal.website

Interface IWebsite

  • All Known Subinterfaces:
    IWebsitesSPI
    All Known Implementing Classes:
    Website, WebsiteManager.UnmodifiableWebsite
    @StableMinor(version="17.0",
             sinceVersion="6.2")
public interface IWebsite
    A website defines the area of the portal structure that is available through a set of URLs.

    A website has a root channel. The structure inside that root channel belongs to that website, and is accessible through it. But if a channel inside such structure is the root channel of another website, that part of the structure does not belong to the first website.

    A website has a secure and a non-secure main base URL. These main URLs are to be used as the base to generate absolute URLs to that website.

    A website may have additional base URLs it responds to. It may be configured to, when an additional base URL is accessed, to redirect to a main URL, or allow navigation to also occur on the additional URLs. This is done by the forceMainURLsNavigation property.

    Since:
    6.2.0
    Version:
    $Revision$ $Date$

    • Method Detail

      • getId

        java.lang.String getId()
        Returns the identifier of this website.
        Returns:
        the identifier of this website.
        Since:
        6.2.0

      • getName

        java.lang.String getName()
        Returns the name of this website. This name is used only for display, and has no functional impact.
        Returns:
        the website name.
        Since:
        6.2.0

      • getWebRootBaseFolder

        IWebRootPortalBaseFolder getWebRootBaseFolder()
        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.

        Returns:
        the web root base folder.
        Since:
        6.2.0
        See Also:
        IPortalBaseFolder

      • getRootChannelId

        java.lang.String getRootChannelId()
        Returns the identifier of the root channel of this web site.
        Returns:
        the identifier of the root channel, of null if there is no root channel defined for this website.
        Since:
        6.2.0

      • isDefaultWebsite

        boolean isDefaultWebsite()
        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.

        Returns:
        true if this website is the default website, false otherwise.
        Since:
        6.2.0

      • isForceMainURLsNavigation

        boolean isForceMainURLsNavigation()
        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.

        Returns:
        true if this website forces the navigation to occurs on its main base URLs, false otherwise.
        Since:
        6.2.0

      • getMainNonSecureBaseURL

        IWebsiteMainBaseURL getMainNonSecureBaseURL()
        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.

        Returns:
        the main non-secure base URL of this website.
        Since:
        6.2.0

      • getMainSecureBaseURL

        IWebsiteMainBaseURL getMainSecureBaseURL()
        Returns the main secure base URL of this website.

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

        Returns:
        the main secure base URL of this website.
        Since:
        6.2.0

      • getAdditionalBaseURLs

        java.util.Collection<IWebsiteBaseURL> getAdditionalBaseURLs()
        Returns the additional base URLs of this web site.

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

        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.
        Since:
        6.2.0