WebServiceTemplate with Basic Auth using HttpComponentsMessa



我正在尝试测试一个Spring Web Service,该服务目前在下面使用基本身份验证进行保护。对于这些测试,我使用Spring的WebServiceTemplate类编写了一个Web服务客户端。

当我用org.apache.commons.httpclient.UsernamePasswordCredentials创建模板的MessageSender作为org.springframework.ws.transport.http.CommonsHttpMessageSender对象bean时,我的Web服务客户端调用Web服务工作正常,尽管客户端工作,但代码有一个警告,强调说CommonsHttpMessageSender类现在已被弃用,我应该使用HttpComponentsMessageSender

我已经尝试重新配置客户端的WebServiceTemplate以使用较新的HttpComponentsMessageSender类工作,但我无法将基本认证部分正确配置。对于新的HttpComponentsMessageSender类,我使用org.apache.http.auth.UsernamePasswordCredentials类创建了凭据,但是,当我调用Web服务时,凭据似乎无法与请求一起使用?是否有一个WebServiceTemplate客户端的工作示例,在任何地方使用这些较新的类来验证请求等?

我的工作代码中使用的旧弃用类的jar: commons-httpclient-3.1, spring-ws-core-2.2.0.RELEASE .

我的非工作代码与新类使用的jar: httpclient-4.3.4, httpcore-4.3.2, spring-ws-core-2.2.0.RELEASE .

测试代表非工作代码的配置:

package com.company.service.a.ws.test.config;
import java.io.IOException;
import org.apache.http.HttpException;
import org.apache.http.HttpRequest;
import org.apache.http.HttpRequestInterceptor;
import org.apache.http.auth.AuthScope;
import org.apache.http.auth.UsernamePasswordCredentials;
import org.apache.http.client.CredentialsProvider;
import org.apache.http.client.HttpClient;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.impl.client.BasicCredentialsProvider;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.protocol.HTTP;
import org.apache.http.protocol.HttpContext;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.DependsOn;
import org.springframework.context.annotation.PropertySource;
import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
import org.springframework.oxm.jaxb.Jaxb2Marshaller;
import org.springframework.ws.client.core.WebServiceTemplate;
import org.springframework.ws.soap.saaj.SaajSoapMessageFactory;
import org.springframework.ws.transport.http.HttpComponentsMessageSender;
@PropertySource("classpath:/${environment}-use-case-data.properties")
@ComponentScan(basePackages = "com.company.service.a.ws.test")
@Configuration
public class TestConfig {
    @Value("${ws.url}")
    private String wsUrl;
    @Value("${ws.username}")
    private String username;
    @Value("${ws.password}")
    private String password;
    private static final Logger logger = LogManager.getLogger();
    @Bean
    public SaajSoapMessageFactory messageFactory() {
        return new SaajSoapMessageFactory();
    }
    @Bean
    public Jaxb2Marshaller marshaller() {
        Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
        marshaller.setContextPath("com.company.service.a.ws.model.data");
        return marshaller;
    }
    @Bean RequestConfig requestConfig() {
        RequestConfig requestConfig = RequestConfig.custom()
                .setAuthenticationEnabled(true)
                .build();
        return requestConfig;
    }
    @Bean
    @DependsOn( value = "propertyConfigurer" )
    public UsernamePasswordCredentials credentials() {
        logger.debug("creating credentials for username: {} passowrd={}", 
                username, password);
        UsernamePasswordCredentials credentials = new UsernamePasswordCredentials(
                username, password);
        return credentials;
    }
    @Bean 
    public CredentialsProvider credentialsProvider() {
        CredentialsProvider credentialsProvider = new BasicCredentialsProvider();
        credentialsProvider.setCredentials(AuthScope.ANY, credentials());
        return credentialsProvider;
    }
    private static class ContentLengthHeaderRemover implements HttpRequestInterceptor{
        @Override
        public void process(HttpRequest request, HttpContext context) 
                throws HttpException, IOException {
            // fighting org.apache.http.protocol.RequestContent's 
            // ProtocolException("Content-Length header already present");
            request.removeHeaders(HTTP.CONTENT_LEN);
        }
    }
    @Bean
    public HttpComponentsMessageSender messageSender() {
        RequestConfig requestConfig = RequestConfig.custom()
                .setAuthenticationEnabled(true)
                .build();
        HttpClientBuilder httpClientBuilder = HttpClients.custom();
        HttpClient httpClient = httpClientBuilder
                .addInterceptorFirst(new ContentLengthHeaderRemover())
                .setDefaultRequestConfig(requestConfig)
                .setDefaultCredentialsProvider(credentialsProvider())               
                .build();
        HttpComponentsMessageSender messageSender = new HttpComponentsMessageSender(httpClient);
        return messageSender;
    }
    @Bean( name = "propertyConfigurer" )
    public static PropertySourcesPlaceholderConfigurer propertyConfigurer() {
        PropertySourcesPlaceholderConfigurer configurer = 
                new PropertySourcesPlaceholderConfigurer();
        return configurer;
    }
    @Bean
    public WebServiceTemplate webServiceTemplate() {
        logger.debug("creating webServiceTemplate to url: {}", wsUrl);
        WebServiceTemplate webServiceTemplate = new WebServiceTemplate(messageFactory());
        webServiceTemplate.setDefaultUri(wsUrl);
        webServiceTemplate.setMarshaller(marshaller());
        webServiceTemplate.setUnmarshaller(marshaller());
        webServiceTemplate.setMessageSender(messageSender());
        return webServiceTemplate;
    }
}

