Package io.continual.iam.impl.common

Class ApiKeyAuthHelper

java.lang.Object

io.continual.iam.impl.common.ApiKeyAuthHelper

public class ApiKeyAuthHelper
extends Object

Web systems implementing RESTful APIs with API keys can use this helper class to read API key authentication info from the inbound request.

Field Summary

Fields

Modifier and Type	Field	Description
static String	kDefault_AuthLineHeader
static String	kDefault_DateLineHeader
static String	kDefault_MagicLineHeader
static String	kSetting_AuthLineHeader
static String	kSetting_DateLineHeader
static String	kSetting_MagicLineHeader

Constructor Summary

Constructors

Constructor	Description
ApiKeyAuthHelper()

Method Summary

Modifier and Type	Method	Description
static ApiKeyCredential	readApiKeyCredential(NvReadable settings, HeaderReader hr, String serviceName)	Build an ApiKeyCredential from an inbound HTTP header.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

kSetting_AuthLineHeader

public static final String kSetting_AuthLineHeader

See Also:

Constant Field Values

kSetting_DateLineHeader

public static final String kSetting_DateLineHeader

See Also:

Constant Field Values

kSetting_MagicLineHeader

public static final String kSetting_MagicLineHeader

See Also:

Constant Field Values

kDefault_AuthLineHeader

public static final String kDefault_AuthLineHeader

See Also:

Constant Field Values

kDefault_DateLineHeader

public static final String kDefault_DateLineHeader

See Also:

Constant Field Values

kDefault_MagicLineHeader

public static final String kDefault_MagicLineHeader

See Also:

Constant Field Values

Constructor Detail

ApiKeyAuthHelper

public ApiKeyAuthHelper()

Method Detail

readApiKeyCredential

public static ApiKeyCredential readApiKeyCredential(NvReadable settings,
                                                    HeaderReader hr,
                                                    String serviceName)

Build an ApiKeyCredential from an inbound HTTP header.

Parameters:

settings - a settings source

hr - a header reader, to isolate web server tech from this class

serviceName - the name of the service fpr signed content

Returns:

an API key credential, or null if the header is malformed, etc.