Spring Web Services Framework

org.springframework.ws.wsdl.wsdl11
Class ProviderBasedWsdl4jDefinition

java.lang.Object
  extended by org.springframework.ws.wsdl.wsdl11.Wsdl4jDefinition
      extended by org.springframework.ws.wsdl.wsdl11.ProviderBasedWsdl4jDefinition
All Implemented Interfaces:
InitializingBean, Wsdl11Definition, WsdlDefinition

public class ProviderBasedWsdl4jDefinition
extends Wsdl4jDefinition
implements InitializingBean

Implementation of the Wsdl11Definition that uses a provider-based mechanism to populate a WSDL4J Definition.

All providers are optional, indicating that a particular part of the WSDL will not be created. Providers can be set via various properties. The providers are invoked in the following order:

  1. ImportsProvider
  2. TypesProvider
  3. MessagesProvider
  4. PortTypesProvider
  5. BindingsProvider
  6. ServicesProvider

This definition requires the target namespace to be set via setTargetNamespace(String)

Since:
1.5.0
Author:
Arjen Poutsma
See Also:
setImportsProvider(ImportsProvider), setTypesProvider(TypesProvider), setMessagesProvider(MessagesProvider), setPortTypesProvider(PortTypesProvider), setBindingsProvider(BindingsProvider), setServicesProvider(ServicesProvider)

Field Summary
static String TARGET_NAMESPACE_PREFIX
          The prefix used to register the target namespace in the WSDL.
 
Constructor Summary
ProviderBasedWsdl4jDefinition()
           
 
Method Summary
 void afterPropertiesSet()
           
 BindingsProvider getBindingsProvider()
          Returns the BindingsProvider for this definition.
 ImportsProvider getImportsProvider()
          Returns the ImportsProvider for this definition.
 MessagesProvider getMessagesProvider()
          Returns the MessagesProvider for this definition.
 PortTypesProvider getPortTypesProvider()
          Returns the PortTypesProvider for this definition.
 ServicesProvider getServicesProvider()
          Returns the ServicesProvider for this definition.
 String getTargetNamespace()
          Returns the target namespace for the WSDL definition.
 TypesProvider getTypesProvider()
          Returns the TypesProvider for this definition.
 void setBindingsProvider(BindingsProvider bindingsProvider)
          Sets the BindingsProvider for this definition.
 void setImportsProvider(ImportsProvider importsProvider)
          Sets the ImportsProvider for this definition.
 void setMessagesProvider(MessagesProvider messagesProvider)
          Sets the MessagesProvider for this definition.
 void setPortTypesProvider(PortTypesProvider portTypesProvider)
          Sets the PortTypesProvider for this definition.
 void setServicesProvider(ServicesProvider servicesProvider)
          Sets the ServicesProvider for this definition.
 void setTargetNamespace(String targetNamespace)
          Sets the target namespace used for this definition.
 void setTypesProvider(TypesProvider typesProvider)
          Sets the TypesProvider for this definition.
 
Methods inherited from class org.springframework.ws.wsdl.wsdl11.Wsdl4jDefinition
getDefinition, getSource, setDefinition, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TARGET_NAMESPACE_PREFIX

public static final String TARGET_NAMESPACE_PREFIX
The prefix used to register the target namespace in the WSDL.

See Also:
Constant Field Values
Constructor Detail

ProviderBasedWsdl4jDefinition

public ProviderBasedWsdl4jDefinition()
Method Detail

getImportsProvider

public ImportsProvider getImportsProvider()
Returns the ImportsProvider for this definition.

Default is null, indicating that no <import> will be created

Returns:
the import provider; or null

setImportsProvider

public void setImportsProvider(ImportsProvider importsProvider)
Sets the ImportsProvider for this definition.

Default is null, indicating that no <import> will be created

Parameters:
importsProvider - the import provider

getTypesProvider

public TypesProvider getTypesProvider()
Returns the TypesProvider for this definition.

Defaults to null, indicating that no <types> will be created

Returns:
the types provider; or null

setTypesProvider

public void setTypesProvider(TypesProvider typesProvider)
Sets the TypesProvider for this definition.

Defaults to null, indicating that no <types> will be created

Parameters:
typesProvider - the types provider; or null

getMessagesProvider

public MessagesProvider getMessagesProvider()
Returns the MessagesProvider for this definition.

Defaults to null, indicating that no <message> will be created

Returns:
the messages provider; or null

setMessagesProvider

public void setMessagesProvider(MessagesProvider messagesProvider)
Sets the MessagesProvider for this definition.

Defaults to null, indicating that no <message> will be created

Parameters:
messagesProvider - the messages provider; or null

getPortTypesProvider

public PortTypesProvider getPortTypesProvider()
Returns the PortTypesProvider for this definition.

Defaults to null, indicating that no <portType> will be created

Returns:
the port types provider; or null

setPortTypesProvider

public void setPortTypesProvider(PortTypesProvider portTypesProvider)
Sets the PortTypesProvider for this definition.

Defaults to null, indicating that no <portType> will be created

Parameters:
portTypesProvider - the port types provider; or null

getBindingsProvider

public BindingsProvider getBindingsProvider()
Returns the BindingsProvider for this definition.

Defaults to null, indicating that no <binding> will be created

Returns:
the binding provider; or null

setBindingsProvider

public void setBindingsProvider(BindingsProvider bindingsProvider)
Sets the BindingsProvider for this definition.

Defaults to null, indicating that no <binding> will be created

Parameters:
bindingsProvider - the bindings provider; or null

getServicesProvider

public ServicesProvider getServicesProvider()
Returns the ServicesProvider for this definition.

Defaults to null, indicating that no <service> will be created

Returns:
the services provider; or null

setServicesProvider

public void setServicesProvider(ServicesProvider servicesProvider)
Sets the ServicesProvider for this definition.

Defaults to null, indicating that no <service> will be created

Parameters:
servicesProvider - the services provider; or null

getTargetNamespace

public String getTargetNamespace()
Returns the target namespace for the WSDL definition.

Returns:
the target namespace
See Also:
Definition.getTargetNamespace()

setTargetNamespace

public void setTargetNamespace(String targetNamespace)
Sets the target namespace used for this definition. Required.

Parameters:
targetNamespace - the target namespace
See Also:
Definition.setTargetNamespace(String)

afterPropertiesSet

public void afterPropertiesSet()
                        throws WSDLException
Specified by:
afterPropertiesSet in interface InitializingBean
Throws:
WSDLException

Spring Web Services Framework

Copyright © 2005-2010 The Spring Web Services Framework. All Rights Reserved.