Package org.apache.syncope.client.console.panels

Class DirectoryPanel<T extends Serializable,W extends Serializable,DP extends DirectoryDataProvider<T>,E extends RestClient>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

org.apache.syncope.client.ui.commons.wizards.AbstractWizardMgtPanel<W>

org.apache.syncope.client.console.wizards.WizardMgtPanel<W>

org.apache.syncope.client.console.panels.DirectoryPanel<T,W,DP,E>

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IQueueRegion, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

Direct Known Subclasses:

AccessTokenDirectoryPanel, AMSessionDirectoryPanel, AnyDirectoryPanel, AnyStatusDirectoryPanel, AttrListDirectoryPanel, AttrRepoDirectoryPanel, AuthModuleDirectoryPanel, AuthProfileDirectoryPanel, AuthProfileItemDirectoryPanel, BpmnProcessDirectoryPanel, ClientAppDirectoryPanel, CommandComposeDirectoryPanel, CommandDirectoryPanel, ConnectorDirectoryPanel, ConnidLocations, DelegationDirectoryPanel, DomainDirectoryPanel, DynRealmDirectoryPanel, ExecutionsDirectoryPanel, FIQLQueryDirectoryPanel, ImplementationDirectoryPanel, JobWidget.AvailableJobsPanel, MailTemplateDirectoryPanel, MergeLinkedAccountsResourcesPanel.ResourceSelectionDirectoryPanel, MergeLinkedAccountsReviewPanel.LinkedAccountsReviewDirectoryPanel, NetworkServiceDirectoryPanel, NotificationDirectoryPanel, OIDCProvidersDirectoryPanel, ParametersDirectoryPanel, PolicyDirectoryPanel, PolicyRuleDirectoryPanel, RemediationDirectoryPanel, ReportDirectoryPanel, ResourceDirectoryPanel, ResourceStatusDirectoryPanel, RoleDirectoryPanel, SAML2IdPEntityDirectoryPanel, SAML2IdPsDirectoryPanel, SecurityQuestionsPanel, SRARouteDirectoryPanel, TaskDirectoryPanel, TypeExtensionDirectoryPanel, TypesDirectoryPanel, UserRequestDirectoryPanel, UserRequestFormDirectoryPanel

public abstract class DirectoryPanel<T extends Serializable,W extends Serializable,DP extends DirectoryDataProvider<T>,E extends RestClient>
extends WizardMgtPanel<W>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DirectoryPanel.Builder<T extends Serializable,W extends Serializable,E extends RestClient>
static class	DirectoryPanel.EventDataWrapper

Nested classes/interfaces inherited from class org.apache.syncope.client.console.wizards.WizardMgtPanel

WizardMgtPanel.ExitEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected final ActionLinksTogglePanel<T>	actionTogglePanel
protected final BaseModal<W>	altDefaultModal
protected final WebMarkupContainer	container	Container used to refresh table.
protected DP	dataProvider	Data provider used to search for entities.
protected final BaseModal<W>	displayAttributeModal
protected final boolean	filtered	Specify if results are about a filtered search or not.
protected String	itemKeyFieldName
protected static final Logger	LOG
protected static final com.fasterxml.jackson.databind.json.JsonMapper	MAPPER
protected final BasePage	page	Owner page.
protected E	restClient
protected AjaxDataTablePanel<T,String>	resultTable	Result table.
protected Integer	rows	Number of rows per page.

Fields inherited from class org.apache.syncope.client.console.wizards.WizardMgtPanel

actualId, addAjaxLink, footerVisibility, initialFragment, modal, newItemPanelBuilder, notificationPanel, pageRef, showResultPanel, utilityAjaxLink, utilityIcon, wizardInModal

Fields inherited from class org.apache.syncope.client.ui.commons.wizards.AbstractWizardMgtPanel

WIZARD_ID

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS

Constructor Summary

Constructors

Modifier	Constructor	Description
	DirectoryPanel(String id, E restClient, PageReference pageRef)	Create simple unfiltered search result panel.
	DirectoryPanel(String id, E restClient, PageReference pageRef, boolean wizardInModal)
	DirectoryPanel(String id, E restClient, PageReference pageRef, boolean showPaginator, boolean wizardInModal)
protected	DirectoryPanel(String id, DirectoryPanel.Builder<T,W,E> builder)
protected	DirectoryPanel(String id, DirectoryPanel.Builder<T,W,E> builder, boolean wizardInModal)

Method Summary

