org.andromda.cartridges.webservice

Class WebServiceUtils

java.lang.Object

org.andromda.cartridges.webservice.WebServiceUtils

public class WebServiceUtils
extends Object

Contains utilities used within the WebService cartridge.

Author:

Chad Brandon, Bob Fields

Constructor Summary

Constructors

Constructor and Description
WebServiceUtils()

Method Summary

Methods

Modifier and Type	Method and Description
Map<PackageFacade,String>	addPkgAbbr(PackageFacade pkg, String pkgAbbr) Adds the package namespace abbreviation for this package
String	createConstructor(ModelElementFacade facade) Supplies a result for type = ; initialization for all types
String	createConstructor(ModelElementFacade facade, boolean useMany) Supplies a result for type = ; initialization for all types
String	createConstructor(ModelElementFacade facade, boolean useMany, ModelElementFacade parent) Supplies a result for type = ; initialization for all types
Collection<ModelElementFacade>	getAllowedOperationExceptions(PackageFacade packageFacade) Get all operations under WebService or with WebServiceOperation in a package
List<WebServiceOperation>	getAllowedOperations(PackageFacade packageFacade) Get all operations under WebService or with WebServiceOperation in a package
Collection<Role>	getAllRoles(Collection<Service> services) Retrieves all roles from the given services collection.
static String	getDate() Returns the current Date in the specified format.
static String	getDate(String format) Returns the current Date in the specified format.
String	getElementClassName(String elementName, String namespace) Gets the fully qualified name of a class given the XML Element Name and namespace.
Collection<PackageFacade>	getExceptionReferences(PackageFacade packageFacade) Creates a list of referenced exception packages for each package.
static String	getPackageName(String namespace) Creates the package name from the element namespace, following the JAXB rules.
Collection<PackageFacade>	getPackageReferences(PackageFacade packageFacade, boolean follow) Creates a list of referenced packages for each package.
Collection<PackageFacade>	getPackageReferences(WebServiceLogicImpl service, Set<MetafacadeBase> types, String packageName, boolean follow) Creates a list of referenced packages for each package.
Collection<PackageFacade>	getPackages(WebServiceLogicImpl service, Set<ModelElementFacade> types, boolean follow) Creates a list of referenced packages for the service.
Collection<ModelElementFacade>	getPackageTypes(PackageFacade packageFacade, boolean follow) Filter schema types list and related object to only a single package.
Collection<ModelElementFacade>	getPackageTypes(WebServiceLogicImpl service, Set<MetafacadeBase> types, String packageName, boolean follow) Filter schema types list and related object to only a single package.
String	getPkgAbbr(PackageFacade pkg) Get the package namespace abbreviation for this package
String	getPkgAbbr(PackageFacade pkg, PackageFacade currentPackage) Get the package namespace abbreviation for this package
static String	getSchemaType(ClassifierFacade type, TypeMappings schemaTypeMappings, String namespacePrefix, String qName, String wrappedArrayTypePrefix, boolean withPrefix, boolean preserveArray) Creates and returns the schema type for the given type.
Collection<PackageFacade>	getServiceDescendantPackages(WebServiceLogicImpl service, boolean follow) Creates a list of referenced packages for all subclasses referenced by the service.
Collection<ModelElementFacade>	getServiceReferences(WebServiceLogicImpl service, boolean follow) Creates a list of referenced types for the service.
String	getTypeMapping(TypeMappings mappings, String from) Determine how a model type is mapped to a java implementation type.
boolean	hasComplexTypes(ClassifierFacade facade, boolean follow) Determine if an object has schema complex types (associations, multiplicity > 1, or complex attributes).
static boolean	isSimpleType(ModelElementFacade element) Returns true if java.lang.* or java.util.* datatype and not many*
static String	reversePackage(String packageName) Reverses the packageName.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebServiceUtils

public WebServiceUtils()

Method Detail

getAllRoles

public Collection<Role> getAllRoles(Collection<Service> services)

Retrieves all roles from the given services collection.

Parameters:

services - the collection services.

Returns:

all roles from the collection.

getPackages

public Collection<PackageFacade> getPackages(WebServiceLogicImpl service,
                                    Set<ModelElementFacade> types,
                                    boolean follow)

Creates a list of referenced packages for the service. Populates pkgAbbr static map. I tried this in the WebServiceLogicImpl metafacade but couldn't get repeatable results. Called from jaxws-included.xsd for CXF implementation

Parameters:

service - WebServiceLogicImpl The service for which to find referenced packages

types - Set of all serviceOperations, from $service.allowedOperations

