Class NoneCaseIdGenerator

  • All Implemented Interfaces:
    CaseIdGenerator

    public class NoneCaseIdGenerator
    extends Object
    implements CaseIdGenerator
    Generator that in general does not generate but rely on given case ids. By default it expects to have "CaseId" parameter given that represents case id. The name of the property can be changed by system property:
    org.jbpm.cases.generator.caseid.param
    • Constructor Detail

      • NoneCaseIdGenerator

        public NoneCaseIdGenerator()
    • Method Detail

      • register

        public void register​(String prefix)
        Description copied from interface: CaseIdGenerator
        Should be called only one time per given prefix. Subsequent calls with same prefix do not affect the generator state.
        Specified by:
        register in interface CaseIdGenerator
        Parameters:
        prefix - unique prefix that should be used for generating case identifiers
      • unregister

        public void unregister​(String prefix)
        Description copied from interface: CaseIdGenerator
        Unregisters given prefix from the generator. It's up to generator implementation to either remove the prefix and its latest value permanently or resume it in case of further registration of the same prefix.
        Specified by:
        unregister in interface CaseIdGenerator
        Parameters:
        prefix - unique prefix that should be used for generating case identifiers
      • generate

        public String generate​(String prefix,
                               Map<String,​Object> optionalParameters)
                        throws CasePrefixNotFoundException
        Description copied from interface: CaseIdGenerator
        Generates next value for given prefix. Returned value should include the prefix as part of the returned value.
        Specified by:
        generate in interface CaseIdGenerator
        Parameters:
        prefix - unique prefix that should be used for generating case identifiers
        optionalParameters - map of optionalParameters that might be helpful for implementation
        Returns:
        complete case id in format (PREFIX-GENERATED_VALUE)
        Throws:
        CasePrefixNotFoundException - in case given prefix was not registered
      • getIdentifier

        public String getIdentifier()
        Description copied from interface: CaseIdGenerator
        Identifier of the generator so it can be found and registered at runtime
        Specified by:
        getIdentifier in interface CaseIdGenerator
        Returns:
        unique identifier