org.opencms.site

类 CmsSite

java.lang.Object

org.opencms.site.CmsSite

所有已实现的接口:

java.lang.Cloneable, java.lang.Comparable<CmsSite>

public final class CmsSite
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable<CmsSite>

Describes a configured site in OpenCms.

从以下版本开始:

6.0.0

构造器概要

构造器

构造器和说明
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) Constructs a new site object with a default (wildcard) a site matcher, this is to be used for display 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.

方法概要

方法

限定符和类型	方法和说明
protected void	addAlias(CmsSiteMatcher aliasServer) Adds an alias for the site.
java.lang.Object	clone() Returns a clone of this Objects instance.
int	compareTo(CmsSite that)
boolean	equals(java.lang.Object obj)
java.util.List<CmsSiteMatcher>	getAliases() Returns the aliases for this site.
java.lang.String	getErrorPage() Returns the errorPage.
float	getPosition() Returns the sorting position.
CmsSiteMatcher	getSecureServer() Returns the secureServer.
java.lang.String	getSecureUrl() Returns the secure server url of this site root.
java.lang.String	getServerPrefix(CmsObject cms, CmsResource resource) Returns the server prefix for the given resource in this site, used to distinguish between secure (https) and non-secure (http) sites.
java.lang.String	getServerPrefix(CmsObject cms, java.lang.String resourceName) Returns the server prefix for the given resource in this site, used to distinguish between secure (https) and non-secure (http) sites.
CmsSiteMatcher	getSiteMatcher() Returns the site matcher that describes the URL of this site.
java.lang.String	getSitePath(java.lang.String rootPath) Returns the site path for the given root path in case the root path actually starts with this site root, or null in case the root path does not.
java.lang.String	getSiteRoot() Returns the path of this site's root directory in the OpenCms VFS without tailing slash.
CmsUUID	getSiteRootUUID() Returns the UUID of this site's root directory in the OpenCms VFS.
java.lang.String	getTitle() Returns the display title of this site.
java.lang.String	getUrl() Returns the server url of this site root.
int	hashCode()
boolean	hasSecureServer() Returns true, if the site has a secure server.
boolean	isExclusiveError() Returns the exclusive error flag.
boolean	isExclusiveUrl() Returns the exclusive protocol flag.
boolean	isWebserver() Returns the web server.
protected void	setAliases(java.util.List<CmsSiteMatcher> aliases) Sets the aliases for the site.
void	setErrorPage(java.lang.String errorPage) Sets the errorPage.
void	setExclusiveError(boolean error) Sets the exclusive error flag.
void	setExclusiveUrl(boolean exclusive) Sets the exclusive protocol flag.
protected void	setPosition(float position) Sets the display title of this site.
protected void	setSecureServer(CmsSiteMatcher secureServer) Sets the secure server.
protected void	setSiteMatcher(CmsSiteMatcher siteMatcher) Sets the site matcher that describes the URL of this site.
protected void	setSiteRoot(java.lang.String siteRoot) Sets the server URL prefix to which this site is mapped.
protected void	setSiteRootUUID(CmsUUID siteRootUUID) Sets the UUID of this site's root directory in the OpenCms VFS.
protected void	setTitle(java.lang.String name) Sets the display title of this site.
void	setWebserver(boolean webserver) Sets the web server.
java.lang.String	toString()

从类继承的方法 java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

构造器详细资料

CmsSite

public 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.

参数:

siteRoot - root directory of this site in the OpenCms VFS

siteMatcher - the site matcher for this site

CmsSite

public CmsSite(java.lang.String siteRoot,
       CmsUUID siteRootUUID,
       java.lang.String title)

Constructs a new site object with a default (wildcard) a site matcher, this is to be used for display purposes only.

参数:

siteRoot - root directory of this site in the OpenCms VFS

siteRootUUID - UUID of this site's root directory in the OpenCms VFS

title - display name of this site

CmsSite

public CmsSite(java.lang.String siteRoot,
       CmsUUID siteRootUUID,
       java.lang.String title,
       CmsSiteMatcher siteMatcher,
       java.lang.String position)

Constructs a new site object.

参数:

siteRoot - root directory of this site in the OpenCms VFS

siteRootUUID - UUID of this site's root directory in the OpenCms VFS

title - display name of this site

siteMatcher - the site matcher for this site

position - the sorting position

CmsSite

public 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.

参数:

siteRoot - root directory of this site in the OpenCms VFS

siteRootUUID - UUID of this site's root directory in the OpenCms VFS

title - display name of this site

siteMatcher - the site matcher for this site

position - the sorting position

errorPage - the optional error page for this site

secureSite - the secure site

exclusiveUrl - the exclusive flag

exclusiveError - the exclusive error flag

webserver - indicates whether to write the web server configuration for this site or not

aliases - the aliases

方法详细资料

clone

public java.lang.Object clone()

Returns a clone of this Objects instance.

覆盖:

clone 在类中 java.lang.Object

返回:

a clone of this instance

compareTo

public int compareTo(CmsSite that)

指定者:

compareTo 在接口中 java.lang.Comparable<CmsSite>

另请参阅:

Comparable.compareTo(java.lang.Object)

equals

public boolean equals(java.lang.Object obj)

覆盖:

equals 在类中 java.lang.Object

另请参阅:

Object.equals(java.lang.Object)

getAliases

public java.util.List<CmsSiteMatcher> getAliases()

Returns the aliases for this site.

返回:

