How to use

addRequiredRole

method

in

org.kie.internal.runtime.conf.DeploymentDescriptorBuilder

builder.addRequiredRole(requiredRole);

protected static void deployKjar() {
  KieServices ks = KieServices.Factory.get();
  ReleaseId releaseId = ks.newReleaseId(GROUP_ID, ARTIFACT_ID, VERSION);
  List<String> processes = new ArrayList<String>();
  processes.add("processes/EmptyHumanTask.bpmn");
  processes.add("processes/humanTask.bpmn");
  processes.add("processes/SimpleHTProcess.bpmn2");
  
  DeploymentDescriptor customDescriptor = new DeploymentDescriptorImpl("org.jbpm.domain");
  customDescriptor.getBuilder()
  .addRequiredRole("view:managers");
  
  Map<String, String> resources = new HashMap<String, String>();
  resources.put("src/main/resources/" + DeploymentDescriptor.META_INF_LOCATION, customDescriptor.toXml());
  
  InternalKieModule kJar1 = createKieJar(ks, releaseId, processes, resources);
  
  File pom = new File("target/kmodule", "pom.xml");
  pom.getParentFile().mkdir();
  try {
    FileOutputStream fs = new FileOutputStream(pom);
    fs.write(getPom(releaseId).getBytes());
    fs.close();
  } catch (Exception e) {
    
  }
  KieMavenRepository repository = getKieMavenRepository();
  repository.installArtifact(releaseId, kJar1, pom);
}

@Test
public void testWriteDeploymentDescriptorXml() {
  DeploymentDescriptor descriptor = new DeploymentDescriptorImpl("org.jbpm.domain");
  descriptor.getBuilder()
       .addMarshalingStrategy(new ObjectModel("org.jbpm.testCustomStrategy",
                           new Object[]{
                                 new ObjectModel("java.lang.String", new Object[]{"param1"}),
                                 "param2"}))
       .addRequiredRole("experts");
  String deploymentDescriptorXml = descriptor.toXml();
  assertNotNull(deploymentDescriptorXml);
  logger.info(deploymentDescriptorXml);
  ByteArrayInputStream stream = new ByteArrayInputStream(deploymentDescriptorXml.getBytes());
  DeploymentDescriptor fromXml = DeploymentDescriptorIO.fromXml(stream);
  assertNotNull(fromXml);
  assertEquals("org.jbpm.domain", fromXml.getPersistenceUnit());
  assertEquals("org.jbpm.domain", fromXml.getAuditPersistenceUnit());
  assertEquals(AuditMode.JPA, fromXml.getAuditMode());
  assertEquals(PersistenceMode.JPA, fromXml.getPersistenceMode());
  assertEquals(RuntimeStrategy.SINGLETON, fromXml.getRuntimeStrategy());
  assertEquals(1, fromXml.getMarshallingStrategies().size());
  assertEquals(0, fromXml.getConfiguration().size());
  assertEquals(0, fromXml.getEnvironmentEntries().size());
  assertEquals(0, fromXml.getEventListeners().size());
  assertEquals(0, fromXml.getGlobals().size());
  assertEquals(0, fromXml.getTaskEventListeners().size());
  assertEquals(0, fromXml.getWorkItemHandlers().size());
  assertEquals(1, fromXml.getRequiredRoles().size());
}

@Test
public void testWriteDeploymentDescriptorXmlWithDuplicateNamedObjects() {
  DeploymentDescriptor descriptor = new DeploymentDescriptorImpl("org.jbpm.domain");
  descriptor.getBuilder()
       .addWorkItemHandler(new NamedObjectModel("mvel", "Log", "new org.jbpm.process.instance.impl.demo.SystemOutWorkItemHandler()"))
       .addWorkItemHandler(new NamedObjectModel("mvel", "Log", "new org.jbpm.process.instance.impl.demo.CustomSystemOutWorkItemHandler()"))
       .addRequiredRole("experts");
  String deploymentDescriptorXml = descriptor.toXml();
  assertNotNull(deploymentDescriptorXml);
  logger.info(deploymentDescriptorXml);
  ByteArrayInputStream stream = new ByteArrayInputStream(deploymentDescriptorXml.getBytes());
  DeploymentDescriptor fromXml = DeploymentDescriptorIO.fromXml(stream);
  assertNotNull(fromXml);
  assertEquals("org.jbpm.domain", fromXml.getPersistenceUnit());
  assertEquals("org.jbpm.domain", fromXml.getAuditPersistenceUnit());
  assertEquals(AuditMode.JPA, fromXml.getAuditMode());
  assertEquals(PersistenceMode.JPA, fromXml.getPersistenceMode());
  assertEquals(RuntimeStrategy.SINGLETON, fromXml.getRuntimeStrategy());
  assertEquals(0, fromXml.getMarshallingStrategies().size());
  assertEquals(0, fromXml.getConfiguration().size());
  assertEquals(0, fromXml.getEnvironmentEntries().size());
  assertEquals(0, fromXml.getEventListeners().size());
  assertEquals(0, fromXml.getGlobals().size());
  assertEquals(0, fromXml.getTaskEventListeners().size());
  assertEquals(1, fromXml.getWorkItemHandlers().size());
  assertEquals(1, fromXml.getRequiredRoles().size());
}

