How to use PrimeFaces p fileUpload Listener method is never invoked or UploadedFile is null throws an error not usable

Question

I m trying to upload a file using PrimeFaces  but the fileUploadListener method isn t being invoked after the upload finishes   Here is the view    lt h form gt       lt p fileUpload fileUploadListener    fileUploadController handleFileUpload           mode  advanced           update  messages          sizeLimit  100000           allowTypes           gif jpe g png      gt        lt p growl id  messages  showDetail  true   gt   lt  h form gt    And the bean    ManagedBean  RequestScoped public class FileUploadController        public void handleFileUpload FileUploadEvent event            FacesMessage msg   new FacesMessage  Succesful   event getFile   getFileName       is uploaded             FacesContext getCurrentInstance   addMessage null  msg              I ve placed a breakpoint on the method  but it s never called  When using mode  simple  and ajax  false   it is been invoked  but I want it to work in the advanced mode  I m using Netbeans and Glassfish 3 1

User · Answer

Looks like javax faces SEPARATOR CHAR must not be equal to

User · Answer

How to configure and troubleshoot  lt p fileUpload gt  depends on PrimeFaces and JSF version  All PrimeFaces versions The below requirements apply to all PrimeFaces versions   The enctype attribute of the  lt h form gt  needs to be set to multipart form-data  When this is absent  the ajax upload may just work  but the general browser behavior is unspecified and dependent on form composition and webbrowser make version  Just always specify it to be on the safe side   When using mode  quot advanced quot   i e  ajax upload  this is the default   then make sure that you ve a  lt h head gt  in the  master  template  This will ensure that the necessary JavaScript files are properly included  This is not required for mode  quot simple quot   non-ajax upload   but this would break look n feel and functionality of all other PrimeFaces components  so you don t want to miss that anyway   When using mode  quot simple quot   i e  non-ajax upload   then ajax must be disabled on any PrimeFaces command buttons links by ajax  quot false quot   and you must use  lt p fileUpload value gt  with  lt p commandButton action gt  instead of  lt p fileUpload listener gt     So  if you want  auto  file upload with ajax support  mind the  lt h head gt      lt h form enctype  quot multipart form-data quot  gt       lt p fileUpload listener  quot   bean upload  quot  auto  quot true quot    gt     For PrimeFaces version older than 8 x this should be fileUploadListener instead of listener   lt  h form gt    public void upload FileUploadEvent event        UploadedFile uploadedFile   event getFile        String fileName   uploadedFile getFileName        String contentType   uploadedFile getContentType        byte   contents   uploadedFile getContents       Or getInputStream              Save it  now     Or if you want non-ajax file upload   lt h form enctype  quot multipart form-data quot  gt       lt p fileUpload mode  quot simple quot  value  quot   bean uploadedFile  quot    gt       lt p commandButton value  quot Upload quot  action  quot   bean upload  quot  ajax  quot false quot    gt   lt  h form gt    private transient UploadedFile uploadedFile      getter setter  public void upload         String fileName   uploadedFile getFileName        String contentType   uploadedFile getContentType        byte   contents   uploadedFile getContents       Or getInputStream              Save it  now     Do note that ajax-related attributes such as auto  allowTypes  update  onstart  oncomplete  etc are ignored in mode  quot simple quot   So it s needless to specify them in such case  Also note that you should read the file contents immediately inside the abovementioned methods and not in a different bean method invoked by a later HTTP request  This is because the uploaded file contents is request scoped and thus unavailable in a later different HTTP request  Any attempt to read it in a later request will most likely end up with java io FileNotFoundException on the temporary file   PrimeFaces 8 x Configuration is identical to the 5 x version info below  but if your listener is not called  check if the method attribute is called listener and not  like with pre 8 x versions  fileUploadListener   PrimeFaces 5 x This does not require any additional configuration if you re using JSF 2 2 and your faces-config xml is also declared conform JSF 2 2 version  You do not need the PrimeFaces file upload filter at all and you also do not need the primefaces UPLOADER context parameter in web xml  In case it s unclear to you how to properly install and configure JSF depending on the target server used  head to How to properly install and configure JSF libraries via Maven  and  quot Installing JSF quot  section of our JSF wiki page  If you re however not using JSF 2 2 yet and you can t upgrade it  should be effortless when already on a Servlet 3 0 compatible container   then you need to manually register the below PrimeFaces file upload filter in web xml  it will parse the multi part request and fill the regular request parameter map so that FacesServlet can continue working as usual    lt filter gt       lt filter-name gt primeFacesFileUploadFilter lt  filter-name gt       lt filter-class gt org primefaces webapp filter FileUploadFilter lt  filter-class gt   lt  filter gt   lt filter-mapping gt       lt filter-name gt primeFacesFileUploadFilter lt  filter-name gt       lt servlet-name gt facesServlet lt  servlet-name gt   lt  filter-mapping gt   The  lt servlet-name gt  value of facesServlet must match exactly the value in the  lt servlet gt  entry of the javax faces webapp FacesServlet in the same web xml  So if it s e g  Faces Servlet  then you need to edit it accordingly to match   PrimeFaces 4 x The same story as PrimeFaces 5 x applies on 4 x as well  There s only a potential problem in getting the uploaded file content by UploadedFile getContents    This will return null when native API is used instead of Apache Commons FileUpload  You need to use UploadedFile getInputStream   instead  See also How to insert uploaded image from p fileUpload as BLOB in MySQL  Another potential problem with native API will manifest is when the upload component is present in a form on which a different  quot regular quot  ajax request is fired which does not process the upload component  See also File upload doesn  39 t work with AJAX in PrimeFaces 4 0 JSF 2 2 x - javax servlet ServletException  The request content-type is not a multipart form-data  Both problems can also be solved by switching to Apache Commons FileUpload  See PrimeFaces 3 x section for detail   PrimeFaces 3 x This version does not support JSF 2 2   Servlet 3 0 native file upload  You need to manually install Apache Commons FileUpload and explicitly register the file upload filter in web xml  You need the following libraries   commons-fileupload jar commons-io jar  Those must be present in the webapp s runtime classpath  When using Maven  make sure they are at least runtime scoped  default scope of compile is also good   When manually carrying around JARs  make sure they end up in  WEB-INF lib folder  The file upload filter registration detail can be found in PrimeFaces 5 x section here above  In case you re using PrimeFaces 4  and you d like to explicitly use Apache Commons FileUpload instead of JSF 2 2   Servlet 3 0 native file upload  then you need next to the mentioned libraries and filter also the below context param in web xml   lt context-param gt       lt param-name gt primefaces UPLOADER lt  param-name gt       lt param-value gt commons lt  param-value gt  lt  -- Allowed values  auto  native and commons  -- gt   lt  context-param gt    Troubleshooting In case it still doesn t work  here are another possible causes unrelated to PrimeFaces configuration   Only if you re using the PrimeFaces file upload filter  There s another Filter in your webapp which runs before the PrimeFaces file upload filter and has already consumed the request body by e g  calling getParameter    getParameterMap    getReader    etcetera  A request body can be parsed only once  When you call one of those methods before the file upload filter does its job  then the file upload filter will get an empty request body  To fix this  you d need to put the  lt filter-mapping gt  of the file upload filter before the other filter in web xml  If the request is not a multipart form-data request  then the file upload filter will just continue as if nothing happened  If you use filters that are automagically added because they use annotations  e g  PrettyFaces   you might need to add explicit ordering via web xml  See How to define servlet filter order of execution using annotations in WAR  Only if you re using the PrimeFaces file upload filter  There s another Filter in your webapp which runs before the PrimeFaces file upload filter and has performed a RequestDispatcher forward   call  Usually  URL rewrite filters such as PrettyFaces do this  This triggers the FORWARD dispatcher  but filters listen by default on REQUEST dispatcher only  To fix this  you d need to either put the PrimeFaces file upload filter before the forwarding filter  or to reconfigure the PrimeFaces file upload filter to listen on FORWARD dispatcher too     lt filter-mapping gt        lt filter-name gt primeFacesFileUploadFilter lt  filter-name gt        lt servlet-name gt facesServlet lt  servlet-name gt        lt dispatcher gt REQUEST lt  dispatcher gt        lt dispatcher gt FORWARD lt  dispatcher gt    lt  filter-mapping gt    There s a nested  lt h form gt   This is illegal in HTML and the browser behavior is unspecified  More than often  the browser won t send the expected data on submit  Make sure that you are not nesting  lt h form gt   This is completely regardless of the form s enctype  Just do not nest forms at all    If you re still having problems  well  debug the HTTP traffic  Open the webbrowser s developer toolset  press F12 in Chrome Firebug23  IE9   and check the Net Network section  If the HTTP part looks fine  then debug the JSF code  Put a breakpoint on FileUploadRenderer decode   and advance from there   Saving uploaded file After you finally got it to work  your next question shall probably be like  quot How where do I save the uploaded file  quot   Well  continue here  How to save uploaded file in JSF

