UriScheme.cs source code in C# .NET

Source code for the .NET framework in C#

                        
Code:

                         / Dotnetfx_Win7_3.5.1 / Dotnetfx_Win7_3.5.1 / 3.5.1 / DEVDIV / depot / DevDiv / releases / whidbey / NetFXspW7 / ndp / fx / src / Net / System / UriScheme.cs / 1 / UriScheme.cs
                        

                        
                            //depot/DevDiv/private/Whidbey_Xws/ndp/fx/src/Net/System/UriScheme.cs#4 - edit change 914456 (text) 
/*++
Copyright (c) Microsoft Corporation

Module Name: 

    UriScheme.cs 
 
Abstract:
    Provides extensibility contract for System.Uri 
    The contains only public API definition.

    For remaining internal stuff please refer to the _UriSyntax.cs file.
 
Author:
 
    Alexei Vopilov    19-Dec-2003 

Revision History: 
    Alexei Vopilov    60-July-2004  - Changed the extensiblity model to be based purely on derivation, also has cut Config extensibility option


--*/ 
namespace System {
    using System.Net; 
    using System.Globalization; 
    using System.Security.Permissions;
 
    //
    // The class is used as a base for custom uri parsing and derived Uri factoring.
    // A set of protected .ctors allows to hookup on the builtin parser behaviors.
    // 
    // A developer must implement at least internal default .ctor to participate in the Uri extensibility game.
    // 
    public abstract partial class UriParser { 

        internal string SchemeName 
        {
            get
            {
                return m_Scheme; 
            }
        } 
        internal int DefaultPort { 
            get {
                return m_Port; 
            }
        }

        private const UriSyntaxFlags SchemeOnlyFlags = UriSyntaxFlags.MayHavePath; 
        // This is a "scheme-only" base parser, everything after the scheme is
        // returned as the path component. 
        // The user parser will need to do the majority of the work itself. 
        //
        // However when the ctor is called from OnCreateUri context the calling parser 
        // settings will later override the result on the base class
        //
        protected UriParser(): this (SchemeOnlyFlags) { }
 
        //
        // Is called on each Uri ctor for every non-simple parser i.e. the one that does have 
        // user code. 
        //
        protected virtual UriParser OnNewUri() 
        {
            return this;
        }
        // 
        // Is called whenever a parser gets registered with some scheme
        // The base implementaion is a nop. 
        // 
        protected virtual void OnRegister(string schemeName, int defaultPort)
        { 

        }
        //
        // Parses and validates a Uri object, is called at the Uri ctor time. 
        //
        // This method returns a non null parsingError if Uri being created is invalid: 
        // 
        protected virtual void InitializeAndValidate(Uri uri, out UriFormatException parsingError)
        { 
            parsingError = uri.ParseMinimal();
        }
        //
        // Resolves a relative Uri object into new AbsoluteUri. 
        //
        //  baseUri         - The baseUri used to resolve this Uri. 
        //  relativeuri     - A relative Uri string passed by the application. 
        //
        // This method returns: 
        // The result Uri value used to represent a new Uri
        //
        protected virtual string Resolve(Uri baseUri, Uri relativeUri, out UriFormatException parsingError)
        { 
            if (baseUri.UserDrivenParsing)
                throw new InvalidOperationException(SR.GetString(SR.net_uri_UserDrivenParsing, this.GetType().FullName)); 
 
            if (!baseUri.IsAbsoluteUri)
                throw new InvalidOperationException(SR.GetString(SR.net_uri_NotAbsolute)); 


            string newUriString = null;
            bool userEscaped = false; 
            Uri result = Uri.ResolveHelper(baseUri, relativeUri, ref newUriString, ref userEscaped, out parsingError);
 
            if (parsingError != null) 
                return null;
 
            if (result != null)
                return result.OriginalString;

            return newUriString; 
        }
        // 
        // 
        //
        protected virtual  bool IsBaseOf(Uri baseUri, Uri relativeUri) 
        {
            return baseUri.IsBaseOfHelper(relativeUri);
        }
        // 
        // This method is invoked to allow a cutsom parser to override the
        // internal parser when serving application with Uri componenet strings. 
        // The output format depends on the "format" parameter 
        //
        // Parameters: 
        //  uriComponents   - Which components are to be retrieved.
        //  uriFormat       - The requested output format.
        //
        // This method returns: 
        // The final result. The base impementaion could be invoked to get a suggested value
        // 
        protected virtual string GetComponents(Uri uri, UriComponents components, UriFormat format) 
        {
            if (((components & UriComponents.SerializationInfoString) != 0) && components != UriComponents.SerializationInfoString) 
                throw new ArgumentOutOfRangeException("UriComponents.SerializationInfoString");

            if ((format & ~UriFormat.SafeUnescaped) != 0)
                throw new ArgumentOutOfRangeException("format"); 

            if (uri.UserDrivenParsing) 
                throw new InvalidOperationException(SR.GetString(SR.net_uri_UserDrivenParsing, this.GetType().FullName)); 

            if (!uri.IsAbsoluteUri) 
                throw new InvalidOperationException(SR.GetString(SR.net_uri_NotAbsolute));

            return uri.GetComponentsHelper(components, format);
        } 
        //
        // 
        // 
        protected virtual bool IsWellFormedOriginalString(Uri uri)
        { 
            return uri.InternalIsWellFormedOriginalString();
        }

        // 
        // Static Registration methods
        // 
        // 
        // Registers a custom Uri parser based on a scheme string
        // 
        public static void Register(UriParser uriParser, string schemeName, int defaultPort)
        {
            ExceptionHelper.InfrastructurePermission.Demand();
 
            if (uriParser == null)
                throw new ArgumentNullException("uriParser"); 
 
            if (schemeName == null)
                throw new ArgumentNullException("schemeName"); 

            if (schemeName.Length == 1)
                throw new ArgumentOutOfRangeException("uriParser.SchemeName");
 
            if (!CheckSchemeName(schemeName))
                throw new ArgumentOutOfRangeException("schemeName"); 
 
            if ((defaultPort >= 0xFFFF || defaultPort < 0) && defaultPort != -1)
                throw new ArgumentOutOfRangeException("defaultPort"); 

            schemeName = schemeName.ToLower(CultureInfo.InvariantCulture);
            FetchSyntax(uriParser, schemeName, defaultPort);
        } 
        //
        // Is a Uri scheme known to System.Uri? 
        // 
        public static bool IsKnownScheme(string schemeName)
        { 
            if (schemeName == null)
                throw new ArgumentNullException("schemeName");

            if (!CheckSchemeName(schemeName)) 
                throw new ArgumentOutOfRangeException("schemeName");
 
            UriParser syntax = UriParser.GetSyntax(schemeName.ToLower(CultureInfo.InvariantCulture)); 
            return syntax != null && syntax.NotAny(UriSyntaxFlags.V1_UnknownUri);
        } 
    }
}

// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
// Copyright (c) Microsoft Corporation. All rights reserved.
//depot/DevDiv/private/Whidbey_Xws/ndp/fx/src/Net/System/UriScheme.cs#4 - edit change 914456 (text) 
/*++
Copyright (c) Microsoft Corporation

Module Name: 

    UriScheme.cs 
 
Abstract:
    Provides extensibility contract for System.Uri 
    The contains only public API definition.

    For remaining internal stuff please refer to the _UriSyntax.cs file.
 
Author:
 
    Alexei Vopilov    19-Dec-2003 

Revision History: 
    Alexei Vopilov    60-July-2004  - Changed the extensiblity model to be based purely on derivation, also has cut Config extensibility option


--*/ 
namespace System {
    using System.Net; 
    using System.Globalization; 
    using System.Security.Permissions;
 
    //
    // The class is used as a base for custom uri parsing and derived Uri factoring.
    // A set of protected .ctors allows to hookup on the builtin parser behaviors.
    // 
    // A developer must implement at least internal default .ctor to participate in the Uri extensibility game.
    // 
    public abstract partial class UriParser { 

        internal string SchemeName 
        {
            get
            {
                return m_Scheme; 
            }
        } 
        internal int DefaultPort { 
            get {
                return m_Port; 
            }
        }

        private const UriSyntaxFlags SchemeOnlyFlags = UriSyntaxFlags.MayHavePath; 
        // This is a "scheme-only" base parser, everything after the scheme is
        // returned as the path component. 
        // The user parser will need to do the majority of the work itself. 
        //
        // However when the ctor is called from OnCreateUri context the calling parser 
        // settings will later override the result on the base class
        //
        protected UriParser(): this (SchemeOnlyFlags) { }
 
