IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

com.ibm.db2.wrapper
Class UnfencedWrapper

java.lang.Object
  extended bycom.ibm.db2.wrapper.SqlqgBaseClass
      extended bycom.ibm.db2.wrapper.Wrapper
          extended bycom.ibm.db2.wrapper.UnfencedWrapper
Direct Known Subclasses:
UnfencedGenericWrapper

public class UnfencedWrapper
extends Wrapper

The UnfencedWrapper class that represents the wrapper on the unfenced (trusted) process space.

Usage:
Do not use this class directly. Instantiating or subclassing the UnfencedWrapper class directly results in incorrect wrapper behavior. Subclass the UnfencedGenericWrapper class.

Since:
IBM DB2 Information Integrator Version 8.2

Method Summary
 java.lang.String getFencedWrapperClass(WrapperInfo wrapperInfo)
          Retrieve the wrapper-specific FencedWrapper subclass name from the WrapperInfo object.
 void setFencedWrapperClass(WrapperInfo wrapperInfo, java.lang.String className)
          Add the wrapper-specific FencedWrapper subclass name to the WrapperInfo object.
protected  WrapperInfo verifyMyAlterWrapperInfo(WrapperInfo wrapperInfo)
          Validate the information that is specified on an ALTER WRAPPER statement.
protected  WrapperInfo verifyMyRegisterWrapperInfo(WrapperInfo wrapperInfo)
          Validate the information that is specified on a CREATE WRAPPER statement.
 
Methods inherited from class com.ibm.db2.wrapper.Wrapper
createServer, destroy, getCorelib, getInfo, getName, getType, getVersion, initializeMyWrapper
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getFencedWrapperClass

public final java.lang.String getFencedWrapperClass(WrapperInfo wrapperInfo)
                                             throws WrapperException
Retrieve the wrapper-specific FencedWrapper subclass name from the WrapperInfo object.

Usage:
This method retrieves the name of the class that needs to be loaded for the fenced part of the wrapper. The class name is specified as the value of the FENCED_WRAPPER_CLASS wrapper option.

Parameters:
wrapperInfo - The WrapperInfo object which stores the wrapper catalog information.
Returns:
The FencedWrapper subclass name or null, if no class name was specified.
Throws:
WrapperException - if the method fails.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
WrapperInfo

setFencedWrapperClass

public final void setFencedWrapperClass(WrapperInfo wrapperInfo,
                                        java.lang.String className)
                                 throws WrapperException
Add the wrapper-specific FencedWrapper subclass name to the WrapperInfo object.

Usage:
This method indicates which class needs to be loaded for the fenced part of the wrapper, and passes this information to the federated server.

Parameters:
wrapperInfo - The WrapperInfo object where the option is added.
className - The FencedWrapper subclass name.
Throws:
WrapperException - if the method fails.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
WrapperInfo

verifyMyAlterWrapperInfo

protected WrapperInfo verifyMyAlterWrapperInfo(WrapperInfo wrapperInfo)
                                        throws java.lang.Exception
Validate the information that is specified on an ALTER WRAPPER statement. This method is for verification only. Therefore, do not update the internal state of the Wrapper object with the new information that is obtained from the ALTER WRAPPER statement. If the execution of the statement is successful, DB2 ensures that the Wrapper object is destroyed and re-created with the new information. Default implementation allows only reserved options and does not return more information. This method can be implemented by the wrapper in the wrapper-specific unfenced wrapper subclass and must be implemented if wrapper-specific wrapper options are supported.

Parameters:
wrapperInfo - A WrapperInfo object that contains the information that is provided in the ALTER WRAPPER statement.
Returns:
A WrapperInfo object with the information that is added by the wrapper.
Throws:
java.lang.Exception - if the verification process fails.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
WrapperInfo

verifyMyRegisterWrapperInfo

protected WrapperInfo verifyMyRegisterWrapperInfo(WrapperInfo wrapperInfo)
                                           throws java.lang.Exception
Validate the information that is specified on a CREATE WRAPPER statement. Default implementation allows only reserved options and does not return more information. This method can be implemented by the wrapper in the wrapper-specific unfenced wrapper subclass and must be implemented if wrapper-specific wrapper options are supported.

Parameters:
wrapperInfo - A WrapperInfo object that contains the information that is provided in the CREATE WRAPPER statement.
Returns:
A WrapperInfo object with the information that is added by the wrapper.
Throws:
java.lang.Exception - if the verification process fails.
Since:
IBM DB2 Information Integrator Version 8.2
See Also:
WrapperInfo

IBM DB2 Information Integrator
Java API Reference
for Developing Wrappers

(C)Copyright IBM Corp. 2002. All rights reserved.

Links on this page are made available for your convenience and may take you to non-IBM sites. IBM does not warrant any sample code provided on these sites.