ch.openchvote.inspectionclient.InspectionClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of inspection-client Show documentation
This module implements the 'verification client' party of the CHVote protocol.
The newest version!
/*
 * Copyright (C) 2024 Berner Fachhochschule https://e-voting.bfh.ch
 *
 *  - This program is free software: you can redistribute it and/or modify                           -
 *  - it under the terms of the GNU Affero General Public License as published by                    -
 *  - the Free Software Foundation, either version 3 of the License, or                              -
 *  - (at your option) any later version.                                                            -
 *  -                                                                                                -
 *  - This program is distributed in the hope that it will be useful,                                -
 *  - but WITHOUT ANY WARRANTY; without even the implied warranty of                                 -
 *  - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                                   -
 *  - GNU General Public License for more details.                                                   -
 *  -                                                                                                -
 *  - You should have received a copy of the GNU Affero General Public License                       -
 *  - along with this program. If not, see .                           -
 */
package ch.openchvote.inspectionclient;

import ch.openchvote.algorithms.AlgorithmService;
import ch.openchvote.framework.annotations.party.Role;
import ch.openchvote.framework.interfaces.UserInterface;
import ch.openchvote.framework.party.Party;
import ch.openchvote.framework.services.RequestResponseService;
import ch.openchvote.inspectionclient.plain.PublicData;

/**
 * This class implements the 'Inspection Client' party of the CHVote protocol. It is a direct subclass of {@link Party}
 * with an additional field {@link InspectionClient#voter} for linking the inspection client to the voter. . The
 * specific role of the inspection client in the protocol is implemented in the classes {@link PublicData} (plain
 * protocol) and {@link ch.openchvote.inspectionclient.writein.PublicData} (write-in protocol) and in corresponding
 * state and task classes.
 */
@Role(ch.openchvote.protocol.roles.InspectionClient.class)
public final class InspectionClient extends Party {

    // algorithm service for preferred language
    private final AlgorithmService algorithmService;

    // the voter using the inspection client
    private final UserInterface.User voter;

    /**
     * Constructs a new instance of this class.
     *
     * @param id          The id of this inspection client
     * @param loggerLevel The logger's mode of operation
     * @param language    The inspection client's programming language for executing algorithms
     * @param voter       The voter using the inspection client
     */
    public InspectionClient(String id, System.Logger.Level loggerLevel, AlgorithmService.Language language, UserInterface.User voter) {
        super(id, loggerLevel);
        this.algorithmService = AlgorithmService.load(language);
        this.voter = voter;
    }

    @Override
    public void subscribeToServices() {
        super.subscribeToServices();

        // subscribe to request/response service as requester
        this.getService(RequestResponseService.Source.class).subscribe(this);
    }

    @Override
    public void unsubscribeFromServices() {
        super.unsubscribeFromServices();

        // unsubscribe from request/response service as requester
        this.getService(RequestResponseService.Source.class).unsubscribe(this);
    }

    /**
     * Return the inspection client's algorithm service.
     *
     * @return The inspection client's algorithm service
     */
    public AlgorithmService getAlgorithmService() {
        return this.algorithmService;
    }

    /**
     * Return the voter using the inspection client.
     *
     * @return The voter using the inspection client.
     */
    public UserInterface.User getVoter() {
        return this.voter;
    }

}