class/System.IdentityModel/System.IdentityModel.Tokens/SamlAction.cs

   1 //
   2 // SamlAction.cs
   3 //
   4 // Author:
   5 //      Atsushi Enomoto <atsushi@ximian.com>
   6 //
   7 // Copyright (C) 2005-2006 Novell, Inc.  http://www.novell.com
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28 using System;
  29 using System.Collections.Generic;
  30 using System.Xml;
  31 using System.IdentityModel.Selectors;
  32
  33 namespace System.IdentityModel.Tokens
  34 {
  35         public class SamlAction
  36         {
  37                 string action, ns;
  38                 bool is_readonly;
  39
  40                 public SamlAction ()
  41                 {
  42                 }
  43
  44                 public SamlAction (string action)
  45                 {
  46                         Action = action;
  47                 }
  48
  49                 public SamlAction (string action, string ns)
  50                 {
  51                         Action = action;
  52                         Namespace = ns;
  53                 }
  54
  55                 public string Action {
  56                         get { return action; }
  57                         set {
  58                                 CheckReadOnly ();
  59                                 if (value == null || value.Length == 0)
  60                                         throw new ArgumentException ("SAML Action must be non-zero length string.");
  61                                 action = value;
  62                         }
  63                 }
  64
  65                 public bool IsReadOnly {
  66                         get { return is_readonly; }
  67                 }
  68
  69                 public string Namespace {
  70                         get { return ns; }
  71                         set {
  72                                 CheckReadOnly ();
  73                                 ns = value;
  74                         }
  75                 }
  76
  77                 void CheckReadOnly ()
  78                 {
  79                         if (is_readonly)
  80                                 throw new InvalidOperationException ("This SAML action is read-only.");
  81                 }
  82
  83                 public void MakeReadOnly ()
  84                 {
  85                         is_readonly = true;
  86                 }
  87
  88                 public virtual void ReadXml (XmlDictionaryReader reader,
  89                         SamlSerializer samlSerializer,
  90                         SecurityTokenSerializer keyInfoTokenSerializer,
  91                         SecurityTokenResolver outOfBandTokenResolver)
  92                 {
  93                         if (reader == null)
  94                                 throw new ArgumentNullException ("writer");
  95                         if (samlSerializer == null)
  96                                 throw new ArgumentNullException ("samlSerializer");
  97
  98                         Namespace = reader.GetAttribute ("Namespace");
  99                         Action =  reader.ReadElementContentAsString ("Action", SamlConstants.Namespace);
 100
 101                         if (Action == null)
 102                                 throw new SecurityTokenException ("non-zero length string must exist for SAML Action.");
 103                 }
 104
 105                 public virtual void WriteXml (XmlDictionaryWriter writer,
 106                         SamlSerializer samlSerializer,
 107                         SecurityTokenSerializer keyInfoTokenSerializer)
 108                 {
 109                         if (writer == null)
 110                                 throw new ArgumentNullException ("writer");
 111                         if (samlSerializer == null)
 112                                 throw new ArgumentNullException ("samlSerializer");
 113
 114                         if (Action == null)
 115                                 throw new SecurityTokenException ("non-zero length string must be set for SAML Action before being written.");
 116
 117                         writer.WriteStartElement ("saml", "Action", SamlConstants.Namespace);
 118                         if (Namespace != null)
 119                                 writer.WriteAttributeString ("Namespace", Namespace);
 120                         writer.WriteString (Action);
 121                         writer.WriteEndElement ();
 122                 }
 123         }
 124 }