com.denodo.itpilot.client

Class HTMLWrapperServerProxy

java.lang.Object

com.denodo.itpilot.client.HTMLWrapperServerProxy

public class HTMLWrapperServerProxy
extends Object

Proxy to a database of a Wrapper Server. It creates a dataSource, and can be configured to use a common connection for all opertaions (in this case the class is not thread safe) or to create a new connection for each operation (default). All the wrapper proxys created by this server proxy use the same connection criteria. If it use the same connection, when the object is not longer used the close method can be used to close the connection (if this method is not called the connection is closed when the object is destroyed by the gc).

A list of parameters can be established in the constructors:

• The host and port where the Wrapper Server is launched.
• The name of the database.
• The user name and password used to connect to the database.
• Connection configuration parameters: query timeout, chunk timeout and chunk size.

Some constructors accept only a subset of these parameters. The parameters not specified are set to its default value which is read from the configuration, or set to a default value if not present.

• User name: conf property "wrapperServer.defaultUseNamer", default="admin"
• Password: conf property "wrapperServer.defaultPassword"
• Database name: conf property "defaultDatabase", default="itpilot"
• Query timeout: conf property "wrapperServer.defaultQueryTimeout", default=80000
• Chunk timeout: conf property "wrapperServer.defaultChunkTimeout", default=90000
• Chunk size: conf property "wrapperServer.defaultChunkSize", default=100

Constructor Summary

Constructors

Constructor and Description
HTMLWrapperServerProxy(String host, int port) Creates a proxy to a database of a Wrapper Server.
HTMLWrapperServerProxy(String host, int port, boolean sameConnection) Creates a proxy to a database of a Wrapper Server.
HTMLWrapperServerProxy(String host, int port, long queryTimeout, long chunkTimeout, long chunkSize) Creates a proxy to a database of a Wrapper Server.
HTMLWrapperServerProxy(String host, int port, long queryTimeout, long chunkTimeout, long chunkSize, boolean sameConnection) Creates a proxy to a database of a Wrapper Server.
HTMLWrapperServerProxy(String host, int port, String dbName, String userName, String password) Creates a proxy to a database of a Wrapper Server.
HTMLWrapperServerProxy(String host, int port, String dbName, String userName, String password, boolean sameConnection) Creates a proxy to a database of a Wrapper Server.
HTMLWrapperServerProxy(String host, int port, String dbName, String userName, String password, long queryTimeout, long chunkTimeout, long chunkSize, boolean sameConnection) Creates a proxy to a database of a Wrapper Server.

Method Summary

Modifier and Type	Method and Description
void	addExtension(String name, File file, boolean replace) Adds the given extension to the Wrapper Server.
void	addExtension(String name, String base64content, boolean replace) Adds the given extension to the Wrapper Server.
void	changePassword(String newPassword) Changes the current user password in the Wrapper Server.
void	close() Closes the common connection if it exists.
void	deleteExtension(String name) Deletes the given extension of the Wrapper Server.
void	deleteExtensions(List<String> extensions) Deletes the given extensions of the Wrapper Server.
void	deleteWrapper(String wpName) Deletes the wrapper in the database.
void	deleteWrappers(List<String> wpNames) Deletes the wrappers in the database.
void	disableMaintenance(List<String> wrapperNames) Deprecated. use disableVerification instead
void	disableVerification(List<String> wrapperNames) Disables automatic maintenance for the given wrappers.
void	enableMaintenance(List<String> wrapperNames) Deprecated. use enableVerification instead
void	enableVerification(List<String> wrapperNames) Enables automatic maintenance for the given wrappers.
Map	getConfiguration() Obtains the configuration parameters of the Wrapper Server.
Collection	getDatabaseNames() Obtains the database names in the Wrapper Server.
Collection	getExtensions() Obtains all the extensions of the Wrapper Server.
HTMLWrapperProxy	getHTMLWrapper(String wpName) Obtains a proxy to the wrapper of the database.
Collection	getHTMLWrapperNames() Returns the names of the HTML wrappers of the database.
String	getVQL() Returns a VQL with all the wrappers installed in the server.
String	getVQL(boolean includeScanners) Returns a vql with all the wrappers installed in the server.
String	getVQL(boolean includeScanners, boolean includeJars) Returns a vql with all the wrappers installed in the server.
String	getVQL(boolean includeScanners, boolean includeJars, boolean includeCustomComponents) Returns a vql with all the wrappers installed in the server.
void	loadWrapper(String vql) Loads a vql that contains CREATE WRAPPER ITP and DROP WRAPPER ITP sentences.
void	setDenodoBrowserOptimization(List<String> wrapperNames, boolean httpOptimization) Changes the value of the httpOptimization option for the given wrappers.
void	setParameters(Map parameters) Modifies the given configuration parameters in the Wrapper Server.
void	setPassThrough(List<String> wrapperNames, boolean passThrough) Changes the value of the PASSTHROUGH option for the given wrappers.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTMLWrapperServerProxy

public HTMLWrapperServerProxy(String host,
                              int port)
                       throws ITPilotClientException

Creates a proxy to a database of a Wrapper Server.

Parameters:

host - host where the Wrapper Server is launched

port - port where the Wrapper Server is lanunched

Throws:

ITPilotClientException - if an error occurs.

HTMLWrapperServerProxy

public HTMLWrapperServerProxy(String host,
                              int port,
                              boolean sameConnection)
                       throws ITPilotClientException

Creates a proxy to a database of a Wrapper Server.

Parameters:

host - host where the Wrapper Server is launched.

port - port where the Wrapper Server is lanunched.

sameConnection - true if the proxy uses a common connection for all the operations.

Throws:

ITPilotClientException - if an error occurs.

HTMLWrapperServerProxy

public HTMLWrapperServerProxy(String host,
                              int port,
                              long queryTimeout,
                              long chunkTimeout,
                              long chunkSize)
                       throws ITPilotClientException

Creates a proxy to a database of a Wrapper Server.

Parameters:

host - host where the Wrapper Server is launched.

port - port where the Wrapper Server is lanunched.

queryTimeout - maximum time to wait by a query result.

chunkTimeout - maximum time to wait between two consecutive results of VDP.

chunkSize - number of blocks in each chunk.

Throws:

ITPilotClientException - if an error occurs.

HTMLWrapperServerProxy

public HTMLWrapperServerProxy(String host,
                              int port,
                              long queryTimeout,
                              long chunkTimeout,
                              long chunkSize,
                              boolean sameConnection)
                       throws ITPilotClientException

Creates a proxy to a database of a Wrapper Server.

Parameters:

host - host where the Wrapper Server is launched.

port - port where the Wrapper Server is lanunched.

queryTimeout - maximum time to wait by a query result.

chunkTimeout - maximum time to wait between two consecutive results of VDP.

chunkSize - number of blocks in each chunk.

sameConnection - true if the proxy uses a common connection for all the operations.

Throws:

ITPilotClientException - if an error occurs.

HTMLWrapperServerProxy

public HTMLWrapperServerProxy(String host,
                              int port,
                              String dbName,
                              String userName,
                              String password)
                       throws ITPilotClientException

Creates a proxy to a database of a Wrapper Server.

Parameters:

host - host where the Wrapper Server is launched.

port - port where the Wrapper Server is lanunched.

dbName - the database name to connect to.

userName - the database user name.

password - the database user password.

Throws:

ITPilotClientException - if an error occurs.

HTMLWrapperServerProxy

public HTMLWrapperServerProxy(String host,
                              int port,
                              String dbName,
                              String userName,
                              String password,
                              boolean sameConnection)
                       throws ITPilotClientException

Creates a proxy to a database of a Wrapper Server.

Parameters:

host - host where the wrapper server is launched.

port - port where the wrapper server is lanunched.

dbName - the database name to connect to.

userName - the database user name.

password - the database user password.

sameConnection - true if the proxy uses a common connection for all the operations.

Throws:

ITPilotClientException - if an error occurs.

HTMLWrapperServerProxy

public HTMLWrapperServerProxy(String host,
                              int port,
                              String dbName,
                              String userName,
                              String password,
                              long queryTimeout,
                              long chunkTimeout,
                              long chunkSize,
                              boolean sameConnection)
                       throws ITPilotClientException

