uk.co.visalia.brightpearl.apiclient.auth

Interface AppAuthorisation

All Known Implementing Classes:

LegacyAuthorisation, PrivateAppAuthorisation, PublicAppAuthorisation

public interface AppAuthorisation

Interface for classes that combine details of an an app with details of an account, providing account details and authentication headers for BrightpearlApiClient.

This interface is generic enough to support all four types of app, which each require different headers, together with legacy auth tokens.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCOUNT_TOKEN_HEADER
static String	APP_HEADER
static String	DEV_HEADER
static String	LEGACY_AUTH_HEADER
static String	STAFF_TOKEN_HEADER

Method Summary

Methods

Modifier and Type	Method and Description
Account	getAccount() Returns the Brightpearl customer's account.
Map<String,String>	getHeaders() Returns authentication headers required for requests made to the customer's account.

Field Detail

DEV_HEADER

static final String DEV_HEADER

See Also:

Constant Field Values

APP_HEADER

static final String APP_HEADER

See Also:

Constant Field Values

ACCOUNT_TOKEN_HEADER

static final String ACCOUNT_TOKEN_HEADER

See Also:

Constant Field Values

STAFF_TOKEN_HEADER

static final String STAFF_TOKEN_HEADER

See Also:

Constant Field Values

LEGACY_AUTH_HEADER

static final String LEGACY_AUTH_HEADER

See Also:

Constant Field Values

Method Detail

getAccount

Account getAccount()

Returns the Brightpearl customer's account.

getHeaders

Map<String,String> getHeaders()

Returns authentication headers required for requests made to the customer's account.