提前感谢,点

使用HttpComponentsMessageSenderUsernamePasswordCredentials。注意,必须将HttpComponentsMessageSender创建为Spring bean,或者必须手动调用afterPropertiesSet才能正确设置http客户端。

@Configuration
public class WsClientConfiguration {

    @Bean
    public ESignatureProcessorClient eSignatureProcessorClient() {
        ESignatureProcessorClient client = new ESignatureProcessorClient();
        client.setWebServiceTemplate(mwWebServiceTemplate());
        return client;
    }
    @Bean
    public WebServiceTemplate mwWebServiceTemplate() {
        Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
        marshaller.setContextPath("cz.csas.services.esignatureprocessor.v02_02");
        WebServiceTemplate template = new WebServiceTemplate(marshaller, marshaller);
        template.setDefaultUri("https://osb-st2.vs.csin.cz:5001/CSMW/WS_MW_ESignatureProcessor_v02_02");
        template.setMessageSender(defaultMwMessageSender());
        return template;
    }
    @Bean
    public HttpComponentsMessageSender defaultMwMessageSender() {
        HttpComponentsMessageSender messageSender = new HttpComponentsMessageSender();
        messageSender.setCredentials(new UsernamePasswordCredentials("user", "password"));
        return messageSender;
    }
}

这是我们使用org.apache.httpcomponents的项目的练习:httpclient-4.5.3, httpcore-4.4.6

我们创建拦截头RequestDefaultHeaders reqHeader = new RequestDefaultHeaders(headers),然后在构建CloseableHttpClient时使用.addInterceptorLast(reqHeader)添加到httpClient

配置类:

import org.apache.http.message.BasicHeader;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.Header;
import org.apache.http.client.protocol.RequestDefaultHeaders;

