com.denodo.itpilot.client

Class HTMLWrapperProxy

java.lang.Object

com.denodo.itpilot.client.HTMLWrapperProxy

public class HTMLWrapperProxy
extends Object

Proxy to a HTML wrapper. The objects of this class are created by the method getWrapper of the class HTMLWrapperServerProxy. To obtain the connections to the Wrapper Server it uses the same datasource as the Wrapper Server proxy used to create this wrapper proxy. It can be configured to use a common connection for all operations (in this case the class is not thread safe) or to create a new conecction for each operation. It uses the same configuration as the Wrapper Server proxy which created it. 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).

Constructor Summary

Constructors

Constructor and Description
HTMLWrapperProxy(com.denodo.vdb.vdbinterface.common.clientResult.vo.descriptions.wrapper.HTMLWrapperVO wrapperVO, com.denodo.vdb.vdbinterface.common.datasource.VDBDataSource dataSource, boolean sameConnection) Creates a proxy to a wrapper.

Method Summary

Modifier and Type	Method and Description
boolean	checkObligatoryParams(Map params) Checks all mandatory parameters have a valid value.
boolean	checkQueryParams(Map params) Validates the query parameters.
boolean	checkSearchableParams(Map params) Validates all the query parameters are searchable fields of the wrapper.
void	close() Closes the common connection if it exists.
boolean	getAutoDeploy() Returns the value of the autodeploy option.
boolean	getDenodoBrowserOptimization() Returns the value of the httpOptimization option.
com.denodo.vdb.vdbinterface.common.clientResult.vo.descriptions.wrapper.HTMLWrapperVO	getHTMLWrapperVO() Returns the wrapper.
boolean	getMaintenance() Returns the value of the maintenance option.
boolean	getPassThrough() Returns the value of the passthrough option.
boolean	getRegenerate() Returns the value of the regenerate option.
HTMLWrapperMetaRegisterRawVO	getSchema() Returns the wrapper schema.
Collection	getSearchableFields() Returns the names of the searchable fields.
Collection	getSearchableObligatoryFields() Returns the names of the mandatory fields.
Collection	getSensitiveFields() Return the names of the sensitive (hidden) fields.
String	getVQL() Returns the VQL of the wrapper.
String	getVQL(boolean includeScanners) Returns the VQL of the wrapper.
String	getVQL(boolean includeScanners, boolean includeJars) Returns the VQL of the wrapper.
String	getVQL(boolean includeScanners, boolean includeJars, boolean includeCustomComponents) Returns the VQL of the wrapper.
boolean	isRegenerable() Returns the value of the regenerable option.
HTMLWrapperResultIterator	query(Map params) Executes a query and returns an async iterator.
void	setAutoDeploy(boolean autodeploy) Deprecated.
void	setDenodoBrowserOptimization(boolean httpOptimization) Changes the value of the httpOptimization option.
void	setMaintenance(boolean maintenance) Deprecated.
void	setMaintenance(boolean maintenance, boolean regenerate, boolean autodeploy) Deprecated.
void	setMaintenanceOptions(boolean regenerate, boolean autodeploy) Deprecated.
void	setPassThrough(boolean passThrough) Changes the value of the PASSTHROUGH option.
void	setRegenerate(boolean regenerate) Deprecated.
void	setVerification(boolean verification) Changes the value of the property that indicates if the wrapper uses automatic maintenance.

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLWrapperProxy

public HTMLWrapperProxy(com.denodo.vdb.vdbinterface.common.clientResult.vo.descriptions.wrapper.HTMLWrapperVO wrapperVO,
                        com.denodo.vdb.vdbinterface.common.datasource.VDBDataSource dataSource,
                        boolean sameConnection)
                 throws ITPilotClientException

Creates a proxy to a wrapper.

Parameters:

wrapperVO - an object containing the wrapper metadata.

dataSource - the dataSource used to obtain the connections to the Wrapper Server.

sameConnection - if true the proxy uses a common connection, otherwise creates a new connection for each operation.

Throws:

ITPilotClientException - if an error occurs.

Method Detail

query

public HTMLWrapperResultIterator query(Map params)
                                throws ITPilotClientException,
                                       InvalidParametersException

Executes a query and returns an async iterator. If the wrapper proxy uses a common connection for all the operations the iterator returned by this method should NOT be closed.

Parameters:

params - parameters of the query.

Returns:

an async iterator to iterate over the results of the query.

Throws:

ITPilotClientException - if an error occurs.

InvalidParametersException - if the parameters are not valid for the wrapper.

checkQueryParams

public boolean checkQueryParams(Map params)

Validates the query parameters.

Parameters:

params - query parameters.

Returns:

true if the parameters are valid for this wrapper, false otherwise.

checkObligatoryParams

public boolean checkObligatoryParams(Map params)

Checks all mandatory parameters have a valid value.

Parameters:

params - query parameters.

Returns:

true if all the mandatory search fields are included in the query parameters, false otherwise.

checkSearchableParams

public boolean checkSearchableParams(Map params)

Validates all the query parameters are searchable fields of the wrapper.

Parameters:

params - query parameters.

Returns:

true if all the query parameters are searchable fields, false otherwise.

setMaintenance

@Deprecated
public void setMaintenance(boolean maintenance)
                                throws ITPilotClientException

Deprecated.

