Class NeosTenantInfo

Namespace

GroupeIsa.Neos.Shared.MultiTenant

Assembly

GroupeIsa.Neos.Shared.dll

Represents the tenant informations.

public class NeosTenantInfo : ITenantInfo

Inheritance

object

NeosTenantInfo

Implements

ITenantInfo

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NeosTenantInfo()

Initializes a new instance of the NeosTenantInfo class.

public NeosTenantInfo()

NeosTenantInfo(string?, string?, string?, string?, DatabaseType?, int?)

Initializes a new instance of the NeosTenantInfo class.

public NeosTenantInfo(string? id, string? identifier = null, string? name = null, string? connectionString = null, DatabaseType? databaseType = null, int? licenseId = null)

Parameters

id string

Id.

identifier string

Identifier.

name string

Name.

connectionString string

Connection string.

databaseType DatabaseType?

Database type.

licenseId int?

Identifier of the license in the LicenseManagement cluster.

Fields

DefaultTenantId

Gets the default tenant Id when cluster is started in monotenancy mode.

public const string DefaultTenantId = "__default__"

Field Value

string

Empty

Gets an empty instance.

public static readonly NeosTenantInfo Empty

Field Value

NeosTenantInfo

TenantHeaderKey

Gets the http header key in header strategy.

public const string TenantHeaderKey = "Neos-Tenant"

Field Value

string

Properties

ConnectionString

Gets or sets a connection string for the tenant.

public string? ConnectionString { get; set; }

Property Value

string

DatabaseType

Gets or sets the database type.

public DatabaseType? DatabaseType { get; set; }

Property Value

DatabaseType?

Id

Gets or sets a unique id for the tenant.

public string? Id { get; set; }

Property Value

string

Remarks

Unlike the Identifier, the id is never intended to be changed.

Identifier

Gets or sets a unique identifier for the tenant.

public string? Identifier { get; set; }

Property Value

string

Remarks

The Identifier is intended for use during tenant resolution and format is determined by convention. For example a web based strategy may require URL friendly identifiers. Identifiers can be changed if needed.

LicenseId

Gets or sets the license identifier.

public int? LicenseId { get; set; }

Property Value

int?

Name

Gets or sets a display friendly name for the tenant.

public string? Name { get; set; }

Property Value

string