org.apache.tapestry.valid

Class UrlValidator

java.lang.Object

org.apache.tapestry.valid.BaseValidator

org.apache.tapestry.valid.UrlValidator

All Implemented Interfaces:

IValidator

public class UrlValidator
extends BaseValidator

Since:

3.0

Field Summary

Fields inherited from class org.apache.tapestry.valid.BaseValidator

FIELD_SYMBOL, FORM_SYMBOL, FUNCTION_SYMBOL, VALIDATOR_SYMBOL

Constructor Summary

Constructors

Constructor and Description
UrlValidator()
UrlValidator(java.lang.String initializer) Initializes the UrlValidator with properties defined by the initializer.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	buildDisallowedProtocolMessage(IFormComponent field)
protected java.lang.String	buildInvalidUrlFormatMessage(IFormComponent field)
protected java.lang.String	buildMinimumLengthMessage(IFormComponent field)
java.lang.String	getDisallowedProtocolMessage()
java.lang.String	getInvalidUrlFormatMessage()
int	getMinimumLength()
java.lang.String	getMinimumLengthMessage()
protected java.lang.String	getPattern(java.lang.String override, java.lang.String key, java.util.Locale locale) Gets a pattern, either as the default value, or as a localized key.
java.lang.String	getScriptPath()
protected boolean	isAllowedProtocol(java.lang.String url)
protected boolean	isValidUrl(java.lang.String url)
void	renderValidatorContribution(IFormComponent field, IMarkupWriter writer, IRequestCycle cycle) This implementation does nothing.
void	setAllowedProtocols(java.lang.String protocols)
void	setDisallowedProtocolMessage(java.lang.String string)
void	setInvalidUrlFormatMessage(java.lang.String string)
void	setMinimumLength(int minimumLength)
void	setMinimumLengthMessage(java.lang.String string)
void	setScriptPath(java.lang.String scriptPath)
java.lang.Object	toObject(IFormComponent field, java.lang.String input) Converts input, submitted by the client, into an object value.
java.lang.String	toString(IFormComponent field, java.lang.Object value) Invoked during rendering to convert an object value (which may be null) to a String.

Methods inherited from class org.apache.tapestry.valid.BaseValidator

buildRequiredMessage, checkRequired, formatString, formatString, formatString, getRequiredMessage, isClientScriptingEnabled, isRequired, processValidatorScript, setClientScriptingEnabled, setRequired, setRequiredMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlValidator

public UrlValidator()

UrlValidator

public UrlValidator(java.lang.String initializer)

Initializes the UrlValidator with properties defined by the initializer.

Since:

4.0

Method Detail

toString

public java.lang.String toString(IFormComponent field,
                        java.lang.Object value)

Description copied from interface: IValidator

Invoked during rendering to convert an object value (which may be null) to a String. It is acceptible to return null. The string will be the VALUE attribute of the HTML text field.

toObject

public java.lang.Object toObject(IFormComponent field,
                        java.lang.String input)
                          throws ValidatorException

Description copied from interface: IValidator

Converts input, submitted by the client, into an object value. May return null if the input is null (and the required flag is false).

The input string will already have been trimmed. It may be null.

Throws:

ValidatorException - if the string cannot be converted into an object, or the object is not valid (due to other constraints).

getMinimumLength

public int getMinimumLength()

setMinimumLength

public void setMinimumLength(int minimumLength)

renderValidatorContribution

public void renderValidatorContribution(IFormComponent field,
                               IMarkupWriter writer,
                               IRequestCycle cycle)

Description copied from class: BaseValidator

This implementation does nothing. Subclasses may supply their own implementation.

Specified by:

renderValidatorContribution in interface IValidator

Overrides:

renderValidatorContribution in class BaseValidator

getScriptPath

public java.lang.String getScriptPath()

setScriptPath

public void setScriptPath(java.lang.String scriptPath)

isValidUrl

protected boolean isValidUrl(java.lang.String url)

isAllowedProtocol

protected boolean isAllowedProtocol(java.lang.String url)

getInvalidUrlFormatMessage

public java.lang.String getInvalidUrlFormatMessage()

getMinimumLengthMessage

public java.lang.String getMinimumLengthMessage()

setInvalidUrlFormatMessage

public void setInvalidUrlFormatMessage(java.lang.String string)

getDisallowedProtocolMessage

public java.lang.String getDisallowedProtocolMessage()

setDisallowedProtocolMessage

public void setDisallowedProtocolMessage(java.lang.String string)

setMinimumLengthMessage

public void setMinimumLengthMessage(java.lang.String string)

buildMinimumLengthMessage

protected java.lang.String buildMinimumLengthMessage(IFormComponent field)

buildInvalidUrlFormatMessage

protected java.lang.String buildInvalidUrlFormatMessage(IFormComponent field)

buildDisallowedProtocolMessage

protected java.lang.String buildDisallowedProtocolMessage(IFormComponent field)

getPattern

protected java.lang.String getPattern(java.lang.String override,
                          java.lang.String key,
                          java.util.Locale locale)

Description copied from class: BaseValidator

Gets a pattern, either as the default value, or as a localized key. If override is null, then the key from the org.apache.tapestry.valid.ValidationStrings ResourceBundle(in the specified locale) is used. The pattern can then be used with BaseValidator.formatString(String, Object[]).

Why do we not just lump these strings into TapestryStrings.properties? because TapestryStrings.properties is localized to the server's locale, which is fine for the logging, debugging and error messages it contains. For field validation, whose errors are visible to the end user normally, we want to localize to the page's locale.

Overrides:

getPattern in class BaseValidator

Parameters:

override - The override value for the localized string from the bundle.

key - used to lookup pattern from bundle, if override is null.

locale - used to get right localization of bundle.

setAllowedProtocols

public void setAllowedProtocols(java.lang.String protocols)

Parameters:

protocols - comma separated list of allowed protocols