Changes the value of the property that indicates if the wrapper uses automatic maintenance.

Parameters:

maintenance - if true the wrapper uses automatic maintenance.

Throws:

ITPilotClientException - if an error occurs.

setVerification

public void setVerification(boolean verification)
                     throws ITPilotClientException

Changes the value of the property that indicates if the wrapper uses automatic maintenance.

Parameters:

verification - if true the wrapper uses automatic maintenance.

Throws:

ITPilotClientException - if an error occurs.

setMaintenanceOptions

@Deprecated
public void setMaintenanceOptions(boolean regenerate,
                                              boolean autodeploy)
                                       throws ITPilotClientException

Deprecated.

Changes the value of maintenance options.

Parameters:

regenerate - if true the wrapper will be automatically regenerated when a source change is detected.

autodeploy - if true the regenerated wrapper will be installed in the server, replacing the old version.

Throws:

ITPilotClientException - if an error occurs.

setMaintenance

@Deprecated
public void setMaintenance(boolean maintenance,
                                       boolean regenerate,
                                       boolean autodeploy)
                                throws ITPilotClientException

Deprecated.

Changes the value of maintenance options.

Parameters:

maintenance - if true the wrapper uses automatic maintenance.

regenerate - if true the wrapper will be automatically regenerated when a source change is detected.

autodeploy - if true the regenerated wrapper will be installed in the server, replacing the old version.

Throws:

ITPilotClientException - if an error occurs.

setRegenerate

@Deprecated
public void setRegenerate(boolean regenerate)
                               throws ITPilotClientException

Deprecated.

Changes the value of the regenerate option.

Parameters:

regenerate - if true the wrapper will be automatically regenerated when a source change is detected.

Throws:

ITPilotClientException - if an error occurs.

setAutoDeploy

@Deprecated
public void setAutoDeploy(boolean autodeploy)
                               throws ITPilotClientException

Deprecated.

Changes the value of the autodeploy option.

Parameters:

autodeploy - if true the regenerated wrapper will be installed in the server, replacing the old version.

Throws:

ITPilotClientException - if an error occurs.

setDenodoBrowserOptimization

public void setDenodoBrowserOptimization(boolean httpOptimization)
                                  throws ITPilotClientException

Changes the value of the httpOptimization option.

Parameters:

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

Throws:

ITPilotClientException - if an error occurs.

getDenodoBrowserOptimization

public boolean getDenodoBrowserOptimization()

Returns the value of the httpOptimization option.

Returns:

true if the wrapper uses optimization data in denodo browser based navigations, false otherwise.

setPassThrough

public void setPassThrough(boolean passThrough)
                    throws ITPilotClientException

Changes the value of the PASSTHROUGH option.

Parameters:

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

Throws:

ITPilotClientException - if an error occurs.

getPassThrough

public boolean getPassThrough()

Returns the value of the passthrough option.

Returns:

true if the wrapper uses passthrough credentials based navigations, false otherwise.

getMaintenance

public boolean getMaintenance()

Returns the value of the maintenance option.

Returns:

true if the wrapper uses automatic maintenance, false otherwise.

getRegenerate

public boolean getRegenerate()

Returns the value of the regenerate option.

Returns:

true if the wrapper will be automatically regenerated when a source change is detected, false otherwise.

getAutoDeploy

public boolean getAutoDeploy()

Returns the value of the autodeploy option.

Returns:

true if the regenerated wrapper will be installed in the server, replacing the old version; false otherwise.

isRegenerable

public boolean isRegenerable()

Returns the value of the regenerable option.

Returns:

true if the wrapper could be regenerated by the maintenance server.

getSchema

public HTMLWrapperMetaRegisterRawVO getSchema()

Returns the wrapper schema.

Returns:

the wrapper schema. It includes the output schema and the simple field characteristics (alias, regular expresion, searchable field, obligatory searchable field).

getHTMLWrapperVO

public com.denodo.vdb.vdbinterface.common.clientResult.vo.descriptions.wrapper.HTMLWrapperVO getHTMLWrapperVO()

Returns the wrapper.

Returns:

the wrapper.

getSearchableFields

public Collection getSearchableFields()

Returns the names of the searchable fields.

Returns:

a collection with the names of the searchable fields.

getSearchableObligatoryFields

public Collection getSearchableObligatoryFields()

Returns the names of the mandatory fields.

Returns:

a collection with the names of the obligatory searchable fields

getSensitiveFields

public Collection getSensitiveFields()

Return the names of the sensitive (hidden) fields.

Returns:

a collection with the names of the sensitive (hidden) fields.

getVQL

public String getVQL()
              throws ITPilotClientException

Returns the VQL of the wrapper.

Returns:

VQL specification of the wrapper.

Throws:

ITPilotClientException - if an error occurs.

getVQL

public String getVQL(boolean includeScanners)
              throws ITPilotClientException

Returns the VQL of the wrapper.

Parameters:

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

Returns:

VQL specification of the wrapper.

Throws:

ITPilotClientException - if an error occurs.

getVQL

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

Returns the VQL of the wrapper.

Parameters:

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

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

Returns:

VQL specification of the wrapper.

Throws:

ITPilotClientException - if an error occurs.

getVQL

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

Returns the VQL of the wrapper.

Parameters:

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

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

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

Returns:

VQL specification of the wrapper.

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.