Package ru.bgcrm.struts.form

Class DynActionForm

  • All Implemented Interfaces:
    java.io.Serializable, org.apache.commons.beanutils.DynaBean, org.apache.commons.beanutils.DynaClass
    Direct Known Subclasses:
    BillingActionForm, FileUploadActionForm
    public class DynActionForm
extends org.apache.struts.action.ActionForm
implements org.apache.commons.beanutils.DynaBean, org.apache.commons.beanutils.DynaClass
    HTTP request execution's context, contains: request, DB connection and response data.
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean contains​(java.lang.String name, java.lang.String key)  
      java.lang.Object get​(java.lang.String name)  
      java.lang.Object get​(java.lang.String name, int index)  
      java.lang.Object get​(java.lang.String name, java.lang.String key)  
      java.lang.String getAction()
      Возвращает параметр запроса action.
      java.lang.String getAreaId()
      Возвращает параметр запроса areaId либо склеенный URL запроса + action.
      ConnectionSet getConnectionSet()  
      org.apache.commons.beanutils.DynaClass getDynaClass()  
      org.apache.commons.beanutils.DynaProperty[] getDynaProperties()  
      org.apache.commons.beanutils.DynaProperty getDynaProperty​(java.lang.String name)  
      org.apache.struts.upload.FormFile getFile()  
      java.lang.String getForward()
      Возвращает параметр запроса forward.
      java.lang.String getForwardFile()
      Возвращает параметр запроса forwardFile.
      javax.servlet.http.HttpServletRequest getHttpRequest()  
      java.lang.String getHttpRequestRemoteAddr()
      Gets IP address of request from HTTP header 'X-Real-IP' or another defined in configuration param AccessLogValve.PARAM_HEADER_NAME_REMOTE_ADDR or ServletRequest.getRemoteAddr()
      javax.servlet.http.HttpServletResponse getHttpResponse()  
      java.io.OutputStream getHttpResponseOutputStream()  
      java.io.PrintWriter getHttpResponseWriter()  
      int getId()
      Возвращает параметр запроса id.
      java.lang.String getName()  
      Page getPage()  
      java.lang.String getPageableId()
      Возвращает параметр запроса pageableId либо склеенный URL запроса + action.
      ArrayHashMap getParam()
      Возвращает доступ к мапу параметров, для получения в JSP.
      java.lang.String getParam​(java.lang.String name)
      Gets HTTP request parameter.
      java.lang.String getParam​(java.lang.String name, java.lang.String defaultValue)
      Gets HTTP request parameter.
      java.lang.String getParam​(java.lang.String name, java.lang.String defaultValue, boolean defaultSet, java.util.function.Predicate<java.lang.String> validate)
      Gets HTTP request parameter.
      java.lang.String getParam​(java.lang.String name, java.lang.String defaultValue, java.util.function.Predicate<java.lang.String> validate)  
      java.lang.String getParam​(java.lang.String name, java.util.function.Predicate<java.lang.String> validate)  
      java.lang.String[] getParamArray​(java.lang.String name)
      Возвращает значения параметров HTTP запроса.
      boolean getParamBoolean​(java.lang.String name)  
      java.lang.Boolean getParamBoolean​(java.lang.String name, java.lang.Boolean defaultValue)  
      java.util.Date getParamDate​(java.lang.String name)  
      java.util.Date getParamDate​(java.lang.String name, java.util.Date defaultValue)  
      java.util.Date getParamDate​(java.lang.String name, java.util.Date defaultValue, boolean defaultSet)
      Gets HTTP request parameter with type date, format TimeUtils.FORMAT_TYPE_YMD.
      java.util.Date getParamDateTime​(java.lang.String name)  
      java.util.Date getParamDateTime​(java.lang.String name, java.util.Date defaultValue)  
      int getParamInt​(java.lang.String name)  
      int getParamInt​(java.lang.String name, int defaultValue)  
      long getParamLong​(java.lang.String name)  
      long getParamLong​(java.lang.String name, long defaultValue)  
      ParameterMap getPermission()  
      java.lang.String getRequestUrl()
      Возвращает параметр запроса requestUrl.
      Response getResponse()  
      java.lang.String getResponseType()
      Возвращает параметр запроса responseType.
      java.lang.String getReturnChildUiid()
      Возвращает id HTML элемента на предка которого нужно загрузить returnUrl для возвращения из редактора.
      java.lang.String getReturnScript()
      Возвращает параметр запроса returnScript.
      java.lang.String getReturnUiid()
      Возвращает id HTML элемента на который нужно загрузить returnUrl для возвращения из редактора.
      java.lang.String getReturnUrl()
      Возвращает URL, который нужно загрузить для возвращения из редактора.
      java.util.Set<java.lang.Integer> getSelectedValues​(java.lang.String name)
      Возвращает набор выбранных числовых значений, переданных в форме несколько значений как param()="", выбираются только целочисленные значения.
      java.util.List<java.lang.Integer> getSelectedValuesList​(java.lang.String name)
      Возвращает набор выбранных числовых значений, переданных в форме несколько значений как param()="", выбираются только ненулевые значения.
      java.util.List<java.lang.String> getSelectedValuesListStr​(java.lang.String name)
      Возвращает список выбранных числовых значений, переданных в форме несколько значений как param()="".
      java.util.List<java.lang.String> getSelectedValuesListStr​(java.lang.String name, java.lang.String exclude)
      Возвращает список выбранных числовых значений, переданных в форме несколько значений как param()="", из списка исключаются значения равные exclude, если != null.
      java.util.Set<java.lang.String> getSelectedValuesStr​(java.lang.String name)
      Values of HTTP request parameter.
      User getUser()  
      int getUserId()  
      org.apache.commons.beanutils.DynaBean newInstance()  
      void remove​(java.lang.String name, java.lang.String key)  
      void set​(java.lang.String name, int index, java.lang.Object value)  
      void set​(java.lang.String name, java.lang.Object value)  
      void set​(java.lang.String name, java.lang.String key, java.lang.Object value)  
      void setConnectionSet​(ConnectionSet value)  
      void setFile​(org.apache.struts.upload.FormFile file)  
      void setForward​(java.lang.String value)  
      void setForwardFile​(java.lang.String value)
      Deprecated.
      void setHttpRequest​(javax.servlet.http.HttpServletRequest httpRequest)  
      void setHttpResponse​(javax.servlet.http.HttpServletResponse httpResponse)  
      void setParam​(java.lang.String name, java.lang.String value)  
      void setParam​(ArrayHashMap param)  
      void setParamArray​(java.lang.String name, java.lang.String[] values)
      Устанавливает значения параметров HTTP запроса.
      void setParamArray​(java.lang.String name, java.util.Collection<?> values)  
      void setPermission​(ParameterMap permission)  
      void setRequestAttribute​(java.lang.String key, java.lang.Object value)
      Set HTTP request attribute.
      void setRequestUrl​(java.lang.String requestUrl)  
      void setResponseData​(java.lang.String key, java.lang.Object value)
      Set response object data.
      void setResponseType​(java.lang.String responseType)
      Устанавливает параметр запроса responseType.
      void setReturnChildUiid​(java.lang.String value)  
      void setReturnUrl​(java.lang.String returnUrl)  
      void setUser​(User user)  

      • Methods inherited from class org.apache.struts.action.ActionForm

        getMultipartRequestHandler, getServlet, getServletWrapper, reset, reset, setMultipartRequestHandler, setServlet, validate, validate

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DynActionForm

        public DynActionForm()
        Empty constructor for Struts.

      • DynActionForm

        public DynActionForm​(java.lang.String url)
        Constructor from string URL.

      • DynActionForm

        public DynActionForm​(User user)

    • Method Detail

      • getHttpRequest

        public javax.servlet.http.HttpServletRequest getHttpRequest()

      • getHttpRequestRemoteAddr

        public java.lang.String getHttpRequestRemoteAddr()
        Gets IP address of request from HTTP header 'X-Real-IP' or another defined in configuration param AccessLogValve.PARAM_HEADER_NAME_REMOTE_ADDR or ServletRequest.getRemoteAddr()
        Returns:

      • setHttpRequest

        public void setHttpRequest​(javax.servlet.http.HttpServletRequest httpRequest)

      • getHttpResponse

        public javax.servlet.http.HttpServletResponse getHttpResponse()

      • setHttpResponse

        public void setHttpResponse​(javax.servlet.http.HttpServletResponse httpResponse)

      • getHttpResponseOutputStream

        public java.io.OutputStream getHttpResponseOutputStream()
                                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • getHttpResponseWriter

        public java.io.PrintWriter getHttpResponseWriter()
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • setConnectionSet

        public void setConnectionSet​(ConnectionSet value)

      • getResponse

        public Response getResponse()

      • setResponseData

        public void setResponseData​(java.lang.String key,
                            java.lang.Object value)
        Set response object data.
        Parameters:
        key -
        value -

      • setRequestAttribute

        public void setRequestAttribute​(java.lang.String key,
                                java.lang.Object value)
        Set HTTP request attribute. Unlike response data, not serialized to JSON.
        Parameters:
        key -
        value -

      • getUser

        public User getUser()

      • setUser

        public void setUser​(User user)

      • getUserId

        public int getUserId()

      • setPermission

        public void setPermission​(ParameterMap permission)

      • getPage

        public Page getPage()

      • getFile

        public org.apache.struts.upload.FormFile getFile()

      • setFile

        public void setFile​(org.apache.struts.upload.FormFile file)

      • getParam

        public ArrayHashMap getParam()
        Возвращает доступ к мапу параметров, для получения в JSP.
        Returns:

      • getAction

        public java.lang.String getAction()
        Возвращает параметр запроса action.
        Returns:

      • getId

        public int getId()
        Возвращает параметр запроса id.
        Returns:

      • getResponseType

        public java.lang.String getResponseType()
        Возвращает параметр запроса responseType.
        Returns:

      • setResponseType

        public void setResponseType​(java.lang.String responseType)
        Устанавливает параметр запроса responseType.
        Parameters:
        responseType -

      • getForward

        public java.lang.String getForward()
        Возвращает параметр запроса forward.
        Returns:

      • setForward

        public void setForward​(java.lang.String value)

      • getForwardFile

        public java.lang.String getForwardFile()
        Возвращает параметр запроса forwardFile.
        Returns:

      • setForwardFile

        @Deprecated
