org.opencrx.kernel.portal

Class PortalExtension

java.lang.Object

org.openmdx.portal.servlet.DefaultPortalExtension

org.opencrx.kernel.portal.PortalExtension

All Implemented Interfaces:

Serializable, org.openmdx.portal.servlet.PortalExtension_1_0

public class PortalExtension
extends org.openmdx.portal.servlet.DefaultPortalExtension
implements Serializable

PortalExtension

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PortalExtension.CrxActionFactory CrxActionFactory

Nested classes/interfaces inherited from class org.openmdx.portal.servlet.DefaultPortalExtension

org.openmdx.portal.servlet.DefaultPortalExtension.DefaultActionFactory, org.openmdx.portal.servlet.DefaultPortalExtension.DefaultControlFactory, org.openmdx.portal.servlet.DefaultPortalExtension.DefaultQueryConditionParser

Nested classes/interfaces inherited from interface org.openmdx.portal.servlet.PortalExtension_1_0

org.openmdx.portal.servlet.PortalExtension_1_0.ActionFactory, org.openmdx.portal.servlet.PortalExtension_1_0.ControlFactory, org.openmdx.portal.servlet.PortalExtension_1_0.QueryConditionParser, org.openmdx.portal.servlet.PortalExtension_1_0.SearchFieldDef

Field Summary

Fields inherited from class org.openmdx.portal.servlet.DefaultPortalExtension

ADMIN_PRINCIPAL_PREFIX, ROOT_PRINCIPAL_NAME, ROOT_REALM_NAME, WELL_KNOWN_PROTOCOLS

Constructor Summary

Constructors

