org.andromda.cartridges.webservice.metafacades

Class WebServiceLogicImpl

java.lang.Object

org.andromda.core.metafacade.MetafacadeBase

org.andromda.cartridges.webservice.metafacades.WebServiceLogic

org.andromda.cartridges.webservice.metafacades.WebServiceLogicImpl

All Implemented Interfaces:

Serializable, Comparable, WebService, ClassifierFacade, GeneralizableElementFacade, ModelElementFacade, Service

public class WebServiceLogicImpl
extends WebServiceLogic

MetafacadeLogic implementation for org.andromda.cartridges.webservice.metafacades.WebService.

Author:

Bob Fields

See Also:

WebService, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebServiceLogicImpl.OperationNameComparator Used to sort operations by name.
class	WebServiceLogicImpl.TypeComparator We use this comparator to actually eliminate duplicates instead of sorting like a comparator is normally used.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static String	NAMESPACE_PATTERN namespacePattern
(package private) static String	NAMESPACE_PREFIX namespacePrefix
(package private) static String	QNAME_LOCAL_PART_PATTERN qualifiedNameLocalPartPattern
(package private) static String	REVERSE_NAMESPACE reverseNamespace

Fields inherited from class org.andromda.cartridges.webservice.metafacades.WebServiceLogic

metaObject

Fields inherited from class org.andromda.core.metafacade.MetafacadeBase

contextRoot

Constructor Summary

Constructors

Constructor and Description
WebServiceLogicImpl(Object metaObject, String context)

Method Summary

Methods

Modifier and Type	Method and Description
Collection<Role>	getAllRoles() Overridden to only allow the exposed operations in the returned roles collection.
protected String	getEjbHomeInterfacePattern() Gets the ejbHomeInterfacePattern for an EJB provider.
protected String	getEjbInterfacePattern() Gets the ejbInterfacePattern for an EJB provider.
protected String	getEjbJndiNamePrefix() Gets the ejbJndiNamePrefix for an EJB provider.
protected String	getNamespacePattern() Gets the namespacePattern for this service.
Collection<PackageFacade>	getPackages()
String	getPkgAbbr(PackageFacade pkg)
protected String	getQualifiedNameLocalPartPattern() Gets the qualifiedNameLocalPartPattern for this service.
protected String	getRpcClassNamePattern() Gets the rpcClassNamePattern for this service.
ClassifierFacade	getType(Object modelElement) Gets the type or returnType of the model element (if the model element has a type or returnType).
protected String	handleGetAllowedMethods()
protected Collection	handleGetAllowedOperationExceptions() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected Collection<OperationFacade>	handleGetAllowedOperations() UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type
protected String	handleGetEjbHomeInterface()
protected String	handleGetEjbInterface()
protected String	handleGetEjbJndiName()
protected String	handleGetFullyQualifiedTestImplementationName()
protected String	handleGetFullyQualifiedTestName()
protected int	handleGetJaxwsCount()
protected String	handleGetNamespace()
protected String	handleGetNamespacePrefix()
protected Collection<String>	handleGetPackageReferences(String pkg, boolean follow) Get a unique list of packages referenced by the referring package
protected Collection<String>	handleGetPackages() Get a unique list of packages populated from the results of GetTypeMappingElements
protected String	handleGetPkgAbbr(String pkgName)
protected String	handleGetProvider()
protected String	handleGetQName()
protected String	handleGetRestCacheType()
protected String	handleGetRestConsumes()
protected List<String>	handleGetRestContexts() Contexts should be in the form fullyqualifiedclassname variable
protected int	handleGetRestCount()
protected String	handleGetRestMethod()
protected String	handleGetRestPath()
protected String	handleGetRestProduces()
protected String	handleGetRestProvider()
protected String	handleGetRestRetention()
protected String	handleGetRestTarget()
protected String	handleGetRpcClassName()
protected TypeMappings	handleGetSchemaMappings() Method to be implemented in descendants TODO: Model Documentation for org.andromda.cartridges.webservice.metafacades.WebService.getSchemaMappings
protected String	handleGetStyle()
protected String	handleGetTestImplementationName()
protected String	handleGetTestName()
protected String	handleGetTestPackageName()
protected Collection<ModelElementFacade>	handleGetTypeMappingElements()
protected String	handleGetUse()
protected String	handleGetWsdlFile()
protected String	handleGetXjcArguments()
protected boolean	handleIsDocumentStyle()
protected boolean	handleIsEncodedUse()
protected boolean	handleIsLiteralUse()
protected boolean	handleIsRestAtom()
protected boolean	handleIsRpcStyle()
protected boolean	handleIsSchemaValidation()
protected boolean	handleIsSecured()
protected boolean	handleIsSimpleBindingMode()
protected boolean	handleIsWrappedStyle()
protected boolean	isReverseNamespace() Gets whether or not reverseNamespace is true/false for this type.
Boolean	useEnumValueInXSD() Used to map between XML (list of restricted strings) and Java enum (has both a name and a value).
void	validateInvariants(Collection<ModelValidationMessage> validationMessages) Constraint: org::andromda::cartridges::webservice::metafacades::WebService::operation name must be unique

