Package org.kie.internal.runtime.manager.deploy

## Class DeploymentDescriptorImpl

- java.lang.Object
- - org.kie.internal.runtime.manager.deploy.DeploymentDescriptorImpl

- All Implemented Interfaces:
    `java.io.Serializable`, `DeploymentDescriptor`

      public class DeploymentDescriptorImpl
      extends java.lang.Object
      implements DeploymentDescriptor, java.io.Serializable

  See Also:
    Serialized Form

- - ### Field Summary

    - ### Fields inherited from interface org.kie.internal.runtime.conf.DeploymentDescriptor

      `META_INF_LOCATION, TYPE_ALL, TYPE_EXECUTE, TYPE_VIEW`

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `DeploymentDescriptorImpl()` |
    `DeploymentDescriptorImpl​(java.lang.String defaultPU)` |

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected java.util.List<ObjectModel>` | `cleanList​(java.util.List<ObjectModel> input)` |
    `protected java.util.Set<NamedObjectModel>` | `cleanNamedSet​(java.util.Set<NamedObjectModel> input)` |
    `protected java.util.Set<ObjectModel>` | `cleanSet​(java.util.Set<ObjectModel> input)` |
    `DeploymentDescriptor` | `clearClone()` |
    `AuditMode` | `getAuditMode()` | Returns the audit type configuration
    `java.lang.String` | `getAuditPersistenceUnit()` | Returns name of the JPA persistence unit to be used by audit component non empty should correspond to defined persistence unit in persistence.xml null to use default persistence unit
    `DeploymentDescriptorBuilder` | `getBuilder()` | Returns implementation specific builder to construct instances of the descriptor;
    `java.util.List<java.lang.String>` | `getClasses()` | Returns additional classes that shall be added to remote services context.
    `java.util.List<NamedObjectModel>` | `getConfiguration()` | List of kiesession configuration entries to be registered
    `java.util.List<NamedObjectModel>` | `getEnvironmentEntries()` | List of (kie) environment entries to be registered
    `java.util.List<ObjectModel>` | `getEventListeners()` | Returns list of event listeners (process, agenda, rule runtime) to be applied on `KieSession`
    `java.util.List<NamedObjectModel>` | `getGlobals()` | Return list of globals to be applied on `KieSession`
    `java.lang.Boolean` | `getLimitSerializationClasses()` | Returns whether or not the classes used in the serialization mechanism are limited to classes annotated with @`Remotable`, @`XmlRootElement`, or @`XmlType`.
    `java.util.List<ObjectModel>` | `getMarshallingStrategies()` | Returns list of object marshaling strategies to be applied on `KieSession`
    `PersistenceMode` | `getPersistenceMode()` | Returns the runtime engine persistence type configuration
    `java.lang.String` | `getPersistenceUnit()` | Returns name of the JPA persistence unit to be used for runtime engine non empty should correspond to defined persistence unit in persistence.xml null to use default persistence unit
    `java.util.List<java.lang.String>` | `getRequiredRoles()` | Returns all required roles required to be granted access to the deployment.
    `java.util.List<java.lang.String>` | `getRequiredRoles​(java.lang.String type)` | Returns required for given type of applicability.
    `RuntimeStrategy` | `getRuntimeStrategy()` | Returns runtime strategy to be used, default Singleton.
    `java.util.List<ObjectModel>` | `getTaskEventListeners()` | Returns list of task event listeners to be applied on `KieSession`
    `java.util.List<NamedObjectModel>` | `getWorkItemHandlers()` | Return list of work item handlers to be applied on `KieSession`
    `boolean` | `isEmpty()` |
    `protected void` | `mapRequiredRoles()` |
    `protected void` | `removeTransient​(java.util.Collection<?> input)` |
    `void` | `setAuditMode​(AuditMode auditMode)` |
    `void` | `setAuditPersistenceUnit​(java.lang.String auditPersistenceUnit)` |
    `void` | `setClasses​(java.util.List<java.lang.String> classes)` |
    `void` | `setConfiguration​(java.util.List<NamedObjectModel> configuration)` |
    `void` | `setEnvironmentEntries​(java.util.List<NamedObjectModel> environmentEntires)` |
    `void` | `setEventListeners​(java.util.List<ObjectModel> eventListeners)` |
    `void` | `setGlobals​(java.util.List<NamedObjectModel> globals)` |
    `void` | `setLimitSerializationClasses​(java.lang.Boolean limitSerializationClasses)` |
    `void` | `setMarshallingStrategies​(java.util.List<ObjectModel> marshallingStrategies)` |
    `void` | `setPersistenceMode​(PersistenceMode persistenceMode)` |
    `void` | `setPersistenceUnit​(java.lang.String persistenceUnit)` |
    `void` | `setRequiredRoles​(java.util.List<java.lang.String> requiredRoles)` |
    `void` | `setRuntimeStrategy​(RuntimeStrategy runtimeStrategy)` |
    `void` | `setTaskEventListeners​(java.util.List<ObjectModel> taskEventListeners)` |
    `void` | `setWorkItemHandlers​(java.util.List<NamedObjectModel> workItemHandlers)` |
    `java.lang.String` | `toString()` |
    `java.lang.String` | `toXml()` | Returns XML representation of this descriptor instance

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### DeploymentDescriptorImpl

          public DeploymentDescriptorImpl()

    - #### DeploymentDescriptorImpl

          public DeploymentDescriptorImpl​(java.lang.String defaultPU)

  - ### Method Detail

    - #### mapRequiredRoles

          protected void mapRequiredRoles()

    - #### getPersistenceUnit

          public java.lang.String getPersistenceUnit()

      Description copied from interface: `DeploymentDescriptor`
      Returns name of the JPA persistence unit to be used for runtime engine
      - non empty should correspond to defined persistence unit in persistence.xml
      - null to use default persistence unit
      Specified by:
        `getPersistenceUnit` in interface `DeploymentDescriptor`
      Returns:
        non empty string should correspond to defined persistence unit in persistence.xml, in case null is returned persistence will use default one - org.jbpm.domain

    - #### getAuditPersistenceUnit

          public java.lang.String getAuditPersistenceUnit()

      Description copied from interface: `DeploymentDescriptor`
      Returns name of the JPA persistence unit to be used by audit component
      - non empty should correspond to defined persistence unit in persistence.xml
      - null to use default persistence unit
      Specified by:
        `getAuditPersistenceUnit` in interface `DeploymentDescriptor`
      Returns:
        non empty string should correspond to defined persistence unit in persistence.xml, in case null is returned persistence will use default one - org.jbpm.domain

    - #### getAuditMode

          public AuditMode getAuditMode()

      Description copied from interface: `DeploymentDescriptor`
      Returns the audit type configuration
      Specified by:
        `getAuditMode` in interface `DeploymentDescriptor`
      Returns:

    - #### getPersistenceMode

          public PersistenceMode getPersistenceMode()

      Description copied from interface: `DeploymentDescriptor`
      Returns the runtime engine persistence type configuration
      Specified by:
        `getPersistenceMode` in interface `DeploymentDescriptor`
      Returns:

    - #### getRuntimeStrategy

          public RuntimeStrategy getRuntimeStrategy()

      Description copied from interface: `DeploymentDescriptor`
      Returns runtime strategy to be used, default Singleton.
      Specified by:
        `getRuntimeStrategy` in interface `DeploymentDescriptor`
      Returns:

    - #### getMarshallingStrategies

          public java.util.List<ObjectModel> getMarshallingStrategies()

      Description copied from interface: `DeploymentDescriptor`
      Returns list of object marshaling strategies to be applied on `KieSession`
      Specified by:
        `getMarshallingStrategies` in interface `DeploymentDescriptor`
      Returns:

    - #### getEventListeners

          public java.util.List<ObjectModel> getEventListeners()

      Description copied from interface: `DeploymentDescriptor`
      Returns list of event listeners (process, agenda, rule runtime) to be applied on `KieSession`
      Specified by:
        `getEventListeners` in interface `DeploymentDescriptor`
      Returns:

    - #### getGlobals

          public java.util.List<NamedObjectModel> getGlobals()

      Description copied from interface: `DeploymentDescriptor`
      Return list of globals to be applied on `KieSession`
      Specified by:
        `getGlobals` in interface `DeploymentDescriptor`
      Returns:

    - #### getWorkItemHandlers

          public java.util.List<NamedObjectModel> getWorkItemHandlers()

      Description copied from interface: `DeploymentDescriptor`
      Return list of work item handlers to be applied on `KieSession`
      Specified by:
        `getWorkItemHandlers` in interface `DeploymentDescriptor`
      Returns:

    - #### getTaskEventListeners

          public java.util.List<ObjectModel> getTaskEventListeners()

      Description copied from interface: `DeploymentDescriptor`
      Returns list of task event listeners to be applied on `KieSession`
      Specified by:
        `getTaskEventListeners` in interface `DeploymentDescriptor`
      Returns:

    - #### getEnvironmentEntries

          public java.util.List<NamedObjectModel> getEnvironmentEntries()

      Description copied from interface: `DeploymentDescriptor`
      List of (kie) environment entries to be registered
      Specified by:
        `getEnvironmentEntries` in interface `DeploymentDescriptor`
      Returns:

    - #### getConfiguration

          public java.util.List<NamedObjectModel> getConfiguration()

      Description copied from interface: `DeploymentDescriptor`
      List of kiesession configuration entries to be registered
      Specified by:
        `getConfiguration` in interface `DeploymentDescriptor`
      Returns:

    - #### getRequiredRoles

          public java.util.List<java.lang.String> getRequiredRoles()

      Description copied from interface: `DeploymentDescriptor`
      Returns all required roles required to be granted access to the deployment. Empty list or null means no security will be applied.
      Specified by:
        `getRequiredRoles` in interface `DeploymentDescriptor`
      Returns:

    - #### getRequiredRoles

          public java.util.List<java.lang.String> getRequiredRoles​(java.lang.String type)

      Description copied from interface: `DeploymentDescriptor`
      Returns required for given type of applicability. Supported types are:
      - all
      - view
      - execute
      Specified by:
        `getRequiredRoles` in interface `DeploymentDescriptor`
      Parameters:
        `type` - indicates the type which required roles shoud apply
      Returns:

    - #### getClasses

          public java.util.List<java.lang.String> getClasses()

      Description copied from interface: `DeploymentDescriptor`
      Returns additional classes that shall be added to remote services context. All classes that directly belong to kjar (or are declared as dependency of type kjar) do not need to be listed as part of this collection.
      Specified by:
        `getClasses` in interface `DeploymentDescriptor`
      Returns:

    - #### setPersistenceUnit

          public void setPersistenceUnit​(java.lang.String persistenceUnit)

    - #### setAuditPersistenceUnit

          public void setAuditPersistenceUnit​(java.lang.String auditPersistenceUnit)

    - #### setAuditMode

          public void setAuditMode​(AuditMode auditMode)

    - #### setPersistenceMode

          public void setPersistenceMode​(PersistenceMode persistenceMode)

    - #### setRuntimeStrategy

          public void setRuntimeStrategy​(RuntimeStrategy runtimeStrategy)

    - #### setMarshallingStrategies

          public void setMarshallingStrategies​(java.util.List<ObjectModel> marshallingStrategies)

    - #### setEventListeners

          public void setEventListeners​(java.util.List<ObjectModel> eventListeners)

    - #### setTaskEventListeners

          public void setTaskEventListeners​(java.util.List<ObjectModel> taskEventListeners)

    - #### setGlobals

          public void setGlobals​(java.util.List<NamedObjectModel> globals)

    - #### setWorkItemHandlers

          public void setWorkItemHandlers​(java.util.List<NamedObjectModel> workItemHandlers)

    - #### setEnvironmentEntries

          public void setEnvironmentEntries​(java.util.List<NamedObjectModel> environmentEntires)

    - #### setConfiguration

          public void setConfiguration​(java.util.List<NamedObjectModel> configuration)

    - #### setRequiredRoles

          public void setRequiredRoles​(java.util.List<java.lang.String> requiredRoles)

    - #### setClasses

          public void setClasses​(java.util.List<java.lang.String> classes)

    - #### getLimitSerializationClasses

          public java.lang.Boolean getLimitSerializationClasses()

      Description copied from interface: `DeploymentDescriptor`
      Returns whether or not the classes used in the serialization mechanism are limited to classes annotated with @`Remotable`, @`XmlRootElement`, or @`XmlType`. In the 6.x branches, the default is false (classes are not limited.) In the 7.x branches, the default is true (classes are limited.)
      Specified by:
        `getLimitSerializationClasses` in interface `DeploymentDescriptor`
      Returns:
        a `Boolean`

    - #### setLimitSerializationClasses

          public void setLimitSerializationClasses​(java.lang.Boolean limitSerializationClasses)

    - #### cleanNamedSet

          protected java.util.Set<NamedObjectModel> cleanNamedSet​(java.util.Set<NamedObjectModel> input)

    - #### cleanSet

          protected java.util.Set<ObjectModel> cleanSet​(java.util.Set<ObjectModel> input)

    - #### cleanList

          protected java.util.List<ObjectModel> cleanList​(java.util.List<ObjectModel> input)

    - #### removeTransient

          protected void removeTransient​(java.util.Collection<?> input)

    - #### clearClone

          public DeploymentDescriptor clearClone()
                                          throws java.lang.CloneNotSupportedException

      Throws:
        `java.lang.CloneNotSupportedException`

    - #### isEmpty

          public boolean isEmpty()

    - #### getBuilder

          public DeploymentDescriptorBuilder getBuilder()

      Description copied from interface: `DeploymentDescriptor`
      Returns implementation specific builder to construct instances of the descriptor;
      Specified by:
        `getBuilder` in interface `DeploymentDescriptor`
      Returns:

    - #### toXml

          public java.lang.String toXml()

      Description copied from interface: `DeploymentDescriptor`
      Returns XML representation of this descriptor instance
      Specified by:
        `toXml` in interface `DeploymentDescriptor`
      Returns:

    - #### toString

          public java.lang.String toString()

      Overrides:
        `toString` in class `java.lang.Object`