com.centrasite.control.auth.api
Class DisplayManager

java.lang.Object
  extended by com.centrasite.control.auth.api.DisplayManager
All Implemented Interfaces:
Constants

public class DisplayManager
extends java.lang.Object
implements Constants

Manages UI components visibility properties.

Example:
Register perspective extension for visibility control.

1. Have the perspective Id. It is formed like <plug-in id>.<perspective extension id> . Example: CentraSite control plugin id - com.centrasite.conrol Home Perspective extension id - HomePagePerspective then Home perspective id - com.centrasite.conrol.HomePagePerspective

2. Update /CentraSiteControl/Backend/com/centrasite/control/auth/api/DisplayManager class There is a static initializer there which initializes a componentMap_ static collection. You need to put there something like componentMap_.put(<perspective id>, null);

3. Update /CentraSiteControl/Backend/com/centrasite/control/auth/api/impl/CentraSiteApplicationPolicy class In its init() method there are 3 sections - CE, EE, GE corresponding to the CS editions. Update ALL 3 with desired ComponentPermission with the appropriate view or execute actions

Example:

//----------------------------------------------- // CE //-----------------------------------------------
// perspectives
communityEdition.add(new ComponentPermission("com.centrasite.conrol.HomePagePerspective" , "view")); //the perspective will be disabled for CE

//----------------------------------------------- // EE //-----------------------------------------------
// perspectives
enterpriseEdition.add(new ComponentPermission("com.centrasite.conrol.HomePagePerspective" , "execute")); //the perspective will be active for EE

//----------------------------------------------- // GE //-----------------------------------------------
// perspectives
governanceEdition.add(new ComponentPermission("com.centrasite.conrol.HomePagePerspective" , "execute")); //the perspective will be active for GE


Field Summary
 
