Interface OutputProcessor

    • Method Detail

      • setXMLSecurityProperties

        void setXMLSecurityProperties​(XMLSecurityProperties xmlSecurityProperties)
        setter for the XMLSecurityProperties after instantiation of the processor
        Parameters:
        xmlSecurityProperties -
      • setAction

        void setAction​(XMLSecurityConstants.Action action,
                       int actionOrder)
        setter for the Action after instantiation of the processor
        Parameters:
        action - The action this processor belongs to, possibly null for no particular action.
        actionOrder - The action order of this processor, possibly -1 for no particular action order.
      • getActionOrder

        int getActionOrder()
        Returns:
        The action order of this processor, or -1.
      • addBeforeProcessor

        void addBeforeProcessor​(java.lang.Class<? extends OutputProcessor> processor)
        Add this processor before the given processor
        Parameters:
        processor -
      • getBeforeProcessors

        java.util.Set<java.lang.Class<? extends OutputProcessor>> getBeforeProcessors()
        This OutputProcessor will be added before the processors in this set
        Returns:
        The set with the named OutputProcessor
      • addAfterProcessor

        void addAfterProcessor​(java.lang.Class<? extends OutputProcessor> processor)
        Add this processor after the given processor
        Parameters:
        processor -
      • getAfterProcessors

        java.util.Set<java.lang.Class<? extends OutputProcessor>> getAfterProcessors()
        This OutputProcessor will be added after the processors in this set
        Returns:
        The set with the named OutputProcessor
      • processEvent

        void processEvent​(XMLSecEvent xmlSecEvent,
                          OutputProcessorChain outputProcessorChain)
                   throws javax.xml.stream.XMLStreamException,
                          XMLSecurityException
        Will be called from the framework for every XMLEvent
        Parameters:
        xmlSecEvent - The next XMLEvent to process
        outputProcessorChain -
        Throws:
        javax.xml.stream.XMLStreamException - thrown when a streaming error occurs
        XMLSecurityException - thrown when a Security failure occurs
      • doFinal

        void doFinal​(OutputProcessorChain outputProcessorChain)
              throws javax.xml.stream.XMLStreamException,
                     XMLSecurityException
        Will be called when the whole document is processed.
        Parameters:
        outputProcessorChain -
        Throws:
        javax.xml.stream.XMLStreamException - thrown when a streaming error occurs
        XMLSecurityException - thrown when a Security failure occurs