com.atlassian.plugins.landlord.spi

Interface LandlordRequests

@ExperimentalSpi
public interface LandlordRequests

This interface must be implemented by each application that provides the landlord service. It allows the application to complete application-specific tasks before the landlord service sends out notification events. Note: This was written to support multiple tenants, but the current version of the landlord is locked to a single tenant, to support Instant On.

Method Summary

Modifier and Type	Method and Description
void	acceptTenant(String tenantId) Deprecated. this should be implemented to have the effect of acceptTenant(String, Map) with second parameter empty.
void	acceptTenant(String tenantId, Map<String,String> tenantProperties) This method will be called by the landlord service when a new tenant is required to be accepted by the application.
List<String>	getTenants() This method will be called by the landlord service to determine what tenants have been accepted by the application
void	removeTenant(String tenantId) This method will be called by the landlord service when a new tenant is required to be removed from the application.

Method Detail

acceptTenant

void acceptTenant(String tenantId)
           throws LandlordRequestException

Deprecated. this should be implemented to have the effect of acceptTenant(String, Map) with second parameter empty.

Parameters:

tenantId - this is currently represented by the baseurl for the tenant

Throws:

LandlordRequestException

acceptTenant

void acceptTenant(String tenantId,
                  Map<String,String> tenantProperties)
           throws LandlordRequestException

This method will be called by the landlord service when a new tenant is required to be accepted by the application. Note: This is required to complete synchronously, as the landlord service will fire an event when the tenant has been accepted (TenantArrivedEvent).

Parameters:

tenantId - this is currently represented by the baseurl for the tenant

tenantProperties - additional tenant configuration properties

Throws:

LandlordRequestException

removeTenant

void removeTenant(String tenantId)
           throws LandlordRequestException

This method will be called by the landlord service when a new tenant is required to be removed from the application.

Parameters:

tenantId - this is currently represented by the baseurl for the tenant

Throws:

LandlordRequestException

getTenants

List<String> getTenants()

This method will be called by the landlord service to determine what tenants have been accepted by the application

Returns:

a list of tenantIds for currently accepted tenants