sapphire.util

Class ForwardUtil

java.lang.Object

com.labvantage.sapphire.BaseClass

sapphire.util.ForwardUtil

public class ForwardUtil
extends com.labvantage.sapphire.BaseClass

Used inside Servlets or JSP Pages to create an HTML form. The form can contain hidden fields and values (properties) that can be submitted to generate a new HTTP request.

Field Summary

Fields inherited from class com.labvantage.sapphire.BaseClass

FAILURE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
ForwardUtil()
ForwardUtil(javax.servlet.ServletRequest request) Use this constructor to ensure CSRF attack protection of the form generated by this object

Method Summary

Modifier and Type	Method and Description
java.lang.String	getForm(java.lang.String formid, java.lang.String action, java.lang.String method, boolean autosubmit) Returns a String containing the text to generate the HTML form.
java.lang.String	getForm(java.lang.String formid, java.lang.String action, java.lang.String method, boolean autosubmit, boolean parseURLToForm) Returns a String containing the text to generate the HTML form.
java.lang.String	getURLParams() Returns a query string (e.g.
void	setProperties(java.util.HashMap props) Add a collection of property/value pairs.
void	setProperty(java.lang.String propertyid, java.lang.String value) Add a property/value pair.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardUtil

public ForwardUtil()

ForwardUtil

public ForwardUtil(javax.servlet.ServletRequest request)

Use this constructor to ensure CSRF attack protection of the form generated by this object

Parameters:

request - - the request object from jsp or ajax request.

Method Detail

setProperty

public void setProperty(java.lang.String propertyid,
                        java.lang.String value)

Add a property/value pair. This will become a hidden input tag in the form.

Parameters:

propertyid - the name of the property - this will be come the name of the hidden input tag

value - the value to put into the form - this will become the value attribute of the hidden input tag

setProperties

public void setProperties(java.util.HashMap props)

Add a collection of property/value pairs. These will become a hidden input tags in the form.

Parameters:

props - contains a collection of property/value pairs. The Map keys will become the names of the input tags and the Map values will be tag value attributes.

getForm

public java.lang.String getForm(java.lang.String formid,
                                java.lang.String action,
                                java.lang.String method,
                                boolean autosubmit)

Returns a String containing the text to generate the HTML form. The form will contain hidden input tags for all properties that have been set using the setProperty() or setProperties() methods. The form will be contained inside a DIV with a display style of 'none'.

Parameters:

formid - the id that will be given to the form

action - the form action. This will typically be a URL for a JSP or Servlet.

method - the form method. Typically, either "Get" or "Post".

autosubmit - true will force the form to be submitted by the webpage as soon as the form has been rendered.

Returns:

the form definition and corresponding submit method.

getForm

public java.lang.String getForm(java.lang.String formid,
                                java.lang.String action,
                                java.lang.String method,
                                boolean autosubmit,
                                boolean parseURLToForm)

Returns a String containing the text to generate the HTML form. The form will contain hidden input tags for all properties that have been set using the setProperty() or setProperties() methods. The form will be contained inside a DIV with a display style of 'none'.

Parameters:

formid - the id that will be given to the form

action - the form action. This will typically be a URL for a JSP or Servlet.

method - the form method. Typically, either "Get" or "Post".

autosubmit - true will force the form to be submitted by the webpage as soon as the form has been rendered.

parseURLToForm - true will parse the action into it's query parts and create input field.

Returns:

the form definition and corresponding submit method.

getURLParams

public java.lang.String getURLParams()

Returns a query string (e.g. "param1=xxx¶m2=yyy¶m3=zzz") representing the properties that have been set using he setProperty() or setProperties() methods. The query string can then be added to the end of a URL.

Returns:

the query string that can be added to a URL.