XMOJO 5 API Docs

com.adventnet.adaptors.html
Class HtmlPageProp

java.lang.Object
  |
  +--com.adventnet.adaptors.html.HtmlPageProp
All Implemented Interfaces:
DynamicMBean

public class HtmlPageProp
extends java.lang.Object
implements DynamicMBean

This class helps to generate run time or dynamic html pages for the instrumented MBeans. This class having certain methods like createDynamicIndexFile(), createHtmlPage(), etc, the user should invoke these methods from the servlet.

Even most of the html pages created in the run time, HtmlPageProp class allows certain levels of customization like author, header, title, description, footer message, logo, background colour, etc. All these attributes have default values, if you don't want those settings the user can set his own values.

Author:
Vijay.
See Also:

Field Summary
 java.lang.String alinkColor
           
 java.lang.String author
           
 java.lang.String backGroundColor
           
 java.lang.String backGroundImage
           
 int backTagLocation
           
 int BOTTOM_CENTER
          The home page link will be at bottom center.
 int BOTTOM_LEFT
          The home page link will be at bottom left corner.
static int BOTTOM_RIGHT
          The home page link will be at bottom right corner.
 boolean copyRightNeeded
           
 int endIndex
           
 java.lang.String filter
           
 java.lang.String fontColor
           
 java.lang.String fontFace
           
 java.lang.String fontSize
           
 java.lang.String footerMsg
           
 int headerSize
           
 int homePageLocation
           
 java.lang.String indexFileName
           
 boolean isJavaScript
           
 boolean isNextButtonNeeded
           
 boolean isOperations
           
 boolean isOperationsLinkNeeded
           
 boolean isPrevButtonNeeded
           
 boolean isRefreshButtonNeeded
           
 boolean isTextDecoration
           
 boolean limitRestrictFlag
           
 java.lang.String linkColor
           
 java.lang.String listStringName
           
 java.lang.String mailTo
           
 int maxDispChar
           
 int numRows
           
 boolean operation
           
 int refreshTime
          Refresh time to update the displayed html page
 java.lang.String servletName
           
 int stIndex
           
 java.lang.String tabIndexColor
           
 java.util.Hashtable table
           
 java.lang.String tableHeaderColor
           
 java.lang.String tableRowColor
           
 int TOP_CENTER
          The home page link will be at top center.
 int TOP_LEFT
          The home page link will be at top left corner.
 int TOP_RIGHT
          The home page link will be at top right corner.
 java.lang.String vlinkColor
           
 
