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

        } catch (MalformedURLException e) {
            fail("Could not construct a java.net.URL instance");
        }
        
        // ensure the pipeline context has a current base uri
        XMLPipelineContext context
                = process.getPipeline().getPipelineContext();
        context.pushBaseURI(baseURI.toExternalForm());


        String localName = "localName";
        String namespaceURI = "";
        String qName = localName;

View Full Code Here

        // call setDocumentLocator()
        process.setDocumentLocator(locator);
        process.startDocument();
        
        // get hold of the pipeline context
        XMLPipelineContext context
                = process.getPipeline().getPipelineContext();
        
        // ensure that the XMLPipelineContext has a current locator and
        // base uri
        assertNotNull(
                "XMLPipelineContext should have a non null current locator",
                context.getCurrentLocator());


        assertNotNull(
                "XMLPipelineContext should have a non null current base URI",
                context.getCurrentBaseURI());
        
        // invoke the method that is being tested
        process.endDocument();
        
        // ensure that the pipeline context has had both the current locator
        // and base uri popped off.
        assertNull("endDocument should pop the current locator",
                   context.getCurrentLocator());


        assertNull("endDocument should pop the current base uri",
                   context.getCurrentBaseURI());
        
        // ensure that the event is not forwarded to the next process
        next.assertEndDocumentNotInvoked();
    }

View Full Code Here

        
        // invoke the method that is being tested
        process.startPrefixMapping(prefix, namespace);


        // get hold of the pipeline context
        XMLPipelineContext context
                = process.getPipeline().getPipelineContext();
        
        // ensure that the pipeline contexts NamespacePrefixTracker has
        // been updated        
        NamespacePrefixTracker tracker = context.getNamespacePrefixTracker();


        assertEquals("NamespacePrefixTracker was not updated with the " +
                     "startPrefixMapping event",
                     namespace,
                     tracker.getNamespaceURI(prefix));

View Full Code Here

        // set the next process
        XMLProcessTestable next = new XMLProcessTestable();
        process.setNextProcess(next);


        // get hold of the pipeline context
        XMLPipelineContext context
                = process.getPipeline().getPipelineContext();
        
        // Update pipeline contexts NamespacePrefixTracker with a prefix
        // and namespace pair
        NamespacePrefixTracker tracker = context.getNamespacePrefixTracker();
        tracker.startPrefixMapping(prefix, namespace);


        assertEquals("NamespacePrefixTracker was not updated with the " +
                     "startPrefixMapping event",
                     namespace,

View Full Code Here

     * @throws SAXException If there was a problem.
     */
    public void iterate(DynamicProcess dynamicProcess)
            throws SAXException {
        
        XMLPipelineContext pipelineContext =
                dynamicProcess.getPipeline().getPipelineContext();
        InternalExpressionContext expressionContext =
                (InternalExpressionContext)
                pipelineContext.getExpressionContext();


        PipelinePlayer player = recording.createPlayer();


        // Push a new scope to contain the variable and shadow any variable
        // with the same name.

View Full Code Here

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


        XMLPipelineContext context =
                dynamicProcess.getPipeline().getPipelineContext();
        InternalExpressionContext expressionContext =
                (InternalExpressionContext)
                context.getExpressionContext();


        // The iterator that is returned.
        EndElementAction action;


        // Evaluate the in expression to a sequence.
        String inExpression = attributes.getValue("in");
        final Sequence sequence = evaluateExpression(expressionContext, inExpression);
        int length = sequence.getLength();
        if (length == 0) {
            // The sequence is empty so there is nothing to do so just skip
            // the body and do not create an iterator.
            context.getFlowControlManager().exitCurrentElement();
            action = EndElementAction.DO_NOTHING;
        } else {


            // Resolve the variable name into an ExpandedName, if the variable
            // name does not have a prefix then it belongs in no namespace,
            // rather than the default namespace.
            String variableName = attributes.getValue("variable");
            QName variableQName = new ImmutableQName(variableName);
            final ExpandedName variableExpandedName =
                    context.getNamespacePrefixTracker()
                    .resolveQName(variableQName, null);


            // If the sequence only has a single value in then it is not
            // necessary to store the body away to be evaluated multiple times.
            if (length == 1) {


                // Create a new block scope to contain the variable.
                expressionContext.pushBlockScope();


                // Create a variable in the current stack frame.
                try {
                    expressionContext.getCurrentScope()
                            .declareVariable(variableExpandedName,
                                    sequence.getItem(1));
                } catch (SequenceIndexOutOfBoundsException e) {
                    throw new ExtendedSAXException(e);
                }


                // Remember to pop the block scope off after the content has
                // been processed.
                action = new PopBlockScopeAction();


            } else {


                // Make the dynamic process pass the element contents straight
                // through without evaluating them so that they can be recprded
                // and evaluated for each value of the variable. The dynamic
                // process will automatically come out of pass through mode
                // once it sees the matching end element event.
                dynamicProcess.passThroughElementContents();


                XMLPipelineFactory factory = context.getPipelineFactory();
                final PipelineRecorder recorder =
                        factory.createPipelineRecorder();
                recorder.startRecording(dynamicProcess.getPipeline());


                final XMLProcess process = recorder.getRecordingProcess();

View Full Code Here


    // Javadoc inherited.
    public void doAction(DynamicProcess dynamicProcess)
            throws SAXException {


        XMLPipelineContext pipelineContext =
                dynamicProcess.getPipeline().getPipelineContext();
        InternalExpressionContext expressionContext =
                (InternalExpressionContext)
                pipelineContext.getExpressionContext();


        expressionContext.popBlockScope();
    }

View Full Code Here

                DynamicProcessConfiguration.class,
                dynamicConfig);
        
        // create a XMLPipelineContext
        EnvironmentInteraction interaction = null;
        XMLPipelineContext context = factory.createPipelineContext(
                    pipelineConfiguration,
                    interaction);


        // create a pipeline
        XMLPipeline pipeline = factory.createDynamicPipeline(context);

View Full Code Here

        attrs.setValue("portType", thePortType);
        attrs.setValue("operation", theOperationName);


        process.processAttributes(attrs);


        XMLPipelineContext context = process.getPipelineContext();
        Operation operation = (Operation) context.getProperty(Operation.class);


        assertNotNull(operation);


        assertEquals(theWsdl, operation.retrieveWSDLURI());
        assertEquals(thePortType, operation.getPortType());

View Full Code Here

                DynamicProcessConfiguration.class,
                dynamicConfig);
        
        // create a XMLPipelineContext
        EnvironmentInteraction interaction = null;
        XMLPipelineContext context = factory.createPipelineContext(
                pipelineConfiguration,
                interaction);


        // create a pipeline
        XMLPipeline pipeline = factory.createDynamicPipeline(context);

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