|
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.CatalogInfo
com.ibm.db2.wrapper.ServerInfo
The ServerInfo class encapsulates the catalog information for a server object from the CREATE SERVER and ALTER SERVER statements.
The ServerInfo class is one of the catalog classes for the Java API.
Usage:
The ServerInfo class is instantiated by the DB2 federated server to contain
information from a CREATE SERVER or an ALTER SERVER statement
or to contain information from the federated server's system catalog.
This class is instantiated by the wrapper when information is added during
CREATE SERVER or ALTER SERVER statement operations.
Constructor Summary | |
ServerInfo()
Construct a default (empty) server information object. |
|
ServerInfo(java.lang.String name,
java.lang.String type,
java.lang.String version,
java.lang.String wrapperName)
Construct a fully initialized server information object. |
Method Summary | |
void |
addOption(java.lang.String optionName,
java.lang.String optionValue,
int action)
Add a single-value option to the options chain. |
void |
addOption(java.lang.String optionName,
java.lang.String optionValue,
java.sql.Timestamp timestamp,
java.lang.String valueID,
int action)
Add a multi-value option to the options chain. |
void |
dropOption(CatalogOption option)
Delete an option from the options chain. |
void |
dropOption(CatalogOption option,
java.lang.String valueID)
Delete a value from a multi-value option and delete the option if no values remain. |
void |
dropRemoteFunction(RemoteFunctionInfo remoteFunctionInfo)
Drop a remote function mapping object from the chain. |
java.lang.String |
getAuthID()
Retrieve the authorization ID for the server. |
RemoteFunctionInfo |
getFirstRemoteFunction()
Retrieve the first remote function mapping object from the chain. |
RemoteFunctionInfo |
getNextRemoteFunction(RemoteFunctionInfo remoteFunctionInfo)
Retrieve the next remote function mapping object from the chain. |
java.lang.String |
getPassword()
Retrieve the password for the server. |
RemoteFunctionInfo |
getRemoteFunction(java.lang.String functionName)
Retrieve the remote function mapping object with the specified name from the chain. |
java.lang.String |
getServerName()
Retrieve the name of the server. |
java.lang.String |
getType()
Retrieve the type of the server. |
java.lang.String |
getVersion()
Retrieve the version string for the server. |
java.lang.String |
getWrapperName()
Retrieve the name of the wrapper that contains the server. |
void |
insertRemoteFunction(RemoteFunctionInfo remoteFunctionInfo)
Insert a remote function mapping object into the chain. |
boolean |
isAuthIDValid()
Verify whether an authorization ID value is specified. |
boolean |
isNameValid()
Verify whether the value of server name is specified. |
boolean |
isPasswordValid()
Verify whether a password value is specified. |
boolean |
isTypeValid()
Verify whether a type value is specified. |
boolean |
isVersionValid()
Verify whether a version value is specified. |
boolean |
isWrapperNameValid()
Verify if a wrapper name value is specified. |
void |
setAuthID(java.lang.String authID)
Set the authorization ID for the server. |
void |
setPassword(java.lang.String password)
Set the password for the server. |
void |
setServerName(java.lang.String name)
Set the server name. |
void |
setType(java.lang.String type)
Set the type of the server. |
void |
setVersion(java.lang.String version)
Set the version string for the server. |
void |
setWrapperName(java.lang.String name)
Set the name of the wrapper that contains the server. |
Methods inherited from class com.ibm.db2.wrapper.CatalogInfo |
addOption, getFirstOption, getNextOption, getOption |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ServerInfo()
public ServerInfo(java.lang.String name, java.lang.String type, java.lang.String version, java.lang.String wrapperName)
name
- The server name.type
- The server type.version
- The version.wrapperName
- The name of the wrapper that contains the server.Method Detail |
public void addOption(java.lang.String optionName, java.lang.String optionValue, int action) throws WrapperException
optionName
- The name of the option.optionValue
- The value of the option.action
- The action flag for the option.
WrapperException
- if the option already exists in the chain or if the action is invalid.SingleValueOption
public void addOption(java.lang.String optionName, java.lang.String optionValue, java.sql.Timestamp timestamp, java.lang.String valueID, int action) throws WrapperException
optionName
- The name of the option.optionValue
- The value of the option.timestamp
- The timestamp of the value.valueID
- The ID of the value.action
- The action flag for the option.
WrapperException
- if a duplicate value ID is specified or if the action is invalid.MultiValueOption
public void dropOption(CatalogOption option) throws WrapperException
dropOption
in class CatalogInfo
option
- The option to be deleted.
WrapperException
- if the option object is null.CatalogOption
public void dropOption(CatalogOption option, java.lang.String valueID) throws WrapperException
option
- The option.valueID
- The ID of the value to be deleted.
WrapperException
- if the option object is null or the value ID is not found.CatalogOption
public void dropRemoteFunction(RemoteFunctionInfo remoteFunctionInfo) throws WrapperException
remoteFunctionInfo
- The function mapping object to be dropped.
WrapperException
- if the remote function is null.RemoteFunctionInfo
public java.lang.String getAuthID()
public RemoteFunctionInfo getFirstRemoteFunction()
RemoteFunctionInfo
public RemoteFunctionInfo getNextRemoteFunction(RemoteFunctionInfo remoteFunctionInfo)
remoteFunctionInfo
- The current function mapping object.
RemoteFunctionInfo
public java.lang.String getPassword()
public RemoteFunctionInfo getRemoteFunction(java.lang.String functionName) throws WrapperException
functionName
- The name of the function mapping.
WrapperException
- if the function name is null or is not found.RemoteFunctionInfo
public java.lang.String getServerName()
public java.lang.String getType()
public java.lang.String getVersion()
public java.lang.String getWrapperName()
public void insertRemoteFunction(RemoteFunctionInfo remoteFunctionInfo) throws WrapperException
remoteFunctionInfo
- The function mapping object to be inserted.
WrapperException
- if the remote function is null.RemoteFunctionInfo
public boolean isAuthIDValid()
public boolean isNameValid()
public boolean isPasswordValid()
public boolean isTypeValid()
public boolean isVersionValid()
public boolean isWrapperNameValid()
public void setAuthID(java.lang.String authID)
authID
- The authorization IDpublic void setPassword(java.lang.String password)
password
- The password.public void setServerName(java.lang.String name)
name
- The server name.public void setType(java.lang.String type)
type
- The server type.public void setVersion(java.lang.String version)
version
- The version.public void setWrapperName(java.lang.String name)
name
- The name of the wrapper.
|
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.