@Test
public void testWriteDeploymentDescriptorXml() {
  DeploymentDescriptor descriptor = new DeploymentDescriptorImpl("org.jbpm.domain");
  descriptor.getBuilder()
       .addMarshalingStrategy(new ObjectModel("org.jbpm.testCustomStrategy",
                           new Object[]{
                                 new ObjectModel("java.lang.String", new Object[]{"param1"}),
                                 "param2"}))
       .addRequiredRole("experts");
  String deploymentDescriptorXml = descriptor.toXml();
  assertNotNull(deploymentDescriptorXml);
  logger.info(deploymentDescriptorXml);
  ByteArrayInputStream stream = new ByteArrayInputStream(deploymentDescriptorXml.getBytes());
  DeploymentDescriptor fromXml = DeploymentDescriptorIO.fromXml(stream);
  assertNotNull(fromXml);
  assertEquals("org.jbpm.domain", fromXml.getPersistenceUnit());
  assertEquals("org.jbpm.domain", fromXml.getAuditPersistenceUnit());
  assertEquals(AuditMode.JPA, fromXml.getAuditMode());
  assertEquals(PersistenceMode.JPA, fromXml.getPersistenceMode());
  assertEquals(RuntimeStrategy.SINGLETON, fromXml.getRuntimeStrategy());
  assertEquals(1, fromXml.getMarshallingStrategies().size());
  assertEquals(0, fromXml.getConfiguration().size());
  assertEquals(0, fromXml.getEnvironmentEntries().size());
  assertEquals(0, fromXml.getEventListeners().size());
  assertEquals(0, fromXml.getGlobals().size());
  assertEquals(0, fromXml.getTaskEventListeners().size());
  assertEquals(0, fromXml.getWorkItemHandlers().size());
  assertEquals(1, fromXml.getRequiredRoles().size());
}

@Test
public void testWriteDeploymentDescriptorXmlWithDuplicateNamedObjects() {
  DeploymentDescriptor descriptor = new DeploymentDescriptorImpl("org.jbpm.domain");
  descriptor.getBuilder()
       .addWorkItemHandler(new NamedObjectModel("mvel", "Log", "new org.jbpm.process.instance.impl.demo.SystemOutWorkItemHandler()"))
       .addWorkItemHandler(new NamedObjectModel("mvel", "Log", "new org.jbpm.process.instance.impl.demo.CustomSystemOutWorkItemHandler()"))
       .addRequiredRole("experts");
  String deploymentDescriptorXml = descriptor.toXml();
  assertNotNull(deploymentDescriptorXml);
  logger.info(deploymentDescriptorXml);
  ByteArrayInputStream stream = new ByteArrayInputStream(deploymentDescriptorXml.getBytes());
  DeploymentDescriptor fromXml = DeploymentDescriptorIO.fromXml(stream);
  assertNotNull(fromXml);
  assertEquals("org.jbpm.domain", fromXml.getPersistenceUnit());
  assertEquals("org.jbpm.domain", fromXml.getAuditPersistenceUnit());
  assertEquals(AuditMode.JPA, fromXml.getAuditMode());
  assertEquals(PersistenceMode.JPA, fromXml.getPersistenceMode());
  assertEquals(RuntimeStrategy.SINGLETON, fromXml.getRuntimeStrategy());
  assertEquals(0, fromXml.getMarshallingStrategies().size());
  assertEquals(0, fromXml.getConfiguration().size());
  assertEquals(0, fromXml.getEnvironmentEntries().size());
  assertEquals(0, fromXml.getEventListeners().size());
  assertEquals(0, fromXml.getGlobals().size());
  assertEquals(0, fromXml.getTaskEventListeners().size());
  assertEquals(1, fromXml.getWorkItemHandlers().size());
  assertEquals(1, fromXml.getRequiredRoles().size());
}