User · Answer

With JBoss 7 2 Undertow  and PrimeFaces 6 0 org primefaces webapp filter FileUploadFilter should be removed from web xml and context param file uploader should be set to native    lt context-param gt       lt param-name gt primefaces UPLOADER lt  param-name gt       lt param-value gt native lt  param-value gt   lt  context-param gt

User · Answer

For people using Tomee or Tomcat and can t get it working  try to create context xml in META-INF and add allowCasualMultipartParsing  true    lt  xml version  1 0  encoding  UTF-8   gt   lt Context allowCasualMultipartParsing  true  gt     lt  -- empty or not depending your project -- gt   lt  Context gt

User · Answer

bean xhtml       lt h form enctype  multipart form-data  gt       lt p outputLabel value  Choose your file  for  submissionFile    gt                   lt p fileUpload id  submissionFile                      value    bean file                       fileUploadListener    bean uploadFile   mode  advanced                      auto  true  dragDropSupport  false  update  messages                      sizeLimit  100000  fileLimit  1  allowTypes           pdf       gt    lt  h form gt    Bean java   ManagedBean    ViewScoped public class Submission implements Serializable    private UploadedFile file     Gets   Sets  public void uploadFasta FileUploadEvent event  throws FileNotFoundException  IOException  InterruptedException        String content   IOUtils toString event getFile   getInputstream     UTF-8         String filePath   PATH    resources submissions     nameOfMyFile     pdf        MyFileWriter writeFile filePath  content        FacesMessage message   new FacesMessage FacesMessage SEVERITY INFO              event getFile   getFileName       is uploaded    null       FacesContext getCurrentInstance   addMessage null  message           web xml       lt servlet-mapping gt       lt servlet-name gt Faces Servlet lt  servlet-name gt       lt url-pattern gt   xhtml lt  url-pattern gt   lt  servlet-mapping gt   lt filter gt       lt filter-name gt PrimeFaces FileUpload Filter lt  filter-name gt       lt filter-class gt org primefaces webapp filter FileUploadFilter lt  filter-class gt   lt  filter gt   lt filter-mapping gt       lt filter-name gt PrimeFaces FileUpload Filter lt  filter-name gt       lt servlet-name gt Faces Servlet lt  servlet-name gt   lt  filter-mapping gt

