TenantAwareLoginParsingDatasourceService (pentaho-platform-core 9.3.0.0-424 API)

java.lang.Object
- org.pentaho.platform.engine.services.connection.datasource.dbcp.BaseDatasourceService
- - org.pentaho.platform.engine.services.connection.datasource.dbcp.NonPooledOrJndiDatasourceService
  - - org.pentaho.platform.engine.services.connection.datasource.dbcp.PooledOrJndiDatasourceService
    - - org.pentaho.platform.engine.services.connection.datasource.dbcp.tenantaware.AbstractTenantAwareDatasourceService
      - org.pentaho.platform.engine.services.connection.datasource.dbcp.tenantaware.TenantAwareLoginParsingDatasourceService

All Implemented Interfaces:

org.pentaho.platform.api.data.IDBDatasourceService, org.springframework.beans.factory.InitializingBean
```
public class TenantAwareLoginParsingDatasourceService
extends AbstractTenantAwareDatasourceService
implements org.springframework.beans.factory.InitializingBean
```
This reference implementation parses the users' login name to derive the Tenant ID. This can come in two forms: 1- Tenant First - for example, tenantid\mbatchelor (an LDAP-like ID) 2- Tenant Last - for example: mbatchelor@pentaho.com (an e-mail like ID)

Author:

mbatchelor

Field Summary
- Fields inherited from interface org.pentaho.platform.api.data.IDBDatasourceService
  ACCESS_TO_UNDERLYING_CONNECTION_ALLOWED, DEFAULT_AUTO_COMMIT, DEFAULT_CATALOG, DEFAULT_READ_ONLY, DEFAULT_TRANSACTION_ISOLATION, IDBDATASOURCE_SERVICE, INITIAL_SIZE, JDBC_DATASOURCE, JDBC_POOL, LOG_ABANDONED, MAX_ACTIVE_KEY, MAX_IDLE_KEY, MAX_OPEN_PREPARED_STATEMENTS, MAX_WAIT_KEY, MIN_IDLE_KEY, POOL_PREPARED_STATEMENTS, QUERY_KEY, REMOVE_ABANDONED, REMOVE_ABANDONED_TIMEOUT, TEST_ON_BORROW, TEST_ON_RETURN, TEST_WHILE_IDLE, TIME_BETWEEN_EVICTION_RUNS_MILLIS, TRANSACTION_ISOLATION_NONE_VALUE

Constructor Summary

Constructors
Constructor Description

TenantAwareLoginParsingDatasourceService()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getTenantId()`	This abstract method must be implemented by subclasses - this should return a string containing the tenant's ID.
`String`	`getTenantSeparator()`
`boolean`	`isTenantOnLeft()`
`void`	`setTenantOnLeft(boolean value)`	Getters and Setters
`void`	`setTenantSeparator(String value)`

Methods inherited from class org.pentaho.platform.engine.services.connection.datasource.dbcp.tenantaware.AbstractTenantAwareDatasourceService
afterPropertiesSet, getDataSource, getDatasourceNameFormat, isRequireTenantId, setDatasourceNameFormat, setRequireTenantId

Methods inherited from class org.pentaho.platform.engine.services.connection.datasource.dbcp.PooledOrJndiDatasourceService
resolveDatabaseConnection

Methods inherited from class org.pentaho.platform.engine.services.connection.datasource.dbcp.NonPooledOrJndiDatasourceService
retrieve

Methods inherited from class org.pentaho.platform.engine.services.connection.datasource.dbcp.BaseDatasourceService
clearCache, clearDataSource, getCacheManager, getDatasourceMgmtService, getDSBoundName, getDSUnboundName, getJndiDataSource

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.beans.factory.InitializingBean
afterPropertiesSet

- Constructor Detail
  - TenantAwareLoginParsingDatasourceService
```
public TenantAwareLoginParsingDatasourceService()
```
- Method Detail
  - getTenantId
```
public String getTenantId()
```
    Description copied from class: AbstractTenantAwareDatasourceService
    
    This abstract method must be implemented by subclasses - this should return a string containing the tenant's ID.
    
    Specified by:
    
    getTenantId in class AbstractTenantAwareDatasourceService
    
    Returns:
    
    String ID of the Tenant
  - setTenantOnLeft
```
public void setTenantOnLeft(boolean value)
```
    Getters and Setters
  - isTenantOnLeft
```
public boolean isTenantOnLeft()
```
  - setTenantSeparator
```
public void setTenantSeparator(String value)
```
  - getTenantSeparator
```
public String getTenantSeparator()
```