• Home
• org.ow2.bonita
• bonita-server
• 5.10.2
• source code
• WebAPIImpl.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.ow2.bonita.facade.impl.WebAPIImpl Maven / Gradle / Ivy

/**
 * Copyright (C) 2009-2013 BonitaSoft S.A.
 * BonitaSoft, 31 rue Gustave Eiffel - 38000 Grenoble
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation
 * version 2.1 of the License.
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA  02110-1301, USA.
 **/
package org.ow2.bonita.facade.impl;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

import org.ow2.bonita.connector.core.Connector;
import org.ow2.bonita.connector.core.Mapper;
import org.ow2.bonita.definition.activity.ConnectorExecutor;
import org.ow2.bonita.facade.WebAPI;
import org.ow2.bonita.facade.def.InternalProcessDefinition;
import org.ow2.bonita.facade.def.majorElement.ProcessDefinition;
import org.ow2.bonita.facade.exception.CategoryAlreadyExistsException;
import org.ow2.bonita.facade.exception.CategoryNotFoundException;
import org.ow2.bonita.facade.exception.DocumentAlreadyExistsException;
import org.ow2.bonita.facade.exception.DocumentationCreationException;
import org.ow2.bonita.facade.exception.ProcessNotFoundException;
import org.ow2.bonita.facade.runtime.ActivityInstance;
import org.ow2.bonita.facade.runtime.Category;
import org.ow2.bonita.facade.runtime.Document;
import org.ow2.bonita.facade.runtime.Label;
import org.ow2.bonita.facade.runtime.WebTemporaryToken;
import org.ow2.bonita.facade.runtime.impl.CaseImpl;
import org.ow2.bonita.facade.runtime.impl.CategoryImpl;
import org.ow2.bonita.facade.runtime.impl.InternalProcessInstance;
import org.ow2.bonita.facade.runtime.impl.LabelImpl;
import org.ow2.bonita.facade.runtime.impl.WebTemporaryTokenImpl;
import org.ow2.bonita.facade.uuid.CategoryUUID;
import org.ow2.bonita.facade.uuid.ProcessDefinitionUUID;
import org.ow2.bonita.facade.uuid.ProcessInstanceUUID;
import org.ow2.bonita.light.LightProcessDefinition;
import org.ow2.bonita.light.LightProcessInstance;
import org.ow2.bonita.light.impl.LightProcessDefinitionImpl;
import org.ow2.bonita.light.impl.LightProcessInstanceImpl;
import org.ow2.bonita.services.DocumentationManager;
import org.ow2.bonita.services.WebService;
import org.ow2.bonita.services.WebTokenManagementService;
import org.ow2.bonita.util.BonitaConstants;
import org.ow2.bonita.util.DocumentService;
import org.ow2.bonita.util.EnvTool;
import org.ow2.bonita.util.Misc;

/**
 * @author Charles Souillard, Matthieu Chaffotte, Nicolas Chabanoles, Christophe
 *         Leroy
 */
public class WebAPIImpl implements WebAPI {

  protected WebAPIImpl(final String queryList) {
  }

  @Override
  public void deletePhantomCases() {
    final Set webCases = EnvTool.getWebService().getAllCases();
    final Set runtimeCases = EnvTool.getAllQueriers().getParentInstancesUUIDs();

    webCases.removeAll(runtimeCases);
    if (!webCases.isEmpty()) {
      EnvTool.getWebService().deleteCases(webCases);
    }
  }

  @Override
  public void addLabel(final String labelName, final String ownerName, final String editableCSSStyleName,
      final String readonlyCSSStyleName, final String previewCSSStyleName, final boolean isVisible,
      final boolean hasToBeDisplayed, final String iconCSSStyle, final Set caseList,
      final int displayOrder, final boolean isSystemLabel) {
    final WebService webService = EnvTool.getWebService();
    final LabelImpl label = new LabelImpl(labelName, ownerName, editableCSSStyleName, readonlyCSSStyleName,
        previewCSSStyleName, isVisible, hasToBeDisplayed, iconCSSStyle, displayOrder, isSystemLabel);
    webService.addLabel(label);

    addCasesToLabel(ownerName, labelName, caseList);
  }