Modifier and Type	Method	Description
protected ActionLinksTogglePanel<T>	actionTogglePanel()
protected void	customActionOnFinishCallback(AjaxRequestTarget target)	Custom action to perform on close callback on finish event.
protected abstract DP	dataProvider()
DirectoryPanel<T,W,DP,E>	disableCheckBoxes()
protected ActionsPanel<T>	getActions(IModel<T> model)
protected abstract Collection<ActionLink.ActionType>	getBatches()
protected abstract List<IColumn<T,String>>	getColumns()
protected ActionsPanel<Serializable>	getHeader(String componentId)
protected ActionLinksTogglePanel<T>	getTogglePanel()
protected void	initResultTable()
protected BiConsumer<AjaxRequestTarget,IModel<T>>	onDoubleClick()
void	onEvent(IEvent<?> event)
protected abstract String	paginatorRowsKey()
protected void	resultTableCustomChanges(AjaxDataTablePanel.Builder<T,String> resultTableBuilder)	Called before build.
void	search(AjaxRequestTarget target)
protected void	updateResultTable(boolean create)
protected void	updateResultTable(boolean create, int rows)
void	updateResultTable(AjaxRequestTarget target)

Methods inherited from class org.apache.syncope.client.console.wizards.WizardMgtPanel

addInnerObject, addNewItemPanelBuilder, addNotificationPanel, addOrReplaceInnerObject, addOuterObject, customActionCallback, customActionOnCancelCallback, customResultBody, disableContainerAutoRefresh, enableUtilityButton, getActualId, isReadOnly, setFooterVisibility, setPageRef, setReadOnly, setShowResultPanel, setWindowClosedReloadCallback

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

getRegionMarkup, newMarkupSourcingStrategy

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMarkupTag, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.event.IEventSource

send

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

LOG

protected static final Logger LOG

MAPPER

protected static final com.fasterxml.jackson.databind.json.JsonMapper MAPPER

restClient

protected E extends RestClient restClient

rows

protected Integer rows

Number of rows per page.

container

protected final WebMarkupContainer container

Container used to refresh table.

filtered

protected final boolean filtered

Specify if results are about a filtered search or not. Using this attribute it is possible to use this panel to show results about entity list and search.

resultTable

protected AjaxDataTablePanel<T extends Serializable,String> resultTable

Result table.

dataProvider

protected DP extends DirectoryDataProvider<T> dataProvider

Data provider used to search for entities.

page

protected final BasePage page

Owner page.

itemKeyFieldName

protected String itemKeyFieldName

altDefaultModal

protected final BaseModal<W extends Serializable> altDefaultModal

displayAttributeModal

protected final BaseModal<W extends Serializable> displayAttributeModal

actionTogglePanel

protected final ActionLinksTogglePanel<T extends Serializable> actionTogglePanel

Constructor Details

DirectoryPanel

public DirectoryPanel(String id,
 E restClient,
 PageReference pageRef)

Create simple unfiltered search result panel. Use the available builder for powerful configuration options.

Parameters:

id - panel id.

restClient - REST client

pageRef - page reference.

DirectoryPanel

public DirectoryPanel(String id,
 E restClient,
 PageReference pageRef,
 boolean wizardInModal)

DirectoryPanel

public DirectoryPanel(String id,
 E restClient,
 PageReference pageRef,
 boolean showPaginator,
 boolean wizardInModal)

DirectoryPanel

protected DirectoryPanel(String id,
 DirectoryPanel.Builder<T,W,E> builder)

DirectoryPanel

protected DirectoryPanel(String id,
 DirectoryPanel.Builder<T,W,E> builder,
 boolean wizardInModal)

Method Details

dataProvider

protected abstract DP dataProvider()

paginatorRowsKey

protected abstract String paginatorRowsKey()

getColumns

protected abstract List<IColumn<T,String>> getColumns()

initResultTable

protected void initResultTable()

getHeader

protected ActionsPanel<Serializable> getHeader(String componentId)

search

public void search(AjaxRequestTarget target)

updateResultTable

public void updateResultTable(AjaxRequestTarget target)

updateResultTable

protected void updateResultTable(boolean create)

updateResultTable

protected void updateResultTable(boolean create,
 int rows)

resultTableCustomChanges

protected void resultTableCustomChanges(AjaxDataTablePanel.Builder<T,String> resultTableBuilder)

Called before build. Override it to customize result table.

Parameters:

resultTableBuilder - result table builder.

disableCheckBoxes

public DirectoryPanel<T,W,DP,E> disableCheckBoxes()

onEvent

public void onEvent(IEvent<?> event)

Specified by:

onEvent in interface IEventSink

Overrides:

onEvent in class WizardMgtPanel<W extends Serializable>

customActionOnFinishCallback

protected void customActionOnFinishCallback(AjaxRequestTarget target)

Description copied from class: WizardMgtPanel

Custom action to perform on close callback on finish event.

Overrides:

customActionOnFinishCallback in class WizardMgtPanel<W extends Serializable>

Parameters:

target - Ajax request target.

getActions

protected ActionsPanel<T> getActions(IModel<T> model)

actionTogglePanel

protected ActionLinksTogglePanel<T> actionTogglePanel()

getTogglePanel

protected ActionLinksTogglePanel<T> getTogglePanel()

onDoubleClick

protected BiConsumer<AjaxRequestTarget,IModel<T>> onDoubleClick()

getBatches

protected abstract Collection<ActionLink.ActionType> getBatches()