com.adventnet.html.dynamic
Interface HtmlInterface

All Known Implementing Classes:
HtmlCreation

public interface HtmlInterface


Method Summary
 void createAboutUsHtmlFile(java.lang.StringBuffer strBuf)
          Creates the contents of the AboutUs File.
 void createAdminHtmlFile(java.lang.StringBuffer strBuf)
          Creates the contents of the Admin Page
 void createAttrbHtmlFile(java.lang.StringBuffer strBuf, java.util.Hashtable valTable, java.util.Vector varVect, java.util.Vector accessVect, java.util.Vector typeVect, java.lang.String objName, java.lang.String mbeanName, java.lang.String searchAttrbName, boolean addRow, boolean ischkBox, java.lang.String viewName)
          Creates the HTML file for attributes of array type.
 void createDeleteViewHtmlFile(java.lang.StringBuffer strBuf, java.util.Hashtable table)
           
 void createDomainIndexFile(java.lang.StringBuffer strBuf, java.lang.String name, java.util.Hashtable info)
          Displays the list of MBeans of a particular domain.
 void createHashtableHtmlFile(java.lang.StringBuffer strBuf, java.lang.String mbeanName, java.lang.String objName, java.lang.String searchAttrbName, java.lang.String viewName, java.lang.Object obj)
           
 void createIndexFile(java.lang.StringBuffer strBuf, java.lang.String name, java.util.Hashtable info, boolean isauthentication, boolean isAdminUser, java.util.Hashtable viewTable)
          Creates the contents of the index file in html format.
 void createListMBeansHtmlFile(java.lang.StringBuffer strBuf, java.util.Vector vect, java.lang.String viewName)
           
 void createLoginHtmlFile(java.lang.StringBuffer strBuf, boolean flag)
          Creates the contents of the Login File.
 java.lang.String createNewRowFile(java.lang.StringBuffer strBuf, java.util.Vector varVect, java.util.Vector access, java.util.Vector type, java.util.Vector indexVect, java.lang.String mbeanName, java.lang.String objName, java.lang.String viewName)
          Creates the contents of the htmlfile when the addRow operation is performed.
 void createNewViewHtmlFile(java.lang.StringBuffer strBuf, java.util.Hashtable table)
           
 void createNotifHtmlFile(java.lang.StringBuffer strBuf, java.util.Vector varVect, java.util.ArrayList list, int stIndex, int endIndex)
          Creates the contents of the Notifications Page
 void createOperationResultHtmlFile(java.lang.StringBuffer strBuf, java.lang.String objName, java.lang.String viewName, java.lang.String operationName, boolean operResultFlag)
          Creates the contents of the Operations page.
 void createOperationsHtmlFile(java.lang.StringBuffer strBuf, java.lang.String objName, java.lang.String mbeanName, java.util.Hashtable table, java.lang.String viewName)
          Creates the contents of the Operations page.
 void createOperationsPageForValues(java.lang.StringBuffer strBuf, java.lang.String objName, java.lang.String actionName, java.lang.String mbeanName, java.lang.Object obj, java.lang.String[] sig, java.lang.String viewName, UserViewInterface userViewIntf)
          Creates the contents of the TopFrame.
 void createOptionsHtmlFile(java.lang.StringBuffer strBuf)
           
 void createPagePropertiesHtmlFile(java.lang.StringBuffer strBuf, java.util.Vector header)
           
 void createRegisterHtmlFile(java.lang.StringBuffer strBuf)
          Creates the contents of the RegisterMBean File.
 void createRegUnRegResultHtmlFile(java.lang.StringBuffer strBuf, int reg, boolean regResultFlag)
           
 void createScalarHtmlFile(java.lang.StringBuffer strBuf, java.lang.String objName, java.lang.String mbeanName, java.util.Vector header, java.util.Hashtable table, java.util.Hashtable domTable, java.lang.String viewName)
          Displays the list of Attributes of a particular MBean.
 void createSearchHtmlFile(java.lang.StringBuffer strBuf, java.util.Vector resultVec)
          Creates the contents of the Search Page
 void createSessionExpireHtmlFile(java.lang.StringBuffer strBuf)
           
 void createTableHtmlFile(java.lang.StringBuffer strBuf, java.util.Hashtable valTable, java.util.Hashtable table, java.util.Hashtable domTable, java.util.Vector vect, java.lang.String objName, java.lang.String mbeanName, int stIndex, int endIndex, int flag, java.lang.String viewName)
          Creates the contents of the html file that appears in Table format.
 void createUnRegisterHtmlFile(java.lang.StringBuffer strBuf)
          Creates the contents of the UnRegisterMBean File.
 void createUserDefinedTypeHtmlFile(java.lang.StringBuffer strBuf, java.lang.String mbeanName, java.lang.String objName, java.lang.String searchAttrbName, java.lang.String viewName, java.lang.Object obj, java.lang.String type, UserViewInterface userViewIntf)
           
 void createUserInfoHtmlFile(java.lang.StringBuffer strBuf)
          Creates the contents of the UserInformations file.
 void createVectorHtmlFile(java.lang.StringBuffer strBuf, java.lang.String mbeanName, java.lang.String objName, java.lang.String searchAttrbName, java.lang.String viewName, java.lang.Object obj)
           
 void createViewForViewName(java.lang.StringBuffer strBuf, java.lang.String viewName, java.util.Vector vect)
           
 void createViewOptionsHtmlFile(java.lang.StringBuffer strBuf)
           
 void setHtmlPageProp(HtmlPageProp htmlPageProp)
           
 

