GSF.Web by Grid Protection Alliance

<PackageReference Include="GSF.Web" Version="2.2.119-beta" />

---

API Diff between 2.2.119-beta and 2.1.298-beta

176 Additions 28 Removals

GSF.Web

• public static class WebExtensions
  • public static void AddBasicAuthenticationHeader(this HttpClient client, string userName, string password)
  • public static void AddEmbeddedResourceAssembly(Assembly assembly)
  • public static Task<PostData> GetPostDataAsync(this HttpRequestMessage request)
  • public static Task<PostData> GetPostDataAsync(this HttpRequestMessage request, CancellationToken cancellationToken)
  • public static DateTime ParseJsonTimestamp(this string timestamp)

GSF.Web.Hosting

• public class ReadonlyWebServerOptions
  • public string AuthTestPage { get; }
  • public bool ClientCacheEnabled { get; }
  • public bool MinifyJavascript { get; }
  • public bool MinifyStyleSheets { get; }
  • public string SessionToken { get; }
  • public bool UseMinifyInDebug { get; }
  • public string WebRootPath { get; }
• public class WebServer
  • public bool ClientCacheEnabled { get; set; }
  • public bool MinifyJavascript { get; set; }
  • public bool MinifyStyleSheets { get; set; }
  • public ReadonlyWebServerOptions Options { get; }
  • public bool UseMinifyInDebug { get; set; }
  • public string WebRootPath { get; }
  • public WebServer(string webRootPath = null, IRazorEngine razorEngineCS = null, IRazorEngine razorEngineVB = null)
  • public WebServer(WebServerOptions options = null, IRazorEngine razorEngineCS = null, IRazorEngine razorEngineVB = null)
• public class WebServerOptions
  • public const bool DefaultClientCacheEnabled = true
  • public const bool DefaultMinifyJavascript = true
  • public const bool DefaultMinifyStyleSheets = true
  • public const bool DefaultUseMinifyInDebug = false
  • public const string DefaultWebRootPath = "wwwroot"
  • public string AuthTestPage { get; set; }
  • public bool ClientCacheEnabled { get; set; }
  • public bool MinifyJavascript { get; set; }
  • public bool MinifyStyleSheets { get; set; }
  • public ReadonlyWebServerOptions Readonly { get; }
  • public string SessionToken { get; set; }
  • public bool UseMinifyInDebug { get; set; }
  • public string WebRootPath { get; set; }
  • public WebServerOptions()

GSF.Web.Hubs

• public class DataContextHubClient : HubClientBase
  • public ConcurrentDictionary<Type, DataTable> PrimaryKeySessionCache { get; }
  • public DataContextHubClient()
  • public DataContext GetDataContext(string settingsCategory)
• public class DataContextOperations : HubClientOperationsBase<DataContextHubClient>
  • public DataContext DataContext { get; }
  • public ConcurrentDictionary<Type, DataTable> PrimaryKeySessionCache { get; }
  • public DataContextOperations(IHub hub, string settingsCategory, Action<string, UpdateType> logStatusMessageFunction = null, Action<Exception> logExceptionFunction = null)
• public abstract class HubClientBase : IHubClient, IDisposable
  • public object ClientScript { get; }
  • public string ConnectionID { get; set; }
  • public IHub HubInstance { get; set; }
  • public Action<Exception> LogExceptionFunction { get; set; }
  • public Action<string, UpdateType> LogStatusMessageFunction { get; set; }
  • protected HubClientBase()
  • public void Dispose()
  • protected virtual void Dispose(bool disposing)
  • protected void LogException(Exception ex, bool logToClient = true)
  • protected void LogStatusMessage(string message, UpdateType type = 0, bool logToClient = true)
• public abstract class HubClientOperationsBase<T> where T : IHubClient
  • protected T HubClient { get; }
  • protected HubClientOperationsBase(IHub hub, Action<string, UpdateType> logStatusMessageFunction = null, Action<Exception> logExceptionFunction = null)
  • public static void EndSession(string connectionID)
  • public virtual void EndSession()
• public interface IHubClient : IDisposable
  • string ConnectionID { get; set; }
  • IHub HubInstance { get; set; }
  • Action<Exception> LogExceptionFunction { get; set; }
  • Action<string, UpdateType> LogStatusMessageFunction { get; set; }
• public interface IRecordOperationsHub : IDisposable
  • string ConnectionID { get; set; }
  • DataContext DataContext { get; }
  • RecordOperationsCache RecordOperationsCache { get; }
