com.sun.xml.rpc.processor.modeler.wsdl

Class WSDLModelerBase

java.lang.Object

com.sun.xml.rpc.processor.modeler.wsdl.WSDLModelerBase

All Implemented Interfaces:

Modeler

Direct Known Subclasses:

WSDLModeler101, WSDLModeler103, WSDLModeler11, WSDLModeler111, WSDLModeler112

public abstract class WSDLModelerBase
extends Object
implements Modeler

Author:

JAX-RPC Development Team Base class for WSDL->Model classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WSDLModelerBase.ProcessSOAPOperationInfo
static class	WSDLModelerBase.WSDLExceptionInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected Map	_faultTypeToStructureMap
protected Map	_javaExceptions
protected JavaSimpleTypeCreator	_javaTypes
protected HashSet	hSet
protected WSDLModelerBase.ProcessSOAPOperationInfo	info
static String	MESSAGE_HAS_MIME_MULTIPART_RELATED_BINDING
protected WSDLParser	parser

Constructor Summary

Constructors

Constructor and Description
WSDLModelerBase(WSDLModelInfo modelInfo, Properties options)

Method Summary

Modifier and Type	Method and Description
protected void	addParameterToStructures(MessagePart part, Parameter parameter, LiteralStructuredType literalType, JavaStructureType javaType)
Model	buildModel() Builds model from WSDL document.
protected void	checkNotWsdlElement(Element e)
protected void	checkNotWsdlRequired(Element e)
protected boolean	createJavaException(Fault fault, Port port, String operationName)
protected boolean	createJavaExceptionFromLiteralType(Fault fault, Port port, String operationName)
protected boolean	createJavaExceptionFromSOAPType(Fault fault, Port port, String operationName)
protected void	createJavaInterfaceForPort(Port port)
protected void	createParentFault(Fault fault)
protected void	createRelativeJavaExceptions(Fault fault, Port port, String operationName)
protected void	createSubfaults(Fault fault)
protected static Message	findMessage(QName messageName, WSDLModelerBase.ProcessSOAPOperationInfo info)
protected Extension	getAnyExtensionOfType(Extensible extensible, Class type)
protected Documentation	getDocumentationFor(Element e)
protected LiteralType	getElementTypeToLiteralType(QName elementType)
protected ProcessorEnvironment	getEnvironment()
protected WSDLModelerBase.WSDLExceptionInfo	getExceptionInfo(Fault fault)
protected static Extension	getExtensionOfType(Extensible extensible, Class type)
protected String	getFaultName(String faultPartName, String soapFaultName, String bindFaultName, String faultMessageName) bug fix: 4884736, this method can be overriden from subclasses of WSDLModelerBase Returns soapbinding:fault name.
protected AbstractType	getHeaderFaultSequenceType(AbstractType faultType, MessagePart faultPart, QName elemName)
protected Message	getInputMessage()
protected String	getJavaNameForOperation(Operation operation)
protected String	getJavaNameOfPort(QName portQName)
protected String	getJavaNameOfSEI(Port port)
protected String	getLiteralJavaMemberName(Fault fault)
protected List	getMessageParts(SOAPBody body, Message message, boolean isInput)
protected String	getNonQualifiedNameFor(QName name)
protected Message	getOutputMessage()
protected static QName	getQNameOf(GloballyKnown entity)
protected String	getRequestNamespaceURI(SOAPBody body)
protected String	getResponseNamespaceURI(SOAPBody body)
protected SchemaAnalyzerBase	getSchemaAnalyzer()
protected abstract SchemaAnalyzerBase	getSchemaAnalyzerInstance(WSDLDocument document, WSDLModelInfo _modelInfo, Properties _options, Set _conflictingClassNames, JavaSimpleTypeCreator _javaTypes) Gets the appropriate Schema Analyzer for the wsdl
protected String	getServiceInterfaceName(QName serviceQName, Service wsdlService)
protected SOAPBody	getSOAPRequestBody()
protected SOAPBody	getSOAPResponseBody()
protected String	getStructureNamePrefix()
protected String	getUniqueName(Operation operation, boolean hasOverloadedOperations)
protected String	getUniqueParameterName(Operation operation, String baseName)
protected void	handleLiteralSOAPFault(Response response, Set duplicateNames)
protected void	info(String key)
protected void	info(String key, String arg)
protected boolean	isBoundToMimeContent(MessagePart part)
protected boolean	isBoundToSOAPBody(MessagePart part)
protected boolean	isConflictingClassName(String name)
protected boolean	isConflictingExceptionClassName(String name)
protected boolean	isConflictingPortClassName(String name)
protected boolean	isConflictingServiceClassName(String name)
protected boolean	isConflictingStubClassName(String name)
protected boolean	isConflictingTieClassName(String name)
boolean	isEquivalentLiteralStructures(LiteralStructuredType struct1, LiteralStructuredType struct2)
boolean	isEquivalentSOAPStructures(SOAPStructureType struct1, SOAPStructureType struct2)
protected boolean	isOperationDocumentLiteral()
protected boolean	isRequestMimeMultipart()
protected boolean	isResponseMimeMultipart()
protected boolean	isSingleInOutPart(Set inputParameterNames, MessagePart outputPart) Returns true when there is single inout part and no parameterOrder defined.
protected boolean	isStyleAndPartMatch(SOAPOperation soapOperation, MessagePart part) For Document/Lit the wsdl:part should only have element attribute and for RPC/Lit or RPC/Encoded the wsdl:part should only have type attribute inside wsdl:message.
protected boolean	isUnwrappable()
protected boolean	isUnwrappable(Message inputMessage)
protected boolean	isWrapperType(LiteralType type)
protected String	makeNameUniqueInSet(String candidateName, Set names)
protected QName	makePackageQualified(QName name)
protected QName	makePackageQualified(QName name, boolean useNamespaceMapping)
protected String	makePackageQualified(String s, QName name)
protected String	makePackageQualified(String s, QName name, boolean useNamespaceMapping)
protected void	postProcessSOAPOperation(Operation operation)
protected void	processHeaderFaults(SOAPHeader header, WSDLModelerBase.ProcessSOAPOperationInfo info, Response response, Set duplicateNames)
protected List	processParameterOrder(Set inputParameterNames, Set outputParameterNames, StringBuffer resultParameterName)
protected boolean	processPort(Port wsdlPort, Service service, WSDLDocument document)
protected void	processSearchSchemaOption(WSDLDocument document, Model model) Should be called for -f:searchschema option processing.
protected void	processService(Service wsdlService, Model model, WSDLDocument document)
protected Operation	processSOAPOperation()
protected Operation	processSOAPOperationDocumentLiteralStyle()
protected Operation	processSOAPOperationRPCEncodedStyle()
protected Operation	processSOAPOperationRPCLiteralStyle()
protected void	setCurrentPort(Port port)
protected static void	setDocumentationIfPresent(ModelObject obj, Documentation documentation)
protected void	setJavaOperationNameProperty(Message inputMessage)
protected void	setSOAPUse()
protected void	setUnwrapped(LiteralStructuredType type)
protected static boolean	tokenListContains(String tokenList, String target)
protected boolean	typeHasNoWildcardElement(LiteralType type, boolean unwrappable)
protected boolean	useExplicitServiceContextForDocLit(Message inputMessage)
protected boolean	useExplicitServiceContextForRpcEncoded(Message inputMessage)
protected boolean	useExplicitServiceContextForRpcLit(Message inputMessage)
protected AbstractType	verifyParameterType(AbstractType type, String partName, Operation operation)
protected AbstractType	verifyResultType(AbstractType type, Operation operation)
protected void	warn(Localizable msg)
protected void	warn(String key)
protected void	warn(String key, Object[] args)
protected void	warn(String key, String arg)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MESSAGE_HAS_MIME_MULTIPART_RELATED_BINDING

