de.bund.bva.isyfact.common.web.tempwebresource.TempWebResourceZugriff Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of isy-web Show documentation

Die IsyFact-Standards bilden das architektonische, technologische und methodische Fundament der IsyFact. Sie umfassen allgemeingültige und wiederverwendbare Konzepte und Komponenten, die für die Entwicklung beliebiger Fachanwendungen relevant sind.

There is a newer version: 6.2.0

Show newest version

/*
 * 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.isyfact.common.web.tempwebresource;

/**
 * Komponentenschnittstelle zum Zugriff auf temporäre Web-Ressourcen.
 *
 */
public interface TempWebResourceZugriff {
    /**
     * Speichert eine temporäre Web-Ressource.
     *
     * @param benutzerkennung
     *            die Kennung des aktuellen Benutzers
     * @param bhknz
     *            das Behördenkennzeichen des aktuellen Benutzers
     * @param ressource
     *            die Binärdaten der Ressource
     * @param kennzeichen
     *            ein Kennzeichen, dass z.B. den Typ der Ressource beschreibt (darf null sein)
     * @param mimeType
     *            der MIME-Type der Ressource
     * @return die gespeicherte TempWebResource
     */
    // XXX benutzerkennung und bhknz sollten nicht explizit übergeben werden, sondern über den
    // AufrufKontextVerwalter geladen werden.
    public TempWebResourceRo speichereTempWebResource(String benutzerkennung, String bhknz, byte[] ressource,
        String kennzeichen, String mimeType);

    /**
     * Speichert eine temporäre Web-Ressource.
     *
     * @param benutzerkennung
     *            die Kennung des aktuellen Benutzers
     * @param bhknz
     *            das Behördenkennzeichen des aktuellen Benutzers
     * @param ressource
     *            die Binärdaten der Ressource
     * @param kennzeichen
     *            ein Kennzeichen, dass z.B. den Typ der Ressource beschreibt (darf null sein)
     * @param mimeType
     *            der MIME-Type der Ressource
     * @param dateiname
     *            der Dateiname der Ressource
     * @return die gespeicherte TempWebResource
     */
    // XXX benutzerkennung und bhknz sollten nicht explizit übergeben werden, sondern über den
    // AufrufKontextVerwalter geladen werden.
    public TempWebResourceRo speichereTempWebResource(String benutzerkennung, String bhknz, byte[] ressource,
        String kennzeichen, String mimeType, String dateiname);

    /**
     * Lädt die temporäre Web-Ressource mit der gegebenen ID.
     *
     * @param id
     *            die ID
     * @param benutzerkennung
     *            die Kennung des aktuellen Benutzers
     * @param bhknz
     *            das Behördenkennzeichen des aktuellen Benutzers
     * @return die gelesene TempWebResource
     * @throws BerechtigungException
     *             falls der Nutzer zu dieser Aktion nicht berechtigt ist.
     */
    // XXX benutzerkennung und bhknz sollten nicht explizit übergeben werden, sondern über den
    // AufrufKontextVerwalter geladen werden.
    public TempWebResourceRo ladeTempWebResource(long id, String benutzerkennung, String bhknz);

    /**
     * Löscht die temporäre Web-Ressource mit der gegebenen ID.
     *
     * @param id
     *            die ID
     * @param benutzerkennung
     *            die Kennung des aktuellen Benutzers
     * @param bhknz
     *            das Behördenkennzeichen des aktuellen Benutzers
     * @throws BerechtigungException
     *             falls der Nutzer zu dieser Aktion nicht berechtigt ist.
     */
    // XXX benutzerkennung und bhknz sollten nicht explizit übergeben werden, sondern über den
    // AufrufKontextVerwalter geladen werden.
    public void loescheTempWebResource(long id, String benutzerkennung, String bhknz);

    /**
     * Löscht alle temporären Web-Ressourcen, die den Kriterien entsprechen.
     *
     * @param benutzerkennung
     *            die Kennung des aktuellen Benutzers
     * @param bhknz
     *            das Behördenkennzeichen des aktuellen Benutzers
     * @param kennzeichen
     *            das Kennzeichen der zu löschenden Ressourcen
     */
    // XXX benutzerkennung und bhknz sollten nicht explizit übergeben werden, sondern über den
    // AufrufKontextVerwalter geladen werden.
    public void loescheTempWebResources(String benutzerkennung, String bhknz, String kennzeichen);
}