ServantGenerator
extends Object| java.lang.Object | |
| ↳ | com.microstrategy.web.servant.ServantGenerator |
Class Overview
This class is responsible for creating the Service Endpoint (or "Servant") class from a definition of the endpoint.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| class | ServantGenerator.JavaGenerator | This class is used to generate portion of a Java class. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ServantGenerator() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| void |
generateAxis2ServicesXml()
Generate the Axis2 Services XML file.
| ||||||||||
| void |
generateServant()
Generate a Servant class given the information suppplied in the
ClassInfo.
| ||||||||||
| File |
getEndpointFile()
Returns the File that represents the endpoint definition
XML.
| ||||||||||
| File |
getServantOutputDirectory()
Returns the servant output directory.
| ||||||||||
| File |
getServicesXmlDirectory()
Returns the services XML output directory.
| ||||||||||
| static void |
main(String[] args)
Process the command line arguments and generate the servant
class and services XML file.
| ||||||||||
| void |
parseEndpointFile()
Parse the endpoint definition (XML) file.
| ||||||||||
| void |
setEndpointFile(File xmlFile)
Sets the File that represents the endpoint definition
XML.
| ||||||||||
| void |
setServantOutputDirectory(File servantOutputDir)
Sets the servant output directory.
| ||||||||||
| void |
setServantTarget(ServantTargetInfo servantTarget)
Sets the private member which identifies the web service platform
| ||||||||||
| void |
setServicesXmlDirectory(File servicesXmlDir)
Sets the services XML output directory.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public ServantGenerator ()
Public Methods
public void generateAxis2ServicesXml ()
Generate the Axis2 Services XML file.
Throws
| IllegalStateException | If no ClassInfo object is associated with this object or the ClassInfo object is not complete. |
|---|
public void generateServant ()
Generate a Servant class given the information suppplied in the ClassInfo.
Throws
| IllegalStateException | If no ClassInfo object is associated with this object or the ClassInfo object is not complete. |
|---|
public File getEndpointFile ()
Returns the File that represents the endpoint definition XML.
Returns
- The File that represents the endpoint definition XML.
public File getServantOutputDirectory ()
Returns the servant output directory.
Returns
- The servant output directory (as a File).
public File getServicesXmlDirectory ()
Returns the services XML output directory.
Returns
- The services XML output directory.
public static void main (String[] args)
Process the command line arguments and generate the servant class and services XML file.
Parameters
| args | The command line arguments... |
|---|
public void parseEndpointFile ()
Parse the endpoint definition (XML) file. The results are saved in the ClassInfo instance associated with this object.
Throws
| Exception | If parsing fails. |
|---|---|
| IllegalStateException | If the endpoint XML is not specified or does not exist. |
public void setEndpointFile (File xmlFile)
Sets the File that represents the endpoint definition XML.
Parameters
| xmlFile | The file that represents the endpoint definition XML. |
|---|
public void setServantOutputDirectory (File servantOutputDir)
Sets the servant output directory.
Parameters
| servantOutputDir | The servant output directory (as a File). |
|---|
public void setServantTarget (ServantTargetInfo servantTarget)
Sets the private member which identifies the web service platform
public void setServicesXmlDirectory (File servicesXmlDir)
Sets the services XML output directory.
Parameters
| servicesXmlDir | The services XML output directory (as a File). |
|---|