es.ree.eemws.core.utils.operations.query

Class QueryRequestMessageValidator

java.lang.Object

es.ree.eemws.core.utils.operations.query.QueryRequestMessageValidator

public final class QueryRequestMessageValidator
extends java.lang.Object

Query request validator. Perform validation on request message. This class can be used by both client and server avoiding code duplication.

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.Object>	validate(ch.iec.tc57._2011.schema.message.RequestMessage message) Validates the given request message.
static void	validateParameterNames(java.lang.String queryId, java.util.Set<java.lang.String> receivedParameterNames) Checks that the operation only received the queryId with no aditional parametes.
static void	validateParameterNames(java.lang.String queryId, java.util.Set<java.lang.String> validParameterNames, java.util.Set<java.lang.String> receivedParameterNames) Checks that the operation only received valid (known) filter names.

Methods inherited from class java.lang.Object

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

Method Detail

validate

public static java.util.Map<java.lang.String,java.lang.Object> validate(ch.iec.tc57._2011.schema.message.RequestMessage message)
                                                                 throws QueryOperationException

Validates the given request message. Aditional validations must be performed by the invoker depending on the query needs.

Parameters:

message - Request message to be validated.

Returns:

a map with all the request "options" values.

Throws:

QueryOperationException - if the request is not valid.

validateParameterNames

public static void validateParameterNames(java.lang.String queryId,
                          java.util.Set<java.lang.String> receivedParameterNames)
                                   throws QueryOperationException

Checks that the operation only received the queryId with no aditional parametes.

Parameters:

queryId - Query identification (DataType value)

receivedParameterNames - Received set of parameter names.

Throws:

QueryOperationException - if the receivedParameterNames set has at least a parameter name that is not included in the validParameterNames set.

validateParameterNames

public static void validateParameterNames(java.lang.String queryId,
                          java.util.Set<java.lang.String> validParameterNames,
                          java.util.Set<java.lang.String> receivedParameterNames)
                                   throws QueryOperationException

Checks that the operation only received valid (known) filter names.

Parameters:

queryId - Query identification (DataType value)

validParameterNames - Valid (understood) parameter for the query.

receivedParameterNames - Received set of parameter names.

Throws:

QueryOperationException - if the receivedParameterNames set has at least a parameter name that is not included in the validParameterNames set.