comparison apache-xmlrpc-3.1.3/docs/apidocs/org/apache/xmlrpc/metadata/XmlRpcSystemImpl.html @ 151:db5f735fd2b4

add xml-rpc.jar
author e085711
date Sat, 10 Sep 2011 04:13:50 +0900
parents
children
comparison
equal deleted inserted replaced
147:a2b5149bbbe6 151:db5f735fd2b4
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_17) on Sat Feb 06 17:11:28 CET 2010 -->
6 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
7 <TITLE>
8 XmlRpcSystemImpl (Apache XML-RPC 3.1.3 API)
9 </TITLE>
10
11 <META NAME="date" CONTENT="2010-02-06">
12
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
14
15 <SCRIPT type="text/javascript">
16 function windowTitle()
17 {
18 if (location.href.indexOf('is-external=true') == -1) {
19 parent.document.title="XmlRpcSystemImpl (Apache XML-RPC 3.1.3 API)";
20 }
21 }
22 </SCRIPT>
23 <NOSCRIPT>
24 </NOSCRIPT>
25
26 </HEAD>
27
28 <BODY BGCOLOR="white" onload="windowTitle();">
29 <HR>
30
31
32 <!-- ========= START OF TOP NAVBAR ======= -->
33 <A NAME="navbar_top"><!-- --></A>
34 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36 <TR>
37 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38 <A NAME="navbar_top_firstrow"><!-- --></A>
39 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40 <TR ALIGN="center" VALIGN="top">
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcSystemImpl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
49 </TR>
50 </TABLE>
51 </TD>
52 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
53 </EM>
54 </TD>
55 </TR>
56
57 <TR>
58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
59 &nbsp;<A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html" title="interface in org.apache.xmlrpc.metadata"><B>PREV CLASS</B></A>&nbsp;
60 &nbsp;NEXT CLASS</FONT></TD>
61 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
62 <A HREF="../../../../index.html?org/apache/xmlrpc/metadata/XmlRpcSystemImpl.html" target="_top"><B>FRAMES</B></A> &nbsp;
63 &nbsp;<A HREF="XmlRpcSystemImpl.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
64 &nbsp;<SCRIPT type="text/javascript">
65 <!--
66 if(window==top) {
67 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
68 }
69 //-->
70 </SCRIPT>
71 <NOSCRIPT>
72 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
73 </NOSCRIPT>
74
75
76 </FONT></TD>
77 </TR>
78 <TR>
79 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
81 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
82 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
83 </TR>
84 </TABLE>
85 <A NAME="skip-navbar_top"></A>
86 <!-- ========= END OF TOP NAVBAR ========= -->
87
88 <HR>
89 <!-- ======== START OF CLASS DATA ======== -->
90 <H2>
91 <FONT SIZE="-1">
92 org.apache.xmlrpc.metadata</FONT>
93 <BR>
94 Class XmlRpcSystemImpl</H2>
95 <PRE>
96 java.lang.Object
97 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xmlrpc.metadata.XmlRpcSystemImpl</B>
98 </PRE>
99 <HR>
100 <DL>
101 <DT><PRE>public class <B>XmlRpcSystemImpl</B><DT>extends java.lang.Object</DL>
102 </PRE>
103
104 <P>
105 This class implements the various "system" calls,
106 as specifies by <A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html" title="interface in org.apache.xmlrpc.metadata"><CODE>XmlRpcListableHandlerMapping</CODE></A>.
107 Suggested use is to create an instance and add it to
108 the handler mapping with the "system" prefix.
109 <P>
110
111 <P>
112 <HR>
113
114 <P>
115
116 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
117
118 <A NAME="constructor_summary"><!-- --></A>
119 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
122 <B>Constructor Summary</B></FONT></TH>
123 </TR>
124 <TR BGCOLOR="white" CLASS="TableRowColor">
125 <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcSystemImpl.html#XmlRpcSystemImpl(org.apache.xmlrpc.metadata.XmlRpcListableHandlerMapping)">XmlRpcSystemImpl</A></B>(<A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html" title="interface in org.apache.xmlrpc.metadata">XmlRpcListableHandlerMapping</A>&nbsp;pMapping)</CODE>
126
127 <BR>
128 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new instance, which provides meta data
129 for the given handler mappings methods.</TD>
130 </TR>
131 </TABLE>
132 &nbsp;
133 <!-- ========== METHOD SUMMARY =========== -->
134
135 <A NAME="method_summary"><!-- --></A>
136 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
138 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
139 <B>Method Summary</B></FONT></TH>
140 </TR>
141 <TR BGCOLOR="white" CLASS="TableRowColor">
142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
143 <CODE>static&nbsp;void</CODE></FONT></TD>
144 <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcSystemImpl.html#addSystemHandler(org.apache.xmlrpc.server.PropertyHandlerMapping)">addSystemHandler</A></B>(<A HREF="../../../../org/apache/xmlrpc/server/PropertyHandlerMapping.html" title="class in org.apache.xmlrpc.server">PropertyHandlerMapping</A>&nbsp;pMapping)</CODE>
145
146 <BR>
147 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds an instance of this class to the given handler
148 mapping.</TD>
149 </TR>
150 <TR BGCOLOR="white" CLASS="TableRowColor">
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152 <CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
153 <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcSystemImpl.html#listMethods()">listMethods</A></B>()</CODE>
154
155 <BR>
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Implements the "system.listMethods" call.</TD>
157 </TR>
158 <TR BGCOLOR="white" CLASS="TableRowColor">
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
161 <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcSystemImpl.html#methodHelp(java.lang.String)">methodHelp</A></B>(java.lang.String&nbsp;methodName)</CODE>
162
163 <BR>
164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Implements the "system.methodHelp" call.</TD>
165 </TR>
166 <TR BGCOLOR="white" CLASS="TableRowColor">
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168 <CODE>&nbsp;java.lang.String[][]</CODE></FONT></TD>
169 <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcSystemImpl.html#methodSignature(java.lang.String)">methodSignature</A></B>(java.lang.String&nbsp;methodName)</CODE>
170
171 <BR>
172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Implements the "system.methodSignature" call.</TD>
173 </TR>
174 </TABLE>
175 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
176 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
177 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
178 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
179 </TR>
180 <TR BGCOLOR="white" CLASS="TableRowColor">
181 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
182 </TR>
183 </TABLE>
184 &nbsp;
185 <P>
186
187 <!-- ========= CONSTRUCTOR DETAIL ======== -->
188
189 <A NAME="constructor_detail"><!-- --></A>
190 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
191 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
192 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
193 <B>Constructor Detail</B></FONT></TH>
194 </TR>
195 </TABLE>
196
197 <A NAME="XmlRpcSystemImpl(org.apache.xmlrpc.metadata.XmlRpcListableHandlerMapping)"><!-- --></A><H3>
198 XmlRpcSystemImpl</H3>
199 <PRE>
200 public <B>XmlRpcSystemImpl</B>(<A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html" title="interface in org.apache.xmlrpc.metadata">XmlRpcListableHandlerMapping</A>&nbsp;pMapping)</PRE>
201 <DL>
202 <DD>Creates a new instance, which provides meta data
203 for the given handler mappings methods.
204 <P>
205 </DL>
206
207 <!-- ============ METHOD DETAIL ========== -->
208
209 <A NAME="method_detail"><!-- --></A>
210 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
211 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
212 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
213 <B>Method Detail</B></FONT></TH>
214 </TR>
215 </TABLE>
216
217 <A NAME="methodSignature(java.lang.String)"><!-- --></A><H3>
218 methodSignature</H3>
219 <PRE>
220 public java.lang.String[][] <B>methodSignature</B>(java.lang.String&nbsp;methodName)
221 throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
222 <DL>
223 <DD>Implements the "system.methodSignature" call.
224 <P>
225 <DD><DL>
226
227 <DT><B>Throws:</B>
228 <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodSignature(java.lang.String)"><CODE>XmlRpcListableHandlerMapping.getMethodSignature(String)</CODE></A></DL>
229 </DD>
230 </DL>
231 <HR>
232
233 <A NAME="methodHelp(java.lang.String)"><!-- --></A><H3>
234 methodHelp</H3>
235 <PRE>
236 public java.lang.String <B>methodHelp</B>(java.lang.String&nbsp;methodName)
237 throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
238 <DL>
239 <DD>Implements the "system.methodHelp" call.
240 <P>
241 <DD><DL>
242
243 <DT><B>Throws:</B>
244 <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getMethodHelp(java.lang.String)"><CODE>XmlRpcListableHandlerMapping.getMethodHelp(String)</CODE></A></DL>
245 </DD>
246 </DL>
247 <HR>
248
249 <A NAME="listMethods()"><!-- --></A><H3>
250 listMethods</H3>
251 <PRE>
252 public java.lang.String[] <B>listMethods</B>()
253 throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
254 <DL>
255 <DD>Implements the "system.listMethods" call.
256 <P>
257 <DD><DL>
258
259 <DT><B>Throws:</B>
260 <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcListableHandlerMapping.html#getListMethods()"><CODE>XmlRpcListableHandlerMapping.getListMethods()</CODE></A></DL>
261 </DD>
262 </DL>
263 <HR>
264
265 <A NAME="addSystemHandler(org.apache.xmlrpc.server.PropertyHandlerMapping)"><!-- --></A><H3>
266 addSystemHandler</H3>
267 <PRE>
268 public static void <B>addSystemHandler</B>(<A HREF="../../../../org/apache/xmlrpc/server/PropertyHandlerMapping.html" title="class in org.apache.xmlrpc.server">PropertyHandlerMapping</A>&nbsp;pMapping)
269 throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
270 <DL>
271 <DD>Adds an instance of this class to the given handler
272 mapping.
273 <P>
274 <DD><DL>
275
276 <DT><B>Throws:</B>
277 <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE></DL>
278 </DD>
279 </DL>
280 <!-- ========= END OF CLASS DATA ========= -->
281 <HR>
282
283
284 <!-- ======= START OF BOTTOM NAVBAR ====== -->
285 <A NAME="navbar_bottom"><!-- --></A>
286 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
287 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
288 <TR>
289 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
290 <A NAME="navbar_bottom_firstrow"><!-- --></A>
291 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
292 <TR ALIGN="center" VALIGN="top">
293 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
294 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
295 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
296 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcSystemImpl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
297 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
298 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
299 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
300 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
301 </TR>
302 </TABLE>
303 </TD>
304 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
305 </EM>
306 </TD>
307 </TR>
308
309 <TR>
310 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
311 &nbsp;<A HREF="../../../../org/apache/xmlrpc/metadata/XmlRpcMetaDataHandler.html" title="interface in org.apache.xmlrpc.metadata"><B>PREV CLASS</B></A>&nbsp;
312 &nbsp;NEXT CLASS</FONT></TD>
313 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
314 <A HREF="../../../../index.html?org/apache/xmlrpc/metadata/XmlRpcSystemImpl.html" target="_top"><B>FRAMES</B></A> &nbsp;
315 &nbsp;<A HREF="XmlRpcSystemImpl.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
316 &nbsp;<SCRIPT type="text/javascript">
317 <!--
318 if(window==top) {
319 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
320 }
321 //-->
322 </SCRIPT>
323 <NOSCRIPT>
324 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
325 </NOSCRIPT>
326
327
328 </FONT></TD>
329 </TR>
330 <TR>
331 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
332 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
333 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
334 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
335 </TR>
336 </TABLE>
337 <A NAME="skip-navbar_bottom"></A>
338 <!-- ======== END OF BOTTOM NAVBAR ======= -->
339
340 <HR>
341 Copyright &#169; 2001-2010 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
342 </BODY>
343 </HTML>