org.andromda.cartridges.webservice.metafacades

Interface WebService

All Superinterfaces:

ClassifierFacade, GeneralizableElementFacade, ModelElementFacade, Service

All Known Implementing Classes:

WebServiceLogic, WebServiceLogicImpl

public interface WebService
extends Service

Represents a web service. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAllowedMethods() Creates a space delimited string containing a name of ALL allowed methods.
Collection<WSDLType>	getAllowedOperationExceptions() The collection of exceptions from all allowed operations present in this webservice.
Collection<WebServiceOperation>	getAllowedOperations() All operations which are exposed on the web service.
String	getEjbHomeInterface() The home interface name for an EJB provider.
String	getEjbInterface() The interface name for an EJB provider.
String	getEjbJndiName() The JNDI name for the EJB provider (the EJB that provides the functionality behind this web service).
String	getFullyQualifiedTestImplementationName() The fully qualified name of the test implementation class for this web service.
String	getFullyQualifiedTestName() The fully qualified name of a test generated for this web service.
int	getJaxwsCount() Number of REST JAX-RS service methods in this class.
String	getNamespace() The name of the namespace to which this web service belongs.
String	getNamespacePrefix() The namespace prefix used for types defined within the generated WSDLs.
Collection	getPackageReferences(String packageName, boolean follow) TODO: Model Documentation for org.andromda.cartridges.webservice.metafacades.WebService.getPackageReferences
String	getProvider() The provider for this web service.
String	getQName() The QName for this service.
String	getRestCacheType() Specified CacheType (none, always, etc) in @CacheType annotation.
String	getRestConsumes()
Collection<String>	getRestContexts() Context used for REST JAX-WS implementation for this service.
int	getRestCount() Number of REST JAX-RS service methods in this class.
String	getRestMethod() Customized Http Method implementation.
String	getRestPath() The URL path for the REST webservice.
String	getRestProduces()
String	getRestProvider() Customized REST @Provider annotation, must be implemented in the generated class.
String	getRestRetention() Customized RetentionPolicy (default=RUNTIME).
String	getRestTarget() Customized target ElementType, default=METHOD.
String	getRpcClassName() The name of the RPC implementation class.
TypeMappings	getSchemaMappings() TODO: Model Documentation for org.andromda.cartridges.webservice.metafacades.WebService.getSchemaMappings
String	getStyle() The style of binding in the generated WSDL, either DOCUMENT, RPC, or WRAPPED.
String	getTestImplementationName() The name for the test implementation class.
String	getTestName() The name of a the test for this web service.
String	getTestPackageName() The name of the package to which tests are generated.
Collection	getTypeMappingElements() Returns a collection of all type mappings used by this WebServiceFacade.
String	getUse() The use of items in the binding, either LITERAL or ENCODED.
String	getWsdlFile() The location of the WSDL file for this web service.
String	getXjcArguments() Override global default XJC arguments for Jaxb wsdl2java (i.e.
boolean	isDocumentStyle() Indicates whether or not this service is "document" style.
boolean	isEncodedUse() Indicates whether or not this web service has a "encoded" use defined.
boolean	isLiteralUse() Indicates whether or not this web service has a "literal" use defined.
boolean	isRestAtom() If this REST service provides application/atom, or any service operations provide application/atom
boolean	isRpcStyle() Indicates whether or not this service is "rpc" style.
boolean	isSchemaValidation() Validate incoming webservice XML against wsdl/xsd schema
boolean	isSecured() Whether or not this web service is secured (its based on whether or not it has any roles associated to it).
boolean	isSimpleBindingMode() Use Jaxb2 XJC simple binding mode
boolean	isWebServiceMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isWrappedStyle() Indicates whether or not this service style is "wrapped".

Methods inherited from interface org.andromda.metafacades.uml.Service

getAllEntityReferences, getAllMessagingDestinations, getAllRoles, getAllServiceReferences, getEntityReferences, getMessagingDestinations, getRoles, getServiceReferences, isServiceMetaType

Methods inherited from interface org.andromda.metafacades.uml.ClassifierFacade

findAttribute, getAbstractions, getAllAssociatedClasses, getAllProperties, getAllRequiredConstructorParameters, getArray, getArrayName, getAssociatedClasses, getAssociationEnds, getAttributes, getAttributes, getFullyQualifiedArrayName, getImplementationOperations, getImplementedInterfaceList, getInstanceAttributes, getInstanceOperations, getInterfaceAbstractions, getJavaNewString, getJavaNullString, getNavigableConnectingEnds, getNavigableConnectingEnds, getNonArray, getOperationCallFromAttributes, getOperations, getProperties, getProperties, getRequiredConstructorParameters, getSerialVersionUID, getStaticAttributes, getStaticOperations, getSuperClass, getWrapperName, isAbstract, isArrayType, isAssociationClass, isBlobType, isBooleanType, isCharacterType, isClassifierFacadeMetaType, isClobType, isCollectionType, isDataType, isDateType, isDoubleType, isEmbeddedValue, isEnumeration, isFileType, isFloatType, isIntegerType, isInterface, isLeaf, isListType, isLongType, isMapType, isPrimitive, isSetType, isStringType, isTimeType, isWrappedPrimitive

Methods inherited from interface org.andromda.metafacades.uml.GeneralizableElementFacade

findTaggedValue, getAllGeneralizations, getAllSpecializations, getGeneralization, getGeneralizationLinks, getGeneralizationList, getGeneralizationRoot, getGeneralizations, getSpecializations, isGeneralizableElementFacadeMetaType

Methods inherited from interface org.andromda.metafacades.uml.ModelElementFacade

copyTaggedValues, findTaggedValue, findTaggedValues, getBindedFullyQualifiedName, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getId, getKeywords, getLabel, getLanguageMappings, getModel, getName, getPackage, getPackageName, getPackageName, getPackagePath, getQualifiedName, getRootPackage, getSourceDependencies, getStateMachineContext, getStereotypeNames, getStereotypes, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getValidationName, getValidationOwner, getVisibility, hasExactStereotype, hasKeyword, hasStereotype, initialize, isBindingDependenciesPresent, isConstraintsPresent, isDocumentationPresent, isModelElementFacadeMetaType, isReservedWord, isTemplateParametersPresent, isValidIdentifierName, translateConstraint, translateConstraints, translateConstraints, validateInvariants

Method Detail

isWebServiceMetaType

boolean isWebServiceMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getAllowedMethods

String getAllowedMethods()

Creates a space delimited string containing a name of ALL allowed methods.

Returns:

String

getAllowedOperationExceptions

Collection<WSDLType> getAllowedOperationExceptions()

The collection of exceptions from all allowed operations present in this webservice.

Returns:

Collection

getAllowedOperations

Collection<WebServiceOperation> getAllowedOperations()

All operations which are exposed on the web service.

Returns:

Collection

getEjbHomeInterface

String getEjbHomeInterface()

The home interface name for an EJB provider.

Returns:

String

getEjbInterface

String getEjbInterface()

The interface name for an EJB provider.

Returns:

String

getEjbJndiName

String getEjbJndiName()

The JNDI name for the EJB provider (the EJB that provides the functionality behind this web service).

Returns:

String

getFullyQualifiedTestImplementationName

String getFullyQualifiedTestImplementationName()

The fully qualified name of the test implementation class for this web service.

Returns:

String

getFullyQualifiedTestName

String getFullyQualifiedTestName()

The fully qualified name of a test generated for this web service.

Returns:

String

getJaxwsCount

int getJaxwsCount()

Number of REST JAX-RS service methods in this class. If WebService stereotype rest value is true, all methods are REST methods, otherwise this is the count of exposed WebServiceOperations with rest value set to true. This is the only required configuration for implementing REST services, the rest use intelligent defaults which can be overridden.

Returns:

int

getNamespace

String getNamespace()

The name of the namespace to which this web service belongs.

Returns:

String

getNamespacePrefix

String getNamespacePrefix()

The namespace prefix used for types defined within the generated WSDLs.

Returns:

String

getPackageReferences

Collection getPackageReferences(String packageName,
                              boolean follow)

TODO: Model Documentation for org.andromda.cartridges.webservice.metafacades.WebService.getPackageReferences

Parameters:

packageName - String

follow - boolean

Returns:

Collection

getProvider

String getProvider()

The provider for this web service. Provider is something like: 'java:RPC', or 'java:EJB' etc.

Returns:

String

getQName

String getQName()

The QName for this service. Usually it will be the same name as the model element, however it is possible to specify a prefix to give to this name.

Returns:

String

getRestCacheType

String getRestCacheType()

Specified CacheType (none, always, etc) in @CacheType annotation.

Returns:

String

getRestConsumes

String getRestConsumes()

Returns:

String

getRestContexts

Collection<String> getRestContexts()

Context used for REST JAX-WS implementation for this service.

Returns:

Collection

getRestCount

int getRestCount()

Number of REST JAX-RS service methods in this class. If WebService stereotype rest value is true, all methods are REST methods, otherwise this is the count of exposed WebServiceOperations with rest value set to true. This is the only required configuration for implementing REST services, the rest use intelligent defaults which can be overridden.

Returns:

int

getRestMethod

String getRestMethod()

Customized Http Method implementation.

Returns:

String

getRestPath

String getRestPath()

The URL path for the REST webservice. If unspecified, the lowercase /classname/ is used.

Returns:

String

getRestProduces

String getRestProduces()

Returns:

String

getRestProvider

String getRestProvider()

Customized REST @Provider annotation, must be implemented in the generated class.

Returns:

String

getRestRetention

String getRestRetention()

Customized RetentionPolicy (default=RUNTIME).

Returns:

String

getRestTarget

String getRestTarget()

Customized target ElementType, default=METHOD.

Returns:

String

getRpcClassName

String getRpcClassName()

The name of the RPC implementation class.

Returns:

String

getSchemaMappings

TypeMappings getSchemaMappings()

TODO: Model Documentation for org.andromda.cartridges.webservice.metafacades.WebService.getSchemaMappings

Returns:

TypeMappings

getStyle

String getStyle()

The style of binding in the generated WSDL, either DOCUMENT, RPC, or WRAPPED.

Returns:

String

getTestImplementationName

String getTestImplementationName()

The name for the test implementation class.

Returns:

String

getTestName

String getTestName()

The name of a the test for this web service.

Returns:

String

getTestPackageName

String getTestPackageName()

The name of the package to which tests are generated.

Returns:

String

getTypeMappingElements

Collection getTypeMappingElements()

Returns a collection of all type mappings used by this WebServiceFacade. This consists of all complex types that the service may take in as a parameter in an operation or returns and exceptions that this web service throws.

Returns:

Collection

getUse

String getUse()

The use of items in the binding, either LITERAL or ENCODED.

Returns:

String

getWsdlFile

String getWsdlFile()

The location of the WSDL file for this web service.

Returns:

String

getXjcArguments

String getXjcArguments()

Override global default XJC arguments for Jaxb wsdl2java (i.e. add Collection setters, equals, toString methods).

Returns:

String

isDocumentStyle

boolean isDocumentStyle()

Indicates whether or not this service is "document" style.

Returns:

boolean

isEncodedUse

boolean isEncodedUse()

Indicates whether or not this web service has a "encoded" use defined.

Returns:

boolean

isLiteralUse

boolean isLiteralUse()

Indicates whether or not this web service has a "literal" use defined.

Returns:

boolean

isRestAtom

boolean isRestAtom()

If this REST service provides application/atom, or any service operations provide application/atom

Returns:

boolean

isRpcStyle

boolean isRpcStyle()

Indicates whether or not this service is "rpc" style.

Returns:

boolean

isSchemaValidation

boolean isSchemaValidation()

Validate incoming webservice XML against wsdl/xsd schema

Returns:

boolean

isSecured

boolean isSecured()

Whether or not this web service is secured (its based on whether or not it has any roles associated to it).

Returns:

boolean

isSimpleBindingMode

boolean isSimpleBindingMode()

Use Jaxb2 XJC simple binding mode

Returns:

boolean

isWrappedStyle

boolean isWrappedStyle()

Indicates whether or not this service style is "wrapped".

Returns:

boolean