WSDLUtils (Red Hat JBoss Enterprise Application Platform 6.4.19.GA public API)

java.lang.Object
- org.jboss.ws.metadata.wsdl.WSDLUtils

```
public class WSDLUtils
extends Object
```
Singleton utils class used for Java2WSDL and WSDL2Java operations

Since:

Nov 3, 2004

Author:

Anil Saldhana

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addSchemaModel(WSDLTypes types, String namespace, JBossXSModel model)`
`boolean`	`checkIgnoreClass(Class<?> cls)` Check if the class is a Java standard class
`boolean`	`checkIgnoreMethod(Method method)` Check if this method should be ignored
`String`	`chop(String name, String chopstr)` Chop chopstr at the end of the String
`String`	`chopPortType(String name)` Chop "PortType" at the end of the String
`StringBuilder`	`createClassBasicStructure(String pkgname, String fname, XSTypeDefinition type, List<?> importList, String baseName)` Create the basic template of a class
`File`	`createPackage(String path, String packageName)` Given a packageName, start creating the package structure
`File`	`createPhysicalFile(File loc, String fname)` Create a file on the disk
`boolean`	`doesPublicFieldExist(Class<?> javaType, String name)` Checks whether there exists a public field with the given name
`String`	`firstLetterUpperCase(String fname)` Ensure that the first alphabet is uppercase
`int`	`getArrayDimension(Class<?> arr)` Get the dimension of an array
`String`	`getFormattedString(QName qn)` Given a QName, provide a string that is prefix:localpart
`Class<?>`	`getHolder(Class<?> cls)` Return the Jaxrpc holder that represents the class
`static WSDLUtils`	`getInstance()` Singleton - Only way to get an instance
`Class<?>`	`getJavaType(QName xmlType)` Given the XMLType, we will check if it is of basic schema types that are mapped to Java primitives and wrappers Jaxrpc 1.1 Section 5.3
`Class<?>`	`getJavaTypeForHolder(Class<?> cls)` Return the Java class that is represented by the Jaxrpc holder
`static String`	`getJustClassName(Class<?> cls)` Given a class, strip out the package name
`static String`	`getJustClassName(String classname)` Given a FQN of a class, strip out the package name
`String`	`getMessagePartForArray(Class<?> javaType)` An input of "HelloObjArray" is converted into arrayOfHelloObj Applied in the input part for WSDL 1.1 Messages
`String`	`getMixedCase(String str)` Change the first character to uppercase
`String`	`getPackageName(String typeNS)` Extracts the package name from the typeNS
`String`	`getPrimitive(String str)` Return the primitive for a wrapper equivalent (Integer -> int)
`Field[]`	`getPublicFields(Class<?> cls)` From the list of fields defined by this class (not superclasses) get the fields that are relevant (public)
`Method[]`	`getPublicProtectedMethods(Method[] methods)` From the list of fields defined by this class (not superclasses) get the fields that are relevant (public/protected)
`QName`	`getQName(String formattedStr)` Return a QName given a formatted string
`static JBossXSModel`	`getSchemaModel(WSDLTypes types)`
`static String`	`getTypeNamespace(Class<?> javaType)`
`static String`	`getTypeNamespace(String packageName)` Extracts the typeNS given the package name Algorithm is based on the one specified in JAWS v2.0 spec
`static WSDLInterfaceOperationInput`	`getWsdl11Input(WSDLInterfaceOperation operation)`
`static WSDLInterfaceOperationOutput`	`getWsdl11Output(WSDLInterfaceOperation operation)`
`String`	`getWSDLStyle(WSDLDefinitions wsdl)` Given WSDLDefinitions, detect the wsdl style
`boolean`	`isBaseTypeIgnorable(XSTypeDefinition baseType, XSComplexTypeDefinition t)` For the given complex type, check if its base type is the regular xsd type (xsd:anyType) which can be ignored
`boolean`	`isPrimitive(String str)` Check if it is of Primitive Type
`boolean`	`isStandardHolder(Class<?> cls)` Checks whether the class is a standard jaxrpc holder
`boolean`	`isWrapper(String str)` Check if it is of Wrapper Type
`protected void`	`populatePrimList()`
`protected void`	`populateWrapperList()`
`void`	`writeJbossHeader(StringBuilder buf)` Write the JBoss License Header at the top of generated class source files

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInstance
```
public static WSDLUtils getInstance()
```
    Singleton - Only way to get an instance
    
    Returns:
  - isPrimitive
```
public boolean isPrimitive(String str)
```
    Check if it is of Primitive Type
    
    Parameters:
    str -
    
    Returns:
  - isWrapper
```
public boolean isWrapper(String str)
```
    Check if it is of Wrapper Type
    
    Parameters:
    str -
    
    Returns:
  - isBaseTypeIgnorable
```
public boolean isBaseTypeIgnorable(XSTypeDefinition baseType,
                          XSComplexTypeDefinition t)
