Style Intelligence v12.0

inetsoft.uql.soap
Class SoapDataSource

java.lang.Object
  extended by inetsoft.uql.XDataSource
      extended by inetsoft.uql.util.HierDataSource
          extended by inetsoft.uql.soap.SoapDataSource
All Implemented Interfaces:
inetsoft.util.XMLSerializable, Serializable, Cloneable

public class SoapDataSource
extends HierDataSource

SOAP data source class. It contains information on how to connect to a SOAP server and the type of method and result of the SOAP server.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class inetsoft.uql.util.HierDataSource
GET, POST
 
Fields inherited from class inetsoft.uql.XDataSource
CORBA, DOMAIN_DB2, DOMAIN_NONE, DOMAIN_ORACLE, DOMAIN_SQL, DOMAIN_SQLSERVER, EJB, JDBC, OBJECT, SAP, SOAP, TEXT, XML, XMLA
 
Constructor Summary
SoapDataSource()
          Create a SOAP data source.
 
Method Summary
 Object clone()
          Create a clone of this object.
 boolean equals(Object obj)
          Check if equals another object.
 String generate(String wsdl)
          Generates the SOAP client.
 String getInterface()
          Get the SOAP server object interface class full name.
 String getMethodName(String reqname)
          Get the name of the SOAP method for the specified request.
 String getPassword()
          Get the used user password.
 String getRequest(int idx)
          Get the data source item name.
 int getRequestCount()
          Get the number of SOAP requests.
 XTypeNode getRequestInputType(String method)
          Get the input type of the specified request.
 XTypeNode getRequestOutputType(String method)
          Get the output type of the specified request.
 XNode getRequestParameters(String method)
          Get the parameters of the specified request.
 String getURL()
          Get the name of the SOAP naming service.
 String getUser()
          Get the used user id.
 void importInterface(String serverclass)
          Import the SOAP server object interface class.
 boolean isGenerated()
          Gets the flag that determines if the SOAP client was generated by this data source.
 boolean isPost()
          Check whether use post method in url connection.
 boolean isRequireLogin()
          Check if this data soure requires user login.
 void parseXML(Element root)
          Parse the XML element that contains information on this data source.
 void setGenerated(boolean generated)
          Sets the flag that determines if the SOAP client was generated by this data source.
 void setInterface(String serverclass)
          Set the SOAP server object interface class full name.
 void setPassword(String password)
          Set the user password.
 void setPost(boolean post)
          Set the method of soap url connect.
 void setRequestParameters(String method, XNode params)
          Set the parameters of the specified request.
 void setRequireLogin(boolean login)
          Set whether this data source requires user login during connection.
 void setURL(String url)
          Set the name of the SOAP naming service.
 void setUser(String user)
          Set the user id.
 void writeXML(PrintWriter writer)
          Generate the XML segment to represent this data source.
 
Methods inherited from class inetsoft.uql.util.HierDataSource
getParameters, getTypeResolver, setTypeResolver
 
Methods inherited from class inetsoft.uql.XDataSource
addFolder, getDescription, getDomainType, getFolders, getFullName, getName, getRuntimeValue, getType, hashCode, isMVEnabled, removeFolder, removeFolders, setDescription, setName, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SoapDataSource

public SoapDataSource()
Create a SOAP data source.

Method Detail

setURL

public void setURL(String url)
Set the name of the SOAP naming service.


getURL

public String getURL()
Get the name of the SOAP naming service.


setPost

public void setPost(boolean post)
Set the method of soap url connect.


isPost

public boolean isPost()
Check whether use post method in url connection.


getRequest

public String getRequest(int idx)
Get the data source item name.

Specified by:
getRequest in class HierDataSource

getMethodName

public String getMethodName(String reqname)
Get the name of the SOAP method for the specified request.

Parameters:
reqname - the name of the request.
Returns:
the name of the SOAP method or null if no such method exists.

setUser

public void setUser(String user)
Set the user id.


getUser

public String getUser()
Get the used user id.


setPassword

public void setPassword(String password)
Set the user password.


getPassword

public String getPassword()
Get the used user password.


setRequireLogin

public void setRequireLogin(boolean login)
Set whether this data source requires user login during connection.


isRequireLogin

public boolean isRequireLogin()
Check if this data soure requires user login.


getRequestCount

public int getRequestCount()
Get the number of SOAP requests. Each SOAP server object method is treated as a request.

Specified by:
getRequestCount in class HierDataSource

getRequestOutputType

public XTypeNode getRequestOutputType(String method)
Get the output type of the specified request.

Specified by:
getRequestOutputType in class HierDataSource
Parameters:
method - request name.
Returns:
request output type.

getRequestInputType

public XTypeNode getRequestInputType(String method)
Get the input type of the specified request.

Specified by:
getRequestInputType in class HierDataSource
Parameters:
method - request name.
Returns:
request input type.

getRequestParameters

public XNode getRequestParameters(String method)
Get the parameters of the specified request.

Specified by:
getRequestParameters in class HierDataSource
Parameters:
method - request name.

setRequestParameters

public void setRequestParameters(String method,
                                 XNode params)
Set the parameters of the specified request.

Specified by:
setRequestParameters in class HierDataSource
Parameters:
method - request name.
params - parameters represented as a tree. It is converted to a SOAP object during runtime to be passed to the SOAP call.

getInterface

public String getInterface()
Get the SOAP server object interface class full name.


setInterface

public void setInterface(String serverclass)
Set the SOAP server object interface class full name.


isGenerated

public boolean isGenerated()
Gets the flag that determines if the SOAP client was generated by this data source.

Returns:
true if generated; false otherwise.

setGenerated

public void setGenerated(boolean generated)
Sets the flag that determines if the SOAP client was generated by this data source.

Parameters:
generated - true if generated; false otherwise.

generate

public String generate(String wsdl)
                throws Exception
Generates the SOAP client.

Parameters:
wsdl - the URL of the WSDL describing the SOAP service.
Returns:
the fully-qualified class name of the SOAP client.
Throws:
Exception - if the generation failed.

importInterface

public void importInterface(String serverclass)
                     throws Exception
Import the SOAP server object interface class. The input/output types are extracted from the interface class.

Throws:
Exception

parseXML

public void parseXML(Element root)
              throws Exception
Parse the XML element that contains information on this data source.

Specified by:
parseXML in interface inetsoft.util.XMLSerializable
Overrides:
parseXML in class XDataSource
Throws:
Exception

writeXML

public void writeXML(PrintWriter writer)
Generate the XML segment to represent this data source.

Specified by:
writeXML in interface inetsoft.util.XMLSerializable
Overrides:
writeXML in class XDataSource

equals

public boolean equals(Object obj)
Check if equals another object.

Overrides:
equals in class XDataSource

clone

public Object clone()
Create a clone of this object.

Overrides:
clone in class XDataSource

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.