org.infoglue.cms.applications.common.actions
Class InfoGlueAbstractAction

java.lang.Object
  org.infoglue.cms.applications.common.actions.WebworkAbstractAction
      org.infoglue.cms.applications.common.actions.InfoGlueAbstractAction

All Implemented Interfaces:

java.io.Serializable, webwork.action.Action, webwork.action.CommandDriven, webwork.action.ServletRequestAware, webwork.action.ServletResponseAware

Direct Known Subclasses:

AbstractAction, AdminReleaseAction, AuthorizationSwitchManagementAction, ChangeContentStateAction, ChangeMultiContentStatePublishAction, ChangeMultiSiteNodeVersionStatePublishAction, ChangeSiteNodeStateAction, ConfirmAction, ConfirmRedirect, ContentTreeXMLAction, CreateAvailableServiceBindingAction, CreateContentAction, CreateContentTypeDefinitionAction, CreateContentWizardAbstractAction, CreateContentWizardAction, CreateContentWizardInputContentAction, CreateEmailAction, CreateGroupAction, CreateInterceptionPointAction, CreateInterceptorAction, CreateLanguageAction, CreatePageTemplateAction, CreateRedirectAction, CreateRepositoryAction, CreateRoleAction, CreateRoleFormAction, CreateServerNodeAction, CreateServiceBindingAction, CreateServiceDefinitionAction, CreateSiteNodeAction, CreateSiteNodeTypeDefinitionAction, CreateSystemUserAction, CreateTransactionHistoryFormAction, CreateWorkflowDefinitionAction, CreateWorkflowInstanceAction, DeleteAvailableServiceBindingAction, DeleteContentAction, DeleteContentTypeDefinitionAction, DeleteContentVersionAction, DeleteDigitalAssetAction, DeleteEventAction, DeleteGroupAction, DeleteInterceptionPointAction, DeleteInterceptorAction, DeleteLanguageAction, DeleteRedirectAction, DeleteRepositoryAction, DeleteRepositoryLanguageAction, DeleteRoleAction, DeleteServerNodeAction, DeleteServiceBindingAction, DeleteServiceDefinitionAction, DeleteSiteNodeAction, DeleteSiteNodeTypeDefinitionAction, DeleteSystemUserAction, DeleteWorkflowDefinitionAction, DenyPublicationRequestAction, DeployPortletAction, DownloadAssetAction, ErrorPageAction, ExportRepositoryAction, ExtendedRedirect, ExtranetLoginAction, ImageEditorAction, ImportRepositoryAction, InfoGlueDefaultInputHandlerAction, InfoGluePropertiesAbstractAction, InstallUpdateAction, InstallUpdateMainAction, LoginAction, ModelAction, MoveContentAction, MoveMultipleContentAction, MoveMultipleSiteNodeAction, MoveSiteNodeAction, PreviewContentVersionAction, PreviewSiteNodeVersionAction, RebuildRegistryAction, RefreshUpdatesAction, RegisterUserInfoAction, RepositoryLanguageAction, RequestContentVersionUnpublishAction, RequestSiteNodeVersionUnpublishAction, SearchContentAction, SimpleContentXmlServiceAction, SimpleXmlServiceAction, TextToImageEditorAction, TreeViewAbstractAction, UnInstallUpdateAction, UnInstallUpdateMainAction, UnpublishContentVersionAction, UnpublishSiteNodeVersionAction, UpdateAccessRightsAction, UpdateCacheAction, UpdateCacheAction, UpdateGroupPropertiesAction, UpdateMySettingsAction, UpdatePortletRegistryAction, UpdateRolePropertiesAction, UpdateSystemUserPasswordAction, UpdateUserPropertiesAction, UpdateWorkflowDefinitionAction, UploadPortletAction, ViewAccessRightsAction, ViewAndCreateContentForServiceBindingAction, ViewApplicationStateAction, ViewArchiveToolAction, ViewAssetListAction, ViewAvailableServiceBindingAction, ViewCalendarAction, ViewCMSAbstractToolAction, ViewCMSToolAction, ViewCMSToolFooterAction, ViewCMSToolHeaderAction, ViewComponentPropertiesEditorAction, ViewContentAction, ViewContentToolHeaderAction, ViewContentToolMenuAction, ViewContentToolStartPageAction, ViewContentToolToolBarAction, ViewContentTreeAction, ViewContentTreeForServiceBindingAction, ViewContentTypeDefinitionAction, ViewContentVersionAction, ViewContentVersionDifferenceAction, ViewContentVersionHistoryAction, ViewDatabaseSettingsAction, ViewDiagnosticCenterAction, ViewDigitalAssetAction, ViewEntityPropertiesAction, ViewExecuteTaskAction, ViewFormEditorAction, ViewGroupAction, ViewInconsistenciesAction, ViewInterceptionPointAction, ViewInterceptorAction, ViewLanguageAction, ViewLinkDialogAction, ViewListAvailableServiceBindingAction, ViewListContentAction, ViewListContentTypeDefinitionAction, ViewListContentVersionAction, ViewListGroupAction, ViewListInterceptionPointAction, ViewListInterceptorAction, ViewListLanguageAction, ViewListPortletAction, ViewListRedirectAction, ViewListRepositoryAction, ViewListRepositoryLanguageAction, ViewListRoleAction, ViewListServerNodeAction, ViewListServiceDefinitionAction, ViewListSiteNodeTypeDefinitionAction, ViewListSiteNodeVersionAction, ViewListSystemUserAction, ViewListTemplateAction, ViewListTransactionHistoryAction, ViewListUp2DateAction, ViewListWorkflowDefinitionAction, ViewLoggingAction, ViewManagementToolAction, ViewManagementToolHeaderAction, ViewManagementToolMenuAction, ViewManagementToolStartPageAction, ViewManagementToolToolBarAction, ViewMessageCenterAction, ViewMultiSelectContentTreeForServiceBindingAction, ViewMultiSelectStructureTreeForServiceBindingAction, ViewMyDesktopToolAction, ViewMyDesktopToolHeaderAction, ViewMyDesktopToolStartPageAction, ViewMyDesktopToolToolBarAction, ViewMySettingsAction, ViewPageAction, ViewPublicationsAction, ViewPublishingToolAction, ViewPublishingToolHeaderAction, ViewPublishingToolMenuAction, ViewPublishingToolStartPageAction, ViewPublishingToolToolBarAction, ViewRedirectAction, ViewRelationEditorAction, ViewRepositoryAction, ViewRoleAction, ViewServerNodeAction, ViewServiceDefinitionAction, ViewSiteNodeAction, ViewSiteNodePageComponentsAction, ViewSiteNodeTreeAction, ViewSiteNodeTypeDefinitionAction, ViewSiteNodeVersionAction, ViewStructureToolHeaderAction, ViewStructureToolMenuAction, ViewStructureToolStartPageAction, ViewStructureToolToolBarAction, ViewStructureTreeForInlineLinkAction, ViewStructureTreeForServiceBindingAction, ViewSystemToolsAction, ViewSystemUserAction, ViewSystemUserPropertiesAction, ViewTransactionHistoryAction, ViewWorkflowDefinitionAction, WYSIWYGPropertiesAction