follow - Follow Inheritance references $extensionInheritanceDisabled

Returns:

pkgRefs Collection - all referenced packages

addPkgAbbr

public Map<PackageFacade,String> addPkgAbbr(PackageFacade pkg,
                                   String pkgAbbr)

Adds the package namespace abbreviation for this package

Parameters:

pkg - Package for which to get the abbreviation. Uses a static Map so that all schemas globally for this model will use the same namespace abbreviations

pkgAbbr - Package Abbreviation to be added to namespace map

Returns:

PackageMap TreeMap of package <-> abbreviation cross references

getPkgAbbr

public String getPkgAbbr(PackageFacade pkg)

Get the package namespace abbreviation for this package

Parameters:

pkg - Package for which to get the abbreviation. Uses a static Map so that all schemas globally for this model will use the same namespace abbreviations

Returns:

Package abbreviation nsX

getPkgAbbr

public String getPkgAbbr(PackageFacade pkg,
                PackageFacade currentPackage)

Get the package namespace abbreviation for this package

Parameters:

pkg - Package for which to get the abbreviation. Uses a static Map so that all schemas globally for this model will use the same namespace abbreviations

currentPackage - The package which is referencing the pkg. Return 'impl' if the same as pkg.

Returns:

Package abbreviation nsX

getPackageReferences

public Collection<PackageFacade> getPackageReferences(WebServiceLogicImpl service,
                                             Set<MetafacadeBase> types,
                                             String packageName,
                                             boolean follow)

Creates a list of referenced packages for each package. Run this after running getTypeMappingElements(), to populate the namespace Map and referenced imports from each namespace.

Parameters:

service - WebService containing WS operations with references.

types - Collection of all schemaTypeMappings referenced in the WebService class operations

packageName - Package / namespace for which to find all related (referenced) packages

follow - Follow Inheritance references $extensionInheritanceDisabled

Returns:

pkgRefs

getExceptionReferences

public Collection<PackageFacade> getExceptionReferences(PackageFacade packageFacade)

Creates a list of referenced exception packages for each package. Populates schema reference list for import for the wsdl

Parameters:

packageFacade - Package / namespace for which to find all related (referenced) packages

Returns:

pkgRefs Collection package names

getPackageReferences

public Collection<PackageFacade> getPackageReferences(PackageFacade packageFacade,
                                             boolean follow)

Creates a list of referenced packages for each package. Populates schema reference list for import

Parameters:

packageFacade - Package / namespace for which to find all related (referenced) packages

follow - Follow Inheritance references $extensionInheritanceDisabled

Returns:

pkgRefs Collection package names

getAllowedOperations

public List<WebServiceOperation> getAllowedOperations(PackageFacade packageFacade)

Get all operations under WebService or with WebServiceOperation in a package

Parameters:

packageFacade - Package / namespace for which to find all service operations

Returns:

operations

getAllowedOperationExceptions

public Collection<ModelElementFacade> getAllowedOperationExceptions(PackageFacade packageFacade)

Get all operations under WebService or with WebServiceOperation in a package

Parameters:

packageFacade - Package / namespace for which to find all service operations

Returns:

operations

getPackageTypes

public Collection<ModelElementFacade> getPackageTypes(PackageFacade packageFacade,
                                             boolean follow)

Filter schema types list and related object to only a single package. Called for each referenced package. Run this after running getTypeMappingElements(), to populate the namespace Map and referenced imports from each namespace.

Parameters:

packageFacade - Package / namespace for which to find all related (referenced) packages

follow - Follow Inheritance references $extensionInheritanceDisabled

Returns:

pkgRefs

getPackageTypes

public Collection<ModelElementFacade> getPackageTypes(WebServiceLogicImpl service,
                                             Set<MetafacadeBase> types,
                                             String packageName,
                                             boolean follow)

Filter schema types list and related object to only a single package. Called for each referenced package. Run this after running getTypeMappingElements(), to populate the namespace Map and referenced imports from each namespace.

Parameters:

service - WebService containing WS operations with references.

types - Collection of all schemaTypeMappings referenced in the WebService class operations

packageName - Package / namespace for which to find all related (referenced) packages

follow - Follow Inheritance references $extensionInheritanceDisabled

Returns:

pkgRefs

hasComplexTypes

public boolean hasComplexTypes(ClassifierFacade facade,
                      boolean follow)

Determine if an object has schema complex types (associations, multiplicity > 1, or complex attributes). Needed when useAttributes=true so wsdl/xsd outputs attributes instead of elements , no complex type element declarations. If no complex types, only attribute declarations are needed in the object schema definition. Sees if attribute packages are something other than java.lang, java,util, java.math.