• public class RecordOperationsCache
  • public RecordOperationsCache(Type hub)
  • public Tuple<string, string>[] GetRecordOperations<TModel>()
  • public Tuple<string, string>[] GetRecordOperations(Type model)
• public class RecordOperationsCache<T> : RecordOperationsCache where T : IHub
  • public RecordOperationsCache()
• public abstract class RecordOperationsHub<T> : Hub, IRecordOperationsHub, IDisposable where T : IHub, IRecordOperationsHub
  • public static int ConnectionCount { get; }
  • public object ClientScript { get; }
  • public string ConnectionID { get; set; }
  • public DataContext DataContext { get; }
  • public RecordOperationsCache RecordOperationsCache { get; }
  • protected RecordOperationsHub()
  • protected RecordOperationsHub(Action<string, UpdateType> logStatusMessageFunction, Action<Exception> logExceptionFunction)
  • protected RecordOperationsHub(string settingsCategory, Action<string, UpdateType> logStatusMessageFunction, Action<Exception> logExceptionFunction)
  • public static RecordOperationsCache GetRecordOperationsCache()
  • public string GetConnectionID()
  • protected void LogException(Exception ex, bool logToClient = true)
  • protected void LogStatusMessage(string message, UpdateType type = 0, bool logToClient = true)

GSF.Web.Model

• public class DataContext : IDisposable
  • public Dictionary<Type, IEnumerable<KeyValuePair<string, string>>> CustomTableOperationTokens { get; }
  • public AdoSecurityProvider SecurityProvider { get; }
  • public string AddSelectField<TModel, TOption>(string fieldName, string optionValueFieldName, string optionLabelFieldName = null, string optionSortFieldName = null, string fieldLabel = null, string fieldID = null, string groupDataBinding = null, string labelDataBinding = null, string requiredDataBinding = null, string customDataBinding = null, string dependencyFieldName = null, string optionDataBinding = null, string toolTip = null, bool initialFocus = false, RecordRestriction restriction = null, bool showNoRecordOption = false, string noRecordValue = "-1", string noRecordText = "No records")
  • public string AddSelectField<TOption>(string fieldName, bool required, string optionValueFieldName, string optionLabelFieldName = null, string optionSortFieldName = null, string fieldLabel = null, string fieldID = null, string groupDataBinding = null, string labelDataBinding = null, string requiredDataBinding = null, string customDataBinding = null, string dependencyFieldName = null, string optionDataBinding = null, string toolTip = null, bool initialFocus = false, RecordRestriction restriction = null, bool showNoRecordOption = false, string noRecordValue = "-1", string noRecordText = "No records")
  • public string AddSelectField<TModel, TOption>(string fieldName, string optionValueFieldName, string optionLabelFieldName = null, string optionSortFieldName = null, string fieldLabel = null, string fieldID = null, string groupDataBinding = null, string labelDataBinding = null, string requiredDataBinding = null, string customDataBinding = null, string dependencyFieldName = null, string optionDataBinding = null, string toolTip = null, bool initialFocus = false, RecordRestriction restriction = null, bool allowUnset = false, string unsetCaption = "Select value...", bool addEmptyRow = false, string emptyRowValue = "", bool showNoRecordOption = false, string noRecordValue = "-1", string noRecordText = "No records")
  • public string AddSelectField<TOption>(string fieldName, bool required, string optionValueFieldName, string optionLabelFieldName = null, string optionSortFieldName = null, string fieldLabel = null, string fieldID = null, string groupDataBinding = null, string labelDataBinding = null, string requiredDataBinding = null, string customDataBinding = null, string dependencyFieldName = null, string optionDataBinding = null, string toolTip = null, bool initialFocus = false, RecordRestriction restriction = null, bool allowUnset = false, string unsetCaption = "Select value...", bool addEmptyRow = false, string emptyRowValue = "", bool showNoRecordOption = false, string noRecordValue = "-1", string noRecordText = "No records")
  • public void EstablishUserRolesForPage<TModel>(RecordOperationsCache cache, object viewBag)
  • public void EstablishUserRolesForPage(Type model, RecordOperationsCache cache, object viewBag)
  • public void EstablishUserRolesForPage<TModel>(RecordOperationsCache cache, object viewBag)
  • public void EstablishUserRolesForPage(Type model, RecordOperationsCache cache, object viewBag)
  • public string RenderLookupFunction<TModel>(string valueFieldName, string keyFieldName = "ID", string lookupFunctionName = null, string arrayName = null)
  • public string RenderViewModelConfiguration<TModel>(RecordOperationsCache cache, object viewBag, string defaultSortField = null, string hubClassName = "GSF.Web.Security.SecurityHub", string hubScriptName = "securityHub", object[] parentKeys)
  • public string RenderViewModelConfiguration<TModel>(RecordOperationsCache cache, object viewBag, string defaultSortField = null, string hubClassName = "GSF.Web.Security.SecurityHub", string hubScriptName = "securityHub", object[] parentKeys)
  • public bool UserIsInGroup(string group)
  • public bool UserIsInGroup(string[] groups)
  • public bool UserIsInRole(string role)
  • public bool UserIsInRole(string[] roles)
  • public bool UserIsInGroup(SecurityPrincipal securityPrincipal, string group)
  • public bool UserIsInGroup(SecurityPrincipal securityPrincipal, string[] groups)
  • public bool UserIsInRole(SecurityPrincipal securityPrincipal, string role)
  • public bool UserIsInRole(SecurityPrincipal securityPrincipal, string[] roles)
