Package com.yahoo.vespa.hosted.controller.api.integration.billing

Class BillingDatabaseClientMock

java.lang.Object

com.yahoo.vespa.hosted.controller.api.integration.billing.BillingDatabaseClientMock

All Implemented Interfaces:

BillingDatabaseClient

public class BillingDatabaseClientMock
extends Object
implements BillingDatabaseClient

Author:

olaa

Constructor Summary

Constructors

Constructor	Description
BillingDatabaseClientMock(Clock clock, PlanRegistry planRegistry)

Method Summary

Modifier and Type	Method	Description
String	addLineItem(com.yahoo.config.provision.TenantName tenantName, Bill.LineItem lineItem, Optional<Bill.Id> invoiceId)	Add a line item to an open bill
void	commitLineItems(com.yahoo.config.provision.TenantName tenantName, Bill.Id invoiceId)	Associate all uncommitted line items to a given bill This is only allowed if the line item has not already been associated with an bill
Bill.Id	createBill(com.yahoo.config.provision.TenantName tenant, ZonedDateTime startTime, ZonedDateTime endTime, String agent)	Create a completely new Bill in the open state with no LineItems.
void	deactivateDefaultPaymentInstrument(com.yahoo.config.provision.TenantName tenant)	Deactivates the default payment instrument for a tenant, if it exists.
void	deleteLineItem(String lineItemId)	Delete a line item This is only allowed if the line item has not yet been associated with an bill
Optional<CollectionMethod>	getCollectionMethod(com.yahoo.config.provision.TenantName tenantName)	Get the current collection method for the tenant - if one has persisted
Optional<InstrumentOwner>	getDefaultPaymentInstrumentForTenant(com.yahoo.config.provision.TenantName tenantName)
Optional<Plan>	getPlan(com.yahoo.config.provision.TenantName tenantName)	Return the plan for the given tenant
Map<com.yahoo.config.provision.TenantName,Optional<Plan>>	getPlans(List<com.yahoo.config.provision.TenantName> tenants)	Return the plan for the given tenants if present.
BillStatus	getStatus(Bill.Id invoiceId)
List<Bill.LineItem>	getUnusedLineItems(com.yahoo.config.provision.TenantName tenantName)
void	maintain()	Performs necessary maintenance operations
Optional<Bill>	readBill(Bill.Id billId)	Read the given bill from the data source
List<Bill>	readBills()	Read all bills, ordered by date
List<Bill>	readBillsForTenant(com.yahoo.config.provision.TenantName tenant)	Get all bills for a given tenant, ordered by date
boolean	setActivePaymentInstrument(InstrumentOwner paymentInstrument)
void	setCollectionMethod(com.yahoo.config.provision.TenantName tenantName, CollectionMethod collectionMethod)	Set the collection method for the tenant
void	setExportedInvoiceId(Bill.Id billId, String invoiceId)	Set the invoice id from an external system for the given bill
void	setExportedInvoiceItemId(String lineItemId, String invoiceItemId)	Set the invoice item id from an external system for the given line item
void	setPlan(com.yahoo.config.provision.TenantName tenantName, Plan plan)	Set the current plan for the given tenant
void	setStatus(Bill.Id invoiceId, String agent, BillStatus status)	Set status for the given bill

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.vespa.hosted.controller.api.integration.billing.BillingDatabaseClient

getPlanCount

Constructor Details

BillingDatabaseClientMock

public BillingDatabaseClientMock(Clock clock,
 PlanRegistry planRegistry)

Method Details

setActivePaymentInstrument

public boolean setActivePaymentInstrument(InstrumentOwner paymentInstrument)

Specified by:

setActivePaymentInstrument in interface BillingDatabaseClient

getDefaultPaymentInstrumentForTenant

public Optional<InstrumentOwner> getDefaultPaymentInstrumentForTenant(com.yahoo.config.provision.TenantName tenantName)

Specified by:

getDefaultPaymentInstrumentForTenant in interface BillingDatabaseClient

getStatus

public BillStatus getStatus(Bill.Id invoiceId)

createBill

public Bill.Id createBill(com.yahoo.config.provision.TenantName tenant,
 ZonedDateTime startTime,
 ZonedDateTime endTime,
 String agent)

Description copied from interface: BillingDatabaseClient

Create a completely new Bill in the open state with no LineItems.

Specified by:

createBill in interface BillingDatabaseClient

Parameters:

tenant - The name of the tenant the bill is for

agent - The agent that created the bill

Returns:

The Id of the new bill

readBill

public Optional<Bill> readBill(Bill.Id billId)

Description copied from interface: BillingDatabaseClient

Read the given bill from the data source

Specified by:

readBill in interface BillingDatabaseClient

Parameters:

billId - The Id of the bill to retrieve

Returns:

The Bill if it exists, Optional.empty() if not.

addLineItem

public String addLineItem(com.yahoo.config.provision.TenantName tenantName,
 Bill.LineItem lineItem,
 Optional<Bill.Id> invoiceId)

Description copied from interface: BillingDatabaseClient