Constructor and Description
PortalExtension() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	checkPrincipal(org.openmdx.base.naming.Path realmIdentity, String principalName, javax.jdo.PersistenceManager pm)
protected QueryBuilderUtil.Predicate	getAccountFullNameMatchesPredicate(String qualifiedFeatureName, boolean negate, String... params) Get predicate for case-insensitive match of account's fullName.
String	getAdminPrincipal(String realmName)
protected List<org.openmdx.portal.servlet.Action>	getAlertGridActions(org.openmdx.portal.servlet.component.ObjectView view, org.openmdx.portal.servlet.component.Grid grid, int maxSize) Get alert grid actions.
org.openmdx.portal.servlet.Autocompleter_1_0	getAutocompleter(org.openmdx.portal.servlet.ApplicationContext app, org.openmdx.base.accessor.jmi.cci.RefObject_1_0 context, String qualifiedFeatureName, String restrictToType)
protected Base.CodeMapper	getCodeMapper(org.openmdx.portal.servlet.Codes codes) Get code mapper used for object title generation.
org.openmdx.portal.servlet.DataBinding	getDataBinding(String dataBindingName)
protected List<org.openmdx.portal.servlet.Action>	getDocumentFolderGridActions(org.openmdx.portal.servlet.component.ObjectView view, org.openmdx.portal.servlet.component.Grid grid, int maxSize) Get document folder grid actions.
protected List<org.openmdx.portal.servlet.Action>	getEnableDisableGridActions(org.openmdx.portal.servlet.component.ObjectView view, org.openmdx.portal.servlet.component.Grid grid, int maxSize) Get enable / disable grid actions.
protected List<org.openmdx.portal.servlet.Action>	getExportGridActions(org.openmdx.portal.servlet.component.ObjectView view, org.openmdx.portal.servlet.component.Grid grid, int maxSize) Get export grid actions.
List<org.openmdx.base.query.Condition>	getFindObjectsBaseFilter(org.openmdx.portal.servlet.ApplicationContext application, org.openmdx.base.accessor.jmi.cci.RefObject_1_0 context, String referenceName)
List<org.openmdx.portal.servlet.Action>	getGridActions(org.openmdx.portal.servlet.component.ObjectView view, org.openmdx.portal.servlet.component.Grid grid)
int	getGridPageSize(String referencedTypeName)
protected List<org.openmdx.security.realm1.jmi1.Group>	getGroupMembership(org.openmdx.security.realm1.jmi1.Principal loginPrincipal, String realmName, javax.jdo.PersistenceManager pm) Returns group memberships of given principal.
org.openmdx.portal.servlet.component.ObjectView	getLookupView(String id, org.openmdx.base.mof.cci.ModelElement_1_0 lookupType, org.openmdx.base.accessor.jmi.cci.RefObject_1_0 startFrom, String filterValues, org.openmdx.portal.servlet.ApplicationContext app)
protected Method	getMethod(String name, Class<?>[] parameterTypes) Get method name implemented by a script located in /WEB-INF/config/scripts/${name}.script, whereas the first character of the script name is uppercase.
String	getNewUserRole(org.openmdx.portal.servlet.ApplicationContext app, org.openmdx.base.naming.Path requestedObjectIdentity)
protected List<org.openmdx.portal.servlet.Action>	getPriceLevelGridActions(org.openmdx.portal.servlet.component.ObjectView view, org.openmdx.portal.servlet.component.Grid grid, int maxSize) Get price level grid actions.
org.openmdx.base.query.Filter	getQuery(String qualifiedFeatureName, String filterValue, int queryFilterStringParamCount, org.openmdx.portal.servlet.ApplicationContext app)
org.openmdx.base.query.Filter	getQueryConditions(String clause, List<String> stringParams, org.openmdx.portal.servlet.ApplicationContext app) Return a filter with the given clause and parameters as query condition.
org.openmdx.portal.servlet.PortalExtension_1_0.SearchFieldDef	getSearchFieldDef(String qualifiedReferenceName, String featureName, org.openmdx.portal.servlet.ApplicationContext app)
TimeZone	getTimeZone(String qualifiedFeatureName, org.openmdx.portal.servlet.ApplicationContext app)
String	getTitle(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 obj, short locale, String localeAsString, boolean asShortTitle, org.openmdx.portal.servlet.ApplicationContext app)
protected List<org.openmdx.portal.servlet.Action>	getUserHomeGridActions(org.openmdx.portal.servlet.component.ObjectView view, org.openmdx.portal.servlet.component.Grid grid, int maxSize) Get user home grid actions.
List<String>	getUserRoles(org.openmdx.base.naming.Path loginRealmIdentity, String loginPrincipalName, javax.jdo.PersistenceManager pm)
org.openmdx.base.accessor.jmi.cci.RefObject_1_0	handleOperationResult(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 target, String operationName, javax.jmi.reflect.RefStruct params, javax.jmi.reflect.RefStruct result)
boolean	hasPermission(org.openmdx.portal.servlet.control.Control control, org.openmdx.base.accessor.jmi.cci.RefObject_1_0 refObj, org.openmdx.portal.servlet.ApplicationContext app, String action)
protected boolean	hasPermission(org.openmdx.security.realm1.jmi1.Principal principal, String permission, String specificPermission, String action) Returns true if principal has permission for the given permission / action.
boolean	hasPermission(String elementName, org.openmdx.base.accessor.jmi.cci.RefObject_1_0 refObj, org.openmdx.portal.servlet.ApplicationContext app, String action)
boolean	hasUserDefineableQualifier(org.openmdx.ui1.jmi1.Inspector inspector, org.openmdx.portal.servlet.ApplicationContext application)
boolean	isLookupType(org.openmdx.base.mof.cci.ModelElement_1_0 classDef)
boolean	isRootPrincipal(String principalName)
protected org.openmdx.portal.servlet.PortalExtension_1_0.ActionFactory	newActionFactory()
void	renderTextValue(org.openmdx.portal.servlet.ViewPort p, org.openmdx.portal.servlet.attribute.AttributeValue attributeValue, String value, boolean asWiki)
void	setLastLoginAt(org.openmdx.base.naming.Path realmIdentity, String segmentName, String principalName, javax.jdo.PersistenceManager pm)

Methods inherited from class org.openmdx.portal.servlet.DefaultPortalExtension

createCompositionHierarchy, getActionFactory, getAutostartUrl, getControlFactory, getCurrentLocale, getDateStyle, getDefaultCssClassFieldGroup, getDefaultCssClassObjectContainer, getGridRowColors, getLookupObject, getQueryConditionParser, getServletContext, getTimeStyle, getTitle, getTitle, getValue, hasPermission, isLookupReference, newControlFactory, setServletContext, setValue, showGridContentOnInit, storeObject, targetAsValueMap, toPlain, updateObject, valueAsCollection, xmlDatatypeFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

PortalExtension

public PortalExtension()

Constructor.

Method Detail

newActionFactory

protected org.openmdx.portal.servlet.PortalExtension_1_0.ActionFactory newActionFactory()

