uk.co.visalia.brightpearl.apiclient.auth

Class PublicAppAuthorisation

java.lang.Object

uk.co.visalia.brightpearl.apiclient.auth.PublicAppAuthorisation

All Implemented Interfaces:

AppAuthorisation

public final class PublicAppAuthorisation
extends Object
implements AppAuthorisation

Contains the details of an app, a Brightpearl customer account and the tokens required to verify the app's permission to make API calls to the account.

Field Summary

Fields inherited from interface uk.co.visalia.brightpearl.apiclient.auth.AppAuthorisation

ACCOUNT_TOKEN_HEADER, APP_HEADER, DEV_HEADER, LEGACY_AUTH_HEADER, STAFF_TOKEN_HEADER

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
Account	getAccount() Returns the Brightpearl customer's account.
String	getAccountToken()
PublicAppIdentity	getAppIdentity()
Map<String,String>	getHeaders() Returns authentication headers required for requests made to the customer's account.
String	getStaffToken()
int	hashCode()
static PublicAppAuthorisation	staff(PublicAppIdentity appIdentity, Account account, String staffToken) Create account authorisation details for a staff authorised API call.
static PublicAppAuthorisation	system(PublicAppIdentity appIdentity, Account account, String accountToken) Create account authorisation details for a system-to-system call using an account token.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

system

public static PublicAppAuthorisation system(PublicAppIdentity appIdentity,
                            Account account,
                            String accountToken)

Create account authorisation details for a system-to-system call using an account token.

Parameters:

appIdentity - Identifies the developer and app.

account - Brightpearl customer account details.

accountToken - Account token, signed or unsigned. If it is unsigned, the developer secret is required.

Returns:

authorisation details.

staff

public static PublicAppAuthorisation staff(PublicAppIdentity appIdentity,
                           Account account,
                           String staffToken)

Create account authorisation details for a staff authorised API call.

Parameters:

appIdentity - Identifies the developer and app.

account - Brightpearl customer account details.

staffToken - Account token, signed or unsigned. If it is unsigned, the developer secret is required.

Returns:

authorisation details.

getAppIdentity

public PublicAppIdentity getAppIdentity()

getAccountToken

public String getAccountToken()

getStaffToken

public String getStaffToken()

getAccount

public Account getAccount()

Description copied from interface: AppAuthorisation

Returns the Brightpearl customer's account.

Specified by:

getAccount in interface AppAuthorisation

getHeaders

public Map<String,String> getHeaders()

Description copied from interface: AppAuthorisation

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

Specified by:

getHeaders in interface AppAuthorisation

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object