User · Answer

I had the same issue  due to the fact that I had all the configuration that describe in this post  but in my case was because I had two jquery imports  one of them was primefaces s query  which caused conflicts to upload files   See Primefaces Jquery conflict

User · Answer

You are using prettyfaces too  Then set dispatcher to FORWARD    lt filter-mapping gt      lt filter-name gt PrimeFaces FileUpload Filter lt  filter-name gt      lt servlet-name gt Faces Servlet lt  servlet-name gt      lt dispatcher gt FORWARD lt  dispatcher gt   lt  filter-mapping gt

User · Answer

One point I noticed with Primefaces 3 4 and Netbeans 7 2   Remove the Netbeans auto-filled parameters for function handleFileUpload i e   event  otherwise event could be null    lt h form gt       lt p fileUpload fileUploadListener    fileUploadController handleFileUpload event            mode  advanced           update  messages          sizeLimit  100000           allowTypes           gif jpe g png      gt        lt p growl id  messages  showDetail  true   gt   lt  h form gt

User · Answer

I had same issue with primefaces 5 3 and I went through all the points described by BalusC with no result  I followed his advice of debugging FileUploadRenderer decode   and I discovered that my web xml was unproperly set   lt context-param gt     lt param-name gt primefaces UPLOADER lt  param-name gt     lt param-value gt auto native commons lt  param-value gt   lt  context-param gt    The param-value must be 1 of these 3 values but not all of them   The whole context-param section can be removed and the default will be auto

User · Answer

Neither of the suggestions here were helpful for me  So I had to debug primefaces and found the reason of the problem was   java lang IllegalStateException  No multipart config for servlet fileUpload   Then I have added  section into my faces servlet in the web xml  So that has fixed the problem     lt servlet gt       lt servlet-name gt main lt  servlet-name gt            lt servlet-class gt org apache myfaces webapp MyFacesServlet lt  servlet-class gt           lt load-on-startup gt 1 lt  load-on-startup gt           lt multipart-config gt               lt location gt  tmp lt  location gt               lt max-file-size gt 20848820 lt  max-file-size gt               lt max-request-size gt 418018841 lt  max-request-size gt               lt file-size-threshold gt 1048576 lt  file-size-threshold gt           lt  multipart-config gt       lt  servlet gt

[jsf] How to use PrimeFaces p:fileUpload? Listener method is never invoked or UploadedFile is null / throws an error / not usable

Examples related to jsf

Examples related to file-upload

Examples related to jsf-2

Examples related to primefaces