  @Override
  public void removeLabel(final String ownerName, final String labelName) {
    EnvTool.getWebService().removeLabel(ownerName, labelName);
  }

  @Override
  public void removeCasesFromLabel(final String ownerName, final String labelName,
      final Set caseList) {
    final Set instances = EnvTool.getAllQueriers().getProcessInstances(caseList);
    final WebService webService = EnvTool.getWebService();
    for (final InternalProcessInstance parentNewOrUpdatedInstance : instances) {
      webService.removeCase(parentNewOrUpdatedInstance.getUUID(), ownerName, labelName);
    }
    EnvTool.getWebService().removeCasesFromLabel(ownerName, labelName, caseList);
  }

  @Override
  public void deleteAllCases() {
    EnvTool.getWebService().deleteAllCases();
  }

  @Override
  public void updateLabelCSS(final String ownerName, final String labelName, final String aEditableCSSStyle,
      final String aPreviewCSSStyle, final String aReadOnlyCSSStyle) {
    final LabelImpl label = EnvTool.getWebService().getLabel(ownerName, labelName);
    label.setEditableCSSStyleName(aEditableCSSStyle);
    label.setPreviewCSSStyleName(aPreviewCSSStyle);
    label.setReadonlyCSSStyleName(aReadOnlyCSSStyle);
  }

  @Override
  public void addCasesToLabel(final String ownerName, final String labelName, final Set caseList) {
    final Set instances = EnvTool.getAllQueriers().getProcessInstances(caseList);
    final WebService webService = EnvTool.getWebService();
    for (final InternalProcessInstance internalProcessInstance : instances) {
      if (webService.getCase(internalProcessInstance.getUUID(), ownerName, labelName) == null) {
        webService.addCase(new CaseImpl(internalProcessInstance.getUUID(), ownerName, labelName));
      }
    }
  }

  @Override
  public Label getLabel(final String ownerName, final String labelName) {
    final LabelImpl label = EnvTool.getWebService().getLabel(ownerName, labelName);
    if (label == null) {
      return null;
    }
    return new LabelImpl(label);
  }

  @Override
  public Set getLabels(final String ownerName) {
    final Set labels = EnvTool.getWebService().getLabels(ownerName);
    return getCopy(labels);
  }

  @Override
  public List getSystemLabels(final String ownerName) {
    final List labels = EnvTool.getWebService().getSystemLabels(ownerName);
    return getCopy(labels);
  }

  @Override
  public List getUserCustomLabels(final String ownerName) {
    final List labels = EnvTool.getWebService().getUserCustomLabels(ownerName);
    return getCopy(labels);
  }

  @Override
  public Set getCaseLabels(final String ownerName, final ProcessInstanceUUID case_) {
    final Set labels = EnvTool.getWebService().getCaseLabels(ownerName, case_);
    return getCopy(labels);
  }

  @Override
  public Map> getCasesLabels(final String ownerName,
      final Set cases) {
    if (cases == null || cases.isEmpty()) {
      return Collections.emptyMap();
    }
    final Map> result = new HashMap>();
    for (final ProcessInstanceUUID case_ : cases) {
      result.put(case_, getCaseLabels(ownerName, case_));
    }
    return result;
  }

  @Override
  public void removeAllCasesFromLabels(final Set caseList) {
    if (caseList != null && !caseList.isEmpty()) {
      final WebService webService = EnvTool.getWebService();
      for (final ProcessInstanceUUID case_ : caseList) {
        webService.removeCase(case_);
      }
    }
  }

  @Override
  public Set getCases(final String ownerName, final Set labels) {
    if (ownerName != null && labels != null && !labels.isEmpty()) {
      final WebService webService = EnvTool.getWebService();
      final Set cases = webService.getCases(ownerName, labels);
      if (cases == null) {
        return Collections.emptySet();
      }
      final Set result = new HashSet();
      for (final ProcessInstanceUUID instanceUUID : cases) {
        result.add(new ProcessInstanceUUID(instanceUUID));
      }
      return result;
    }
    return Collections.emptySet();
  }