Method Detail

createIndexFile

void createIndexFile(java.lang.StringBuffer strBuf,
                     java.lang.String name,
                     java.util.Hashtable info,
                     boolean isauthentication,
                     boolean isAdminUser,
                     java.util.Hashtable viewTable)
Creates the contents of the index file in html format. Depending on the file name passed, the corresponding methods namely createFramesPage, createTopFramesPage and createMainPage will be called.

Parameters:
strBuf - to store the generated tags information.
file - the filename
table - It contains all the list of domains that are registered with the MBeanServer
isauthentication - boolean true if authentication enable false otherwise.
isAdminUser - boolean true if Admin User false otherwise

createDomainIndexFile

void createDomainIndexFile(java.lang.StringBuffer strBuf,
                           java.lang.String name,
                           java.util.Hashtable info)
Displays the list of MBeans of a particular domain.

Parameters:
strBuf - to store the html tags that are generated
domainName - domain name for which the index needs to be generated.
table - hashtable which stores the details of registered MBeans under the respective domains.

createScalarHtmlFile

void createScalarHtmlFile(java.lang.StringBuffer strBuf,
                          java.lang.String objName,
                          java.lang.String mbeanName,
                          java.util.Vector header,
                          java.util.Hashtable table,
                          java.util.Hashtable domTable,
                          java.lang.String viewName)
Displays the list of Attributes of a particular MBean.

Parameters:
strBuf - to store the html tags that are generated
objName - a string representing the ObjectName of a particular MBean
mbeanName - is a string which is the name of the Mbean.
header - Vector which has the header variables to be displayed in the page like Attribute Value.
table - Hashtabel which contains the vectors name, type, access, description and value
domTable - which contains the list of domains.

createTableHtmlFile

void createTableHtmlFile(java.lang.StringBuffer strBuf,
                         java.util.Hashtable valTable,
                         java.util.Hashtable table,
                         java.util.Hashtable domTable,
                         java.util.Vector vect,
                         java.lang.String objName,
                         java.lang.String mbeanName,
                         int stIndex,
                         int endIndex,
                         int flag,
                         java.lang.String viewName)
Creates the contents of the html file that appears in Table format.

Parameters:
strBuf - to store the html tags that are generated
valTable - hashtable which has the values of the rows according to key value index.
table - hashtable which gets the vector for variable, type, access and indexes names.
domTable - hashtable which contains the other domian names.
vect - vector which contains the indexes list.
objName - the object name of the table.
mbeanName - the name of the MBean for which the table belongs.
stIndex - the first index of the row displayed
endIndex - the last index of the row displayed
flag - which indicates whether prev, next images to be present or not.

