org.apache.portals.applications.webcontent2.proxy.impl

Class RegexProxyMapping

java.lang.Object

org.apache.portals.applications.webcontent2.proxy.impl.AbstractProxyMapping

org.apache.portals.applications.webcontent2.proxy.impl.RegexProxyMapping

All Implemented Interfaces:

ProxyMapping

public class RegexProxyMapping
extends AbstractProxyMapping

Java Regular Expression based ProxyMapping implementation.

For example, suppose this should cover the following mapping cases:

• /portals/applications/a/b/c.html <-> http://portals.apache.org/applications/a/b/c.html
• /portals/pluto/a/b/c.html <-> http://portals.apache.org/pluto/a/b/c.html
• /portals/jetspeed-2/a/b/c.html <-> http://portals.apache.org/jetspeed-2/a/b/c.html

Then you might configure the properties of this like the following example to achieve the mappings shown above:

• localPattern: "^/portals/([A-Za-z]+)/(.*)$"
• remoteReplace: "http://portals.apache.org/$1/$2"
• remotePattern: "^http://portals\\.apache\\.org/([A-Za-z]+)/(.*)$"
• localReplace: "/portals/$1/$2"

Note: The localPattern and remoteReplace properties are used in order to translate the local request path info to a remote target URI, whereas the remotePattern and localReplace properties are used in order to translate the remote location URI (e.g, redirection location) to a local request path info.

Constructor Summary

Constructors

Constructor and Description
RegexProxyMapping() Zero-argument default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getLocalPattern() Returns the regular expression to evaluate a local request path info.
String	getLocalReplace() Returns the replace string to translate to a local request path info based on the regular expression result from getRemotePattern().
String	getRemotePattern() Returns the regular expression to evaluate a remote URL.
String	getRemoteReplace() Returns the replace string to translate to a remote URI based on the regular expression result from getLocalPattern().
boolean	matchesLocal(String localPath) Returns true the localPath can be mapped by this proxy mapping.
boolean	matchesRemote(URI remoteURI) Returns true the remoteURI can be mapped by this proxy mapping.
String	resolveLocalFromRemote(URI remoteURI) Resolves the remoteURI to a local request path info.
String	resolveRemoteFromLocal(String localPath) Resolves the localPath to a remote target URI.
void	setLocalPattern(String localPattern) Sets the regular expression to evaluate a local request path info.
void	setLocalReplace(String localReplace) Sets the replace string to translate to a local request path info based on the regular expression result from getRemotePattern().
void	setRemotePattern(String remotePattern) Sets the regular expression to evaluate a remote URL.
void	setRemoteReplace(String remoteReplace) Sets the replace string to translate to a remote URI based on the regular expression result from getLocalPattern().

Methods inherited from class org.apache.portals.applications.webcontent2.proxy.impl.AbstractProxyMapping

getAttribute, getAttributesMap, getContentRewriter, getContentRewriters, removeAttribute, setAttribute, setAttributesMap, setContentRewriters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegexProxyMapping

public RegexProxyMapping()

Zero-argument default constructor.

Method Detail

getLocalPattern

public String getLocalPattern()

Returns the regular expression to evaluate a local request path info.

Returns:

setLocalPattern

public void setLocalPattern(String localPattern)

Sets the regular expression to evaluate a local request path info.

Parameters:

localPattern -

getRemoteReplace

public String getRemoteReplace()

Returns the replace string to translate to a remote URI based on the regular expression result from getLocalPattern().

Returns:

setRemoteReplace

public void setRemoteReplace(String remoteReplace)

Sets the replace string to translate to a remote URI based on the regular expression result from getLocalPattern().

Parameters:

remoteReplace -

getRemotePattern

public String getRemotePattern()

Returns the regular expression to evaluate a remote URL.

Returns:

setRemotePattern

public void setRemotePattern(String remotePattern)

Sets the regular expression to evaluate a remote URL.

Parameters:

remotePattern -

getLocalReplace

public String getLocalReplace()

Returns the replace string to translate to a local request path info based on the regular expression result from getRemotePattern().

Returns:

setLocalReplace

public void setLocalReplace(String localReplace)

Sets the replace string to translate to a local request path info based on the regular expression result from getRemotePattern().

Parameters:

localReplace -

matchesLocal

public boolean matchesLocal(String localPath)

Returns true the localPath can be mapped by this proxy mapping. Otherwise, it should return false.

Returns:

resolveRemoteFromLocal

public String resolveRemoteFromLocal(String localPath)

Resolves the localPath to a remote target URI.

Returns:

matchesRemote

public boolean matchesRemote(URI remoteURI)

Returns true the remoteURI can be mapped by this proxy mapping. Otherwise, it should return false.

Returns:

resolveLocalFromRemote

public String resolveLocalFromRemote(URI remoteURI)

Resolves the remoteURI to a local request path info.

Returns: