References
- CPS-2240Getting issue details... STATUS
Issues & Decisions
Issue | Notes | Decision | |
---|---|---|---|
1 | use api and impl folders | Team agreed on separate top level ap and impl folders. Common impl folders can be at top level ie. not under impl. | |
2 | use feature based packages | Team agreed to use the current 4 services (or 5 depending on inventory) as feature folders directly under api and impl
| |
3 | when to use common packages | when in doubt use common package ie exceptions might be re-used for otrerh features in teh futures | |
4 | scope | currently only ncmp-service in scope. | |
5 | plan | team agreed to do trial with 'datajobs' first. Code need to be reviewed by both teams. Once this is completed we will adress 'legacy' services |
Proposed Generic Structure
api\feature1\SomeService.class api\feature1\models\SpecificModelClass api\feature1\exceptions\SpecificException.class api\feature2\SomeService.class api\feature2\models\SpecificModelclass api\feature2\exceptions\SpecificException.class api\models\CommonModel.class api\exeptions\CommonException.class impl\feature1\SomeServiceImpl.class impl\feature1\helperPackage\SpecificHelper.class impl\feature2\SomeServiceImpl.class exceptions\someInternalException.class utils\CommonHelper.class
Proposed DataJobs Structure
Proposed structure (not complete but indicative):
api\datajobs\DataJobsService.class api\datajobs\models\DataJobMetadata.class api\datajobs\models\DataJobReadRequest.class api\datajobs\models\DataJobWriteRequest.class impl\datajobs\DataJobsServiceImpl.class exceptions\NoAlternateIdParentFoundException.class utils\AlternateIdMatcher.class