de.bund.bva.pliscommon.aufrufkontext.AufrufKontext Maven / Gradle / Ivy

Go to download
/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * The Federal Office of Administration (Bundesverwaltungsamt, BVA)
 * licenses this file to you under the Apache License, Version 2.0 (the
 * License). You may not use this file except in compliance with the
 * License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package de.bund.bva.pliscommon.aufrufkontext;

/**
 * Enthält informationen darüber, welcher Nutzer die gerade ausgeführet Berechnung angestoßen hat.
 * 
 */
public interface AufrufKontext {

    /**
     * Getter für die Kennung des Benutzers.
     * @return Wert von durchfuehrenderBenutzerKennung
     */
    public String getDurchfuehrenderBenutzerKennung();

    /**
     * Setter für die Kennung des Benutzers.
     * @param durchfuehrenderBenutzerKennung
     *            Neuer Wert für die Benutzerkennung.
     */
    public void setDurchfuehrenderBenutzerKennung(String durchfuehrenderBenutzerKennung);

    /**
     * Getter für das Passwort des Benutzers.
     * @return Wert von durchfuehrenderBenutzerPasswort
     */
    public String getDurchfuehrenderBenutzerPasswort();

    /**
     * Setter für das Passwort des Benutzers.
     * @param durchfuehrenderBenutzerPasswort
     *            Neuer Wert für durchfuehrenderBenutzerPasswort
     */
    public void setDurchfuehrenderBenutzerPasswort(String durchfuehrenderBenutzerPasswort);

    /**
     * Getter für das Behördenkennzeichen des Benutzers.
     * @return Wert von durchfuehrendeBehoerde
     */
    public String getDurchfuehrendeBehoerde();

    /**
     * Setter für das Behördenkennzeichen des Benutzers.
     * @param durchfuehrendeBehoerde
     *            Neuer Wert für durchfuehrendeBehoerde
     */
    public void setDurchfuehrendeBehoerde(String durchfuehrendeBehoerde);

    /**
     * Getter für die Korrelations-ID. Die Korrelations-ID wird zur eindeutigen Identifikation von
     * Service-Aufrufen verwendet. Sie wird z.B. in Log-Dateien als Logging-Kontext verwendet.
     * @return Wert von korrelationsId
     */
    public String getKorrelationsId();

    /**
     * Setter für die Korrelations-ID. Die Korrelations-ID wird zur eindeutigen Identifikation von
     * Service-Aufrufen verwendet. Sie wird z.B. in Log-Dateien als Logging-Kontext verwendet.
     * @param korrelationsId
     *            Neuer Wert für korrelationsId
     */
    public void setKorrelationsId(String korrelationsId);

    /**
     * Getter für die Rollen des Benutzers.
     * @return Wert von rolle
     */
    public String[] getRolle();

    /**
     * Setter für die Rollen des Benutzers.
     * @param rolle
     *            Neuer Wert für rolle
     */
    public void setRolle(String[] rolle);

    /**
     * Gibt an, ob die Rollen des Nutzer bereits ermittelt wurden oder nicht. Falls hier true angegeben ist
     * und die Liste der RollenIds leer ist, bedeutet dies, dass der Nutzer keinerlei Rollen hat.
     * @return Wert von rollenErmittelt
     */
    public boolean isRollenErmittelt();

    /**
     * Setter für rollenErmittelt.
     * @param rollenErmittelt
     *            Neuer Wert für rollenErmittelt
     */
    public void setRollenErmittelt(boolean rollenErmittelt);

    /**
     * Getter für den Namen des Sachbearbeiters (Endnutzer).
     * 
     * @return Der Name des Sachbearbeiters (Vorname + Nachname)
     */
    public String getDurchfuehrenderSachbearbeiterName();

    /**
     * Setter für den Namen des Sachbearbeiters (Endnutzer).
     * 
     * @param durchfuehrenderSachbearbeiterName
     *            Der Name des Sachbearbeiters (Vorname + Nachname)
     */
    public void setDurchfuehrenderSachbearbeiterName(String durchfuehrenderSachbearbeiterName);

    /**
     * Getter für die interne, unveränderliche Kennung des Benutzers. Diese Kennung kann als dauerhafter
     * Schlüssel für einen Benutzer verwendet werden, z.B. zum Speichern von anwendungsspezifischen
     * Benutzereinstellungen.
     * 
     * 
     * Wichtig: Diese interne Kennung wird aktuell nicht über das {@code AufrufKontextTo}
     * zwischen Systemen übertragen. Sie ist daher für interne Service-Aufrufe nicht befüllt.
     * 
     * 
     * @return Wert von durchfuehrenderBenutzerKennung
     */
    public String getDurchfuehrenderBenutzerInterneKennung();

    /**
     * Setter für die interne, unveränderliche Kennung des Benutzers. Diese Kennung kann als dauerhafter
     * Schlüssel für einen Benutzer verwendet werden, z.B. zum Speichern von anwendungsspezifischen
     * Benutzereinstellungen.
     * 
     * 
     * Wichtig: Diese interne Kennung wird aktuell nicht über das {@code AufrufKontextTo}
     * zwischen Systemen übertragen. Sie ist daher für interne Service-Aufrufe nicht befüllt.
     * 
     * 
     * @param durchfuehrenderBenutzerInterneKennung
     *            Neuer Wert für die Benutzerkennung.
     */
    public void setDurchfuehrenderBenutzerInterneKennung(String durchfuehrenderBenutzerInterneKennung);

}