com.inductiveautomation.ignition.gateway.auth.web.strategy

Interface WebAuthStrategyAdapter

public interface WebAuthStrategyAdapter

Adapter interface for WebAuthStrategies

Method Summary

Modifier and Type	Method and Description
WebAuthStrategy	create(com.google.gson.JsonElement config) Create an WebAuthStrategy instance based on the given JSON config
java.lang.String	parseState(HttpRequest httpRequest) Parse the state string from the incoming Http Request

Method Detail

create

@Nonnull
WebAuthStrategy create(@Nonnull
                                com.google.gson.JsonElement config)
                         throws WebAuthStrategyAdapterException

Create an WebAuthStrategy instance based on the given JSON config

Parameters:

config - The JSON config for this web auth strategy

Returns:

The WebAuthStrategy instance created for the given JSON config

Throws:

WebAuthStrategyAdapterException - if there was a problem creating an WebAuthStrategy instance for the given JSON 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