/lib/bouncycastle/docs/org/bouncycastle/asn1/cms/Attribute.html
HTML | 372 lines | 310 code | 39 blank | 23 comment | 0 complexity | 3c6ba064074b33309aff2abacf21f4fb MD5 | raw file
Possible License(s): LGPL-2.1, BSD-3-Clause, Apache-2.0
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0) on Mon Jan 11 13:46:33 EST 2010 -->
6<TITLE>
7Attribute (Bouncy Castle Library 1.45 API Specification)
8</TITLE>
9
10<META NAME="date" CONTENT="2010-01-11">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 if (location.href.indexOf('is-external=true') == -1) {
18 parent.document.title="Attribute (Bouncy Castle Library 1.45 API Specification)";
19 }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39 <TR ALIGN="center" VALIGN="top">
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
47 </TR>
48</TABLE>
49</TD>
50<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51<b>Bouncy Castle Cryptography Library 1.45</b></EM>
52</TD>
53</TR>
54
55<TR>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 PREV CLASS
58 <A HREF="../../../../org/bouncycastle/asn1/cms/AttributeTable.html" title="class in org.bouncycastle.asn1.cms"><B>NEXT CLASS</B></A></FONT></TD>
59<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60 <A HREF="../../../../index.html?org/bouncycastle/asn1/cms/Attribute.html" target="_top"><B>FRAMES</B></A>
61 <A HREF="Attribute.html" target="_top"><B>NO FRAMES</B></A>
62 <SCRIPT type="text/javascript">
63 <!--
64 if(window==top) {
65 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
66 }
67 //-->
68</SCRIPT>
69<NOSCRIPT>
70 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
71</NOSCRIPT>
72
73
74</FONT></TD>
75</TR>
76<TR>
77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.bouncycastle.asn1.ASN1Encodable">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
81</TR>
82</TABLE>
83<A NAME="skip-navbar_top"></A>
84<!-- ========= END OF TOP NAVBAR ========= -->
85
86<HR>
87<!-- ======== START OF CLASS DATA ======== -->
88<H2>
89<FONT SIZE="-1">
90org.bouncycastle.asn1.cms</FONT>
91<BR>
92Class Attribute</H2>
93<PRE>
94java.lang.Object
95 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/bouncycastle/asn1/ASN1Encodable.html" title="class in org.bouncycastle.asn1">org.bouncycastle.asn1.ASN1Encodable</A>
96 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.bouncycastle.asn1.cms.Attribute</B>
97</PRE>
98<DL>
99<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/bouncycastle/asn1/DEREncodable.html" title="interface in org.bouncycastle.asn1">DEREncodable</A></DD>
100</DL>
101<DL>
102<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/bouncycastle/asn1/smime/SMIMECapabilitiesAttribute.html" title="class in org.bouncycastle.asn1.smime">SMIMECapabilitiesAttribute</A>, <A HREF="../../../../org/bouncycastle/asn1/smime/SMIMEEncryptionKeyPreferenceAttribute.html" title="class in org.bouncycastle.asn1.smime">SMIMEEncryptionKeyPreferenceAttribute</A></DD>
103</DL>
104<HR>
105<DL>
106<DT><PRE>public class <B>Attribute</B><DT>extends <A HREF="../../../../org/bouncycastle/asn1/ASN1Encodable.html" title="class in org.bouncycastle.asn1">ASN1Encodable</A></DL>
107</PRE>
108
109<P>
110<HR>
111
112<P>
113<!-- =========== FIELD SUMMARY =========== -->
114
115<A NAME="field_summary"><!-- --></A>
116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
119<B>Field Summary</B></FONT></TH>
120</TR>
121</TABLE>
122 <A NAME="fields_inherited_from_class_org.bouncycastle.asn1.ASN1Encodable"><!-- --></A>
123<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
124<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
125<TH ALIGN="left"><B>Fields inherited from class org.bouncycastle.asn1.<A HREF="../../../../org/bouncycastle/asn1/ASN1Encodable.html" title="class in org.bouncycastle.asn1">ASN1Encodable</A></B></TH>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD><CODE><A HREF="../../../../org/bouncycastle/asn1/ASN1Encodable.html#BER">BER</A>, <A HREF="../../../../org/bouncycastle/asn1/ASN1Encodable.html#DER">DER</A></CODE></TD>
129</TR>
130</TABLE>
131
132<!-- ======== CONSTRUCTOR SUMMARY ======== -->
133
134<A NAME="constructor_summary"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
137<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
138<B>Constructor Summary</B></FONT></TH>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<TD><CODE><B><A HREF="../../../../org/bouncycastle/asn1/cms/Attribute.html#Attribute(org.bouncycastle.asn1.ASN1Sequence)">Attribute</A></B>(<A HREF="../../../../org/bouncycastle/asn1/ASN1Sequence.html" title="class in org.bouncycastle.asn1">ASN1Sequence</A> seq)</CODE>
142
143<BR>
144 </TD>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD><CODE><B><A HREF="../../../../org/bouncycastle/asn1/cms/Attribute.html#Attribute(org.bouncycastle.asn1.DERObjectIdentifier, org.bouncycastle.asn1.ASN1Set)">Attribute</A></B>(<A HREF="../../../../org/bouncycastle/asn1/DERObjectIdentifier.html" title="class in org.bouncycastle.asn1">DERObjectIdentifier</A> attrType,
148 <A HREF="../../../../org/bouncycastle/asn1/ASN1Set.html" title="class in org.bouncycastle.asn1">ASN1Set</A> attrValues)</CODE>
149
150<BR>
151 </TD>
152</TR>
153</TABLE>
154
155<!-- ========== METHOD SUMMARY =========== -->
156
157<A NAME="method_summary"><!-- --></A>
158<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
159<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
160<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
161<B>Method Summary</B></FONT></TH>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165<CODE> <A HREF="../../../../org/bouncycastle/asn1/DERObjectIdentifier.html" title="class in org.bouncycastle.asn1">DERObjectIdentifier</A></CODE></FONT></TD>
166<TD><CODE><B><A HREF="../../../../org/bouncycastle/asn1/cms/Attribute.html#getAttrType()">getAttrType</A></B>()</CODE>
167
168<BR>
169 </TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173<CODE> <A HREF="../../../../org/bouncycastle/asn1/ASN1Set.html" title="class in org.bouncycastle.asn1">ASN1Set</A></CODE></FONT></TD>
174<TD><CODE><B><A HREF="../../../../org/bouncycastle/asn1/cms/Attribute.html#getAttrValues()">getAttrValues</A></B>()</CODE>
175
176<BR>
177 </TD>
178</TR>
179<TR BGCOLOR="white" CLASS="TableRowColor">
180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181<CODE>static <A HREF="../../../../org/bouncycastle/asn1/cms/Attribute.html" title="class in org.bouncycastle.asn1.cms">Attribute</A></CODE></FONT></TD>
182<TD><CODE><B><A HREF="../../../../org/bouncycastle/asn1/cms/Attribute.html#getInstance(java.lang.Object)">getInstance</A></B>(java.lang.Object o)</CODE>
183
184<BR>
185 return an Attribute object from the given object.</TD>
186</TR>
187<TR BGCOLOR="white" CLASS="TableRowColor">
188<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189<CODE> <A HREF="../../../../org/bouncycastle/asn1/DERObject.html" title="class in org.bouncycastle.asn1">DERObject</A></CODE></FONT></TD>
190<TD><CODE><B><A HREF="../../../../org/bouncycastle/asn1/cms/Attribute.html#toASN1Object()">toASN1Object</A></B>()</CODE>
191
192<BR>
193 Produce an object suitable for an ASN1OutputStream.</TD>
194</TR>
195</TABLE>
196 <A NAME="methods_inherited_from_class_org.bouncycastle.asn1.ASN1Encodable"><!-- --></A>
197<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
198<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
199<TH ALIGN="left"><B>Methods inherited from class org.bouncycastle.asn1.<A HREF="../../../../org/bouncycastle/asn1/ASN1Encodable.html" title="class in org.bouncycastle.asn1">ASN1Encodable</A></B></TH>
200</TR>
201<TR BGCOLOR="white" CLASS="TableRowColor">
202<TD><CODE><A HREF="../../../../org/bouncycastle/asn1/ASN1Encodable.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../../org/bouncycastle/asn1/ASN1Encodable.html#getDEREncoded()">getDEREncoded</A>, <A HREF="../../../../org/bouncycastle/asn1/ASN1Encodable.html#getDERObject()">getDERObject</A>, <A HREF="../../../../org/bouncycastle/asn1/ASN1Encodable.html#getEncoded()">getEncoded</A>, <A HREF="../../../../org/bouncycastle/asn1/ASN1Encodable.html#getEncoded(java.lang.String)">getEncoded</A>, <A HREF="../../../../org/bouncycastle/asn1/ASN1Encodable.html#hashCode()">hashCode</A></CODE></TD>
203</TR>
204</TABLE>
205 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
206<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
207<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
208<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD><CODE>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
212</TR>
213</TABLE>
214
215<P>
216
217<!-- ========= CONSTRUCTOR DETAIL ======== -->
218
219<A NAME="constructor_detail"><!-- --></A>
220<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
221<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
222<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
223<B>Constructor Detail</B></FONT></TH>
224</TR>
225</TABLE>
226
227<A NAME="Attribute(org.bouncycastle.asn1.ASN1Sequence)"><!-- --></A><H3>
228Attribute</H3>
229<PRE>
230public <B>Attribute</B>(<A HREF="../../../../org/bouncycastle/asn1/ASN1Sequence.html" title="class in org.bouncycastle.asn1">ASN1Sequence</A> seq)</PRE>
231<DL>
232</DL>
233<HR>
234
235<A NAME="Attribute(org.bouncycastle.asn1.DERObjectIdentifier, org.bouncycastle.asn1.ASN1Set)"><!-- --></A><H3>
236Attribute</H3>
237<PRE>
238public <B>Attribute</B>(<A HREF="../../../../org/bouncycastle/asn1/DERObjectIdentifier.html" title="class in org.bouncycastle.asn1">DERObjectIdentifier</A> attrType,
239 <A HREF="../../../../org/bouncycastle/asn1/ASN1Set.html" title="class in org.bouncycastle.asn1">ASN1Set</A> attrValues)</PRE>
240<DL>
241</DL>
242
243<!-- ============ METHOD DETAIL ========== -->
244
245<A NAME="method_detail"><!-- --></A>
246<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
247<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
248<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
249<B>Method Detail</B></FONT></TH>
250</TR>
251</TABLE>
252
253<A NAME="getInstance(java.lang.Object)"><!-- --></A><H3>
254getInstance</H3>
255<PRE>
256public static <A HREF="../../../../org/bouncycastle/asn1/cms/Attribute.html" title="class in org.bouncycastle.asn1.cms">Attribute</A> <B>getInstance</B>(java.lang.Object o)</PRE>
257<DL>
258<DD>return an Attribute object from the given object.
259<P>
260<DD><DL>
261<DT><B>Parameters:</B><DD><CODE>o</CODE> - the object we want converted.
262<DT><B>Throws:</B>
263<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the object cannot be converted.</DL>
264</DD>
265</DL>
266<HR>
267
268<A NAME="getAttrType()"><!-- --></A><H3>
269getAttrType</H3>
270<PRE>
271public <A HREF="../../../../org/bouncycastle/asn1/DERObjectIdentifier.html" title="class in org.bouncycastle.asn1">DERObjectIdentifier</A> <B>getAttrType</B>()</PRE>
272<DL>
273<DD><DL>
274</DL>
275</DD>
276</DL>
277<HR>
278
279<A NAME="getAttrValues()"><!-- --></A><H3>
280getAttrValues</H3>
281<PRE>
282public <A HREF="../../../../org/bouncycastle/asn1/ASN1Set.html" title="class in org.bouncycastle.asn1">ASN1Set</A> <B>getAttrValues</B>()</PRE>
283<DL>
284<DD><DL>
285</DL>
286</DD>
287</DL>
288<HR>
289
290<A NAME="toASN1Object()"><!-- --></A><H3>
291toASN1Object</H3>
292<PRE>
293public <A HREF="../../../../org/bouncycastle/asn1/DERObject.html" title="class in org.bouncycastle.asn1">DERObject</A> <B>toASN1Object</B>()</PRE>
294<DL>
295<DD>Produce an object suitable for an ASN1OutputStream.
296 <pre>
297 Attribute ::= SEQUENCE {
298 attrType OBJECT IDENTIFIER,
299 attrValues SET OF AttributeValue
300 }
301 </pre>
302<P>
303<DD><DL>
304<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/bouncycastle/asn1/ASN1Encodable.html#toASN1Object()">toASN1Object</A></CODE> in class <CODE><A HREF="../../../../org/bouncycastle/asn1/ASN1Encodable.html" title="class in org.bouncycastle.asn1">ASN1Encodable</A></CODE></DL>
305</DD>
306<DD><DL>
307</DL>
308</DD>
309</DL>
310<!-- ========= END OF CLASS DATA ========= -->
311<HR>
312
313
314<!-- ======= START OF BOTTOM NAVBAR ====== -->
315<A NAME="navbar_bottom"><!-- --></A>
316<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
317<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
318<TR>
319<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
320<A NAME="navbar_bottom_firstrow"><!-- --></A>
321<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
322 <TR ALIGN="center" VALIGN="top">
323 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
324 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
325 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
326 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
327 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
328 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
329 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
330 </TR>
331</TABLE>
332</TD>
333<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
334<b>Bouncy Castle Cryptography Library 1.45</b></EM>
335</TD>
336</TR>
337
338<TR>
339<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
340 PREV CLASS
341 <A HREF="../../../../org/bouncycastle/asn1/cms/AttributeTable.html" title="class in org.bouncycastle.asn1.cms"><B>NEXT CLASS</B></A></FONT></TD>
342<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
343 <A HREF="../../../../index.html?org/bouncycastle/asn1/cms/Attribute.html" target="_top"><B>FRAMES</B></A>
344 <A HREF="Attribute.html" target="_top"><B>NO FRAMES</B></A>
345 <SCRIPT type="text/javascript">
346 <!--
347 if(window==top) {
348 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
349 }
350 //-->
351</SCRIPT>
352<NOSCRIPT>
353 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
354</NOSCRIPT>
355
356
357</FONT></TD>
358</TR>
359<TR>
360<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
361 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.bouncycastle.asn1.ASN1Encodable">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
362<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
363DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
364</TR>
365</TABLE>
366<A NAME="skip-navbar_bottom"></A>
367<!-- ======== END OF BOTTOM NAVBAR ======= -->
368
369<HR>
370
371</BODY>
372</HTML>