Package org.apache.jackrabbit.oak.spi.security

Interface SecurityProvider

All Known Implementing Classes:

OpenSecurityProvider

@ProviderType
public interface SecurityProvider

Main entry point for security related plugins to an Oak repository. The interface allow to access the available SecurityConfigurations defining the individual plugins. In addition this provider gives access to the configuration parameters that apply to the configurations with the specified name.

Method Summary

Modifier and Type	Method	Description
<T> T	getConfiguration(@NotNull java.lang.Class<T> configClass)	Returns the security configuration of the specified configClass.
@NotNull java.lang.Iterable<? extends SecurityConfiguration>	getConfigurations()	Returns all available SecurityConfigurations.
@NotNull ConfigurationParameters	getParameters(@Nullable java.lang.String name)	Allows to retrieve the configuration parameters associated with a given SecurityConfiguration accessible by this provider.

Method Detail

getParameters

@NotNull
@NotNull ConfigurationParameters getParameters(@Nullable
                                               @Nullable java.lang.String name)

Allows to retrieve the configuration parameters associated with a given SecurityConfiguration accessible by this provider. If the specified name is null the global config parameters will be returned.

Parameters:

name - The name of the security configuration.

Returns:

The configuration parameters associated with the SecurityConfiguration identified by the specified name. If the specified name is null the global config parameters will be returned.

getConfigurations

@NotNull
@NotNull java.lang.Iterable<? extends SecurityConfiguration> getConfigurations()

Returns all available SecurityConfigurations.

Returns:

the available SecurityConfigurations.

getConfiguration

@NotNull
<T> T getConfiguration(@NotNull
                       @NotNull java.lang.Class<T> configClass)

Returns the security configuration of the specified configClass.

Type Parameters:

T -

Parameters:

configClass - The class of the configuration to retrieve.

Returns:

The desired security configuration.