public class CommunityPrincipalFormHandler extends CommunityFormHandler
All handle methods in this form handler mirror a similiar pattern.
Each handleXXX process, all have an associated preXXX and postXXX method.
For example, the handleAssignPrincipal
has an associated
preAssignPrincipal
and postAssignPrincipal
.
These pre/post methods provide an easy way for customer's to extend the
functionality of this form handler.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
CommunityPrincipalFormHandler() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
approveMembershipRequests(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
approveMembershipRequest called by the handler to approve membership requests to a list of
ids specified in property approvePrincipalIds
|
protected boolean |
assignPrincipals(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
assignPrincipal is called by the handlers to assign principals access to a community.
|
protected boolean |
declineMembershipRequests(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
declineMembershipRequest is called by the handlers to decline membership requests for all the
users whose ids are specified in declinePrincipalIds property of this form handler
|
java.lang.String |
getAccessType() |
java.lang.String[] |
getApproveDeclineFlags() |
java.lang.String[] |
getApproveDeclinePrincipalIds() |
java.lang.String[] |
getApprovePrincipalIds() |
java.lang.String[] |
getDeclinePrincipalIds() |
atg.portal.email.EmailSender |
getEmailer() |
java.lang.String |
getEmailSenderAddress() |
int |
getNoOfMembershipRequests() |
java.lang.String |
getPostAcceptedMessage() |
java.lang.String |
getPostDeclinedMessage() |
java.lang.String |
getPreMessage() |
java.lang.String[] |
getPrincipalIds() |
java.lang.String |
getPrincipalType() |
java.lang.String |
getRequestEmailSubject() |
boolean |
getSendUserEmail() |
boolean |
handleApproveDeclineMembershipRequests(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called to approve or decline membership requests all the membership requests for users whose
ids are specified in approvePrincipalIds is approved while those in declinePrincipalIds are
declined.
|
boolean |
handleApproveMembershipRequests(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called to approve membership requests membership requests for all the users whose
id is specified in approvePrincipalIds will be approved.
|
boolean |
handleAssignPrincipals(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called to assign a principal to a community.
|
boolean |
handleDeclineMembershipRequests(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called to decline membership requests.
|
boolean |
handleUnassignPrincipals(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called to revoke a principal's access to a community.
|
void |
postApproveDeclineMembershipRequests(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just after component update is finished
|
void |
postApproveMembershipRequests(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just after component update is finished
|
void |
postAssignPrincipals(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just after component update is finished
|
void |
postDeclineMembershipRequests(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just after component update is finished
|
void |
postUnassignPrincipals(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just after component update is finished
|
void |
preApproveDeclineMembershipRequests(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just before component update is started
|
void |
preApproveMembershipRequests(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just before component update is started
|
void |
preAssignPrincipals(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just before component update is started
|
void |
preDeclineMembershipRequests(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just before component update is started
|
void |
preUnassignPrincipals(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Operation called just before component update is started
|
protected void |
resetBean()
Reset this bean.
|
void |
setAccessType(java.lang.String pAccessType) |
void |
setApproveDeclineFlags(int index,
java.lang.String pApproveDeclineFlag) |
void |
setApproveDeclinePrincipalIds(int index,
java.lang.String pApproveDeclinePrincipalId) |
void |
setApprovePrincipalIds(java.lang.String[] pApprovePrincipalIds) |
void |
setDeclinePrincipalIds(java.lang.String[] pDeclinePrincipalIds) |
void |
setEmailer(atg.portal.email.EmailSender pEmailer) |
void |
setEmailSenderAddress(java.lang.String pEmailSenderAddress) |
void |
setNoOfMembershipRequests(int pNoOfMembershipRequests) |
void |
setPostAcceptedMessage(java.lang.String pPostAcceptedMessage) |
void |
setPostDeclinedMessage(java.lang.String pPostDeclinedMessage) |
void |
setPreMessage(java.lang.String pPreMessage) |
void |
setPrincipalIds(java.lang.String[] pPrincipalIds) |
void |
setPrincipalType(java.lang.String pPrincipalType) |
void |
setRequestEmailSubject(java.lang.String pRequestEmailSubject) |
void |
setSendUserEmail(boolean pSendUserEmail) |
protected boolean |
unassignPrincipals(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
unassignPrincipal is called by the handlers to revoke access to a community from a pricipals.
|
createCommunity, deleteCommunity, getAccessLevel, getActive, getCommunity, getDescription, getGearDefinitionFolderIds, getGearDefinitionFolders, getGearTitleTemplate, getHasFolders, getId, getMembershipRequest, getName, getPageCache, getPageTemplate, getParentFolder, getPersonalization, getPortal, getStyle, getUrl, getWirelessPage, handleCreate, handleDelete, handleReset, handleUpdate, handleUpdateGearDefinitionFolders, postCreateCommunity, postDeleteCommunity, postUpdate, postUpdateGearDefinitionFolders, preCreateCommunity, preDeleteCommunity, preUpdate, preUpdateGearDefinitionFolders, setAccessLevel, setActive, setCommunity, setDescription, setGearDefinitionFolderIds, setGearDefinitionFolders, setGearTitleTemplate, setHasFolders, setId, setMembershipRequest, setName, setPageCache, setPageTemplate, setParentFolder, setPersonalization, setPortal, setStyle, setUrl, setWirelessPage, updateCommunity, updateGearDefinitionFolders
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
afterSet, beforeSet, checkFormRedirect, commitTransaction, getTransactionDemarcation, getTransactionStatus, isEnsureTransaction, isRollbackTransaction, isRollbackTransactionOnUnhandledException, isTransactionMarkedAsRollback, setEnsureTransaction, setRollbackTransaction, setRollbackTransactionOnUnhandledException, setTransactionDemarcation
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
afterGet, beforeGet
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
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public java.lang.String getPrincipalType()
public void setPrincipalType(java.lang.String pPrincipalType)
public java.lang.String[] getPrincipalIds()
public void setPrincipalIds(java.lang.String[] pPrincipalIds)
public java.lang.String getAccessType()
public void setAccessType(java.lang.String pAccessType)
public void setEmailer(atg.portal.email.EmailSender pEmailer)
public atg.portal.email.EmailSender getEmailer()
public void setEmailSenderAddress(java.lang.String pEmailSenderAddress)
public java.lang.String getEmailSenderAddress()
public void setPostAcceptedMessage(java.lang.String pPostAcceptedMessage)
public java.lang.String getPostAcceptedMessage()
public void setPostDeclinedMessage(java.lang.String pPostDeclinedMessage)
public java.lang.String getPostDeclinedMessage()
public void setPreMessage(java.lang.String pPreMessage)
public java.lang.String getPreMessage()
public void setRequestEmailSubject(java.lang.String pRequestEmailSubject)
public java.lang.String getRequestEmailSubject()
public void setSendUserEmail(boolean pSendUserEmail)
public boolean getSendUserEmail()
public java.lang.String[] getDeclinePrincipalIds()
public void setDeclinePrincipalIds(java.lang.String[] pDeclinePrincipalIds)
public int getNoOfMembershipRequests()
public void setNoOfMembershipRequests(int pNoOfMembershipRequests)
public java.lang.String[] getApprovePrincipalIds()
public void setApprovePrincipalIds(java.lang.String[] pApprovePrincipalIds)
public java.lang.String[] getApproveDeclinePrincipalIds()
public void setApproveDeclinePrincipalIds(int index, java.lang.String pApproveDeclinePrincipalId)
public java.lang.String[] getApproveDeclineFlags()
public void setApproveDeclineFlags(int index, java.lang.String pApproveDeclineFlag)
public boolean handleAssignPrincipals(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet ioprotected boolean assignPrincipals(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void preAssignPrincipals(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void postAssignPrincipals(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic boolean handleUnassignPrincipals(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet ioprotected boolean unassignPrincipals(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void preUnassignPrincipals(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void postUnassignPrincipals(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic boolean handleApproveDeclineMembershipRequests(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet iopublic boolean handleApproveMembershipRequests(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet iopublic boolean handleDeclineMembershipRequests(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet ioprotected boolean declineMembershipRequests(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongprotected boolean approveMembershipRequests(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void preDeclineMembershipRequests(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void postDeclineMembershipRequests(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void preApproveMembershipRequests(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void postApproveMembershipRequests(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void preApproveDeclineMembershipRequests(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongpublic void postApproveDeclineMembershipRequests(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the dynamo request objectpResponse
- the dynamo response objectjavax.servlet.ServletException
- if something went wrongjava.io.IOException
- if something went wrongprotected void resetBean()
resetBean
in class CommunityFormHandler