Class UpdatePersistenceInstanceTask

  • All Implemented Interfaces:
    SubTask

    public class UpdatePersistenceInstanceTask
    extends AbstractBaseTask

    A Rhino management sub task for updating the settings of a persistence instance.

    Ant Parameters
    Attribute Description Required

    name

    Name of the persistence instance to create. This name must be unique.

    Yes.

    type

    Type of the persistence instance to create, eg. 'jdbc' or 'cassandra'.

    No. Only needs to be specified if changing the persistence instance type.

    datasourceclass

    Fully-qualified class name the the datasource class to be used by the persistence instance.

    No. This parameter is only meaningful if 'type' is 'jdbc'. Only needs to be specified if a different datasource class should be used by the persistence instance than previously specified.

    failonerror

    Flag to control failure behaviour. If 'true', the sub task will throw a BuildException when an error is encountered. If 'false', the sub task will throw a NonFatalBuildException instead of a BuildException under specific circumstances. See below for conditions (if any) which will cause a NonFatalBuildException.

    No. Default value is taken from the Rhino management parent task.

    Parameters available as nested elements
    Element Description Required

    configproperty

    Identifies a configuration property of the datasource class that should be updated. See ConfigPropertyElement. Note that the type property of ConfigPropertyElement is mandatory for this task.

    One ConfigPropertyElement must be specified per config property.

    removeconfigproperty

    Identifies an existing configuration property of the datasource class that should be removed. See UpdatePersistenceInstanceTask.RemoveConfigPropertyElement.

    One RemoveConfigPropertyElement must be specified per config property to be removed.

    NonFatalBuildException throw conditions
    • This task will never throw a NonFatalBuildException. It will always fail (throw a BuildException) on errors.

    • Constructor Detail

      • UpdatePersistenceInstanceTask

        public UpdatePersistenceInstanceTask()
    • Method Detail

      • execute

        protected void execute()
                        throws org.apache.tools.ant.BuildException
        Specified by:
        execute in class AbstractBaseTask
        Throws:
        org.apache.tools.ant.BuildException
      • validateParameters

        protected void validateParameters()
                                   throws org.apache.tools.ant.BuildException
        Specified by:
        validateParameters in class AbstractBaseTask
        Throws:
        org.apache.tools.ant.BuildException
      • setName

        public void setName​(String name)
      • setType

        public void setType​(String type)
      • setDatasourceClass

        public void setDatasourceClass​(String datasourceClassName)
      • addConfiguredConfigProperty

        public void addConfiguredConfigProperty​(ConfigPropertyElement element)