Class PortalHub
  
  Portal hub - a registry of portals, It establishes a context for portal inter-operation (i.e. so one portal may locate another by name)
when some settings need to be cloned. This is an app-started singleton instance class
 
  
  
    Inheritance
    System.Object
    
    
    PortalHub
   
  
    Implements
    
    System.IDisposable
    
    
    
    
   
  
    Inherited Members
    
    
    
    
    
    
    
    
    
    
    
    
    
      System.Object.Equals(System.Object)
    
    
      System.Object.Equals(System.Object, System.Object)
    
    
      System.Object.GetHashCode()
    
    
      System.Object.GetType()
    
    
      System.Object.MemberwiseClone()
    
    
      System.Object.ReferenceEquals(System.Object, System.Object)
    
    
      System.Object.ToString()
    
   
  
  Assembly: NFX.Wave.dll
  Syntax
  
    public sealed class PortalHub : ApplicationComponent, IApplicationComponent, IDisposable, IApplicationStarter, IConfigurable, IApplicationFinishNotifiable, INamed
   
  Fields
  
  
  
  CONFIG_CMS_BANK_SECTION
  
  
  Declaration
  
    public const string CONFIG_CMS_BANK_SECTION = "cms-bank"
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  CONFIG_CONTENT_FS_SECTION
  
  
  Declaration
  
    public const string CONFIG_CONTENT_FS_SECTION = "content-file-system"
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  CONFIG_FS_CONNECT_PARAMS_SECTION
  
  
  Declaration
  
    public const string CONFIG_FS_CONNECT_PARAMS_SECTION = "connect-params"
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  CONFIG_FS_ROOT_PATH_ATTR
  
  
  Declaration
  
    public const string CONFIG_FS_ROOT_PATH_ATTR = "root-path"
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  CONFIG_PORTAL_SECTION
  
  
  Declaration
  
    public const string CONFIG_PORTAL_SECTION = "portal"
   
  Field Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  Properties
  
  
  
  
  CMSAvailable
  Returns true if CMS is initializes with non-NOP CMS bank
 
  
  Declaration
  
    public bool CMSAvailable { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  CMSBank
  Returns the ICMSBank instance
 
  
  Declaration
  
    public ICMSBank CMSBank { get; }
   
  Property Value
  
  
  
  
  ContentFileSystem
  Returns file system that serves static content for portals
 
  
  Declaration
  
    public IFileSystem ContentFileSystem { get; }
   
  Property Value
  
  
  
  
  ContentFileSystemConnectParams
  
  
  Declaration
  
    public FileSystemSessionConnectParams ContentFileSystemConnectParams { get; }
   
  Property Value
  
  
  
  
  ContentFileSystemRootPath
  Returns root path for content file system
 
  
  Declaration
  
    public string ContentFileSystemRootPath { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  
  DefaultOnline
  Returns first portal which is not Offline and marked as default
 
  
  Declaration
  
    public Portal DefaultOnline { get; }
   
  Property Value
  
  
  
  
  Instance
  Returns singleton instance
 
  
  Declaration
  
    public static PortalHub Instance { get; }
   
  Property Value
  
  
  
  
  InstanceAvailable
  True if instance is allocated
 
  
  Declaration
  
    public static bool InstanceAvailable { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  Name
  
  
  Declaration
  
    public string Name { get; }
   
  Property Value
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  
  
  
  Portals
  Registry of all portals in the hub
 
  
  Declaration
  
    public IRegistry<Portal> Portals { get; }
   
  Property Value
  
  Methods
  
  
  
  
  Destructor()
  
  
  Declaration
  
    protected override void Destructor()
   
  Overrides
  
  
  
  
  GenerateContentFileVersionSegment(String)
  Generates file version path segment suitable for usage in file name.
This method is slow as it does byte file sig calculation
 
  
  Declaration
  
    public string GenerateContentFileVersionSegment(string filePath)
   
  Parameters
  
    
      
        | Type | 
        Name | 
        Description | 
      
    
    
      
        | System.String | 
        filePath | 
         | 
      
    
  
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.String | 
         | 
      
    
  
  Explicit Interface Implementations
  
  
  
  
  IApplicationFinishNotifiable.ApplicationFinishAfterCleanup(IApplication)
  
  
  Declaration
  
    void IApplicationFinishNotifiable.ApplicationFinishAfterCleanup(IApplication application)
   
  Parameters
  
  
  
  
  IApplicationFinishNotifiable.ApplicationFinishBeforeCleanup(IApplication)
  
  
  Declaration
  
    void IApplicationFinishNotifiable.ApplicationFinishBeforeCleanup(IApplication application)
   
  Parameters
  
  
  
  
  IApplicationStarter.ApplicationStartAfterInit(IApplication)
  
  
  Declaration
  
    void IApplicationStarter.ApplicationStartAfterInit(IApplication application)
   
  Parameters
  
  
  
  
  IApplicationStarter.ApplicationStartBeforeInit(IApplication)
  
  
  Declaration
  
    void IApplicationStarter.ApplicationStartBeforeInit(IApplication application)
   
  Parameters
  
  
  
  
  IApplicationStarter.ApplicationStartBreakOnException
  
  
  Declaration
  
    bool IApplicationStarter.ApplicationStartBreakOnException { get; }
   
  Returns
  
    
      
        | Type | 
        Description | 
      
    
    
      
        | System.Boolean | 
         | 
      
    
  
  
  
  
  
  
  
  Declaration
  
    void IConfigurable.Configure(IConfigSectionNode node)
   
  Parameters
  
  Implements
  
  
      System.IDisposable
  
  
  
  
  
  Extension Methods