Class StorageProviderLocal

java.lang.Object

de.willuhn.jameica.attachment.storage.StorageProviderLocal

All Implemented Interfaces:

StorageProvider

@Lifecycle(CONTEXT)
public class StorageProviderLocal
extends Object
implements StorageProvider

Storage-Provider, der die Speicherung in lokalen Dateien übernimmt.

Constructor Summary

Constructors

Constructor	Description
StorageProviderLocal()

Method Summary

Modifier and Type	Method	Description
void	copy(Attachment a, OutputStream os)	Kopiert das exsitierende Attachment in den angegebenen Stream.
void	create(Attachment a, InputStream is)	Erstellt ein neues Attachment.
void	delete(Attachment a)	Löscht das Attachment.
List<Attachment>	getAttachments(Context ctx)	Liefert die Attachments für den angegebenen Context.
File	getBaseDir()	Liefert das Basis-Verzeichnis für die Speicherung.
String	getCustomBaseDir()	Liefert das abweichende Basis-Verzeichnis für die Speicherung.
File	getDefaultBaseDir()	Liefert das Default-Basis-Verzeichnis.
String	getId()	Liefert einen Identifier für den Storage-Provider.
String	getName()	Liefert einen sprechenden Namen für den Storage-Provider.
boolean	isEnabled()	Liefert true, wenn der Storage-Provider verfügbar ist.
void	setCustomBaseDir(String dir)	Speichert das Basis-Verzeichnis für die Speicherung.
void	update(Attachment a, InputStream is)	Aktualisiert ein Attachment.
boolean	useCustomBaseDir()	Liefert true, wenn ein abweichendes Basis-Verzeichnis für die Sicherung verwendet werden soll.
void	useCustomBaseDir(boolean b)	Legt fest, ob ein abweichendes Basis-Verzeichnis für die Sicherung verwendet werden soll.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StorageProviderLocal

public StorageProviderLocal()

Method Details

getId

public String getId()

Description copied from interface: StorageProvider

Liefert einen Identifier für den Storage-Provider.

Specified by:

getId in interface StorageProvider

Returns:

ein Identifier.

See Also:

• StorageProvider.getId()

isEnabled

public boolean isEnabled()

Description copied from interface: StorageProvider

Liefert true, wenn der Storage-Provider verfügbar ist.

Specified by:

isEnabled in interface StorageProvider

Returns:

true, wenn der Storage-Provider verfügbar ist.

See Also:

• StorageProvider.isEnabled()

getName

public String getName()

Description copied from interface: StorageProvider

Liefert einen sprechenden Namen für den Storage-Provider.

Specified by:

getName in interface StorageProvider

Returns:

sprechender Name für den Storage-Provider.

See Also:

• StorageProvider.getName()

getAttachments

public List<Attachment> getAttachments(Context ctx)
                                throws IOException

Description copied from interface: StorageProvider

Liefert die Attachments für den angegebenen Context. Hierbei werden nur die Informationen zu den Attachments geliefert, nicht der Datei-Inhalt. Der kann per StorageProvider.copy(Attachment, OutputStream) geladen werden.

Specified by:

getAttachments in interface StorageProvider

Parameters:

ctx - der Context.

Returns:

die Attachments.

Throws:

IOException

See Also:

• StorageProvider.getAttachments(de.willuhn.jameica.attachment.Context)

create

public void create(Attachment a,
 InputStream is)
            throws IOException

Description copied from interface: StorageProvider

Erstellt ein neues Attachment.

Specified by:

create in interface StorageProvider

Parameters:

a - das zu erstellende Attachment.

is - Stream mit den Daten des neuen Attachments.

Throws:

IOException

See Also:

• StorageProvider.create(de.willuhn.jameica.attachment.Attachment, java.io.InputStream)

update

public void update(Attachment a,
 InputStream is)
            throws IOException

Description copied from interface: StorageProvider

Aktualisiert ein Attachment.

Specified by:

update in interface StorageProvider

Parameters:

a - das existierende Attachment.

is - Stream mit den aktualisierten Daten.

Throws:

IOException

See Also:

• StorageProvider.update(de.willuhn.jameica.attachment.Attachment, java.io.InputStream)

copy

public void copy(Attachment a,
 OutputStream os)
          throws IOException

Description copied from interface: StorageProvider

Kopiert das exsitierende Attachment in den angegebenen Stream.

Specified by:

copy in interface StorageProvider

Parameters:

a - das existierende Attachment.

os - Stream, in den das Attachment geschrieben wird.

Throws:

IOException

See Also:

• StorageProvider.copy(de.willuhn.jameica.attachment.Attachment, java.io.OutputStream)

delete

public void delete(Attachment a)
            throws IOException

Description copied from interface: StorageProvider

Löscht das Attachment.

Specified by:

delete in interface StorageProvider

Parameters:

a - das zu löschende Attachment.

Throws:

IOException

See Also:

• StorageProvider.delete(de.willuhn.jameica.attachment.Attachment)

getBaseDir

public File getBaseDir()

Liefert das Basis-Verzeichnis für die Speicherung.

Returns:

das Basis-Verzeichnis für die Speicherung.

getDefaultBaseDir

public File getDefaultBaseDir()

Liefert das Default-Basis-Verzeichnis.

Returns:

das Default-Basis-Verzeichnis.

getCustomBaseDir

public String getCustomBaseDir()

Liefert das abweichende Basis-Verzeichnis für die Speicherung.

Returns:

das abweichende Basis-Verzeichnis für die Speicherung.

setCustomBaseDir

public void setCustomBaseDir(String dir)

Speichert das Basis-Verzeichnis für die Speicherung.

Parameters:

dir - das Basis-Verzeichnis für die Speicherung.

useCustomBaseDir

public boolean useCustomBaseDir()

Liefert true, wenn ein abweichendes Basis-Verzeichnis für die Sicherung verwendet werden soll.

Returns:

true, wenn ein abweichendes Basis-Verzeichnis für die Sicherung verwendet werden soll.

useCustomBaseDir

public void useCustomBaseDir(boolean b)

Legt fest, ob ein abweichendes Basis-Verzeichnis für die Sicherung verwendet werden soll.

Parameters:

b - true, wenn ein abweichendes Basis-Verzeichnis für die Sicherung verwendet werden soll.