Java tutorial
/* * Copyright (c) 2010-2013 Evolveum * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.evolveum.midpoint.web.page; import com.evolveum.midpoint.common.configuration.api.MidpointConfiguration; import com.evolveum.midpoint.common.validator.EventHandler; import com.evolveum.midpoint.common.validator.EventResult; import com.evolveum.midpoint.common.validator.Validator; import com.evolveum.midpoint.model.api.ModelDiagnosticService; import com.evolveum.midpoint.model.api.ModelInteractionService; import com.evolveum.midpoint.model.api.ModelService; import com.evolveum.midpoint.model.api.TaskService; import com.evolveum.midpoint.prism.Objectable; import com.evolveum.midpoint.prism.PrismContext; import com.evolveum.midpoint.prism.PrismObject; import com.evolveum.midpoint.report.api.ReportManager; import com.evolveum.midpoint.schema.constants.SchemaConstants; import com.evolveum.midpoint.schema.result.OperationResult; import com.evolveum.midpoint.security.api.MidPointPrincipal; import com.evolveum.midpoint.security.api.SecurityEnforcer; import com.evolveum.midpoint.task.api.Task; import com.evolveum.midpoint.task.api.TaskManager; import com.evolveum.midpoint.util.Holder; import com.evolveum.midpoint.util.logging.LoggingUtils; import com.evolveum.midpoint.util.logging.Trace; import com.evolveum.midpoint.util.logging.TraceManager; import com.evolveum.midpoint.web.component.AjaxButton; import com.evolveum.midpoint.web.component.atmosphere.NotifyMessage; import com.evolveum.midpoint.web.component.atmosphere.NotifyMessageFilter; import com.evolveum.midpoint.web.component.menu.top.MenuBarItem; import com.evolveum.midpoint.web.component.menu.top.TopMenuBar; import com.evolveum.midpoint.web.component.message.MainFeedback; import com.evolveum.midpoint.web.component.message.OpResult; import com.evolveum.midpoint.web.component.message.TempFeedback; import com.evolveum.midpoint.web.component.util.VisibleEnableBehaviour; import com.evolveum.midpoint.web.security.MidPointApplication; import com.evolveum.midpoint.web.security.MidPointAuthWebSession; import com.evolveum.midpoint.web.security.SecurityUtils; import com.evolveum.midpoint.web.session.SessionStorage; import com.evolveum.midpoint.wf.api.WorkflowManager; import com.evolveum.midpoint.xml.ns._public.common.common_3.UserType; import org.apache.commons.lang.StringUtils; import org.apache.commons.lang.Validate; import org.apache.wicket.Component; import org.apache.wicket.Page; import org.apache.wicket.RestartResponseException; import org.apache.wicket.RuntimeConfigurationType; import org.apache.wicket.ajax.AbstractDefaultAjaxBehavior; import org.apache.wicket.ajax.AjaxRequestTarget; import org.apache.wicket.atmosphere.Subscribe; import org.apache.wicket.devutils.debugbar.DebugBar; import org.apache.wicket.extensions.ajax.markup.html.modal.ModalWindow; import org.apache.wicket.feedback.FeedbackMessage; import org.apache.wicket.feedback.FeedbackMessages; import org.apache.wicket.injection.Injector; import org.apache.wicket.markup.head.IHeaderResponse; import org.apache.wicket.markup.head.JavaScriptHeaderItem; import org.apache.wicket.markup.head.OnDomReadyHeaderItem; import org.apache.wicket.markup.html.WebMarkupContainer; import org.apache.wicket.markup.html.WebPage; import org.apache.wicket.markup.html.basic.Label; import org.apache.wicket.model.IModel; import org.apache.wicket.model.Model; import org.apache.wicket.model.StringResourceModel; import org.apache.wicket.request.mapper.parameter.PageParameters; import org.apache.wicket.resource.CoreLibrariesContributor; import org.apache.wicket.spring.injection.annot.SpringBean; import org.w3c.dom.Element; import org.w3c.dom.Node; import javax.management.MBeanServer; import javax.management.MBeanServerFactory; import javax.management.ObjectName; import java.util.ArrayList; import java.util.Iterator; import java.util.List; /** * @author lazyman */ public abstract class PageBase extends WebPage { private static final Trace LOGGER = TraceManager.getTrace(PageBase.class); private static final String ID_TITLE = "title"; private static final String ID_PAGE_TITLE_CONTAINER = "pageTitleContainer"; private static final String ID_PAGE_TITLE_REAL = "pageTitleReal"; private static final String ID_PAGE_TITLE = "pageTitle"; private static final String ID_PAGE_SUBTITLE = "pageSubtitle"; private static final String ID_DEBUG_PANEL = "debugPanel"; private static final String ID_TOP_MENU = "topMenu"; private static final String ID_VERSION = "version"; private static final String ID_FEEDBACK_CONTAINER = "feedbackContainer"; private static final String ID_FEEDBACK = "feedback"; private static final String ID_TEMP_FEEDBACK = "tempFeedback"; private static final String ID_DEBUG_BAR = "debugBar"; private static final String ID_CLEAR_CACHE = "clearCssCache"; @SpringBean(name = "modelController") private ModelService modelService; @SpringBean(name = "modelController") private ModelInteractionService modelInteractionService; @SpringBean(name = "modelController") private TaskService taskService; @SpringBean(name = "modelDiagController") private ModelDiagnosticService modelDiagnosticService; @SpringBean(name = "taskManager") private TaskManager taskManager; @SpringBean(name = "workflowManager") private WorkflowManager workflowManager; @SpringBean(name = "midpointConfiguration") private MidpointConfiguration midpointConfiguration; @SpringBean(name = "reportManager") private ReportManager reportManager; @SpringBean(name = "accessDecisionManager") private SecurityEnforcer securityEnforcer; private PageBase previousPage; // experimental -- where to return e.g. when 'Back' button is clicked [NOT a class, in order to eliminate reinitialization when it is not needed] private boolean reinitializePreviousPages; // experimental -- should we reinitialize all the chain of previous pages? public PageBase(PageParameters parameters) { super(parameters); Injector.get().inject(this); Validate.notNull(modelService, "Model service was not injected."); Validate.notNull(taskManager, "Task manager was not injected."); Validate.notNull(reportManager, "Report manager was not injected."); initLayout(); } public PageBase() { this(null); } @Override public void renderHead(IHeaderResponse response) { super.renderHead(response); //this attaches jquery.js as first header item, which is used in our scripts. CoreLibrariesContributor.contribute(getApplication(), response); response.render(OnDomReadyHeaderItem.forScript("updateBodyTopPadding()")); } @Override protected void onAfterRender() { super.onAfterRender(); //we try to remove messages (and operation results) that were stored in session, but only //if all session messages were already rendered. boolean allRendered = true; FeedbackMessages messages = getSession().getFeedbackMessages(); Iterator<FeedbackMessage> iterator = messages.iterator(); while (iterator.hasNext()) { FeedbackMessage message = iterator.next(); if (!message.isRendered()) { allRendered = false; break; } } if (getSession().getFeedbackMessages().size() > 0 && allRendered) { getSession().getFeedbackMessages().clear(); } } private void initLayout() { Label title = new Label(ID_TITLE, createPageTitleModel()); title.setRenderBodyOnly(true); add(title); DebugBar debugPanel = new DebugBar(ID_DEBUG_PANEL); add(debugPanel); TopMenuBar topMenu = new TopMenuBar(ID_TOP_MENU, createMenuItems()); add(topMenu); WebMarkupContainer version = new WebMarkupContainer(ID_VERSION) { @Deprecated public String getDescribe() { return PageBase.this.getDescribe(); } }; version.add(new VisibleEnableBehaviour() { @Override public boolean isVisible() { return RuntimeConfigurationType.DEVELOPMENT.equals(getApplication().getConfigurationType()); } }); add(version); WebMarkupContainer pageTitleContainer = new WebMarkupContainer(ID_PAGE_TITLE_CONTAINER); pageTitleContainer.add(new VisibleEnableBehaviour() { @Override public boolean isVisible() { return StringUtils.isNotEmpty(createPageTitleModel().getObject()); } }); add(pageTitleContainer); WebMarkupContainer pageTitle = new WebMarkupContainer(ID_PAGE_TITLE); pageTitleContainer.add(pageTitle); Label pageTitleReal = new Label(ID_PAGE_TITLE_REAL, createPageTitleModel()); pageTitleReal.setRenderBodyOnly(true); pageTitle.add(pageTitleReal); pageTitle.add(new Label(ID_PAGE_SUBTITLE, createPageSubTitleModel())); WebMarkupContainer feedbackContainer = new WebMarkupContainer(ID_FEEDBACK_CONTAINER); feedbackContainer.setOutputMarkupId(true); add(feedbackContainer); MainFeedback feedback = new MainFeedback(ID_FEEDBACK); feedbackContainer.add(feedback); TempFeedback tempFeedback = new TempFeedback(ID_TEMP_FEEDBACK); feedbackContainer.add(tempFeedback); initDebugBar(); } private void initDebugBar() { WebMarkupContainer debugBar = new WebMarkupContainer(ID_DEBUG_BAR); debugBar.add(new VisibleEnableBehaviour() { @Override public boolean isVisible() { RuntimeConfigurationType runtime = getApplication().getConfigurationType(); return RuntimeConfigurationType.DEVELOPMENT.equals(runtime); } }); add(debugBar); AjaxButton clearCache = new AjaxButton(ID_CLEAR_CACHE, createStringResource("PageBase.clearCssCache")) { @Override public void onClick(AjaxRequestTarget target) { clearLessJsCache(target); } }; debugBar.add(clearCache); } protected void clearLessJsCache(AjaxRequestTarget target) { try { ArrayList<MBeanServer> servers = MBeanServerFactory.findMBeanServer(null); if (servers.size() > 1) { LOGGER.info("Too many mbean servers, cache won't be cleared."); for (MBeanServer server : servers) { LOGGER.info(server.getDefaultDomain()); } return; } MBeanServer server = servers.get(0); ObjectName objectName = ObjectName.getInstance("wro4j-idm:type=WroConfiguration"); server.invoke(objectName, "reloadCache", new Object[] {}, new String[] {}); if (target != null) { target.add(PageBase.this); } } catch (Exception ex) { LoggingUtils.logException(LOGGER, "Couldn't clear less/js cache", ex); error("Error occurred, reason: " + ex.getMessage()); if (target != null) { target.add(getFeedbackPanel()); } } } protected TopMenuBar getTopMenuBar() { return (TopMenuBar) get(ID_TOP_MENU); } protected List<MenuBarItem> createMenuItems() { return new ArrayList<>(); } public WebMarkupContainer getFeedbackPanel() { return (WebMarkupContainer) get(ID_FEEDBACK_CONTAINER); } public SessionStorage getSessionStorage() { MidPointAuthWebSession session = (MidPointAuthWebSession) getSession(); return session.getSessionStorage(); } public MidPointApplication getMidpointApplication() { return (MidPointApplication) getApplication(); } public PrismContext getPrismContext() { return getMidpointApplication().getPrismContext(); } protected TaskManager getTaskManager() { return taskManager; } protected WorkflowManager getWorkflowManager() { return workflowManager; } protected IModel<String> createPageSubTitleModel() { return new StringResourceModel("page.subTitle", this, new Model<String>(), ""); } protected IModel<String> createPageTitleModel() { return createStringResource("page.title"); } public ReportManager getReportManager() { return reportManager; } public ModelService getModelService() { return modelService; } public TaskService getTaskService() { return taskService; } public SecurityEnforcer getSecurityEnforcer() { return securityEnforcer; } public ModelInteractionService getModelInteractionService() { return modelInteractionService; } protected ModelDiagnosticService getModelDiagnosticService() { return modelDiagnosticService; } public String getString(String resourceKey, Object... objects) { return createStringResource(resourceKey, objects).getString(); } public StringResourceModel createStringResource(String resourceKey, Object... objects) { return new StringResourceModel(resourceKey, this, new Model<String>(), resourceKey, objects); } public StringResourceModel createStringResource(Enum e) { String resourceKey = e.getDeclaringClass().getSimpleName() + "." + e.name(); return createStringResource(resourceKey); } public static StringResourceModel createStringResourceStatic(Component component, String resourceKey, Object... objects) { return new StringResourceModel(resourceKey, component, new Model<String>(), resourceKey, objects); } public static StringResourceModel createStringResourceStatic(Component component, Enum e) { String resourceKey = e.getDeclaringClass().getSimpleName() + "." + e.name(); return createStringResourceStatic(component, resourceKey); } public Task createSimpleTask(String operation, PrismObject<UserType> owner) { TaskManager manager = getTaskManager(); Task task = manager.createTaskInstance(operation); if (owner == null) { MidPointPrincipal user = SecurityUtils.getPrincipalUser(); if (user == null) { return task; } else { owner = user.getUser().asPrismObject(); } } task.setOwner(owner); task.setChannel(SchemaConstants.CHANNEL_GUI_USER_URI); return task; } public Task createSimpleTask(String operation) { MidPointPrincipal user = SecurityUtils.getPrincipalUser(); return createSimpleTask(operation, user != null ? user.getUser().asPrismObject() : null); } public void showResult(OperationResult result) { if (result == null) { return; } OpResult opResult = new OpResult(result); showResult(opResult, false); } public void showResultInSession(OperationResult result) { if (result == null) { return; } OpResult opResult = new OpResult(result); showResult(opResult, true); } private void showResult(OpResult opResult, boolean showInSession) { Validate.notNull(opResult, "Operation result must not be null."); Validate.notNull(opResult.getStatus(), "Operation result status must not be null."); switch (opResult.getStatus()) { case FATAL_ERROR: case PARTIAL_ERROR: if (showInSession) { getSession().error(opResult); } else { error(opResult); } break; case IN_PROGRESS: case NOT_APPLICABLE: if (showInSession) { getSession().info(opResult); } else { info(opResult); } break; case SUCCESS: if (showInSession) { getSession().success(opResult); } else { success(opResult); } break; case UNKNOWN: case WARNING: default: if (showInSession) { getSession().warn(opResult); } else { warn(opResult); } } } protected String createComponentPath(String... components) { return StringUtils.join(components, ":"); } /** * It's here only because of some IDEs - it's not properly filtering resources during maven build. * "describe" variable is not replaced. * * @return "unknown" instead of "git describe" for current build. */ @Deprecated public String getDescribe() { return getString("pageBase.unknownBuildNumber"); } public MidpointConfiguration getMidpointConfiguration() { return midpointConfiguration; } protected ModalWindow createModalWindow(final String id, IModel<String> title, int width, int height) { final ModalWindow modal = new ModalWindow(id); add(modal); modal.setResizable(false); modal.setTitle(title); modal.setCookieName(PageBase.class.getSimpleName() + ((int) (Math.random() * 100))); modal.setInitialWidth(width); modal.setWidthUnit("px"); modal.setInitialHeight(height); modal.setHeightUnit("px"); modal.setCloseButtonCallback(new ModalWindow.CloseButtonCallback() { @Override public boolean onCloseButtonClicked(AjaxRequestTarget target) { return true; } }); modal.setWindowClosedCallback(new ModalWindow.WindowClosedCallback() { @Override public void onClose(AjaxRequestTarget target) { modal.close(target); } }); modal.add(new AbstractDefaultAjaxBehavior() { @Override public void renderHead(Component component, IHeaderResponse response) { response.render(OnDomReadyHeaderItem.forScript("Wicket.Window.unloadConfirmation = false;")); response.render(JavaScriptHeaderItem.forScript( "$(document).ready(function() {\n" + " $(document).bind('keyup', function(evt) {\n" + " if (evt.keyCode == 27) {\n" + getCallbackScript() + "\n" + " evt.preventDefault();\n" + " }\n" + " });\n" + "});", id)); } @Override protected void respond(AjaxRequestTarget target) { modal.close(target); } }); return modal; } public boolean isReinitializePreviousPages() { return reinitializePreviousPages; } public void setReinitializePreviousPages(boolean reinitializePreviousPages) { this.reinitializePreviousPages = reinitializePreviousPages; } public PageBase getPreviousPage() { return previousPage; } public void setPreviousPage(PageBase previousPage) { this.previousPage = previousPage; } // experimental -- all pages should know how to reinitialize themselves (most hardcore way is to construct a new instance of themselves) public PageBase reinitialize() { // by default there is nothing to do -- our pages have to know how to reinitialize themselves LOGGER.trace("Default no-op implementation of reinitialize() called."); return this; } // experimental -- go to previous page (either with reinitialization e.g. when something changed, or without - typically when 'back' button is pressed) protected void goBack(Class<? extends Page> defaultBackPageClass) { LOGGER.trace("goBack called; page = {}, previousPage = {}, reinitializePreviousPages = {}", new Object[] { this, previousPage, reinitializePreviousPages }); if (previousPage != null) { setResponsePage(getPreviousPageToGoTo()); } else { LOGGER.trace("...going to default back page {}", defaultBackPageClass); setResponsePage(defaultBackPageClass); } } // returns previous page ready to go to (i.e. reinitialized, if necessary) public PageBase getPreviousPageToGoTo() { if (previousPage == null) { return null; } if (isReinitializePreviousPages()) { LOGGER.trace("...calling reinitialize on previousPage ({})", previousPage); previousPage.setReinitializePreviousPages(true); // we set this flag on the original previous page... PageBase reinitialized = previousPage.reinitialize(); reinitialized.setReinitializePreviousPages(true); // ...but on the returned value, as it is probably different object return reinitialized; } else { return previousPage; } } // returns to previous page via restart response exception public RestartResponseException getRestartResponseException(Class<? extends Page> defaultBackPageClass) { LOGGER.trace( "getRestartResponseException called; page = {}, previousPage = {}, reinitializePreviousPages = {}", new Object[] { this, previousPage, reinitializePreviousPages }); if (previousPage != null) { return new RestartResponseException(getPreviousPageToGoTo()); } else { LOGGER.trace("...going to default back page {}", defaultBackPageClass); return new RestartResponseException(defaultBackPageClass); } } protected <P extends Object> void validateObject(String xmlObject, final Holder<P> objectHolder, boolean validateSchema, OperationResult result) { EventHandler handler = new EventHandler() { @Override public EventResult preMarshall(Element objectElement, Node postValidationTree, OperationResult objectResult) { return EventResult.cont(); } @Override public <T extends Objectable> EventResult postMarshall(PrismObject<T> object, Element objectElement, OperationResult objectResult) { objectHolder.setValue((P) object); return EventResult.cont(); } @Override public void handleGlobalError(OperationResult currentResult) { } }; Validator validator = new Validator(getPrismContext(), handler); validator.setVerbose(true); validator.setValidateSchema(validateSchema); validator.validateObject(xmlObject, result); result.computeStatus(); } @Subscribe(filter = NotifyMessageFilter.class) public void receiveNotifyMessage(AjaxRequestTarget target, NotifyMessage message) { LOGGER.trace("Received notify message {}.", new Object[] { message }); StringBuilder sb = new StringBuilder(); sb.append("$.pnotify({\n"); sb.append("\ttitle: '").append(createStringResource(message.getTitle()).getString()).append("',\n"); sb.append("\ttext: '").append(createStringResource(message.getMessage()).getString()).append("',\n"); sb.append("\ttype: '").append(message.getMessageType().name().toLowerCase()).append("',\n"); sb.append("\topacity: .8,\n"); sb.append("\ticon: '").append(message.getIcon()).append("'\n"); sb.append("});"); target.appendJavaScript(sb.toString()); } }