@StableMinor(version="12.1", sinceVersion="6.2") public interface IWebsite
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.
Modifier and Type | Method and Description |
---|---|
Collection<IWebsiteBaseURL> |
getAdditionalBaseURLs()
Returns the additional base URLs of this web site.
|
String |
getId()
Returns the identifier of this website.
|
IWebsiteMainBaseURL |
getMainNonSecureBaseURL()
Returns the main non-secure base URL of this website.
|
IWebsiteMainBaseURL |
getMainSecureBaseURL()
Returns the main secure base URL of this website.
|
String |
getName()
Returns the name of this website.
|
String |
getRootChannelId()
Returns the identifier of the root channel of this web site.
|
IWebRootPortalBaseFolder |
getWebRootBaseFolder()
Returns the base folder that corresponds to the web root folder of this
website.
|
boolean |
isDefaultWebsite()
Returns whether this website is the default website.
|
boolean |
isForceMainURLsNavigation()
Returns whether this website forces the navigation to occur on its
main base URLs, instead of on its additional base URLs.
|
String getId()
String getName()
IWebRootPortalBaseFolder getWebRootBaseFolder()
The base folder corresponds to the folder referenced by the evaluation
of the configuration in this website's
web root path
.
IPortalBaseFolder
String getRootChannelId()
null
if there is
no root channel defined for this website.boolean isDefaultWebsite()
The default website is used to respond to requests that did not match the base URLs of any website.
true
if this website is the default website,
false
otherwise.boolean isForceMainURLsNavigation()
When this property is enabled, this website redirects requests targeting the additional base URLs to the main base URLs.
true
if this website forces the navigation to occurs on its
main base URLs, false
otherwise.IWebsiteMainBaseURL getMainNonSecureBaseURL()
This base URL is used to generate absolute non-secure (HTTP) URLs to this website.
IWebsiteMainBaseURL getMainSecureBaseURL()
This base URL is used to generate absolute secure (HTTPS) URLs to this website.
Collection<IWebsiteBaseURL> getAdditionalBaseURLs()
The main base URLs are not included in the returned collection.
LumisXP 12.1.0.191010 - Copyright © 2006–2019 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.