public abstract class InfoGlueAbstractAction
extends WebworkAbstractAction

Author:

Mattias Bogeblad This is an abstract action used for all InfoGlue actions. Just to not have to put to much in the WebworkAbstractAction.

See Also:

Serialized Form

Field Summary

protected java.lang.String

colorScheme

Fields inherited from interface webwork.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

InfoGlueAbstractAction()

Method Summary

void	beginTransaction(org.exolab.castor.jdo.Database db) Begins a transaction on the supplied database
void	closeDatabase(org.exolab.castor.jdo.Database db) Close the database
void	closeTransaction(org.exolab.castor.jdo.Database db) Rollbacks a transaction on the named database
void	commitTransaction(org.exolab.castor.jdo.Database db) Ends a transaction on the named database
java.lang.String	encode(java.lang.String value)
java.lang.String	getAllowPublicationEventFilter()
java.security.Principal	getAnonymousPrincipal()
java.lang.String	getCMSBaseUrl()
java.lang.String	getColorScheme()
java.lang.String	getComponentRendererAction()
java.lang.String	getComponentRendererUrl()
java.lang.String	getCurrentURL() This method returns the current url.
java.lang.String	getDisableImageEditor()
java.security.Principal	getInfoGluePrincipal(java.lang.String userName)
java.lang.String	getLanguageCode()
java.util.Locale	getLocale()
java.lang.String	getLogoutURL() This method returns the logout url.
java.lang.String	getOriginalFullURL()
protected java.lang.String	getParameter(java.lang.String parameterName) Get a parameter (could possibly be an array) from the ActionContext (hides Servlet implementation)
java.util.Map	getPrincipalPropertyHashValues(java.lang.String propertyName, boolean escapeSpecialCharacters) Getting a property for a Principal - used for personalisation.
java.lang.String	getPrincipalPropertyValue(java.lang.String propertyName, boolean escapeSpecialCharacters) This method returns a propertyValue for the logged in user.
java.lang.String	getPrincipalPropertyValue(java.lang.String propertyName, boolean escapeSpecialCharacters, boolean findLargestValue) This method returns a propertyValue for the logged in user.
int	getSessionTimeout() This method returns the session timeout value.
protected java.lang.String	getSingleParameter(java.lang.String parameterName) Get a single parameter from the ActionContext (hides Servlet implementation)
InfoGlueAbstractAction	getThis() This method lets the velocity template get hold of all actions inheriting.
java.lang.Integer	getToolId()
java.util.List	getToolLocales() Gets a list of tool languages
java.lang.String	getURLBase() This method returns the actions url base.
java.lang.String	getUserName() Get the username for the currently logged in user
boolean	hasAccessTo(java.lang.String interceptionPointName) Used by the view pages to determine if the current user has sufficient access rights to perform the action specific by the interception point name.
boolean	hasAccessTo(java.lang.String interceptionPointName, java.lang.String extraParameter) Used by the view pages to determine if the current user has sufficient access rights to perform the action specific by the interception point name.
void	rollbackTransaction(org.exolab.castor.jdo.Database db) Rollbacks a transaction on the named database
void	setColorScheme(java.lang.String colorScheme)
void	setLanguageCode(java.lang.String languageCode)
void	setToolId(java.lang.Integer toolId)