Methods inherited from class org.andromda.cartridges.webservice.metafacades.WebServiceLogic

copyTaggedValues, findAttribute, findTaggedValue, findTaggedValue, findTaggedValues, getAbstractions, getAllAssociatedClasses, getAllEntityReferences, getAllGeneralizations, getAllMessagingDestinations, getAllowedMethods, getAllowedOperationExceptions, getAllowedOperations, getAllProperties, getAllRequiredConstructorParameters, getAllServiceReferences, getAllSpecializations, getArray, getArrayName, getAssociatedClasses, getAssociationEnds, getAttributes, getAttributes, getBindedFullyQualifiedName, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getEjbHomeInterface, getEjbInterface, getEjbJndiName, getEntityReferences, getFullyQualifiedArrayName, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getFullyQualifiedTestImplementationName, getFullyQualifiedTestName, getGeneralization, getGeneralizationLinks, getGeneralizationList, getGeneralizationRoot, getGeneralizations, getId, getImplementationOperations, getImplementedInterfaceList, getInstanceAttributes, getInstanceOperations, getInterfaceAbstractions, getJavaNewString, getJavaNullString, getJaxwsCount, getKeywords, getLabel, getLanguageMappings, getMessagingDestinations, getModel, getName, getNamespace, getNamespacePrefix, getNavigableConnectingEnds, getNavigableConnectingEnds, getNonArray, getOperationCallFromAttributes, getOperations, getPackage, getPackageName, getPackageName, getPackagePath, getPackageReferences, getProperties, getProperties, getProvider, getQName, getQualifiedName, getRequiredConstructorParameters, getRestCacheType, getRestConsumes, getRestContexts, getRestCount, getRestMethod, getRestPath, getRestProduces, getRestProvider, getRestRetention, getRestTarget, getRoles, getRootPackage, getRpcClassName, getSchemaMappings, getSerialVersionUID, getServiceReferences, getSourceDependencies, getSpecializations, getStateMachineContext, getStaticAttributes, getStaticOperations, getStereotypeNames, getStereotypes, getStyle, getSuperClass, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getTestImplementationName, getTestName, getTestPackageName, getTypeMappingElements, getUse, getValidationName, getValidationOwner, getVisibility, getWrapperName, getWsdlFile, getXjcArguments, hasExactStereotype, hasKeyword, hasStereotype, initialize, isAbstract, isArrayType, isAssociationClass, isBindingDependenciesPresent, isBlobType, isBooleanType, isCharacterType, isClassifierFacadeMetaType, isClobType, isCollectionType, isConstraintsPresent, isDataType, isDateType, isDocumentationPresent, isDocumentStyle, isDoubleType, isEmbeddedValue, isEncodedUse, isEnumeration, isFileType, isFloatType, isGeneralizableElementFacadeMetaType, isIntegerType, isInterface, isLeaf, isListType, isLiteralUse, isLongType, isMapType, isModelElementFacadeMetaType, isPrimitive, isReservedWord, isRestAtom, isRpcStyle, isSchemaValidation, isSecured, isServiceMetaType, isSetType, isSimpleBindingMode, isStringType, isTemplateParametersPresent, isTimeType, isValidIdentifierName, isWebServiceMetaType, isWrappedPrimitive, isWrappedStyle, resetMetafacadeContext, toString, translateConstraint, translateConstraints, translateConstraints