        //
        // Is called on each Uri ctor for every non-simple parser i.e. the one that does have 
        // user code. 
        //
        protected virtual UriParser OnNewUri() 
        {
            return this;
        }
        // 
        // Is called whenever a parser gets registered with some scheme
        // The base implementaion is a nop. 
        // 
        protected virtual void OnRegister(string schemeName, int defaultPort)
        { 

        }
        //
        // Parses and validates a Uri object, is called at the Uri ctor time. 
        //
        // This method returns a non null parsingError if Uri being created is invalid: 
        // 
        protected virtual void InitializeAndValidate(Uri uri, out UriFormatException parsingError)
        { 
            parsingError = uri.ParseMinimal();
        }
        //
        // Resolves a relative Uri object into new AbsoluteUri. 
        //
        //  baseUri         - The baseUri used to resolve this Uri. 
        //  relativeuri     - A relative Uri string passed by the application. 
        //
        // This method returns: 
        // The result Uri value used to represent a new Uri
        //
        protected virtual string Resolve(Uri baseUri, Uri relativeUri, out UriFormatException parsingError)
        { 
            if (baseUri.UserDrivenParsing)
                throw new InvalidOperationException(SR.GetString(SR.net_uri_UserDrivenParsing, this.GetType().FullName)); 
 
            if (!baseUri.IsAbsoluteUri)
                throw new InvalidOperationException(SR.GetString(SR.net_uri_NotAbsolute)); 


            string newUriString = null;
            bool userEscaped = false; 
            Uri result = Uri.ResolveHelper(baseUri, relativeUri, ref newUriString, ref userEscaped, out parsingError);
 
            if (parsingError != null) 
                return null;
 
            if (result != null)
                return result.OriginalString;

            return newUriString; 
        }
        // 
        // 
        //
        protected virtual  bool IsBaseOf(Uri baseUri, Uri relativeUri) 
        {
            return baseUri.IsBaseOfHelper(relativeUri);
        }
        // 
        // This method is invoked to allow a cutsom parser to override the
        // internal parser when serving application with Uri componenet strings. 
        // The output format depends on the "format" parameter 
        //
        // Parameters: 
        //  uriComponents   - Which components are to be retrieved.
        //  uriFormat       - The requested output format.
        //
        // This method returns: 
        // The final result. The base impementaion could be invoked to get a suggested value
        // 
        protected virtual string GetComponents(Uri uri, UriComponents components, UriFormat format) 
        {
            if (((components & UriComponents.SerializationInfoString) != 0) && components != UriComponents.SerializationInfoString) 
                throw new ArgumentOutOfRangeException("UriComponents.SerializationInfoString");

            if ((format & ~UriFormat.SafeUnescaped) != 0)
                throw new ArgumentOutOfRangeException("format"); 

            if (uri.UserDrivenParsing) 
                throw new InvalidOperationException(SR.GetString(SR.net_uri_UserDrivenParsing, this.GetType().FullName)); 

            if (!uri.IsAbsoluteUri) 
                throw new InvalidOperationException(SR.GetString(SR.net_uri_NotAbsolute));

            return uri.GetComponentsHelper(components, format);
        } 
        //
        // 
        // 
        protected virtual bool IsWellFormedOriginalString(Uri uri)
        { 
            return uri.InternalIsWellFormedOriginalString();
        }

        // 
        // Static Registration methods
        // 
        // 
        // Registers a custom Uri parser based on a scheme string
        // 
        public static void Register(UriParser uriParser, string schemeName, int defaultPort)
        {
            ExceptionHelper.InfrastructurePermission.Demand();
 
            if (uriParser == null)
                throw new ArgumentNullException("uriParser"); 
 
            if (schemeName == null)
                throw new ArgumentNullException("schemeName"); 

            if (schemeName.Length == 1)
                throw new ArgumentOutOfRangeException("uriParser.SchemeName");
 
            if (!CheckSchemeName(schemeName))
                throw new ArgumentOutOfRangeException("schemeName"); 
 
            if ((defaultPort >= 0xFFFF || defaultPort < 0) && defaultPort != -1)
                throw new ArgumentOutOfRangeException("defaultPort"); 

            schemeName = schemeName.ToLower(CultureInfo.InvariantCulture);
            FetchSyntax(uriParser, schemeName, defaultPort);
        } 
        //
        // Is a Uri scheme known to System.Uri? 
        // 
        public static bool IsKnownScheme(string schemeName)
        { 
            if (schemeName == null)
                throw new ArgumentNullException("schemeName");

            if (!CheckSchemeName(schemeName)) 
                throw new ArgumentOutOfRangeException("schemeName");
 
            UriParser syntax = UriParser.GetSyntax(schemeName.ToLower(CultureInfo.InvariantCulture)); 
            return syntax != null && syntax.NotAny(UriSyntaxFlags.V1_UnknownUri);
        } 
    }
}

// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
// Copyright (c) Microsoft Corporation. All rights reserved.

Link Menu

Network programming in C#, Network Programming in VB.NET, Network Programming in .NET
This book is available now!
Buy at Amazon US or
Buy at Amazon UK