a ArrayList with the aliases

getErrorPage

public java.lang.String getErrorPage()

Returns the errorPage.

返回:

the errorPage

getPosition

public float getPosition()

Returns the sorting position.

返回:

the sorting position

getSecureServer

public CmsSiteMatcher getSecureServer()

Returns the secureServer.

返回:

the secureServer

getSecureUrl

public java.lang.String getSecureUrl()

Returns the secure server url of this site root.

返回:

the secure server url

getServerPrefix

public java.lang.String getServerPrefix(CmsObject cms,
                               CmsResource resource)

Returns the server prefix for the given resource in this site, used to distinguish between secure (https) and non-secure (http) sites.

This is required since a resource may have an individual "secure" setting using the property CmsPropertyDefinition.PROPERTY_SECURE, which means this resource must be delivered only using a secure protocol.

The result will look like http://site.enterprise.com:8080/ or https://site.enterprise.com/.

参数:

cms - the current users OpenCms context

resource - the resource to use

返回:

the server prefix for the given resource in this site

另请参阅:

getSecureUrl(), getUrl()

getServerPrefix

public java.lang.String getServerPrefix(CmsObject cms,
                               java.lang.String resourceName)

Returns the server prefix for the given resource in this site, used to distinguish between secure (https) and non-secure (http) sites.

This is required since a resource may have an individual "secure" setting using the property CmsPropertyDefinition.PROPERTY_SECURE, which means this resource must be delivered only using a secure protocol.

The result will look like http://site.enterprise.com:8080/ or https://site.enterprise.com/.

参数:

cms - the current users OpenCms context

resourceName - the resource name

返回:

the server prefix for the given resource in this site

另请参阅:

getSecureUrl(), getUrl()

getSiteMatcher

public CmsSiteMatcher getSiteMatcher()

Returns the site matcher that describes the URL of this site.

返回:

the site matcher that describes the URL of this site

getSitePath

public java.lang.String getSitePath(java.lang.String rootPath)

Returns the site path for the given root path in case the root path actually starts with this site root, or null in case the root path does not.

参数:

rootPath - the root path to get the site path for

返回:

the site path for the given root path in case the root path actually starts with this site root, or null in case the root path does not

getSiteRoot

public java.lang.String getSiteRoot()

Returns the path of this site's root directory in the OpenCms VFS without tailing slash.

• e.g. /sites/default

返回:

the path of this site's root directory in the OpenCms VFS without tailing slash

getSiteRootUUID

public CmsUUID getSiteRootUUID()

Returns the UUID of this site's root directory in the OpenCms VFS.

返回:

the UUID of this site's root directory in the OpenCms VFS

getTitle

public java.lang.String getTitle()

Returns the display title of this site.

返回:

the display title of this site

getUrl

public java.lang.String getUrl()

Returns the server url of this site root.

返回:

the server url

hashCode

public int hashCode()

覆盖:

hashCode 在类中 java.lang.Object

另请参阅:

Object.hashCode()

hasSecureServer

public boolean hasSecureServer()

Returns true, if the site has a secure server.

返回:

true, if the site has a secure server

isExclusiveError

public boolean isExclusiveError()

Returns the exclusive error flag.

返回:

true will generate a 404 error, or false will redirect to secure url.

isExclusiveUrl

public boolean isExclusiveUrl()

Returns the exclusive protocol flag.

返回:

true secure resources will only be available using the configured secure url, or false if the uri (protocol + servername) does not really matter.

isWebserver

public boolean isWebserver()

Returns the web server.

返回:

the web server

setErrorPage

public void setErrorPage(java.lang.String errorPage)

Sets the errorPage.

参数:

errorPage - the errorPage to set

setExclusiveError

public void setExclusiveError(boolean error)

Sets the exclusive error flag.

参数:

error - the exclusive error flag

setExclusiveUrl

public void setExclusiveUrl(boolean exclusive)

Sets the exclusive protocol flag.

参数:

exclusive - the exclusive protocol flag

setWebserver

public void setWebserver(boolean webserver)

Sets the web server.

参数:

webserver - the web server to set

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

另请参阅:

Object.toString()

addAlias

protected void addAlias(CmsSiteMatcher aliasServer)

Adds an alias for the site.

参数:

aliasServer - the sitematcher for the alias

setAliases

protected void setAliases(java.util.List<CmsSiteMatcher> aliases)

Sets the aliases for the site.

参数:

aliases - the aliases for the site

setPosition

protected void setPosition(float position)

Sets the display title of this site.

参数:

position - the display title of this site

setSecureServer

protected void setSecureServer(CmsSiteMatcher secureServer)

Sets the secure server.

参数:

secureServer - the sitematcher of the secure server

setSiteMatcher

protected void setSiteMatcher(CmsSiteMatcher siteMatcher)

Sets the site matcher that describes the URL of this site.

参数:

siteMatcher - the site matcher that describes the URL of this site

setSiteRoot

protected void setSiteRoot(java.lang.String siteRoot)

Sets the server URL prefix to which this site is mapped.

参数:

siteRoot - the server URL prefix to which this site is mapped

setSiteRootUUID

protected void setSiteRootUUID(CmsUUID siteRootUUID)

Sets the UUID of this site's root directory in the OpenCms VFS.

参数:

siteRootUUID - the UUID of this site's root directory in the OpenCms VFS

setTitle

protected void setTitle(java.lang.String name)

Sets the display title of this site.

参数:

name - the display title of this site