Package com.evolveum.midpoint.model.api.authentication

Class CompiledUserProfile

java.lang.Object

com.evolveum.midpoint.model.api.authentication.CompiledUserProfile

All Implemented Interfaces:

DebugDumpable, Serializable

public class CompiledUserProfile
extends Object
implements DebugDumpable, Serializable

Compiled user profile. This class contains information about configuration and customization of individual parts of user interface and user preferences. This class contains pre-processed information in a form that is suitable to direct use by user interface code. The GUI should not be required to do any complex processing on this. This idea is to compile the profile just once, on login time. Therefore only the authentication code (UserProfileCompiler) should modify this object. It should be considered read-only for all other purposes. Later it may be split to interface and implementation parts.

Since:

4.0

Author:

Radovan Semancik

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
CompiledUserProfile()

Method Summary

Modifier and Type	Method	Description
String	debugDump(int indent)
List<CompiledObjectCollectionView>	findAllApplicableArchetypeViews(QName objectType)	Find all archetype views that are applicable for a particular object type.
<O extends ObjectType> List<CompiledObjectCollectionView>	findAllApplicableObjectCollectionViews(Class<O> compileTimeClass)	Find all views that are applicable for a particular object type.
List<CompiledObjectCollectionView>	findAllApplicableObjectCollectionViews(QName objectType)	Find all views that are applicable for a particular object type.
UserInterfaceFeatureType	findFeature(String identifier)
static <T extends UserInterfaceFeatureType> T	findFeature(List<T> features, String identifier)
CompiledObjectCollectionView	findObjectCollectionView(QName objectType, String viewName)	Compiled information about object list view for a particular type.
<O extends ObjectType> GuiObjectDetailsPageType	findObjectDetailsConfiguration(Class<O> compileTimeClass)
<O extends ObjectType> CompiledObjectCollectionView	findObjectViewByViewName(Class<O> compileTimeClass, String viewName)
DashboardWidgetType	findUserDashboardWidget(String widgetIdentifier)
List<RichHyperlinkType>	getAdditionalMenuLink()
GuiExportSettingsType	getDefaultExportSettings()
CompiledObjectCollectionView	getDefaultObjectCollectionView()	Default list view setting should never be needed publicly.
String	getDefaultTimezone()
AdminGuiConfigurationDisplayFormatsType	getDisplayFormats()
List<UserInterfaceFeatureType>	getFeatures()
UserInterfaceElementVisibilityType	getFeatureVisibility(String identifier)
FeedbackMessagesHookType	getFeedbackMessagesHook()
List<CompiledObjectCollectionView>	getObjectCollectionViews()	Compiled information about all configured object list views.
GuiObjectDetailsSetType	getObjectDetails()	May change in the future.
ObjectFormsType	getObjectForms()	May change in the future.
String	getPreferredDataLanguage()
AdminGuiConfigurationRoleManagementType	getRoleManagement()
DashboardLayoutType	getUserDashboard()	Very likely to change in the future (for "flexible dashboards" feature).
List<RichHyperlinkType>	getUserDashboardLink()	Very likely to change in the future (for "flexible dashboards" feature).
Boolean	isEnableExperimentalFeatures()
boolean	isFeatureVisible(String identifier)
boolean	isFeatureVisible(String identifier, BooleanSupplier automaticPredicate)
static boolean	isVisible(UserInterfaceElementVisibilityType visibility, BooleanSupplier automaticPredicate)
void	setDefaultExportSettings(GuiExportSettingsType defaultExportSettings)
void	setDefaultObjectCollectionView(CompiledObjectCollectionView defaultObjectCollectionView)
void	setDefaultTimezone(String defaultTimezone)
void	setDisplayFormats(AdminGuiConfigurationDisplayFormatsType displayFormats)
void	setEnableExperimentalFeatures(Boolean enableExperimentalFeatures)
void	setFeedbackMessagesHook(FeedbackMessagesHookType feedbackMessagesHook)
void	setObjectDetails(GuiObjectDetailsSetType objectDetails)
void	setObjectForms(ObjectFormsType objectForms)
void	setPreferredDataLanguage(String preferredDataLanguage)
void	setRoleManagement(AdminGuiConfigurationRoleManagementType roleManagement)
void	setUserDashboard(DashboardLayoutType userDashboard)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable

debugDump, debugDumpLazily, debugDumpLazily

Constructor Detail

CompiledUserProfile

public CompiledUserProfile()

Method Detail

getDefaultTimezone

public String getDefaultTimezone()

setDefaultTimezone

public void setDefaultTimezone(String defaultTimezone)

getPreferredDataLanguage

public String getPreferredDataLanguage()

setPreferredDataLanguage

public void setPreferredDataLanguage(String preferredDataLanguage)

