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

Class CompiledGuiProfile

java.lang.Object

com.evolveum.midpoint.model.api.authentication.CompiledGuiProfile

All Implemented Interfaces:

DebugDumpable, Serializable

@Experimental
public class CompiledGuiProfile
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 (GuiProfiledPrincipalManager) 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
CompiledGuiProfile()

Method Summary

Modifier and Type	Method	Description
String	debugDump(int indent)
boolean	derivedFrom(String oid)	Returns true if compiled profile is derived from provided OID
<O extends ObjectType> @NotNull List<CompiledObjectCollectionView>	findAllApplicableArchetypeViews(@NotNull Class<O> objectType)
<O extends ObjectType> @NotNull List<CompiledObjectCollectionView>	findAllApplicableArchetypeViews(@NotNull Class<O> objectType, OperationTypeType operationType)
@NotNull List<CompiledObjectCollectionView>	findAllApplicableArchetypeViews(@NotNull QName objectType, OperationTypeType operationTypeType)	Find all archetype views that are applicable for a particular object type.
@NotNull List<CompiledObjectCollectionView>	findAllApplicableObjectCollectionViews(@NotNull QName objectType)	Find all views that are applicable for a particular object type.
<O extends ObjectType> @NotNull List<CompiledObjectCollectionView>	findAllApplicableObjectCollectionViews(Class<O> compileTimeClass)	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(@NotNull 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> GuiObjectDetailsPageType	findObjectDetailsConfiguration(QName typeQName)
ContainerPanelConfigurationType	findPrincipalFocusDetailsPanel(@NotNull QName focusType, @NotNull String panelType)
<O extends ObjectType> GuiResourceDetailsPageType	findResourceDetailsConfiguration(String connectorOid)
CompiledShadowCollectionView	findShadowCollectionView(@NotNull String resourceOid, ShadowKindType kindType, String intent)
<O extends ObjectType> GuiShadowDetailsPageType	findShadowDetailsConfiguration(ResourceShadowCoordinates coordinates)
DashboardWidgetType	findUserDashboardWidget(String widgetIdentifier)
AccessRequestType	getAccessRequest()
@NotNull List<RichHyperlinkType>	getAdditionalMenuLink()
AdminGuiApprovalsConfigurationType	getApprovals()
List<CompiledDashboardType>	getConfigurableDashboards()
GuiExportSettingsType	getDefaultExportSettings()
CompiledObjectCollectionView	getDefaultObjectCollectionView()	Default list view setting should never be needed publicly.
String	getDefaultTimezone()
Set<String>	getDependencies()
AdminGuiConfigurationDisplayFormatsType	getDisplayFormats()
List<UserInterfaceFeatureType>	getFeatures()
UserInterfaceElementVisibilityType	getFeatureVisibility(String identifier)
FeedbackMessagesHookType	getFeedbackMessagesHook()
HomePageType	getHomePage()
byte[]	getJpegPhoto()
Locale	getLocale()
@NotNull 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()
GuiObjectDetailsPageType	getSelfProfilePage()
@NotNull List<CompiledShadowCollectionView>	getShadowCollectionViews()
DashboardLayoutType	getUserDashboard()	Very likely to change in the future (for "flexible dashboards" feature).
@NotNull List<RichHyperlinkType>	getUserDashboardLink()	Very likely to change in the future (for "flexible dashboards" feature).
Boolean	isEnableExperimentalFeatures()
Boolean	isExpandRolesOnApprovalPreview()
boolean	isFeatureVisible(String identifier)
boolean	isFeatureVisible(String identifier, BooleanSupplier automaticPredicate)
boolean	isInvalid()
Boolean	isUseNewDesign()
static boolean	isVisible(UserInterfaceElementVisibilityType visibility, BooleanSupplier automaticPredicate)
void	markInvalid()
void	setAccessRequest(AccessRequestType accessRequest)
void	setApprovals(AdminGuiApprovalsConfigurationType approvals)
void	setDefaultExportSettings(GuiExportSettingsType defaultExportSettings)
void	setDefaultObjectCollectionView(CompiledObjectCollectionView defaultObjectCollectionView)
void	setDefaultTimezone(String defaultTimezone)
void	setDependencies(Set<String> value)
void	setDisplayFormats(AdminGuiConfigurationDisplayFormatsType displayFormats)
void	setEnableExperimentalFeatures(Boolean enableExperimentalFeatures)
void	setFeedbackMessagesHook(FeedbackMessagesHookType feedbackMessagesHook)
void	setHomePage(HomePageType homePage)
void	setJpegPhoto(byte[] jpegPhoto)
void	setLocale(Locale locale)
void	setObjectDetails(GuiObjectDetailsSetType objectDetails)
void	setObjectForms(ObjectFormsType objectForms)
void	setPreferredDataLanguage(String preferredDataLanguage)
void	setRoleManagement(AdminGuiConfigurationRoleManagementType roleManagement)
void	setSelfProfilePage(GuiObjectDetailsPageType selfProfilePage)
void	setUseNewDesign(Boolean useNewDesign)
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

CompiledGuiProfile

public CompiledGuiProfile()

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)

setUseNewDesign

public void setUseNewDesign(Boolean useNewDesign)

