org.opencms.site
Class CmsSiteMatcher

java.lang.Object
  org.opencms.site.CmsSiteMatcher

All Implemented Interfaces:

Cloneable

public final class CmsSiteMatcher

extends Object

implements Cloneable

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

Since:

6.0.0

Version:

$Revision: 1.18 $

Author:

Alexander Kandzior

Field Summary

static CmsSiteMatcher

DEFAULT_MATCHER Default matcher that always matches all other Site matchers.

Constructor Summary

CmsSiteMatcher(String serverString)
Construct a new site matcher from a String which should be in default URL notation.

CmsSiteMatcher(String serverProtocol, String serverName, int serverPort)
Constructs a new site matcher object.

Method Summary

Object	clone() Returns a clone of this Objects instance.
boolean	equals(Object obj)
String	getServerName() Returns the hostname (e.g.
int	getServerPort() Returns the port (e.g.
String	getServerProtocol() Returns the protocol (e.g.
String	getUrl() Returns the url of this site matcher.
int	hashCode()
protected void	setServerName(String serverName) Sets the hostname (e.g.
protected void	setServerPort(int serverPort) Sets the port (e.g.
protected void	setServerProtocol(String serverProtocol) Sets the protocol (e.g.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MATCHER

public static final CmsSiteMatcher DEFAULT_MATCHER

Default matcher that always matches all other Site matchers.

Constructor Detail

CmsSiteMatcher

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

Parameters:

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

CmsSiteMatcher

public CmsSiteMatcher(String serverProtocol,
                      String serverName,
                      int serverPort)

Constructs a new site matcher object.

Parameters:

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

Method Detail

clone

public Object clone()

Returns a clone of this Objects instance.

Returns:

a clone of this instance

equals

public boolean equals(Object obj)

See Also:

Object.equals(java.lang.Object)

getServerName

public String getServerName()

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

Returns:

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.

Returns:

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

getServerProtocol

public String getServerProtocol()

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

Returns:

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

getUrl

public String getUrl()

Returns the url of this site matcher.

Returns:

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

hashCode

public int hashCode()

See Also:

Object.hashCode()

toString

public String toString()

See Also:

Object.toString()

setServerName

protected void setServerName(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

Parameters:

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

Parameters:

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

setServerProtocol

protected void setServerProtocol(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.

Parameters:

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