|
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.Server
com.ibm.db2.wrapper.UnfencedServer
The UnfencedServer class is a subclass of the Server class and is the
abstract base class for all data source server functionality that operates in the unfenced
(trusted) process space.
This class is responsible for validation and for performing the query planning.
Usage:
Do not use this class directly. Instantiating or subclassing the
UnfencedServer class directly results in incorrect wrapper behavior.
Subclass the UnfencedGenericServer
class.
Constructor Summary | |
protected |
UnfencedServer(java.lang.String name,
int kind,
UnfencedWrapper wrapper)
|
Method Summary | |
Nickname |
findNickname(java.lang.String schema,
java.lang.String name)
Search for a nickname with the specified schema name and nickname name. |
void |
insertRemoteFunction(DefaultRemoteFunction defaultRemoteFunction)
This function adds a temporary remote function mapping based on the DefaultRemoteFunction
object to the server. |
void |
insertRemoteFunction(RemoteFunctionInfo remoteFunctionInfo)
This function adds a temporary remote function mapping based on the RemoteFunctionInfo
object to the server. |
static boolean |
isReservedFunctionOption(java.lang.String functionOption)
Returns true if an option is a reserved function option |
protected void |
setMyDefaultRemoteFunctionMappings()
Allows the wrapper to add temporary function mappings to the current server via the insertRemoteFunction(RemoteFunctionInfo) and insertRemoteFunction(DefaultRemoteFunction) method. |
protected ServerInfo |
verifyMyAlterServerInfo(ServerInfo serverInfo)
Validate the data source server information that is specified in ALTER SERVER statements. |
protected void |
verifyMyFunctionMappingInfo(RemoteFunctionInfo remoteFunctionInfo)
Validates function mapping information that is specified in CREATE FUNCTION MAPPING statements. |
protected ServerInfo |
verifyMyRegisterServerInfo(ServerInfo serverInfo)
Validate the data source server information that is specified in CREATE SERVER statements. |
Methods inherited from class com.ibm.db2.wrapper.Server |
createNickname, createRemoteUser, destroy, findRemoteUser, getInfo, getName, getType, getVersion, getWrapper, initializeMyServer |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected UnfencedServer(java.lang.String name, int kind, UnfencedWrapper wrapper)
Method Detail |
public final Nickname findNickname(java.lang.String schema, java.lang.String name)
schema
- The schema name of the nickname to locate.name
- The name of the nickname to locate.
Nickname
public final void insertRemoteFunction(DefaultRemoteFunction defaultRemoteFunction) throws WrapperException
DefaultRemoteFunction
object to the server. The function can only be called inside setMyDefaultRemoteFunctionMappings()
WrapperException
- - if called outside of the setMyDefaultRemoteFunctionMappings()
contextDefaultRemoteFunction
,
setMyDefaultRemoteFunctionMappings()
public final void insertRemoteFunction(RemoteFunctionInfo remoteFunctionInfo) throws WrapperException
RemoteFunctionInfo
object to the server. The function can only be called inside setMyDefaultRemoteFunctionMappings()
The function just inserts the provided RemoteFunctionInfo object - it does not follow the RemoteFuctionInfo chain.
WrapperException
- - if called outside of the setMyDefaultRemoteFunctionMappings()
contextRemoteFunctionInfo
,
setMyDefaultRemoteFunctionMappings()
public static final boolean isReservedFunctionOption(java.lang.String functionOption)
functionOption
- the option name to be checkedprotected void setMyDefaultRemoteFunctionMappings() throws java.lang.Exception
insertRemoteFunction(RemoteFunctionInfo)
and insertRemoteFunction(DefaultRemoteFunction)
method.
By default no function mappings are added. The wrapper can implement this function to add temporary function mappings.
java.lang.Exception
- if an error occurs.insertRemoteFunction(RemoteFunctionInfo)
,
insertRemoteFunction(DefaultRemoteFunction)
protected ServerInfo verifyMyAlterServerInfo(ServerInfo serverInfo) throws java.lang.Exception
serverInfo
- An object that contains the information that is provided in ALTER SERVER statements.
java.lang.Exception
- if the verification fails.ServerInfo
protected void verifyMyFunctionMappingInfo(RemoteFunctionInfo remoteFunctionInfo) throws java.lang.Exception
remoteFunctionInfo
- A RemoteFunctionInfo instance that contains the function mapping information.
java.lang.Exception
- if the verification fails.RemoteFunctionInfo
protected ServerInfo verifyMyRegisterServerInfo(ServerInfo serverInfo) throws java.lang.Exception
serverInfo
- An object that contains the information that is provided in CREATE SERVER statements.
java.lang.Exception
- if the verification fails.ServerInfo
|
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.