Fields inherited from interface com.centrasite.control.Constants
ADD_APPLICATION_ADAPTER, ADD_APPLICATION_LAYOUT_PAGE, ADD_ASSOCIATION_ADAPTER, ADD_ASSOCIATION_PAGE_LAYOUT, ADD_BULK_VERSION_ADAPTER, ADD_CATEGORY_ADAPTER, ADD_CATEGORY_PAGE, ADD_CLASSIFICATION_ADAPTER, ADD_NEW_VERSION_ADAPTER, ADD_USERS_GROUPS_ADAPTER, ADD_USERS_GROUPS_LAYOUT_PAGE, ADV_SEARCH_ADAPTER, ADVANCED_EXPORT_OPTION_ADAPTER, ADVANCED_EXPORT_OPTION_PAGE, ADVANCED_IMPORT_OPTION_ADAPTER, ADVANCED_IMPORT_OPTION_PAGE, APPLICABLE_TO_OBJECT_TYPES_ADAPTER, APPLICABLE_TO_OBJECT_TYPES_LAYOUT_PAGE, ASSOCIATION_TAB_ADAPTER, ASSOCIATIONS_LAYOUT_PAGE, ASSOCIATIONS_TAB_ADAPTER, ASSOCIATIONS_TABLE_LAYOUT, AUDITABLE_TAB_ADAPTER, AUDITABLE_TABLE_LAYOUT, BROWSE_ADAPTER, BROWSE_BY_COLUMN_ADAPTER, BROWSE_BY_COLUMNS_PAGE_F, BROWSE_BY_PAGE_F, BROWSE_PAGE, CALLING_XPDL_ADAPTER, CENTRASITE_ADDEXTERNALCLASSIFICATIONSLOT_ICO, CENTRASITE_ADDSLOT_ICO, CENTRASITE_ALERT_ICO, CENTRASITE_ARROW_ICON, CENTRASITE_COMMUNITY_URL, CENTRASITE_DELETESLOT_ICO, CENTRASITE_DEV_COMMUNITY_URL, CENTRASITE_EMAIL_NOTIFCATION_ICO, CENTRASITE_FAV_ICO, CENTRASITE_FAVOURITE_ENTRY_ASSET_I_CONSUME_ICO, CENTRASITE_FAVOURITE_ENTRY_ASSET_I_PROVIDE_ICO, CENTRASITE_FAVOURITE_ENTRY_DEFAULT_TYPE_ICO, CENTRASITE_FAVOURITE_ENTRY_LIST_ICO, CENTRASITE_FAVOURITE_ENTRY_SAVED_SEARCH_ICO, CENTRASITE_FAVOURITE_ENTRY_SAVED_XQUERY_SEARCH_ICO, CENTRASITE_FAVOURITE_ENTRY_SMART_LIST_CLASSIFICATION_SCHEME_ICO, CENTRASITE_FAVOURITE_ENTRY_SMART_LIST_CONCEPT_ICO, CENTRASITE_FAVOURITE_ENTRY_SMART_LIST_ICO, CENTRASITE_FAVOURITE_LEFT_ICO, CENTRASITE_FAVOURITE_RIGHT_ICO, CENTRASITE_FILE_ICO, CENTRASITE_GROUP_ICO, CENTRASITE_HTML_ICO, CENTRASITE_MOVEDOWN_ICO, CENTRASITE_MOVEUP_ICO, CENTRASITE_NEW_ICO, CENTRASITE_ONLINE_DOCUMENTATION_URL, CENTRASITE_PDF_ICO, CENTRASITE_POWERPOINT_ICO, CENTRASITE_REG_ICO, CENTRASITE_REMOVE_ICO, CENTRASITE_REMOVESLOT_ICO, CENTRASITE_REP_ICO, CENTRASITE_REVERT_ICO, CENTRASITE_RTL_ARROW_ICON, CENTRASITE_SAVE_ICO, CENTRASITE_USER_ICO, CENTRASITE_USERROLE_ICO, CENTRASITE_WORD_ICO, CENTRASITE_XLS_ICO, CENTRASITE_XML_ICO, CHANGE_LCM_STATE_ADAPTER, CHANGE_ORG_ADAPTER, CHANGE_ORG_PAGE, CHANGE_OWNER_ADAPTER, CHANGE_OWNER_LOG, CHANGE_OWNER_LOG_ADAPTER, CHANGE_OWNER_PAGE, CHANGE_PASSWORD_ADAPTER, CHANGE_PASSWORD_PAGE_F, CHANGE_PROVIDING_ORG, CHANGE_PROVIDING_ORG_ADAPTER, CLASSIFICATIONS_TAB_ADAPTER, CLASSIFICATIONS_TAB_LAYOUT_PAGE, COLUMNS_PAGE_F, COMPUTED_PROFILE_TAB_ADAPTER, CONSUMERS_PAGE_LAYOUT, CONSUMERS_TAB_ADAPTER, COPY_ASSET, COPY_ASSET_ADAPTER, CREATE, CREATE_ASSET_ADAPTER, CREATE_EXTERNAL_CLASSIFICATION_ADAPTER, CREATE_EXTERNAL_CLASSIFICATION_PAGE_FULL, CREATE_FAVORITE_ADAPTER, CREATE_FAVORITE_PAGE_FULL, CREATE_ROLE_ADAPTER, CREATE_ROLE_PAGE_F, CREATE_TYPE_ADAPTER, CREATE_TYPE_WIZARD_PAGE_FULL, CUSTOM_PROFILE_TAB_ADAPTER, DISPLAY, DOCUMENT_URL_CONTENT, DOWNLOAD_DOCUMENTS_ADAPTER, DOWNLOAD_DOCUMENTS_CONFIRM_PAGE, EDIT, EDIT_ASSET_ADAPTER, EDIT_ASSET_LAYOUT_PAGE, EDIT_CATEGORY_ADAPTER, EDIT_CATEGORY_PAGE, EDIT_PERMISSIONS_ADAPTER, EDIT_PERMISSIONS_PAGE, EDIT_TAXONOMY_ADAPTER, EDIT_USER_INFO_ADAPTER, EDITION_ACTIVESOA, EDITION_COMMUNITY, EDITION_ENTERPRISE, EDITION_UNKNOWN, EP_ADD_IMPORT_EXTENSION, EP_ADD_REPORT_COLUMN, EP_ADD_ROW_TO_MY_NOTIFICATIONS, EP_ASSETTYPETOPIC_ID, EP_ASSOC_NAVIGATOR_NODE_DECORATOR, EP_ATTACH_DOC_COMMAND, EP_BROWSETOPIC_ID, EP_DETAIL_VIEW_TAB, EP_DOWNLOAD_DOC_COMMAND, EP_FAVORITE_ID, EP_GLOBAL_COMMAND, EP_ITEM_BULK_COMMAND, EP_ITEM_COMMAND, EP_ITEM_EDITOR, EP_ORGANIZATIONTOPIC_ID, EP_REG_OBJ_PROPERTY, EP_REPLACE_ITEM_COMMAND, EP_REPORTS_ID, EP_SEARCH_PREDICATE, EP_SEARCHTOPIC_ID, EP_SUBSCRIPTIONS_ID, EP_SUPPORTINGDOCUMENTSTOPIC_ID, EP_SUPPRESS_REG_OBJ_COMMAND, EP_SUPPRESS_REG_OBJ_PROPERTY, EP_SUPPRESS_REPORT_COLUMN, EP_TAXONOMIES_ID, EP_TOPIC_ITEMS, EP_TOPIC_ITEMS_PROP_TOPIC, EP_USERMANAGEMENTTOPIC_ID, EP_WELCOME_ID, EXPORT_ITEMS_POPUP_LOG_VIEW_PAGE_FULL, EXPORT_LOG_ADAPTER, EXPORT_ORG_REGISTRY_OBJECTS_ADAPTER, EXPORT_ORG_REGISTRY_OBJECTS_PAGE_F_POPUP, EXPORT_ORGANIZATION, EXPORT_ORGANIZATION_ADAPTER, EXPORT_OWNER, EXPORT_OWNER_ADAPTER, EXPORT_REGISTRY_OBJECTS_ADAPTER, EXPORT_REGISTRY_OBJECTS_PAGE_F, EXPORT_REGISTRY_OBJECTS_PAGE_F_POPUP, EXPORT_REGISTRY_OBJECTS_POPUP_ADAPTER, EXTERNAL_CLASSIFICATION_DIALOG_PAGE_FULL, EXTERNAL_LINK_ORGANIZATION_REPOSITORY_FOLDER, EXTERNAL_LINKS_ADAPTER, EXTERNAL_LINKS_PAGE, FGRID_ADAPTER, FILE_CONTENT_LAYOUT_PAGE, FILE_CONTENT_TAB_ADAPTER, FILTER_ROWS_PAGE_F, GENERAL_LAYOUT_PAGE, GENERAL_TAB_ADAPTER, HELP_TEXT_PROVIDER_POPUP, HOME_PAGE_ADAPTER, ICON_URL_PREFIX, IMPACT_ANALYSIS_CUSTOMIZE_DIALOG_ADAPTER, IMPORT, IMPORT_ASSET_ADAPTER, IMPORT_ASSET_PAGE_F_POPUP, IMPORT_ASSET_WIZARD, IMPORT_ASSET_WIZARD_PAGE_POPUP, IMPORT_BPEL_ADAPTER, IMPORT_BPEL_PAGE_F, IMPORT_LOG_ADAPTER, IMPORT_OBJECTS_ADAPTER, IMPORT_OBJECTS_PAGE_F, IMPORT_ORG_OBJECTS_ADAPTER, IMPORT_ORG_OBJECTS_PAGE_F, IMPORT_POLICY_ADAPTER, IMPORT_REGISTRY_OBJECTS_ADAPTER, IMPORT_REGISTRY_OBJECTS_PAGE_F, IMPORT_SCHEMA_ADAPTER, IMPORT_SCHEMA_PAGE_F, IMPORT_WEBSERVICE_ADAPTER, IMPORT_WEBSERVICE_PAGE_F, IMPORT_XML_SERVICE_ADAPTER, IMPORT_XML_SERVICE_PAGE_F, IMPORT_XML_SERVICE_WIZARD_ADAPTER, INIT_PARAM_CFGURL, INIT_PARAM_CFGURL_ID, INIT_PARAM_LIC, INIT_PARAM_LIC__COMMUNITY, INIT_PARAM_LIC_ID, INIT_PARAM_NEWWIN, INIT_PARAM_NEWWIN_ID, INIT_PARAM_REGURL, INIT_PARAM_REGURL_ID, INIT_PARAM_ROKEY, INIT_PARAM_ROKEY_ID, INIT_PARAM_ROPATH, INIT_PARAM_ROPATH_ID, INVISIBLE, INVOKED_FROM_CLASSIFICATIONATTRFILTERLINE, INVOKED_FROM_LCMFILTERLINE, ITEM_ADDED_AS_FAVORITE, ITEM_CREATED, ITEM_DELETED, ITEM_REMOVED_FROM_FAVORITES, ITEM_RENAMED, ITEM_UPDATED, KEY_COMMON_PAGE, KEY_FILE_EXTENSION_ZIP, KEY_ORG_SELECT_ASSET_OPTION, KEY_ORG_SELECT_USER_OPTION, KEY_ORG_USER_TAB, KEY_USER_ASSET_TAB, KEY_USER_PAGE, KEYWORD_SEARCH_ADAPTER, knownEditions, LOG_VIEW_ADAPTER, LOG_VIEW_PAGE_FULL, MINMAX_OCCURS_01, MINMAX_OCCURS_0UNBOUNDED, MINMAX_OCCURS_11, MINMAX_OCCURS_1UNBOUNDED, MULTI_VALUE_PAGE_REFERENCE, MY_ACCOUNT_PAGE, MY_APPLICATION, MY_CENTRASITE_PAGE, MY_PLUGIN_ID, NOT_REFERENCED, NOTIFICATIONS_TAB_ADAPTER, OBJECT_SPECIFIC_PROPERTIES_ADAPTER, OBJECT_SPECIFIC_PROPERTIES_PAGE, OBJECT_TYPE_CLASSIFICATION, OBJECT_TYPE_REPORT, OVERVIEW_LAYOUT_PAGE, OVERVIEW_TAB_ADAPTER, PAGE_URL_PREFIX, PAIR_INPUT_PAGE_FULL, PARAM_JAAS_XML_SERVER_URL, PARM_INM_CRR_URL, PARM_INM_GUES_ALLOW_SUMMARY_PROFILE_VISIBLE, PARM_INM_GUEST_ALLOW_HOMEPAGE_CHANGE, PARM_INM_GUEST_CAN_DOWNLOAD_DOCUMENTS, PARM_INM_GUEST_SHOW_COLUMN_CHOOSER, PARM_INM_IS_CUSTOM_ATTACH_DOCUMENTS, PARM_INM_REPORTING_ENGINE_AUTH, PARM_INM_WELCOME_PAGE_DEFAULT, PERMISSION_TABLE_LAYOUT_PAGE, PERMISSIONS_TAB_ADAPTER, PIN_EDIT_ADAPTER, PIN_EDIT_PAGE_LAYOUT, PROFILE_ASSOCIATIONS, PROFILE_AUDIT_LOG, PROFILE_CLASSIFICATIONS, PROFILE_CONSUMERS, PROFILE_DEPLOYMENT, PROFILE_EVENTS, PROFILE_EXTERNAL_LINKS, PROFILE_GENERAL, PROFILE_IMPACT_ANALYSIS, PROFILE_OBJECT_SECIFIC_PROPERTIES, PROFILE_PERFORMANCE, PROFILE_PERMISSION_LAYOUT_PAGE, PROFILE_PERMISSIONS, PROFILE_PERMISSIONS_TAB_ADAPTER, PROFILE_POLICIES, PROFILE_PROCESSING_STEPS, PROFILE_SUBSCRIPTIONS, PROFILE_SUMMARY, PROFILE_SUMMARY_XSD, PROFILE_TECHNICAL_DETAILS, PROFILE_VERSIONS, PROFILE_WSDL, PROMPT_SAVE_DISCARD_ADAPTER, REPOSITORY_OBJECT_FILE_SYSTEM_NAME_PROPERTY_NAME, REPOSITORY_OBJECT_USER_DEFINED_DESCRIPTION_PROPERTY_NAME, REPOSITORY_OBJECT_VERSION_TAB_ADAPTER, REPOSITORY_OBJECT_VERSION_TAB_LAYOUT, REPOSITORY_PERMISSIONS_LAYOUT_PAGE, SEARCH_ADAPTER, SEARCH_PAGE, SEARCH_SCREEN_PAGE_FULL, SECURITY_LAYOUT_PAGE, SECURITY_TAB_ADAPTER, SELECT_ASSOCIATION_TYPE_PAGE_FULL, SELECT_COLUMNS_PAGE_F, SELECT_EXTERNAL_CLASSIFICATION, SELECT_EXTERNAL_CLASSIFICATION_ADAPTER, SELECT_INTERNAL_CLASSIFICATION, SELECT_INTERNAL_CLASSIFICATION_ADAPTER, SELECT_ROLE_PAGE_FULL, SELECT_SERVICE_BINDING_ADAPTER, SELECT_SERVICE_BINDING_PAGE_FULL, SELECT_USERROLE_PAGE_FULL, SERVICE_BINDING_DIALOG_PAGE_FULL, SET_PERMISSINOS_POPUP, SINGLE_VALUE_PAGE_REFERENCE, SLOT_NAME_IS_PENDING_FOR_REDEPLOYMENT, STR_AUTHORIZATION, STR_BASIC, STR_COLON, STR_CONTENTTYP_UNDEFINED, STR_FORWARDSLASH, STR_PROTOCOL_GET, STR_UNDERSCORE, STR_UTF8, STR_WEBDAV_TYPE_URL, SUBSCRIPTION_ACTIVE, SUBSCRIPTION_INACTIVE, TABLE_DETAIL_TAB_ADAPTER, TABLE_LAYOUT_PAGE, TABLE_LAYOUT_PAGE_WITH_METHOD_LINKS, TECHNICAL_DETAILS_LAYOUT, TECHNICAL_DETAILS_TAB_ADAPTER, TYPE_SECURITY_LAYOUT_PAGE, TYPE_SECURITY_TAB_ADAPTER, URL_CONTENT_ADAPTER, USER_PREFERENCES_ADAPTER, USER_PREFERENCES_PAGE, VERSION_TABLE_LAYOUT_PAGE, VERSIONING_CHANGELOG_SLOT, VERSIONS_TAB_ADAPTER, VIEW_EXPORT_LOG_ADAPTER, VIEW_EXPORT_LOG_PAGE_FULL, VIEW_EXPORT_MESSAGE_ADAPTER, VIEW_EXPORT_MESSAGE_PAGE_FULL, VIEW_EXPORT_OBJECTS_LIST_ADPTER, VIEW_EXPORT_OBJECTS_LIST_PAGE, VIEW_IMPORT_LOG_ADAPTER, VIEW_IMPORT_LOG_PAGE_FULL, VIEW_IMPORT_MESSAGE_ADAPTER, VIEW_IMPORT_MESSAGE_PAGE_FULL, VIEW_IMPORT_OBJECTS_LIST_ADPTER, VIEW_IMPORT_OBJECTS_LIST_PAGE
 
