From 30db55cc7a7a9bfa67b321e66bb8d1b1abf7afc9 Mon Sep 17 00:00:00 2001
From: Thomas Lenz
-Invoking the MOA SP/SS API
-The names of the MOA SP/SS API classes have been chosen to correspond to the
-MOA SP/SS schema elements. The structure of the classes (i.e., their fields)
-also corresponds to the structure of the respective MOA SP/SS schema elements.
-However, a few classes escape this naming convention, mainly because the
-corresponding schema elements contain Using the MOA SP/SS API
-
-Invoking the services
-In general, invoking the MOA SP/SS API involves the following steps:
-
-
-
-moa.spss.server.configuration
system property to point
-to the main MOA SP/SS configuration file. This needs to be done only once per
-JVM instance. You may also call
-{@link at.gv.egovernment.moa.spss.api.Configurator#init} at this point to
-pre-initialize MOA SP/SS (if not, it is done automatically upon service
-invocation).getInstance()
method.create...
methods of the SPSSFactory
to
-create the desired {@link at.gv.egovernment.moa.spss.api.xmlsign.CreateXMLSignatureRequest},
-{@link at.gv.egovernment.moa.spss.api.cmsverify.VerifyCMSSignatureRequest} or
-{@link at.gv.egovernment.moa.spss.api.xmlverify.VerifyXMLSignatureRequest} object.
-createXMLSignature()
},
-{@link at.gv.egovernment.moa.spss.api.SignatureVerificationService#verifyCMSSignature(at.gv.egovernment.moa.spss.api.cmsverify.VerifyCMSSignatureRequest) verifyCMSSignature()
} or
-{@link at.gv.egovernment.moa.spss.api.SignatureVerificationService#verifyXMLSignature(at.gv.egovernment.moa.spss.api.xmlverify.VerifyXMLSignatureRequest) verifyXMLSignature()
}.
-CreateXMLSignatureResponse
.
-Creating MOA SP/SS API objects
-Service
classes involves creating
-a Request
object using the {@link at.gv.egovernment.moa.spss.api.SPSSFactory SPSSFactory}.
-Object creation using the SPSSFactory
is always bottom-up, meaning
-that in order to create an object all of its components must have been created
-before.
-xsd:choice
components:
-
-
-
-Profile
classes have subclasses called
-ProfileID
and ProfileExplicit
-(e.g., {@link at.gv.egovernment.moa.spss.api.xmlsign.CreateTransformsInfoProfileID} and
-{@link at.gv.egovernment.moa.spss.api.xmlsign.CreateTransformsInfoProfileExplicit}),
-so that the profile can be given either as an ID (which is to be resolved from the
-MOA SP/SS configuration) or explicitly.
-For clarity, the MOA SP/SS API classes have been organized in several packages -listed in the following table: -
- -Package | Purpose | -
{@link at.gv.egovernment.moa.spss.api.xmlsign} | -Components of the {@link at.gv.egovernment.moa.spss.api.xmlsign.CreateXMLSignatureRequest} and - {@link at.gv.egovernment.moa.spss.api.xmlsign.CreateXMLSignatureResponse} | -
{@link at.gv.egovernment.moa.spss.api.cmsverify} | -Components of the - {@link at.gv.egovernment.moa.spss.api.cmsverify.VerifyCMSSignatureRequest} and - {@link at.gv.egovernment.moa.spss.api.cmsverify.VerifyCMSSignatureResponse} | -
{@link at.gv.egovernment.moa.spss.api.xmlverify} | -Components of the - {@link at.gv.egovernment.moa.spss.api.xmlverify.VerifyXMLSignatureRequest} and - {@link at.gv.egovernment.moa.spss.api.xmlverify.VerifyXMLSignatureResponse} | -
{@link at.gv.egovernment.moa.spss.api.common} | -Common components used across the classes of the above packages | -
CreateXMLSignatureRequest
,
-VerifyCMSSignatureRequest
or
-VerifyCMSSignatureRequest
into its respective MOA SP/SS API object
-representation. For example, to parse a CreateXMLSignatureRequest
-DOM tree, the {@link at.gv.egovernment.moa.spss.api.xmlbind.CreateXMLSignatureRequestParser#parse(org.w3c.dom.Element) CreateXMLSignatureRequestParser.parse()}
-method can be used. CreateXMLSignatureResponse
,
-VerifyCMSSignatureResponse
or a
-VerifyXMLSignatureResponse
DOM tree from the respective MOA SP/SS
-API object. For example, to build a VerifyXMLSignatureResponse
-DOM tree, the {@link at.gv.egovernment.moa.spss.api.xmlbind.VerifyXMLSignatureResponseBuilder#build(at.gv.egovernment.moa.spss.api.xmlverify.VerifyXMLSignatureResponse) VerifyXMLSignatureResponseBuilder.build()}
-can be used.The packages {@link at.gv.egovernment.moa.util} and -{@link at.gv.egovernment.moa.spss.util} contain utility classes developed for -the MOA SP/SS implementation. Since the classes contained in these packages are -tailored towards the MOA SP/SS implementation, they are far from being complete -in the sense of providing a utility class library. Therefore, they may or may -not prove useful in the context of your application. Their interfaces may also -change in future releases. -
- -The package {@link at.gv.egovernment.moa.logging} contains classes for -logging messages to the MOA SP/SS log hierarchy via the -{@link at.gv.egovernment.moa.logging.Logger} class. -
- -