org.apache.portals.applications.webcontent2.proxy

Interface ProxyMapping

All Known Implementing Classes:

AbstractProxyMapping, PortletAnyProxyMapping, RegexProxyMapping, SimpleProxyMapping

public interface ProxyMapping

Reverse proxy mapping abstraction, which is responsible for

• checking whether or not a local request path info is matched by this proxy mapping,
• resolving a local request path info to a remote target URI,
• checking whether or not a remote target URI is matched by this proxy mapping,
• resolving a remote target URI to a local request path info,
• finding a proper ContentRewriter instance for the MIME type of the response content if any available,
• storing/retrieving/setting ad hoc attributes.

Note: resolveRemoteFromLocal(String) is usually invoked to resolve a remote target URI from a local request path info, whereas resolveLocalFromRemote(URI) is usually invoked to resolve a local request path info from a remote target URI location (e.g, URI redirection response from the remote server).

Note: It is recommended to invoke resolveRemoteFromLocal(String) only when matchesLocal(String) returns true. In the same way, it is recommended to invoke resolveLocalFromRemote(URI) only when matchesRemote(URI) returns true.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttribute(String name) Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
Map<String,Object>	getAttributesMap() Returns a Map containing the attributes available.
ContentRewriter	getContentRewriter(String mimeType) Returns a ContentRewriter instance to be used for the given mimeType.
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.
void	removeAttribute(String name) Removes an attribute from this 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	setAttribute(String name, Object value) Stores an attribute in this mapping.

Method Detail

matchesLocal

boolean matchesLocal(String localPath)

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

Parameters:

localPath -

Returns:

resolveRemoteFromLocal

String resolveRemoteFromLocal(String localPath)

Resolves the localPath to a remote target URI.

Parameters:

localPath -

Returns:

matchesRemote

boolean matchesRemote(URI remoteURI)

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

Parameters:

remoteURI -

Returns:

resolveLocalFromRemote

String resolveLocalFromRemote(URI remoteURI)

Resolves the remoteURI to a local request path info.

Parameters:

remoteURI -

Returns:

getContentRewriter

ContentRewriter getContentRewriter(String mimeType)

Returns a ContentRewriter instance to be used for the given mimeType.

Parameters:

mimeType -

Returns:

getAttribute

Object getAttribute(String name)

Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.

Parameters:

name -

Returns:

setAttribute

void setAttribute(String name,
                Object value)

Stores an attribute in this mapping.

Parameters:

name -

value -

removeAttribute

void removeAttribute(String name)

Removes an attribute from this mapping.

Parameters:

name -

getAttributesMap

Map<String,Object> getAttributesMap()

Returns a Map containing the attributes available. This method returns an empty Map if there's no attributes available to it.

Returns: