Package se.curity.identityserver.sdk.plugin.descriptor

Interface DataAccessProviderPluginDescriptor<C extends Configuration>

All Superinterfaces:

PluginDescriptor<C>

public interface DataAccessProviderPluginDescriptor<C extends Configuration>
extends PluginDescriptor<C>

A Plugin descriptor that describes implementations of DataAccessProvider for Attributes, credentials, Delegation, nonce, sessions, Token and AccountAttributes.

Not all data access provider types need to be provided. Return null from any of the getter methods in this interface if the data access provider returned by the getter is not implemented by this plugin (this is what the default implementation of all getters does). If a type is not provided, it is a runtime error to attempt to use such data source provider in configuration.

Examples of implementations of a data access provider are SQL (the data is obtained via a SQL database) and Webservice (the data is obtained from a web API).

Method Summary

Modifier and Type	Method	Description
default @Nullable Class<? extends AttributeDataAccessProvider>	getAttributeDataAccessProvider()	Gives the implementation type for the AttributeDataAccessProvider that this plugin implements.
default @Nullable Class<? extends BucketDataAccessProvider>	getBucketDataAccessProvider()	Gives the implementation type for the BucketDataAccessProvider that this plugin implements.
default @Nullable Class<? extends CredentialDataAccessProvider>	getCredentialDataAccessProvider()	Gives the implementation type for the CredentialDataAccessProvider that this plugin implements.
default @Nullable Class<? extends DelegationDataAccessProvider>	getDelegationDataAccessProvider()	Gives the implementation type for the DelegationDataAccessProvider that this plugin implements.
default @Nullable Class<? extends DeviceDataAccessProvider>	getDeviceDataAccessProvider()	Gives the implementation type for the DeviceDataAccessProvider that this plugin implements.
default @Nullable Class<? extends DynamicallyRegisteredClientDataAccessProvider>	getDynamicallyRegisteredClientDataAccessProvider()	Gives the implementation type for the DynamicallyRegisteredClientDataAccessProvider that this plugin implements.
default @Nullable Class<? extends NonceDataAccessProvider>	getNonceDataAccessProvider()	Gives the implementation type for the NonceDataAccessProvider that this plugin implements.
default @Nullable Class<? extends SessionDataAccessProvider>	getSessionDataAccessProvider()	Gives the implementation type for the SessionDataAccessProvider that this plugin implements.
default @Nullable Class<? extends TokenDataAccessProvider>	getTokenDataAccessProvider()	Gives the implementation type for the TokenDataAccessProvider that this plugin implements.
default @Nullable Class<? extends UserAccountDataAccessProvider>	getUserAccountDataAccessProvider()	Gives the implementation type for the UserAccountDataAccessProvider that this plugin implements.

Methods inherited from interface se.curity.identityserver.sdk.plugin.PluginDescriptor

createManagedObject, getConfigurationType, getPluginImplementationType

Method Details

getAttributeDataAccessProvider

@Nullable
default @Nullable Class<? extends AttributeDataAccessProvider> getAttributeDataAccessProvider()

Gives the implementation type for the AttributeDataAccessProvider that this plugin implements.

Returns:

The specific AttributeDataAccessProvider class

See Also:

• AttributeDataAccessProvider

getCredentialDataAccessProvider

@Nullable
default @Nullable Class<? extends CredentialDataAccessProvider> getCredentialDataAccessProvider()

Gives the implementation type for the CredentialDataAccessProvider that this plugin implements.

Returns:

The CredentialDataAccessProvider implementation class

See Also:

• CredentialDataAccessProvider

getDelegationDataAccessProvider

@Nullable
default @Nullable Class<? extends DelegationDataAccessProvider> getDelegationDataAccessProvider()

Gives the implementation type for the DelegationDataAccessProvider that this plugin implements.

Returns:

The DelegationDataAccessProvider implementation class

See Also:

• DelegationDataAccessProvider

getNonceDataAccessProvider

@Nullable
default @Nullable Class<? extends NonceDataAccessProvider> getNonceDataAccessProvider()

Gives the implementation type for the NonceDataAccessProvider that this plugin implements.

Returns:

The NonceDataAccessProvider implementation class

See Also:

• NonceDataAccessProvider

getSessionDataAccessProvider

@Nullable
default @Nullable Class<? extends SessionDataAccessProvider> getSessionDataAccessProvider()

Gives the implementation type for the SessionDataAccessProvider that this plugin implements.

Returns:

The SessionDataAccessProvider implementation class

See Also:

• SessionDataAccessProvider

getTokenDataAccessProvider

@Nullable
default @Nullable Class<? extends TokenDataAccessProvider> getTokenDataAccessProvider()

Gives the implementation type for the TokenDataAccessProvider that this plugin implements.

Returns:

The TokenDataAccessProvider implementation class

See Also:

• TokenDataAccessProvider

getUserAccountDataAccessProvider

@Nullable
default @Nullable Class<? extends UserAccountDataAccessProvider> getUserAccountDataAccessProvider()

Gives the implementation type for the UserAccountDataAccessProvider that this plugin implements.

Returns:

The UserAccountDataAccessProvider implementation class

See Also:

• UserAccountDataAccessProvider

getDeviceDataAccessProvider

@Nullable
default @Nullable Class<? extends DeviceDataAccessProvider> getDeviceDataAccessProvider()

Gives the implementation type for the DeviceDataAccessProvider that this plugin implements.

Returns:

The DeviceDataAccessProvider implementation class

See Also:

• DeviceDataAccessProvider

getDynamicallyRegisteredClientDataAccessProvider

@Nullable
default @Nullable Class<? extends DynamicallyRegisteredClientDataAccessProvider> getDynamicallyRegisteredClientDataAccessProvider()

Gives the implementation type for the DynamicallyRegisteredClientDataAccessProvider that this plugin implements.

Returns:

The DynamicallyRegisteredClientDataAccessProvider implementation class

Since:

2.1.0

See Also:

• DynamicallyRegisteredClientDataAccessProvider

getBucketDataAccessProvider

@Nullable
default @Nullable Class<? extends BucketDataAccessProvider> getBucketDataAccessProvider()

Gives the implementation type for the BucketDataAccessProvider that this plugin implements.

Returns:

The BucketDataAccessProvider implementation class

Since:

3.0.0

See Also:

• BucketDataAccessProvider