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

Modifier	Constructor	Description
	CmsRequestContext(CmsUser user, CmsProject project, String requestedUri, CmsSiteMatcher requestMatcher, String siteRoot, boolean isSecureRequest, Locale locale, String encoding, String remoteAddr, long requestTime, CmsResourceTranslator directoryTranslator, CmsResourceTranslator fileTranslator, 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

Modifier	Constructor	Description
	CmsContextInfo(CmsUser user, CmsProject project, String requestedUri, CmsSiteMatcher requestMatcher, String siteRoot, boolean isSecureRequest, Locale locale, String encoding, String remoteAddr, long requestTime, 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 final 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(String alias, String redirect, String offset)	Creates a site matcher for an alias read from the configuration.
CmsSiteMatcher	CmsSiteMatcher.forDifferentScheme(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
List<CmsSiteMatcher>	CmsSite.getAliases()	Returns the aliases for this site.
List<CmsSiteMatcher>	CmsSite.getAllMatchers()	Gets all site matchers which should be used for matching the site.
Map<CmsSiteMatcher,CmsSite>	CmsSiteManagerImpl.getSites()	Returns the map of configured sites, using CmsSiteMatcher objects as keys and CmsSite 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	CmsSiteMatcher.equalsIgnoreScheme(CmsSiteMatcher matcher)	Checks if this site matcher equals another site matcher, ignoring the scheme.
boolean	CmsSiteManagerImpl.isMatching(CmsSiteMatcher matcher)	Returns true if the given site matcher matches any configured site, which includes the workplace site.
boolean	CmsSiteManagerImpl.isMatchingCurrentSite(CmsObject cms, CmsSiteMatcher matcher)	Returns true if the given site matcher matches the current site.
boolean	CmsSiteManagerImpl.isWorkplaceRequest(CmsSiteMatcher matcher)	Returns true 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(String server, String uri, String title, String position, String errorPage, String webserver, String sslMode, String secureServer, String exclusive, String error, String usePermanentRedirects, String subsiteSelection, SortedMap<String,String> params, List<CmsSiteMatcher> aliases, Optional<CmsAlternativeSiteRootMapping> alternativeSiteRootMapping)	Adds a new CmsSite to the list of configured sites, this is only allowed during configuration.
void	CmsSiteManagerImpl.addSiteInternally(String server, String uri, String title, String position, String errorPage, String webserver, String sslMode, String secureServer, String exclusive, String error, String usePermanentRedirects, String subsiteSelection, SortedMap<String,String> params, List<CmsSiteMatcher> aliases, Optional<CmsAlternativeSiteRootMapping> alternativeSiteRoot)	Adds a new CmsSite to the list of configured sites, this is only allowed during configuration.
protected void	CmsSite.setAliases(List<CmsSiteMatcher> aliases)	Sets the aliases for the site.

Constructors in org.opencms.site with parameters of type CmsSiteMatcher

Modifier	Constructor	Description
	CmsSite(String siteRoot, CmsSiteMatcher siteMatcher)	Constructs a new site object without title and id information, this is to be used for lookup purposes only.
	CmsSite(String siteRoot, CmsUUID siteRootUUID, String title, CmsSiteMatcher siteMatcher, String position)	Constructs a new site object.
	CmsSite(String siteRoot, CmsUUID siteRootUUID, String title, CmsSiteMatcher siteMatcher, String position, String errorPage, CmsSiteMatcher secureSite, boolean exclusiveUrl, boolean exclusiveError, boolean webserver, List<CmsSiteMatcher> aliases, boolean subsiteSelection)	Constructs a new site object.

Constructor parameters in org.opencms.site with type arguments of type CmsSiteMatcher

Modifier	Constructor	Description
	CmsSite(String siteRoot, CmsUUID siteRootUUID, String title, CmsSiteMatcher siteMatcher, String position, String errorPage, CmsSiteMatcher secureSite, boolean exclusiveUrl, boolean exclusiveError, boolean webserver, List<CmsSiteMatcher> aliases, boolean subsiteSelection)	Constructs a new site object.