org.andromda.cartridges.spring.metafacades

Interface SpringService

All Superinterfaces:

ClassifierFacade, GeneralizableElementFacade, ModelElementFacade, Service

All Known Implementing Classes:

SpringServiceLogic, SpringServiceLogicImpl

public interface SpringService
extends Service

Represents a Spring service (which can include regular java objects, and/or session EJBs). Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBaseName() The service base class name.
String	getBeanName() The bean name of this service.
String	getBeanName(boolean targetSuffix) Gets the Spring bean name, and optionally adds a target suffix, if 'targetSuffix' is set to true.
String	getDefaultExceptionName() The name of the default exception to be generated for this service.
String	getDestroyMethodName() This is a name of the destroy-method of this service, or is empty if doesn't exists.
String	getEjbImplementationName() The EJB implementation class name.
String	getEjbJndiName() The JNDI name to which a Spring remote Session EJB will be bound.
String	getEjbLocalJndiName() The JNDI name to which a Spring local Session EJB will be bound.
String	getEjbPackageName() This can be either the package name the model element exists within OR it can be the package with a prefix or suffix (i.e.
String	getEjbPackageNamePath() The EJB package name as a path (i.e.
String	getEjbTransactionType() The EJB transaction type (Bean or Container).
String	getFullyQualifiedBaseName() The fully qualified service base class name.
String	getFullyQualifiedDefaultExceptionName() The fully qualified class name of the default exception.
String	getFullyQualifiedEjbImplementationName() The fully qualified name of the implementation class name.
String	getFullyQualifiedEjbName() TODO: Model Documentation for org.andromda.cartridges.spring.metafacades.SpringService.fullyQualifiedEjbName
String	getFullyQualifiedImplementationName() The fully qualified name of the implementation class.
String	getFullyQualifiedLocalEjbName() TODO: Model Documentation for org.andromda.cartridges.spring.metafacades.SpringService.fullyQualifiedLocalEjbName
String	getFullyQualifiedWebServiceDelegatorName() The fully qualified web service delegator class name.
String	getImplementationName() The implementation name of the service
String	getImplementationPackageName() This can be either the package name the model element exists within OR it can be the package with a prefix or suffix (i.e.
String	getImplementationPackagePath() The service implementation package name as a path (i.e.
String	getInitMethodName() This is a name of the init-method of this service, or is empty if doesn't exists.
Collection<String>	getInterceptors() TODO: Model Documentation for org.andromda.cartridges.spring.metafacades.SpringService.interceptors
String	getRemoteContext() Returns the remote context for this service.
String	getRemotePort() Determines which port this service will be published on at the server side.
String	getRemoteServer() Returns the name of the remote server for this service.
String	getRemoteUrl() The URL this servie will be run on at the server side.
String	getWebServiceDelegatorName() The name of the web service delegator class.
String	getWebServiceIncomingAttachmentHandlerCall() The call to the incoming web service attachment call.
Collection<SpringServiceOperation>	getWebServiceOperations() The operations that can be exposed in a webservice.
String	getWebServiceOutgoingAttachmentHandlerCall() The call to the outgoing web service attachment call.
boolean	isAllowDefaultServiceException() Indicates whether or not a default service exception should be allowed.
boolean	isConfigonly() Defines whether this service will only be listed in the config, but note be generated as a Spring bean.
boolean	isEjbLocalView() TODO: Model Documentation for org.andromda.cartridges.spring.metafacades.SpringService.ejbLocalView
boolean	isEjbRemoteView() Indicates if the view type of this service is remote.
boolean	isHibernateInterceptorEnabled() Indicates whether or not the hibernate intercetor is enabled for this service.
boolean	isPrivate() Returns true if the service is considered as private.
boolean	isRemotable() Returns true if this service is remotable.
boolean	isRemotingTypeBurlap() Indicates if the remoting type is "burlap".
boolean	isRemotingTypeHessian() Indicates if the remoting type is "hessian".
boolean	isRemotingTypeHttpInvoker() Indicates if the remoting type is "httpinvoker".
boolean	isRemotingTypeLingo() Indicates whether this service can be talked to using Lingo remoting.
boolean	isRemotingTypeNone() Indicates if the remoting type for this service is "none".
boolean	isRemotingTypeRmi() Indicates if the remoting type is RMI.
boolean	isRichClient() Returns true if this service is meant to take part in a richt client application.
boolean	isSpringServiceMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isWebService() Returns true/false depending on whether or not this SpringService represents a web service.

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

isSpringServiceMetaType

boolean isSpringServiceMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getBaseName

String getBaseName()

The service base class name.

Returns:

String

getBeanName

String getBeanName()

The bean name of this service.

Returns:

String

getBeanName

String getBeanName(boolean targetSuffix)

Gets the Spring bean name, and optionally adds a target suffix, if 'targetSuffix' is set to true.

Parameters:

targetSuffix - boolean

Returns:

String

getDefaultExceptionName

String getDefaultExceptionName()

The name of the default exception to be generated for this service.

Returns:

String

getDestroyMethodName

String getDestroyMethodName()

This is a name of the destroy-method of this service, or is empty if doesn't exists.

Returns:

String

getEjbImplementationName

String getEjbImplementationName()

The EJB implementation class name.

Returns:

String

getEjbJndiName

String getEjbJndiName()

The JNDI name to which a Spring remote Session EJB will be bound.

Returns:

String

getEjbLocalJndiName

String getEjbLocalJndiName()

The JNDI name to which a Spring local Session EJB will be bound.

Returns:

String

getEjbPackageName

String getEjbPackageName()

This can be either the package name the model element exists within OR it can be the package with a prefix or suffix (i.e. the package could have '.ejb') appended to it. This option is available if the EJB is just used a wrapper around a POJO Spring Service.

Returns:

String

getEjbPackageNamePath

String getEjbPackageNamePath()

The EJB package name as a path (i.e. '.' are replaced with '/').

Returns:

String

getEjbTransactionType

String getEjbTransactionType()

The EJB transaction type (Bean or Container).

Returns:

String

getFullyQualifiedBaseName

String getFullyQualifiedBaseName()

The fully qualified service base class name.

Returns:

String

getFullyQualifiedDefaultExceptionName

String getFullyQualifiedDefaultExceptionName()

The fully qualified class name of the default exception.

Returns:

String

getFullyQualifiedEjbImplementationName

String getFullyQualifiedEjbImplementationName()

The fully qualified name of the implementation class name.

Returns:

String

getFullyQualifiedEjbName

String getFullyQualifiedEjbName()

TODO: Model Documentation for org.andromda.cartridges.spring.metafacades.SpringService.fullyQualifiedEjbName

Returns:

String

getFullyQualifiedImplementationName

String getFullyQualifiedImplementationName()

The fully qualified name of the implementation class.

Returns:

String

getFullyQualifiedLocalEjbName

String getFullyQualifiedLocalEjbName()

TODO: Model Documentation for org.andromda.cartridges.spring.metafacades.SpringService.fullyQualifiedLocalEjbName

Returns:

String

getFullyQualifiedWebServiceDelegatorName

String getFullyQualifiedWebServiceDelegatorName()

The fully qualified web service delegator class name.

Returns:

String

getImplementationName

String getImplementationName()

The implementation name of the service

Returns:

String

getImplementationPackageName

String getImplementationPackageName()

This can be either the package name the model element exists within OR it can be the package with a prefix or suffix (i.e. the package could have '.impl') appended to it.

Returns:

String

getImplementationPackagePath

String getImplementationPackagePath()

The service implementation package name as a path (i.e. '.' are replaced with '/').

Returns:

String

getInitMethodName

String getInitMethodName()

This is a name of the init-method of this service, or is empty if doesn't exists.

Returns:

String

getInterceptors

Collection<String> getInterceptors()

TODO: Model Documentation for org.andromda.cartridges.spring.metafacades.SpringService.interceptors

Returns:

Collection

getRemoteContext

String getRemoteContext()

Returns the remote context for this service.

Returns:

String

getRemotePort

String getRemotePort()

Determines which port this service will be published on at the server side.

Returns:

String

getRemoteServer

String getRemoteServer()

Returns the name of the remote server for this service.

Returns:

String

getRemoteUrl

String getRemoteUrl()

The URL this servie will be run on at the server side.

Returns:

String

getWebServiceDelegatorName

String getWebServiceDelegatorName()

The name of the web service delegator class.

Returns:

String

getWebServiceIncomingAttachmentHandlerCall

String getWebServiceIncomingAttachmentHandlerCall()

The call to the incoming web service attachment call.

Returns:

String

getWebServiceOperations

Collection<SpringServiceOperation> getWebServiceOperations()

The operations that can be exposed in a webservice.

Returns:

Collection

getWebServiceOutgoingAttachmentHandlerCall

String getWebServiceOutgoingAttachmentHandlerCall()

The call to the outgoing web service attachment call.

Returns:

String

isAllowDefaultServiceException

boolean isAllowDefaultServiceException()

Indicates whether or not a default service exception should be allowed.

Returns:

boolean

isConfigonly

boolean isConfigonly()

Defines whether this service will only be listed in the config, but note be generated as a Spring bean.

Returns:

boolean

isEjbLocalView

boolean isEjbLocalView()

TODO: Model Documentation for org.andromda.cartridges.spring.metafacades.SpringService.ejbLocalView

Returns:

boolean

isEjbRemoteView

boolean isEjbRemoteView()

Indicates if the view type of this service is remote.

Returns:

boolean

isHibernateInterceptorEnabled

boolean isHibernateInterceptorEnabled()

Indicates whether or not the hibernate intercetor is enabled for this service.

Returns:

boolean

isPrivate

boolean isPrivate()

Returns true if the service is considered as private. Private services are not available through the ServiceLocator, are not exposed via remoting and their methods are not intercepted by transaction manager.

Returns:

boolean

isRemotable

boolean isRemotable()

Returns true if this service is remotable. Derived from remotingType.

Returns:

boolean

isRemotingTypeBurlap

boolean isRemotingTypeBurlap()

Indicates if the remoting type is "burlap".

Returns:

boolean

isRemotingTypeHessian

boolean isRemotingTypeHessian()

Indicates if the remoting type is "hessian".

Returns:

boolean

isRemotingTypeHttpInvoker

boolean isRemotingTypeHttpInvoker()

Indicates if the remoting type is "httpinvoker".

Returns:

boolean

isRemotingTypeLingo

boolean isRemotingTypeLingo()

Indicates whether this service can be talked to using Lingo remoting.

Returns:

boolean

isRemotingTypeNone

boolean isRemotingTypeNone()

Indicates if the remoting type for this service is "none".

Returns:

boolean

isRemotingTypeRmi

boolean isRemotingTypeRmi()

Indicates if the remoting type is RMI.

Returns:

boolean

isRichClient

boolean isRichClient()

Returns true if this service is meant to take part in a richt client application.

Returns:

boolean

isWebService

boolean isWebService()

Returns true/false depending on whether or not this SpringService represents a web service.

Returns:

boolean