sirius.biz.jdbc.tenants

Class Tenant

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.db.mixing.Mixable

sirius.db.mixing.BaseEntity<Long>

sirius.db.jdbc.SQLEntity

sirius.biz.jdbc.model.BizEntity

sirius.biz.jdbc.tenants.Tenant

All Implemented Interfaces:

Journaled, sirius.kernel.di.transformers.Transformable

public class Tenant
extends BizEntity
implements Journaled

Represents a tenant using the system.

Helps to support multi tenancy for SaaS platforms.

Field Summary

Fields

Modifier and Type	Field and Description
static sirius.db.mixing.Mapping	ACCOUNT_NUMBER Contains the customer number assigned to the tenant.
static sirius.db.mixing.Mapping	ADDRESS Contains the address of the tenant.
static sirius.db.mixing.Mapping	CAN_ACCESS_PARENT Determines if this tenant can become its tenant by calling "/tenants/select".
static sirius.db.mixing.Mapping	EXTERNAL_LOGIN_INTERVAL_DAYS Determines the interval in days, after which a user needs to login again, via an extenal system.
static sirius.db.mixing.Mapping	JOURNAL Used to record changes on fields of the tenant.
static sirius.db.mixing.Mapping	LOGIN_INTERVAL_DAYS Determines the interval in days, after which a user needs to login again.
static sirius.db.mixing.Mapping	NAME Contains the name of the tenant.
static sirius.db.mixing.Mapping	PARENT Contains the parent tenant of this tenant.
static sirius.db.mixing.Mapping	PARENT_CAN_ACCESS Determines if the parent tenant can become this tenant by calling "/tenants/select".
static sirius.db.mixing.Mapping	PERMISSIONS Contains the features and individual config assigned to the tenant.
static sirius.db.mixing.Mapping	SAML_FINGERPRINT Contains the SHA-1 fingerprint of the X509 certificate which is used to sign the SAML assertions.
static sirius.db.mixing.Mapping	SAML_ISSUER_INDEX Contains the endpoint index at the SAML provider.
static sirius.db.mixing.Mapping	SAML_ISSUER_NAME Contains the issuer name within a SAML assertion.
static sirius.db.mixing.Mapping	SAML_ISSUER_URL Contains the URL of the SAML provider.
static sirius.db.mixing.Mapping	SAML_REQUEST_ISSUER_NAME Contains the name of the system which is used as the SAML provider.

Fields inherited from class sirius.biz.jdbc.model.BizEntity

TRACE

Fields inherited from class sirius.db.jdbc.SQLEntity

fetchRow, id, ID, NON_PERSISTENT_ENTITY_ID, oma

Fields inherited from class sirius.db.mixing.BaseEntity

mixing, NEW, persistedData, version

Fields inherited from class sirius.db.mixing.Mixable

elastic, mango

Fields inherited from class sirius.kernel.di.transformers.Composable

components

Constructor Summary

Constructors

Constructor and Description
Tenant()

Method Summary

Modifier and Type	Method and Description
String	getAccountNumber()
InternationalAddressData	getAddress()
Integer	getExternalLoginIntervalDays()
JournalData	getJournal() Returns the journal of this entity.
Integer	getLoginIntervalDays()
String	getName()
sirius.db.jdbc.SQLEntityRef<Tenant>	getParent()
PermissionData	getPermissions()
String	getSamlFingerprint()
String	getSamlIssuerIndex()
String	getSamlIssuerName()
String	getSamlIssuerUrl()
String	getSamlRequestIssuerName()
boolean	isCanAccessParent()
boolean	isParentCanAccess()
protected void	onModify()
void	setAccountNumber(String accountNumber)
void	setCanAccessParent(boolean canAccessParent)
void	setExternalLoginIntervalDays(Integer externalLoginIntervalDays)
void	setLoginIntervalDays(Integer loginIntervalDays)
void	setName(String name)
void	setParentCanAccess(boolean parentCanAccess)
void	setSamlFingerprint(String samlFingerprint)
void	setSamlIssuerIndex(String samlIssuerIndex)
void	setSamlIssuerName(String samlIssuerName)
void	setSamlIssuerUrl(String samlIssuerUrl)
void	setSamlRequestIssuerName(String samlRequestIssuerName)
String	toString()

Methods inherited from class sirius.biz.jdbc.model.BizEntity

getTrace, isAnyColumnChangedExceptNoJournal

Methods inherited from class sirius.db.jdbc.SQLEntity

equals, getFetchRow, getId, getMapper, hashCode, isNew, isUnique, setId

Methods inherited from class sirius.db.mixing.BaseEntity

assertUnique, getDescriptor, getIdAsString, getTypeName, getUniqueName, getVersion, isAnyMappingChanged, isChanged, setVersion

Methods inherited from class sirius.db.mixing.Mixable

