io.cdap.cdap.api.plugin

Class InvalidPluginConfigException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.cdap.cdap.api.plugin.InvalidPluginConfigException

All Implemented Interfaces:

Serializable

public class InvalidPluginConfigException
extends RuntimeException

Thrown when a PluginConfig cannot be created from provided PluginProperties. This can happen if properties required by the PluginConfig are not in the PluginProperties, or when the property type specified by the PluginConfig is incompatible with the value provided in the PluginProperties.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidPluginConfigException(String message, Set<String> missingProperties, Set<InvalidPluginProperty> invalidProperties)
InvalidPluginConfigException(String message, Throwable cause)

Method Summary

Modifier and Type	Method and Description
Set<InvalidPluginProperty>	getInvalidProperties()
Set<String>	getMissingProperties()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InvalidPluginConfigException

public InvalidPluginConfigException(String message,
                                    Throwable cause)

InvalidPluginConfigException

public InvalidPluginConfigException(String message,
                                    Set<String> missingProperties,
                                    Set<InvalidPluginProperty> invalidProperties)

Method Detail

getMissingProperties

public Set<String> getMissingProperties()

Returns:

the set of required properties that were not provided in the PluginProperties.

getInvalidProperties

public Set<InvalidPluginProperty> getInvalidProperties()

Returns:

the set of invalid properties, usually because the value given in the PluginProperties did not match the expected type.