Package org.apache.guacamole.form

Class RedirectField

java.lang.Object

org.apache.guacamole.form.Field

org.apache.guacamole.form.RedirectField

All Implemented Interfaces:

Translatable

public class RedirectField
extends Field
implements Translatable

A Guacamole field that redirects a user to another page.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.guacamole.form.Field

Field.Type

Constructor Summary

Constructors

Constructor	Description
RedirectField(String name, URI redirectUrl, TranslatableMessage redirectMessage)	Creates a new field which facilitates redirection of the user to another page.

Method Summary

Modifier and Type	Method	Description
String	getRedirectUrl()	Returns the URL to which the user should be redirected.
TranslatableMessage	getTranslatableMessage()	Returns a message which can be translated using a translation service, consisting of a translation key and optional set of substitution variables.

Methods inherited from class org.apache.guacamole.form.Field

getName, getOptions, getType, setName, setOptions, setType

Methods inherited from class java.lang.Object

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

Constructor Details

RedirectField

public RedirectField(String name,
 URI redirectUrl,
 TranslatableMessage redirectMessage)

Creates a new field which facilitates redirection of the user to another page.

Parameters:

name - The name of this field.

redirectUrl - The URL to which the user should be redirected.

redirectMessage - The translatable message that should be displayed for the user while the browser redirects.

Method Details

getRedirectUrl

public String getRedirectUrl()

Returns the URL to which the user should be redirected.

Returns:

The URL to which the user should be redirected.

getTranslatableMessage

public TranslatableMessage getTranslatableMessage()

Description copied from interface: Translatable

Returns a message which can be translated using a translation service, consisting of a translation key and optional set of substitution variables.

Specified by:

getTranslatableMessage in interface Translatable

Returns:

A message which can be translated using a translation service.