Overrides:

newActionFactory in class org.openmdx.portal.servlet.DefaultPortalExtension

getMethod

protected Method getMethod(String name,
                           Class<?>[] parameterTypes)
                    throws org.openmdx.base.exception.ServiceException

Get method name implemented by a script located in /WEB-INF/config/scripts/${name}.script, whereas the first character of the script name is uppercase. This method is a helper and allows scripted implementations of portal extension methods.

Parameters:

name -

parameterTypes -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getFindObjectsBaseFilter

public List<org.openmdx.base.query.Condition> getFindObjectsBaseFilter(org.openmdx.portal.servlet.ApplicationContext application,
                                                                       org.openmdx.base.accessor.jmi.cci.RefObject_1_0 context,
                                                                       String referenceName)

Specified by:

getFindObjectsBaseFilter in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

getFindObjectsBaseFilter in class org.openmdx.portal.servlet.DefaultPortalExtension

getCodeMapper

protected Base.CodeMapper getCodeMapper(org.openmdx.portal.servlet.Codes codes)

Get code mapper used for object title generation.

Parameters:

codes -

Returns:

getTitle

public String getTitle(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 obj,
                       short locale,
                       String localeAsString,
                       boolean asShortTitle,
                       org.openmdx.portal.servlet.ApplicationContext app)

Specified by:

getTitle in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

getTitle in class org.openmdx.portal.servlet.DefaultPortalExtension

hasPermission

protected boolean hasPermission(org.openmdx.security.realm1.jmi1.Principal principal,
                                String permission,
                                String specificPermission,
                                String action)

Returns true if principal has permission for the given permission / action.

Parameters:

principal -

permission -

specificPermission -

action -

Returns:

hasPermission

public boolean hasPermission(String elementName,
                             org.openmdx.base.accessor.jmi.cci.RefObject_1_0 refObj,
                             org.openmdx.portal.servlet.ApplicationContext app,
                             String action)

Specified by:

hasPermission in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

hasPermission in class org.openmdx.portal.servlet.DefaultPortalExtension

hasPermission

public boolean hasPermission(org.openmdx.portal.servlet.control.Control control,
                             org.openmdx.base.accessor.jmi.cci.RefObject_1_0 refObj,
                             org.openmdx.portal.servlet.ApplicationContext app,
                             String action)

Specified by:

hasPermission in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

hasPermission in class org.openmdx.portal.servlet.DefaultPortalExtension

getQueryConditions

public org.openmdx.base.query.Filter getQueryConditions(String clause,
                                                        List<String> stringParams,
                                                        org.openmdx.portal.servlet.ApplicationContext app)

Return a filter with the given clause and parameters as query condition.

Parameters:

clause -

stringParams -

app -

Returns:

getAccountFullNameMatchesPredicate

protected QueryBuilderUtil.Predicate getAccountFullNameMatchesPredicate(String qualifiedFeatureName,
                                                                        boolean negate,
                                                                        String... params)

Get predicate for case-insensitive match of account's fullName.

Parameters:

qualifiedFeatureName -

negate -

s0 -

s1 -

Returns:

getQuery

public org.openmdx.base.query.Filter getQuery(String qualifiedFeatureName,
                                              String filterValue,
                                              int queryFilterStringParamCount,
                                              org.openmdx.portal.servlet.ApplicationContext app)
                                       throws org.openmdx.base.exception.ServiceException

Specified by:

getQuery in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

getQuery in class org.openmdx.portal.servlet.DefaultPortalExtension

Throws:

org.openmdx.base.exception.ServiceException

getGridPageSize

public int getGridPageSize(String referencedTypeName)

Specified by:

getGridPageSize in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

getGridPageSize in class org.openmdx.portal.servlet.DefaultPortalExtension

isLookupType

public boolean isLookupType(org.openmdx.base.mof.cci.ModelElement_1_0 classDef)
                     throws org.openmdx.base.exception.ServiceException

Specified by:

isLookupType in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

isLookupType in class org.openmdx.portal.servlet.DefaultPortalExtension

Throws:

org.openmdx.base.exception.ServiceException

getAutocompleter

public org.openmdx.portal.servlet.Autocompleter_1_0 getAutocompleter(org.openmdx.portal.servlet.ApplicationContext app,
                                                                     org.openmdx.base.accessor.jmi.cci.RefObject_1_0 context,
                                                                     String qualifiedFeatureName,
                                                                     String restrictToType)

