Package org.xwiki.wysiwyg.converter

Interface RequestParameterConverter

  • @Role
@Unstable
public interface RequestParameterConverter
    Check if the given request contains parameters that needs conversion and perform the needing conversion.
    Since:
    13.5RC1
    Version:
    $Id: 57e2f12ac6906b5e76f9c2109f099a6bd57424e5 $

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Optional<javax.servlet.ServletRequest> convert​(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)
      Check if the given request needs conversion and perform those conversions.

    • Method Detail

      • convert

        Optional<javax.servlet.ServletRequest> convert​(javax.servlet.ServletRequest request,
                                               javax.servlet.ServletResponse response)
                                        throws IOException
        Check if the given request needs conversion and perform those conversions. This method is supposed to create a mutable request and to modify and returns that one. However in case of error it won't return the modified request, but it will handle directly the errors in the response.
        Parameters:
        request - the request that might contain parameter needing conversion
        response - the response used to redirect or do changes in case of conversion error
        Returns:
        a mutable request with the converted parameters, or an empty optional in case of error
        Throws:
        IOException - in case of problem to write an answer in the response