Export (0) Print
Expand All

Authorization.ProtectionRealm Property

Gets or sets the prefix for Uniform Resource Identifiers (URIs) that can be authenticated with the Message property.

Namespace: System.Net
Assembly: System (in system.dll)

public:
property array<String^>^ ProtectionRealm {
	array<String^>^ get ();
	void set (array<String^>^ value);
}
/** @property */
public String[] get_ProtectionRealm ()

/** @property */
public void set_ProtectionRealm (String[] value)

public function get ProtectionRealm () : String[]

public function set ProtectionRealm (value : String[])

Not applicable.

Property Value

An array of strings that contains URI prefixes.

The ProtectionRealm property contains a list of URI prefixes that the Message property can be used to authenticate. WebRequest and its descendants compare a URI to this list to determine if the Authorization is valid for a particular URI.

The following code example gets or sets the prefix for URIs that can be authenticated with the Message property.

virtual Authorization^ Authenticate( String^ challenge, WebRequest^ request, ICredentials^ credentials )
{
   try
   {
      String^ message;

      // Check if Challenge String* was raised by a site which requires 'CloneBasic' authentication.
      if ( (challenge == nullptr) || ( !challenge->StartsWith( "CloneBasic" )) )
               return nullptr;
      NetworkCredential^ myCredentials;
      if ( dynamic_cast<CredentialCache^>(credentials) == nullptr )
      {
         myCredentials = credentials->GetCredential( request->RequestUri, "CloneBasic" );
         if ( myCredentials == nullptr )
                     return nullptr;
      }
      else
               myCredentials = dynamic_cast<NetworkCredential^>(credentials);

      // Message encryption scheme :
      //   a)Concatenate username and password seperated by space;
      //   b)Apply ASCII encoding to obtain a stream of bytes;
      //   c)Apply Base64 Encoding to this array of bytes to obtain our encoded authorization message.
      message = String::Concat( myCredentials->UserName, " ", myCredentials->Password );

      // Apply AsciiEncoding to 'message' String* to obtain it as an array of bytes.
      Encoding^ ascii = Encoding::ASCII;
      array<Byte>^byteArray = gcnew array<Byte>(ascii->GetByteCount( message ));
      byteArray = ascii->GetBytes( message );

      // Performing Base64 transformation.
      message = Convert::ToBase64String( byteArray );
      Authorization^ myAuthorization = gcnew Authorization( String::Concat( "CloneBasic ", message, true ) );
      array<String^>^protectionRealm = gcnew array<String^>(1);
      protectionRealm[ 0 ] = request->RequestUri->AbsolutePath;
      myAuthorization->ProtectionRealm = protectionRealm;
      return myAuthorization;
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "The following exception was raised in Authenticate method: {0}", e->Message );
      return nullptr;
   }
}

public Authorization Authenticate(String challenge, WebRequest request, 
    ICredentials credentials)
{
    try {
        String message;

        // Check if Challenge string was raised by a site which requires 
        // 'CloneBasic' authentication.
        if (challenge == null || !(challenge.StartsWith("CloneBasic"))) {
            return null;
        }

        NetworkCredential myCredentials;
        if (credentials instanceof CredentialCache) {
            myCredentials = credentials.GetCredential(
                request.get_RequestUri(), "CloneBasic");
            if (myCredentials == null) {
                return null;
            }
        }
        else {
            myCredentials = (NetworkCredential)credentials;
        } 
        //   Message encryption scheme : 
        //   a)Concatenate userName and password seperated by space;
        //   b)Apply ASCII encoding to obtain a stream of bytes;
        //   c)Apply Base64 Encoding to this array of bytes to obtain our 
        //     encoded authorization message.
        message = myCredentials.get_UserName() + " " 
            + myCredentials.get_Password();

        // Apply AsciiEncoding to 'message' string to obtain it as an array
        // of bytes.
        Encoding ascii = Encoding.get_ASCII();
        ubyte byteArray[] = new ubyte[ascii.GetByteCount(message)];
        byteArray = ascii.GetBytes(message);

        // Performing Base64 transformation.
        message = Convert.ToBase64String(byteArray);
        Authorization myAuthorization = new Authorization("CloneBasic " 
            + message, true);
        String protectionRealm[] = new String[] 
            { request.get_RequestUri().get_AbsolutePath() };
        myAuthorization.set_ProtectionRealm(protectionRealm);
        return myAuthorization;
    }
    catch (System.Exception e) {
        Console.WriteLine("The following exception was raised in "
            + "Authenticate method:{0}", e.get_Message());
        return null;
    }
} //Authenticate

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft