atg.portal.admin

Class CommunityFormHandler

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.CommunityFormHandler

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

Direct Known Subclasses:

CommunityPrincipalFormHandler

public class CommunityFormHandler
extends PortalGenericFormHandler

This class provides convenient form handling methods for operating on Portal Application Framework communities. It can be used to create new or edit existing communities.

Community management is the core functionality of this form handler. It controls creating, updating and deleting all communities using calls to the business layer PortalRepositoryManagement class. This functionality is invoked via the various handleXXX methods of the form handler.

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 associated preCreateCommunity and postCreateCommunity. These pre/post methods provide an easy way for customer's 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

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
CommunityFormHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	createCommunity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) createCommunity is called by the handlers to make calls to the management layer class to create a community using the properties set by the form.
protected boolean	deleteCommunity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) deleteCommunity is called by the handlers to make calls to the management layer class to delete a community.
java.lang.Integer	getAccessLevel() Returns property Access
java.lang.Boolean	getActive() Returns property active
Community	getCommunity() Returns property Community
java.lang.String	getDescription() Returns property Description
java.lang.String[]	getGearDefinitionFolderIds() Returns property mGearDefinitionFolder
atg.portal.framework.folder.GearDefinitionFolder[]	getGearDefinitionFolders() Returns property mGearDefinitionFolder
java.lang.String	getGearTitleTemplate() Returns property mGearTitleTemplate
java.lang.Boolean	getHasFolders() Returns property HasFolders
java.lang.String	getId() Returns property Id
java.lang.String	getMembershipRequest() Returns property mMembershipRequest
java.lang.String	getName() Returns property mName
Cache	getPageCache() Returns property PageCache
java.lang.String	getPageTemplate() Returns property mPageTemplate
java.lang.String	getParentFolder() Returns property mParentFolder
java.lang.String	getPersonalization() Returns property Personalization
Portal	getPortal() Returns the Portal object to use for retrieval and manipulation of portal assets.
java.lang.String	getStyle() Returns property mStyle
java.lang.String	getUrl() Returns property mUrl
java.lang.String	getWirelessPage() Returns property mWirelessPage
boolean	handleCreate(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called when the user submits the form using the Create button to create a community.
boolean	handleDelete(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called to handle deleting a community.
boolean	handleReset(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Reset this session scoped formhandler
boolean	handleUpdate(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called to handle updating a community.
boolean	handleUpdateGearDefinitionFolders(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Called to handle updating a community.
void	postCreateCommunity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just component creation is finished
void	postDeleteCommunity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just component creation is finished
void	postUpdate(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just component creation is finished
void	postUpdateGearDefinitionFolders(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just component creation is finished
boolean	preCreateCommunity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just before component creation is started.
void	preDeleteCommunity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just before component creation is started
void	preUpdate(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just before component creation is started
void	preUpdateGearDefinitionFolders(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Operation called just before component creation is started
protected void	resetBean() Reset this bean set properties to null
void	setAccessLevel(java.lang.Integer pAccessLevel) Sets property Access
void	setActive(java.lang.Boolean pActive)
void	setCommunity(Community pCommunity) Sets property Community
void	setDescription(java.lang.String pDescription) Sets property Description
void	setGearDefinitionFolderIds(java.lang.String[] pGearDefinitionFolderIds) Sets property GearDefinitionFolderIds
void	setGearDefinitionFolders(atg.portal.framework.folder.GearDefinitionFolder[] pGearDefinitionFolders) Sets property GearDefinitionFolders
void	setGearTitleTemplate(java.lang.String pGearTitleTemplate) Sets property GearTitleTemplate
void	setHasFolders(java.lang.Boolean pHasFolders) Sets property HasFolders
void	setId(java.lang.String pId) Sets property Id
void	setMembershipRequest(java.lang.String pMembershipRequest) Sets property MembershipRequest
void	setName(java.lang.String pName) Sets property Name
void	setPageCache(Cache pPageCache) Sets property PageCache
void	setPageTemplate(java.lang.String pPageTemplate) Sets property PageTemplate
void	setParentFolder(java.lang.String pParentFolder) Sets property ParentFolder
void	setPersonalization(java.lang.String pPersonalization) Sets property Personalization
void	setPortal(Portal pPortal) The portal object to use for retrieval and manipulation of portal assets.
void	setStyle(java.lang.String pStyle) Sets property Style
void	setUrl(java.lang.String pUrl) Sets property Url
void	setWirelessPage(java.lang.String pWirelessPage) Sets property wirelessPage
protected boolean	updateCommunity(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) updateCommunity is called by the handlers to make calls to the management layer class to update a community.
protected boolean	updateGearDefinitionFolders(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) updateGearDefinitionFolders is called by the handlers to update the gear definition folders available to a community

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

Constructor Detail

CommunityFormHandler

public CommunityFormHandler()

Method Detail

setPortal

public void setPortal(Portal pPortal)

The portal object to use for retrieval and manipulation of portal assets.

Parameters:

pPortal - The property to store the value of the portal object.

getPortal

public Portal getPortal()

Returns the Portal object to use for retrieval and manipulation of portal assets.

Returns:

The value of the property portal.

setId

public void setId(java.lang.String pId)

Sets property Id

Parameters:

pId - The property for repository id of .

getId

public java.lang.String getId()

Returns property Id

Returns:

The value of property mId.

setName

public void setName(java.lang.String pName)

Sets property Name

Parameters:

pName - The property to store the name of the .

getName

public java.lang.String getName()

Returns property mName

Specified by:

getName in interface NameContextElement

Overrides:

getName in class GenericService

Returns:

The value of property Name.

setUrl

public void setUrl(java.lang.String pUrl)

Sets property Url

Parameters:

pUrl - The property to store the url of the .

getUrl

public java.lang.String getUrl()

Returns property mUrl

Returns:

The value of property Url.

setParentFolder

public void setParentFolder(java.lang.String pParentFolder)

Sets property ParentFolder

Parameters:

pParentFolder - The property to store the parent folder for the community.

getParentFolder

public java.lang.String getParentFolder()

Returns property mParentFolder

Returns:

The value of property ParentFolder.

setDescription

public void setDescription(java.lang.String pDescription)

Sets property Description

Parameters:

pDescription - The description of the community.

getDescription

public java.lang.String getDescription()

Returns property Description

Returns:

The value of property mDescription.

setMembershipRequest

public void setMembershipRequest(java.lang.String pMembershipRequest)

Sets property MembershipRequest

Parameters:

pMembershipRequest - The property used to indicate membership for community.

getMembershipRequest

public java.lang.String getMembershipRequest()

Returns property mMembershipRequest

Returns:

The value of property MembershipRequest.

setPageTemplate

public void setPageTemplate(java.lang.String pPageTemplate)

Sets property PageTemplate

Parameters:

pPageTemplate - The property to store the Page Template of community.

getPageTemplate

public java.lang.String getPageTemplate()

Returns property mPageTemplate

Returns:

The value of property PageTemplate.

setStyle

public void setStyle(java.lang.String pStyle)

Sets property Style

Parameters:

pStyle - The property used to store style Repository Id of community community.

getStyle

public java.lang.String getStyle()

Returns property mStyle

Returns:

The value of property Style.

setGearTitleTemplate

public void setGearTitleTemplate(java.lang.String pGearTitleTemplate)

Sets property GearTitleTemplate

Parameters:

pGearTitleTemplate - The property to store the Gear TitleTemplate of community.

getGearTitleTemplate

public java.lang.String getGearTitleTemplate()

Returns property mGearTitleTemplate

Returns:

The value of property GearTitleTemplate.

setPersonalization

public void setPersonalization(java.lang.String pPersonalization)

Sets property Personalization

Parameters:

pPersonalization - The property used to indicate whether users can personalize the community.

getPersonalization

public java.lang.String getPersonalization()

Returns property Personalization

Returns:

The value of property mPersonalization.

setAccessLevel

public void setAccessLevel(java.lang.Integer pAccessLevel)

Sets property Access

Parameters:

pAccess - The property used to indicate who all can access the community.

getAccessLevel

public java.lang.Integer getAccessLevel()

Returns property Access

Returns:

The value of property mAccess.

setWirelessPage

public void setWirelessPage(java.lang.String pWirelessPage)

Sets property wirelessPage

Parameters:

pWirelessPage - The property to store the wireless page.

getWirelessPage

public java.lang.String getWirelessPage()

Returns property mWirelessPage

Returns:

The value of property wirelessPage.

setActive

public void setActive(java.lang.Boolean pActive)

getActive

public java.lang.Boolean getActive()

Returns property active

Returns:

The value of property mActive.

setPageCache

public void setPageCache(Cache pPageCache)

Sets property PageCache

getPageCache

public Cache getPageCache()

Returns property PageCache

setCommunity

public void setCommunity(Community pCommunity)

Sets property Community

Parameters:

pCommunity - The property for the Community object.

getCommunity

public Community getCommunity()

Returns property Community

Returns:

The value of property mCommunity.

setGearDefinitionFolders

public void setGearDefinitionFolders(atg.portal.framework.folder.GearDefinitionFolder[] pGearDefinitionFolders)

Sets property GearDefinitionFolders

Parameters:

pGearDefinitionFolders - The property to store the all the gear definition folders.

getGearDefinitionFolders

public atg.portal.framework.folder.GearDefinitionFolder[] getGearDefinitionFolders()
                                                                            throws PortalException,
                                                                                   SecurityException

Returns property mGearDefinitionFolder

Returns:

The value of property GearDefinitionFolders.

Throws:

PortalException

SecurityException

setGearDefinitionFolderIds

public void setGearDefinitionFolderIds(java.lang.String[] pGearDefinitionFolderIds)

Sets property GearDefinitionFolderIds

Parameters:

pGearDefinitionFolderIds - The property to store the all the gear definition folders.

getGearDefinitionFolderIds

public java.lang.String[] getGearDefinitionFolderIds()

Returns property mGearDefinitionFolder

Returns:

The value of property GearDefinitionFolderIds.

setHasFolders

public void setHasFolders(java.lang.Boolean pHasFolders)

Sets property HasFolders

Parameters:

pHasFolders - boolean to specify whether gear definition folders have been checked.

getHasFolders

public java.lang.Boolean getHasFolders()

Returns property HasFolders

Returns:

The value of the property HasFolders.

handleCreate

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

Called when the user submits the form using the Create button to create a community.

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

createCommunity

protected boolean createCommunity(DynamoHttpServletRequest pRequest,
                      DynamoHttpServletResponse pResponse)
                           throws java.io.IOException,
                                  javax.servlet.ServletException,
                                  SecurityException

createCommunity is called by the handlers to make calls to the management layer class to create a community using the properties set by the form.

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

SecurityException

preCreateCommunity

public boolean preCreateCommunity(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

postCreateCommunity

public void postCreateCommunity(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 java.io.IOException,
                            javax.servlet.ServletException,
                            SecurityException

Called to handle deleting a community.

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

SecurityException

deleteCommunity

protected boolean deleteCommunity(DynamoHttpServletRequest pRequest,
                      DynamoHttpServletResponse pResponse)
                           throws java.io.IOException,
                                  javax.servlet.ServletException,
                                  SecurityException

deleteCommunity is called by the handlers to make calls to the management layer class to delete a community.

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

SecurityException

preDeleteCommunity

public void preDeleteCommunity(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

postDeleteCommunity

public void postDeleteCommunity(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

handleUpdate

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

Called to handle updating a community.

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

updateCommunity

protected boolean updateCommunity(DynamoHttpServletRequest pRequest,
                      DynamoHttpServletResponse pResponse)
                           throws java.io.IOException,
                                  javax.servlet.ServletException,
                                  SecurityException

updateCommunity is called by the handlers to make calls to the management layer class to update a community.

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

SecurityException

preUpdate

public void preUpdate(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

postUpdate

public void postUpdate(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

handleUpdateGearDefinitionFolders

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

Called to handle updating a community.

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

updateGearDefinitionFolders

protected boolean updateGearDefinitionFolders(DynamoHttpServletRequest pRequest,
                                  DynamoHttpServletResponse pResponse)
                                       throws java.io.IOException,
                                              javax.servlet.ServletException,
                                              SecurityException

updateGearDefinitionFolders is called by the handlers to update the gear definition folders available to a community

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

SecurityException

preUpdateGearDefinitionFolders

public void preUpdateGearDefinitionFolders(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

postUpdateGearDefinitionFolders

public void postUpdateGearDefinitionFolders(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

resetBean

protected void resetBean()

Reset this bean set properties to null

handleReset

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

Reset this session scoped formhandler

Throws:

java.io.IOException

javax.servlet.ServletException