de.espirit.firstspirit.agency
Interface TransferAgent

public interface TransferAgent

Definition for an agent providing means to produce transfer relevant objects.

Since:

4.2.426

See Also:

SpecialistsBroker

Field Summary

static SpecialistType<TransferAgent>

TYPE The agent's techincal type to be used to request the agent from a SpecialistsBroker.

Method Summary

TransferType<String>	getAllTextsType() Convenience accessor providing the transfer type representing an all text access.
<T extends MediaElement> TransferType<Media>	getMediaType(Class<T> clazz) Provides the transfer type for a given FirstSpirit media element type.
TransferType<String>	getStringType() Convenience accessor providing the transfer type for java String based data.
<T extends IDProvider> TransferType<T>	getType(Class<T> clazz) Provides the transfer type for a given FirstSpirit element type.
<T> TransferType<T>	getType(String mime, Class<T> clazz) Provides the transfer type for a given mime descriptor and the class of objects being transferred.

Field Detail

TYPE

static final SpecialistType<TransferAgent> TYPE

The agent's techincal type to be used to request the agent from a SpecialistsBroker.

Since:

4.2.426

See Also:

SpecialistsBroker.requireSpecialist(de.espirit.firstspirit.agency.SpecialistType), SpecialistsBroker.requestSpecialist(de.espirit.firstspirit.agency.SpecialistType)

Method Detail

getType

<T extends IDProvider> TransferType<T> getType(Class<T> clazz)

Provides the transfer type for a given FirstSpirit element type.

Type Parameters:

T - The element's type.

Parameters:

clazz - The FirstSpirit element class.

Returns:

The according transfer type.

Since:

4.2.426

getMediaType

<T extends MediaElement> TransferType<Media> getMediaType(Class<T> clazz)

Provides the transfer type for a given FirstSpirit media element type.

Type Parameters:

T - The element's type.

Parameters:

clazz - The media element's type.

Returns:

The according transfer type.

Since:

4.2.426

getType

<T> TransferType<T> getType(@NotNull
                            String mime,
                            @NotNull
                            Class<T> clazz)

Provides the transfer type for a given mime descriptor and the class of objects being transferred.

Type Parameters:

T - The transferred type.

Parameters:

mime - The mime descriptor.

clazz - The transfer-object's class.

Returns:

The according transfer type.

Since:

4.2.426

getAllTextsType

TransferType<String> getAllTextsType()

Convenience accessor providing the transfer type representing an all text access. While using this type for registering to handle transfers, commodities provided will only be accessible by a concrete textual type (e.g. getType("text/plain", String.class)).

Returns:

The all text transfer type.

Since:

4.2.426

getStringType

TransferType<String> getStringType()

Convenience accessor providing the transfer type for java String based data.

Returns:

The string transfer type.

Since:

4.2.426