@Bean
HttpClient createHttpClient() {
    List<Header> headers = new ArrayList<>();
    BasicHeader authHeader = new BasicHeader("Authorization", "Basic " + base64authUserPassword());
    headers.add(authHeader);
    // add more header as more as needed
    RequestDefaultHeaders reqHeader = new RequestDefaultHeaders(headers);
    CloseableHttpClient httpClient = 
        HttpClients.custom()
            .addInterceptorFirst(new HttpComponentsMessageSender.RemoveSoapHeadersInterceptor())
            .addInterceptorLast(reqHeader)
            .build();
    return httpClient;
}
@Bean
public HttpComponentsMessageSender defaultMyMessageSender() 
        throws KeyManagementException, NoSuchAlgorithmException, KeyStoreException {
    HttpComponentsMessageSender messageSender = new HttpComponentsMessageSender(createHttpClient());
    //messageSender.setCredentials(credentials());
    return messageSender;
}
@Bean
WebServiceTemplate webServiceTemplate() throws KeyManagementException, NoSuchAlgorithmException, KeyStoreException{
    WebServiceTemplate wsTemplate = new WebServiceTemplate();
    wsTemplate.setDefaultUri(endpointURI);
    wsTemplate.setMessageSender(defaultMyMessageSender());
    return wsTemplate;
}

我使用的一个解决方案是创建一个带有自定义CredentialsProvider的自定义WebServiceMessageSender。该解决方案还设置了一个路由规划器,该路由规划器尊重默认的java代理设置。

@Configuration
public class WebServiceConfiguration {
    @Bean
    public WebServiceMessageSender webServiceMessageSender(@Value("${endpoint.uri}") endpointUri, 
                                                           @Value("${endpoint.username}") String username, 
                                                           @Value("${endpoint.password}") String password) throws Exception {
        SystemDefaultRoutePlanner routePlanner = new SystemDefaultRoutePlanner(
            ProxySelector.getDefault());
        BasicCredentialsProvider credentialsProvider = new BasicCredentialsProvider();
        credentialsProvider.setCredentials(new AuthScope(endpointUri.getHost(), endpointUri.getPort(), ANY_REALM, ANY_SCHEME), new UsernamePasswordCredentials(username, password););
        CloseableHttpClient httpclient = HttpClients.custom()
            .setRoutePlanner(routePlanner)
            .addInterceptorFirst(new HttpComponentsMessageSender.RemoveSoapHeadersInterceptor())
            .setDefaultCredentialsProvider(credentialsProvider)
            .build();
        return new HttpComponentsMessageSender(httpclient);
    }
}

最后,使用当前的httpclient-4.3.+, httpcore-4.3.+类,使基本身份验证与spring-ws-xxx.2.2.0.RELEASE中的Spring WebServiceTemplate一起工作,我在HttpClient中添加了一个抢占式身份验证拦截器(正如@Oliv在Apache HttpClient 4的抢占式基本身份验证中所建议的那样)。请注意,正如@Oliv指出的那样,该解决方案为所有请求添加了身份验证。

我仍然不确定这是否是配置Spring WebServiceTemplate的最佳方法,但这是我发现(到目前为止)在没有直接访问HttpClientHttpClientContext对象的情况下启用抢占式身份验证的唯一方法。我非常欢迎任何更简单更好的答案。

截取程序代码:

private static class PreemptiveAuthInterceptor implements HttpRequestInterceptor {
    public void process(final HttpRequest request, final HttpContext context) 
            throws HttpException, IOException {
        AuthState authState = (AuthState) context.getAttribute(
                HttpClientContext.TARGET_AUTH_STATE);
        // If no auth scheme is avaialble yet, initialize it preemptively
        if ( authState.getAuthScheme() == null ) {
            CredentialsProvider credsProvider = (CredentialsProvider) context.getAttribute(
                    HttpClientContext.CREDS_PROVIDER);
            HttpHost targetHost = (HttpHost) context.getAttribute(
                    HttpCoreContext.HTTP_TARGET_HOST);
            Credentials creds = credsProvider.getCredentials(
                    new AuthScope(targetHost.getHostName(), targetHost.getPort()));
            if ( creds == null ) {
                throw new HttpException("no credentials available for preemptive "
                        + "authentication");
            }
            authState.update(new BasicScheme(), creds);
        }
    }
}

线程是旧的,但要总结。

根据spring文档:

UsernamePasswordCredentials和HttpComponentsMessageSender应该是spring bean。所以定义bean并注入它们。这应该能解决问题。

最新更新