```
    For the given complex type, check if its base type is the regular xsd type (xsd:anyType) which can be ignored
    
    Parameters:
    baseType -
    t - ComplexTypeDefinition
    
    Returns:
    true:ignorable, false-otherwise(user defined base type)
  - checkIgnoreClass
```
public boolean checkIgnoreClass(Class<?> cls)
```
    Check if the class is a Java standard class
    
    Parameters:
    cls -
    
    Returns:
    true if class belongs to java.* or javax.* package
  - checkIgnoreMethod
```
public boolean checkIgnoreMethod(Method method)
```
    Check if this method should be ignored
  - chopPortType
```
public String chopPortType(String name)
```
    Chop "PortType" at the end of the String
    
    Parameters:
    name -
    
    Returns:
  - chop
```
public String chop(String name,
          String chopstr)
```
    Chop chopstr at the end of the String
    
    Parameters:
    name -
    chopstr - the string that is the key Eg: Fault
    
    Returns:
  - createPackage
```
public File createPackage(String path,
                 String packageName)
```
    Given a packageName, start creating the package structure
    
    Parameters:
    packageName -
  - createPhysicalFile
```
public File createPhysicalFile(File loc,
                      String fname)
                        throws IOException
```
    Create a file on the disk
    
    Parameters:
    loc - Location where the file has to be created
    fname - File Name to which '.java' will be appended
    
    Returns:
    
    Throws:
    
    IOException - Problem creating the file
  - createClassBasicStructure
```
public StringBuilder createClassBasicStructure(String pkgname,
                                      String fname,
                                      XSTypeDefinition type,
                                      List<?> importList,
                                      String baseName)
```
    Create the basic template of a class
    
    Parameters:
    pkgname - Package Name
    fname - File Name to which '.java' will be appended
    type - XSDType to obtain base class info (if Complex Type)
    importList - Strings representing imports
    
    Returns:
  - doesPublicFieldExist
```
public boolean doesPublicFieldExist(Class<?> javaType,
                           String name)
