Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

MID Server ISecuredConfigProvider interface

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

Note: 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.

void intialize(java.util.Properties properties,
               IMidServerEncrypter encrypter)
        throws java.lang.Exception
ParametersDescription
propertiesInitialization properties.
encrypterEncrypter to use if the provider is encryption based.
`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.

`boolean isParameterValueSecured(java.lang.String paramValue)`
ParameterDescription
paramValueThe parameter value.
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.

java.lang.String secureParameterValue(java.lang.String unsecuredParameterValue)
                               throws java.lang.Exception
ParameterDescription
unsecuredParameterValueThe unsecured parameter value.
This method returns the unsecuired parameter value.
`java.lang.Exception`

unsecuredParameterValue

This method returns the unsecured value of the parameter. This method returns a string type value.

java.lang.String unsecuredParameterValue(java.lang.String parameterName)
                                  throws java.lang.Exception
ParameterDescription
parameterNameThe parameter name.
This parameter returns the unsecured value.
`java.lang.Exception`

Parent Topic:MID Server configuration file security