• public class HtmlHelper
  • public IEncodedString IncludeResouce(string resourceName)
  • public IEncodedString IncludeResource(string resourceName)
• public interface IRecordOperationsHub : IDisposable
• public class RazorEngine<TLanguage> : IRazorEngine, IRazorEngineService, IDisposable where TLanguage : LanguageConstraint
  • public Task PreCompile(Type modelType, Action<Exception> exceptionHandler = null)
• public class RazorView
  • public const double DefaultSessionMonitorInterval = 60000
  • public const double DefaultSessionTimeout = 20
  • public static double SessionMonitorInterval { get; }
  • public static double SessionTimeout { get; }
  • public ReadonlyWebServerOptions WebServerOptions { get; set; }
  • public static event EventHandler<EventArgs<Guid, DynamicViewBag>> SessionExpired
  • public RazorView(IRazorEngine razorEngine, string templateName, object model = null, Type modelType = null, Type pagedViewModelDataType = null, Type pagedViewModelHubType = null, AdoDataConnection database = null, Action<Exception> exceptionHandler = null)
  • public RazorView(IRazorEngine razorEngine, string templateName, object model = null, Type modelType = null, Type pagedViewModelDataType = null, Type pagedViewModelHubType = null, AdoDataConnection database = null, Action<Exception> exceptionHandler = null, ReadonlyWebServerOptions webServerOptions = null)
  • public static bool ClearSessionCache(Guid sessionID)
  • public string Execute(HttpRequestMessage request, bool isPost)
  • public Task<string> ExecuteAsync(HttpRequestMessage request, bool isPost, CancellationToken cancellationToken)
  • public string Execute(HttpRequestMessage request, HttpResponseMessage response, bool isPost)
  • public Task<string> ExecuteAsync(HttpRequestMessage request, HttpResponseMessage response, bool isPost, CancellationToken cancellationToken)
• public class RecordOperationsCache

GSF.Web.Model.Handlers

• public class CsvDownloadHandler : IHttpHandler, IHostedHttpHandler
  • public static Action<Exception> LogExceptionHandler

GSF.Web.Security

• public static class AppBuilderExtensions
  • public static IAppBuilder UseAuthentication(this IAppBuilder app, AuthenticationOptions options)
• public class AuthenticationHandler : AuthenticationHandler<AuthenticationOptions>
  • public AuthenticationHandler()
  • public static bool ClearAuthorizationCache(Guid sessionID)
  • public static bool TryGetPrincipal(Guid sessionID, out SecurityPrincipal securityPrincipal)
• public class AuthenticationMiddleware : AuthenticationMiddleware<AuthenticationOptions>
  • public AuthenticationMiddleware(OwinMiddleware next, AuthenticationOptions options)
