com.atlassian.plugins.landlord.service

Interface LandlordService

All Known Implementing Classes:

LandlordServiceImpl

public interface LandlordService

This interface specifies the contract for the landlord service, which is responsible for securely reading a new tenant id and asking the application to accept it

Method Summary

Modifier and Type	Method and Description
String	getTenantID() This method will return the current tenant.
void	loadTenant() Deprecated. use loadTenant(boolean) and explicitly specify asynchrony.
void	loadTenant(boolean asynchronous) Trigger the landlord to load tenant details from a tenant file.

Method Detail

getTenantID

String getTenantID()

This method will return the current tenant. The current version of the landlord service ensures that only one tenant is accepted by the application

Returns:

String the tenant id, if present.

loadTenant

@Deprecated
void loadTenant()

Deprecated. use loadTenant(boolean) and explicitly specify asynchrony.

Equivalent to loadTenant(true).

loadTenant

void loadTenant(boolean asynchronous)

Trigger the landlord to load tenant details from a tenant file. This will then instruct the application the accept the new tenant.

Parameters:

asynchronous - true if the tenant load should be asynchronous.