Defining the component XML file for the signature handler

You must define a component XML file to deploy the signature handler, which is a LiveCycle ES component. A component XML file exists for each component and provides metadata about the component. (See Component XML Elements.)

When creating the component XML file for the signature handler, you can use the import-packages element to specify the packages that must be referenced by the signature handler. The following XML data specifies the import-packages that must be specified within the component XML file.

<import-packages>

<package>com.adobe.livecycle.signatures.client.spi.types</package> 

<package>com.adobe.livecycle.signatures.client.spi.types.exceptions</package> 

<package>com.adobe.livecycle.signatures.client</package> 

<package>com.adobe.livecycle.signatures.client.types</package> 

<package>com.adobe.livecycle.signatures.client.types.exceptions</package> 

</import-packages>

Note: The Signatures JAR file (adobe-signatures-client.jar) must be referenced in the component XML file’s class-path element in order to avoid classloading errors.

The following component.xml file is used for the signature handler. Notice that the service name is SamplePKIProviderServiceEx and the operation that this service exposes is sign.

Example: Defining the component XML file for the signature handler

<component xmlns="http://adobe.com/idp/dsc/component/document">

	<component-id>com.adobe.livecycle.externalpkiprovider</component-id>

    <version>1.0</version>

	<class-path>adobe-livecycle-client.jar adobe-usermanager-client.jar adobe-utilities.jar commons-io-1.4.jar xalan.jar xercesImpl.jar log4j.jar commons-fileupload-1.2.jar commons-codec-1.3.jar bcmail-jdk15-135.jar bcprov-jdk15-135.jar jsafeFIPS.jar jsafeJCEFIPS.jar certjFIPS.jar</class-path>

	<import-packages>

		<package>com.adobe.livecycle.signatures.client.spi.types</package> 

    	<package>com.adobe.livecycle.signatures.client.spi.types.exceptions</package> 

     	<package>com.adobe.livecycle.signatures.client</package> 

		 <package>com.adobe.livecycle.signatures.client.types</package> 

		<package>com.adobe.livecycle.signatures.client.types.exceptions</package> 

	</import-packages>

	<services>

		<service name="SamplePKIProviderServiceEx">

			<implementation-class>com.adobe.livecycle.externalpkiprovider.service.impl.ExternalPKIService</implementation-class>

			<!--*****-->

			<supported-connectors>default</supported-connectors>	

			<!--**************************************************************-->

			<operations>

				<!--AddInvisibleSignature Operation-->

				<operation name="sign" title="Sign the Hash" method="sign" orchestrateable="true">

					<description>Returns a PKCS7 packet in return of hash provided.</description>

						<input-parameter name="SignRequest" type="com.adobe.livecycle.signatures.client.spi.types.SignRequest" title="Sign Request" required="false">

					 		<description>This structure contains hash which is to be encrypted to create a pkcs7 parameter and all the options to generate the pkcs7 packet</description>

						</input-parameter>

					<output-parameter name="signResp"

						type="com.adobe.livecycle.signatures.client.spi.types.SignResponse" title="Sign Response">

						<description>the data structure containing the result as well as the status of Signing operation</description>

					</output-parameter>

					<faults>

						<fault name = "SigningException" type = "com.adobe.livecycle.signatures.client.spi.types.exceptions.SigningException"/>

					</faults>					

				</operation>

			</operations>

		</service>

	</services>

</component>

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/help/000924_2.html

Add Comment