com.pcbsys.nirvana.client.nMessageValidator Interface Reference

This interface defines the generic functionality that all Message Validators need to implement. More...

Public Member Functions

object check (sbyte[] original)
 Compares the signature passed as a byte[] with the signature constructed with the update methods. More...
 
void start (sbyte[] signature)
 This method is called on the validating class prior to any calls being made. More...
 
void stop ()
 This method is called when the validation is completed. More...
 
void update (sbyte[] data)
 This method adds the byte[] to the signature being built up to validate against More...
 

Detailed Description

This interface defines the generic functionality that all Message Validators need to implement.

Member Function Documentation

object com.pcbsys.nirvana.client.nMessageValidator.check ( sbyte[]  original)

Compares the signature passed as a byte[] with the signature constructed with the update methods.

This method must throw an exception if the signatures do not match and must not just return null. As a null is still a valid return object.

Parameters
originalSignature byte[]
Returns
Object specific to the validating class that can be used for further validation
Exceptions
ExceptionMust be thrown if the signature do not match
void com.pcbsys.nirvana.client.nMessageValidator.start ( sbyte[]  signature)

This method is called on the validating class prior to any calls being made.

It is not mandatory that the implementing class do anything with the function.

Parameters
signatureThe signature to be validated
void com.pcbsys.nirvana.client.nMessageValidator.stop ( )

This method is called when the validation is completed.

void com.pcbsys.nirvana.client.nMessageValidator.update ( sbyte[]  data)

This method adds the byte[] to the signature being built up to validate against

Parameters
databyte[] to add to the signature
Exceptions
ExceptionSpecific to the actual signing implementation