Constructor Summary
DisplayManager(Connector connector)
           
 
Method Summary
 void clearVisibleProfiles()
           
 int getDisplayMode(java.lang.String id)
           
 int getDisplayMode(java.lang.String id, ActionContext ac)
          Check for instance level privileges as well as system and organization level.
 java.util.List<Profile> getVisibleProfiles(java.lang.String assetKey)
          Get the list of profiles for the given asset visible to the current user.
 java.util.Map<java.lang.String,java.util.List<Profile>> getVisibleProfilesMap()
           
 int setDisplayMode(com.softwareag.cis.plugin.interfaces.Component component)
          Changes the state of the component instance properties visible and enabled, i.e. this method calls setVisible(boolean) and setEnabled(boolean) as appropriate.
 int setDisplayMode(com.softwareag.cis.plugin.interfaces.Component component, ActionContext ac)
          Changes the state of the component instance properties visible and enabled, i.e. this method calls setVisible(boolean) and setEnabled(boolean) as appropriate.
 void setVisibleProfile(java.lang.String assetKey, java.util.List<Profile> visibleProfiles)
          Set the list of profiles for the given asset visible to the current user.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DisplayManager

public DisplayManager(Connector connector)
Method Detail

getVisibleProfilesMap

public java.util.Map<java.lang.String,java.util.List<Profile>> getVisibleProfilesMap()

