com.veriplace.client.factory
Class DefaultCallbackFactory

java.lang.Object
  com.veriplace.client.factory.DefaultCallbackFactory

All Implemented Interfaces:

CallbackFactory

public class DefaultCallbackFactory
extends java.lang.Object
implements CallbackFactory

Standard implementation of CallbackFactory. This is used by Client and VeriplaceState if you don't specify a different implementation.

When constructing a callback URL, DefaultCallbackFactory behaves as follows:

• Use the automatically detected hostname from HttpServletRequest.getServerName(), unless a different value was specified in the constructor. You may need to specify the value if your server's internal host name does not match the external domain name.
• Use the automatically detected port from HttpServletRequest.getServerName(), unless a different value was specified in the constructor. You may need to specify the value if requests are being forwarded to your application from a different port. The port is omitted from the URL if it is the standard value of 80 (for HTTP) or 443 (for HTTPS).
• Use the automatically detected URL path components from HttpServletRequest.getContextPath(), getServletPath(), and getPathInfo(), unless a different path was specified in the constructor. You may need to specify the path if requests are being forwarded to your application from within another application whose URL can't be automatically detected.
• If no parameter names were specified in the constructor, copy all HTTP request parameters (query string and/or POST values) to the callback URL.
• If parameter names were specified in the constructor, then include or exclude parameters based on what was specified.

Since:

2.0

Constructor Summary

DefaultCallbackFactory()
Constructs a DefaultCallbackFactory with no overridden properties.

DefaultCallbackFactory(java.lang.String overrideServerName)
Constructs a DefaultCallbackFactory, overriding the server name.

DefaultCallbackFactory(java.lang.String overrideServerName, java.lang.Integer overrideServerPort)
Constructs a DefaultCallbackFactory, overriding the server name and port.

DefaultCallbackFactory(java.lang.String overrideServerName, java.lang.Integer overrideServerPort, java.lang.String overridePath)
Constructs a DefaultCallbackFactory, overriding the server name, port, and URL path.

DefaultCallbackFactory(java.lang.String overrideServerName, java.lang.Integer overrideServerPort, java.lang.String overridePath, boolean captureSpecifiedParameters, java.lang.String[] specifiedParameters)
Deprecated.

DefaultCallbackFactory(java.lang.String overrideServerName, java.lang.Integer overrideServerPort, java.lang.String overridePath, java.lang.String[] includeParameters, java.lang.String[] excludeParameters)
Constructs a DefaultCallbackFactory, overriding the server name, port, and URL path, and specifying the parameter names to be captured or not captured.

Method Summary

java.util.Map<java.lang.String,java.lang.String[]>	captureParameters(HttpServletRequest request) Given an HTTP request, returns a map containing the names and values of all HTTP GET or POST parameters that should be included in a callback.
java.lang.String	createCallbackUrl(HttpServletRequest request, boolean includePath) Given an HTTP request, returns a callback URL that should access the same resource as that request.
java.util.Set<java.lang.String>	getExcludeParameters()
java.util.Set<java.lang.String>	getIncludeParameters()
java.lang.String	getOverridePath()
java.lang.String	getOverrideServerName()
java.lang.Integer	getOverrideServerPort()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCallbackFactory

public DefaultCallbackFactory()

Constructs a DefaultCallbackFactory with no overridden properties.

DefaultCallbackFactory

public DefaultCallbackFactory(java.lang.String overrideServerName)

Constructs a DefaultCallbackFactory, overriding the server name.

Parameters:

overrideServerName - the hostname to use in callback URLs, or null to use the default value

DefaultCallbackFactory

public DefaultCallbackFactory(java.lang.String overrideServerName,
                              java.lang.Integer overrideServerPort)

Constructs a DefaultCallbackFactory, overriding the server name and port.

Parameters:

overrideServerName - the hostname to use in callback URLs (e.g. "myhost.com"), or null to use the default value

overrideServerPort - the port to use in callback URLs, or null to use the default value

DefaultCallbackFactory

public DefaultCallbackFactory(java.lang.String overrideServerName,
                              java.lang.Integer overrideServerPort,
                              java.lang.String overridePath)

Constructs a DefaultCallbackFactory, overriding the server name, port, and URL path.

Parameters:

overrideServerName - the hostname to use in callback URLs, or null to use the default value

overrideServerPort - the port to use in callback URLs, or null to use the default value

overridePath - the path to use in callback URLs (e.g. "/foo/bar"), or null to use the default value

DefaultCallbackFactory

public DefaultCallbackFactory(java.lang.String overrideServerName,
                              java.lang.Integer overrideServerPort,
                              java.lang.String overridePath,
                              boolean captureSpecifiedParameters,
                              java.lang.String[] specifiedParameters)

Deprecated.

Constructs a DefaultCallbackFactory, overriding the server name, port, and URL path, and specifying the parameter names to be captured or not captured.

Parameters:

overrideServerName - the hostname to use in callback URLs, or null to use the default value

overrideServerPort - the port to use in callback URLs, or null to use the default value

overridePath - the path to use in callback URLs, or null to use the default value

captureSpecifiedParameters - true if the specified parameters are the only ones that should be captured; false if they are the only ones that should not be captured

specifiedParameters - a list of parameter names

DefaultCallbackFactory

public DefaultCallbackFactory(java.lang.String overrideServerName,
                              java.lang.Integer overrideServerPort,
                              java.lang.String overridePath,
                              java.lang.String[] includeParameters,
                              java.lang.String[] excludeParameters)

Constructs a DefaultCallbackFactory, overriding the server name, port, and URL path, and specifying the parameter names to be captured or not captured.

Parameters:

overrideServerName - the hostname to use in callback URLs, or null to use the default value

overrideServerPort - the port to use in callback URLs, or null to use the default value

overridePath - the path to use in callback URLs, or null to use the default value

includeParameters - specific parameter names to be captured, or null to include all by default

excludeParameters - specific parameter names to be excluded, or null for no specific exclusions

Method Detail

getOverrideServerName

public java.lang.String getOverrideServerName()

getOverrideServerPort

public java.lang.Integer getOverrideServerPort()

getOverridePath

public java.lang.String getOverridePath()

getIncludeParameters

public java.util.Set<java.lang.String> getIncludeParameters()

getExcludeParameters

public java.util.Set<java.lang.String> getExcludeParameters()

createCallbackUrl

public java.lang.String createCallbackUrl(HttpServletRequest request,
                                          boolean includePath)

Description copied from interface: CallbackFactory

Given an HTTP request, returns a callback URL that should access the same resource as that request.

Specified by:

createCallbackUrl in interface CallbackFactory

Parameters:

request - the current HTTP request

includePath - true if the full URL path should be included (not including the query string); false if it should just be the server and port

captureParameters

public java.util.Map<java.lang.String,java.lang.String[]> captureParameters(HttpServletRequest request)

Description copied from interface: CallbackFactory

Given an HTTP request, returns a map containing the names and values of all HTTP GET or POST parameters that should be included in a callback.

Specified by:

captureParameters in interface CallbackFactory

Parameters:

request - the current HTTP request

Returns:

a map of parameter names and values; each value is an array, since a parameter name may have multiple values