|
IBM DB2 Information Integrator Java API Reference for Developing Wrappers |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.db2.wrapper.SqlqgBaseClass
com.ibm.db2.wrapper.Wrapper
The Wrapper class represents the base class for a set of data sources. This class provides library initialization services and access to the data source servers that the wrapper supports. The Wrapper class maintains the following information:
WrapperInfo
object that contains all the information
that pertains to this wrapper. This information gets stored in the
federated server's system catalog as a result of issuing the DDL
statements CREATE WRAPPER or ALTER WRAPPER.
FencedGenericWrapper
class and the
UnfencedGenericWrapper
class.
Method Summary | |
protected Server |
createServer(java.lang.String serverName)
Instantiate the appropriate subclass of Server for the wrapper. |
protected void |
destroy()
Destroys this wrapper object and frees any resources associated with it. |
java.lang.String |
getCorelib()
Retrieve the wrapper core library name. |
WrapperInfo |
getInfo()
Retrieve the wrapper information that is stored in the federated server's system catalog as a result of running DDL statements. |
java.lang.String |
getName()
Retrieve the wrapper name. |
char |
getType()
Retrieve the wrapper type. |
int |
getVersion()
Retrieve the version of the wrapper, which represents the version that is currently running. |
protected void |
initializeMyWrapper(WrapperInfo wrapperInfo)
Initialize the wrapper object state from the catalog information object. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
protected Server createServer(java.lang.String serverName) throws java.lang.Exception
serverName
- The name of the data source server to be created,
which is specified on the CREATE SERVER statement.
java.lang.Exception
- if a new Server instance cannot be created.Server
protected void destroy() throws java.lang.Exception
UnfencedGenericWrapper
and FencedGenericWrapper
.
java.lang.Exception
- if the processing fails.public final java.lang.String getCorelib()
public final WrapperInfo getInfo()
WrapperInfo
public final java.lang.String getName()
public char getType()
public int getVersion()
protected void initializeMyWrapper(WrapperInfo wrapperInfo) throws java.lang.Exception
UnfencedGenericWrapper
and FencedGenericWrapper
.
wrapperInfo
- The WrapperInfo instance that contains the catalog information for the wrapper.
java.lang.Exception
- if the initialization process fails.WrapperInfo
|
IBM DB2 Information Integrator Java API Reference for Developing Wrappers |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
(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.