setDisplayMode

public int setDisplayMode(com.softwareag.cis.plugin.interfaces.Component component)
Changes the state of the component instance properties visible and enabled, i.e. this method calls setVisible(boolean) and setEnabled(boolean) as appropriate. Returns explicitly the display mode .

Parameters:
component - The component instance to set the display mode to.
Returns:
display mode which can be one of

Constants.EDIT - the component should be displayed and responsive to user input.

Constants.DISPLAY - the component should be displayed but not responsive to user input.

Constants.INVISIBLE - the component should not be displayed.


setDisplayMode

public int setDisplayMode(com.softwareag.cis.plugin.interfaces.Component component,
                          ActionContext ac)
Changes the state of the component instance properties visible and enabled, i.e. this method calls setVisible(boolean) and setEnabled(boolean) as appropriate. Returns explicitly the display mode .

Parameters:
component - The component instance to set the display mode to.
Returns:
display mode which can be one of

Constants.EDIT - the component should be displayed and responsive to user input.

Constants.DISPLAY - the component should be displayed but not responsive to user input.

Constants.INVISIBLE - the component should not be displayed.


getDisplayMode

public int getDisplayMode(java.lang.String id)
Parameters:
id - The component id to check visibility against.
Returns:
display mode which can be one of

Constants.EDIT - the component should be displayed and responsive to user input.

Constants.DISPLAY - the component should be displayed but not responsive to user input.

Constants.INVISIBLE - the component should not be displayed.


getDisplayMode

public int getDisplayMode(java.lang.String id,
                          ActionContext ac)
Check for instance level privileges as well as system and organization level.

Parameters:
id - The component id to check visibility.
ro - Registry Object instance level privileges to check against.
Returns:
display mode which can be one of

Constants.EDIT - the component should be displayed and responsive to user input.

Constants.DISPLAY - the component should be displayed but not responsive to user input.

Constants.INVISIBLE - the component should not be displayed.


getVisibleProfiles

public java.util.List<Profile> getVisibleProfiles(java.lang.String assetKey)
Get the list of profiles for the given asset visible to the current user.

Parameters:
assetKey -
Returns:
List of visible profiles.

clearVisibleProfiles

public void clearVisibleProfiles()

setVisibleProfile

public void setVisibleProfile(java.lang.String assetKey,
                              java.util.List<Profile> visibleProfiles)
Set the list of profiles for the given asset visible to the current user.

Parameters:
assetKey -
visibleProfiles -