public static final String MESSAGE_HAS_MIME_MULTIPART_RELATED_BINDING

See Also:

Constant Field Values

info

protected WSDLModelerBase.ProcessSOAPOperationInfo info

_javaExceptions

protected Map _javaExceptions

_faultTypeToStructureMap

protected Map _faultTypeToStructureMap

_javaTypes

protected JavaSimpleTypeCreator _javaTypes

parser

protected WSDLParser parser

hSet

protected HashSet hSet

Constructor Detail

WSDLModelerBase

public WSDLModelerBase(WSDLModelInfo modelInfo,
                       Properties options)

Method Detail

buildModel

public Model buildModel()

Builds model from WSDL document. Model contains abstraction which is used by the generators to generate the stub/tie/serializers etc. code.

Specified by:

buildModel in interface Modeler

Returns:

Model - the root Node of the model of the Web Service

See Also:

Modeler.buildModel()

getSchemaAnalyzerInstance

protected abstract SchemaAnalyzerBase getSchemaAnalyzerInstance(WSDLDocument document,
                                                                WSDLModelInfo _modelInfo,
                                                                Properties _options,
                                                                Set _conflictingClassNames,
                                                                JavaSimpleTypeCreator _javaTypes)

Gets the appropriate Schema Analyzer for the wsdl