is, makeNewInstance, tryAs

Methods inherited from class sirius.kernel.di.transformers.Composable

as, attach, attach

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PARENT

public static final sirius.db.mixing.Mapping PARENT

Contains the parent tenant of this tenant.

PARENT_CAN_ACCESS

public static final sirius.db.mixing.Mapping PARENT_CAN_ACCESS

Determines if the parent tenant can become this tenant by calling "/tenants/select".

CAN_ACCESS_PARENT

public static final sirius.db.mixing.Mapping CAN_ACCESS_PARENT

Determines if this tenant can become its tenant by calling "/tenants/select".

LOGIN_INTERVAL_DAYS

public static final sirius.db.mixing.Mapping LOGIN_INTERVAL_DAYS

Determines the interval in days, after which a user needs to login again.

EXTERNAL_LOGIN_INTERVAL_DAYS

public static final sirius.db.mixing.Mapping EXTERNAL_LOGIN_INTERVAL_DAYS

Determines the interval in days, after which a user needs to login again, via an extenal system.

Note that this is only enforced if UserAccount.externalLoginRequired is true.

NAME

public static final sirius.db.mixing.Mapping NAME

Contains the name of the tenant.

ACCOUNT_NUMBER

public static final sirius.db.mixing.Mapping ACCOUNT_NUMBER

Contains the customer number assigned to the tenant.

SAML_REQUEST_ISSUER_NAME

public static final sirius.db.mixing.Mapping SAML_REQUEST_ISSUER_NAME

Contains the name of the system which is used as the SAML provider.

SAML_ISSUER_URL

public static final sirius.db.mixing.Mapping SAML_ISSUER_URL

Contains the URL of the SAML provider.

SAML_ISSUER_INDEX

public static final sirius.db.mixing.Mapping SAML_ISSUER_INDEX

Contains the endpoint index at the SAML provider.

SAML_ISSUER_NAME

public static final sirius.db.mixing.Mapping SAML_ISSUER_NAME

Contains the issuer name within a SAML assertion.

If several SAML providers are used, multiple values can be separated by a ,.

SAML_FINGERPRINT

public static final sirius.db.mixing.Mapping SAML_FINGERPRINT

Contains the SHA-1 fingerprint of the X509 certificate which is used to sign the SAML assertions.

If several SAML providers are used, multiple values can be separated by a ,.

ADDRESS

public static final sirius.db.mixing.Mapping ADDRESS

Contains the address of the tenant.

PERMISSIONS

public static final sirius.db.mixing.Mapping PERMISSIONS

Contains the features and individual config assigned to the tenant.

JOURNAL

public static final sirius.db.mixing.Mapping JOURNAL

Used to record changes on fields of the tenant.

Constructor Detail

Tenant

public Tenant()

Method Detail

onModify

protected void onModify()

getName

public String getName()

setName

public void setName(String name)

getAccountNumber

public String getAccountNumber()

setAccountNumber

public void setAccountNumber(String accountNumber)

getAddress

public InternationalAddressData getAddress()

getPermissions

public PermissionData getPermissions()

getParent

public sirius.db.jdbc.SQLEntityRef<Tenant> getParent()

isParentCanAccess

public boolean isParentCanAccess()

setParentCanAccess

public void setParentCanAccess(boolean parentCanAccess)

isCanAccessParent

public boolean isCanAccessParent()

setCanAccessParent

public void setCanAccessParent(boolean canAccessParent)

getSamlIssuerName

public String getSamlIssuerName()

setSamlIssuerName

public void setSamlIssuerName(String samlIssuerName)

getSamlIssuerUrl

public String getSamlIssuerUrl()

setSamlIssuerUrl

public void setSamlIssuerUrl(String samlIssuerUrl)

getSamlIssuerIndex

public String getSamlIssuerIndex()

setSamlIssuerIndex

public void setSamlIssuerIndex(String samlIssuerIndex)

getSamlFingerprint

public String getSamlFingerprint()

setSamlFingerprint

public void setSamlFingerprint(String samlFingerprint)

getSamlRequestIssuerName

public String getSamlRequestIssuerName()

setSamlRequestIssuerName

public void setSamlRequestIssuerName(String samlRequestIssuerName)

getLoginIntervalDays

public Integer getLoginIntervalDays()

setLoginIntervalDays

public void setLoginIntervalDays(Integer loginIntervalDays)

getExternalLoginIntervalDays

public Integer getExternalLoginIntervalDays()

setExternalLoginIntervalDays

public void setExternalLoginIntervalDays(Integer externalLoginIntervalDays)

getJournal

public JournalData getJournal()

Description copied from interface: Journaled

Returns the journal of this entity.

Specified by:

getJournal in interface Journaled

Returns:

the journal of this entity

toString

public String toString()

Overrides:

toString in class sirius.db.mixing.BaseEntity<Long>