org.opencms.site

类 CmsSiteMatcher

java.lang.Object

org.opencms.site.CmsSiteMatcher

所有已实现的接口:

java.lang.Cloneable

public final class CmsSiteMatcher
extends java.lang.Object
implements java.lang.Cloneable

A matcher object to compare request data against the configured sites.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static CmsSiteMatcher	DEFAULT_MATCHER Default matcher that always matches all other Site matchers.

构造器概要

构造器

构造器和说明
CmsSiteMatcher(java.lang.String serverString) Construct a new site matcher from a String which should be in default URL notation.
CmsSiteMatcher(java.lang.String serverString, long timeOffset) Construct a new site matcher from a String which should be in default URL notation.
CmsSiteMatcher(java.lang.String serverProtocol, java.lang.String serverName, int serverPort) Constructs a new site matcher object.
CmsSiteMatcher(java.lang.String serverProtocol, java.lang.String serverName, int serverPort, long timeOffset) Constructs a new site matcher object.

方法概要

方法

限定符和类型	方法和说明
java.lang.Object	clone() Returns a clone of this Objects instance.
boolean	equals(java.lang.Object obj)
java.lang.String	getServerName() Returns the hostname (e.g. localhost) which is required to access this site.
int	getServerPort() Returns the port (e.g. 80) which is required to access this site.
java.lang.String	getServerProtocol() Returns the protocol (e.g.
long	getTimeOffset() Returns the time Offset.
java.lang.String	getUrl() Returns the url of this site matcher.
int	hashCode()
protected void	setServerName(java.lang.String serverName) Sets the hostname (e.g. localhost) which is required to access this site.
protected void	setServerPort(int serverPort) Sets the port (e.g. 80) which is required to access this site.
protected void	setServerProtocol(java.lang.String serverProtocol) Sets the protocol (e.g.
protected void	setTimeOffset(long timeOffset) Sets the time Offset in seconds.
java.lang.String	toString()

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

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

字段详细资料

DEFAULT_MATCHER

public static final CmsSiteMatcher DEFAULT_MATCHER

Default matcher that always matches all other Site matchers.

构造器详细资料

CmsSiteMatcher

public CmsSiteMatcher(java.lang.String serverString)

Construct a new site matcher from a String which should be in default URL notation.

If no port is provided, the default port 80 or 443 will be used for http or https respectively. If no protocol is provided, the default protocol "http" will be used.

参数:

serverString - the String, e.g. http://localhost:8080

CmsSiteMatcher

public CmsSiteMatcher(java.lang.String serverString,
              long timeOffset)

Construct a new site matcher from a String which should be in default URL notation.

If no port is provided, the default port 80 or 443 will be used for http or https respectively. If no protocol is provided, the default protocol "http" will be used.

参数:

serverString - the String, e.g. http://localhost:8080

timeOffset - the time offset

CmsSiteMatcher

public CmsSiteMatcher(java.lang.String serverProtocol,
              java.lang.String serverName,
              int serverPort)

Constructs a new site matcher object.

参数:

serverProtocol - to protocol required to access this site

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

serverPort - the port required to access this site

CmsSiteMatcher

public CmsSiteMatcher(java.lang.String serverProtocol,
              java.lang.String serverName,
              int serverPort,
              long timeOffset)

Constructs a new site matcher object.

参数:

serverProtocol - to protocol required to access this site

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

serverPort - the port required to access this site

timeOffset - the time offset

方法详细资料

clone

public java.lang.Object clone()

Returns a clone of this Objects instance.

覆盖:

clone 在类中 java.lang.Object

返回:

a clone of this instance

equals

public boolean equals(java.lang.Object obj)

覆盖:

equals 在类中 java.lang.Object

另请参阅:

Object.equals(java.lang.Object)

getServerName

public java.lang.String getServerName()

Returns the hostname (e.g. localhost) which is required to access this site.

返回:

the hostname (e.g. localhost) which is required to access this site

getServerPort

public int getServerPort()

Returns the port (e.g. 80) which is required to access this site.

返回:

the port (e.g. 80) which is required to access this site

getServerProtocol

public java.lang.String getServerProtocol()

Returns the protocol (e.g. "http", "https") which is required to access this site.

返回:

the protocol (e.g. "http", "https") which is required to access this site

getTimeOffset

public long getTimeOffset()

Returns the time Offset.

返回:

the time Offset

getUrl

public java.lang.String getUrl()

Returns the url of this site matcher.

返回:

the url, i.e. {protocol}://{servername}[:{port}], port appened only if != 80

hashCode

public int hashCode()

覆盖:

hashCode 在类中 java.lang.Object

另请参阅:

Object.hashCode()

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

另请参阅:

Object.toString()

setServerName

protected void setServerName(java.lang.String serverName)

Sets the hostname (e.g. localhost) which is required to access this site.

Setting the hostname to "*" is a wildcard that matches all hostnames

参数:

serverName - the hostname (e.g. localhost) which is required to access this site

setServerPort

protected void setServerPort(int serverPort)

Sets the port (e.g. 80) which is required to access this site.

Setting the port to 0 (zero) is a wildcard that matches all ports

参数:

serverPort - the port (e.g. 80) which is required to access this site

setServerProtocol

protected void setServerProtocol(java.lang.String serverProtocol)

Sets the protocol (e.g. "http", "https") which is required to access this site.

Setting the protocol to "*" is a wildcard that matches all protocols.

参数:

serverProtocol - the protocol (e.g. "http", "https") which is required to access this site

setTimeOffset

protected void setTimeOffset(long timeOffset)

Sets the time Offset in seconds.

参数:

timeOffset - the time Offset to set