MID Server ISecuredConfigProvider interface

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 1 minute de lecture

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

    Remarque :
    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.
    Tableau 1. Example 
    void intialize(java.util.Properties properties,
               IMidServerEncrypter encrypter)
        throws java.lang.Exception
    Tableau 2. Parameters
    Parameters Description
    properties Initialization properties.
    encrypter Encrypter to use if the provider is encryption based.
    Tableau 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.
    Tableau 4. Example
    boolean isParameterValueSecured(java.lang.String paramValue)
    Tableau 5. Parameters
    Parameter Description
    paramValue The parameter value.
    Tableau 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.
    Tableau 7. Example 
    java.lang.String secureParameterValue(java.lang.String unsecuredParameterValue)
                               throws java.lang.Exception
    Tableau 8. Parameters
    Parameter Description
    unsecuredParameterValue The unsecured parameter value.
    Tableau 9. Returns
    This method returns the unsecuired parameter value.
    Tableau 10. Exception
    java.lang.Exception

    unsecuredParameterValue

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