org.thales.punch.platform.api

Interface IPlatform

All Known Implementing Classes:

LocalPlatformImpl

public interface IPlatform

The IPlatform represents your entry point to access your running platform configuration data.

Say you need to perform an action for a given channel from tenant. Here is how you access the tenant settings:

        IPlatform platform = PlatformProvider.getPlatform();
        IPunchPlatformProperties properties = platform.getPlatformProperties();
        ITenant tenant = platform.getTenant("myTenant");
        IChannel channel = tenant.getChannel("myChannel");

Refer to the PlatformProvider class for accessing your platform.

Every time you access a platform resource, it is read and fetched from your file system or (most likely) from zookeeper. The whole idea is to let you design short administration tasks that start, fetch the configuration, do what they need then exit. This has immense benefits : admninistrative actions are straightforward to code : no caching, no daemons, no cleanup, full protected from a per tenant synchronized access.

Second new tenants and channels will appear dynamically.

Method Summary

Modifier and Type	Method and Description
ISettingsMap	getConfigurationTree()
String	getId()
IPunchPlatformProperties	getPlatformProperties()
ITenant	getTenant(String tenantName)
List<ITenant>	getTenants()

Method Detail

getPlatformProperties

IPunchPlatformProperties getPlatformProperties()

Returns:

your platform punchplatform.properties file content.

getTenants

List<ITenant> getTenants()

Returns:

the list of tenants known to this platform.

getTenant

ITenant getTenant(String tenantName)

Parameters:

tenantName - the tenant name

Returns:

the corresponding tenant, null if not found

getConfigurationTree

ISettingsMap getConfigurationTree()

Returns:

the platform complete tree as a ISettingsMap. Note that this relies on a lazy loading strategy. Only files you actually access later on will be fetched.

getId

String getId()

Returns:

the unique identifier of this platform