nl.nn.adapterframework.pipes

Class CreateRestViewPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.stream.StreamingPipe

nl.nn.adapterframework.pipes.XsltPipe

nl.nn.adapterframework.pipes.CreateRestViewPipe

All Implemented Interfaces:

HasTransactionAttribute, IConfigurable, IConfigurationAware, IExtendedPipe, IForwardTarget, INamedObject, IPipe, IScopeProvider, EventThrowing, IOutputStreamingSupport, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class CreateRestViewPipe
extends XsltPipe

Create a view for RestListener.

expected format after performing the XSLT transformation:

   <page title="...">
      ...
   </page>
 

example:

   <page title="Generate WSDL">
      <script type="text/javascript">
         //&lt;![CDATA[
         function changeBg(obj,isOver) {
            var color1="#8D0022";
            var color2="#b4e2ff";
            if (isOver) {
               obj.style.backgroundColor=color1;
               obj.style.color=color2;
            } else {
               obj.style.backgroundColor=color2;
               obj.style.color=color1;
            }
         }
         //]]&gt;
      </script>
      <form method="post" action="" enctype="multipart/form-data">
         <table border="0" width="100%">
            <tr>
               <td>Upload xsd/zip file</td>
               <td>
                  <input type="file" name="file" value=""/>
               </td>
            </tr>
             <tr>
                <td/>
                <td>
                   <input type="submit" onmouseover="changeBg(this,true);" onmouseout="changeBg(this,false);" value="send"/>
                </td>
             </tr>
         </table>
      </form>
   </page>
 

example:

   <page title="Show Generated WSDL">
      <table>
         <caption class="caption">Files</caption>
         <tr>
            <th class="colHeader">Name</th>
            <th class="colHeader">Size</th>
            <th class="colHeader">Date</th>
            <th class="colHeader">Time</th>
            <th class="colHeader">as</th>
         </tr>
         <tr class="filterRow">
            <td class="filterRow">GetCollectionDisbursementAccountInformationOnPolicy_2_concrete.wsdl</td>
            <td class="filterRow">25269</td>
            <td class="filterRow">28-05-15</td>
            <td class="filterRow">11:33:30</td>
            <td class="filterRow">
               <a href="../FileViewerServlet?resultType=xml&amp;fileName=C:\Temp\GetCollectionDisbursementAccountInformationOnPolicy_2_concrete.wsdl">xml</a>
               <a href="../FileViewerServlet?resultType=text&amp;fileName=C:\Temp\GetCollectionDisbursementAccountInformationOnPolicy_2_concrete.wsdl">text</a>
            </td>
         </tr>
         <tr class="rowEven">
            <td class="filterRow">GetCollectionDisbursementAccountInformationOnPolicy_2_concrete.zip</td>
            <td class="filterRow">5759</td>
            <td class="filterRow">28-05-15</td>
            <td class="filterRow">11:33:30</td>
            <td class="filterRow">
               <a href="../FileViewerServlet?resultType=zip&amp;fileName=C:\Temp\GetCollectionDisbursementAccountInformationOnPolicy_2_concrete.zip">zip</a>
            </td>
         </tr>
      </table>
   </page>
 

Author:

Peter Leeuwenburgh

Field Summary

Fields inherited from class nl.nn.adapterframework.stream.StreamingPipe

AUTOMATIC_STREAMING

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
CreateRestViewPipe()

Method Summary

Modifier and Type	Method and Description
void	configure() The configure() method instantiates a transformer for the specified XSL.
PipeRunResult	doPipe(Message input, PipeLineSession session) This is where the action takes place.
String	getContentType()
void	setContentType(String string) content type of the servlet response

Methods inherited from class nl.nn.adapterframework.pipes.XsltPipe

addParameter, afterPropertiesSet, canProvideOutputStream, canStreamToNextPipe, createXsltSender, getNamespaceDefs, getParameterList, getSessionKey, getXpathExpression, provideOutputStream, setDisableOutputEscaping, setHandleLexicalEvents, setIndentXml, setName, setNamespaceAware, setNamespaceDefs, setOmitXmlDeclaration, setOutputType, setRemoveNamespaces, setSessionKey, setSkipEmptyTags, setStreamingXslt, setStyleSheetCacheSize, setStyleSheetName, setStyleSheetNameSessionKey, setXpathExpression, setXslt2, setXsltVersion, start, stop, supportsOutputStreamPassThrough

Methods inherited from class nl.nn.adapterframework.stream.StreamingPipe

getNextPipe, getTargetStream, isStreamingActive, provideOutputStream, setStreamingActive

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, throwEvent

Methods inherited from class nl.nn.adapterframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.IExtendedPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent

Methods inherited from interface nl.nn.adapterframework.core.IPipe

getMaxThreads

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface nl.nn.adapterframework.core.IForwardTarget

getName

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

CreateRestViewPipe

public CreateRestViewPipe()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from class: XsltPipe

The configure() method instantiates a transformer for the specified XSL. If the stylesheetname cannot be accessed, a ConfigurationException is thrown.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class XsltPipe

Throws:

ConfigurationException

doPipe

public PipeRunResult doPipe(Message input,
                            PipeLineSession session)
                     throws PipeRunException

Description copied from interface: IPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.

Specified by:

doPipe in interface IPipe

Overrides:

doPipe in class XsltPipe

Throws:

PipeRunException

setContentType

public void setContentType(String string)

content type of the servlet response

Default value

text/html

getContentType

public String getContentType()