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

     * and the next SAX content encountered will be the content that
     * is to be transformed.
     * @throws SAXException if an error occurs
     */
    public void beginTransform() throws SAXException {
        XMLPipelineContext context = getPipelineContext();
        if (!context.inErrorRecoveryMode()) {
            // run through the list of Transformer handlers and set up the
            // transformations


            XMLProcess cup = new ContextManagerProcess(true);
            cup.setPipeline(getPipeline());

View Full Code Here

     * This method should be called when all content that requires
     * transforming has been received.
     * @throws SAXException if an error occurs
     */
    public void endTransform() throws SAXException {
        XMLPipelineContext context = getPipelineContext();
        if (!context.inErrorRecoveryMode()) {
            if (getTemplateCount() > 0) {
                // contentHandler will be the TransformerHandler at the head of
                // the chain. Need to call endDocument() for the transformers to
                // actually perform the transformations.
                // The DocumentEventFilter will filter the endDocument() event

View Full Code Here

        // We only look for the configuration in the pipeline config if it
        // has not been set on constuction.
        if (configuration == null) {


            // Get hold of the pipeline context
            XMLPipelineContext context = getPipelineContext();


            // Get hold of the pipeline configuration
            XMLPipelineConfiguration pipelineConfiguration =
                    context.getPipelineConfiguration();


            // Retrieve the configuration
            Configuration config =
                    pipelineConfiguration.retrieveConfiguration(
                            URLRewriteProcessConfiguration.class);


            if (config == null ||
                    !(config instanceof URLRewriteProcessConfiguration)) {
                // Cannot get hold of the configuration. As this is fatal
                // deliver a fatal error down the pipeline
                XMLPipelineException error = new XMLPipelineException(
                        "Could not retrieve the URL rewrite process " +
                        "configuration",
                        context.getCurrentLocator());


                try {
                    pipeline.getPipelineProcess().fatalError(error);
                } catch (SAXException e) {
                    // cannot continue so throw a runtime exception

View Full Code Here

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


        // get hold of the pipeline context
        XMLPipelineContext context = getPipelineContext();


        // get hold of the pipeline configuration
        XMLPipelineConfiguration pipelineConfiguration =
                context.getPipelineConfiguration();


        // retrieve the configuration
        Configuration config =
                pipelineConfiguration.retrieveConfiguration(
                        AbsoluteToRelativeURLConfiguration.class);


        if (config == null ||
                !(config instanceof AbsoluteToRelativeURLConfiguration)) {
            // cannot get hold of the configuration. As this is fatal
            // deliver a fatal error down the pipeline
            XMLPipelineException error = new XMLPipelineException(
                    "Could not retrieve the Absolute to Relative URL " +
                    "converter configuration",
                    context.getCurrentLocator());


            try {
                pipeline.getPipelineProcess().fatalError(error);
            } catch (SAXException e) {
                // cannot continue so throw a runtime exception

View Full Code Here

     * is compilable but there should be no difference between the results of
     * this test and that of testSimpleTransformation()
     * @throws Exception if an error occurs
     */
    public void testCompilableSimpleTransformation() throws Exception {
        XMLPipelineContext pipelineContext =
                pipelineFactory.createPipelineContext(
                        createPipelineConfiguration(),
                        createRootEnvironmentInteraction());


        DefaultTransformConfiguration config = (DefaultTransformConfiguration)
                pipelineContext.getPipelineConfiguration().
                retrieveConfiguration(TransformConfiguration.class);


        config.setTemplateCompilationRequired(true);


        doInContextTest(pipelineContext,

View Full Code Here

     * transformation is compilable but there should be no difference between
     * the results of this test and that of testSimpleTransformation()
     * @throws Exception if an error occurs
     */
    public void testCompilableSimpleTransformation2() throws Exception {
        XMLPipelineContext pipelineContext =
                pipelineFactory.createPipelineContext(
                        createPipelineConfiguration(),
                        createRootEnvironmentInteraction());


        DefaultTransformConfiguration config = (DefaultTransformConfiguration)
                pipelineContext.getPipelineConfiguration().
                retrieveConfiguration(TransformConfiguration.class);


        config.setTemplateCompilationRequired(true);


        doInContextTest(pipelineContext,

View Full Code Here

     * element is compilable but one of its child transformation elements
     * overrides it to be not compilable.
     * @throws Exception if an error occurs
     */
    public void testCompilableNestedTransformations() throws Exception {
        XMLPipelineContext pipelineContext =
                pipelineFactory.createPipelineContext(
                        createPipelineConfiguration(),
                        createRootEnvironmentInteraction());


        DefaultTransformConfiguration config = (DefaultTransformConfiguration)
                pipelineContext.getPipelineConfiguration().
                retrieveConfiguration(TransformConfiguration.class);


        config.setTemplateCompilationRequired(true);


        doInContextTest(pipelineContext,

View Full Code Here

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


        // get hold of the pipeline context
        XMLPipelineContext context = getPipelineContext();


        // get hold of the pipeline configuration
        XMLPipelineConfiguration pipelineConfiguration =
                context.getPipelineConfiguration();


        // retrieve the configuration
        Configuration config =
                pipelineConfiguration.retrieveConfiguration(
                        URLToURLCConfiguration.class);


        if (config == null ||
                !(config instanceof URLToURLCConfiguration)) {
            // cannot get hold of the configuration. As this is fatal
            // deliver a fatal error down the pipeline
            XMLPipelineException error = new XMLPipelineException(
                    "Could not retrieve the URL To URLC converter " +
                    "configuration",
                    context.getCurrentLocator());


            try {
                pipeline.getPipelineProcess().fatalError(error);
            } catch (SAXException e) {
                // cannot continue so throw a runtime exception

View Full Code Here


    /**
     *
     */
    public void testCache()  throws Exception {
        XMLPipelineContext pipelineContext =
                pipelineFactory.createPipelineContext(
                        createPipelineConfiguration(),
                        createRootEnvironmentInteraction());


        // extract the expression context
        ExpressionContext expresisonContext
                = pipelineContext.getExpressionContext();


        // allow subclasses to register functions that are specific to
        // their tests
        registerExpressionFunctions(expresisonContext);

View Full Code Here

    /**
     * Test that transform template caching works in a multi threaded
     * environment.
     */
    public void testCacheMultiThreaded() throws Exception {
        final XMLPipelineContext pipelineContext =
                pipelineFactory.createPipelineContext(
                        createPipelineConfiguration(),
                        createRootEnvironmentInteraction());


        DefaultTransformConfiguration config = (DefaultTransformConfiguration)
                pipelineContext.getPipelineConfiguration().
                retrieveConfiguration(TransformConfiguration.class);


        config.setTemplateCacheRequired(true);
        config.setTemplateCompilationRequired(true);

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