isEnableExperimentalFeatures

public Boolean isEnableExperimentalFeatures()

setEnableExperimentalFeatures

public void setEnableExperimentalFeatures(Boolean enableExperimentalFeatures)

getAdditionalMenuLink

@NotNull
public List<RichHyperlinkType> getAdditionalMenuLink()

getUserDashboardLink

@NotNull
public List<RichHyperlinkType> getUserDashboardLink()

Very likely to change in the future (for "flexible dashboards" feature).

getUserDashboard

public DashboardLayoutType getUserDashboard()

Very likely to change in the future (for "flexible dashboards" feature).

setUserDashboard

public void setUserDashboard(DashboardLayoutType userDashboard)

getObjectCollectionViews

@NotNull
public List<CompiledObjectCollectionView> getObjectCollectionViews()

Compiled information about all configured object list views.

findObjectCollectionView

public CompiledObjectCollectionView findObjectCollectionView(@NotNull
                                                             QName objectType,
                                                             String viewName)

Compiled information about object list view for a particular type. If viewName is null then it returns view definition for "all objects" view, e.g. "all users", "all roles".

findAllApplicableObjectCollectionViews

@NotNull
public List<CompiledObjectCollectionView> findAllApplicableObjectCollectionViews(@NotNull
                                                                                 QName objectType)

Find all views that are applicable for a particular object type. Returns views for all collections and archetypes that are applicable for that type. Ideal to be used in constructing menus.

findAllApplicableArchetypeViews

@NotNull
public List<CompiledObjectCollectionView> findAllApplicableArchetypeViews(@NotNull
                                                                          QName objectType)

Find all archetype views that are applicable for a particular object type. Returns views for archetypes that are applicable for that type.

findAllApplicableObjectCollectionViews

@NotNull
public <O extends ObjectType> List<CompiledObjectCollectionView> findAllApplicableObjectCollectionViews(Class<O> compileTimeClass)

Find all views that are applicable for a particular object type. Returns views for all collections and archetypes that are applicable for that type. Ideal to be used in costructing menus.

findObjectViewByViewName

public <O extends ObjectType> CompiledObjectCollectionView findObjectViewByViewName(Class<O> compileTimeClass,
                                                                                    String viewName)

getDefaultObjectCollectionView

public CompiledObjectCollectionView getDefaultObjectCollectionView()

Default list view setting should never be needed publicly. Always check setting for specific object type (and archetype).

setDefaultObjectCollectionView

public void setDefaultObjectCollectionView(CompiledObjectCollectionView defaultObjectCollectionView)

getDefaultExportSettings

public GuiExportSettingsType getDefaultExportSettings()

setDefaultExportSettings

public void setDefaultExportSettings(GuiExportSettingsType defaultExportSettings)

getObjectForms

public ObjectFormsType getObjectForms()

May change in the future.

setObjectForms

public void setObjectForms(ObjectFormsType objectForms)

getObjectDetails

public GuiObjectDetailsSetType getObjectDetails()

May change in the future.

setObjectDetails

public void setObjectDetails(GuiObjectDetailsSetType objectDetails)

findObjectDetailsConfiguration

public <O extends ObjectType> GuiObjectDetailsPageType findObjectDetailsConfiguration(Class<O> compileTimeClass)

getFeedbackMessagesHook

public FeedbackMessagesHookType getFeedbackMessagesHook()

setFeedbackMessagesHook

public void setFeedbackMessagesHook(FeedbackMessagesHookType feedbackMessagesHook)

getRoleManagement

public AdminGuiConfigurationRoleManagementType getRoleManagement()

setRoleManagement

public void setRoleManagement(AdminGuiConfigurationRoleManagementType roleManagement)

getFeatures

public List<UserInterfaceFeatureType> getFeatures()

findFeature

public UserInterfaceFeatureType findFeature(String identifier)

findFeature

public static <T extends UserInterfaceFeatureType> T findFeature(List<T> features,
                                                                 String identifier)

getDisplayFormats

public AdminGuiConfigurationDisplayFormatsType getDisplayFormats()

setDisplayFormats

public void setDisplayFormats(AdminGuiConfigurationDisplayFormatsType displayFormats)

getFeatureVisibility

public UserInterfaceElementVisibilityType getFeatureVisibility(String identifier)

isFeatureVisible

public boolean isFeatureVisible(String identifier)

isFeatureVisible

public boolean isFeatureVisible(String identifier,
                                BooleanSupplier automaticPredicate)

isVisible

public static boolean isVisible(UserInterfaceElementVisibilityType visibility,
                                BooleanSupplier automaticPredicate)

findUserDashboardWidget

public DashboardWidgetType findUserDashboardWidget(String widgetIdentifier)

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable