Package hudson.util

Class FormFieldValidator

    • Field Detail

      • CHECK

        public static final Permission CHECK
        Deprecated.
      • request

        protected final org.kohsuke.stapler.StaplerRequest request
        Deprecated.
      • response

        protected final org.kohsuke.stapler.StaplerResponse response
        Deprecated.
      • permission

        protected final Permission permission
        Deprecated.
        Permission to check, or null if this check doesn't require any permission.
      • subject

        protected final AccessControlled subject
        Deprecated.
        The object to which the permission is checked against. If permission is non-null, must be non-null.
    • Constructor Detail

      • FormFieldValidator

        protected FormFieldValidator​(org.kohsuke.stapler.StaplerRequest request,
                                     org.kohsuke.stapler.StaplerResponse response,
                                     boolean adminOnly)
        Deprecated.
        Parameters:
        adminOnly - Pass true to only let admin users to run the check. This is necessary for security reason, so that unauthenticated user cannot obtain sensitive information or run a process that may have side-effect.
      • FormFieldValidator

        @Deprecated
        protected FormFieldValidator​(org.kohsuke.stapler.StaplerRequest request,
                                     org.kohsuke.stapler.StaplerResponse response,
                                     Permission permission)
        Deprecated.
        Use FormFieldValidator(Permission) and remove StaplerRequest and StaplerResponse from your "doCheck..." method parameter
      • FormFieldValidator

        protected FormFieldValidator​(Permission permission)
        Deprecated.
        Parameters:
        permission - Permission needed to perform this validation, or null if no permission is necessary.
    • Method Detail

      • process

        public final void process()
                           throws IOException,
                                  javax.servlet.ServletException
        Deprecated.
        Runs the validation code.
        Throws:
        IOException
        javax.servlet.ServletException
      • check

        protected abstract void check()
                               throws IOException,
                                      javax.servlet.ServletException
        Deprecated.
        Throws:
        IOException
        javax.servlet.ServletException
      • getFileParameter

        protected final File getFileParameter​(String paramName)
        Deprecated.
        Gets the parameter as a file.
      • ok

        public void ok()
                throws IOException,
                       javax.servlet.ServletException
        Deprecated.
        Sends out an HTML fragment that indicates a success.
        Throws:
        IOException
        javax.servlet.ServletException
      • respond

        public void respond​(String html)
                     throws IOException,
                            javax.servlet.ServletException
        Deprecated.
        Sends out an arbitrary HTML fragment.
        Throws:
        IOException
        javax.servlet.ServletException
      • error

        public void error​(String message)
                   throws IOException,
                          javax.servlet.ServletException
        Deprecated.
        Sends out a string error message that indicates an error.
        Parameters:
        message - Human readable message to be sent. error(null) can be used as ok().
        Throws:
        IOException
        javax.servlet.ServletException
      • warning

        public void warning​(String message)
                     throws IOException,
                            javax.servlet.ServletException
        Deprecated.
        Throws:
        IOException
        javax.servlet.ServletException
      • ok

        public void ok​(String message)
                throws IOException,
                       javax.servlet.ServletException
        Deprecated.
        Throws:
        IOException
        javax.servlet.ServletException
      • warning

        public void warning​(String format,
                            Object... args)
                     throws IOException,
                            javax.servlet.ServletException
        Deprecated.
        Throws:
        IOException
        javax.servlet.ServletException
      • ok

        public void ok​(String format,
                       Object... args)
                throws IOException,
                       javax.servlet.ServletException
        Deprecated.
        Throws:
        IOException
        javax.servlet.ServletException
      • errorWithMarkup

        public void errorWithMarkup​(String message)
                             throws IOException,
                                    javax.servlet.ServletException
        Deprecated.
        Sends out an HTML fragment that indicates an error.

        This method must be used with care to avoid cross-site scripting attack.

        Parameters:
        message - Human readable message to be sent. error(null) can be used as ok().
        Throws:
        IOException
        javax.servlet.ServletException
      • warningWithMarkup

        public void warningWithMarkup​(String message)
                               throws IOException,
                                      javax.servlet.ServletException
        Deprecated.
        Throws:
        IOException
        javax.servlet.ServletException
      • okWithMarkup

        public void okWithMarkup​(String message)
                          throws IOException,
                                 javax.servlet.ServletException
        Deprecated.
        Throws:
        IOException
        javax.servlet.ServletException