View Source

Class SiteDomainHelper

Provides utilities to handle site domains.

Inheritance

System.Object

Namespace: Umbraco.Web.Routing

Assembly: Umbraco.Web.dll

Syntax

public class SiteDomainHelper : ISiteDomainHelper, IDisposable

Properties

ConfigReadLock

Declaration

protected static IDisposable ConfigReadLock { get; }

Property Value

Type	Description
System.IDisposable

ConfigWriteLock

Declaration

protected static IDisposable ConfigWriteLock { get; }

Property Value

Type	Description
System.IDisposable

Methods

AddSite(String, IEnumerable<String>)

Adds a site.

Declaration

public static void AddSite(string key, IEnumerable<string> domains)

Parameters

Type	Name	Description
System.String	key	A key uniquely identifying the site.
System.Collections.Generic.IEnumerable<System.String>	domains	The site domains.

Remarks

At the moment there is no public way to remove a site. Clear and reconfigure.

AddSite(String, String[])

Adds a site.

Declaration

public static void AddSite(string key, params string[] domains)

Parameters

Type	Name	Description
System.String	key	A key uniquely identifying the site.
System.String[]	domains	The site domains.

Remarks

At the moment there is no public way to remove a site. Clear and reconfigure.

BindSites(String[])

Binds some sites.

Declaration

public static void BindSites(params string[] keys)

Parameters

Type	Name	Description
System.String[]	keys	The keys uniquely identifying the sites to bind.

Remarks

At the moment there is no public way to unbind sites. Clear and reconfigure.

If site1 is bound to site2 and site2 is bound to site3 then site1 is bound to site3.

Clear()

Clears the entire configuration.

Declaration

public static void Clear()

Dispose()

Declaration

public void Dispose()

Dispose(Boolean)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

MapDomain(IReadOnlyCollection<DomainAndUri>, Uri, String, String)

Filters a list of DomainAndUri to pick one that best matches the current request.

Declaration

public virtual DomainAndUri MapDomain(IReadOnlyCollection<DomainAndUri> domainAndUris, Uri current, string culture, string defaultCulture)

Parameters

Type	Name	Description
System.Collections.Generic.IReadOnlyCollection<DomainAndUri>	domainAndUris	The list of DomainAndUri to filter.
System.Uri	current	The Uri of the current request.
System.String	culture	A culture.
System.String	defaultCulture	The default culture.

Returns

Type	Description
DomainAndUri	The selected DomainAndUri.

Remarks

If the filter is invoked then domainAndUris is not empty and current is not null, and current could not be matched with anything in domainAndUris.

The culture may be null, but when non-null, it can be used to help pick the best matches.

The filter must return something else an exception will be thrown.

MapDomains(IReadOnlyCollection<DomainAndUri>, Uri, Boolean, String, String)

Filters a list of DomainAndUri to pick those that best matches the current request.

Declaration

public virtual IEnumerable<DomainAndUri> MapDomains(IReadOnlyCollection<DomainAndUri> domainAndUris, Uri current, bool excludeDefault, string culture, string defaultCulture)

Parameters

Type	Name	Description
System.Collections.Generic.IReadOnlyCollection<DomainAndUri>	domainAndUris	The list of DomainAndUri to filter.
System.Uri	current	The Uri of the current request.
System.Boolean	excludeDefault	A value indicating whether to exclude the current/default domain.
System.String	culture	A culture.
System.String	defaultCulture	The default culture.

Returns

Type	Description
System.Collections.Generic.IEnumerable<DomainAndUri>	The selected DomainAndUri items.

Remarks

The filter must return something, even empty, else an exception will be thrown.

The culture may be null, but when non-null, it can be used to help pick the best matches.