```
    Checks whether there exists a public field with the given name
    
    Parameters:
    javaType - Class Object
    name - Field name to check
    
    Returns:
    true - if public field exists, false-otherwise
  - firstLetterUpperCase
```
public String firstLetterUpperCase(String fname)
```
    Ensure that the first alphabet is uppercase
    
    Parameters:
    fname -
    
    Returns:
  - getArrayDimension
```
public int getArrayDimension(Class<?> arr)
```
    Get the dimension of an array
    
    Parameters:
    arr -
    
    Returns:
    dimension of an array
  - getHolder
```
public Class<?> getHolder(Class<?> cls)
```
    Return the Jaxrpc holder that represents the class
    
    Parameters:
    cls -
    
    Returns:
    Jaxrpc Holder object if exists
  - getJavaTypeForHolder
```
public Class<?> getJavaTypeForHolder(Class<?> cls)
```
    Return the Java class that is represented by the Jaxrpc holder
    
    Parameters:
    cls - The jaxrpc holder type
    
    Returns:
    Jaxrpc Holder object if exists
  - getMessagePartForArray
```
public String getMessagePartForArray(Class<?> javaType)
```
    An input of "HelloObjArray" is converted into arrayOfHelloObj Applied in the input part for WSDL 1.1 Messages
    
    Parameters:
    arrayStr -
    
    Returns:
  - getJustClassName
```
public static String getJustClassName(Class<?> cls)
```
    Given a class, strip out the package name
    
    Parameters:
    cls -
    
    Returns:
    just the classname
  - getJustClassName
```
public static String getJustClassName(String classname)
```
    Given a FQN of a class, strip out the package name
    
    Parameters:
    classname -
    
    Returns:
    just the classname
  - getPublicFields
```
public Field[] getPublicFields(Class<?> cls)
```
    From the list of fields defined by this class (not superclasses) get the fields that are relevant (public)
  - getPublicProtectedMethods
```
public Method[] getPublicProtectedMethods(Method[] methods)
```
    From the list of fields defined by this class (not superclasses) get the fields that are relevant (public/protected)
    
    Parameters:
    methods -
    
    Returns:
  - getJavaType
```
public Class<?> getJavaType(QName xmlType)
```
    Given the XMLType, we will check if it is of basic schema types that are mapped to Java primitives and wrappers Jaxrpc 1.1 Section 5.3
    
    Parameters:
    xmlType -
    
    Returns:
  - getMixedCase
```
public String getMixedCase(String str)
```
    Change the first character to uppercase
    
    Parameters:
    str -
    
    Returns:
  - getFormattedString
```
public String getFormattedString(QName qn)
```
    Given a QName, provide a string that is prefix:localpart
    
    Parameters:
    qn -
    
    Returns:
    formatted string
  - getQName
```
public QName getQName(String formattedStr)
```
    Return a QName given a formatted string
    
    Parameters:
    formattedStr - string that is prefix:localpart
    
    Returns:
    QName
  - getPrimitive
```
public String getPrimitive(String str)
```
    Return the primitive for a wrapper equivalent (Integer -> int)
    
    Parameters:
    str -
    
    Returns:
  - getPackageName
```
public String getPackageName(String typeNS)
```
    Extracts the package name from the typeNS
    
    Parameters:
    typeNS -
    
    Returns:
  - getTypeNamespace
```
public static String getTypeNamespace(Class<?> javaType)
```
  - getTypeNamespace
```
public static String getTypeNamespace(String packageName)
```
    Extracts the typeNS given the package name Algorithm is based on the one specified in JAWS v2.0 spec
  - getWSDLStyle
```
public String getWSDLStyle(WSDLDefinitions wsdl)
```
    Given WSDLDefinitions, detect the wsdl style
    
    Parameters:
    wsdl -
    
    Returns:
    Constants.RPC_LITERAL or Constants.DOCUMENT_LITERAL
  - getSchemaModel
```
public static JBossXSModel getSchemaModel(WSDLTypes types)
```
  - addSchemaModel
```
public static void addSchemaModel(WSDLTypes types,
                  String namespace,
                  JBossXSModel model)
```
  - isStandardHolder
```
public boolean isStandardHolder(Class<?> cls)
```
    Checks whether the class is a standard jaxrpc holder
    
    Parameters:
    cls - a Class object
    
    Returns:
    true: A Standard jaxrpc holder
  - writeJbossHeader
```
public void writeJbossHeader(StringBuilder buf)
```
    Write the JBoss License Header at the top of generated class source files
    
    Parameters:
    buf -
  - populatePrimList
```
protected void populatePrimList()
```
  - populateWrapperList
```
protected void populateWrapperList()
```
  - getWsdl11Output
```
public static WSDLInterfaceOperationOutput getWsdl11Output(WSDLInterfaceOperation operation)
```
  - getWsdl11Input
```
public static WSDLInterfaceOperationInput getWsdl11Input(WSDLInterfaceOperation operation)
```

Class WSDLUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

isPrimitive

isWrapper

isBaseTypeIgnorable

checkIgnoreClass

checkIgnoreMethod

chopPortType

chop

createPackage

createPhysicalFile

createClassBasicStructure

doesPublicFieldExist

firstLetterUpperCase

getArrayDimension

getHolder

getJavaTypeForHolder

getMessagePartForArray

getJustClassName

getJustClassName

getPublicFields

getPublicProtectedMethods

getJavaType

getMixedCase

getFormattedString

getQName

getPrimitive

getPackageName

getTypeNamespace

getTypeNamespace

getWSDLStyle

getSchemaModel

addSchemaModel

isStandardHolder

writeJbossHeader

populatePrimList

populateWrapperList

getWsdl11Output

getWsdl11Input