Creates a proxy to a database of a Wrapper Server.

Parameters:

host - host where the Wrapper Server is launched.

port - port where the Wrapper Server is lanunched.

dbName - the database name to connect to.

userName - the database user name.

password - the database user password.

queryTimeout - maximum time to wait by a query result

chunkTimeout - maximum time to wait between two consecutive results of the VDP.

chunkSize - number of blocks in each chunk.

sameConnection - true if the proxy uses a common connection for all the operations.

Throws:

ITPilotClientException - if an error occurs.

Method Detail

getVQL

public String getVQL()
              throws ITPilotClientException

Returns a VQL with all the wrappers installed in the server.

Returns:

the VQL with all the wrappers of the server.

Throws:

ITPilotClientException

getVQL

public String getVQL(boolean includeScanners)
              throws ITPilotClientException

Returns a vql with all the wrappers installed in the server.

Parameters:

includeScanners - true if the vql includes the scanners used by the wrappers.

Returns:

VQL specification of all the wrappers in the server.

Throws:

ITPilotClientException - if an error occurs.

getVQL

public String getVQL(boolean includeScanners,
                     boolean includeJars)
              throws ITPilotClientException

Returns a vql with all the wrappers installed in the server.

Parameters:

includeScanners - true if the vql includes the scanners used by the wrappers.

includeJars - true if the vql includes the extensions used by the wrappers.

Returns:

VQL specification of all the wrappers in the server.

Throws:

ITPilotClientException - if an error occurs.

getVQL

public String getVQL(boolean includeScanners,
                     boolean includeJars,
                     boolean includeCustomComponents)
              throws ITPilotClientException

Returns a vql with all the wrappers installed in the server.

Parameters:

includeScanners - true if the vql includes the scanners used by the wrappers.

includeJars - true if the vql includes the extensions used by the wrappers.

includeCustomComponents - true if the vql includes the custom components used by the wrappers.

Returns:

VQL specification of all the wrappers in the server.

Throws:

ITPilotClientException - if an error occurs.

getHTMLWrapperNames

public Collection getHTMLWrapperNames()
                               throws ITPilotClientException

Returns the names of the HTML wrappers of the database.

Returns:

a collection containing the names of all the HTML wrappers of the database.

Throws:

ITPilotClientException - if an error occurs.

getHTMLWrapper

public HTMLWrapperProxy getHTMLWrapper(String wpName)
                                throws ITPilotClientException

Obtains a proxy to the wrapper of the database.

Parameters:

wpName - the name of the wrapper.

Returns:

a proxy to the wrapper.

Throws:

ITPilotClientException - if the wrapper does not exist or an error occurs.

deleteWrapper

public void deleteWrapper(String wpName)
                   throws ITPilotClientException

Deletes the wrapper in the database.

Parameters:

wpName - the name of the wrapper to delete.

Throws:

ITPilotClientException - if the wrapper does not exist or an error occurs.

deleteWrappers

public void deleteWrappers(List<String> wpNames)
                    throws ITPilotClientException

Deletes the wrappers in the database.

Parameters:

wpNames - the list of the wrappers names to delete.

Throws:

ITPilotClientException - if the wrappers do not exist or an error occurs.

enableMaintenance

public void enableMaintenance(List<String> wrapperNames)
                       throws ITPilotClientException

Deprecated. use enableVerification instead

Enables automatic maintenance for the given wrappers.

Parameters:

wrapperNames - the list of wrapper names.

Throws:

ITPilotClientException - if the wrappers do not exist or an error occurs.

enableVerification

public void enableVerification(List<String> wrapperNames)
                        throws ITPilotClientException

Enables automatic maintenance for the given wrappers.

Parameters:

wrapperNames - the list of wrapper names.

Throws:

ITPilotClientException - if the wrappers do not exist or an error occurs.

disableMaintenance

public void disableMaintenance(List<String> wrapperNames)
                        throws ITPilotClientException

Deprecated. use disableVerification instead

Disables automatic maintenance for the given wrappers.

Parameters:

wrapperNames - the list of wrapper names.

Throws:

ITPilotClientException - if the wrappers dos not exist or an error occurs.

disableVerification