Parameters:

facade - Type to determine if it contains complex types

follow - Follow inheritance hierarchy for type when determining complex types

Returns:

pkgRefs

getPackageName

public static String getPackageName(String namespace)

Creates the package name from the element namespace, following the JAXB rules. Reverse the hostname (separated by .) Add the service context (separated by /) Substitute underscore _ for dash - in name Put _ in front of numeric values for package components.

Parameters:

namespace - the XML namespace.

Returns:

the reversed package name.

getElementClassName

public String getElementClassName(String elementName,
                         String namespace)

Gets the fully qualified name of a class given the XML Element Name and namespace. Assumes the namespace is the reversed package name.

Parameters:

elementName - the XML element name.

namespace - the XML namespace for the element.

Returns:

String the package + element name

createConstructor

public String createConstructor(ModelElementFacade facade)

Supplies a result for type = ; initialization for all types

Parameters:

facade - Type to create default object for

Returns:

Constructor String with facade name

createConstructor

public String createConstructor(ModelElementFacade facade,
                       boolean useMany)

Supplies a result for type = ; initialization for all types

Parameters:

facade - Type to create default object for

useMany - Return constructor with multiplicity type instead of underlying type

Returns:

Constructor String with facade name

createConstructor

public String createConstructor(ModelElementFacade facade,
                       boolean useMany,
                       ModelElementFacade parent)

Supplies a result for type = ; initialization for all types

Parameters:

facade - Type to create default object for

useMany - Return constructor with multiplicity type instead of underlying type

parent - Object containing this facade, which may have an attribute named dependency to a different type

Returns:

Constructor String with facade name

getServiceDescendantPackages

public Collection<PackageFacade> getServiceDescendantPackages(WebServiceLogicImpl service,
                                                     boolean follow)

Creates a list of referenced packages for all subclasses referenced by the service. Used to add XmlSeeAlso references to the SEI Interface.

Parameters:

service - WebService containing WS operations with references.

follow - Follow Inheritance references $extensionInheritanceDisabled

Returns:

typeRef Collection referenced types

getServiceReferences

public Collection<ModelElementFacade> getServiceReferences(WebServiceLogicImpl service,
                                                  boolean follow)

Creates a list of referenced types for the service. Used to add element references to the service namespace, for bare parameters.

Parameters:

service - WebService containing WS operations with references.

follow - Follow Inheritance references $extensionInheritanceDisabled

Returns:

typeRef Collection referenced types

reversePackage

public static String reversePackage(String packageName)

Reverses the packageName.

Parameters:

packageName - the package name to reverse.

Returns:

the reversed package name.

getDate

public static String getDate(String format)

Returns the current Date in the specified format.

Parameters:

format - The format for the output date

Returns:

the current date in the specified format.

getDate

public static String getDate()

Returns the current Date in the specified format.

Returns:

the current date with the default format .

getTypeMapping

public String getTypeMapping(TypeMappings mappings,
                    String from)

Determine how a model type is mapped to a java implementation type. Used to resolve conflicts between java and webservice type mappings. i.e. webservice maps Integer as BigInteger and Date/Time/DateTime as Calendar, so Value Object attributes will not match webservice attribute types. Called from vsl $webServiceUtils.getTypeMapping($service.

Parameters:

mappings -

from -

Returns:

the String mapping type to.

getSchemaType

public static String getSchemaType(ClassifierFacade type,
                   TypeMappings schemaTypeMappings,
                   String namespacePrefix,
                   String qName,
                   String wrappedArrayTypePrefix,
                   boolean withPrefix,
                   boolean preserveArray)

Creates and returns the schema type for the given type. It finds the mapped schema type from the passed in schemaTypeMappings.

Parameters:

type - the ClassifierFacade instance

schemaTypeMappings - contains the mappings from model datatypes to schema datatypes.

namespacePrefix - the prefix given to the schema type if it's a custom type (non XSD type).

qName - the qualified name

wrappedArrayTypePrefix - a prefix to give to wrapped array types.

withPrefix - a flag indicating whether or not the type should have the prefix defined

preserveArray - true/false, if true then if the schema type is an array we'll preserve the fact that its an array and return an array schema type name. If false we will return back the non array type even if its an array.

Returns:

the schema type name - String

isSimpleType

public static boolean isSimpleType(ModelElementFacade element)

Returns true if java.lang.* or java.util.* datatype and not many*

Parameters:

element - the ClassifierFacade instance

Returns:

if type is one of the PrimitiveTypes and not an array/list