  @Override
  public List getLightProcessInstances(final String ownerName, final Set theLabelsName,
      final int fromIndex, final int pageSize) {
    if (ownerName == null || theLabelsName == null || theLabelsName.isEmpty()) {
      return Collections.emptyList();
    }

    final List caseUUIDs = EnvTool.getWebService().getLabelsCaseUUIDs(ownerName, theLabelsName,
        fromIndex, pageSize);
    final Set internalList = EnvTool.getAllQueriers().getProcessInstances(caseUUIDs);

    if (internalList == null || internalList.isEmpty()) {
      return Collections.emptyList();
    }
    final Comparator comparator = new Comparator() {
      @Override
      public int compare(final InternalProcessInstance o1, final InternalProcessInstance o2) {
        return o2.getLastUpdate().compareTo(o1.getLastUpdate());
      }
    };
    final List sortedInstances = new ArrayList(internalList);
    Collections.sort(sortedInstances, comparator);

    final List list = new ArrayList();
    for (final InternalProcessInstance internalProcessInstance : sortedInstances) {
      list.add(new LightProcessInstanceImpl(internalProcessInstance));
    }
    return list;
  }

  @Override
  public Set getLabels(final String ownerName, final Set labelsName) {
    final Set labels = EnvTool.getWebService().getLabels(ownerName, labelsName);
    return getCopy(labels);
  }

  private Set getCopy(final Set labels) {
    if (labels == null || labels.isEmpty()) {
      return Collections.emptySet();
    }
    final Set result = new HashSet();
    for (final Label label : labels) {
      result.add(new LabelImpl(label));
    }
    return result;
  }

  private List getCopy(final List labels) {
    if (labels == null || labels.isEmpty()) {
      return Collections.emptyList();
    }
    final List result = new ArrayList();
    for (final Label label : labels) {
      result.add(new LabelImpl(label));
    }
    return result;
  }

  @Override
  public void removeLabels(final String ownerName, final Collection labelNames) {
    for (final String labelName : labelNames) {
      removeLabel(ownerName, labelName);
    }
  }

  @Override
  public void updateLabelName(final String ownerName, final String labelName, final String newName) {
    EnvTool.getWebService().updateLabelName(ownerName, labelName, newName);
  }

  @Override
  public void updateLabelVisibility(final String ownerName, final String labelName, final boolean isVisible) {
    final LabelImpl label = EnvTool.getWebService().getLabel(ownerName, labelName);
    label.setVisible(isVisible);
  }

  @Override
  public void updateLabelVisibility(final String ownerName, final Map labelvisibilities) {
    for (final Entry labelVisibility : labelvisibilities.entrySet()) {
      updateLabelVisibility(ownerName, labelVisibility.getKey(), labelVisibility.getValue());
    }
  }

  @Override
  public Map getCasesNumber(final String ownerName, final Collection labelNames,
      final int limit) {
    final Map result = new HashMap();
    final WebService webService = EnvTool.getWebService();
    for (final String label : labelNames) {
      int number = 0;
      if (limit <= BonitaConstants.MAX_LIST_SIZE) {
        final Set cases = webService.getCases(ownerName, label, limit + 1);
        number = cases.size();
        if (number > limit) {
          number = -limit;
        }
      } else {
        number = webService.getCasesNumber(ownerName, label);
      }
      result.put(label, number);
    }
    return result;
  }

  @Override
  public Map getCasesNumber(final String ownerName, final Collection labelNames) {
    final Map result = new HashMap();
    final WebService webService = EnvTool.getWebService();
    for (final String label : labelNames) {
      final int number = webService.getCasesNumber(ownerName, label);
      result.put(label, number);
    }
    return result;
  }

  @Override
  public Map getCasesNumber(final String ownerName, final String labelName,
      final Collection labelNames, final int limit) {
    final Map result = new HashMap();
    final WebService webService = EnvTool.getWebService();
    for (final String label : labelNames) {
      int number = 0;
      if (limit <= BonitaConstants.MAX_LIST_SIZE) {
        final Set cases = webService.getCases(ownerName, labelName, label, limit + 1);
        number = cases.size();
        if (number > limit) {
          number = -limit;
        }
      } else {
        number = webService.getCasesNumber(ownerName, labelName, label);
      }
      result.put(label, number);
    }
    return result;
  }

  @Override
  public String generateTemporaryToken(final String identityKey) {
    FacadeUtil.checkArgsNotNull(identityKey);
    if (identityKey.length() == 0) {
      throw new IllegalArgumentException();
    }
    final WebTokenManagementService webTokenManagementService = EnvTool.getWebTokenManagementService();
    final String tokenKey = Misc.getUniqueId("");
    // Token will expire in 1 hour.
    final long expirationDate = new Date().getTime() + 1000 * 60 * 60;
    final WebTemporaryTokenImpl temporaryToken = new WebTemporaryTokenImpl(tokenKey, expirationDate, identityKey);
    webTokenManagementService.addTemporaryToken(temporaryToken);
    return temporaryToken.getToken();
  }

  @Override
  public String getIdentityKeyFromTemporaryToken(final String token) {
    final WebTokenManagementService webTokenManagementService = EnvTool.getWebTokenManagementService();
    final WebTemporaryToken temporaryToken = webTokenManagementService.getToken(token);
    if (temporaryToken == null) {
      return null;
    }
    // Token can be used only once.
    webTokenManagementService.deleteToken((WebTemporaryTokenImpl) temporaryToken);

    return temporaryToken.getIdentityKey();
  }

  @Override
  public Set getAllCategories() {
    final Set categories = EnvTool.getJournalQueriers().getAllCategories();
    final Set result = new HashSet();
    for (final Category category : categories) {
      result.add(new CategoryImpl(category));
    }
    return result;
  }

  @Override
  public Set getCategories(final Set names) {
    final Set categories = EnvTool.getJournalQueriers().getCategories(names);
    final Set result = new HashSet();
    for (final Category category : categories) {
      result.add(new CategoryImpl(category));
    }
    return result;
  }

  @Override
  public void deleteCategoriesByUUIDs(final Set uuids) {
    final Set categories = EnvTool.getJournalQueriers().getCategoriesByUUIDs(uuids);
    EnvTool.getWebService().removeCategories(new HashSet(categories));
  }

  @Override
  public Set getCategoriesByUUIDs(final Set uuids) {
    final Set categories = EnvTool.getJournalQueriers().getCategoriesByUUIDs(uuids);
    final Set result = new HashSet();
    for (final Category category : categories) {
      result.add(new CategoryImpl(category));
    }
    return result;
  }

  @Override
  public void removeAllLabelsExcept(final Set labelNames) {
    final Set labels = EnvTool.getWebService().getLabelsByNameExcept(labelNames);
    for (final Label label : labels) {
      removeLabel(label.getOwnerName(), label.getName());
    }
  }

  @Override
  public void removeLabels(final Set labelNames) {
    final Set labels = EnvTool.getWebService().getLabelsByName(labelNames);
    for (final Label label : labels) {
      removeLabel(label.getOwnerName(), label.getName());
    }
  }

  @Override
  public void deleteCategories(final Set categoryNames) {
    final Set categories = EnvTool.getJournalQueriers().getCategories(categoryNames);
    EnvTool.getWebService().removeCategories(categories);
  }

  @Override
  public void executeConnectorAndSetVariables(final String connectorClassName, final Map parameters,
      final ActivityInstance activityInstance, final Map context) throws Exception {
    final ProcessDefinitionUUID processDefinitionUUID = activityInstance.getProcessDefinitionUUID();
    final Connector connector = (Connector) EnvTool.getClassDataLoader().getInstance(processDefinitionUUID,
        connectorClassName);
    if (connector instanceof Mapper) {
      throw new IllegalAccessException(connectorClassName + " is a instance of RoleResolver or Filter");
    }
    ConnectorExecutor.executeConnector(connector, parameters, activityInstance.getProcessInstanceUUID(),
        activityInstance, context);
  }

  @Override
  public Map executeConnectorAndGetVariablesToSet(final String connectorClassName,
      final Map parameters, final ProcessDefinitionUUID processDefinitionUUID,
      final Map context) throws Exception {
    final Connector connector = (Connector) EnvTool.getClassDataLoader().getInstance(processDefinitionUUID,
        connectorClassName);
    if (connector instanceof Mapper) {
      throw new IllegalAccessException(connectorClassName + " is a instance of RoleResolver or Filter");
    }
    return ConnectorExecutor.executeConnector(connector, parameters, processDefinitionUUID, context);
  }