public void disableVerification(List<String> wrapperNames)
                         throws ITPilotClientException

Disables automatic maintenance for the given wrappers.

Parameters:

wrapperNames - the list of wrapper names.

Throws:

ITPilotClientException - if the wrappers dos not exist or an error occurs.

setDenodoBrowserOptimization

public void setDenodoBrowserOptimization(List<String> wrapperNames,
                                         boolean httpOptimization)
                                  throws ITPilotClientException

Changes the value of the httpOptimization option for the given wrappers.

Parameters:

wrapperNames - the list of wrapper names.

httpOptimization - if true, the wrapper will use the optimization data in denodo browser based sequences.

Throws:

ITPilotClientException - if an error occurs.

setPassThrough

public void setPassThrough(List<String> wrapperNames,
                           boolean passThrough)
                    throws ITPilotClientException

Changes the value of the PASSTHROUGH option for the given wrappers.

Parameters:

wrapperNames - the list of wrapper names.

passThrough - if true, the wrapper will use passthrough credentials.

Throws:

ITPilotClientException - if an error occurs.

changePassword

public void changePassword(String newPassword)
                    throws ITPilotClientException

Changes the current user password in the Wrapper Server.

Parameters:

newPassword - the new password.

Throws:

ITPilotClientException - if an error occurs.

getDatabaseNames

public Collection getDatabaseNames()
                            throws ITPilotClientException

Obtains the database names in the Wrapper Server. This method can be executed only if the user has administrator privileges over the connected database.

Returns:

a collection containing the names of all the databases of the Wrapper Server.

Throws:

ITPilotClientException - if an error occurs.

getConfiguration

public Map getConfiguration()
                     throws ITPilotClientException

Obtains the configuration parameters of the Wrapper Server. They are the same for all the databases of the server.

Returns:

a Map containing the configuration.

Throws:

ITPilotClientException - if an error occurs.

setParameters

public void setParameters(Map parameters)
                   throws ITPilotClientException

Modifies the given configuration parameters in the Wrapper Server. The changes do not take effect until the server is restarted.

Parameters:

parameters - the parameters to modify. The keys of the Map are parameter names and the values are the new values for the parameters.

Throws:

ITPilotClientException - if an error occurs.

loadWrapper

public void loadWrapper(String vql)
                 throws ITPilotClientException

Loads a vql that contains CREATE WRAPPER ITP and DROP WRAPPER ITP sentences. Each sentence can be separated with #END-SENTENCE.

Parameters:

vql - String that contains the vql sentences to load in the server.

Throws:

ITPilotClientException

addExtension

public void addExtension(String name,
                         String base64content,
                         boolean replace)
                  throws ITPilotClientException

Adds the given extension to the Wrapper Server.

Parameters:

name - the extension name to be added.

base64content - the extension content encoded in Base64.

replace - true if the extension (if already exists) should be replaced with this new one.

Throws:

ITPilotClientException - if an error occurs.

addExtension

public void addExtension(String name,
                         File file,
                         boolean replace)
                  throws ITPilotClientException,
                         IOException

Adds the given extension to the Wrapper Server.

Parameters:

name - the extension name to be added.

file - the file containing the extension.

replace - true if the extension (if already exists) should be replaced with this new one.

Throws:

ITPilotClientException - if an error occurs.

IOException

deleteExtension

public void deleteExtension(String name)
                     throws ITPilotClientException

Deletes the given extension of the Wrapper Server.

Parameters:

name - the extension name to be deleted.

Throws:

ITPilotClientException - if an error occurs.

deleteExtensions

public void deleteExtensions(List<String> extensions)
                      throws ITPilotClientException

Deletes the given extensions of the Wrapper Server.

Parameters:

extensions - the list of the extension names to delete.

Throws:

ITPilotClientException - if an error occurs.

getExtensions

public Collection getExtensions()
                         throws ITPilotClientException

Obtains all the extensions of the Wrapper Server.

Returns:

a Collection of JarInfoVO.

Throws:

ITPilotClientException - if an error occurs.

close

public void close()
           throws ITPilotClientException

Closes the common connection if it exists.

Throws:

ITPilotClientException - if an error occurs.