File: AssociateRequest.html

package info (click to toggle)
libopenid-ruby 2.1.8debian-1%2Bsqueeze1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 5,300 kB
  • ctags: 3,346
  • sloc: ruby: 17,403; xml: 219; sh: 78; python: 30; makefile: 15
file content (248 lines) | stat: -rw-r--r-- 6,802 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Class: OpenID::Server::AssociateRequest</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Class</strong></td>
          <td class="class-name-in-header">OpenID::Server::AssociateRequest</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../../../files/lib/openid/server_rb.html">
                lib/openid/server.rb
                </a>
        <br />
            </td>
        </tr>

        <tr class="top-aligned-row">
            <td><strong>Parent:</strong></td>
            <td>
                <a href="OpenIDRequest.html">
                OpenIDRequest
               </a>
            </td>
        </tr>
        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="description">
      <p>
A request to establish an association.
</p>
<p>
See <a href="../../OpenID.html">OpenID</a> Specs, Section 8: Establishing
Associations &lt;<a
href="http://openid.net/specs/openid-authentication-2_0-12.html#associations">openid.net/specs/openid-authentication-2_0-12.html#associations</a>&gt;
</p>

    </div>


   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000245">answer</a>&nbsp;&nbsp;
      <a href="#M000246">answer_unsupported</a>&nbsp;&nbsp;
      <a href="#M000244">from_message</a>&nbsp;&nbsp;
      <a href="#M000243">new</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->

    <div id="section">





    <div id="attribute-list">
      <h3 class="section-bar">Attributes</h3>

      <div class="name-list">
        <table>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">assoc_type</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc">
The type of association. Supported values include HMAC-SHA256 and HMAC-SHA1

</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">session</td>
          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
          <td class="context-item-desc">
An object that knows how to handle association requests of a certain type.

</td>
        </tr>
        </table>
      </div>
    </div>
      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000244" class="method-detail">
        <a name="M000244"></a>

        <div class="method-heading">
          <a href="AssociateRequest.src/M000244.html" target="Code" class="method-signature"
            onclick="popupCode('AssociateRequest.src/M000244.html');return false;">
          <span class="method-name">from_message</span><span class="method-args">(message, op_endpoint=UNUSED)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Construct me from an <a href="../../OpenID.html">OpenID</a> <a
href="../Message.html">Message</a>.
</p>
        </div>
      </div>

      <div id="method-M000243" class="method-detail">
        <a name="M000243"></a>

        <div class="method-heading">
          <a href="AssociateRequest.src/M000243.html" target="Code" class="method-signature"
            onclick="popupCode('AssociateRequest.src/M000243.html');return false;">
          <span class="method-name">new</span><span class="method-args">(session, assoc_type)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Construct me.
</p>
<p>
The session is assigned directly as a class attribute. See my class
documentation for its description.
</p>
        </div>
      </div>

      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000245" class="method-detail">
        <a name="M000245"></a>

        <div class="method-heading">
          <a href="AssociateRequest.src/M000245.html" target="Code" class="method-signature"
            onclick="popupCode('AssociateRequest.src/M000245.html');return false;">
          <span class="method-name">answer</span><span class="method-args">(assoc)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Respond to this request with an association.
</p>
<table>
<tr><td valign="top">assoc:</td><td>The association to send back.

</td></tr>
</table>
<p>
Returns a response with the association information, encrypted to the
consumer&#8216;s public key if appropriate.
</p>
        </div>
      </div>

      <div id="method-M000246" class="method-detail">
        <a name="M000246"></a>

        <div class="method-heading">
          <a href="AssociateRequest.src/M000246.html" target="Code" class="method-signature"
            onclick="popupCode('AssociateRequest.src/M000246.html');return false;">
          <span class="method-name">answer_unsupported</span><span class="method-args">(message, preferred_association_type=nil, preferred_session_type=nil)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Respond to this request indicating that the association type or association
session type is not supported.
</p>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>