Package com.adaptris.core.jdbc

Class JdbcMetadataParameter

  • All Implemented Interfaces:
    InOutParameter, InParameter, JdbcParameter, OutParameter
    Direct Known Subclasses:
    JdbcObjectMetadataParameter
    public class JdbcMetadataParameter
extends NullableParameter
    Stored Procedure parameter implementation, can be used for all IN, INOUT and OUT Stored Procedure parameters.

    If this implementation is used for an IN or an INOUT parameter, then the metadata will be pulled from the AdaptrisMessage and used as the parameter value. If this implementation is used for an OUT or an INOUT parameter, then the value of the matching parameter after the Stored Procedure has run, will be reapplied into the AdaptrisMessage as metadata. You will simply set the metadataKey, to both retrieve a value or to set a new value as above.

    Additionally you will set one or both of "name" and/or "order". "name" will map this parameter to a Stored Procedure parameter using the Stored Procedures method signature. "order" will map this parameter according to the parameter number using the Stored Procedures method signature. Note that the "order" starts from 1 and not 0, so the first parameter would be order 1. You will also need to set the data type of the parameter; you may use any of the string types defined in ParameterValueType

    In the adapter configuration file this class is aliased as jdbc-metadata-parameter which is the preferred alternative to the fully qualified classname when building your configuration.