Module qilletni.api

Package dev.qilletni.api.auth

Interface ServiceProvider

public interface ServiceProvider

A service provider interface that facilitates the management of music-related resources and operations, including caching, fetching, orchestration, and type conversion. This may be switched by the Qilletni program through the use of a DynamicProvider.

Method Summary

Modifier and Type	Method	Description
MusicCache	getMusicCache()	Gets the MusicCache created after initialization.
MusicFetcher	getMusicFetcher()	Gets the MusicFetcher created after initialization.
MusicTypeConverter	getMusicTypeConverter()	Gets the MusicTypeConverter created after initialization.
String	getName()	Gets the name of the provider.
PlayActor	getPlayActor()	Gets the PlayActor created after initialization.
StringIdentifier	getStringIdentifier(SongTypeFactory songTypeFactory, CollectionTypeFactory collectionTypeFactory, AlbumTypeFactory albumTypeFactory)	Gets the StringIdentifier.
TrackOrchestrator	getTrackOrchestrator()	Gets the TrackOrchestrator created after initialization.
CompletableFuture<Void>	initialize(BiFunction<PlayActor,MusicCache,TrackOrchestrator> defaultTrackOrchestratorFunction, PackageConfig packageConfig)	Initializes the service provider.
void	shutdown()	Shuts down the service provider.

Method Details

initialize

CompletableFuture<Void> initialize(BiFunction<PlayActor,MusicCache,TrackOrchestrator> defaultTrackOrchestratorFunction,
 PackageConfig packageConfig)

Initializes the service provider. This populates getMusicCache(), getMusicFetcher(), and getTrackOrchestrator().

Parameters:

defaultTrackOrchestratorFunction - If the service provider doesn't implement a custom, TrackOrchestrator, it should run this function to create the default implementation of one and use it.

packageConfig - The PackageConfig for the service provider. This provides persistent storage for the package. Use PackageConfig.loadConfig() to load the configuration.

Returns:

The created future of the initialization

shutdown

void shutdown()

Shuts down the service provider. This should clean up any async tasks currently running.

getName

String getName()

Gets the name of the provider.

Returns:

The provider's name

getMusicCache

MusicCache getMusicCache()

Gets the MusicCache created after initialization.

Returns:

The created MusicCache

getMusicFetcher

MusicFetcher getMusicFetcher()

Gets the MusicFetcher created after initialization.

Returns:

The created MusicFetcher

getTrackOrchestrator

TrackOrchestrator getTrackOrchestrator()

Gets the TrackOrchestrator created after initialization.

Returns:

The created TrackOrchestrator

getMusicTypeConverter

MusicTypeConverter getMusicTypeConverter()

Gets the MusicTypeConverter created after initialization.

Returns:

The created MusicTypeConverter

getStringIdentifier

StringIdentifier getStringIdentifier(SongTypeFactory songTypeFactory,
 CollectionTypeFactory collectionTypeFactory,
 AlbumTypeFactory albumTypeFactory)

Gets the StringIdentifier.

Returns:

The created StringIdentifier

getPlayActor

PlayActor getPlayActor()

Gets the PlayActor created after initialization.

Returns:

The created PlayActor