isUseNewDesign

public Boolean isUseNewDesign()

getSelfProfilePage

public GuiObjectDetailsPageType getSelfProfilePage()

setSelfProfilePage

public void setSelfProfilePage(GuiObjectDetailsPageType selfProfilePage)

getAdditionalMenuLink

@NotNull
public @NotNull List<RichHyperlinkType> getAdditionalMenuLink()

getUserDashboardLink

@Experimental
@NotNull
public @NotNull List<RichHyperlinkType> getUserDashboardLink()

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

getUserDashboard

@Experimental
public DashboardLayoutType getUserDashboard()

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

setUserDashboard

@Experimental
public void setUserDashboard(DashboardLayoutType userDashboard)

getConfigurableDashboards

public List<CompiledDashboardType> getConfigurableDashboards()

getObjectCollectionViews

@NotNull
public @NotNull List<CompiledObjectCollectionView> getObjectCollectionViews()

Compiled information about all configured object list views.

getShadowCollectionViews

@NotNull
public @NotNull List<CompiledShadowCollectionView> getShadowCollectionViews()

findObjectCollectionView

public CompiledObjectCollectionView findObjectCollectionView(@NotNull
                                                             @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".

findShadowCollectionView

public CompiledShadowCollectionView findShadowCollectionView(@NotNull
                                                             @NotNull String resourceOid,
                                                             ShadowKindType kindType,
                                                             String intent)

findAllApplicableObjectCollectionViews

@NotNull
public @NotNull List<CompiledObjectCollectionView> findAllApplicableObjectCollectionViews(@NotNull
                                                                                          @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 @NotNull List<CompiledObjectCollectionView> findAllApplicableArchetypeViews(@NotNull
                                                                                   @NotNull QName objectType,
                                                                                   OperationTypeType operationTypeType)

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

findAllApplicableArchetypeViews

@NotNull
public <O extends ObjectType> @NotNull List<CompiledObjectCollectionView> findAllApplicableArchetypeViews(@NotNull
                                                                                                          @NotNull Class<O> objectType)

findAllApplicableArchetypeViews

@NotNull
public <O extends ObjectType> @NotNull List<CompiledObjectCollectionView> findAllApplicableArchetypeViews(@NotNull
                                                                                                          @NotNull Class<O> objectType,
                                                                                                          OperationTypeType operationType)

findAllApplicableObjectCollectionViews

@NotNull
public <O extends ObjectType> @NotNull 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.

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

@Experimental
public ObjectFormsType getObjectForms()

May change in the future.

setObjectForms

@Experimental
public void setObjectForms(ObjectFormsType objectForms)

getObjectDetails

@Experimental
public GuiObjectDetailsSetType getObjectDetails()

May change in the future.

setObjectDetails

@Experimental
public void setObjectDetails(GuiObjectDetailsSetType objectDetails)

findObjectDetailsConfiguration

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

findObjectDetailsConfiguration

public <O extends ObjectType> GuiObjectDetailsPageType findObjectDetailsConfiguration(QName typeQName)

findResourceDetailsConfiguration

public <O extends ObjectType> GuiResourceDetailsPageType findResourceDetailsConfiguration(String connectorOid)

findShadowDetailsConfiguration

public <O extends ObjectType> GuiShadowDetailsPageType findShadowDetailsConfiguration(ResourceShadowCoordinates coordinates)

getFeedbackMessagesHook

public FeedbackMessagesHookType getFeedbackMessagesHook()

setFeedbackMessagesHook

public void setFeedbackMessagesHook(FeedbackMessagesHookType feedbackMessagesHook)

getRoleManagement

public AdminGuiConfigurationRoleManagementType getRoleManagement()

setRoleManagement

public void setRoleManagement(AdminGuiConfigurationRoleManagementType roleManagement)

getApprovals

public AdminGuiApprovalsConfigurationType getApprovals()

setApprovals

public void setApprovals(AdminGuiApprovalsConfigurationType approvals)

isExpandRolesOnApprovalPreview

public Boolean isExpandRolesOnApprovalPreview()

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)

getJpegPhoto

public byte[] getJpegPhoto()

setJpegPhoto

public void setJpegPhoto(byte[] jpegPhoto)

getLocale

public Locale getLocale()

setLocale

public void setLocale(Locale locale)

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

@Experimental
public DashboardWidgetType findUserDashboardWidget(String widgetIdentifier)

getAccessRequest

public AccessRequestType getAccessRequest()

setAccessRequest

public void setAccessRequest(AccessRequestType accessRequest)

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

derivedFrom

public boolean derivedFrom(String oid)

Returns true if compiled profile is derived from provided OID

markInvalid

public void markInvalid()

isInvalid

public boolean isInvalid()

setDependencies

public void setDependencies(Set<String> value)

getDependencies

public Set<String> getDependencies()

getHomePage

public HomePageType getHomePage()

setHomePage

public void setHomePage(HomePageType homePage)

findPrincipalFocusDetailsPanel

public ContainerPanelConfigurationType findPrincipalFocusDetailsPanel(@NotNull
                                                                      @NotNull QName focusType,
                                                                      @NotNull
                                                                      @NotNull String panelType)