Parameters:

document -

_modelInfo -

_options -

_conflictingClassNames -

_javaTypes -

Returns:

the schema analyzer

getSchemaAnalyzer

protected SchemaAnalyzerBase getSchemaAnalyzer()

processSearchSchemaOption

protected void processSearchSchemaOption(WSDLDocument document,
                                         Model model)

Should be called for -f:searchschema option processing. With this option we look for all the schema types under ...

Parameters:

document - WSDL document

model - Model which will be used by the generators to generate code.

getDocumentationFor

protected Documentation getDocumentationFor(Element e)

checkNotWsdlElement

protected void checkNotWsdlElement(Element e)

checkNotWsdlRequired

protected void checkNotWsdlRequired(Element e)

getServiceInterfaceName

protected String getServiceInterfaceName(QName serviceQName,
                                         Service wsdlService)

Parameters:

serviceQName -

wsdlService -

Returns:

The full name of the class for the wsdl service

processService

protected void processService(Service wsdlService,
                              Model model,
                              WSDLDocument document)

Parameters:

wsdlService -

model -

document -

getJavaNameOfPort

protected String getJavaNameOfPort(QName portQName)

processPort

protected boolean processPort(Port wsdlPort,
                              Service service,
                              WSDLDocument document)

Parameters:

wsdlPort -

service -

document -

Returns:

boolean

setCurrentPort

protected void setCurrentPort(Port port)

processSOAPOperation

protected Operation processSOAPOperation()

postProcessSOAPOperation

protected void postProcessSOAPOperation(Operation operation)

setJavaOperationNameProperty

protected void setJavaOperationNameProperty(Message inputMessage)

useExplicitServiceContextForRpcEncoded

protected boolean useExplicitServiceContextForRpcEncoded(Message inputMessage)

useExplicitServiceContextForRpcLit

protected boolean useExplicitServiceContextForRpcLit(Message inputMessage)

useExplicitServiceContextForDocLit

protected boolean useExplicitServiceContextForDocLit(Message inputMessage)

processSOAPOperationRPCEncodedStyle

protected Operation processSOAPOperationRPCEncodedStyle()

verifyResultType

protected AbstractType verifyResultType(AbstractType type,
                                        Operation operation)

verifyParameterType

protected AbstractType verifyParameterType(AbstractType type,
                                           String partName,
                                           Operation operation)

createParentFault

protected void createParentFault(Fault fault)

createSubfaults

