Uses of Class
org.opencms.site.CmsSiteMatcher
-
Packages that use CmsSiteMatcher Package Description org.opencms.file This important package provides the methods to access the OpenCms VFS repository with the permissions of an authenticated user.org.opencms.main Provides the main OpenCms "operating system".org.opencms.site Provides access to the multi-site configuration of OpenCms. -
-
Uses of CmsSiteMatcher in org.opencms.file
Methods in org.opencms.file that return CmsSiteMatcher Modifier and Type Method Description CmsSiteMatcher
CmsRequestContext. getRequestMatcher()
Returns the matcher for the current request, that is the host part of the URI from the original http request.Constructors in org.opencms.file with parameters of type CmsSiteMatcher Constructor Description CmsRequestContext(CmsUser user, CmsProject project, java.lang.String requestedUri, CmsSiteMatcher requestMatcher, java.lang.String siteRoot, boolean isSecureRequest, java.util.Locale locale, java.lang.String encoding, java.lang.String remoteAddr, long requestTime, CmsResourceTranslator directoryTranslator, CmsResourceTranslator fileTranslator, java.lang.String ouFqn, boolean forceAbsoluteLinks)
Constructs a new request context. -
Uses of CmsSiteMatcher in org.opencms.main
Methods in org.opencms.main that return CmsSiteMatcher Modifier and Type Method Description CmsSiteMatcher
CmsContextInfo. getRequestMatcher()
Returns the matcher for the current request, that is the host part of the URI from the original http request.Methods in org.opencms.main with parameters of type CmsSiteMatcher Modifier and Type Method Description void
CmsContextInfo. setRequestMatcher(CmsSiteMatcher requestMatcher)
Sets the matcher for the current request, that is the host part of the URI from the original http request.Constructors in org.opencms.main with parameters of type CmsSiteMatcher Constructor Description CmsContextInfo(CmsUser user, CmsProject project, java.lang.String requestedUri, CmsSiteMatcher requestMatcher, java.lang.String siteRoot, boolean isSecureRequest, java.util.Locale locale, java.lang.String encoding, java.lang.String remoteAddr, long requestTime, java.lang.String ouFqn, boolean isForceAbsoluteLinks)
Creates a new instance with all context variables initialized. -
Uses of CmsSiteMatcher in org.opencms.site
Fields in org.opencms.site declared as CmsSiteMatcher Modifier and Type Field Description static CmsSiteMatcher
CmsSiteMatcher. DEFAULT_MATCHER
Default matcher that always matches all other Site matchers.Methods in org.opencms.site that return CmsSiteMatcher Modifier and Type Method Description static CmsSiteMatcher
CmsSiteManagerImpl. createAliasSiteMatcher(java.lang.String alias, java.lang.String redirect, java.lang.String offset)
Creates a site matcher for an alias read from the configuration.CmsSiteMatcher
CmsSiteMatcher. forDifferentScheme(java.lang.String scheme)
Generates a site matcher equivalent to this one but with a different scheme.CmsSiteMatcher
CmsSite. getSecureServer()
Returns the secureServer.protected CmsSiteMatcher
CmsSite. getSecureServerMatcher()
Returns the site matcher for the secure site, or null if no secure site is defined.CmsSiteMatcher
CmsSite. getSiteMatcher()
Returns the site matcher that describes the URL of this site.CmsSiteMatcher
CmsSiteManagerImpl. getWorkplaceSiteMatcher()
Returns the site matcher that matches the workplace site.Methods in org.opencms.site that return types with arguments of type CmsSiteMatcher Modifier and Type Method Description java.util.List<CmsSiteMatcher>
CmsSite. getAliases()
Returns the aliases for this site.java.util.List<CmsSiteMatcher>
CmsSite. getAllMatchers()
Gets all site matchers which should be used for matching the site.java.util.Map<CmsSiteMatcher,CmsSite>
CmsSiteManagerImpl. getSites()
Returns the map of configured sites, usingCmsSiteMatcher
objects as keys andCmsSite
objects as values.Methods in org.opencms.site with parameters of type CmsSiteMatcher Modifier and Type Method Description protected void
CmsSite. addAlias(CmsSiteMatcher aliasServer)
Adds an alias for the site.boolean
CmsSiteManagerImpl. isMatching(CmsSiteMatcher matcher)
Returnstrue
if the given site matcher matches any configured site, which includes the workplace site.boolean
CmsSiteManagerImpl. isMatchingCurrentSite(CmsObject cms, CmsSiteMatcher matcher)
Returnstrue
if the given site matcher matches the current site.boolean
CmsSiteManagerImpl. isWorkplaceRequest(CmsSiteMatcher matcher)
Returnstrue
if the given site matcher matches the configured OpenCms workplace.CmsSite
CmsSiteManagerImpl. matchSite(CmsSiteMatcher matcher)
Return the configured site that matches the given site matcher, or the default site if no sites matches.protected void
CmsSite. setSecureServer(CmsSiteMatcher secureServer)
Sets the secure server.protected void
CmsSite. setSiteMatcher(CmsSiteMatcher siteMatcher)
Sets the site matcher that describes the URL of this site.Method parameters in org.opencms.site with type arguments of type CmsSiteMatcher Modifier and Type Method Description void
CmsSiteManagerImpl. addSite(java.lang.String server, java.lang.String uri, java.lang.String title, java.lang.String position, java.lang.String errorPage, java.lang.String webserver, java.lang.String sslMode, java.lang.String secureServer, java.lang.String exclusive, java.lang.String error, java.lang.String usePermanentRedirects, java.lang.String subsiteSelection, java.util.SortedMap<java.lang.String,java.lang.String> params, java.util.List<CmsSiteMatcher> aliases, java.util.Optional<CmsAlternativeSiteRootMapping> alternativeSiteRootMapping)
Adds a new CmsSite to the list of configured sites, this is only allowed during configuration.void
CmsSiteManagerImpl. addSiteInternally(java.lang.String server, java.lang.String uri, java.lang.String title, java.lang.String position, java.lang.String errorPage, java.lang.String webserver, java.lang.String sslMode, java.lang.String secureServer, java.lang.String exclusive, java.lang.String error, java.lang.String usePermanentRedirects, java.lang.String subsiteSelection, java.util.SortedMap<java.lang.String,java.lang.String> params, java.util.List<CmsSiteMatcher> aliases, java.util.Optional<CmsAlternativeSiteRootMapping> alternativeSiteRoot)
Adds a new CmsSite to the list of configured sites, this is only allowed during configuration.protected void
CmsSite. setAliases(java.util.List<CmsSiteMatcher> aliases)
Sets the aliases for the site.Constructors in org.opencms.site with parameters of type CmsSiteMatcher Constructor Description CmsSite(java.lang.String siteRoot, CmsSiteMatcher siteMatcher)
Constructs a new site object without title and id information, this is to be used for lookup purposes only.CmsSite(java.lang.String siteRoot, CmsUUID siteRootUUID, java.lang.String title, CmsSiteMatcher siteMatcher, java.lang.String position)
Constructs a new site object.CmsSite(java.lang.String siteRoot, CmsUUID siteRootUUID, java.lang.String title, CmsSiteMatcher siteMatcher, java.lang.String position, java.lang.String errorPage, CmsSiteMatcher secureSite, boolean exclusiveUrl, boolean exclusiveError, boolean webserver, java.util.List<CmsSiteMatcher> aliases, boolean subsiteSelection)
Constructs a new site object.Constructor parameters in org.opencms.site with type arguments of type CmsSiteMatcher Constructor Description CmsSite(java.lang.String siteRoot, CmsUUID siteRootUUID, java.lang.String title, CmsSiteMatcher siteMatcher, java.lang.String position, java.lang.String errorPage, CmsSiteMatcher secureSite, boolean exclusiveUrl, boolean exclusiveError, boolean webserver, java.util.List<CmsSiteMatcher> aliases, boolean subsiteSelection)
Constructs a new site object.
-