• public class AuthenticationOptions : AuthenticationOptions
  • public const string DefaultAnonymousResourceExpression = "^/@|^/favicon.ico$"
  • public const AuthenticationSchemes DefaultAuthenticationSchemes = 12
  • public const string DefaultAuthFailureRedirectResourceExpression = "^/$|^/.+\\.cshtml$|^/.+\\.vbhtml$"
  • public const string DefaultAuthTestPage = "/AuthTest"
  • public const string DefaultClearCredentialsParameter = "clearcredentials"
  • public const string DefaultLoginPage = "/@GSF/Web/Security/Views/Login.cshtml"
  • public const string DefaultPassThroughAuthSupportedBrowserExpression = "^(.+\\(Windows.+(MSIE |Trident/))|(.+\\(Windows.+Chrome/((?! Edge/).)*)$"
  • public string AnonymousResourceExpression { get; set; }
  • public AuthenticationSchemes AuthenticationSchemes { get; set; }
  • public string AuthenticationToken { get; set; }
  • public string AuthFailureRedirectResourceExpression { get; set; }
  • public string AuthTestPage { get; set; }
  • public string ClearCredentialsParameter { get; set; }
  • public string LoginHeader { get; set; }
  • public string LoginPage { get; set; }
  • public string PassThroughAuthSupportedBrowserExpression { get; set; }
  • public ReadonlyAuthenticationOptions Readonly { get; }
  • public string Realm { get; set; }
  • public string SessionToken { get; set; }
  • public AuthenticationOptions()
  • public bool IsAnonymousResource(string urlPath)
  • public bool IsAuthFailureRedirectResource(string urlPath)
• public class AuthorizationCache
  • public static void CacheAuthorization(string userName, string securitySettingsCategory)
• public class AuthorizeControllerRoleAttribute : FilterAttribute, IAuthorizationFilter, IExceptionFilter
  • public string SettingsCategory { get; set; }
  • public string SecuritySettingsCategory { get; set; }
• public class AuthorizeHubRoleAttribute : AuthorizeAttribute
  • public string SettingsCategory { get; set; }
  • public string SecuritySettingsCategory { get; set; }
• public static class HttpConfigurationExtensions
  • public static void EnableSessions(this HttpConfiguration httpConfig, AuthenticationOptions options)
• public class ReadonlyAuthenticationOptions
  • public string AnonymousResourceExpression { get; }
  • public AuthenticationSchemes AuthenticationSchemes { get; }
  • public string AuthFailureRedirectResourceExpression { get; }
  • public string AuthTestPage { get; }
  • public string ClearCredentialsParameter { get; }
  • public string LoginHeader { get; }
  • public string LoginPage { get; }
  • public string PassThroughAuthSupportedBrowserExpression { get; }
  • public string Realm { get; }
  • public string SessionToken { get; }
  • public static ReadonlyAuthenticationOptions GetAuthenticationOptions(HttpRequestMessage request)
  • public bool IsAnonymousResource(string urlPath)
  • public bool IsAuthFailureRedirectResource(string urlPath)
• public class SecurityHub : RecordOperationsHub<SecurityHub>
  • public RecordOperationsCache RecordOperationsCache { get; }
  • public SecurityHub(DataContext dataContext)
  • public static RecordOperationsCache GetRecordOperationsCache()
  • public SecurityHub(Action<string, UpdateType> logStatusMessageFunction, Action<Exception> logExceptionFunction)
  • public SecurityHub(string settingsCategory, Action<string, UpdateType> logStatusMessageFunction, Action<Exception> logExceptionFunction)
  • public Guid GetDefaultNodeID()
  • public bool Logout(string cookieSessionID)
• public class SessionHandler : DelegatingHandler
  • public const string DefaultAuthenticationToken = "x-gsf-auth"
  • public const string DefaultSessionToken = "x-gsf-session"
  • public string AuthenticationToken { get; }
  • public string SessionToken { get; }
  • public static event EventHandler<EventArgs<Exception>> ProcessException
  • public SessionHandler(string authenticationToken = "x-gsf-auth", string sessionToken = "x-gsf-session")
  • public static string GetAuthenticationTokenFromCookie(HttpRequestMessage request, string authenticationToken)
  • public static string GetAuthenticationTokenFromCookie(IOwinRequest request, string authenticationToken)
  • public static Guid GetSessionIDFromCookie(HttpRequestMessage request, string sessionToken)
  • public static Guid GetSessionIDFromCookie(IOwinRequest request, string sessionToken)
  • public static Guid GetSessionIDFromCookie(IRequest request, string sessionToken)
  • public static bool TryGetCachedCredentials(string authenticationToken, out string username, out string password)
  • public static bool TryGetSessionID(HttpRequestMessage request, string sessionToken, out Guid sessionID)

GSF.Web.Shared

• public static class Resources
  • public static readonly string HeaderIcons
  • public const string Root = "/@GSF/Web"