Methods inherited from class org.andromda.core.metafacade.MetafacadeBase

compareTo, equals, getConfiguredProperty, getDebug, getMetafacadeContext, getMetaObject, hashCode, isConfiguredProperty, isMetafacadePropertyCachingEnabled, setMetafacadeContext, setProperty, shieldedElement, shieldedElements, THIS, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAMESPACE_PREFIX

static final String NAMESPACE_PREFIX

namespacePrefix

See Also:

Constant Field Values

QNAME_LOCAL_PART_PATTERN

static final String QNAME_LOCAL_PART_PATTERN

qualifiedNameLocalPartPattern

See Also:

Constant Field Values

NAMESPACE_PATTERN

static final String NAMESPACE_PATTERN

namespacePattern

See Also:

Constant Field Values

REVERSE_NAMESPACE

static final String REVERSE_NAMESPACE

reverseNamespace

See Also:

Constant Field Values

Constructor Detail

WebServiceLogicImpl

public WebServiceLogicImpl(Object metaObject,
                   String context)

Parameters:

metaObject -

context -

Method Detail

handleGetAllowedOperations

protected Collection<OperationFacade> handleGetAllowedOperations()

Description copied from class: WebServiceLogic

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Specified by:

handleGetAllowedOperations in class WebServiceLogic

Returns:

operations filtered by ((WebServiceOperation)object).isExposed()

See Also:

WebService.getAllowedOperations()

handleGetAllowedMethods

protected String handleGetAllowedMethods()

Specified by:

handleGetAllowedMethods in class WebServiceLogic

Returns:

this.getAllowedOperations() separated by " "

See Also:

WebService.getAllowedMethods()

handleGetQName

protected String handleGetQName()

Specified by:

handleGetQName in class WebServiceLogic

Returns:

this.getName() formatted as this.getQualifiedNameLocalPartPattern()

See Also:

WebService.getQName()

handleGetNamespace

protected String handleGetNamespace()

Specified by:

handleGetNamespace in class WebServiceLogic

Returns:

this.getPackageName() reversed if this.isReverseNamespace()

See Also:

WebService.getNamespace()

handleGetStyle

protected String handleGetStyle()

Specified by:

handleGetStyle in class WebServiceLogic

Returns:

UMLProfile.TAGGEDVALUE_WEBSERVICE_STYLE or this.getConfiguredProperty(PROPERTY_DEFAULT_STYLE)

See Also:

WebService.getStyle()

handleGetUse

protected String handleGetUse()

Specified by:

handleGetUse in class WebServiceLogic

Returns:

UMLProfile.TAGGEDVALUE_WEBSERVICE_USE or this.getConfiguredProperty(PROPERTY_DEFAULT_USE

See Also:

WebService.getUse()

handleGetTypeMappingElements

protected Collection<ModelElementFacade> handleGetTypeMappingElements()

Specified by:

handleGetTypeMappingElements in class WebServiceLogic

Returns:

this.elementSet types

See Also:

WebService.getTypeMappingElements()

handleGetPackages

protected Collection<String> handleGetPackages()

Get a unique list of packages populated from the results of GetTypeMappingElements

Returns:

pkgAbbr TreeSet containing unique package list

handleGetPkgAbbr

protected String handleGetPkgAbbr(String pkgName)

Parameters:

pkgName -

Returns:

this.packageAbbr.get(pkgName)

handleGetPackageReferences

protected Collection<String> handleGetPackageReferences(String pkg,
                                            boolean follow)

Get a unique list of packages referenced by the referring package

Specified by:

handleGetPackageReferences in class WebServiceLogic

Parameters:

pkg - PackageName to find related packages for xs:schema import

follow - Follow Inheritance references $extensionInheritanceDisabled

Returns:

Collection TreeSet containing referenced package list

handleGetProvider

protected String handleGetProvider()

Specified by:

handleGetProvider in class WebServiceLogic

Returns:

this.getConfiguredProperty("defaultProvider")

See Also:

WebService.getProvider()

handleGetWsdlFile

protected String handleGetWsdlFile()

Specified by:

handleGetWsdlFile in class WebServiceLogic

Returns:

this.getConfiguredProperty(UMLMetafacadeProperties.NAMESPACE_SEPARATOR)

See Also:

WebService.getWsdlFile()

getType

public ClassifierFacade getType(Object modelElement)

Gets the type or returnType of the model element (if the model element has a type or returnType).

Parameters:

modelElement - the model element we'll retrieve the type of.

Returns:

ClassifierFacade Type of modelElement Object

handleGetNamespacePrefix

protected String handleGetNamespacePrefix()

Specified by:

handleGetNamespacePrefix in class WebServiceLogic

Returns:

this.getConfiguredProperty(NAMESPACE_PREFIX)

See Also:

WSDLType.getNamespacePrefix()

getQualifiedNameLocalPartPattern

protected String getQualifiedNameLocalPartPattern()

Gets the qualifiedNameLocalPartPattern for this service.

Returns:

this.getConfiguredProperty(QNAME_LOCAL_PART_PATTERN)

getNamespacePattern

protected String getNamespacePattern()

Gets the namespacePattern for this service.

Returns:

String the namespace pattern to use.

isReverseNamespace

protected boolean isReverseNamespace()

Gets whether or not reverseNamespace is true/false for this type.

Returns:

boolean true/false

handleGetEjbJndiName

protected String handleGetEjbJndiName()

Specified by:

handleGetEjbJndiName in class WebServiceLogic

Returns:

this.getEjbJndiNamePrefix() + ejb/ + this.getFullyQualifiedName()

See Also:

WebService.getEjbJndiName()

getEjbJndiNamePrefix

protected String getEjbJndiNamePrefix()

Gets the ejbJndiNamePrefix for an EJB provider.

Returns:

the EJB Jndi name prefix.

handleGetEjbHomeInterface

protected String handleGetEjbHomeInterface()

Specified by:

handleGetEjbHomeInterface in class WebServiceLogic

Returns:

this.getEjbHomeInterfacePattern() formatted as this.getPackageName() + this.getName()

See Also:

WebService.getEjbHomeInterface()

getEjbHomeInterfacePattern

protected String getEjbHomeInterfacePattern()

Gets the ejbHomeInterfacePattern for an EJB provider.

Returns:

the EJB Home interface pattern

handleGetEjbInterface

protected String handleGetEjbInterface()

Specified by:

handleGetEjbInterface in class WebServiceLogic

Returns:

this.getEjbInterfacePattern() formatted as this.getPackageName() + this.getName()

See Also:

WebService.getEjbInterface()

getEjbInterfacePattern

protected String getEjbInterfacePattern()

Gets the ejbInterfacePattern for an EJB provider.

Returns:

the EJB interface pattern

getRpcClassNamePattern

protected String getRpcClassNamePattern()

Gets the rpcClassNamePattern for this service.

Returns:

this.getConfiguredProperty(RPC_CLASS_NAME_PATTERN)

handleGetRpcClassName

protected String handleGetRpcClassName()

Specified by:

handleGetRpcClassName in class WebServiceLogic

Returns:

this.getRpcClassNamePattern() formatted as this.getPackageName() + this.getName()

See Also:

WebService.getRpcClassName()

handleIsSecured

protected boolean handleIsSecured()

Specified by:

handleIsSecured in class WebServiceLogic

Returns:

!this.getAllRoles().isEmpty()

See Also:

WebService.isSecured()

getAllRoles

public Collection<Role> getAllRoles()

Overridden to only allow the exposed operations in the returned roles collection.

Specified by:

getAllRoles in interface Service

Overrides:

getAllRoles in class WebServiceLogic

See Also:

Service.getAllRoles()

handleGetTestPackageName

protected String handleGetTestPackageName()

Specified by:

handleGetTestPackageName in class WebServiceLogic

Returns:

this.getPackageName() formatted as this.getConfiguredProperty(TEST_PACKAGE_NAME_PATTERN)

See Also:

WebService.getTestPackageName()

handleGetFullyQualifiedTestName

protected String handleGetFullyQualifiedTestName()

Specified by:

handleGetFullyQualifiedTestName in class WebServiceLogic

Returns:

this.getTestPackageName() + '.' + this.getTestName()

See Also:

WebService.getFullyQualifiedTestName()

handleGetTestName

protected String handleGetTestName()

Specified by:

handleGetTestName in class WebServiceLogic

Returns:

this.getName() formatted with this.getConfiguredProperty(TEST_NAME_PATTERN)

See Also:

WebService.getTestName()

handleIsWrappedStyle

protected boolean handleIsWrappedStyle()

Specified by:

handleIsWrappedStyle in class WebServiceLogic

Returns:

this.getStyle().equalsIgnoreCase(STYLE_WRAPPED)

See Also:

WebService.isWrappedStyle()

handleIsDocumentStyle

protected boolean handleIsDocumentStyle()

Specified by:

handleIsDocumentStyle in class WebServiceLogic

Returns:

this.getStyle().equalsIgnoreCase("document")

See Also:

WebService.isDocumentStyle()

handleIsRpcStyle

protected boolean handleIsRpcStyle()

Specified by:

handleIsRpcStyle in class WebServiceLogic

Returns:

this.getStyle().equalsIgnoreCase("rpc")

See Also:

WebService.isRpcStyle()

handleIsLiteralUse

protected boolean handleIsLiteralUse()

Specified by:

handleIsLiteralUse in class WebServiceLogic

Returns:

this.getStyle().equalsIgnoreCase("literal")

See Also:

WebService.isLiteralUse()

handleIsEncodedUse

protected boolean handleIsEncodedUse()

Specified by:

handleIsEncodedUse in class WebServiceLogic

Returns:

this.getStyle().equalsIgnoreCase("encoded")

See Also:

WebService.isEncodedUse()

handleGetTestImplementationName

protected String handleGetTestImplementationName()

Specified by:

handleGetTestImplementationName in class WebServiceLogic

Returns:

this.getName() formatted as this.getConfiguredProperty(TEST_IMPLEMENTATION_NAME_PATTERN)

See Also:

WebService.getTestImplementationName()

handleGetFullyQualifiedTestImplementationName

protected String handleGetFullyQualifiedTestImplementationName()

Specified by:

handleGetFullyQualifiedTestImplementationName in class WebServiceLogic

Returns:

this.getTestPackageName() + '.' + this.getTestImplementationName()

See Also:

WebService.getFullyQualifiedTestImplementationName()

handleGetSchemaMappings

protected TypeMappings handleGetSchemaMappings()

Description copied from class: WebServiceLogic

Method to be implemented in descendants TODO: Model Documentation for org.andromda.cartridges.webservice.metafacades.WebService.getSchemaMappings

Specified by:

handleGetSchemaMappings in class WebServiceLogic

Returns:

TypeMappings from WebServiceGlobals.SCHEMA_TYPE_MAPPINGS_URI "schemaTypeMappingsUri"

See Also:

WebService.getSchemaMappings()

handleGetAllowedOperationExceptions

protected Collection handleGetAllowedOperationExceptions()

Description copied from class: WebServiceLogic

UML Specific type is returned in Collection, transformed by shieldedElements to AndroMDA Metafacade type

Specified by:

handleGetAllowedOperationExceptions in class WebServiceLogic

Returns:

Collection

See Also:

WebServiceLogic.handleGetAllowedOperationExceptions()

getPackages

public Collection<PackageFacade> getPackages()

Returns:

packages from this.getAllowedOperations()

See Also:

WebServiceUtils.getPackages(WebServiceLogicImpl, Set, boolean)

getPkgAbbr

public String getPkgAbbr(PackageFacade pkg)

Parameters:

pkg -

Returns:

WebServiceUtils().getPkgAbbr(pkg)

See Also:

getPkgAbbr(PackageFacade)

handleIsSchemaValidation

protected boolean handleIsSchemaValidation()

Specified by:

handleIsSchemaValidation in class WebServiceLogic

Returns:

boolean

See Also:

WebServiceLogic.handleIsSchemaValidation()

handleIsSimpleBindingMode

protected boolean handleIsSimpleBindingMode()

Specified by:

handleIsSimpleBindingMode in class WebServiceLogic

Returns:

boolean

See Also:

WebServiceLogic.handleIsSimpleBindingMode()

handleGetXjcArguments

protected String handleGetXjcArguments()

Specified by:

handleGetXjcArguments in class WebServiceLogic

Returns:

String

See Also:

WebServiceLogic.getXjcArguments()

handleGetRestCacheType

protected String handleGetRestCacheType()

Specified by:

handleGetRestCacheType in class WebServiceLogic

Returns:

String

See Also:

WebServiceLogic.getRestCacheType()

handleGetRestConsumes

protected String handleGetRestConsumes()

Specified by:

handleGetRestConsumes in class WebServiceLogic

Returns:

String

See Also:

WebServiceLogic.getRestConsumes()

handleGetRestContexts

protected List<String> handleGetRestContexts()

Contexts should be in the form fullyqualifiedclassname variable

Specified by:

handleGetRestContexts in class WebServiceLogic

Returns:

Collection

See Also:

WebServiceLogic.getRestContexts()

handleGetRestMethod

protected String handleGetRestMethod()

Specified by:

handleGetRestMethod in class WebServiceLogic

Returns:

String

See Also:

WebServiceLogic.getRestMethod()

handleGetRestPath

protected String handleGetRestPath()

Specified by:

handleGetRestPath in class WebServiceLogic

Returns:

String

See Also:

WebServiceLogic.getRestPath()

handleGetRestProduces

protected String handleGetRestProduces()

Specified by:

handleGetRestProduces in class WebServiceLogic

Returns:

String

See Also:

WebServiceLogic.getRestProduces()

handleGetRestProvider

protected String handleGetRestProvider()

Specified by:

handleGetRestProvider in class WebServiceLogic

Returns:

String

See Also:

WebServiceLogic.getRestProvider()

handleGetRestRetention

protected String handleGetRestRetention()

Specified by:

handleGetRestRetention in class WebServiceLogic

Returns:

String

See Also:

WebServiceLogic.getRestRetention()

handleGetRestTarget

protected String handleGetRestTarget()

Specified by:

handleGetRestTarget in class WebServiceLogic

Returns:

String

See Also:

WebServiceLogic.getRestTarget()

handleIsRestAtom

protected boolean handleIsRestAtom()

Specified by:

handleIsRestAtom in class WebServiceLogic

Returns:

boolean

See Also:

WebServiceLogic.handleIsRestAtom()

handleGetRestCount

protected int handleGetRestCount()

Specified by:

handleGetRestCount in class WebServiceLogic

Returns:

int

See Also:

WebServiceLogic.handleGetRestCount()

handleGetJaxwsCount

protected int handleGetJaxwsCount()

Specified by:

handleGetJaxwsCount in class WebServiceLogic

Returns:

int

See Also:

WebServiceLogic.handleGetJaxwsCount()

useEnumValueInXSD

public Boolean useEnumValueInXSD()

Used to map between XML (list of restricted strings) and Java enum (has both a name and a value).

Returns:

useEnumValueInXSD true if EnumerationLiteral.value is used instead of EnumerationLiteral.Name.

validateInvariants

public void validateInvariants(Collection<ModelValidationMessage> validationMessages)

Description copied from class: WebServiceLogic

Constraint: org::andromda::cartridges::webservice::metafacades::WebService::operation name must be unique

Error: A web service can not have more than one operation with the same name, please check the names of your web service operations.

OCL: context WebService inv : allowedOperations -> isUnique(operationName)

Specified by:

validateInvariants in interface ModelElementFacade

Overrides:

validateInvariants in class WebServiceLogic

Parameters:

validationMessages - Collection

See Also:

MetafacadeBase.validateInvariants(Collection validationMessages)