Specified by:

getAutocompleter in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

getAutocompleter in class org.openmdx.portal.servlet.DefaultPortalExtension

getLookupView

public org.openmdx.portal.servlet.component.ObjectView getLookupView(String id,
                                                                     org.openmdx.base.mof.cci.ModelElement_1_0 lookupType,
                                                                     org.openmdx.base.accessor.jmi.cci.RefObject_1_0 startFrom,
                                                                     String filterValues,
                                                                     org.openmdx.portal.servlet.ApplicationContext app)
                                                              throws org.openmdx.base.exception.ServiceException

Specified by:

getLookupView in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

getLookupView in class org.openmdx.portal.servlet.DefaultPortalExtension

Throws:

org.openmdx.base.exception.ServiceException

hasUserDefineableQualifier

public boolean hasUserDefineableQualifier(org.openmdx.ui1.jmi1.Inspector inspector,
                                          org.openmdx.portal.servlet.ApplicationContext application)

Specified by:

hasUserDefineableQualifier in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

hasUserDefineableQualifier in class org.openmdx.portal.servlet.DefaultPortalExtension

renderTextValue

public void renderTextValue(org.openmdx.portal.servlet.ViewPort p,
                            org.openmdx.portal.servlet.attribute.AttributeValue attributeValue,
                            String value,
                            boolean asWiki)
                     throws org.openmdx.base.exception.ServiceException

Specified by:

renderTextValue in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

renderTextValue in class org.openmdx.portal.servlet.DefaultPortalExtension

Throws:

org.openmdx.base.exception.ServiceException

getDataBinding

public org.openmdx.portal.servlet.DataBinding getDataBinding(String dataBindingName)

Specified by:

getDataBinding in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

getDataBinding in class org.openmdx.portal.servlet.DefaultPortalExtension

handleOperationResult

public org.openmdx.base.accessor.jmi.cci.RefObject_1_0 handleOperationResult(org.openmdx.base.accessor.jmi.cci.RefObject_1_0 target,
                                                                             String operationName,
                                                                             javax.jmi.reflect.RefStruct params,
                                                                             javax.jmi.reflect.RefStruct result)
                                                                      throws org.openmdx.base.exception.ServiceException

Specified by:

handleOperationResult in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

handleOperationResult in class org.openmdx.portal.servlet.DefaultPortalExtension

Throws:

org.openmdx.base.exception.ServiceException

getNewUserRole

public String getNewUserRole(org.openmdx.portal.servlet.ApplicationContext app,
                             org.openmdx.base.naming.Path requestedObjectIdentity)

Specified by:

getNewUserRole in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

getNewUserRole in class org.openmdx.portal.servlet.DefaultPortalExtension

getAlertGridActions

protected List<org.openmdx.portal.servlet.Action> getAlertGridActions(org.openmdx.portal.servlet.component.ObjectView view,
                                                                      org.openmdx.portal.servlet.component.Grid grid,
                                                                      int maxSize)
                                                               throws org.openmdx.base.exception.ServiceException

Get alert grid actions.

Parameters:

view -

grid -

maxSize -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getPriceLevelGridActions

protected List<org.openmdx.portal.servlet.Action> getPriceLevelGridActions(org.openmdx.portal.servlet.component.ObjectView view,
                                                                           org.openmdx.portal.servlet.component.Grid grid,
                                                                           int maxSize)
                                                                    throws org.openmdx.base.exception.ServiceException

Get price level grid actions.

Parameters:

view -

grid -

maxSize -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getDocumentFolderGridActions

protected List<org.openmdx.portal.servlet.Action> getDocumentFolderGridActions(org.openmdx.portal.servlet.component.ObjectView view,
                                                                               org.openmdx.portal.servlet.component.Grid grid,
                                                                               int maxSize)
                                                                        throws org.openmdx.base.exception.ServiceException

Get document folder grid actions.

Parameters:

view -

grid -

maxSize -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getUserHomeGridActions

protected List<org.openmdx.portal.servlet.Action> getUserHomeGridActions(org.openmdx.portal.servlet.component.ObjectView view,
                                                                         org.openmdx.portal.servlet.component.Grid grid,
                                                                         int maxSize)
                                                                  throws org.openmdx.base.exception.ServiceException

