Package adams.flow.standalone

Class SSLContext

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.flow.core.Actor>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.core.VariablesInspectionHandler, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ErrorHandler, adams.flow.core.SSLContextProvider, Serializable, Comparable
    public class SSLContext
extends adams.flow.standalone.AbstractStandalone
implements adams.flow.core.SSLContextProvider
    Initializes an SSL context using the specified context.
    For protocols, see:
    https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#sslcontext-algorithms
    Requires adams.flow.core.KeyManagerFactoryProvider and adams.flow.core.TrustManagerFactoryProvider standalones to be present.
    You don't have to use these actors if you enable the 'useDefaultContext' option. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: SSLContext
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -protocol <java.lang.String> (property: protocol)
    The protocol to use, eg TLSv1, TLSv1.1 or TLSv1.2.
    default: TLSv1.2
 
    -use-default-context <boolean> (property: useDefaultContext)
    If enabled, the default SSL context is used (doesn't require the keymanager
    /trustmanager).
    default: false
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.flow.core.KeyManagerFactoryProvider m_KeyManager
      the KeyManager instance to use.
      protected String m_Protocol
      the protocol to use.
      protected SSLContext m_SSLContext
      the SSL context.
      protected adams.flow.core.TrustManagerFactoryProvider m_TrustManager
      the TrustManager instance to use.
      protected boolean m_UseDefaultContext
      whether to use default context.

      • Fields inherited from class adams.flow.core.AbstractActor

        m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

      • Fields inherited from interface adams.flow.core.Actor

        FILE_EXTENSION, FILE_EXTENSION_GZ

    • Constructor Summary

      Constructors 
      Constructor Description
      SSLContext()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Executes the flow item.
      String getProtocol()
      Returns the protocol to use.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      SSLContext getSSLContext()
      Returns the SSLContext instance.
      boolean getUseDefaultContext()
      Returns whether to use the default SSL context.
      String globalInfo()
      Returns a string describing the object.
      String protocolTipText()
      Returns the tip text for this property.
      void setProtocol​(String value)
      Sets the protocol to use.
      String setUp()
      Initializes the item for flow execution.
      void setUseDefaultContext​(boolean value)
      Sets whether to use the default SSL context.
      String useDefaultContextTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.flow.standalone.AbstractStandalone

        preExecute

      • Methods inherited from class adams.flow.core.AbstractActor

        annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

      • Methods inherited from interface adams.flow.core.Actor

        cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel, setLoggingLevel

      • Methods inherited from interface adams.core.logging.LoggingSupporter

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • Field Detail

      • m_Protocol

        protected String m_Protocol
        the protocol to use.

      • m_UseDefaultContext

        protected boolean m_UseDefaultContext
        whether to use default context.

      • m_KeyManager

        protected transient adams.flow.core.KeyManagerFactoryProvider m_KeyManager
        the KeyManager instance to use.

      • m_TrustManager

        protected transient adams.flow.core.TrustManagerFactoryProvider m_TrustManager
        the TrustManager instance to use.

      • m_SSLContext

        protected transient SSLContext m_SSLContext
        the SSL context.

    • Constructor Detail

      • SSLContext

        public SSLContext()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.flow.core.AbstractActor

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.flow.core.Actor
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class adams.flow.core.AbstractActor
        Returns:
        null if no info available, otherwise short string

      • setProtocol

        public void setProtocol​(String value)
        Sets the protocol to use.
        Parameters:
        value - the protocol

      • getProtocol

        public String getProtocol()
        Returns the protocol to use.
        Specified by:
        getProtocol in interface adams.flow.core.SSLContextProvider
        Returns:
        the protocol

      • protocolTipText

        public String protocolTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setUseDefaultContext

        public void setUseDefaultContext​(boolean value)
        Sets whether to use the default SSL context.
        Parameters:
        value - true if to use default context

      • getUseDefaultContext

        public boolean getUseDefaultContext()
        Returns whether to use the default SSL context.
        Specified by:
        getUseDefaultContext in interface adams.flow.core.SSLContextProvider
        Returns:
        true if to use default context

      • useDefaultContextTipText

        public String useDefaultContextTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setUp

        public String setUp()
        Initializes the item for flow execution.
        Specified by:
        setUp in interface adams.flow.core.Actor
        Overrides:
        setUp in class adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message

      • getSSLContext

        public SSLContext getSSLContext()
        Returns the SSLContext instance.
        Specified by:
        getSSLContext in interface adams.flow.core.SSLContextProvider
        Returns:
        the instance, null if not available

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message