Package org.certificateservices.messages.csexport.protocol

Class CSExportProtocolPayloadParser

java.lang.Object

org.certificateservices.messages.csmessages.BasePayloadParser

org.certificateservices.messages.csexport.protocol.CSExportProtocolPayloadParser

All Implemented Interfaces:

PayloadParser

public class CSExportProtocolPayloadParser
extends BasePayloadParser

Payload Parser for generating CS Export Protocol messages according to cs_export_protocol_schema2_0.xsd

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CS_EXPORT_PROTOCOL_XSD_SCHEMA_2_0_RESOURCE_LOCATION
static java.lang.String	NAMESPACE

Fields inherited from class org.certificateservices.messages.csmessages.BasePayloadParser

config, csMessageObjectFactory, customCSMessageParser, payloadVersion, secProv

Constructor Summary

Constructors

Constructor	Description
CSExportProtocolPayloadParser()

Method Summary

Modifier and Type	Method	Description
byte[]	genGetCSExportRequest(java.lang.String requestId, java.lang.String destinationId, java.lang.String organisation, java.lang.String exportDataVersion, java.util.List<QueryParameter> queryParameters, Credential originator, java.util.List<java.lang.Object> assertions)	Method to create a GetRequesterRolesRequest message for a specified version of the CSExportData version..
CSMessageResponseData	genGetCSExportResponse(java.lang.String relatedEndEntity, CSMessage request, java.lang.String exportDataVersion, java.lang.Object csExportData, java.util.List<java.lang.Object> assertions)	Method to a GetRequesterRolesResponse message and populating it with the all requesters authorized roles.
CSExport	getCSExportDataFromResponse(CSMessage resp)	Help method to extract the CSExport data form a GetCSExportResponse CSMessage.
protected java.lang.String	getDefaultPayloadVersion()
java.lang.String	getJAXBPackage()	Method that returns the JAXBPackage Name for the package name containing the JAXB classes.
java.lang.String	getNameSpace()
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()
protected java.lang.String[]	getSupportedVersions()

Methods inherited from class org.certificateservices.messages.csmessages.BasePayloadParser

generateGetApprovalRequest, generateIsApprovedRequest, getAssertions, getCSMessageParser, getPayload, getPayloadVersion, getRelatedSchemas, getResponseStatus, init, init, isPayloadVersionSupported, parseMessage, parseMessage, parseMessage, setPayloadVersion

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static java.lang.String NAMESPACE

CS_EXPORT_PROTOCOL_XSD_SCHEMA_2_0_RESOURCE_LOCATION

public static final java.lang.String CS_EXPORT_PROTOCOL_XSD_SCHEMA_2_0_RESOURCE_LOCATION

See Also:

Constant Field Values

Constructor Detail

CSExportProtocolPayloadParser

public CSExportProtocolPayloadParser()

Method Detail

getJAXBPackage

public java.lang.String getJAXBPackage()

Description copied from interface: PayloadParser

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

See Also:

PayloadParser.getJAXBPackage()

getNameSpace

public java.lang.String getNameSpace()

Returns:

the related pay load elements unique name space.

See Also:

PayloadParser.getNameSpace()

getSchemaAsInputStream

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

Description copied from interface: PayloadParser

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.

See Also:

PayloadParser.getSchemaAsInputStream(String)

getSupportedVersions

protected java.lang.String[] getSupportedVersions()

Specified by:

getSupportedVersions in class BasePayloadParser

Returns:

an array of version numbers of payload that is supported by this parser.

See Also:

BasePayloadParser.getSupportedVersions()

getDefaultPayloadVersion

protected java.lang.String getDefaultPayloadVersion()

Specified by:

getDefaultPayloadVersion in class BasePayloadParser

Returns:

returns the payload version used by default when generating request messages.

See Also:

BasePayloadParser.getDefaultPayloadVersion()

genGetCSExportRequest

public byte[] genGetCSExportRequest(java.lang.String requestId,
                                    java.lang.String destinationId,
                                    java.lang.String organisation,
                                    java.lang.String exportDataVersion,
                                    java.util.List<QueryParameter> queryParameters,
                                    Credential originator,
                                    java.util.List<java.lang.Object> assertions)
                             throws MessageContentException,
                                    MessageProcessingException

Method to create a GetRequesterRolesRequest message for a specified version of the CSExportData version..

Parameters:

requestId - the id of the request

destinationId - the destinationId used in the CSMessage.

organisation - the related organisation

exportDataVersion - version of the export data to export

queryParameters - a list of query parameters, if null or empty list will no query parameters be specified.

originator - the original requester of a message, null if not applicable

assertions - a list of related authorization assertions, or null if no authorization assertions is available.

Returns:

generated and signed CSMessage in byte[] format.

Throws:

MessageContentException - if CS message contained invalid data not conforming to the standard.

MessageProcessingException - if internal state occurred when processing the CSMessage

genGetCSExportResponse

public CSMessageResponseData genGetCSExportResponse(java.lang.String relatedEndEntity,
                                                    CSMessage request,
                                                    java.lang.String exportDataVersion,
                                                    java.lang.Object csExportData,
                                                    java.util.List<java.lang.Object> assertions)
                                             throws MessageContentException,
                                                    MessageProcessingException

Method to a GetRequesterRolesResponse message and populating it with the all requesters authorized roles.

Parameters:

relatedEndEntity - the name of the related end entity (such as username of the related user)

request - the request to populate the response with

exportDataVersion - version of the export data to export

csExportData - The CSExport Data to set in the response.

assertions - a list of related authorization assertions, or null if no authorization assertions is available.

Returns:

a generated message.

Throws:

MessageContentException - if CS message contained invalid data not conforming to the standard.

MessageProcessingException - if internal state occurred when processing the CSMessage

getCSExportDataFromResponse

public CSExport getCSExportDataFromResponse(CSMessage resp)
                                     throws MessageContentException,
                                            MessageProcessingException

Help method to extract the CSExport data form a GetCSExportResponse CSMessage.

Parameters:

resp - the CSMessage, never null

Returns:

he internal CSExport object.

Throws:

MessageContentException - when failure illegal argument message response is received.

MessageProcessingException - when no CS export data can be parsed from response.