org.odpi.openmetadata.accessservices.subjectarea.validators

Class InputValidator

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.validators.InputValidator

public class InputValidator
extends Object

Methods used for rest API input validation

Constructor Summary

Constructors

Constructor and Description
InputValidator()

Method Summary

Modifier and Type	Method and Description
static void	validateEffectiveDate(String className, String methodName, Date to, Date from) Throw an exception if the supplied effective dates are not valid
static void	validateGUIDNotNull(String className, String methodName, String guid, String guidParameter) Throw an exception if the supplied guid is null
static void	validateNameNotNull(String className, String methodName, String name, String nameParameter) Throw an exception if the supplied userId is null
static void	validateNodeType(Object... args)
static void	validateRemoteServerNameNotNull(String className, String methodName, String omasServerURL) Throw an exception if the metadata server Name (which comes from the configuration has not been supplied on the constructor.
static void	validateRemoteServerURLNotNull(String className, String methodName, String omasServerURL) Throw an exception if the metadata server URL (which comes from the configuration has not been supplied on the constructor.
static Status	validateStatusAndCheckNotDeleted(String className, String methodName, String statusName) Validate the supplied string can be converted to a Status and return that status.
static void	validateUserIdNotNull(String className, String methodName, String userId) Throw an exception if the supplied userId is null

Methods inherited from class java.lang.Object

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

Constructor Detail

InputValidator

public InputValidator()

Method Detail

validateRemoteServerURLNotNull

public static void validateRemoteServerURLNotNull(String className,
                                                  String methodName,
                                                  String omasServerURL)
                                           throws InvalidParameterException

Throw an exception if the metadata server URL (which comes from the configuration has not been supplied on the constructor.

Parameters:

className - - name of the class making the call.

methodName - - name of the method making the call.

omasServerURL - - metadata server url.

Throws:

InvalidParameterException - - the org.odpi.openmetadata.accessservices.subjectarea.server URL is not set

validateRemoteServerNameNotNull

public static void validateRemoteServerNameNotNull(String className,
                                                   String methodName,
                                                   String omasServerURL)
                                            throws InvalidParameterException

Throw an exception if the metadata server Name (which comes from the configuration has not been supplied on the constructor.

Parameters:

className - - name of the class making the call.

methodName - - name of the method making the call.

omasServerURL - - metadata server url.

Throws:

InvalidParameterException - - the org.odpi.openmetadata.accessservices.subjectarea.server URL is not set

validateUserIdNotNull

public static void validateUserIdNotNull(String className,
                                         String methodName,
                                         String userId)
                                  throws InvalidParameterException

Throw an exception if the supplied userId is null

Parameters:

className - name of the class

methodName - name of the method making the call.

userId - user name to validate

Throws:

InvalidParameterException - the userId is null

validateEffectiveDate

public static void validateEffectiveDate(String className,
                                         String methodName,
                                         Date to,
                                         Date from)
                                  throws InvalidParameterException

Throw an exception if the supplied effective dates are not valid

Parameters:

className - name of the class

methodName - name of the method making the call.

to - effective to date

from - effective from date

Throws:

InvalidParameterException - the userId is null

validateStatusAndCheckNotDeleted

public static Status validateStatusAndCheckNotDeleted(String className,
                                                      String methodName,
                                                      String statusName)
                                               throws InvalidParameterException

Validate the supplied string can be converted to a Status and return that status. If it cannot be converted then null is returned.

Parameters:

className - - name of the class making the call.

methodName - - name of the method making the call.

statusName - - the String name to convert to a Status

Returns:

Status or null.

Throws:

InvalidParameterException - invalid status

validateGUIDNotNull

public static void validateGUIDNotNull(String className,
                                       String methodName,
                                       String guid,
                                       String guidParameter)
                                throws InvalidParameterException

Throw an exception if the supplied guid is null

Parameters:

className - - name of the class making the call.

methodName - - name of the method making the call.

guid - - unique identifier to validate

guidParameter - - name of the parameter that passed the guid

Throws:

InvalidParameterException - - the guid is null

validateNameNotNull

public static void validateNameNotNull(String className,
                                       String methodName,
                                       String name,
                                       String nameParameter)
                                throws InvalidParameterException

Throw an exception if the supplied userId is null

Parameters:

className - - name of the class making the call.

methodName - - name of the method making the call.

name - - unique name to validate

nameParameter - - name of the parameter that passed the name.

Throws:

InvalidParameterException - - the guid is null

validateNodeType

public static void validateNodeType(Object... args)
                             throws InvalidParameterException

Throws:

InvalidParameterException