@Test
public void testWriteDeploymentDescriptorXmlWithTransientElements() {
  DeploymentDescriptor descriptor = new DeploymentDescriptorImpl("org.jbpm.domain");
  descriptor.getBuilder()
       .addMarshalingStrategy(new TransientObjectModel("org.jbpm.testCustomStrategy",
                               new Object[]{
                                      new ObjectModel("java.lang.String", new Object[]{"param1"}),
                                      "param2"}))
       .addWorkItemHandler(new TransientNamedObjectModel("mvel", "Log", "new org.jbpm.process.instance.impl.demo.SystemOutWorkItemHandler()"))
       .addRequiredRole("experts");
  String deploymentDescriptorXml = descriptor.toXml();
  assertNotNull(deploymentDescriptorXml);
  logger.info(deploymentDescriptorXml);
  ByteArrayInputStream stream = new ByteArrayInputStream(deploymentDescriptorXml.getBytes());
  DeploymentDescriptor fromXml = DeploymentDescriptorIO.fromXml(stream);
  assertNotNull(fromXml);
  assertEquals("org.jbpm.domain", fromXml.getPersistenceUnit());
  assertEquals("org.jbpm.domain", fromXml.getAuditPersistenceUnit());
  assertEquals(AuditMode.JPA, fromXml.getAuditMode());
  assertEquals(PersistenceMode.JPA, fromXml.getPersistenceMode());
  assertEquals(RuntimeStrategy.SINGLETON, fromXml.getRuntimeStrategy());
  assertEquals(0, fromXml.getMarshallingStrategies().size());
  assertEquals(0, fromXml.getConfiguration().size());
  assertEquals(0, fromXml.getEnvironmentEntries().size());
  assertEquals(0, fromXml.getEventListeners().size());
  assertEquals(0, fromXml.getGlobals().size());
  assertEquals(0, fromXml.getTaskEventListeners().size());
  assertEquals(0, fromXml.getWorkItemHandlers().size());
  assertEquals(1, fromXml.getRequiredRoles().size());
}

@Test
public void testWriteDeploymentDescriptorXmlWithTransientElements() {
  DeploymentDescriptor descriptor = new DeploymentDescriptorImpl("org.jbpm.domain");
  descriptor.getBuilder()
       .addMarshalingStrategy(new TransientObjectModel("org.jbpm.testCustomStrategy",
                               new Object[]{
                                      new ObjectModel("java.lang.String", new Object[]{"param1"}),
                                      "param2"}))
       .addWorkItemHandler(new TransientNamedObjectModel("mvel", "Log", "new org.jbpm.process.instance.impl.demo.SystemOutWorkItemHandler()"))
       .addRequiredRole("experts");
  String deploymentDescriptorXml = descriptor.toXml();
  assertNotNull(deploymentDescriptorXml);
  logger.info(deploymentDescriptorXml);
  ByteArrayInputStream stream = new ByteArrayInputStream(deploymentDescriptorXml.getBytes());
  DeploymentDescriptor fromXml = DeploymentDescriptorIO.fromXml(stream);
  assertNotNull(fromXml);
  assertEquals("org.jbpm.domain", fromXml.getPersistenceUnit());
  assertEquals("org.jbpm.domain", fromXml.getAuditPersistenceUnit());
  assertEquals(AuditMode.JPA, fromXml.getAuditMode());
  assertEquals(PersistenceMode.JPA, fromXml.getPersistenceMode());
  assertEquals(RuntimeStrategy.SINGLETON, fromXml.getRuntimeStrategy());
  assertEquals(0, fromXml.getMarshallingStrategies().size());
  assertEquals(0, fromXml.getConfiguration().size());
  assertEquals(0, fromXml.getEnvironmentEntries().size());
  assertEquals(0, fromXml.getEventListeners().size());
  assertEquals(0, fromXml.getGlobals().size());
  assertEquals(0, fromXml.getTaskEventListeners().size());
  assertEquals(0, fromXml.getWorkItemHandlers().size());
  assertEquals(1, fromXml.getRequiredRoles().size());
}

                          new ObjectModel("java.lang.String", new Object[]{"param1"}),
                          "param2"}))
.addRequiredRole("experts");

                          new ObjectModel("java.lang.String", new Object[]{"param1"}),
                          "param2"}))
.addRequiredRole("experts");

builder.addRequiredRole(requiredRole);