createNewRowFile

java.lang.String createNewRowFile(java.lang.StringBuffer strBuf,
                                  java.util.Vector varVect,
                                  java.util.Vector access,
                                  java.util.Vector type,
                                  java.util.Vector indexVect,
                                  java.lang.String mbeanName,
                                  java.lang.String objName,
                                  java.lang.String viewName)
Creates the contents of the htmlfile when the addRow operation is performed.

Parameters:
strBuf - to store the generated tags information.
varVect - vector which contains the the variable names.
access - the access type for each variable.
type - the data type for each of the variable.
indexVect - the vector which contains the names of the index.
mbeanName - The Name of the MBean for which the new row file is displayed.
objName - the object name of the MBean which it is displayed.

createAttrbHtmlFile

void createAttrbHtmlFile(java.lang.StringBuffer strBuf,
                         java.util.Hashtable valTable,
                         java.util.Vector varVect,
                         java.util.Vector accessVect,
                         java.util.Vector typeVect,
                         java.lang.String objName,
                         java.lang.String mbeanName,
                         java.lang.String searchAttrbName,
                         boolean addRow,
                         boolean ischkBox,
                         java.lang.String viewName)
Creates the HTML file for attributes of array type.

Parameters:
strBuf - to store the html tags that are generated
valTable - hashtable which has the row values for each indexes.
varVect - the vector which contains the variables list.
accessVect - the vector which contains the access type.
typeVect - the vector which contains the type of the variable.
objName - the object name of the Mbean for which the table is displayed
mbeanName - the name of the MBean.
searchAttrbName - the attribute for which the values are displayed.
addRow - the flag which specifies the addRow button has to be added or not.
ischkBox - the flag which specifies whether the check box has the displayed for each row.

createOperationsHtmlFile

void createOperationsHtmlFile(java.lang.StringBuffer strBuf,
                              java.lang.String objName,
                              java.lang.String mbeanName,
                              java.util.Hashtable table,
                              java.lang.String viewName)
Creates the contents of the Operations page.

Parameters:
strBuf - to store the html tags that are generated
objName - the object name of the domain for which the operations are being created.
mbeanName - the name of the MBean for which the operations are being created
table - which contains the OperationName, ReturnType, ParamVector and ParamType vectors respectively

createOperationsPageForValues

void createOperationsPageForValues(java.lang.StringBuffer strBuf,
                                   java.lang.String objName,
                                   java.lang.String actionName,
                                   java.lang.String mbeanName,
                                   java.lang.Object obj,
                                   java.lang.String[] sig,
                                   java.lang.String viewName,
                                   UserViewInterface userViewIntf)
Creates the contents of the TopFrame.

Parameters:
strBuf - to store the html tags that are generated
objName - for which the operation page is created.
actionName - which specifies the operation name (get/set)
mbeanName - the name of the MBean for which the page is generated.
obj - the return type of the operqation.
sig - an array of string.
viewName - the name of the View for a particular user

createNotifHtmlFile

void createNotifHtmlFile(java.lang.StringBuffer strBuf,
                         java.util.Vector varVect,
                         java.util.ArrayList list,
                         int stIndex,
                         int endIndex)
Creates the contents of the Notifications Page

Parameters:
strBuf - to store the generated tags information.
varVect - the vector which displays the header for the table to be displayed.
list - the array list containing the notification values.
stIndex - specifies the Start Index
endIndex - specifies the End Index

createSearchHtmlFile

void createSearchHtmlFile(java.lang.StringBuffer strBuf,
                          java.util.Vector resultVec)
Creates the contents of the Search Page

Parameters:
strBuf - to store the generated tags information.
resultVec - a vector which stores the results of the search operation

createAdminHtmlFile

void createAdminHtmlFile(java.lang.StringBuffer strBuf)
Creates the contents of the Admin Page