Constructor Summary
HtmlPageProp()
           
 
Method Summary
 java.lang.String getAlinkColor()
           
 java.lang.Object getAttribute(java.lang.String attribute)
          Gets the value of a specific attribute of this MBean.
 AttributeList getAttributes(java.lang.String[] attributes)
          Enables the values of several attributes of this MBean.
 java.lang.String getAuthor()
           
 java.lang.String getBackGroundColor()
           
 java.lang.String getBackGroundImage()
           
 java.util.Hashtable getConfTable(java.lang.String userName)
           
 boolean getCopyRightNeeded()
           
 java.lang.String getFontColor()
           
 java.lang.String getFontFace()
           
 java.lang.String getFontSize()
           
 java.lang.String getFooterMessage()
           
 java.util.Hashtable getHeaderTable()
           
 java.lang.String getIndexFileName()
           
 boolean getJavaScript()
           
 boolean getLimitRestrictFlag()
           
 java.lang.String getLinkColor()
           
 java.lang.String getMailTo()
           
 int getMaxDispChar()
           
 MBeanInfo getMBeanInfo()
          This method discovers the attributes and operations this MBean exposes for management.
 int getNumRows()
           
 boolean getOperationsLinkNeeded()
           
 int getRefreshTime()
           
 java.lang.String getServletName()
           
 java.lang.String getTabIndexColor()
           
 java.lang.String getTableHeaderColor()
           
 java.lang.String getTableRowColor()
           
 boolean getTextDecoration()
           
 java.lang.String getVlinkColor()
           
 java.lang.Object invoke(java.lang.String actionName, java.lang.Object[] params, java.lang.String[] signature)
          Invokes an action on this MBean.
 void readFromFile(java.lang.String userName)
           
 void setAlinkColor(java.lang.String alinkColor)
           
 void setAttribute(Attribute attribute)
          Sets the value of a specific attribute of this MBean.
 AttributeList setAttributes(AttributeList attributes)
          Sets the values of several attributes of this MBean.
 void setAuthor(java.lang.String auth)
           
 void setBackGroundColor(java.lang.String bgColor)
           
 void setBackGroundImage(java.lang.String bgImage)
           
 void setCopyRightNeeded(boolean flag)
           
 void setFontColor(java.lang.String fontColor)
           
 void setFontFace(java.lang.String fontFace)
           
 void setFontSize(java.lang.String fontSize)
           
 void setFooterMessage(java.lang.String footer)
           
 void setIndexFileName(java.lang.String fName)
           
 void setJavaScript(boolean flag)
           
 void setLimitRestrictFlag(boolean flag)
           
 void setLinkColor(java.lang.String linkColor)
           
 void setMailTo(java.lang.String mailTo)
           
 void setMaxDispChar(java.lang.Integer maxDispChar)
           
 void setNumRows(java.lang.Integer numrows)
           
 void setOperationsLinkNeeded(boolean flag)
           
 void setRefreshTime(java.lang.Integer refresh)
           
 void setServletName(java.lang.String servlet)
           
 void setTabIndexColor(java.lang.String tabIndexColor)
           
 void setTableHeaderColor(java.lang.String scaTHColor)
           
 void setTableRowColor(java.lang.String scaTRColor)
           
 void setTextDecoration(boolean flag)
           
 void setVlinkColor(java.lang.String vlinkColor)
           
 void writeIntoFile(java.lang.String userName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

operation

public boolean operation

table

public java.util.Hashtable table

copyRightNeeded

public boolean copyRightNeeded

filter

public java.lang.String filter

author

public java.lang.String author

indexFileName

public java.lang.String indexFileName

backGroundColor

public java.lang.String backGroundColor

backGroundImage

public java.lang.String backGroundImage

footerMsg

public java.lang.String footerMsg

servletName

public java.lang.String servletName

listStringName

public java.lang.String listStringName

vlinkColor

public java.lang.String vlinkColor

alinkColor

public java.lang.String alinkColor

linkColor

public java.lang.String linkColor

tableHeaderColor

public java.lang.String tableHeaderColor

tableRowColor

public java.lang.String tableRowColor

tabIndexColor

public java.lang.String tabIndexColor

fontColor

public java.lang.String fontColor

fontFace

public java.lang.String fontFace

mailTo

public java.lang.String mailTo

fontSize

public java.lang.String fontSize

maxDispChar

public int maxDispChar

refreshTime

public int refreshTime
Refresh time to update the displayed html page

backTagLocation

public int backTagLocation

homePageLocation

public int homePageLocation

headerSize

public int headerSize

TOP_LEFT

public int TOP_LEFT
The home page link will be at top left corner.

TOP_RIGHT

public int TOP_RIGHT
The home page link will be at top right corner.

TOP_CENTER

public int TOP_CENTER
The home page link will be at top center.

BOTTOM_LEFT

public int BOTTOM_LEFT
The home page link will be at bottom left corner.

BOTTOM_RIGHT

public static int BOTTOM_RIGHT
The home page link will be at bottom right corner.

BOTTOM_CENTER

public int BOTTOM_CENTER
The home page link will be at bottom center.

isRefreshButtonNeeded

public boolean isRefreshButtonNeeded

isNextButtonNeeded

public boolean isNextButtonNeeded

isPrevButtonNeeded

public boolean isPrevButtonNeeded

isJavaScript

public boolean isJavaScript

limitRestrictFlag

public boolean limitRestrictFlag

isOperationsLinkNeeded

public boolean isOperationsLinkNeeded

isOperations

public boolean isOperations

isTextDecoration

public boolean isTextDecoration

stIndex

public int stIndex

endIndex

public int endIndex

numRows

public int numRows
Constructor Detail

HtmlPageProp

public HtmlPageProp()
Method Detail

getHeaderTable

public java.util.Hashtable getHeaderTable()

getCopyRightNeeded

public boolean getCopyRightNeeded()

setCopyRightNeeded

public void setCopyRightNeeded(boolean flag)

getTextDecoration

public boolean getTextDecoration()

setTextDecoration

public void setTextDecoration(boolean flag)

getJavaScript

public boolean getJavaScript()

setJavaScript

public void setJavaScript(boolean flag)

getLimitRestrictFlag

public boolean getLimitRestrictFlag()

setLimitRestrictFlag

public void setLimitRestrictFlag(boolean flag)

getOperationsLinkNeeded

public boolean getOperationsLinkNeeded()

setOperationsLinkNeeded

public void setOperationsLinkNeeded(boolean flag)

getMaxDispChar

public int getMaxDispChar()

setMaxDispChar

public void setMaxDispChar(java.lang.Integer maxDispChar)

getNumRows

public int getNumRows()

setNumRows

public void setNumRows(java.lang.Integer numrows)
                throws java.lang.Exception

getRefreshTime

public int getRefreshTime()

setRefreshTime

public void setRefreshTime(java.lang.Integer refresh)

getBackGroundColor

public java.lang.String getBackGroundColor()

setBackGroundColor

public void setBackGroundColor(java.lang.String bgColor)

getVlinkColor

public java.lang.String getVlinkColor()

setVlinkColor

public void setVlinkColor(java.lang.String vlinkColor)

getLinkColor

public java.lang.String getLinkColor()

setLinkColor

public void setLinkColor(java.lang.String linkColor)

getAlinkColor

public java.lang.String getAlinkColor()

setAlinkColor

public void setAlinkColor(java.lang.String alinkColor)

getTableHeaderColor

public java.lang.String getTableHeaderColor()

setTableHeaderColor

public void setTableHeaderColor(java.lang.String scaTHColor)

getTableRowColor

public java.lang.String getTableRowColor()

setTableRowColor

public void setTableRowColor(java.lang.String scaTRColor)

getTabIndexColor

public java.lang.String getTabIndexColor()

setTabIndexColor

public void setTabIndexColor(java.lang.String tabIndexColor)

getFontColor

public java.lang.String getFontColor()

setFontColor

public void setFontColor(java.lang.String fontColor)

getFontFace

public java.lang.String getFontFace()

setFontFace

public void setFontFace(java.lang.String fontFace)

getMailTo

public java.lang.String getMailTo()

setMailTo

public void setMailTo(java.lang.String mailTo)

getFontSize

public java.lang.String getFontSize()

setFontSize

public void setFontSize(java.lang.String fontSize)

getBackGroundImage

public java.lang.String getBackGroundImage()

setBackGroundImage

public void setBackGroundImage(java.lang.String bgImage)

getServletName

public java.lang.String getServletName()

setServletName

public void setServletName(java.lang.String servlet)

getIndexFileName

public java.lang.String getIndexFileName()

setIndexFileName

public void setIndexFileName(java.lang.String fName)

getFooterMessage

public java.lang.String getFooterMessage()

setFooterMessage

public void setFooterMessage(java.lang.String footer)

getAuthor

public java.lang.String getAuthor()

setAuthor

public void setAuthor(java.lang.String auth)

readFromFile

public void readFromFile(java.lang.String userName)

getConfTable

public java.util.Hashtable getConfTable(java.lang.String userName)

writeIntoFile

public void writeIntoFile(java.lang.String userName)

getMBeanInfo

public MBeanInfo getMBeanInfo()
This method discovers the attributes and operations this MBean exposes for management.
Specified by:
getMBeanInfo in interface DynamicMBean
Returns:
An instance of MBeanInfo allowing to retrieve all attributes and operations of this MBean.

getAttribute

public java.lang.Object getAttribute(java.lang.String attribute)
                              throws AttributeNotFoundException,
                                     MBeanException,
                                     ReflectionException
Gets the value of a specific attribute of this MBean.
Specified by:
getAttribute in interface DynamicMBean
Parameters:
attribute - A String specifying the name of the attribute to be retrieved.
Returns:
The value of the retrieved attribute.
Throws:
AttributeNotFoundException - The specified attribute is not accessible in the MBean.
MBeanException - The constructor of the MBean has thrown an exception
ReflectionException - Wraps a ClassNotFoundException or a java.lang.Exception that occured trying to invoke the MBean's constructor.

getAttributes

public AttributeList getAttributes(java.lang.String[] attributes)
Enables the values of several attributes of this MBean.
Specified by:
getAttributes in interface DynamicMBean
Parameters:
attributes - A list of attributes to be retrieved.
Returns:
The value of the retrieved attributes as attributeList.

invoke

public java.lang.Object invoke(java.lang.String actionName,
                               java.lang.Object[] params,
                               java.lang.String[] signature)
                        throws MBeanException,
                               ReflectionException
Invokes an action on this MBean.
Specified by:
invoke in interface DynamicMBean
Parameters:
actionName - The name of the action to be invoked.
params - An array containing the parameters to be set when the action is invoked
signature - An array containing the signature of the action. The class objects will be loaded using the same class loader as the one used for loading the MBean on which the action was invoked.
Returns:
The object returned by the action, which represents the result ofinvoking the action on the specified MBean.
Throws:
MBeanException - The constructor of the MBean has thrown an exception
ReflectionException - Wraps a ClassNotFoundException or a java.lang.Exception that occured trying to invoke the MBean's constructor.

setAttribute

public void setAttribute(Attribute attribute)
                  throws AttributeNotFoundException,
                         InvalidAttributeValueException,
                         MBeanException,
                         ReflectionException
Sets the value of a specific attribute of this MBean.
Specified by:
setAttribute in interface DynamicMBean
Parameters:
attribute - The identification of the attribute to be set and the value it is to be set to.
Throws:
AttributeNotFoundException - The specified attribute is not accessible in the MBean.
InvalidAttributeValueException - The specified value for the attribute is not valid.
MBeanException - The constructor of the MBean has thrown an exception
ReflectionException - Wraps a ClassNotFoundException or a java.lang.Exception that occured trying to invoke the MBean's constructor.

setAttributes

public AttributeList setAttributes(AttributeList attributes)
Sets the values of several attributes of this MBean.
Specified by:
setAttributes in interface DynamicMBean
Parameters:
attributes - A list of attributes: The identification of the attributes to be set and the values they are to be set to.
Returns:
The list of attributes that were set, with their new values.

XMOJO 5 API Docs

Copyright ©2003 XMOJO.org. All Rights Reserved.