Add a line item to an open bill

Specified by:

addLineItem in interface BillingDatabaseClient

lineItem - The line item to add

invoiceId - The optional ID of the bill this line item is for

Returns:

The Id of the new line item

setStatus

public void setStatus(Bill.Id invoiceId,
 String agent,
 BillStatus status)

Description copied from interface: BillingDatabaseClient

Set status for the given bill

Specified by:

setStatus in interface BillingDatabaseClient

Parameters:

invoiceId - The ID of the bill this status is for

agent - The agent that added the status

status - The new status of the bill

getUnusedLineItems

public List<Bill.LineItem> getUnusedLineItems(com.yahoo.config.provision.TenantName tenantName)

Specified by:

getUnusedLineItems in interface BillingDatabaseClient

deleteLineItem

public void deleteLineItem(String lineItemId)

Description copied from interface: BillingDatabaseClient

Delete a line item This is only allowed if the line item has not yet been associated with an bill

Specified by:

deleteLineItem in interface BillingDatabaseClient

Parameters:

lineItemId - The ID of the line item

commitLineItems

public void commitLineItems(com.yahoo.config.provision.TenantName tenantName,
 Bill.Id invoiceId)

Description copied from interface: BillingDatabaseClient

Associate all uncommitted line items to a given bill This is only allowed if the line item has not already been associated with an bill

Specified by:

commitLineItems in interface BillingDatabaseClient

Parameters:

tenantName - The tenant we want to commit line items for

invoiceId - The ID of the line item

getPlan

public Optional<Plan> getPlan(com.yahoo.config.provision.TenantName tenantName)

Description copied from interface: BillingDatabaseClient

Return the plan for the given tenant

Specified by:

getPlan in interface BillingDatabaseClient

Parameters:

tenantName - The tenant to retrieve the plan for

Returns:

Optional.of the plan if present in DN, else Optional.empty

getPlans

public Map<com.yahoo.config.provision.TenantName,Optional<Plan>> getPlans(List<com.yahoo.config.provision.TenantName> tenants)

Description copied from interface: BillingDatabaseClient

Return the plan for the given tenants if present. If the database does not know of the tenant, the tenant is not included in the result.

Specified by:

getPlans in interface BillingDatabaseClient

setPlan

public void setPlan(com.yahoo.config.provision.TenantName tenantName,
 Plan plan)

Description copied from interface: BillingDatabaseClient

Set the current plan for the given tenant

Specified by:

setPlan in interface BillingDatabaseClient

Parameters:

tenantName - The tenant to set the plan for

plan - The plan to use

deactivateDefaultPaymentInstrument

public void deactivateDefaultPaymentInstrument(com.yahoo.config.provision.TenantName tenant)

Description copied from interface: BillingDatabaseClient

Deactivates the default payment instrument for a tenant, if it exists. Used during tenant deletion

Specified by:

deactivateDefaultPaymentInstrument in interface BillingDatabaseClient

getCollectionMethod

public Optional<CollectionMethod> getCollectionMethod(com.yahoo.config.provision.TenantName tenantName)

Description copied from interface: BillingDatabaseClient

Get the current collection method for the tenant - if one has persisted

Specified by:

getCollectionMethod in interface BillingDatabaseClient

Returns:

Optional.empty if no collection method has been persisted for the tenant

setCollectionMethod

public void setCollectionMethod(com.yahoo.config.provision.TenantName tenantName,
 CollectionMethod collectionMethod)

Description copied from interface: BillingDatabaseClient

Set the collection method for the tenant

Specified by:

setCollectionMethod in interface BillingDatabaseClient

Parameters:

tenantName - The name of the tenant to set collection method for

collectionMethod - The collection method for the tenant

readBillsForTenant

public List<Bill> readBillsForTenant(com.yahoo.config.provision.TenantName tenant)

Description copied from interface: BillingDatabaseClient

Get all bills for a given tenant, ordered by date

Specified by:

readBillsForTenant in interface BillingDatabaseClient

Parameters:

tenant - The name of the tenant

Returns:

List of all bills ordered by date

readBills

public List<Bill> readBills()

Description copied from interface: BillingDatabaseClient

Read all bills, ordered by date

Specified by:

readBills in interface BillingDatabaseClient

Returns:

List of all bills ordered by date

maintain

public void maintain()

Description copied from interface: BillingDatabaseClient

Performs necessary maintenance operations

Specified by:

maintain in interface BillingDatabaseClient

setExportedInvoiceId

public void setExportedInvoiceId(Bill.Id billId,
 String invoiceId)

Description copied from interface: BillingDatabaseClient

Set the invoice id from an external system for the given bill

Specified by:

setExportedInvoiceId in interface BillingDatabaseClient

setExportedInvoiceItemId

public void setExportedInvoiceItemId(String lineItemId,
 String invoiceItemId)

Description copied from interface: BillingDatabaseClient

Set the invoice item id from an external system for the given line item

Specified by:

setExportedInvoiceItemId in interface BillingDatabaseClient