org.atlasapi.application

Interface ApplicationStore

All Superinterfaces:

IdResolver<Application>

All Known Subinterfaces:

LegacyApplicationStore

All Known Implementing Classes:

AbstractApplicationStore, CacheBackedApplicationStore, LegacyAdaptingApplicationStore

public interface ApplicationStore
extends IdResolver<Application>

Applications connect a configuration to an API key

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<Application>	allApplications()
com.google.common.base.Optional<Application>	applicationFor(Id id) Returns application for a specific ID if it exists
com.google.common.base.Optional<Application>	applicationForKey(String apiKey) Returns an application for an api key passed as part of the request if one exists
Application	createApplication(Application application) Add a new application to store.
Iterable<Application>	readersFor(org.atlasapi.media.entity.Publisher source) Returns all applications that can read data published under this source
Application	updateApplication(Application application) Replaces stored information for an application
Iterable<Application>	writersFor(org.atlasapi.media.entity.Publisher source) Returns all applications that can add data as this source

Methods inherited from interface org.atlasapi.entity.IdResolver

resolveIds

Method Detail

allApplications

Iterable<Application> allApplications()

applicationFor

com.google.common.base.Optional<Application> applicationFor(Id id)

Returns application for a specific ID if it exists

Parameters:

id -

Returns:

Application object if found

createApplication

Application createApplication(Application application)

Add a new application to store. Implementations of this method should ensure that the application gets an ID, slug, API key and created time.

Parameters:

application -

Returns:

Application with newly allocated ID

updateApplication

Application updateApplication(Application application)

Replaces stored information for an application

Parameters:

application -

Returns:

Application object

readersFor

Iterable<Application> readersFor(org.atlasapi.media.entity.Publisher source)

Returns all applications that can read data published under this source

Parameters:

source -

Returns:

Applications with read access to this source

writersFor

Iterable<Application> writersFor(org.atlasapi.media.entity.Publisher source)

Returns all applications that can add data as this source

Parameters:

source -

Returns:

Applications with write access to this source

applicationForKey

com.google.common.base.Optional<Application> applicationForKey(String apiKey)

Returns an application for an api key passed as part of the request if one exists

Parameters:

apiKey - String of api key

Returns:

Application if found