Package org.certificateservices.messages.csmessages

Interface PayloadParser

All Known Implementing Classes:

AssertionPayloadParser, AuthorizationPayloadParser, AutoEnrollPayloadParser, BasePayloadParser, CredManagementPayloadParser, CSAgentProtocolPayloadParser, CSExportProtocolPayloadParser, DummyPayloadParser, EncryptedCSMessagePayloadParser, KeystoreMgmtPayloadParser, SignRequestPayloadParser, SysConfigPayloadParser, V2XBackendPayloadParser, V2XPayloadParser

public interface PayloadParser

Interface defining required method for a payload parser.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getJAXBPackage()	Method that returns the JAXBPackage Name for the package name containing the JAXB classes.
java.lang.String	getNameSpace()
java.lang.String[]	getRelatedSchemas(java.lang.String payloadVersion)	Method that should return related schemas used during payload schema validation.
java.io.InputStream	getSchemaAsInputStream(java.lang.String payLoadVersion)	Method that should return the location of the schema for a given payLoadVersion, it should be accessable as a class resource using getClass().getResourceAsStream()
void	init(java.util.Properties config, MessageSecurityProvider secProv)	Method that initializes the CSMessage parser with properties.

Method Detail

init

void init(java.util.Properties config,
          MessageSecurityProvider secProv)
   throws MessageProcessingException

Method that initializes the CSMessage parser with properties.

This method might be called more than once if configuration have been updated and the parser needs to be updated.

Parameters:

config - the configuration of the parser.

secProv - the related message security provider.

Throws:

MessageProcessingException - if configuration contained bad configuration of security provider.

getNameSpace

java.lang.String getNameSpace()

Returns:

the related pay load elements unique name space.

getJAXBPackage

java.lang.String getJAXBPackage()

Method that returns the JAXBPackage Name for the package name containing the JAXB classes. For multiple package names use a ':' without spaces.

getSchemaAsInputStream

java.io.InputStream getSchemaAsInputStream(java.lang.String payLoadVersion)
                                    throws MessageContentException,
                                           MessageProcessingException

Method that should return the location of the schema for a given payLoadVersion, it should be accessable as a class resource using getClass().getResourceAsStream()

Throws:

MessageContentException - if given version isn't supported.

MessageProcessingException - if problems occurred setting up the stream.

getRelatedSchemas

java.lang.String[] getRelatedSchemas(java.lang.String payloadVersion)

Method that should return related schemas used during payload schema validation.

Parameters:

payloadVersion - payload version.

Returns:

an array of related schemas if no related schemas exists is empty array returned, never null.