public void setForwardFile​(java.lang.String value)
        Deprecated.
        Return JSP template directly.
        Parameters:
        value -

      • getRequestUrl

        public java.lang.String getRequestUrl()
        Возвращает параметр запроса requestUrl.
        Returns:

      • setRequestUrl

        public void setRequestUrl​(java.lang.String requestUrl)

      • getReturnUrl

        public java.lang.String getReturnUrl()
        Возвращает URL, который нужно загрузить для возвращения из редактора.
        Returns:

      • setReturnUrl

        public void setReturnUrl​(java.lang.String returnUrl)

      • getReturnUiid

        public java.lang.String getReturnUiid()
        Возвращает id HTML элемента на который нужно загрузить returnUrl для возвращения из редактора.
        Returns:

      • getReturnChildUiid

        public java.lang.String getReturnChildUiid()
        Возвращает id HTML элемента на предка которого нужно загрузить returnUrl для возвращения из редактора.
        Returns:

      • setReturnChildUiid

        public void setReturnChildUiid​(java.lang.String value)

      • getReturnScript

        public java.lang.String getReturnScript()
        Возвращает параметр запроса returnScript.
        Returns:

      • getPageableId

        public java.lang.String getPageableId()
        Возвращает параметр запроса pageableId либо склеенный URL запроса + action.
        Returns:

      • getAreaId

        public java.lang.String getAreaId()
        Возвращает параметр запроса areaId либо склеенный URL запроса + action.
        Returns:

      • getParam

        public java.lang.String getParam​(java.lang.String name,
                                 java.lang.String defaultValue,
                                 boolean defaultSet,
                                 java.util.function.Predicate<java.lang.String> validate)
                          throws BGIllegalArgumentException
        Gets HTTP request parameter.
        Parameters:
        name - parameter name.
        defaultValue - default value if not presented in request.
        defaultSet - set default value back in request for using in JSP.
        validate - optional value validator.
        Returns:
        Throws:
        BGIllegalArgumentException - if validation fails.

      • getParam

        public java.lang.String getParam​(java.lang.String name,
                                 java.lang.String defaultValue)
        Gets HTTP request parameter.
        Parameters:
        name -
        defaultValue -
        Returns:
        the value of parameter with {@param name} or {@param defaultValue} if not presented.

      • getParam

        public java.lang.String getParam​(java.lang.String name)
        Gets HTTP request parameter.
        Parameters:
        name -
        Returns:
        parameter value or null if missing or empty.

      • setParam

        public void setParam​(java.lang.String name,
                     java.lang.String value)

      • getParamDate

        public java.util.Date getParamDate​(java.lang.String name,
                                   java.util.Date defaultValue,
                                   boolean defaultSet)
        Gets HTTP request parameter with type date, format TimeUtils.FORMAT_TYPE_YMD.
        Parameters:
        name - parameter name.
        defaultValue - default value if not presented in request.
        defaultSet - set default value back in request for using in JSP.
        Returns:

      • getParamDate

        public java.util.Date getParamDate​(java.lang.String name,
                                   java.util.Date defaultValue)

      • getParamDate

        public java.util.Date getParamDate​(java.lang.String name)

      • getParamDateTime

        public java.util.Date getParamDateTime​(java.lang.String name,
                                       java.util.Date defaultValue)

      • getParamDateTime

        public java.util.Date getParamDateTime​(java.lang.String name)

      • getParamInt

        public int getParamInt​(java.lang.String name,
                       int defaultValue)

      • getParamInt

        public int getParamInt​(java.lang.String name)

      • getParamLong

        public long getParamLong​(java.lang.String name,
                         long defaultValue)

      • getParamLong

        public long getParamLong​(java.lang.String name)

      • getParamBoolean

        public java.lang.Boolean getParamBoolean​(java.lang.String name,
                                         java.lang.Boolean defaultValue)

      • getParamBoolean

        public boolean getParamBoolean​(java.lang.String name)

      • getParamArray

        public java.lang.String[] getParamArray​(java.lang.String name)
        Возвращает значения параметров HTTP запроса.
        Parameters:
        name - имя параметра.
        Returns:
        null, если параметр не установлен.

      • setParamArray

        public void setParamArray​(java.lang.String name,
                          java.lang.String[] values)
        Устанавливает значения параметров HTTP запроса.
        Parameters:
        name - имя параметра.
        values - значения.

      • setParamArray

        public void setParamArray​(java.lang.String name,
                          java.util.Collection<?> values)

      • get

        public java.lang.Object get​(java.lang.String name)
        Specified by:
        get in interface org.apache.commons.beanutils.DynaBean

      • set

        public void set​(java.lang.String name,
                java.lang.Object value)
        Specified by:
        set in interface org.apache.commons.beanutils.DynaBean

      • getSelectedValues

        public java.util.Set<java.lang.Integer> getSelectedValues​(java.lang.String name)
        Возвращает набор выбранных числовых значений, переданных в форме несколько значений как param()="", выбираются только целочисленные значения.
        Returns:

      • getSelectedValuesStr

        public java.util.Set<java.lang.String> getSelectedValuesStr​(java.lang.String name)
        Values of HTTP request parameter.
        Parameters:
        name - parameter name.
        Returns:
        set with name parameter values.

      • getSelectedValuesListStr

        public java.util.List<java.lang.String> getSelectedValuesListStr​(java.lang.String name)
        Возвращает список выбранных числовых значений, переданных в форме несколько значений как param()="".
        Returns:

      • getSelectedValuesListStr

        public java.util.List<java.lang.String> getSelectedValuesListStr​(java.lang.String name,
                                                                 java.lang.String exclude)
        Возвращает список выбранных числовых значений, переданных в форме несколько значений как param()="", из списка исключаются значения равные exclude, если != null.
        Returns:

      • getSelectedValuesList

        public java.util.List<java.lang.Integer> getSelectedValuesList​(java.lang.String name)
        Возвращает набор выбранных числовых значений, переданных в форме несколько значений как param()="", выбираются только ненулевые значения.
        Returns:

      • contains

        public boolean contains​(java.lang.String name,
                        java.lang.String key)
        Specified by:
        contains in interface org.apache.commons.beanutils.DynaBean

      • get

        public java.lang.Object get​(java.lang.String name,
                            int index)
        Specified by:
        get in interface org.apache.commons.beanutils.DynaBean

      • get

        public java.lang.Object get​(java.lang.String name,
                            java.lang.String key)
        Specified by:
        get in interface org.apache.commons.beanutils.DynaBean

      • getDynaClass

        public org.apache.commons.beanutils.DynaClass getDynaClass()
        Specified by:
        getDynaClass in interface org.apache.commons.beanutils.DynaBean

      • remove

        public void remove​(java.lang.String name,
                   java.lang.String key)
        Specified by:
        remove in interface org.apache.commons.beanutils.DynaBean

      • set

        public void set​(java.lang.String name,
                int index,
                java.lang.Object value)
        Specified by:
        set in interface org.apache.commons.beanutils.DynaBean

      • set

        public void set​(java.lang.String name,
                java.lang.String key,
                java.lang.Object value)
        Specified by:
        set in interface org.apache.commons.beanutils.DynaBean

      • getName

        public java.lang.String getName()
        Specified by:
        getName in interface org.apache.commons.beanutils.DynaClass

      • getDynaProperty

        public org.apache.commons.beanutils.DynaProperty getDynaProperty​(java.lang.String name)
        Specified by:
        getDynaProperty in interface org.apache.commons.beanutils.DynaClass

      • getDynaProperties

        public org.apache.commons.beanutils.DynaProperty[] getDynaProperties()
        Specified by:
        getDynaProperties in interface org.apache.commons.beanutils.DynaClass

      • newInstance

        public org.apache.commons.beanutils.DynaBean newInstance()
                                                  throws java.lang.IllegalAccessException,
                                                         java.lang.InstantiationException
        Specified by:
        newInstance in interface org.apache.commons.beanutils.DynaClass
        Throws:
        java.lang.IllegalAccessException
        java.lang.InstantiationException