AdminClient (Axis API)

Class AdminClient

public class AdminClient extends Object

An admin client object that can be used both from the command line and programmatically.

Author: Rob Jellinghaus (robj@unrealities.com) Doug Davis (dug@us.ibm.com) Simeon Simeonov (simeons@macromedia.com)

Field Summary
protected Call	call the object that represents our call
protected static Log	log
protected static String	ROOT_UNDEPLOY root element of the undeploy request

Field Summary

protected Call

call

the object that represents our call

protected static Log

log

protected static String

ROOT_UNDEPLOY

root element of the undeploy request

Constructor Summary
	AdminClient() Construct an admin client w/o a logger.
	AdminClient(boolean ignored) this is a somwhat contrived variant constructor, one that throws an exception if things go wrong.

Constructor Summary

AdminClient()

Construct an admin client w/o a logger.

AdminClient(boolean ignored)

this is a somwhat contrived variant constructor, one that throws an exception if things go wrong.

Method Summary
Call	getCall() External access to our `Call`
String	list(Options opts) process the options then run a list call
String	list() send a list command
static void	main(String[] args) Creates in instance of `AdminClient` and invokes `process(args)`.
String	process(String[] args) Processes a set of administration commands. The following commands are available: `-lurl` sets the AxisServlet URL `-hhostName` sets the AxisServlet host `-pportNumber` sets the AxisServlet port `-sservletPath` sets the path to the AxisServlet `-ffileName` specifies that a simple file protocol should be used `-uusername` sets the username `-wpassword` sets the password `-d` sets the debug flag (for instance, -ddd would set it to 3) `-tname` sets the transport chain touse `list` will list the currently deployed services `quit` will quit (?
String	process(InputStream input)
String	process(URL xmlURL)
String	process(String xmlFile) process an XML file containing a pre-prepared admin message
String	process(Options opts, String xmlFile)
String	process(Options opts, InputStream input) submit the input stream's contents to the endpoint, return the results as a string.
void	processOpts(Options opts) go from the (parsed) command line to setting properties on our call object.
String	quit(Options opts) process the command line ops, then send a quit command
String	quit() make a quit command
static void	setDefaultConfiguration(EngineConfiguration config) If the user calls this with an EngineConfiguration object, all AdminClients on this thread will use that EngineConfiguration rather than the default one.
void	setLogin(String user, String password) set the username and password requires that call!
void	setTargetEndpointAddress(URL address) set the URL to deploy to requires that call!
void	setTransport(String transportName) set the transport to deploy with. requires that call!
String	undeployHandler(String handlerName) undeploy a handler
String	undeployService(String serviceName) undeploy a service

Method Summary

Call

getCall()

External access to our Call

String

list(Options opts)

process the options then run a list call

String

list()

send a list command

static void

main(String[] args)

Creates in instance of AdminClient and invokes process(args).

String

process(String[] args)

Processes a set of administration commands.

The following commands are available:

-lurl sets the AxisServlet URL
-hhostName sets the AxisServlet host
-pportNumber sets the AxisServlet port
-sservletPath sets the path to the AxisServlet
-ffileName specifies that a simple file protocol should be used
-uusername sets the username
-wpassword sets the password
-d sets the debug flag (for instance, -ddd would set it to 3)
-tname sets the transport chain touse
list will list the currently deployed services
quit will quit (?

String

process(InputStream input)

String

process(URL xmlURL)

String

process(String xmlFile)

process an XML file containing a pre-prepared admin message

String

process(Options opts, String xmlFile)

String

process(Options opts, InputStream input)

submit the input stream's contents to the endpoint, return the results as a string.

void

processOpts(Options opts)

go from the (parsed) command line to setting properties on our call object.

String

quit(Options opts)

process the command line ops, then send a quit command

String

quit()

make a quit command

static void

setDefaultConfiguration(EngineConfiguration config)

If the user calls this with an EngineConfiguration object, all AdminClients on this thread will use that EngineConfiguration rather than the default one.

void

setLogin(String user, String password)

set the username and password requires that call!

void

setTargetEndpointAddress(URL address)

set the URL to deploy to requires that call!

void

setTransport(String transportName)

set the transport to deploy with. requires that call!

String

undeployHandler(String handlerName)

undeploy a handler

String

undeployService(String serviceName)

undeploy a service

Constructor Detail

public AdminClient()

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 System.err. This is for 'historical reasons'

public AdminClient(boolean ignored)

this is a somwhat contrived variant constructor, one that throws an exception if things go wrong.

Parameters: ignored

Method Detail

public Call getCall()

External access to our

CallReturns: the Call object this instance uses

list

public String list(Options opts)

process the options then run a list call

Parameters: opts

Returns:

Throws: Exception

list

public String list()

send a list command

Returns: the response from the call

Throws: Exception

main

public static void main(String[] args)

Creates in instance of AdminClient and invokes process(args).

Diagnostic output goes to log.info.

Parameters: args Commands to process

process

public String process(String[] args)

Processes a set of administration commands.

The following commands are available:

-lurl sets the AxisServlet URL
-hhostName sets the AxisServlet host
-pportNumber sets the AxisServlet port
-sservletPath sets the path to the AxisServlet
-ffileName specifies that a simple file protocol should be used
-uusername sets the username
-wpassword sets the password
-d sets the debug flag (for instance, -ddd would set it to 3)
-tname sets the transport chain touse
list will list the currently deployed services
quit will quit (???)
passwd value changes the admin password
xmlConfigFile deploys or undeploys Axis components and web services

If -l or -h -p -s are not set, the AdminClient will invoke http://localhost:8080/axis/servlet/AxisServlet.

Parameters: args Commands to process

Returns: XML result or null in case of failure. In the case of multiple commands, the XML results will be concatenated, separated by \n

Throws: Exception Could be an IO exception, an AxisFault or something else

process

public String process(InputStream input)

process

public String process(String xmlFile)

process an XML file containing a pre-prepared admin message

Parameters: xmlFile file to load

Returns:

Throws: Exception

process

public String process(Options opts, String xmlFile)

process

public String process(Options opts, InputStream input)

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

Parameters: opts options -can be null input -input stream for request

Returns:

Throws: Exception if the call was null AxisFault if the invocation returned an empty response

processOpts

public void processOpts(Options opts)

go from the (parsed) command line to setting properties on our call object.

Parameters: opts

Throws: Exception if call==null

quit

public String quit(Options opts)

process the command line ops, then send a quit command

Parameters: opts

Returns:

Throws: Exception

quit

public String quit()

make a quit command

Returns:

Throws: Exception

setDefaultConfiguration

public static void setDefaultConfiguration(EngineConfiguration config)

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.

Parameters: config the EngineConfiguration which should be used