atg.portal.admin

Class GearDefinitionFormHandler

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

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, DropletFormHandler, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class GearDefinitionFormHandler
extends PortalGenericFormHandler

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.

See Also:

GenericFormHandler, PortalGenericFormHandler

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
GearDefinitionFormHandler() Constructs an instanceof GearDefinitionFormHandler

Method Summary

Methods

Modifier and Type	Method and Description
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.portal.admin.PortalGenericFormHandler

addFormException, formatUserMessage, formatUserMessage, formatUserMessage, formatUserMessage, getDefaultLocale, getFailureMessageProcessor, getFailureURL, getFormError, getFormInfo, getFormMessages, getLocale, getPublisher, getSuccessMessageProcessor, getSuccessURL, getUserLocale, handleResetFormExceptions, handleResetFormMessages, handleSetLocale, isUseRequestLocale, processException, processException, processException, processException, processSuccess, processSuccess, processSuccess, resetFormMessages, sendAlertMessage, setDefaultLocale, setFailureMessageProcessor, setFailureURL, setPublisher, setSuccessMessageProcessor, setSuccessURL, setUseRequestLocale

Methods inherited from class atg.droplet.TransactionalFormHandler

afterSet, beforeSet, checkFormRedirect, commitTransaction, getTransactionDemarcation, getTransactionStatus, isEnsureTransaction, isRollbackTransaction, isRollbackTransactionOnUnhandledException, isTransactionMarkedAsRollback, setEnsureTransaction, setRollbackTransaction, setRollbackTransactionOnUnhandledException, setTransactionDemarcation

Methods inherited from class atg.droplet.GenericFormHandler

addUncheckedFormException, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet, beforeGet

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, 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

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

sResourceBundle

protected static java.util.ResourceBundle sResourceBundle

Resource Bundle

Constructor Detail

GearDefinitionFormHandler

public GearDefinitionFormHandler()

Constructs an instanceof GearDefinitionFormHandler

Method Detail

setManifestFileParser

public void setManifestFileParser(atg.portal.xml.tools.ManifestFileParser pManifestFileParser)

Sets property ManifestFileParser

Parameters:

pManifestFileParser - The property to store the value of the manifest file parser.

getManifestFileParser

public atg.portal.xml.tools.ManifestFileParser getManifestFileParser()

Returns property ManifestFileParser

Returns:

The value of the property manifestFileParser.

setXmlToolsFactory

public void setXmlToolsFactory(atg.xml.tools.XMLToolsFactory pXmlToolsFactory)

Sets property XmlToolsFactory

Parameters:

pXmlToolsFactory - The property to store the value of the XML Tools Factory.

getXmlToolsFactory

public atg.xml.tools.XMLToolsFactory getXmlToolsFactory()

Returns property XmlToolsFactory

Returns:

The value of the property xmlToolsFactory.

setPortalRepositoryTools

public void setPortalRepositoryTools(atg.portal.admin.PortalRepositoryTools p_tools)

Sets property portalRepositoryTools

getPortalRepositoryTools

public atg.portal.admin.PortalRepositoryTools getPortalRepositoryTools()

setManifestFile

public void setManifestFile(UploadedFile pManifestFile)

Sets property manifestFile

Parameters:

pManifestFile - The property to store the manifest file.

getManifestFile

public UploadedFile getManifestFile()

Returns property manifestFile.

Returns:

The value of the property manifestFile.

setParentFolder

public void setParentFolder(java.lang.String pParentFolder)

Sets property ParentFolder

Parameters:

pParentFolder - The property to store the id of the parent folder.

getParentFolder

public java.lang.String getParentFolder()

Returns property ParentFolder

Returns:

The value of the property ParentFolder.

setParentFolders

public void setParentFolders(java.lang.String[] pParentFolders)

Sets property ParentFolders

Parameters:

pParentFolders - The property to store the id of the parent folders.

getParentFolders

public java.lang.String[] getParentFolders()

Returns property ParentFolder

Returns:

The value of the property ParentFolder.

getId

public java.lang.String getId()

Returns property id

Returns:

The value of the gear definition id

setId

public void setId(java.lang.String pId)

Sets property id

Parameters:

pId - The property to store the id of the current gear definition

setName

public void setName(java.lang.String pName)

Sets property Name

Parameters:

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.

getName

public java.lang.String getName()

Returns property Name

Specified by:

getName in interface NameContextElement

Overrides:

getName in class GenericService

Returns:

The value of the property Name.

handleCreate

public boolean handleCreate(DynamoHttpServletRequest pRequest,
                   DynamoHttpServletResponse pResponse)
                     throws javax.servlet.ServletException,
                            java.io.IOException

Called when the admin selects create to create a new gear definition.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

true if successful, false otherwise.

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

preCreate

public void preCreate(DynamoHttpServletRequest pRequest,
             DynamoHttpServletResponse pResponse)
               throws javax.servlet.ServletException,
                      java.io.IOException

Operation called just before component creation is started

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

postCreate

public void postCreate(DynamoHttpServletRequest pRequest,
              DynamoHttpServletResponse pResponse)
                throws javax.servlet.ServletException,
                       java.io.IOException

Operation called just component creation is finished

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

handleDelete

public boolean handleDelete(DynamoHttpServletRequest pRequest,
                   DynamoHttpServletResponse pResponse)
                     throws javax.servlet.ServletException,
                            java.io.IOException

Called when the administrator selects yes in delete confirmation page to delete an item from the repository. It calls deleteObject in PortalRepositoryTools with the id and type.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

true if successful, false otherwise.

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

preDelete

public void preDelete(DynamoHttpServletRequest pRequest,
             DynamoHttpServletResponse pResponse)
               throws javax.servlet.ServletException,
                      java.io.IOException

Operation called just before component deleting is initialized

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong

postDelete

public void postDelete(DynamoHttpServletRequest pRequest,
              DynamoHttpServletResponse pResponse)
                throws javax.servlet.ServletException,
                       java.io.IOException

Operation called just after component deleting is finished

Parameters:

pRequest - the dynamo request object

pResponse - the dynamo response object

Throws:

javax.servlet.ServletException - if something went wrong

java.io.IOException - if something went wrong