|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.droplet.EmptyFormHandler atg.droplet.GenericFormHandler atg.droplet.TransactionalFormHandler atg.portal.admin.PortalGenericFormHandler atg.portal.admin.GearDefinitionFormHandler
public class GearDefinitionFormHandler
This class provides convenient form handling methods for registering new gear definitions in the portal framework. This handler prompts the admin for a manifest file and uploads that file. On upload, this formhandler calls the parser to parse the file into a set of configuration objects with gear definition data. For each configuration, the handler uses the manager class to create, update or delete gear definitions.
All handle methods in this form handler mirror a similiar pattern.
Each handleXXX process, some have an associated preXXX and postXXX method.
For example, the handleCreate
has an associate
preCreate
and postCreate
.
These pre/post methods provide an easy way for a user to extend the
functionality of this form handler.
GenericFormHandler
,
PortalGenericFormHandler
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected static java.util.ResourceBundle |
sResourceBundle
Resource Bundle |
Fields inherited from class atg.droplet.GenericFormHandler |
---|
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
GearDefinitionFormHandler()
Constructs an instanceof GearDefinitionFormHandler |
Method Summary | |
---|---|
java.lang.String |
getId()
Returns property id |
UploadedFile |
getManifestFile()
Returns property manifestFile. |
atg.portal.xml.tools.ManifestFileParser |
getManifestFileParser()
Returns property ManifestFileParser |
java.lang.String |
getName()
Returns property Name |
java.lang.String |
getParentFolder()
Returns property ParentFolder |
java.lang.String[] |
getParentFolders()
Returns property ParentFolder |
atg.portal.admin.PortalRepositoryTools |
getPortalRepositoryTools()
|
atg.xml.tools.XMLToolsFactory |
getXmlToolsFactory()
Returns property XmlToolsFactory |
boolean |
handleCreate(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called when the admin selects create to create a new gear definition. |
boolean |
handleDelete(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called when the administrator selects yes in delete confirmation page to delete an item from the repository. |
void |
postCreate(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just component creation is finished |
void |
postDelete(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just after component deleting is finished |
void |
preCreate(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just before component creation is started |
void |
preDelete(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just before component deleting is initialized |
void |
setId(java.lang.String pId)
Sets property id |
void |
setManifestFile(UploadedFile pManifestFile)
Sets property manifestFile |
void |
setManifestFileParser(atg.portal.xml.tools.ManifestFileParser pManifestFileParser)
Sets property ManifestFileParser |
void |
setName(java.lang.String pName)
Sets property Name |
void |
setParentFolder(java.lang.String pParentFolder)
Sets property ParentFolder |
void |
setParentFolders(java.lang.String[] pParentFolders)
Sets property ParentFolders |
void |
setPortalRepositoryTools(atg.portal.admin.PortalRepositoryTools p_tools)
Sets property portalRepositoryTools |
void |
setXmlToolsFactory(atg.xml.tools.XMLToolsFactory pXmlToolsFactory)
Sets property XmlToolsFactory |
Methods inherited from class atg.droplet.EmptyFormHandler |
---|
afterGet, beforeGet |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
protected static java.util.ResourceBundle sResourceBundle
Constructor Detail |
---|
public GearDefinitionFormHandler()
Method Detail |
---|
public void setManifestFileParser(atg.portal.xml.tools.ManifestFileParser pManifestFileParser)
pManifestFileParser
- The property to store the value of the manifest file parser.public atg.portal.xml.tools.ManifestFileParser getManifestFileParser()
public void setXmlToolsFactory(atg.xml.tools.XMLToolsFactory pXmlToolsFactory)
pXmlToolsFactory
- The property to store the value of the XML Tools Factory.public atg.xml.tools.XMLToolsFactory getXmlToolsFactory()
public void setPortalRepositoryTools(atg.portal.admin.PortalRepositoryTools p_tools)
public atg.portal.admin.PortalRepositoryTools getPortalRepositoryTools()
public void setManifestFile(UploadedFile pManifestFile)
pManifestFile
- The property to store the manifest file.public UploadedFile getManifestFile()
public void setParentFolder(java.lang.String pParentFolder)
pParentFolder
- The property to store the id of the parent folder.public java.lang.String getParentFolder()
public void setParentFolders(java.lang.String[] pParentFolders)
pParentFolders
- The property to store the id of the parent folders.public java.lang.String[] getParentFolders()
public java.lang.String getId()
public void setId(java.lang.String pId)
pId
- The property to store the id of the current gear definitionpublic void setName(java.lang.String pName)
pName
- The property to store a component name. This handler can be used to delete portal items. This property would be used to store the name of a specific component.public java.lang.String getName()
getName
in interface NameContextElement
getName
in class GenericService
public boolean handleCreate(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's response
javax.servlet.ServletException
- if there was an error while executing the code
java.io.IOException
- if there was an error with servlet iopublic void preCreate(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response object
javax.servlet.ServletException
- if something went wrong
java.io.IOException
- if something went wrongpublic void postCreate(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response object
javax.servlet.ServletException
- if something went wrong
java.io.IOException
- if something went wrongpublic boolean handleDelete(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's response
javax.servlet.ServletException
- if there was an error while executing the code
java.io.IOException
- if there was an error with servlet iopublic void preDelete(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response object
javax.servlet.ServletException
- if something went wrong
java.io.IOException
- if something went wrongpublic void postDelete(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response object
javax.servlet.ServletException
- if something went wrong
java.io.IOException
- if something went wrong
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |