Package net.sf.jasperreports.dataadapters.http

Class HttpDataService

java.lang.Object
net.sf.jasperreports.dataadapters.http.HttpDataService
All Implemented Interfaces:
DataFileService
public class HttpDataService extends Object implements DataFileService
Author:
Lucian Chirita (lucianc@users.sourceforge.net)

  • Field Details

    • HTTP_DATA_SERVICE_NAME

      public static final String HTTP_DATA_SERVICE_NAME
      See Also:

    • EXCEPTION_MESSAGE_KEY_NO_HTTP_URL_SET

      public static final String EXCEPTION_MESSAGE_KEY_NO_HTTP_URL_SET
      See Also:

    • EXCEPTION_MESSAGE_KEY_UNKNOWN_REQUEST_METHOD

      public static final String EXCEPTION_MESSAGE_KEY_UNKNOWN_REQUEST_METHOD
      See Also:

    • PARAMETER_URL

      public static final String PARAMETER_URL
      Deprecated.
      Replaced by PROPERTY_URL.
      See Also:

    • PARAMETER_USERNAME

      public static final String PARAMETER_USERNAME
      Deprecated.
      Replaced by PROPERTY_USERNAME.
      See Also:

    • PARAMETER_PASSWORD

      public static final String PARAMETER_PASSWORD
      Deprecated.
      Replaced by PROPERTY_PASSWORD.
      See Also:

    • PARAMETER_PREFIX_URL_PARAMETER

      public static final String PARAMETER_PREFIX_URL_PARAMETER
      Deprecated.
      Replaced by PROPERTY_URL_PARAMETER.
      See Also:

    • PARAMETER_PREFIX_POST_PARAMETER

      public static final String PARAMETER_PREFIX_POST_PARAMETER
      Deprecated.
      Replaced by PROPERTY_POST_PARAMETER.
      See Also:

    • PROPERTY_METHOD

      public static final String PROPERTY_METHOD
      Property that specifies the HTTP request method to be used by the HTTP data adapters. When used at parameter level, it does not need to provide a value, but is just used to mark the parameter that will provide the HTTP method.
      See Also:

    • PROPERTY_URL

      public static final String PROPERTY_URL
      Property that specifies the base URL to be used by the HTTP data adapters. When used at parameter level, it does not need to provide a value, but is just used to mark the parameter that will provide the URL value.
      See Also:

    • PROPERTY_USERNAME

      public static final String PROPERTY_USERNAME
      Property that specifies the user name to be used by the HTTP data adapters with basic authentication. When used at parameter level, it does not need to provide a value, but is just used to mark the parameter that will provide the user name value.
      See Also:

    • PROPERTY_PASSWORD

      public static final String PROPERTY_PASSWORD
      Property that specifies the password to be used by the HTTP data adapters with basic authentication. When used at parameter level, it does not need to provide a value, but is just used to mark the parameter that will provide the user password value.
      See Also:

    • PROPERTY_URL_PARAMETER

      public static final String PROPERTY_URL_PARAMETER
      Property that specifies the name of the request parameter to be added to the URL when HTTP data adapter is used. If the property is present, but has no value, the name of the request parameter is the same as the report parameter name.
      See Also:

    • PROPERTY_BODY

      public static final String PROPERTY_BODY
      Property that specifies the POST/PUT request body to be sent when HTTP data adapter is used. When used at parameter level, it does not need to provide a value, but is just used to mark the parameter that will provide the POST/PUT request body value.
      See Also:

    • PROPERTY_POST_PARAMETER

      public static final String PROPERTY_POST_PARAMETER
      Property that specifies the name of the request POST parameter to be sent when HTTP data adapter is used. If the property is present, but has no value, the name of the request parameter is the same as the report parameter name.
      See Also:

    • PROPERTY_HEADER

      public static final String PROPERTY_HEADER
      Property that specifies the name of the request header to be sent when HTTP data adapter is used. If the property is present, but has no value, the name of the request header is the same as the report parameter name.
      See Also:

  • Constructor Details

  • Method Details

    • getDataFileConnection

      public DataFileConnection getDataFileConnection(Map<String,Object> parameters) throws JRException
      Specified by:
      getDataFileConnection in interface DataFileService
      Throws:
      JRException

    • createHttpClient

      protected org.apache.http.impl.client.CloseableHttpClient createHttpClient(Map<String,Object> parameters)

    • setAuthentication

      protected void setAuthentication(Map<String,Object> parameters, org.apache.http.impl.client.HttpClientBuilder clientBuilder)

    • getUsername

      protected String getUsername(Map<String,Object> parameters)

    • getPassword

      protected String getPassword(Map<String,Object> parameters)

    • createRequest

      protected org.apache.http.client.methods.HttpRequestBase createRequest(Map<String,Object> parameters)

    • createGetRequest

      protected org.apache.http.client.methods.HttpGet createGetRequest(URI requestURI)

    • createPostRequest

      protected org.apache.http.client.methods.HttpPost createPostRequest(URI requestURI, String body)

    • createPostRequest

      protected org.apache.http.client.methods.HttpPost createPostRequest(URI requestURI, List<org.apache.http.NameValuePair> postParameters)

    • createPutRequest

      protected org.apache.http.client.methods.HttpPut createPutRequest(URI requestURI, String body)

    • createPutRequest

      protected org.apache.http.client.methods.HttpPut createPutRequest(URI requestURI, List<org.apache.http.NameValuePair> postParameters)

    • createRequestEntity

      protected org.apache.http.HttpEntity createRequestEntity(String body)

    • createRequestEntity

      protected org.apache.http.HttpEntity createRequestEntity(List<org.apache.http.NameValuePair> postParameters)

    • collectUrlParameters

      protected List<org.apache.http.NameValuePair> collectUrlParameters(Map<String,Object> reportParameters)

    • collectPostParameters

      protected List<org.apache.http.NameValuePair> collectPostParameters(Map<String,Object> reportParameters)

    • collectHeaders

      protected List<org.apache.http.NameValuePair> collectHeaders(Map<String,Object> reportParameters)

    • collectParameters

      protected List<org.apache.http.NameValuePair> collectParameters(List<HttpLocationParameter> dataAdapterParameters, Map<String,Object> parameterValues, String propertyName, String parameterPrefix)

    • getRequestURI

      protected URI getRequestURI(Map<String,Object> parameters)

    • getURL

      protected String getURL(Map<String,Object> parameters)

    • getMethod

      protected RequestMethod getMethod(Map<String,Object> parameters)

    • getBody

      protected String getBody(Map<String,Object> parameters)

    • getPropertyOrParameterValue

      protected String getPropertyOrParameterValue(String propName, String paramName, Map<String,Object> parameterValues)

    • toHttpParameterValue

      protected String toHttpParameterValue(Object value)