/*
 * Copyright 2002-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.remoting.jaxws;

import java.io.IOException;
import java.net.URL;
import java.util.concurrent.Executor;

import javax.xml.namespace.QName;
import javax.xml.ws.Service;
import javax.xml.ws.WebServiceFeature;
import javax.xml.ws.handler.HandlerResolver;

import org.springframework.core.io.Resource;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;

Factory for locally defined JAX-WS Service references. Uses the JAX-WS Service.create factory API underneath.

Serves as base class for LocalJaxWsServiceFactoryBean as well as JaxWsPortClientInterceptor and JaxWsPortProxyFactoryBean.

Author:Juergen Hoeller
See Also:
Since:2.5
/** * Factory for locally defined JAX-WS {@link javax.xml.ws.Service} references. * Uses the JAX-WS {@link javax.xml.ws.Service#create} factory API underneath. * * <p>Serves as base class for {@link LocalJaxWsServiceFactoryBean} as well as * {@link JaxWsPortClientInterceptor} and {@link JaxWsPortProxyFactoryBean}. * * @author Juergen Hoeller * @since 2.5 * @see javax.xml.ws.Service * @see LocalJaxWsServiceFactoryBean * @see JaxWsPortClientInterceptor * @see JaxWsPortProxyFactoryBean */
public class LocalJaxWsServiceFactory { @Nullable private URL wsdlDocumentUrl; @Nullable private String namespaceUri; @Nullable private String serviceName; @Nullable private WebServiceFeature[] serviceFeatures; @Nullable private Executor executor; @Nullable private HandlerResolver handlerResolver;
Set the URL of the WSDL document that describes the service.
See Also:
  • setWsdlDocumentResource(Resource)
/** * Set the URL of the WSDL document that describes the service. * @see #setWsdlDocumentResource(Resource) */
public void setWsdlDocumentUrl(@Nullable URL wsdlDocumentUrl) { this.wsdlDocumentUrl = wsdlDocumentUrl; }
Set the WSDL document URL as a Resource.
Since:3.2
/** * Set the WSDL document URL as a {@link Resource}. * @since 3.2 */
public void setWsdlDocumentResource(Resource wsdlDocumentResource) throws IOException { Assert.notNull(wsdlDocumentResource, "WSDL Resource must not be null"); this.wsdlDocumentUrl = wsdlDocumentResource.getURL(); }
Return the URL of the WSDL document that describes the service.
/** * Return the URL of the WSDL document that describes the service. */
@Nullable public URL getWsdlDocumentUrl() { return this.wsdlDocumentUrl; }
Set the namespace URI of the service. Corresponds to the WSDL "targetNamespace".
/** * Set the namespace URI of the service. * Corresponds to the WSDL "targetNamespace". */
public void setNamespaceUri(@Nullable String namespaceUri) { this.namespaceUri = (namespaceUri != null ? namespaceUri.trim() : null); }
Return the namespace URI of the service.
/** * Return the namespace URI of the service. */
@Nullable public String getNamespaceUri() { return this.namespaceUri; }
Set the name of the service to look up. Corresponds to the "wsdl:service" name.
/** * Set the name of the service to look up. * Corresponds to the "wsdl:service" name. */
public void setServiceName(@Nullable String serviceName) { this.serviceName = serviceName; }
Return the name of the service.
/** * Return the name of the service. */
@Nullable public String getServiceName() { return this.serviceName; }
Specify WebServiceFeature objects (e.g. as inner bean definitions) to apply to JAX-WS service creation.
See Also:
Since:4.0
/** * Specify WebServiceFeature objects (e.g. as inner bean definitions) * to apply to JAX-WS service creation. * @since 4.0 * @see Service#create(QName, WebServiceFeature...) */
public void setServiceFeatures(WebServiceFeature... serviceFeatures) { this.serviceFeatures = serviceFeatures; }
Set the JDK concurrent executor to use for asynchronous executions that require callbacks.
See Also:
  • setExecutor.setExecutor
/** * Set the JDK concurrent executor to use for asynchronous executions * that require callbacks. * @see javax.xml.ws.Service#setExecutor */
public void setExecutor(Executor executor) { this.executor = executor; }
Set the JAX-WS HandlerResolver to use for all proxies and dispatchers created through this factory.
See Also:
  • setHandlerResolver.setHandlerResolver
/** * Set the JAX-WS HandlerResolver to use for all proxies and dispatchers * created through this factory. * @see javax.xml.ws.Service#setHandlerResolver */
public void setHandlerResolver(HandlerResolver handlerResolver) { this.handlerResolver = handlerResolver; }
Create a JAX-WS Service according to the parameters of this factory.
See Also:
/** * Create a JAX-WS Service according to the parameters of this factory. * @see #setServiceName * @see #setWsdlDocumentUrl */
public Service createJaxWsService() { Assert.notNull(this.serviceName, "No service name specified"); Service service; if (this.serviceFeatures != null) { service = (this.wsdlDocumentUrl != null ? Service.create(this.wsdlDocumentUrl, getQName(this.serviceName), this.serviceFeatures) : Service.create(getQName(this.serviceName), this.serviceFeatures)); } else { service = (this.wsdlDocumentUrl != null ? Service.create(this.wsdlDocumentUrl, getQName(this.serviceName)) : Service.create(getQName(this.serviceName))); } if (this.executor != null) { service.setExecutor(this.executor); } if (this.handlerResolver != null) { service.setHandlerResolver(this.handlerResolver); } return service; }
Return a QName for the given name, relative to the namespace URI of this factory, if given.
See Also:
  • setNamespaceUri
/** * Return a QName for the given name, relative to the namespace URI * of this factory, if given. * @see #setNamespaceUri */
protected QName getQName(String name) { return (getNamespaceUri() != null ? new QName(getNamespaceUri(), name) : new QName(name)); } }