MID Server ISecuredConfigProvider interface

  • Freigeben Version: Australia
  • Aktualisiert 12. März 2026
  • 1 Minute Lesedauer

    • Use the methods in this interface to create custom providers that manage secured parameter values in the MID Server config.xml file.

    Hinweis:
    These methods are contained in the snc-automation-api.jar file, located in the MID Server installation folder.

    initialize

    This method initializes the provider with additional configuration parameters and does not return a value.
    Tabelle : 1. Example 
    void intialize(java.util.Properties properties,
               IMidServerEncrypter encrypter)
        throws java.lang.Exception
    Tabelle : 2. Parameters
    Parameters Description
    properties Initialization properties.
    encrypter Encrypter to use if the provider is encryption based.
    Tabelle : 3. Exception
    java.lang.Exception

    isParameterValueSecured

    This method checks to see if the parameter value has been secured or not. This method returns a boolean type value.
    Tabelle : 4. Example
    boolean isParameterValueSecured(java.lang.String paramValue)
    Tabelle : 5. Parameters
    Parameter Description
    paramValue The parameter value.
    Tabelle : 6. Returns
    The parameter returns true if the parameter value is secured.

    secureParameterValue

    This method secures the parameter value if it has not been secured. This method returns a string type value.
    Tabelle : 7. Example 
    java.lang.String secureParameterValue(java.lang.String unsecuredParameterValue)
                               throws java.lang.Exception
    Tabelle : 8. Parameters
    Parameter Description
    unsecuredParameterValue The unsecured parameter value.
    Tabelle : 9. Returns
    This method returns the unsecuired parameter value.
    Tabelle : 10. Exception
    java.lang.Exception

    unsecuredParameterValue

    This method returns the unsecured value of the parameter. This method returns a string type value.
    Tabelle : 11. Example 
    java.lang.String unsecuredParameterValue(java.lang.String parameterName)
                                  throws java.lang.Exception
    Tabelle : 12. Parameters
    Parameter Description
    parameterName The parameter name.
    Tabelle : 13. Returns
    This parameter returns the unsecured value.
    Tabelle : 14. Exception
    java.lang.Exception