Get user home grid actions.

Parameters:

view -

grid -

maxSize -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getEnableDisableGridActions

protected List<org.openmdx.portal.servlet.Action> getEnableDisableGridActions(org.openmdx.portal.servlet.component.ObjectView view,
                                                                              org.openmdx.portal.servlet.component.Grid grid,
                                                                              int maxSize)
                                                                       throws org.openmdx.base.exception.ServiceException

Get enable / disable grid actions.

Parameters:

view -

grid -

maxSize -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getExportGridActions

protected List<org.openmdx.portal.servlet.Action> getExportGridActions(org.openmdx.portal.servlet.component.ObjectView view,
                                                                       org.openmdx.portal.servlet.component.Grid grid,
                                                                       int maxSize)
                                                                throws org.openmdx.base.exception.ServiceException

Get export grid actions.

Parameters:

view -

grid -

maxSize -

Returns:

Throws:

org.openmdx.base.exception.ServiceException

getGridActions

public List<org.openmdx.portal.servlet.Action> getGridActions(org.openmdx.portal.servlet.component.ObjectView view,
                                                              org.openmdx.portal.servlet.component.Grid grid)
                                                       throws org.openmdx.base.exception.ServiceException

Specified by:

getGridActions in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

getGridActions in class org.openmdx.portal.servlet.DefaultPortalExtension

Throws:

org.openmdx.base.exception.ServiceException

getGroupMembership

protected List<org.openmdx.security.realm1.jmi1.Group> getGroupMembership(org.openmdx.security.realm1.jmi1.Principal loginPrincipal,
                                                                          String realmName,
                                                                          javax.jdo.PersistenceManager pm)

Returns group memberships of given principal.

Parameters:

loginPrincipal -

realmName -

pm -

Returns:

checkPrincipal

public boolean checkPrincipal(org.openmdx.base.naming.Path realmIdentity,
                              String principalName,
                              javax.jdo.PersistenceManager pm)
                       throws org.openmdx.base.exception.ServiceException

Specified by:

checkPrincipal in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

checkPrincipal in class org.openmdx.portal.servlet.DefaultPortalExtension

Throws:

org.openmdx.base.exception.ServiceException

getUserRoles

public List<String> getUserRoles(org.openmdx.base.naming.Path loginRealmIdentity,
                                 String loginPrincipalName,
                                 javax.jdo.PersistenceManager pm)
                          throws org.openmdx.base.exception.ServiceException

Specified by:

getUserRoles in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

getUserRoles in class org.openmdx.portal.servlet.DefaultPortalExtension

Throws:

org.openmdx.base.exception.ServiceException

getAdminPrincipal

public String getAdminPrincipal(String realmName)

Specified by:

getAdminPrincipal in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

getAdminPrincipal in class org.openmdx.portal.servlet.DefaultPortalExtension

isRootPrincipal

public boolean isRootPrincipal(String principalName)

Specified by:

isRootPrincipal in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

isRootPrincipal in class org.openmdx.portal.servlet.DefaultPortalExtension

setLastLoginAt

public void setLastLoginAt(org.openmdx.base.naming.Path realmIdentity,
                           String segmentName,
                           String principalName,
                           javax.jdo.PersistenceManager pm)
                    throws org.openmdx.base.exception.ServiceException

Specified by:

setLastLoginAt in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

setLastLoginAt in class org.openmdx.portal.servlet.DefaultPortalExtension

Throws:

org.openmdx.base.exception.ServiceException

getTimeZone

public TimeZone getTimeZone(String qualifiedFeatureName,
                            org.openmdx.portal.servlet.ApplicationContext app)

Specified by:

getTimeZone in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

getTimeZone in class org.openmdx.portal.servlet.DefaultPortalExtension

getSearchFieldDef

public org.openmdx.portal.servlet.PortalExtension_1_0.SearchFieldDef getSearchFieldDef(String qualifiedReferenceName,
                                                                                       String featureName,
                                                                                       org.openmdx.portal.servlet.ApplicationContext app)
                                                                                throws org.openmdx.base.exception.ServiceException

Specified by:

getSearchFieldDef in interface org.openmdx.portal.servlet.PortalExtension_1_0

Overrides:

getSearchFieldDef in class org.openmdx.portal.servlet.DefaultPortalExtension

Throws:

org.openmdx.base.exception.ServiceException