protected void createSubfaults(Fault fault)

getSOAPRequestBody

protected SOAPBody getSOAPRequestBody()

isRequestMimeMultipart

protected boolean isRequestMimeMultipart()

isResponseMimeMultipart

protected boolean isResponseMimeMultipart()

getSOAPResponseBody

protected SOAPBody getSOAPResponseBody()

getOutputMessage

protected Message getOutputMessage()

getInputMessage

protected Message getInputMessage()

setSOAPUse

protected void setSOAPUse()

getMessageParts

protected List getMessageParts(SOAPBody body,
                               Message message,
                               boolean isInput)

Parameters:

body - request or response body, represents soap:body

message - Input or output message, equivalent to wsdl:message

Returns:

iterator over MessagePart

processParameterOrder

protected List processParameterOrder(Set inputParameterNames,
                                     Set outputParameterNames,
                                     StringBuffer resultParameterName)

isSingleInOutPart

protected boolean isSingleInOutPart(Set inputParameterNames,
                                    MessagePart outputPart)

Returns true when there is single inout part and no parameterOrder defined. This fixes bug: 4922107. This method should be overriden for 1.1 or previous version to 1.1.1 as this fix results in the generated method signature change.

Returns:

true if there is single inout part

isOperationDocumentLiteral

protected boolean isOperationDocumentLiteral()

isStyleAndPartMatch

protected boolean isStyleAndPartMatch(SOAPOperation soapOperation,
                                      MessagePart part)

For Document/Lit the wsdl:part should only have element attribute and for RPC/Lit or RPC/Encoded the wsdl:part should only have type attribute inside wsdl:message. Nagesh: Made the above rule applicable for only wsi compliant WSDLs.

getRequestNamespaceURI

protected String getRequestNamespaceURI(SOAPBody body)

getResponseNamespaceURI

protected String getResponseNamespaceURI(SOAPBody body)

getStructureNamePrefix

protected String getStructureNamePrefix()

processSOAPOperationRPCLiteralStyle

protected Operation processSOAPOperationRPCLiteralStyle()

isBoundToMimeContent

protected boolean isBoundToMimeContent(MessagePart part)

Parameters:

part -

Returns:

true if the message part is a wsdl mime type

isBoundToSOAPBody

protected boolean isBoundToSOAPBody(MessagePart part)

Parameters:

part -

Returns:

true if the message part is the soap body

handleLiteralSOAPFault

protected void handleLiteralSOAPFault(Response response,
                                      Set duplicateNames)

Parameters:

response -

duplicateNames -

getFaultName

protected String getFaultName(String faultPartName,
                              String soapFaultName,
                              String bindFaultName,
                              String faultMessageName)

bug fix: 4884736, this method can be overriden from subclasses of WSDLModelerBase Returns soapbinding:fault name. If null then gives warning for wsi R2721 and uses wsdl:fault name.

Parameters:

faultPartName - - to be used by versions < 1.1

soapFaultName -

bindFaultName -

faultMessageName -

Returns:

The faultMessageName if not overridden by a subclass

addParameterToStructures

protected void addParameterToStructures(MessagePart part,
                                        Parameter parameter,
                                        LiteralStructuredType literalType,
                                        JavaStructureType javaType)

isUnwrappable

protected boolean isUnwrappable(Message inputMessage)

isUnwrappable

protected boolean isUnwrappable()

isWrapperType

protected boolean isWrapperType(LiteralType type)

typeHasNoWildcardElement

protected boolean typeHasNoWildcardElement(LiteralType type,
                                           boolean unwrappable)

setUnwrapped

protected void setUnwrapped(LiteralStructuredType type)

processSOAPOperationDocumentLiteralStyle

protected Operation processSOAPOperationDocumentLiteralStyle()

processHeaderFaults

protected void processHeaderFaults(SOAPHeader header,
                                   WSDLModelerBase.ProcessSOAPOperationInfo info,
                                   Response response,
                                   Set duplicateNames)

