net.sf.jasperreports.data.http.HttpDataService Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2014 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see parameters) throws JRException
{
CloseableHttpClient httpClient = createHttpClient(parameters);
HttpRequestBase request = createRequest(parameters);
return new HttpDataConnection(httpClient, request);
}
protected CloseableHttpClient createHttpClient(Map parameters)
{
HttpClientBuilder clientBuilder = HttpClients.custom();
// single connection
BasicHttpClientConnectionManager connManager = new BasicHttpClientConnectionManager();
clientBuilder.setConnectionManager(connManager);
// ignore cookies for now
RequestConfig requestConfig = RequestConfig.custom().setCookieSpec(CookieSpecs.IGNORE_COOKIES).build();
clientBuilder.setDefaultRequestConfig(requestConfig);
HttpClientContext clientContext = HttpClientContext.create();
setAuthentication(parameters, clientContext);
CloseableHttpClient client = clientBuilder.build();
return client;
}
protected void setAuthentication(Map parameters, HttpClientContext clientContext)
{
String username = getUsername(parameters);
if (username != null)
{
String password = getPassword(parameters);
BasicCredentialsProvider credentialsProvider = new BasicCredentialsProvider();
//FIXME proxy authentication?
credentialsProvider.setCredentials(
new AuthScope(AuthScope.ANY_HOST, AuthScope.ANY_PORT),
new UsernamePasswordCredentials(username, password));
clientContext.setCredentialsProvider(credentialsProvider);
}
}
protected String getUsername(Map parameters)
{
String username = (String) parameters.get(PARAMETER_USERNAME);
if (username == null)
{
username = dataLocation.getUsername();
}
return username;
}
protected String getPassword(Map parameters)
{
String password = (String) parameters.get(PARAMETER_PASSWORD);
if (password == null)
{
password = dataLocation.getPassword();
}
if (password != null)
{
SecretsUtil secrets = SecretsUtil.getInstance(context);
password = secrets.getSecret(AbstractDataAdapterService.SECRETS_CATEGORY, password);
}
return password;
}
protected HttpRequestBase createRequest(Map parameters)
{
List postParameters = collectPostParameters(parameters);
URI requestURI = getRequestURI(parameters);
HttpRequestBase request;
if (postParameters.isEmpty())
{
request = createGetRequest(requestURI);
}
else
{
request = createPostRequest(requestURI, postParameters);
}
return request;
}
protected HttpGet createGetRequest(URI requestURI)
{
HttpGet httpGet = new HttpGet(requestURI);
return httpGet;
}
protected HttpPost createPostRequest(URI requestURI, List postParameters)
{
HttpPost httpPost = new HttpPost(requestURI);
try
{
UrlEncodedFormEntity formEntity = new UrlEncodedFormEntity(postParameters, "UTF-8");//allow custom?
httpPost.setEntity(formEntity);
}
catch (UnsupportedEncodingException e)
{
// should not happen
throw new JRRuntimeException(e);
}
return httpPost;
}
protected List collectPostParameters(Map parameters)
{
List postParameters = new ArrayList();
for (Entry paramEntry : parameters.entrySet())
{
String paramName = paramEntry.getKey();
Object value = paramEntry.getValue();
if (paramName.startsWith(PARAMETER_PREFIX_POST_PARAMETER) && value != null)
{
String name = paramName.substring(PARAMETER_PREFIX_POST_PARAMETER.length(), paramName.length());
String paramValue = toHttpParameterValue(value);
if (log.isDebugEnabled())
{
log.debug("adding post parameter " + name + " with value " + paramValue);
}
postParameters.add(new BasicNameValuePair(name, paramValue));
}
}
return postParameters;
}
protected URI getRequestURI(Map parameters)
{
String url = getURL(parameters);
if (url == null)
{
throw new JRRuntimeException("No HTTP URL set");
}
try
{
URIBuilder uriBuilder = new URIBuilder(url);
for (Entry paramEntry : parameters.entrySet())
{
String paramName = paramEntry.getKey();
Object value = paramEntry.getValue();
if (paramName.startsWith(PARAMETER_PREFIX_URL_PARAMETER) && value != null)
{
String name = paramName.substring(PARAMETER_PREFIX_URL_PARAMETER.length(), paramName.length());
String paramValue = toHttpParameterValue(value);
if (log.isDebugEnabled())
{
log.debug("adding URL parameter " + name + " with value " + paramValue);
}
uriBuilder.addParameter(name, paramValue);
}
}
URI uri = uriBuilder.build();
if (log.isDebugEnabled())
{
log.debug("request URI " + uri);
}
return uri;
}
catch (URISyntaxException e)
{
throw new JRRuntimeException(e);
}
}
protected String getURL(Map parameters)
{
String url = (String) parameters.get(PARAMETER_URL);
if (url == null)
{
url = dataLocation.getUrl();
}
return url;
}
protected String toHttpParameterValue(Object value)
{
return String.valueOf(value);//FIXME do something smarter than String.valueOf
}
}