uk.co.visalia.brightpearl.apiclient.auth

Class PrivateAppAuthorisation

java.lang.Object

uk.co.visalia.brightpearl.apiclient.auth.PrivateAppAuthorisation

All Implemented Interfaces:

AppAuthorisation

public final class PrivateAppAuthorisation
extends Object
implements AppAuthorisation

Contains the details of a private app, the Brightpearl customer account to which it belongs, and either an account token or a staff token for authorisation of calls to this 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()
PrivateAppIdentity	getAppIdentity()
Map<String,String>	getHeaders() Returns authentication headers required for requests made to the customer's account.
String	getStaffToken()
int	hashCode()
static PrivateAppAuthorisation	staff(PrivateAppIdentity appIdentity, String staffToken) Create account authorisation details for a staff authorised API call for a private app.
static PrivateAppAuthorisation	system(PrivateAppIdentity appIdentity, String accountToken) Create account authorisation details for a private (own account) system-to-system call using the account token generated for a private app.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

system

public static PrivateAppAuthorisation system(PrivateAppIdentity appIdentity,
                             String accountToken)

Create account authorisation details for a private (own account) system-to-system call using the account token generated for a private app.

Parameters:

appIdentity - Details of the private app including the Brightpearl customer account it belongs to.

accountToken - Account token generated for the private app.

Returns:

authorisation details.

staff

public static PrivateAppAuthorisation staff(PrivateAppIdentity appIdentity,
                            String staffToken)

Create account authorisation details for a staff authorised API call for a private app.

Parameters:

appIdentity - Details of the private app including the Brightpearl customer account it belongs to.

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

Returns:

authorisation details.

getAppIdentity

public PrivateAppIdentity 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