com.atlassian.crowd.openid.server.util

Class UrlTemplateFormatter

java.lang.Object

com.atlassian.crowd.openid.server.util.UrlTemplateFormatter

public class UrlTemplateFormatter
extends Object

Constructor Summary

Constructors

Constructor and Description
UrlTemplateFormatter()

Method Summary

Modifier and Type	Method and Description
String	formatUrlTemplate(String urlTemplate, Map<String,String> variableValues) Expands variable references in urlTemplate with variableValues.
String	patternForVariableNamed(String variableName)

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlTemplateFormatter

public UrlTemplateFormatter()

Method Detail

formatUrlTemplate

public String formatUrlTemplate(String urlTemplate,
                                Map<String,String> variableValues)

Expands variable references in urlTemplate with variableValues.

The variable references look like "${foo}" and will be replaced with the value matching the that key from variableValues. The inserted value will be encoded suitably for a URL query parameter. The names may not contain '}' characters but are otherwise unconstrained. Variables which do not have associated values in the request are replaced with the empty string. There is no syntax to escape this expansion.

Parameters:

urlTemplate - the template to expand.

variableValues - the variable values to use when expanding the template

Returns:

the template expanded as detailed above.

patternForVariableNamed

public String patternForVariableNamed(String variableName)

Parameters:

variableName - name of the variable of interest

Returns:

the pattern that this formatter would look for in a url passed to formatUrlTemplate(String, java.util.Map) in order to replace a variable called variableName.