Examples of com.volantis.xml.pipeline.sax.XMLPipelineContext

com.volantis.xml.pipeline.sax.XMLPipelineContext
Contains contextual information that is needed by processes within the pipeline.
Warning: This is a facade provided for use by user code, not for implementation by user code. User implementations of this interface are highly likely to be incompatible with future releases of the product at both binary and source levels.

Processes can be added to the pipeline after it has been running which means that they may have missed some of the events that carry contextual information that may be needed in order to interpret other events, e.g. setDocumentLocator, startPrefixMapping, etc. This class provides access to that information.

Each pipeline has its own instance of this object which is created when the pipeline is created and discarded when the pipeline is discarded. Nested pipelines use the same instance of this class as the containing pipeline.

In addition to the normal SAX contextual information this class also provides facilities for pipeline objects such as XMLProcesses to communicate with each other.

XML Base

The XML Base standard defines a mechanism to allow page authors to specify the base URI used when resolving relative URIs. This interface provides support for managing them using the following methods.
- {@link #pushBaseURI}
- {@link #popBaseURI}
- {@link #getCurrentBaseURI}
- {@link #pushLocator}
- {@link #popLocator}
- {@link #getCurrentLocator}
Namespace mappings
todo: document this
Environment Interaction Tracker

The {@link EnvironmentInteractionTracker} is used to keep track of theenvironment interactions that affect the pipeline.

Object Stack

The object stack can be used by objects (processes, dynamic element rules, etc) to communicate and cooperate with one another.

The {@link ResourceOwner#release} method will be invoked on stack objectsthat implement the interface when the object is popped off the stack.

While pushing an {@link XMLProcess} on the object stack is allowed it isnot recommended as it can cause problems. An {@link XMLProcess} is a{@link ResourceOwner} and so popping it off the stack could
Custom Properties

These are used to allow pipeline objects (processes, rules) to communicate and cooperate with both the user of the pipeline and other pipeline objects. See {@link PropertyContainer} for more details.
The {@link ResourceOwner#release} method will be invoked on propertyvalues that implement the interface if the property is changed or removed.

Flow Control

Conditional content and error recovery require the ability to skip over events within the pipeline until a certain point within the event stream is reached at which time the pipeline carries on processing as normal. The mechanism to support this is called flow control.

Error Recovery

As part of error recovery this object provides support for recovering back to a well known state. This can involve discarding property values and objects on the object stack. The {@link ResourceOwner#release} method willbe invoked for those property values and stack objects that implement that interface and are discarded during error recovery.
@volantis-api-include-in PublicAPI @volantis-api-include-in ProfessionalServicesAPI @volantis-api-include-in InternalAPI @mock.generate

            DynamicProcess dynamicProcess,
            ExpandedName elementName,
            Attributes attributes)
            throws SAXException {


        XMLPipelineContext context = dynamicProcess.getPipelineContext();


        TryModel model = (TryModel) context.findObject(TryProcess.class);
        model.startBlock(element);


        dynamicProcess.addErrorRecoveryPoint();


        return model;

View Full Code Here

            ExpandedName element,
            Object object)
            throws SAXException {
        // retrieve the pipeline context so that we can determine if
        // the pipeline is in error recovery mode.
        XMLPipelineContext context = dynamicProcess.getPipelineContext();


        // determine if we are in error recovery mode before the superclasses
        // endElement is invoked as the error recovery mode is reset whenever
        // the attempt operation process is removed from the pipeline.
        boolean inErrorRecoveryMode = context.inErrorRecoveryMode();


        TryModel model = (TryModel) object;
        model.endBlock(this.element);


        // if attempt succeeded (ie the pipeline was not in error recovery
        // mode) then exit the current element, skipping any alternative
        // operations.
        if (!inErrorRecoveryMode) {
            context.getFlowControlManager().exitCurrentElement();
        }
    }

View Full Code Here


    // javadoc inherited
    public void setPipeline(XMLPipeline pipeline) {
        super.setPipeline(pipeline);


        XMLPipelineContext context = getPipelineContext();
        dependencyContext = context.getDependencyContext();
    }

View Full Code Here

    public void startBlock(Element element)
            throws SAXException {


        startElement(element);


        XMLPipelineContext context = getPipelineContext();
        recoveryPoint = context.addRecoveryPoint();
        XMLPipelineProcess pipeline =
                (XMLPipelineProcess) getPipeline().getPipelineProcess();
        XMLPipelineFactory factory = context.getPipelineFactory();
        recorder = factory.createPipelineRecorder();
        recorder.startRecording(pipeline);
        contentHandler = recorder.getRecordingHandler();
    }

View Full Code Here

        contentHandler = recorder.getRecordingHandler();
    }


    // Javadoc inherited.
    public void endBlock(Element element) throws SAXException {
        XMLPipelineContext context = getPipelineContext();
        if (!inErrorRecoveryMode) {


            // There was no error encountered during the processing of this
            // block of content.
            //
            // Propagate the dependencies upwards.
            dependencyContext.propagateDependencies();


            // Play the content back.
            PipelineRecording recording = recorder.stopRecording();
            PipelinePlayer player = recording.createPlayer();
            player.play(getNextProcess());


            // Remove the recovery point and keep the changes that have been
            // made to the pipeline context.
            context.removeRecoveryPoint(recoveryPoint, true);


            clearExceptions();


        } else {


            // An error occurred in this block.
            //
            // Discard all the changes made to the context since the recovery
            // point was created.
            context.removeRecoveryPoint(recoveryPoint, false);


            // Exit error recovery mode so that the next block can be tried.
            context.exitErrorRecoveryMode();


            // There was an error in the content so discard the dependencies.
            dependencyContext.clearDependencies();
        }

View Full Code Here

            logger.debug("An error was encountered. " +
                    "Invoking error recovery", exception);
        }
        inErrorRecoveryMode = true;
        listener.startErrorRecovery();
        XMLPipelineContext context = getPipelineContext();
        context.enterErrorRecoveryMode();
        if (logger.isDebugEnabled()) {
            logger.debug("Attempt failed ", exception);
        }


        addException(exception);

View Full Code Here

            throws SAXException {


        XMLProcess removed = removeProcess();
        // check that the correct process was removed.
        if (expected != removed) {
            XMLPipelineContext context = getPipelineContext();
            XMLPipelineException error = new XMLPipelineException(
                    "Expected to remove process " + expected +
                    "from the pipeline, but actually removed " + removed,
                    context.getCurrentLocator());
            // send the error down the pipeline
            fatalError(error);
        }
    }

View Full Code Here

    // Javadoc inherited.
    public Object startElement(
            DynamicProcess dynamicProcess, ExpandedName element,
            Attributes attributes) throws SAXException {


        XMLPipelineContext pipelineContext = dynamicProcess.getPipelineContext();
        ExpressionContext context = pipelineContext.getExpressionContext();


        // Get the expr attribute.
        String expr = attributes.getValue("expr");
        if (expr == null) {
            forwardError(dynamicProcess,
                    "'expr' attribute must be specified on " + element);
        } else {
            ExpressionFactory factory = ExpressionFactory.getDefaultInstance();
            ExpressionParser parser = factory.createExpressionParser();
            try {
                // Parse, and evaluate the expression.
                Expression expression = parser.parse(expr);
                Value value = expression.evaluate(context);


                // Stream the value's contents into the process following the
                // dynamic process. Don't do it into the dynamic process as
                // that will cause any markup to get reevaluated.
                value.streamContents(getTargetProcess(dynamicProcess));


            } catch (ExpressionException e) {
                dynamicProcess.fatalError(new XMLPipelineException(
                        "Error parsing '" + expr +
                        "' from expr attribute on " + element,
                        pipelineContext.getCurrentLocator(), e));
            }
        }


        return null;
    }

View Full Code Here

                                       Attributes attributes)
                throws SAXException {
        XMLProcess process = null;
        // we only add a process if the "active" attribute is set to true
        // and a DebugOutputFilesPrefix has been set on the pipeline context.
        XMLPipelineContext context =
                    dynamicProcess.getPipeline().getPipelineContext();
        String suffix = attributes.getValue(FILE_SUFFIX_ATTRIBUTE);
        String logFilePath =
                SerializeRule.calculateLogFilePath(context, suffix);
        boolean isActive = Boolean.valueOf(attributes.getValue(

View Full Code Here

            }
        });
        dynamicProcess.addProcess(process);


        TryModel model = process;
        XMLPipelineContext context = dynamicProcess.getPipelineContext();
        context.pushObject(model, false);


        model.startTry();


        return process;
    }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of com.volantis.xml.pipeline.sax.XMLPipelineContext

com.volantis.mcs.client.ClientSampleValidationTestCase$ClientSuccessfulTest

com.volantis.mcs.ibm.websphere.portalserver.MCSPortalFilter

com.volantis.mcs.marlin.sax.MarlinSAXHelper

com.volantis.mcs.papi.impl.IncludeElementImpl

com.volantis.mcs.protocols.DOMProtocol

com.volantis.mcs.runtime.pipeline.PipelineInitialization$MCSPipelineFactory

com.volantis.mcs.runtime.pipeline.PipelineIntegrationUtilities

com.volantis.mcs.runtime.pipeline.TranscoderURLConverterTestCase

com.volantis.mcs.servlet.DefaultXDIMERequestProcessorHelper

com.volantis.mcs.servlet.http.proxy.ProxySessionIdOperationProcess

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.

Examples of com.volantis.xml.pipeline.sax.XMLPipelineContext

XML Base

Namespace mappings

Environment Interaction Tracker

Object Stack

Custom Properties

Flow Control

Error Recovery

Related Classes of com.volantis.xml.pipeline.sax.XMLPipelineContext