getHeaderFaultSequenceType

protected AbstractType getHeaderFaultSequenceType(AbstractType faultType,
                                                  MessagePart faultPart,
                                                  QName elemName)

Parameters:

faultType -

getJavaNameOfSEI

protected String getJavaNameOfSEI(Port port)

createJavaInterfaceForPort

protected void createJavaInterfaceForPort(Port port)

getJavaNameForOperation

protected String getJavaNameForOperation(Operation operation)

createJavaException

protected boolean createJavaException(Fault fault,
                                      Port port,
                                      String operationName)

getExceptionInfo

protected WSDLModelerBase.WSDLExceptionInfo getExceptionInfo(Fault fault)

createJavaExceptionFromSOAPType

protected boolean createJavaExceptionFromSOAPType(Fault fault,
                                                  Port port,
                                                  String operationName)

getLiteralJavaMemberName

protected String getLiteralJavaMemberName(Fault fault)

isEquivalentSOAPStructures

public boolean isEquivalentSOAPStructures(SOAPStructureType struct1,
                                          SOAPStructureType struct2)

isEquivalentLiteralStructures

public boolean isEquivalentLiteralStructures(LiteralStructuredType struct1,
                                             LiteralStructuredType struct2)

createJavaExceptionFromLiteralType

protected boolean createJavaExceptionFromLiteralType(Fault fault,
                                                     Port port,
                                                     String operationName)

createRelativeJavaExceptions

protected void createRelativeJavaExceptions(Fault fault,
                                            Port port,
                                            String operationName)

getEnvironment

protected ProcessorEnvironment getEnvironment()

warn

protected void warn(Localizable msg)

warn

protected void warn(String key)

warn

protected void warn(String key,
                    String arg)

warn

protected void warn(String key,
                    Object[] args)

info

protected void info(String key)

info

protected void info(String key,
                    String arg)

makePackageQualified

protected String makePackageQualified(String s,
                                      QName name)

makePackageQualified

protected String makePackageQualified(String s,
                                      QName name,
                                      boolean useNamespaceMapping)

makePackageQualified

protected QName makePackageQualified(QName name)

makePackageQualified

protected QName makePackageQualified(QName name,
                                     boolean useNamespaceMapping)

makeNameUniqueInSet

protected String makeNameUniqueInSet(String candidateName,
                                     Set names)

getUniqueName

protected String getUniqueName(Operation operation,
                               boolean hasOverloadedOperations)

getUniqueParameterName

protected String getUniqueParameterName(Operation operation,
                                        String baseName)

getNonQualifiedNameFor

protected String getNonQualifiedNameFor(QName name)

setDocumentationIfPresent

protected static void setDocumentationIfPresent(ModelObject obj,
                                                Documentation documentation)

getQNameOf

protected static QName getQNameOf(GloballyKnown entity)

getExtensionOfType

protected static Extension getExtensionOfType(Extensible extensible,
                                              Class type)

getAnyExtensionOfType

protected Extension getAnyExtensionOfType(Extensible extensible,
                                          Class type)

findMessage

protected static Message findMessage(QName messageName,
                                     WSDLModelerBase.ProcessSOAPOperationInfo info)

tokenListContains

protected static boolean tokenListContains(String tokenList,
                                           String target)

isConflictingClassName

protected boolean isConflictingClassName(String name)

isConflictingServiceClassName

protected boolean isConflictingServiceClassName(String name)

isConflictingStubClassName

protected boolean isConflictingStubClassName(String name)

isConflictingTieClassName

protected boolean isConflictingTieClassName(String name)

isConflictingPortClassName

protected boolean isConflictingPortClassName(String name)

isConflictingExceptionClassName

protected boolean isConflictingExceptionClassName(String name)

getElementTypeToLiteralType

protected LiteralType getElementTypeToLiteralType(QName elementType)