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 |
|---|---|
| IdentityRegistryManagementService |
|
| IdentityRegistryManagementServiceRest | Ulospäin näkyvä rest rajapinta IdentityRegistry-rajapinnasta |
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 |
2. Opiskelijapalvelu
Opiskelijapalvelu on varsin suuri palvelu, joten se jakautuu pienempiin moduuleihin.
Nimi: student-service
2.1 Moduulit
enrollment-student ja person-registry moduulit sisältävät vain opiskelijalle tarkoitetut 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.
study-management
Palvelukerroksen komponentit: enrollment-api, enrollment-impl, enrollment-client
| Rajapinta | Käyttötapaus |
|---|---|
EnrollmentService |
|
| EnrollmentServiceRest | Ulospäin näkyvä rest rajapinta Enrollment-rajapinnasta |
| AssessmentService |
|
| AssessmentServiceRest | Ulospäin näkyvä rest rajapinta Assessment-rajapinnasta |
| EnrollmentManagement |
|
| EnrollmentManagementRest | Ulospäin näkyvä rest rajapinta Enrollmentmanagement-rajapinnasta |
| AssessmentManagement |
|
| AssessmentManagementRest | Ulospäin näkyvä rest rajapinta AssessmentManagement-rajapinnasta |
study-student
Moduulin avulla julkaistaan opiskelijalle näkyvät toiminnot.
Palvelukerroksen komponentit: study-student-impl, study-student-client
study-entitlement-management
| StudyEntitlementManagementService | a006D opiskelijaroolin tiedot opiskelijaoikeuteen liittyvät toiminnot |
C010 opiskelijalle nimetään ohjaaja | |
study-entitlement-student
| StudyEntitlementService | Opiskeluoikeuden tiedot |
group
Ryhmien haku
group-management
ryhmien hallinta. Tämä täytyy vielä katsoa suhteessa pepin opiskelijaryhmiin.
Palvelukerroksen komponentit: group-management-api, group-management-impl, group-management-client
| Rajapinta | Käyttötapaus |
|---|---|
| Group | A001a, saapumisryhmän luominen A006b1, hakijan siirto opiskelijaksi |
| GroupRest | Ulospäin näkyvä rest rajapinta GroupManagement-rajapinnasta |
configuration
Palvelukerroksen komponentit: configuration-api, configuration-impl, configuration-client
| Rajapinta | Käyttötapaus |
|---|---|
| ConfigurationEnrollment | B001, läsnäoloilmoittautumisajat |
| ConfigurationEnrollmentRest | Ulospäin näkyvä rest rajapinta ConfigurationEnrollment-rajapinnasta |
| ConfigurationCodes | B002, pääkäyttäjä hallinnoi koodistoja B002h |
| ConfigurationCodesRest | Ulospäin näkyvä rest rajapinta ConfigurationCodes-rajapinnasta |
| ConfigurationOrganisation | organisaatioluettelo(synkronoidaan jostain kansallisesta palvelusta?) |
| ConfigurationOrganisationRest | Ulospäin näkyvä rest rajapinta ConfigurationOrganisation-rajapinnasta |
3. Raportointipavelu
Nimi: reporting-service
3.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 |
4. Lokipalvelu
Nimi: log-service
4.1 Moduulit
audit-log
Palvelukerroksen komponentit: audit-log-api, audit-log-impl, audit-log-client
| Rajapinta | Käyttötapaus |
|---|---|
| AuditLog | tapahtumien tallennus auditointia varten |
- 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
- 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.