GSF.Web
Contains embedded ASP.NET web pages and WCF web services that support the implementation of role-based security in .NET and non-.NET based development platforms.
Attribute indicating the location of an embedded resource that should be
served by the .
This attribute is used by the
module/path provider to retrieve the list of embedded resources from an assembly
that should be considered a part of the virtual filesystem.
Below is an example of what it might look like to embed a web form and a
user control in an assembly to be served up with the :
[assembly: EmbeddedResourceFileAttribute("MyNamespace.WebForm1.aspx", "MyNamespace")]
[assembly: EmbeddedResourceFileAttribute("MyNamespace.UserControl1.ascx", "MyNamespace")]
Internal storage for the
property.
Internal storage for the
property.
Initializes a new instance of the class.
The path to the embedded resource. Used to get the resource as a stream from the assembly.
The namespace the resource is in. This will generally be removed from the full resource path to calculate the "application path" for the embedded resource.
Thrown if or is .
Thrown if is
or if it only consists of periods and/or spaces.
Both and
will be processed to have leading and trailing periods and spaces removed.
If ends up being empty, an
is thrown. No exception
is thrown if turns out empty.
If the is RootNS.SubNS.AppRoot.Folder.File.aspx
and the is RootNS.SubNS.AppRoot,
the virtual "path" to the embedded file will be Folder.File.aspx
(which will be converted by the
to ~/Folder/File.aspx).
Removes leading and trailing dots and spaces from a string.
The to be cleaned up.
A version of with leading and trailing dots and spaces removed.
Regular expression indicating the characters that can't start or end a resource.
Gets the namespace for the embedded resource.
A with the embedded resource namespace.
This namespace will be removed from the full
to create the virtual application path for the resource.
Gets the path to the embedded resource.
A with the full path to an embedded resource in
the associated assembly.
This path will be used to retrieve the resource from the assembly and serve
it up.
A that allows serving
pages from embedded resources.
ASP.NET retrieves files to serve via the .
Rather than opening a file via , you ask
the for its
and ask that provider for the file. The provider will return a
reference that will allow you
to open a stream on the file and use the contents.
This implementation of
allows you to serve files to ASP.NET through embedded resources. Rather
than deploying your web forms, user controls, etc., to the file system,
you can embed the files as resources right in your assembly and deploy
just your assembly. The
mechanism will take care of the rest.
Most implementations
handle both directories and files. This implementation handles only files.
As such, if the is
used to enumerate available files (as in directory browsing), files provided
via embedded resource will not be included.
To use this , you need
to do four things to your web application.
First, you need to set all of the files you want to serve from your assembly
as embedded resources. By default, web forms and so forth are set as "content"
files; setting them as embedded resources will package them into your assembly.
Second, in your AssemblyInfo.cs file (or whichever file you are
declaring your assembly attributes in) you need to add one
for
every file you plan on serving. This lets the provider know which embedded
resources are available and which are actually resources for other purposes.
Your assembly attributes will look something like this:
[assembly: EmbeddedResourceFileAttribute("MyNamespace.WebForm1.aspx", "MyNamespace")]
[assembly: EmbeddedResourceFileAttribute("MyNamespace.UserControl1.ascx", "MyNamespace")]
Third, you need to register this provider at application startup so ASP.NET
knows to use it. In your Global.asax, during Application_OnStart,
put the following:
System.Web.Hosting.HostingEnvironment.RegisterVirtualPathProvider(new EmbeddedResourcePathProvider());
Fourth, in your web.config file, you need to set up a configuration
section called embeddedFileAssemblies that lets the provider know
which assemblies should be queried for embedded files. A sample configuration
section looks like this:
<configuration>
<configSections>
<section name="embeddedFileAssemblies" type="GSF.Configuration.StringCollectionSectionHandler, GSF.Web.Hosting.EmbeddedResourcePathProvider"/>
</configSections>
<embeddedFileAssemblies>
<add value="My.Web.Assembly"/>
</embeddedFileAssemblies>
<!-- ... other web.config items ... -->
</configuration>
Once you have that set up, you're ready to serve files from embedded resources.
Simply deploy your application without putting the embedded resource files
into the filesystem. When you visit the embedded locations, the provider
will automatically retrieve the proper embedded resource.
File paths are mapped into the application using the
declarations and the
method. This allows you to set up your web application as normal in
Visual Studio and the folder structure, which automatically generates
namespaces for your embedded resources, will translate into virtual folders
in the embedded resource "filesystem."
By default, files that are embedded as resources will take precedence over
files in the filesystem. If you would like the files in the filesystem
to take precedence (that is, if you would like to allow the filesystem
to "override" embedded files), you can set a key in the appSettings
section of your web.config file that enables overrides:
<configuration>
<!-- ... other web.config items ... -->
<appSettings>
<add key="GSF.Web.Hosting.EmbeddedResourcePathProvider.AllowOverrides" value="true"/>
</appSettings>
</configuration>
For more information on virtual filesystems in ASP.NET, check out
.
The standard web application "app relative root" path.
The name of the configuration section containing the list of assemblies
that should participate in the virtual filesystem.
Appsettings key that indicates if filesystem files should override
embedded files.
Internal storage for the
property.
Gets a value that indicates whether a file exists in the virtual file system.
The path to the virtual file.
if the file exists in the virtual file system; otherwise, .
This override checks to see if the embedded resource file exists
in memory. If so, this method will return .
If not, it returns the value from the
virtual path provider.
Thrown if is .
Thrown if is .
Creates a cache dependency based on the specified virtual paths.
The path to the primary virtual resource.
An array of paths to other resources required by the primary virtual resource.
The UTC time at which the virtual resources were read.
A object for the specified virtual resources.
Thrown if is .
Thrown if is .
Gets a virtual file from the virtual file system.
The path to the virtual file.
A descendent of the class that represents a file in the virtual file system.
Thrown if is .
Thrown if is .
Initializes the instance.
The set of assemblies configured to provide embedded resource files
are queried for
attributes. For each one present, the associated embedded resource
is added to the virtual filesystem served by this provider.
Gets the names of the configured assemblies from configuration.
A with
the names of the configured assemblies that should participate in this
path provider.
Maps an embedded resource ID into a web application relative path (~/path).
The base namespace of the resource to map.
The fully qualified embedded resource path to map.
The mapped path of the resource into the web application.
The is stripped from the front of the
and all but the last period in the remaining
is replaced with the directory separator character
('/'). Finally, that path is mapped into a web application relative path.
The filename being mapped must have an extension associated with it, and that
extension may not have a period in it. Only one period will be kept in the
mapped filename - others will be assumed to be directory separators. If a filename
has multiple extensions (i.e., My.Custom.config), it will not map properly -
it will end up being ~/My/Custom.config.
If does not occur at the start of the
, an
is thrown.
Given a of MyNamespace,
this method will process as follows:
value
Mapping in Web App
-
MyNamespace.Config.MyFile.config
~/Config/MyFile.config
-
MyNamespace.MyPage.aspx
~/MyPage.aspx
Thrown if or is .
Thrown if or :
-
Is .
-
Start or end with period.
-
Contain two or more periods together (like MyNamespace..MySubnamespace).
Validates an embedded resource path or namespace.
The name of the parameter being validated.
The path/namespace to validate.
Thrown if is .
Thrown if :
-
Is .
-
Start or end with period.
-
Contain two or more periods together (like MyNamespace..MySubnamespace).
Determines if a file should be handled by the base provider or if
it should be handled by this provider.
The absolute path to the file to check.
if processing of the file at
should be done by the base provider;
if this provider should handle it.
Reads in the embedded files from an assembly an processes them into
the virtual filesystem.
The name of the to load and process.
Thrown if is .
Thrown if is .
Thrown if the indicated by
is not found.
The will be passed to
so the associated assembly can be processed. If the assembly is not
found, a is thrown.
Once the assembly is retrieved, it is queried for
instances. For each one found, the associated resources are processed
into virtual files that will be stored in
for later use.
Gets a value indicating if embedded files can be overridden.
if embedded files can be overridden by other
files (e.g., if filesystem files override embedded files);
if not. Defaults to .
This property uses the
key
to determine if overrides are allowed. If the key is present, it is
parsed to a and that value is returned.
If the key is not present or if any error occurs during the parsing,
is returned.
Gets the collection of files served by this provider.
A
that contains all of the files served by this provider.
Represents a file object in embedded resource space.
This type is used by the
to serve embedded resources as virtual files. The properties on the
file can be used to retrieve an embedded resource stream from the
at the appropriate
using reflection. As part of the
interface, you can do this easily via .
For more information on embedded resource virtual filesystem
usage, see
Internal storage for the
property.
Internal storage for the
property.
Initializes a new instance of the class.
The virtual path to the resource represented by this instance.
The containing the resource represented by this instance.
The path to the embedded resource in the .
Thrown if or is .
Thrown if is .
Returns a read-only stream to the virtual resource.
A read-only stream to the virtual file.
Gets a reference to the assembly containing the virtual file.
A that contains the embedded
resource with the file contents.
Gets the path to the embedded resource in the containing assembly.
A that indicates an embedded resource
in the
that represents the file for this instance.
Contains classes that make-up the framework for serving content embedded in .NET assemblies over the web.
A strongly typed
where each element is a and is keyed
off of the
property.
The default constructor for this collection does a culture-invariant case-insensitive
comparison on the keys. This allows for proper case-insensitive web-oriented
behavior that is generally expected.
Initializes a new instance of the class that uses a case-insensitive comparer.
Initializes a new instance of the class that uses the specified equality comparer.
The implementation of the
generic interface to use when comparing keys, or to use the default
equality comparer for the type of the key, obtained from .
Initializes a new instance of the class that uses the specified equality comparer.
The implementation of the
generic interface to use when comparing keys, or to use the default
equality comparer for the type of the key, obtained from .
The number of elements the collection can hold without creating a lookup dictionary
(0 creates the lookup dictionary when the first item is added), or ?1 to specify that
a lookup dictionary is never created.
Extracts the key from the specified element.
The element from which to extract the key ().
Embedded WCF service contract used for securing external facing WCF services.
Returns information about the current user.
An object of the user if user's security context has been initialized, otherwise null.
Refreshes and returns information about the current user.
An object of the user if user's security context has been initialized, otherwise null.
Authenticates a user and caches the security context upon successful authentication for subsequent use.
Username of the user.
Password of the user.
An object of the user.
Resets user password.
Answer to user's security question.
true if password is reset, otherwise false.
Changes user password.
User's current password.
User's new password.
true if the password is changed, otherwise false.
Contains classes and extension functions related to .NET web enabled platforms such as ASP.NET and WCF.
Represents an HTTP module that can be used to enable site-wide role-based security.
Required config file entries:
]]>
Initializes the .
An object.
Releases the resources used by .
Redirects the client browser based on the specified
to be used for the redirect.
Gets the name of resource being accessed.
.. property value.
Determines if access to the requested resource is restricted by .
true if access to the requested resource is restricted, otherwise false.
Gets the current instance.
A handler used to force the SessionStateModule to load session state.
Initializes a new instance of the class.
The original handler object.
This method will never get called.
Returns false since class has a member.
Embedded web page used by secure ASP.NET web sites for security related tasks.
Config file entries for customizing the page:
]]>
Initializes the web page.
Source of this event.
Arguments of this event.
Logins the user.
Source of this event.
Arguments of this event.
Updates user data.
Source of this event.
Arguments of this event.
Changes user password.
Source of this event.
Arguments of this event.
Checks if user password can be reset.
Source of this event.
Arguments of this event.
Resets user password.
Source of this event.
Arguments of this event.
StyleSheet control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
MainForm control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
LogoLink control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
LogoImage control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
HelpLink control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
HelpImage control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ContentPlaceHolder control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
MessageLabel control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
FooterLabel control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
LoginPanel control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
LoginUsernameValidator control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
LoginUsername control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
RememberUsername control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
LoginPasswordValidator control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
LoginPassword control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ForgotPassword control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ChangePassword control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
LoginButton control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ResetPasswordCheckPanel control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ResetPasswordUsernameValidator control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ResetPasswordUsername control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ResetCheckButton control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ResetPasswordFinalPanel control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ResetPasswordSecurityQuestion control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ResetPasswordSecurityAnswer control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ResetFinalButton control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ChangePasswordPanel control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ChangePasswordUsernameValidator control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ChangePasswordUsername control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ChangePasswordOldPasswordValidator control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ChangePasswordOldPassword control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ChangePasswordNewPasswordValidator1 control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ChangePasswordNewPasswordValidator2 control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ChangePasswordNewPassword control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ChangePasswordConfirmNewPasswordValidator1 control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ChangePasswordConfirmNewPasswordValidator2 control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ChangePasswordConfirmNewPassword control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
ChangeButton control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
MyAccountPanel control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
AccountUsername control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
AccountUserCompany control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
AccountUserFirstNameValidator control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
AccountUserFirstName control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
AccountUserLastNameValidator control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
AccountUserLastName control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
AccountUserEmailAddressValidator control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
AccountUserEmailAddress control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
AccountUserPhoneNumberAddressValidator control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
AccountUserPhoneNumber control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
AccountUserSecurityQuestion control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
AccountUserSecurityAnswerValidator control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
AccountUserSecurityAnswer control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
UpdateButton control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
AccessDeniedPanel control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
WarningImage control.
Auto-generated field.
To modify move field declaration from designer file to code-behind file.
Embedded WCF service that can be used for securing applications using role-based security.
This list shows the endpoints exposed by :
URI
Protocol
-
~/SecurityService.svc/soap
SOAP 1.1
-
~/SecurityService.svc/rest
REST
This example shows how to consume the REST endpoint of using jQuery:
]]>
Returns information about the current user.
An object of the user if user's security context has been initialized, otherwise null.
Refreshes and returns information about the current user.
An object of the user if user's security context has been initialized, otherwise null.
Authenticates a user and caches the security context upon successful authentication for subsequent use.
Username of the user.
Password of the user.
An object of the user.
Resets user password.
Answer to user's security question.
true if password is reset, otherwise false.
Changes user password.
User's current password.
User's new password.
true if the password is changed, otherwise false.
Specifies the buttons to be displayed in a message box.
OK Button.
OK and Cancel buttons.
Abort,Retry, and Ignore buttons.
Yes, No, and Cancel buttons.
Yes and No buttons.
Retry and Cancel buttons.
Critical message.
Warning query.
Warning message.
Information message.
First button is default.
Second button is default.
Third button is default.
Fourth button is default.
Application modal message box.
System modal message box.
Defines javascript client-side extensions for web controls.
Performs JavaScript encoding on given string.
The string to be encoded.
Decodes JavaScript characters from given string.
The string to be decoded.
Registers a default button to be activated when the ENTER key is pressed inside this .
for which the default button is to be registered.
Button to be assigned as the default action handler.
Registers the to be disabled after one click to prevent multiple postbacks.
for which submit once script is to be registered.
Brings the 's browser window to the foreground.
to be brought to the foreground.
Pushes the 's browser window to the background.
to be pushed to the background.
Registers this to perform a page refresh.
to refresh.
Refreshes the after the page content has loaded.
Registers the to perform a page refresh.
that will perform a page refresh when clicked.
Shows a modeless popup window for the specified web page when the has loaded.
that will show the popup window when loaded.
Web page url for which the popup windows is to be shown.
Height of the popup window.
Width of the popup window.
Location of the popup window on X-axis.
Location of the popup window on Y-axis.
True if the popup window is to be centered, otherwise False.
True if help button is to be displayed, otherwise False.
True if the popup window can be resized, otherwise False.
True if the status bar is to be displayed, otherwise False.
Shows a modeless popup window for the specified web page when the is clicked.
that will show the popup window when clicked.
Web page url for which the popup windows is to be shown.
Height of the popup window.
Width of the popup window.
Location of the popup window on X-axis.
Location of the popup window on Y-axis.
True if the popup window is to be centered, otherwise False.
True if help button is to be displayed, otherwise False.
True if the popup window can be resized, otherwise False.
True if the status bar is to be displayed, otherwise False.
Shows a modal popup window for the specified web page when the has loaded.
Web page that will show the popup window when loaded.
Web page url for which the popup windows is to be shown.
whose text is to updated with the text returned by the web page displayed in the popup window.
Height of the popup window.
Width of the popup window.
Location of the popup window on X-axis.
Location of the popup window on Y-axis.
True if the popup window is to be centered, otherwise False.
True if help button is to be displayed, otherwise False.
True if the popup window can be resized, otherwise False.
True if the status bar is to be displayed, otherwise False.
Shows a modal popup window for the specified web page when the is clicked.
that will show the popup window when clicked.
Web page url for which the popup windows is to be shown.
whose text is to updated with the text returned by the web page displayed in the popup window.
Height of the popup window.
Width of the popup window.
Location of the popup window on X-axis.
Location of the popup window on Y-axis.
True if the popup window is to be centered, otherwise False.
True if help button is to be displayed, otherwise False.
True if the popup window can be resized, otherwise False.
True if the status bar is to be displayed, otherwise False.
Shows a popup for the specified web page when the has loaded.
that will show the popup when loaded.
Web page url for which the popup is to be shown.
Height of the popup.
Width of the popup.
Location of the popup on X-axis.
Location of the popup on Y-axis.
True if the popup is to be centered, otherwise False.
True if the popup can be resized, otherwise False.
True is the scrollbars are to be displayed, otherwise False.
True if the toolbar is to be displayed, otherwise False.
True if the menu bar is to be displayed, otherwise False.
True if the address bar is to be displayed, otherwise False.
True if the status bar is to be displayed, otherwise False.
True if the directories buttons (Netscape only) are to be displayed, otherwise False.
Shows a popup for the specified web page when the is clicked.
that will show the popup when clicked.
Web page url for which the popup is to be shown.
Height of the popup.
Width of the popup.
Location of the popup on X-axis.
Location of the popup on Y-axis.
True if the popup is to be centered, otherwise False.
True if the popup can be resized, otherwise False.
True is the scrollbars are to be displayed, otherwise False.
True if the toolbar is to be displayed, otherwise False.
True if the menu bar is to be displayed, otherwise False.
True if the address bar is to be displayed, otherwise False.
True if the status bar is to be displayed, otherwise False.
True if the directories buttons (Netscape only) are to be displayed, otherwise False.
Closes the current when it has finished loading in the browser and returns the specified to the web page that opened it.
to be closed.
Value to be returned to the parent web page.
Closes the current page when the is clicked and returns the specified to the web page that opened it.
that will close the current web page when clicked.
Value to be returned to the parent web page.
Shows a windows application style message box when the has loaded.
that will show the message box when loaded.
Text that is to be displayed in the message box.
Title of the message box.
Buttons to be displayed in the message box.
True if a post-back is to be performed when either OK, Retry, or Yes buttons are clicked in the message box, otherwise False.
Shows a windows application style message box when the is clicked.
that will show the message box when clicked.
Text that is to be displayed in the message box.
Title of the message box.
Buttons to be displayed in the message box.
True if a post-back is to be performed when either OK, Retry, or Yes buttons are clicked in the message box, otherwise False.