  @Override
  public LightProcessDefinition setProcessCategories(final ProcessDefinitionUUID aProcessUUID,
      final Set aCategoriesName) throws ProcessNotFoundException {
    FacadeUtil.checkArgsNotNull(aProcessUUID);
    final InternalProcessDefinition internalProcess = EnvTool.getAllQueriers().getProcess(aProcessUUID);
    if (internalProcess == null) {
      throw new ProcessNotFoundException("web_1", aProcessUUID);
    }
    internalProcess.setCategories(aCategoriesName);
    return new LightProcessDefinitionImpl(internalProcess);
  }

  @Override
  public void addCategory(final String name, final String iconCSSStyle, final String previewCSSStyleName,
      final String cssStyleName) throws CategoryAlreadyExistsException {
    FacadeUtil.checkArgsNotNull(name);
    final Set categories = EnvTool.getJournalQueriers().getCategories(Arrays.asList(name));
    if (categories != null && !categories.isEmpty()) {
      throw new CategoryAlreadyExistsException(name);
    }
    final CategoryImpl newCategory = new CategoryImpl(name);
    newCategory.setIconCSSStyle(iconCSSStyle);
    newCategory.setPreviewCSSStyleName(previewCSSStyleName);
    newCategory.setReadonlyCSSStyleName(cssStyleName);
    EnvTool.getRecorder().recordNewCategory(newCategory);
  }

  @Override
  public Category updateCategoryByUUID(final String uuid, final String name, final String iconCSSStyle,
      final String previewCSSStyleName, final String cssStyleName) throws CategoryNotFoundException,
      CategoryAlreadyExistsException {
    FacadeUtil.checkArgsNotNull(uuid, name);
    final CategoryImpl category = EnvTool.getJournalQueriers().getCategoryByUUID(uuid);
    if (category == null) {
      throw new CategoryNotFoundException(name);
    }
    final Set categories = EnvTool.getJournalQueriers().getCategories(Arrays.asList(name));
    if (categories != null && !categories.isEmpty()) {
      if (!categories.iterator().next().getUUID().equals(uuid)) {
        throw new CategoryAlreadyExistsException(name);
      }
    }
    category.setIconCSSStyle(iconCSSStyle);
    category.setPreviewCSSStyleName(previewCSSStyleName);
    category.setReadonlyCSSStyleName(cssStyleName);
    category.setName(name);
    return new CategoryImpl(category);
  }

  @Override
  public Set getAllCategoriesByUUIDExcept(final Set uuids) {

    final Set ids = new HashSet();
    for (final CategoryUUID categoryUUID : uuids) {
      ids.add(categoryUUID.getValue());
    }
    final Set categories = EnvTool.getJournalQueriers().getAllCategoriesExcept(ids);
    final Set result = new HashSet();
    for (final Category category : categories) {
      result.add(new CategoryImpl(category));
    }
    return result;
  }

  @Override
  public Document addProcessDocumentTemplate(final String name, final ProcessDefinitionUUID processDefinitionUUID,
      final String fileName, final String mimeType, final byte[] content) throws ProcessNotFoundException,
      DocumentAlreadyExistsException, DocumentationCreationException {
    final ProcessDefinition process = EnvTool.getAllQueriers().getProcess(processDefinitionUUID);
    if (process == null) {
      throw new ProcessNotFoundException("bai_RAPII_29", processDefinitionUUID);
    } else if (content != null && (fileName == null || mimeType == null)) {
      new DocumentationCreationException("");
    }
    final DocumentationManager manager = EnvTool.getDocumentationManager();
    return DocumentService.getClientDocument(manager,
        manager.createMetaDocument(processDefinitionUUID, name, fileName, mimeType, content));
  }

  @Override
  public List getProcessDocumentTemplates(final ProcessDefinitionUUID processDefinitionUUID)
      throws ProcessNotFoundException, DocumentationCreationException {
    final ProcessDefinition process = EnvTool.getAllQueriers().getProcess(processDefinitionUUID);
    if (process == null) {
      throw new ProcessNotFoundException("bai_RAPII_29", processDefinitionUUID);
    }
    final DocumentationManager manager = EnvTool.getDocumentationManager();
    return DocumentService.getClientDocuments(manager, manager.getMetaDocuments(processDefinitionUUID));
  }

}