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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.4.2_07) on Thu Oct 12 12:19:56 EDT 2006 -->
<TITLE>
SecurityHandlersManager (PDFBox-0.7.3 API)
</TITLE>
<META NAME="keywords" CONTENT="org.pdfbox.pdmodel.encryption.SecurityHandlersManager class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="SecurityHandlersManager (PDFBox-0.7.3 API)";
}
</SCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SecurityHandlersManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/pdfbox/pdmodel/encryption/SecurityHandler.html" title="class in org.pdfbox.pdmodel.encryption"><B>PREV CLASS</B></A>
<A HREF="../../../../org/pdfbox/pdmodel/encryption/StandardDecryptionMaterial.html" title="class in org.pdfbox.pdmodel.encryption"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
<A HREF="SecurityHandlersManager.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.pdfbox.pdmodel.encryption</FONT>
<BR>
Class SecurityHandlersManager</H2>
<PRE>
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>org.pdfbox.pdmodel.encryption.SecurityHandlersManager</B>
</PRE>
<HR>
<DL>
<DT>public class <B>SecurityHandlersManager</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL>
<P>
This class manages security handlers for the application. It follows the singleton pattern.
To be usable, security managers must be registered in it. Security managers are retrieved by
the application when necessary.
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Revision: 1.3 $</DD>
<DT><B>Author:</B></DT>
<DD>Benoit Guillon (benoit.guillon@snv.jussieu.fr)</DD>
</DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../org/pdfbox/pdmodel/encryption/SecurityHandlersManager.html" title="class in org.pdfbox.pdmodel.encryption">SecurityHandlersManager</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/pdfbox/pdmodel/encryption/SecurityHandlersManager.html#getInstance()">getInstance</A></B>()</CODE>
<BR>
Get the singleton instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/pdfbox/pdmodel/encryption/SecurityHandler.html" title="class in org.pdfbox.pdmodel.encryption">SecurityHandler</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/pdfbox/pdmodel/encryption/SecurityHandlersManager.html#getSecurityHandler(org.pdfbox.pdmodel.encryption.ProtectionPolicy)">getSecurityHandler</A></B>(<A HREF="../../../../org/pdfbox/pdmodel/encryption/ProtectionPolicy.html" title="class in org.pdfbox.pdmodel.encryption">ProtectionPolicy</A> policy)</CODE>
<BR>
Get the security handler for the protection policy.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/pdfbox/pdmodel/encryption/SecurityHandler.html" title="class in org.pdfbox.pdmodel.encryption">SecurityHandler</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/pdfbox/pdmodel/encryption/SecurityHandlersManager.html#getSecurityHandler(java.lang.String)">getSecurityHandler</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> filterName)</CODE>
<BR>
Retrieve the appropriate SecurityHandler for a the given filter name.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/pdfbox/pdmodel/encryption/SecurityHandlersManager.html#registerHandler(java.lang.String, java.lang.Class, java.lang.Class)">registerHandler</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> filterName,
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> securityHandlerClass,
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> protectionPolicyClass)</CODE>
<BR>
register a security handler.
</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="registerHandler(java.lang.String, java.lang.Class, java.lang.Class)"><!-- --></A><H3>
registerHandler</H3>
<PRE>
public void <B>registerHandler</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> filterName,
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> securityHandlerClass,
<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> protectionPolicyClass)
throws <A HREF="../../../../org/pdfbox/pdmodel/encryption/BadSecurityHandlerException.html" title="class in org.pdfbox.pdmodel.encryption">BadSecurityHandlerException</A></PRE>
<DL>
<DD>register a security handler.
If the security handler was already registered an exception is thrown.
If another handler was previously registered for the same filter name or
for the same policy name, an exception is thrown
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filterName</CODE> - The name of the filter.<DD><CODE>securityHandlerClass</CODE> - Security Handler class to register.<DD><CODE>protectionPolicyClass</CODE> - Protection Policy class to register.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/pdfbox/pdmodel/encryption/BadSecurityHandlerException.html" title="class in org.pdfbox.pdmodel.encryption">BadSecurityHandlerException</A></CODE> - If there is an error registering the security handler.</DL>
</DD>
</DL>
<HR>
<A NAME="getInstance()"><!-- --></A><H3>
getInstance</H3>
<PRE>
public static <A HREF="../../../../org/pdfbox/pdmodel/encryption/SecurityHandlersManager.html" title="class in org.pdfbox.pdmodel.encryption">SecurityHandlersManager</A> <B>getInstance</B>()</PRE>
<DL>
<DD>Get the singleton instance.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The SecurityHandlersManager.</DL>
</DD>
</DL>
<HR>
<A NAME="getSecurityHandler(org.pdfbox.pdmodel.encryption.ProtectionPolicy)"><!-- --></A><H3>
getSecurityHandler</H3>
<PRE>
public <A HREF="../../../../org/pdfbox/pdmodel/encryption/SecurityHandler.html" title="class in org.pdfbox.pdmodel.encryption">SecurityHandler</A> <B>getSecurityHandler</B>(<A HREF="../../../../org/pdfbox/pdmodel/encryption/ProtectionPolicy.html" title="class in org.pdfbox.pdmodel.encryption">ProtectionPolicy</A> policy)
throws <A HREF="../../../../org/pdfbox/pdmodel/encryption/BadSecurityHandlerException.html" title="class in org.pdfbox.pdmodel.encryption">BadSecurityHandlerException</A></PRE>
<DL>
<DD>Get the security handler for the protection policy.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>policy</CODE> - The policy to get the security handler for.
<DT><B>Returns:</B><DD>The appropriate security handler.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/pdfbox/pdmodel/encryption/BadSecurityHandlerException.html" title="class in org.pdfbox.pdmodel.encryption">BadSecurityHandlerException</A></CODE> - If it is unable to create a SecurityHandler.</DL>
</DD>
</DL>
<HR>
<A NAME="getSecurityHandler(java.lang.String)"><!-- --></A><H3>
getSecurityHandler</H3>
<PRE>
public <A HREF="../../../../org/pdfbox/pdmodel/encryption/SecurityHandler.html" title="class in org.pdfbox.pdmodel.encryption">SecurityHandler</A> <B>getSecurityHandler</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> filterName)
throws <A HREF="../../../../org/pdfbox/pdmodel/encryption/BadSecurityHandlerException.html" title="class in org.pdfbox.pdmodel.encryption">BadSecurityHandlerException</A></PRE>
<DL>
<DD>Retrieve the appropriate SecurityHandler for a the given filter name.
The filter name is an entry of the encryption dictionary of an encrypted document.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filterName</CODE> - The filter name.
<DT><B>Returns:</B><DD>The appropriate SecurityHandler if it exists.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/pdfbox/pdmodel/encryption/BadSecurityHandlerException.html" title="class in org.pdfbox.pdmodel.encryption">BadSecurityHandlerException</A></CODE> - If the security handler does not exist.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SecurityHandlersManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/pdfbox/pdmodel/encryption/SecurityHandler.html" title="class in org.pdfbox.pdmodel.encryption"><B>PREV CLASS</B></A>
<A HREF="../../../../org/pdfbox/pdmodel/encryption/StandardDecryptionMaterial.html" title="class in org.pdfbox.pdmodel.encryption"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
<A HREF="SecurityHandlersManager.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|
