Basic concepts
Having in mind definition of a SOA and also good practices of a software development we have designed Service layer around a few standard principles:
- Reusability
- Encapsulation
- Easy configuration
- Extensibility
- Separation of concerns
Logical components
- GatewayRequestInterface
- AdapterInterface
- GatewayInterface
- ResponseDomainMapperInterface
- LoggerInterface
Core ideas
- Request contract represents basic contract for wrapping mandatory parameters for service execution - endpoint URL, headers, request body and HTTP method. Reusability is ensured by name of a request - because it contains all necessary information and is properly named, it can be initialized and reused in any place.
- Response minimalistic contract represents any response
that can be emitted from adapter context. Because there are many differences in between
connection response and domain response, we have defined two separate contracts for each case:
- EndpointResponse represents connection response context agnostic response, that only knows whether the request was successful (by reading HTTP status code) and has access to the response body.
- DomainResponseInterface represents domain response wrapper that is able to retrieve specific domain object.
- Adapter contract represents wrapper for any adapter capable of sending of a HTTP requests.
- Mapper contract represents a component capable of mapping EndpointResponse onto DomainResponseInterface
- GatewayUseCase contract represents one specific use case - request with all the necessary configuration and means to override its one time configuration.
- GatewayUseCaseRegistry contract represents registry of gateway use cases and predefines required structure for the necessary configuration with the capability to override each part of a communication.
Model
In the following diagram the core list of classes is shown along with their relations:
