Class AbstractConnector

  • All Implemented Interfaces:
    org.apache.synapse.aspects.AspectConfigurable, org.apache.synapse.Mediator, org.apache.synapse.SynapseArtifact, Connector
    Direct Known Subclasses:
    GenerateAccessToken, RefreshAccessToken

    public abstract class AbstractConnector
    extends org.apache.synapse.mediators.AbstractMediator
    implements Connector
    • Field Summary

      • Fields inherited from class org.apache.synapse.mediators.AbstractMediator

        log, trace, traceState
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract void connect​(org.apache.synapse.MessageContext messageContext)
      implements the connection logic to external API or custom service pattern
      protected Object getParameter​(org.apache.synapse.MessageContext messageContext, String paramName)  
      boolean mediate​(org.apache.synapse.MessageContext messageContext)  
      • Methods inherited from class org.apache.synapse.mediators.AbstractMediator

        auditLog, auditWarn, configure, disableStatistics, disableTracing, divertMediationRoute, enableStatistics, enableTracing, getAspectConfiguration, getCommentsList, getDescription, getInputType, getLastSequenceFaultHandler, getLog, getMediatorName, getMediatorPosition, getOutputType, getRegisteredMediationFlowPoint, getShortDescription, getTraceState, getType, handleException, handleException, isBreakPoint, isContentAltering, isContentAware, isSkipEnabled, isStatisticsEnable, isTraceOn, isTraceOrDebugOn, isTracingEnabled, registerMediationFlowPoint, reportCloseStatistics, reportOpenStatistics, setBreakPoint, setCommentsList, setComponentStatisticsId, setDescription, setEffectiveTraceState, setMediatorPosition, setShortDescription, setSkipEnabled, setTraceState, shouldCaptureTracing, shouldTrace, shouldTrace, traceOrDebug, traceOrDebugWarn, unregisterMediationFlowPoint
      • Methods inherited from interface org.apache.synapse.Mediator

        getMediatorName, getMediatorPosition, getShortDescription, getTraceState, getType, isContentAltering, isContentAware, reportCloseStatistics, reportOpenStatistics, setComponentStatisticsId, setMediatorPosition, setShortDescription, setTraceState
      • Methods inherited from interface org.apache.synapse.SynapseArtifact

        getDescription, setDescription
    • Constructor Detail

      • AbstractConnector

        public AbstractConnector()
    • Method Detail

      • connect

        public abstract void connect​(org.apache.synapse.MessageContext messageContext)
                              throws ConnectException
        Description copied from interface: Connector
        implements the connection logic to external API or custom service pattern
        Specified by:
        connect in interface Connector
        Throws:
        ConnectException - when error during conenction to APIs or unexpected errors
      • mediate

        public boolean mediate​(org.apache.synapse.MessageContext messageContext)
        Specified by:
        mediate in interface org.apache.synapse.Mediator
      • getParameter

        protected Object getParameter​(org.apache.synapse.MessageContext messageContext,
                                      String paramName)