org.thales.punch.platform.api

Interface ITenant

All Known Implementing Classes:

TenantImpl

public interface ITenant

This interface gives you access to all the configuration files defined for a given tenant.

Each tenant has channels, services and possibly resource files. These are stored in the tenant folder.

• etc/conf.json : there are stored per tenant settings related to administrative tasks
• channels : the channels defined as part of this tenant.
• services : the services defined as part of this tenant.

Method Summary

Modifier and Type	Method and Description
ISettingsMap	asSettingsMap()
IBook	getBook(String driverName) Get one of the tenant's channel.
List<IEntity>	getBooks(Map<String,Exception> invalid) Iterate over the channels of a tenant
IChannel	getChannel(String channelName) Get one of the tenant's channel.
List<IEntity>	getChannels(Map<String,Exception> invalid) Iterate over the channels of a tenant
List<IEntity>	getEntities() Get one of the tenant's channel.
ISettingsMap	getEtc()
String	getName()
String	getPath() I.e.
IPlatform	getPlatform() Get this tenant platform.
List<IEntity>	getValidBooks()

Method Detail

getPlatform

IPlatform getPlatform()

Get this tenant platform.

Returns:

a platform handle

getEntities

List<IEntity> getEntities()
                   throws ConfigurationException

Get one of the tenant's channel.

Parameters:

channelName - a channel name

Returns:

the corresponding channel

Throws:

ConfigurationException

getChannel

IChannel getChannel(String channelName)
             throws ConfigurationException

Get one of the tenant's channel.

Parameters:

channelName - a channel name

Returns:

the corresponding channel or null if there is none

Throws:

ConfigurationException

getBook

IBook getBook(String driverName)
       throws ConfigurationException

Get one of the tenant's channel.

Parameters:

driverName - a channel name

Returns:

the corresponding channel

Throws:

ConfigurationException

getChannels

List<IEntity> getChannels(Map<String,Exception> invalid)

Iterate over the channels of a tenant

Parameters:

invalid - a map to be returned with any invalid or corrupted channel.

Returns:

a list of valid channel, possibly empty

getBooks

List<IEntity> getBooks(Map<String,Exception> invalid)

Iterate over the channels of a tenant

Returns:

a list of channel, possibly empty

Throws:

ConfigurationException

getValidBooks

List<IEntity> getValidBooks()

Returns:

only the list of valid books.

getName

String getName()

Returns:

the name of this tenant

getEtc

ISettingsMap getEtc()

Returns:

the content of the etc configuration folder of this tenant

asSettingsMap

ISettingsMap asSettingsMap()

Returns:

the tenant as a settings map.

getPath

String getPath()

I.e. "tenants/mytenant"

Returns:

the tenant path relative to the configuration directory.