AbstractSynchronizeBackend
, HBCISynchronizeBackend
, ScriptingSynchronizeBackend
public interface SynchronizeBackend
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
QUEUE_ERROR |
Queue, die im Fehlerfall benachrichtigt wird.
|
static java.lang.String |
QUEUE_STATUS |
Queue, an die der aktuelle Prozess-Status der Synchronisierung (RUNNING, ERROR, DONE, CANCEL) geschickt wird.
|
Modifier and Type | Method | Description |
---|---|---|
<T> T |
create(java.lang.Class<? extends SynchronizeJob> type,
Konto konto) |
Liefert eine Instanz des angegebenen Job-Typs.
|
SynchronizeSession |
execute(java.util.List<SynchronizeJob> jobs) |
Fuehrt die uebergebenen Jobs auf dem Backend aus.
|
SynchronizeSession |
getCurrentSession() |
Liefert die aktuelle Session oder NULL wenn gerade keine laeuft.
|
java.lang.String |
getName() |
Liefert einen sprechenden Namen fuer das Backend.
|
java.util.List<java.lang.String> |
getPropertyNames(Konto k) |
Liefert eine optionale Liste mit Property-Namen, die in Hibiscus
in den Sync-Einstellungen als Eingabefelder fuer zusaetzliche Konfigurationsoptionen
angezeigt werden sollen.
|
java.util.List<SynchronizeJob> |
getSynchronizeJobs(Konto k) |
Liefert eine Liste der auszufuehrenden Synchronisierungsjobs auf dem angegebenen Konto.
|
boolean |
supports(java.lang.Class<? extends SynchronizeJob> type,
Konto konto) |
Liefert true, wenn das Backend den angegebenen Job-Typ fuer das angegebene Konto unterstuetzt.
|
static final java.lang.String QUEUE_STATUS
static final java.lang.String QUEUE_ERROR
boolean supports(java.lang.Class<? extends SynchronizeJob> type, Konto konto)
type
- der zu pruefende Job-Typ.konto
- das Konto.<T> T create(java.lang.Class<? extends SynchronizeJob> type, Konto konto) throws de.willuhn.util.ApplicationException
type
- der zu erstellende Job-Typ.konto
- das Konto.de.willuhn.util.ApplicationException
- bei einem Anwendungsfehler.java.util.List<SynchronizeJob> getSynchronizeJobs(Konto k)
k
- das Konto.
Wenn kein Konto angegeben ist, werden die Jobs aller Konten zurueckgeliefert.java.util.List<java.lang.String> getPropertyNames(Konto k)
HibiscusDBObject.getMeta(String, String)
wieder abgerufen werden.
Besitzt ein Property den Suffix "(true/false)" wird es als Checkbox angezeigt.
Besitzt ein Property den Suffix "(pwd)" oder "(password)" wird es als Passwort-Eingabe angezeigt.
Der Suffix wird vor dem Speichern des Property in den Meta-Daten des Konto entfernt.k
- das Konto.SynchronizeSession execute(java.util.List<SynchronizeJob> jobs) throws de.willuhn.util.ApplicationException, de.willuhn.jameica.system.OperationCanceledException
jobs
- die auszufuehrenden Jobs.de.willuhn.util.ApplicationException
- bei einem Anwendungsfehler.de.willuhn.jameica.system.OperationCanceledException
- wenn der User die Synchronisierung abgebrochen hat.SynchronizeSession getCurrentSession()
java.lang.String getName()