Methods inherited from class org.infoglue.cms.applications.common.actions.WebworkAbstractAction

doDefault, doExecute, execute, getBrowserBean, getCurrentUrl, getError, getErrors, getHttpSession, getInfoGluePrincipal, getLocalizedString, getRequest, getResponse, getRoot, getSession, setCommand, setError, setServletRequest, setServletResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

colorScheme

protected java.lang.String colorScheme

Constructor Detail

InfoGlueAbstractAction

public InfoGlueAbstractAction()

Method Detail

getThis

public InfoGlueAbstractAction getThis()

This method lets the velocity template get hold of all actions inheriting.

Returns:

The action object currently invoked

getLogoutURL

public java.lang.String getLogoutURL()
                              throws java.lang.Exception

This method returns the logout url.

Throws:

java.lang.Exception

getURLBase

public java.lang.String getURLBase()

This method returns the actions url base.

getCurrentURL

public java.lang.String getCurrentURL()

This method returns the current url.

getOriginalFullURL

public java.lang.String getOriginalFullURL()

getSessionTimeout

public int getSessionTimeout()

This method returns the session timeout value.

getToolLocales

public java.util.List getToolLocales()

Gets a list of tool languages

getPrincipalPropertyValue

public java.lang.String getPrincipalPropertyValue(java.lang.String propertyName,
                                                  boolean escapeSpecialCharacters)

This method returns a propertyValue for the logged in user.

getPrincipalPropertyValue

public java.lang.String getPrincipalPropertyValue(java.lang.String propertyName,
                                                  boolean escapeSpecialCharacters,
                                                  boolean findLargestValue)

This method returns a propertyValue for the logged in user.

getPrincipalPropertyHashValues

public java.util.Map getPrincipalPropertyHashValues(java.lang.String propertyName,
                                                    boolean escapeSpecialCharacters)

Getting a property for a Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.

getAnonymousPrincipal

public java.security.Principal getAnonymousPrincipal()
                                              throws SystemException

Throws:

SystemException

getInfoGluePrincipal

public java.security.Principal getInfoGluePrincipal(java.lang.String userName)
                                             throws SystemException

Throws:

SystemException

hasAccessTo

public boolean hasAccessTo(java.lang.String interceptionPointName)

Used by the view pages to determine if the current user has sufficient access rights to perform the action specific by the interception point name.

Parameters:

interceptionPointName - THe Name of the interception point to check access rights

Returns:

True is access is allowed, false otherwise

hasAccessTo

public boolean hasAccessTo(java.lang.String interceptionPointName,
                           java.lang.String extraParameter)

Used by the view pages to determine if the current user has sufficient access rights to perform the action specific by the interception point name.

Parameters:

interceptionPointName - THe Name of the interception point to check access rights

Returns:

True is access is allowed, false otherwise

getUserName

public java.lang.String getUserName()

Get the username for the currently logged in user

getSingleParameter

protected final java.lang.String getSingleParameter(java.lang.String parameterName)

Get a single parameter from the ActionContext (hides Servlet implementation)

getParameter

protected final java.lang.String getParameter(java.lang.String parameterName)

Get a parameter (could possibly be an array) from the ActionContext (hides Servlet implementation)

getColorScheme

public java.lang.String getColorScheme()

setColorScheme

public void setColorScheme(java.lang.String colorScheme)

encode

public java.lang.String encode(java.lang.String value)

getComponentRendererUrl

public java.lang.String getComponentRendererUrl()

getComponentRendererAction

public java.lang.String getComponentRendererAction()

getCMSBaseUrl

public java.lang.String getCMSBaseUrl()

getDisableImageEditor

public java.lang.String getDisableImageEditor()

getAllowPublicationEventFilter

public java.lang.String getAllowPublicationEventFilter()

getLocale

public java.util.Locale getLocale()

getToolId

public java.lang.Integer getToolId()

getLanguageCode

public java.lang.String getLanguageCode()

setLanguageCode

public void setLanguageCode(java.lang.String languageCode)

setToolId

public void setToolId(java.lang.Integer toolId)

beginTransaction

public void beginTransaction(org.exolab.castor.jdo.Database db)
                      throws SystemException

Begins a transaction on the supplied database

Throws:

SystemException

closeTransaction

public void closeTransaction(org.exolab.castor.jdo.Database db)
                      throws SystemException

Rollbacks a transaction on the named database

Throws:

SystemException

commitTransaction

public void commitTransaction(org.exolab.castor.jdo.Database db)
                       throws SystemException

Ends a transaction on the named database

Throws:

SystemException

rollbackTransaction

public void rollbackTransaction(org.exolab.castor.jdo.Database db)
                         throws SystemException

Rollbacks a transaction on the named database

Throws:

SystemException

closeDatabase

public void closeDatabase(org.exolab.castor.jdo.Database db)
                   throws SystemException

Close the database

Throws:

SystemException