jrun.servlet.metadata
Class ServletMetaData

java.lang.Object
  |
  +--jrunx.xml.XMLMetaData
        |
        +--jrun.j2ee.metadata.DescriptionMetaData
              |
              +--jrun.servlet.metadata.ServletMetaData

public class ServletMetaData
extends DescriptionMetaData

The servlet element contains the declarative data of a servlet. If a jsp-file is specified and the load-on-startup element is present, then the JSP should be precompiled and loaded.

The servlet element is used in the web-app element

Author:
Paul Reilly
See Also:
WebAppMetaData

Inner classes inherited from class jrunx.xml.XMLMetaData
XMLMetaData.BaseException, XMLMetaData.CouldNotCreateDocumentException, XMLMetaData.CreateInstanceException, XMLMetaData.ElementRequiredException, XMLMetaData.IntegerExpectedException, XMLMetaData.InvalidElementException, XMLMetaData.InvalidObjectException, XMLMetaData.MetaDataExportIOException, XMLMetaData.NoLocationException, XMLMetaData.NoStringConstructorException, XMLMetaData.UnsupportedArrayTypeException
 
Fields inherited from class jrunx.xml.XMLMetaData
logger
 
Constructor Summary
ServletMetaData()
           
 
Method Summary
 void addInitParam(InitParamMetaData initParam)
           
 void addSecurityRoleRef(SecurityRoleRefMetaData securityRoleRefMetaData)
           
 void clearInitParams()
           
 void clearSecurityRoleRefs()
           
 void createEmpty()
          create empty lists, used for programmatic initialization
 java.lang.String getDisplayName()
           
 IconMetaData getIcon()
           
 InitParamMetaData getInitParam(java.lang.String name)
           
 java.util.Iterator getInitParams()
           
 java.lang.String getJSPFile()
           
 int getLoadOnStartup()
           
 RunAsMetaData getRunAs()
           
 java.util.Iterator getSecurityRoleRefs()
           
 java.lang.String getServletClass()
           
 java.lang.String getServletName()
           
 boolean hasLoadOnStartup()
           
 SecurityRoleRefMetaData removeSecurityRoleRef(int index)
           
 void setDisplayName(java.lang.String displayName)
           
 void setIcon(IconMetaData iconMetaData)
           
 void setJSPFile(java.lang.String jspFile)
           
 void setLoadOnStartup(int loadOnStartup)
           
 void setRunAs(RunAsMetaData runAsMetaData)
           
 void setServletClass(java.lang.String servletClass)
           
 void setServletName(java.lang.String servletName)
           
 java.lang.String toString()
          Return a String representation of the document
 
Methods inherited from class jrun.j2ee.metadata.DescriptionMetaData
getDescription, setDescription
 
Methods inherited from class jrunx.xml.XMLMetaData
addAcronym, addAcronyms, addPackagePrefix, addPackagePrefixes, exportDocument, getAttribute, getMetaDataSource, getParent, getPersistenceContext, getText, importXML, importXML, remove, removeAttribute, setAttribute, setMetaDataSource, setMetaDataSource, setParent, setParent, setPersistenceContext, setPublicID, setSystemID, setText, sync, sync
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ServletMetaData

public ServletMetaData()
Method Detail

getIcon

public IconMetaData getIcon()

setIcon

public void setIcon(IconMetaData iconMetaData)

getServletName

public java.lang.String getServletName()

setServletName

public void setServletName(java.lang.String servletName)

getDisplayName

public java.lang.String getDisplayName()

setDisplayName

public void setDisplayName(java.lang.String displayName)

getServletClass

public java.lang.String getServletClass()

setServletClass

public void setServletClass(java.lang.String servletClass)

getJSPFile

public java.lang.String getJSPFile()

setJSPFile

public void setJSPFile(java.lang.String jspFile)

getInitParams

public java.util.Iterator getInitParams()

addInitParam

public void addInitParam(InitParamMetaData initParam)

getInitParam

public InitParamMetaData getInitParam(java.lang.String name)

clearInitParams

public void clearInitParams()

hasLoadOnStartup

public boolean hasLoadOnStartup()

getLoadOnStartup

public int getLoadOnStartup()

setLoadOnStartup

public void setLoadOnStartup(int loadOnStartup)

getRunAs

public RunAsMetaData getRunAs()

setRunAs

public void setRunAs(RunAsMetaData runAsMetaData)

getSecurityRoleRefs

public java.util.Iterator getSecurityRoleRefs()

addSecurityRoleRef

public void addSecurityRoleRef(SecurityRoleRefMetaData securityRoleRefMetaData)

removeSecurityRoleRef

public SecurityRoleRefMetaData removeSecurityRoleRef(int index)

clearSecurityRoleRefs

public void clearSecurityRoleRefs()

createEmpty

public void createEmpty()
create empty lists, used for programmatic initialization

toString

public java.lang.String toString()
Description copied from class: XMLMetaData
Return a String representation of the document
Overrides:
toString in class XMLMetaData


Copyright � 2002 Macromedia Corporation. All Rights Reserved.