Package org.ikasan.component.converter.xml

Class XmlConfiguration

  • public class XmlConfiguration
extends java.lang.Object
    Configuration for an XML conversion validation.
    Author:
    Ikasan Development Team

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getNamespacePrefix()  
      java.lang.String getNamespaceURI()  
      java.lang.String getRootClassName()
      Getter for any root class name override
      java.lang.String getRootName()
      Getter for any roo name override
      java.lang.String getSchema()
      Set an alternate schema to validate against.
      java.lang.String getSchemaLocation()
      Get the root XSD attribute value
      boolean isFastFailOnConfigurationLoad()  
      boolean isNoNamespaceSchema()
      If schema specified then is this a noNamespaceSchema
      boolean isRouteOnValidationException()
      Whether to route an XML validation failure to the next component (true) or throw an exception and rollback (false)
      boolean isUseNamespacePrefix()
      Getter for use namespace prefix on marshaller
      boolean isValidate()
      Getter to determine whether to validate the XML against the XSD
      void setFastFailOnConfigurationLoad​(boolean fastFailOnConfigurationLoad)  
      void setNamespacePrefix​(java.lang.String namespacePrefix)  
      void setNamespaceURI​(java.lang.String namespaceURI)  
      void setNoNamespaceSchema​(boolean noNamespaceSchema)
      Setter for noNamespaceSchema if schema specified
      void setRootClassName​(java.lang.String rootClassName)
      Setter for root class name override
      void setRootName​(java.lang.String rootName)
      Allow override of the root document name
      void setRouteOnValidationException​(boolean routeOnValidationException)
      Setter as to whether the component should route or throw an exception on XML validation failure.
      void setSchema​(java.lang.String schema)
      Get an alternate schema to validate against Commonly used if the XSD is picked up from the classpath rather than an http resource URL
      void setSchemaLocation​(java.lang.String schemaLocation)
      Set the root XSD attribute value
      void setUseNamespacePrefix​(boolean useNamespacePrefix)
      Setter for namespace prefix on marshaller
      void setValidate​(boolean validate)
      Setter to determine whether to validate the XML against the XSD

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • XmlConfiguration

        public XmlConfiguration()

    • Method Detail

      • isRouteOnValidationException

        public boolean isRouteOnValidationException()
        Whether to route an XML validation failure to the next component (true) or throw an exception and rollback (false)
        Returns:

      • setRouteOnValidationException

        public void setRouteOnValidationException​(boolean routeOnValidationException)
        Setter as to whether the component should route or throw an exception on XML validation failure.
        Parameters:
        routeOnValidationException -

      • getSchemaLocation

        public java.lang.String getSchemaLocation()
        Get the root XSD attribute value
        Returns:

      • setSchemaLocation

        public void setSchemaLocation​(java.lang.String schemaLocation)
        Set the root XSD attribute value
        Parameters:
        schemaLocation -

      • getSchema

        public java.lang.String getSchema()
        Set an alternate schema to validate against. Commonly used if the XSD is picked up from the classpath rather than an http resource URL
        Returns:

      • setSchema

        public void setSchema​(java.lang.String schema)
        Get an alternate schema to validate against Commonly used if the XSD is picked up from the classpath rather than an http resource URL
        Parameters:
        schema -

      • isValidate

        public boolean isValidate()
        Getter to determine whether to validate the XML against the XSD
        Returns:

      • setValidate

        public void setValidate​(boolean validate)
        Setter to determine whether to validate the XML against the XSD
        Parameters:
        validate -

      • getRootName

        public java.lang.String getRootName()
        Getter for any roo name override
        Returns:

      • setRootName

        public void setRootName​(java.lang.String rootName)
        Allow override of the root document name
        Parameters:
        rootName -

      • getRootClassName

        public java.lang.String getRootClassName()
        Getter for any root class name override
        Returns:

      • setRootClassName

        public void setRootClassName​(java.lang.String rootClassName)
        Setter for root class name override
        Parameters:
        rootClassName -

      • isNoNamespaceSchema

        public boolean isNoNamespaceSchema()
        If schema specified then is this a noNamespaceSchema
        Returns:

      • setNoNamespaceSchema

        public void setNoNamespaceSchema​(boolean noNamespaceSchema)
        Setter for noNamespaceSchema if schema specified
        Parameters:
        noNamespaceSchema -

      • isUseNamespacePrefix

        public boolean isUseNamespacePrefix()
        Getter for use namespace prefix on marshaller
        Returns:

      • setUseNamespacePrefix

        public void setUseNamespacePrefix​(boolean useNamespacePrefix)
        Setter for namespace prefix on marshaller
        Parameters:
        useNamespacePrefix -

      • isFastFailOnConfigurationLoad

        public boolean isFastFailOnConfigurationLoad()

      • setFastFailOnConfigurationLoad

        public void setFastFailOnConfigurationLoad​(boolean fastFailOnConfigurationLoad)

      • getNamespacePrefix

        public java.lang.String getNamespacePrefix()

      • setNamespacePrefix

        public void setNamespacePrefix​(java.lang.String namespacePrefix)

      • getNamespaceURI

        public java.lang.String getNamespaceURI()

      • setNamespaceURI

        public void setNamespaceURI​(java.lang.String namespaceURI)