Käsitteet
Käsite | Selite |
---|---|
Palvelu | Palvelu ovat joukko kiinteästi yhteenkuuluvia toimintoja ja ovat mahdollisimman autonomisia. Palvelut koostuvat moduulesta. |
Moduuli | Joukko yhteenkuuluvia toimintoja, mutta joita ei ole järkevää erottaa omiksi palveluiksi. Moduuli koostuu komponenteista. |
Komponentti | Palvelualustaan tai käyttöliittymäkerrokseen asennettavia asennuspaketteja(jar tai war). Huomaa että komponentti käsite esiintyy myös http://wiki.osgi.org/wiki/Declarative_Services |
Nimeäminen
Projektin nimi sisäisesti: studentregistry
Maven konfiguraatoissa käytettävä groupId: com.eduix.studentregistry
Pakkausten nimi: com.eduix.studentregistry.<moduulin nimi>
Domain pakkauksen nimi: com.eduix.studentregistry.<moduulin nimi>.domain
Service pakkauksen nimi: com.eduix.studentregistry.<moduulin nimi>.service
Katso myös tarkempi tekninen kuvaus rajapintojen toteutuksesta.
1. Henkilötietopalvelu
identity-registry-management
Palvelukerroksen komponentit: identity-registry-management-api, identity-registry-management-impl, identity-registry-management-client
Rajapinta | Käyttötapaus |
---|---|
IdentityRegistryService |
|
IdentityRegistryServiceRest | Ulospäin näkyvä rest rajapinta IdentityRegistry-rajapinnasta |
StudentRegistryService | |
StudentRegistryServiceRest | |
StudentRegistryStudentServiceRest | Rajapinta jonka kautta opiskelija voi muokata henkilötietojaan (käytännössä vain osaa henkilötiedoistaan) |
identity-registry-student
Palvelukerroksen komponentit: identity-registry-student-impl, identity-registry-student-client
Rajapinta | Käyttötapaus |
---|---|
IdentityRegistryService | D005a, henkilö ylläpitää omia tietojaan järjestelmässä |
IdentityRegistryServiceRest | Ulospäin näkyvä rest rajapinta IdentityRegistry-rajapinnasta |
Huomio: Nämä mahdollisesti StudentRegistryStudentServiceRestin kautta eikä omana rajapintanaan.
2. Opiskelijapalvelu
Opiskelijapalvelu on varsin suuri palvelu, joten se jakautuu pienempiin moduuleihin.
Tämä taso on kokoava, ja käsittää perusrekisterin keskeisimmät toiminnot.
2.1 Moduulit
study-management
Moduuli study-management käsittää ylläpidon puolen opiskelijapalveluiden rajapinnoista, nimenomaan opintoihin liittyvän osuuden. Näihin palveluihin ei ole suoraa pääsyä opiskelijapuolelta.
Rajapinta | Käyttötapaus |
---|---|
SemesterEnrollmentService | Läsnäolojen/lukukausi-ilmoittautumisten hallinta |
SemesterEnrollmentServiceRest | Ylläpitopuolen läsnäolojen hallinta |
StudyAccomplishmentService | Opintosuoritusten hallinta |
StudyAccomplishmentServiceRest | Ylläpitopuolen opintosuoritusten hallinta
|
StudyEnrollmentService | Ylläpidon
|
StudyEnrollmentServiceRest |
study-entitlement-management
Tämä moduuli käsittää opiskeluoikeuden hallinnan ylläpitäjän näkökulmasta.
Rajapinta | Käyttötapaus |
---|---|
StudentGroupService | Ryhmien hallinta |
StudentGroupServiceRest | Ryhmien hallinnan REST-rajapinta |
StudyEntitlementService | Opiskeluoikeuksien hallinta |
StudyEntitlementServiceRest | Opiskeluoikeuksien hallinnan REST-rajapinta |
StudyEntitlementStudentServiceRest | Opiskelijan näkökulmasta tehty opiskeluoikeusrajapinta |
study-student
Moduulin avulla julkaistaan opiskelijalle näkyvät toiminnot. Tämä mahdollistaa sen että moduuleja voidaan ajaa omalla palvelimella. Mikäli esimerkiksi integraatioihin tai henkilökunnan toimintoihin tehdään muutoksia, ne eivät näy opiskelijan palveluihin. Lisäksi jako parantaa tietoturvaa/tietosuojaa koska opiskelijalla ei ole mitään mahdollisuutta päästä käsiksi muihin rajapintoihin/toimintoihin.
Tämä moduuli keskittyy opintoihin.
Rajapinta | Käyttötapaus |
---|---|
SemesterEnrollmentStudentServiceRest |
|
StudyAccomplishmentStudentServiceRest | Opiskelijan versio opintosuoritusten hallinnasta
|
StudyEnrollmentStudentServiceRest |
|
study-entitlement-student
Tämä moduuli tarjoaa opiskelijaperspektiivin opinto-oikeuksiin.
Rajapinta | Käyttötapaus |
---|---|
StudyEntitlementStudentServiceRest | Opiskelijan näkökulmasta tehty opiskeluoikeusrajapinta |
3. Koodisto- ja konfiguraatiopalvelu
Palvelukerroksen komponentit: configuration-api, configuration-impl, configuration-client
Rajapinta | Käyttötapaus |
---|---|
ConfigurationCodes | B002, pääkäyttäjä hallinnoi koodistoja B002h |
ConfigurationCodesRest | Ulospäin näkyvä rest rajapinta ConfigurationCodes-rajapinnasta |
CodeProvider | Koodistojen apurajapinta, käytännössä Pepistä haetut koodistot tarjotaan "proxyttavan" providerin läpi; mahdollistaa muun koodistolähteen käyttämisen |
SemesterProvider | Lukukausien apurajapinta, katso ylempi kommentti. |
4. Raportointipavelu
Nimi: reporting-service
4.1 Moduulit
report
Palvelukerroksen komponentit: report-student-api, report-student-impl, report-student-client
Rajapinta | Käyttötapaus |
---|---|
ReportStudent | Opiskelijan raportit |
ReportStudentRest |
report-management
Palvelukerroksen komponentit: report-api, report-impl, report-client
Rajapinta | Käyttötapaus |
---|---|
Report | Opettajan raportit |
ReportRest | |
ReportTemplate | Raporttipohjien hallinta |
ReportTemplateRest |
5. Lokipalvelu
Nimi: log
5.1 Moduulit
log
Palvelukerroksen komponentit: log-api, log-impl, log-client
Rajapinta | Käyttötapaus |
---|---|
Log |
|
LogRest | REST-rajapinta lokien selaamista varten (ei itsessään lokien kirjoittamista, lokitus tapahtuu aina palvelukerroksessa) |
- käyttöliittymät lokien katseluun
5. Integraatio-palvelu
Nimi: integration-service
5.1 Moduulit
data-transfer
- rajapinnat "karkea rakeisia"
- Varsinaiset integraatio sijaitsevat muualla, eli integraatiomoduulin vastuulla huolehtia ettei tätä rajapintaa kuormiteta liikaa.
Palvelukerroksen komponentit: data-transfer-api, data-transfer-impl, data-transfer-client
Rajapinta | Käyttötapaus |
---|---|
DataTransferRest | virta-datan tuonti järjestelmään. Ei tarvetta sisäiselle rajapinnalle väestörekisteri integraatio, henkilön tietojen päivitys väestörekisteristä Hakijoiden tuonti KSHJ-palvelusta |
6. Muut moduulit
data-import
Sisältö:
- integraatio joka hakee virta-skeeman mukaiset viestit ja välittää ne data-transfer moduulin rajapinnoille. Käytetään vain kehityksen aikana sekä käyttöönotossa.
indexing-service
Palvelu joka keskustelee toisten palveluiden kanssa indeksoidakseen niiden dataa ElasticSearch-indeksiin. Indeksointi palvelee kehittyneitä hakutoimintoja, sekä mahdollisesti raportointitoimintoja.
permission-service
Palvelu johon tallennetaan
Rajapinta | Käyttötapaus |
---|---|
PermissionService | Käyttöoikeuksien hallinta |
PermissionServiceRest | Käyttöoikeuksien hallinnan käyttöliittymää palveleva REST-rajapinta Voidaan käyttää myös käyttöoikeuksien tarkistamiseen, jotta käyttöliittymässä ei tarvitse näyttää linkkejä tai painikkeita toimintoihin joihin ei ole oikeuksia. |
system-info
Diagnoositietoa järjestelmästä tarjoava palvelu.
Rajapinta | Käyttötapaus |
---|---|
SystemInfo | Tarjoaa moduulien versiotietoja, ei nimenomaista käyttötapausta |
SystemInfoRest | REST-rajapinta versiotiedoille |