com.atlassian.applinks.spi.util

Interface TypeAccessor

public interface TypeAccessor

Provides access to singleton instances of EntityType and ApplicationType and registered AuthenticationProvider classes.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
<T extends ApplicationType> T	getApplicationType(Class<T> typeClass)
Class<? extends AuthenticationProvider>	getAuthenticationProviderClass(String className)
Iterable<? extends ApplicationType>	getEnabledApplicationTypes()
Iterable<? extends EntityType>	getEnabledEntityTypes()
Iterable<? extends EntityType>	getEnabledEntityTypesForApplicationType(ApplicationType applicationType)
<T extends EntityType> T	getEntityType(Class<T> typeClass)
ApplicationType	loadApplicationType(TypeId typeId) Load application type using its unique identifier represented by typeId.
EntityType	loadEntityType(TypeId typeId)

Method Detail

getEntityType

<T extends EntityType> T getEntityType(Class<T> typeClass)

Type Parameters:

T - the type to the typeClass parameter

Parameters:

typeClass - the interface or superclass (extending EntityType of the type to retrieve. Generally this will be a class from a sub-package of com.atlassian.applinks.api.application

Returns:

an instance of the specified EntityType, or null if an implementation of the specified EntityType is not registered via the plugin system.

loadEntityType

EntityType loadEntityType(TypeId typeId)

Parameters:

typeId - the id of the EntityType to retrieve.

Returns:

a specific EntityType with a given ID. Null if no entity with given typeId

getApplicationType

<T extends ApplicationType> T getApplicationType(Class<T> typeClass)

Type Parameters:

T - the type to the typeClass parameter

Parameters:

typeClass - the interface or superclass (extending ApplicationType of the type to retrieve. Generally this will be a class from com.atlassian.applinks.api.application

Returns:

an instance of the specified ApplicationType, or null if an implementation of the specified ApplicationType is not registered via the plugin system.

loadApplicationType

ApplicationType loadApplicationType(TypeId typeId)

Load application type using its unique identifier represented by typeId.

Parameters:

typeId - identifier of the application type to load

Returns:

application type instance, or null if no such application type exists

getAuthenticationProviderClass

Class<? extends AuthenticationProvider> getAuthenticationProviderClass(String className)

Parameters:

className - the full class name of a registered AuthenticationProvider (must be equal to the result of a call to Class.getName()).

Returns:

the Class of the specified AuthenticationProvider

getEnabledEntityTypes

Iterable<? extends EntityType> getEnabledEntityTypes()

Returns:

a collection of all enabled EntityType instances registered via the plugin system

getEnabledEntityTypesForApplicationType

Iterable<? extends EntityType> getEnabledEntityTypesForApplicationType(ApplicationType applicationType)

Returns:

the collection of entity types that are supported by the given ApplicationType.

getEnabledApplicationTypes

Iterable<? extends ApplicationType> getEnabledApplicationTypes()

Returns:

a collection of all enabled ApplicationType instances registered via the plugin system