com.altair.hwm.database.sql.protocol
Class DBCxnPacket

java.lang.Object
  extended by com.altair.hwm.database.sql.protocol.DBCxnPacket

public class DBCxnPacket
extends java.lang.Object

Title: DBCxnPacket

Description: This class represents the cxn packet sent by client to the server asking it to establish cxn with DB.

Company: Altair Engineering, Inc.


Constructor Summary
DBCxnPacket()
          Constructor
DBCxnPacket(java.lang.String strDBInfoName, java.lang.String strDBURL, java.lang.String strUser, java.lang.String strPWD, boolean bCreateDB)
          Constructor
 
Method Summary
 HWMDatabaseInfo GetDBInfoClass()
          Get DBInfo class
 java.lang.String GetDBInfoName()
          Get DBInfo class name
 java.lang.String GetDBURL()
          Gets the URL for the DB
 java.lang.String GetPWD()
          Returns the password
 java.lang.String GetUser()
          Returns the user name
 boolean IsDBCreateFlag()
          Gets the flag that indicates if the DB should be created
 void ReadPacket(java.io.ObjectInputStream in)
          Reads this object from the input stream
 void SetDBCreateFlag(boolean bCreateDB)
          Sets the flag to indicate if the DB should be created
 void SetDBInfoClass(java.lang.String strDBInfo)
          Set DBInfo class name
 void SetDBURL(java.lang.String strDBURL)
          Sets the url for the DB
 void SetPWD(java.lang.String strPWD)
          Sets the password
 void SetUser(java.lang.String strUser)
          Sets the user name
 void WritePacket(java.io.ObjectOutputStream out)
          Writes out this object to the output stream
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DBCxnPacket

public DBCxnPacket()
Constructor


DBCxnPacket

public DBCxnPacket(java.lang.String strDBInfoName,
                   java.lang.String strDBURL,
                   java.lang.String strUser,
                   java.lang.String strPWD,
                   boolean bCreateDB)
Constructor

Parameters:
strDBInfoName - The database info class name
strDBURL - The URL of the DB
strUser - The user URL to use
strPWD - The password to use
bCreateDB - If true, the database is created
Method Detail

SetDBURL

public void SetDBURL(java.lang.String strDBURL)
Sets the url for the DB

Parameters:
strDBURL - The URL for the database

GetDBURL

public java.lang.String GetDBURL()
Gets the URL for the DB

Returns:
String The URL for the database

SetUser

public void SetUser(java.lang.String strUser)
Sets the user name

Parameters:
strUser - The user name to use

GetUser

public java.lang.String GetUser()
Returns the user name

Returns:
String The user name

SetPWD

public void SetPWD(java.lang.String strPWD)
Sets the password

Parameters:
strPWD - The password to use

GetPWD

public java.lang.String GetPWD()
Returns the password

Returns:
String The password

SetDBCreateFlag

public void SetDBCreateFlag(boolean bCreateDB)
Sets the flag to indicate if the DB should be created

Parameters:
bCreateDB - If true the DB it is created else not created

IsDBCreateFlag

public boolean IsDBCreateFlag()
Gets the flag that indicates if the DB should be created

Returns:
boolean If true the DB it is created else not created

GetDBInfoClass

public HWMDatabaseInfo GetDBInfoClass()
                               throws java.lang.Exception
Get DBInfo class

Returns:
HWMDatabaseInfo The database info class
Throws:
java.lang.Exception

SetDBInfoClass

public void SetDBInfoClass(java.lang.String strDBInfo)
Set DBInfo class name

Parameters:
strDBInfo - The database info class name

GetDBInfoName

public java.lang.String GetDBInfoName()
Get DBInfo class name

Returns:
String The database info class name

WritePacket

public void WritePacket(java.io.ObjectOutputStream out)
                 throws java.io.IOException
Writes out this object to the output stream

Parameters:
out - The output stream
Throws:
java.io.IOException

ReadPacket

public void ReadPacket(java.io.ObjectInputStream in)
                throws java.io.IOException,
                       java.lang.ClassNotFoundException
Reads this object from the input stream

Parameters:
in - The input stream
Throws:
java.io.IOException
java.lang.ClassNotFoundException