Content
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
How to model Service Interfaces
...
When modelling services there is no difference to regular interfaces. As for interfaces all operations of a service including parameters, return type and exceptions have to be defined. In addition the interface has to be marked with the stereotype «JEAFService». Only based on this stereotype JEAF Generator is able to detect a service and then will generate specific code for service interfaces.
...
How to model Service Objects
...
Service Objects define together with service interface (stereotype «JEAFService») the public API of a service. Thereby the services interface define the offered operations of a service. Service objects describe the data than can be exchanged between a service and its client.
...
How to model Enumerations
...
The example above shows how to model enumerations. As you can see in UML model enumerations have to be marked with stereotype «JEANEnumeration». Also attributes are supported for enumerations.
...
How to model Exceptions
...
JEAF’s concept of exception handling distinguishes between two types of exceptions: application and system exceptions. Application exceptions are used to indicate problems that are connected with the business logic of the application like unfulfilled constraints etc. System exceptions are used to indicate technical problems like not available external services or other technical problems.
...
For further information please also refer to:
How to model Query Objects
...
The example above shows an example for a query object. As you can see they are modeled similar to service objects. Also the same rules applies and behavior of JEAF Generator applies to them. Only difference is that they are marked with stereotype «QueryObject».
...
How to model Load Strategy Objects
The Load Strategy Pattern can be used to optimize the amount of objects loaded and returned by a service. Due to optimized loading in general also the amount of service calls can be reduced.
...
How to model REST Services
...
In case that JEAF Services should also be provided as REST Resources then some additional information need to be defined.
...
In addition to normal parameters in case of REST it is also possible to receive paramaters from the path (e.g. /doSomething/{id}) or from the http header or as query paramater. For each of these variants stereotypes are defined («PathParam», «HeaderParam», «QueryParam» and «CookieParam»). These stereotype can be applied on the parameters of an REST Operation («RESTOperation»). In addition it is also supported to group sets of parameters together using so called bean parameters.
For further information please refer to:
How to model Identifiable
...
Stereotype «Identifiable» can be used to mark an object as Identifiable. This means that it can be identified using an ObjectID. The stereotype is intended to be used in combination with stereotypes «DomainObject», «POJO» and «ServiceObject». In case that such kinds of classes will be marked as identifiable then the generated code will respect that.
...