org.andromda.cartridges.webservice.metafacades

Interface WebServiceOperation

All Superinterfaces:

ModelElementFacade, OperationFacade, ServiceOperation

All Known Implementing Classes:

WebServiceOperationLogic, WebServiceOperationLogicImpl

public interface WebServiceOperation
extends ServiceOperation

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getOperationName() Returns the customized operation name.
String	getParameterStyle() WebService parameter style: bare or wrapped
String	getRestCacheType() TODO: Model Documentation for org.andromda.cartridges.webservice.metafacades.WebServiceOperation.restCacheType
String	getRestConsumes()
String	getRestPartType() Multipart/xml type for this returned part.
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	getRestRequestType() HTML request type for this REST service (GET, PUT, POST, QUERY, DELETE), used for method annotations.
int	getRestSuspend() Asynchronous service implementation, suspend execution for X ms.
String	getRestTestPath() The URL path to test the REST webservice.
String	getRolesAllowed() REST security roles allowed.
String	getTestCall() The call for the test that tests this operation.
String	getTestImplementationCall() The method call for the test implementation operation.
String	getTestImplementationName() The name of the the operation used within the test implementation.
String	getTestImplementationSignature() The signature for the test implementation operation.
String	getTestName() The name for the test that tests this operation.
String	getTestSignature() The signature for the test that tests this operation.
WebServicePackage	getWebServicePackage() TODO: Model Documentation for WebServicePackage
boolean	isExposed() Returns true/false depending on whether or not this web service operation is exposed.
boolean	isRest() Is this operation a JAX-RS REST operation? JAX-WS and JAX-RS can be mixed in the same service class.
boolean	isRestAtom() If this REST service provides application/atom, or any service operations provide application/atom
boolean	isRestEncoded()
boolean	isWebFaultOnAllExceptions() Checks is each service exception reference is some Exception type and has stereotype WebFault, if CXF.
boolean	isWebServiceOperationMetaType() Indicates the metafacade type (used for metafacade mappings).

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

getIncomingDestination, getOutgoingDestination, getRoles, getService, isIncomingMessageOperation, isMessageOperation, isOutgoingMessageOperation, isServiceOperationMetaType

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

findParameter, findTaggedValue, getArgumentNames, getArguments, getArgumentTypeNames, getCall, getConcurrency, getExceptionList, getExceptionList, getExceptions, getGetterSetterReturnTypeName, getLower, getMethodBody, getOverriddenOperation, getOwner, getParameters, getPostconditionName, getPostconditions, getPreconditionCall, getPreconditionName, getPreconditions, getPreconditionSignature, getReturnParameter, getReturnType, getSignature, getSignature, getSignature, getTypedArgumentList, getTypedArgumentList, getUpper, isAbstract, isExceptionsPresent, isLeaf, isMany, isOperationFacadeMetaType, isOrdered, isOverriding, isPostconditionsPresent, isPreconditionsPresent, isQuery, isReturnTypePresent, isStatic, isUnique

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

isWebServiceOperationMetaType

boolean isWebServiceOperationMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getOperationName

String getOperationName()

Returns the customized operation name. Defaults to operation.name, can be overridden with WebServiceOperation stereotype operationName attribute. Prevents duplicate operation names in wsdl for overloaded operations.

Returns:

String

getParameterStyle

String getParameterStyle()

WebService parameter style: bare or wrapped

Returns:

String

getRestCacheType

String getRestCacheType()

TODO: Model Documentation for org.andromda.cartridges.webservice.metafacades.WebServiceOperation.restCacheType

Returns:

String

getRestConsumes

String getRestConsumes()

Returns:

String

getRestPartType

String getRestPartType()

Multipart/xml type for this returned part.

Returns:

String

getRestPath

String getRestPath()

The URL path for the REST webservice. If unspecified, the lowercase /operation/parametername/{parametername}/ 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

getRestRequestType

String getRestRequestType()

HTML request type for this REST service (GET, PUT, POST, QUERY, DELETE), used for method annotations.

Returns:

String

getRestSuspend

int getRestSuspend()

Asynchronous service implementation, suspend execution for X ms. Adds @Suspend annotation to the operation. default=synchronous (suspend=0=wait forever).

Returns:

int

getRestTestPath

String getRestTestPath()

The URL path to test the REST webservice. Substitutes test values for {parametername} parts of the service URL.

Returns:

String

getRolesAllowed

String getRolesAllowed()

REST security roles allowed. default=All.

Returns:

String

getTestCall

String getTestCall()

The call for the test that tests this operation.

Returns:

String

getTestImplementationCall

String getTestImplementationCall()

The method call for the test implementation operation.

Returns:

String

getTestImplementationName

String getTestImplementationName()

The name of the the operation used within the test implementation.

Returns:

String

getTestImplementationSignature

String getTestImplementationSignature()

The signature for the test implementation operation.

Returns:

String

getTestName

String getTestName()

The name for the test that tests this operation.

Returns:

String

getTestSignature

String getTestSignature()

The signature for the test that tests this operation.

Returns:

String

getWebServicePackage

WebServicePackage getWebServicePackage()

TODO: Model Documentation for WebServicePackage

Returns:

WebServicePackage

isExposed

boolean isExposed()

Returns true/false depending on whether or not this web service operation is exposed.

Returns:

boolean

isRest

boolean isRest()

Is this operation a JAX-RS REST operation? JAX-WS and JAX-RS can be mixed in the same service class. If false, all rest attributes and methods are ignored.

Returns:

boolean

isRestAtom

boolean isRestAtom()

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

Returns:

boolean

isRestEncoded

boolean isRestEncoded()

Returns:

boolean

isWebFaultOnAllExceptions

boolean isWebFaultOnAllExceptions()

Checks is each service exception reference is some Exception type and has stereotype WebFault, if CXF.

Returns:

boolean