Interface WebAuthStrategyAdapter
-
- All Superinterfaces:
AuthAdapter
public interface WebAuthStrategyAdapter extends AuthAdapter
Adapter interface forWebAuthStrategies
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebAuthStrategy
create(WebAuthStrategyContext context)
Create aWebAuthStrategy
instance based on the given context and config.UserAttributeMapperConfig
defaultUserAttributeMapperConfig()
java.lang.String
getDescription()
java.lang.String
getName()
WebAuthStrategyConfig
importProviderMetadata(java.io.Reader providerMetadataReader)
Import provider metadata and parse into aWebAuthStrategyConfig
com.inductiveautomation.ignition.common.gson.JsonElement
onConfigChange(com.inductiveautomation.ignition.common.gson.JsonElement config)
Called any time aWebAuthStrategyConfig's
config is changed (whether an existing config was updated or a new config was created).java.lang.String
parseState(HttpRequest httpRequest)
Parse the state string from the incoming Http Request-
Methods inherited from interface com.inductiveautomation.ignition.gateway.auth.adapter.AuthAdapter
getType
-
-
-
-
Method Detail
-
getName
@Nonnull java.lang.String getName()
- Returns:
- this
WebAuthStrategyAdapter's
human-readable name
-
getDescription
@Nonnull java.lang.String getDescription()
- Returns:
- this
WebAuthStrategyAdapter's
human-readable description
-
create
@Nonnull WebAuthStrategy create(@Nonnull WebAuthStrategyContext context) throws WebAuthStrategyAdapterException
Create aWebAuthStrategy
instance based on the given context and config.- Parameters:
context
- the context in which this web auth strategy is created- Returns:
- The
WebAuthStrategy
instance created for the given context and config - Throws:
WebAuthStrategyAdapterException
- if there was a problem creating aWebAuthStrategy
instance for the given context and config
-
parseState
@Nonnull java.lang.String parseState(@Nonnull HttpRequest httpRequest) throws WebAuthStrategyAdapterException
Parse the state string from the incoming Http Request- Parameters:
httpRequest
- The incoming Http Request- Returns:
- the state string parsed from the incoming Http Request
- Throws:
WebAuthStrategyAdapterException
- if there is a problem parsing the state string from the incoming Http Request
-
importProviderMetadata
@Nonnull WebAuthStrategyConfig importProviderMetadata(@Nonnull java.io.Reader providerMetadataReader) throws WebAuthStrategyAdapterException
Import provider metadata and parse into aWebAuthStrategyConfig
- Parameters:
providerMetadataReader
- theReader
which provides the provider metadata- Returns:
- the parsed
WebAuthStrategyConfig
- Throws:
WebAuthStrategyAdapterException
- if there is an unexpected problem importing provider metadata
-
defaultUserAttributeMapperConfig
@Nonnull UserAttributeMapperConfig defaultUserAttributeMapperConfig()
- Returns:
- the default
UserAttributeMapperConfig
for thisWebAuthStrategyAdapter
-
onConfigChange
@Nonnull com.inductiveautomation.ignition.common.gson.JsonElement onConfigChange(@Nonnull com.inductiveautomation.ignition.common.gson.JsonElement config) throws WebAuthStrategyAdapterException
Called any time a
WebAuthStrategyConfig's
config is changed (whether an existing config was updated or a new config was created). TheWebAuthStrategyAdapter
has the opportunity to:- Check if the config properly de-serializes into the expected shape
- Transform the config in any way before it is persisted and used by the system
- Parameters:
config
- the new or changed config- Returns:
- the transformed config
- Throws:
WebAuthStrategyAdapterException
- if there is an unexpected problem processing the config change
-
-