| 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.
|
| Modifier and Type | Method and Description |
|---|---|
CmsSiteMatcher |
CmsRequestContext.getRequestMatcher()
Returns the matcher for the current request, that is the host part of the URI from the original http request.
|
| Constructor and 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)
Constructs a new request context.
|
| Modifier and Type | Method and Description |
|---|---|
CmsSiteMatcher |
CmsContextInfo.getRequestMatcher()
Returns the matcher for the current request, that is the host part of the URI from the original http request.
|
| Modifier and Type | Method and 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.
|
| Constructor and 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)
Creates a new instance with all context variables initialized.
|
| Modifier and Type | Field and Description |
|---|---|
static CmsSiteMatcher |
CmsSiteMatcher.DEFAULT_MATCHER
Default matcher that always matches all other Site matchers.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
| Modifier and Type | Method and 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, using
CmsSiteMatcher objects as keys and CmsSite objects as values. |
| Modifier and Type | Method and Description |
|---|---|
protected void |
CmsSite.addAlias(CmsSiteMatcher aliasServer)
Adds an alias for the site.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
CmsSite.setAliases(java.util.List<CmsSiteMatcher> aliases)
Sets the aliases for the site.
|
| Constructor and 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)
Constructs a new site object.
|
| Constructor and 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)
Constructs a new site object.
|