| <!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_08) on Sat Apr 22 18:56:43 PDT 2006 --> |
| <TITLE> |
| AdminClient (Axis API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.axis.client.AdminClient class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="AdminClient (Axis 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/AdminClient.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"> |
| PREV CLASS |
| <A HREF="../../../../org/apache/axis/client/AxisClient.html" title="class in org.apache.axis.client"><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="AdminClient.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.apache.axis.client</FONT> |
| <BR> |
| Class AdminClient</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.axis.client.AdminClient</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT>public class <B>AdminClient</B><DT>extends java.lang.Object</DL> |
| |
| <P> |
| An admin client object that can be used both from the command line |
| and programmatically. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Rob Jellinghaus (robj@unrealities.com), Doug Davis (dug@us.ibm.com), Simeon Simeonov (simeons@macromedia.com)</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/axis/client/Call.html" title="class in org.apache.axis.client">Call</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#call">call</A></B></CODE> |
| |
| <BR> |
| the object that represents our call</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static org.apache.commons.logging.Log</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#log">log</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#ROOT_UNDEPLOY">ROOT_UNDEPLOY</A></B></CODE> |
| |
| <BR> |
| root element of the undeploy request</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#AdminClient()">AdminClient</A></B>()</CODE> |
| |
| <BR> |
| Construct an admin client w/o a logger.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#AdminClient(boolean)">AdminClient</A></B>(boolean ignored)</CODE> |
| |
| <BR> |
| this is a somwhat contrived variant constructor, one that throws an exception |
| if things go wrong.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== 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> <A HREF="../../../../org/apache/axis/client/Call.html" title="class in org.apache.axis.client">Call</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#getCall()">getCall</A></B>()</CODE> |
| |
| <BR> |
| External access to our <code>Call</code< object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#list()">list</A></B>()</CODE> |
| |
| <BR> |
| send a list command</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#list(org.apache.axis.utils.Options)">list</A></B>(<A HREF="../../../../org/apache/axis/utils/Options.html" title="class in org.apache.axis.utils">Options</A> opts)</CODE> |
| |
| <BR> |
| process the options then run a list call</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#main(java.lang.String[])">main</A></B>(java.lang.String[] args)</CODE> |
| |
| <BR> |
| Creates in instance of <code>AdminClient</code> and |
| invokes <code>process(args)</code>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#process(java.io.InputStream)">process</A></B>(java.io.InputStream input)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#process(org.apache.axis.utils.Options, java.io.InputStream)">process</A></B>(<A HREF="../../../../org/apache/axis/utils/Options.html" title="class in org.apache.axis.utils">Options</A> opts, |
| java.io.InputStream input)</CODE> |
| |
| <BR> |
| submit the input stream's contents to the endpoint, return the results as a string.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#process(org.apache.axis.utils.Options, java.lang.String)">process</A></B>(<A HREF="../../../../org/apache/axis/utils/Options.html" title="class in org.apache.axis.utils">Options</A> opts, |
| java.lang.String xmlFile)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#process(java.lang.String)">process</A></B>(java.lang.String xmlFile)</CODE> |
| |
| <BR> |
| process an XML file containing a pre-prepared admin message</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#process(java.lang.String[])">process</A></B>(java.lang.String[] args)</CODE> |
| |
| <BR> |
| Processes a set of administration commands.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#process(java.net.URL)">process</A></B>(java.net.URL xmlURL)</CODE> |
| |
| <BR> |
| </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/apache/axis/client/AdminClient.html#processOpts(org.apache.axis.utils.Options)">processOpts</A></B>(<A HREF="../../../../org/apache/axis/utils/Options.html" title="class in org.apache.axis.utils">Options</A> opts)</CODE> |
| |
| <BR> |
| go from the (parsed) command line to setting properties on our call object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#quit()">quit</A></B>()</CODE> |
| |
| <BR> |
| make a quit command</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#quit(org.apache.axis.utils.Options)">quit</A></B>(<A HREF="../../../../org/apache/axis/utils/Options.html" title="class in org.apache.axis.utils">Options</A> opts)</CODE> |
| |
| <BR> |
| process the command line ops, then send a quit command</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#setDefaultConfiguration(org.apache.axis.EngineConfiguration)">setDefaultConfiguration</A></B>(<A HREF="../../../../org/apache/axis/EngineConfiguration.html" title="interface in org.apache.axis">EngineConfiguration</A> config)</CODE> |
| |
| <BR> |
| If the user calls this with an EngineConfiguration object, all |
| AdminClients on this thread will use that EngineConfiguration |
| rather than the default one.</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/apache/axis/client/AdminClient.html#setLogin(java.lang.String, java.lang.String)">setLogin</A></B>(java.lang.String user, |
| java.lang.String password)</CODE> |
| |
| <BR> |
| set the username and password |
| requires that call!=null</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/apache/axis/client/AdminClient.html#setTargetEndpointAddress(java.net.URL)">setTargetEndpointAddress</A></B>(java.net.URL address)</CODE> |
| |
| <BR> |
| set the URL to deploy to |
| requires that call!=null</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/apache/axis/client/AdminClient.html#setTransport(java.lang.String)">setTransport</A></B>(java.lang.String transportName)</CODE> |
| |
| <BR> |
| set the transport to deploy with.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#undeployHandler(java.lang.String)">undeployHandler</A></B>(java.lang.String handlerName)</CODE> |
| |
| <BR> |
| undeploy a handler</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/axis/client/AdminClient.html#undeployService(java.lang.String)">undeployService</A></B>(java.lang.String serviceName)</CODE> |
| |
| <BR> |
| undeploy a service</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.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="log"><!-- --></A><H3> |
| log</H3> |
| <PRE> |
| protected static org.apache.commons.logging.Log <B>log</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="call"><!-- --></A><H3> |
| call</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/axis/client/Call.html" title="class in org.apache.axis.client">Call</A> <B>call</B></PRE> |
| <DL> |
| <DD>the object that represents our call |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ROOT_UNDEPLOY"><!-- --></A><H3> |
| ROOT_UNDEPLOY</H3> |
| <PRE> |
| protected static final java.lang.String <B>ROOT_UNDEPLOY</B></PRE> |
| <DL> |
| <DD>root element of the undeploy request |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="AdminClient()"><!-- --></A><H3> |
| AdminClient</H3> |
| <PRE> |
| public <B>AdminClient</B>()</PRE> |
| <DL> |
| <DD>Construct an admin client w/o a logger. |
| If the client cannot create a call object, then it does not throw an exception. |
| Instead it prints a message to <CODE>System.err</CODE>. |
| This is for 'historical reasons' |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="AdminClient(boolean)"><!-- --></A><H3> |
| AdminClient</H3> |
| <PRE> |
| public <B>AdminClient</B>(boolean ignored) |
| throws <A HREF="../../../../javax/xml/rpc/ServiceException.html" title="class in javax.xml.rpc">ServiceException</A></PRE> |
| <DL> |
| <DD>this is a somwhat contrived variant constructor, one that throws an exception |
| if things go wrong. |
| <P> |
| <DT><B>Parameters:</B><DD><CODE>ignored</CODE> - </DL> |
| |
| <!-- ============ 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="setDefaultConfiguration(org.apache.axis.EngineConfiguration)"><!-- --></A><H3> |
| setDefaultConfiguration</H3> |
| <PRE> |
| public static void <B>setDefaultConfiguration</B>(<A HREF="../../../../org/apache/axis/EngineConfiguration.html" title="interface in org.apache.axis">EngineConfiguration</A> config)</PRE> |
| <DL> |
| <DD>If the user calls this with an EngineConfiguration object, all |
| AdminClients on this thread will use that EngineConfiguration |
| rather than the default one. This is primarily to enable the |
| deployment of custom transports and handlers. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>config</CODE> - the EngineConfiguration which should be used</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCall()"><!-- --></A><H3> |
| getCall</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/axis/client/Call.html" title="class in org.apache.axis.client">Call</A> <B>getCall</B>()</PRE> |
| <DL> |
| <DD>External access to our <code>Call</code< object. |
| This will be null if the non-excepting constructor was used |
| and the construction failed. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the <code>Call</code> object this instance uses</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="list(org.apache.axis.utils.Options)"><!-- --></A><H3> |
| list</H3> |
| <PRE> |
| public java.lang.String <B>list</B>(<A HREF="../../../../org/apache/axis/utils/Options.html" title="class in org.apache.axis.utils">Options</A> opts) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>process the options then run a list call |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>opts</CODE> - |
| <DT><B>Returns:</B><DD> |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="list()"><!-- --></A><H3> |
| list</H3> |
| <PRE> |
| public java.lang.String <B>list</B>() |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>send a list command |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the response from the call |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="quit(org.apache.axis.utils.Options)"><!-- --></A><H3> |
| quit</H3> |
| <PRE> |
| public java.lang.String <B>quit</B>(<A HREF="../../../../org/apache/axis/utils/Options.html" title="class in org.apache.axis.utils">Options</A> opts) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>process the command line ops, then send a quit command |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>opts</CODE> - |
| <DT><B>Returns:</B><DD> |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="quit()"><!-- --></A><H3> |
| quit</H3> |
| <PRE> |
| public java.lang.String <B>quit</B>() |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>make a quit command |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD> |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="undeployHandler(java.lang.String)"><!-- --></A><H3> |
| undeployHandler</H3> |
| <PRE> |
| public java.lang.String <B>undeployHandler</B>(java.lang.String handlerName) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>undeploy a handler |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>handlerName</CODE> - name of the handler to undeploy |
| <DT><B>Returns:</B><DD> |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="undeployService(java.lang.String)"><!-- --></A><H3> |
| undeployService</H3> |
| <PRE> |
| public java.lang.String <B>undeployService</B>(java.lang.String serviceName) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>undeploy a service |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>serviceName</CODE> - name of service |
| <DT><B>Returns:</B><DD> |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="process(java.lang.String[])"><!-- --></A><H3> |
| process</H3> |
| <PRE> |
| public java.lang.String <B>process</B>(java.lang.String[] args) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD><p>Processes a set of administration commands.</p> |
| <p>The following commands are available:</p> |
| <ul> |
| <li><code>-l<i>url</i></code> sets the AxisServlet URL</li> |
| <li><code>-h<i>hostName</i></code> sets the AxisServlet host</li> |
| <li><code>-p<i>portNumber</i></code> sets the AxisServlet port</li> |
| <li><code>-s<i>servletPath</i></code> sets the path to the |
| AxisServlet</li> |
| <li><code>-f<i>fileName</i></code> specifies that a simple file |
| protocol should be used</li> |
| <li><code>-u<i>username</i></code> sets the username</li> |
| <li><code>-w<i>password</i></code> sets the password</li> |
| <li><code>-d</code> sets the debug flag (for instance, -ddd would |
| set it to 3)</li> |
| <li><code>-t<i>name</i></code> sets the transport chain touse</li> |
| <li><code>list</code> will list the currently deployed services</li> |
| <li><code>quit</code> will quit (???)</li> |
| <li><code>passwd <i>value</i></code> changes the admin password</li> |
| <li><code><i>xmlConfigFile</i></code> deploys or undeploys |
| Axis components and web services</li> |
| </ul> |
| <p>If <code>-l</code> or <code>-h -p -s</code> are not set, the |
| AdminClient will invoke |
| <code>http://localhost:8080/axis/servlet/AxisServlet</code>.</p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>args</CODE> - Commands to process |
| <DT><B>Returns:</B><DD>XML result or null in case of failure. In the case of multiple |
| commands, the XML results will be concatenated, separated by \n |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE> - Could be an IO exception, an AxisFault or something else</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="processOpts(org.apache.axis.utils.Options)"><!-- --></A><H3> |
| processOpts</H3> |
| <PRE> |
| public void <B>processOpts</B>(<A HREF="../../../../org/apache/axis/utils/Options.html" title="class in org.apache.axis.utils">Options</A> opts) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>go from the (parsed) command line to setting properties on our call object. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>opts</CODE> - |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE> - if call==null</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLogin(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| setLogin</H3> |
| <PRE> |
| public void <B>setLogin</B>(java.lang.String user, |
| java.lang.String password)</PRE> |
| <DL> |
| <DD>set the username and password |
| requires that call!=null |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>user</CODE> - username<DD><CODE>password</CODE> - password</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTargetEndpointAddress(java.net.URL)"><!-- --></A><H3> |
| setTargetEndpointAddress</H3> |
| <PRE> |
| public void <B>setTargetEndpointAddress</B>(java.net.URL address)</PRE> |
| <DL> |
| <DD>set the URL to deploy to |
| requires that call!=null |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>address</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTransport(java.lang.String)"><!-- --></A><H3> |
| setTransport</H3> |
| <PRE> |
| public void <B>setTransport</B>(java.lang.String transportName)</PRE> |
| <DL> |
| <DD>set the transport to deploy with. |
| requires that call!=null |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>transportName</CODE> - a null or empty value does not trigger a setting</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="process(java.io.InputStream)"><!-- --></A><H3> |
| process</H3> |
| <PRE> |
| public java.lang.String <B>process</B>(java.io.InputStream input) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="process(java.net.URL)"><!-- --></A><H3> |
| process</H3> |
| <PRE> |
| public java.lang.String <B>process</B>(java.net.URL xmlURL) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="process(java.lang.String)"><!-- --></A><H3> |
| process</H3> |
| <PRE> |
| public java.lang.String <B>process</B>(java.lang.String xmlFile) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>process an XML file containing a pre-prepared admin message |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>xmlFile</CODE> - file to load |
| <DT><B>Returns:</B><DD> |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="process(org.apache.axis.utils.Options, java.lang.String)"><!-- --></A><H3> |
| process</H3> |
| <PRE> |
| public java.lang.String <B>process</B>(<A HREF="../../../../org/apache/axis/utils/Options.html" title="class in org.apache.axis.utils">Options</A> opts, |
| java.lang.String xmlFile) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="process(org.apache.axis.utils.Options, java.io.InputStream)"><!-- --></A><H3> |
| process</H3> |
| <PRE> |
| public java.lang.String <B>process</B>(<A HREF="../../../../org/apache/axis/utils/Options.html" title="class in org.apache.axis.utils">Options</A> opts, |
| java.io.InputStream input) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>submit the input stream's contents to the endpoint, return the results as a string. |
| The input stream is always closed after the call, whether the request worked or not |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>opts</CODE> - options -can be null<DD><CODE>input</CODE> - -input stream for request |
| <DT><B>Returns:</B><DD> |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE> - if the call was null |
| <DD><CODE><A HREF="../../../../org/apache/axis/AxisFault.html" title="class in org.apache.axis">AxisFault</A></CODE> - if the invocation returned an empty response</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="main(java.lang.String[])"><!-- --></A><H3> |
| main</H3> |
| <PRE> |
| public static void <B>main</B>(java.lang.String[] args)</PRE> |
| <DL> |
| <DD>Creates in instance of <code>AdminClient</code> and |
| invokes <code>process(args)</code>. |
| <p>Diagnostic output goes to <code>log.info</code>.</p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>args</CODE> - Commands to process</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/AdminClient.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"> |
| PREV CLASS |
| <A HREF="../../../../org/apache/axis/client/AxisClient.html" title="class in org.apache.axis.client"><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="AdminClient.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2005 Apache Web Services Project. All Rights Reserved. |
| </BODY> |
| </HTML> |