Parameters:
strBuf - to store the generated tags information.

createAboutUsHtmlFile

void createAboutUsHtmlFile(java.lang.StringBuffer strBuf)
Creates the contents of the AboutUs File.

Parameters:
strBuf - to store the generated tags information.

createLoginHtmlFile

void createLoginHtmlFile(java.lang.StringBuffer strBuf,
                         boolean flag)
Creates the contents of the Login File.

Parameters:
strBuf - to store the generated tags information.
flag - which specifes whether the page should lead to main page or index page.

createUserInfoHtmlFile

void createUserInfoHtmlFile(java.lang.StringBuffer strBuf)
Creates the contents of the UserInformations file.

Parameters:
strBuf - to store the generated tags information.

createRegisterHtmlFile

void createRegisterHtmlFile(java.lang.StringBuffer strBuf)
Creates the contents of the RegisterMBean File.

Parameters:
strBuf - to store the generated tags information.

createUnRegisterHtmlFile

void createUnRegisterHtmlFile(java.lang.StringBuffer strBuf)
Creates the contents of the UnRegisterMBean File.

Parameters:
strBuf - to store the generated tags information.

createViewOptionsHtmlFile

void createViewOptionsHtmlFile(java.lang.StringBuffer strBuf)

createNewViewHtmlFile

void createNewViewHtmlFile(java.lang.StringBuffer strBuf,
                           java.util.Hashtable table)

createListMBeansHtmlFile

void createListMBeansHtmlFile(java.lang.StringBuffer strBuf,
                              java.util.Vector vect,
                              java.lang.String viewName)

createViewForViewName

void createViewForViewName(java.lang.StringBuffer strBuf,
                           java.lang.String viewName,
                           java.util.Vector vect)

createDeleteViewHtmlFile

void createDeleteViewHtmlFile(java.lang.StringBuffer strBuf,
                              java.util.Hashtable table)

setHtmlPageProp

void setHtmlPageProp(HtmlPageProp htmlPageProp)

createPagePropertiesHtmlFile

void createPagePropertiesHtmlFile(java.lang.StringBuffer strBuf,
                                  java.util.Vector header)

createOptionsHtmlFile

void createOptionsHtmlFile(java.lang.StringBuffer strBuf)

createOperationResultHtmlFile

void createOperationResultHtmlFile(java.lang.StringBuffer strBuf,
                                   java.lang.String objName,
                                   java.lang.String viewName,
                                   java.lang.String operationName,
                                   boolean operResultFlag)
Creates the contents of the Operations page.

Parameters:
strBuf - to store the html tags that are generated
objName - the object name of the domain for which the operations are being created.
viewName - the name of the View for a particular user
operResultFlag - flag which describes whether the operation is successful or not.

createRegUnRegResultHtmlFile

void createRegUnRegResultHtmlFile(java.lang.StringBuffer strBuf,
                                  int reg,
                                  boolean regResultFlag)

createSessionExpireHtmlFile

void createSessionExpireHtmlFile(java.lang.StringBuffer strBuf)

createHashtableHtmlFile

void createHashtableHtmlFile(java.lang.StringBuffer strBuf,
                             java.lang.String mbeanName,
                             java.lang.String objName,
                             java.lang.String searchAttrbName,
                             java.lang.String viewName,
                             java.lang.Object obj)

createVectorHtmlFile

void createVectorHtmlFile(java.lang.StringBuffer strBuf,
                          java.lang.String mbeanName,
                          java.lang.String objName,
                          java.lang.String searchAttrbName,
                          java.lang.String viewName,
                          java.lang.Object obj)

createUserDefinedTypeHtmlFile

void createUserDefinedTypeHtmlFile(java.lang.StringBuffer strBuf,
                                   java.lang.String mbeanName,
                                   java.lang.String objName,
                                   java.lang.String searchAttrbName,
                                   java.lang.String viewName,
                                   java.lang.Object obj,
                                   java.lang.String type,
                                   UserViewInterface userViewIntf)