Package com.arbortext.e3c

Interface E3ClientCompositionExtension

public interface E3ClientCompositionExtension

Interface that provides composition operation type-specific pre- and post-processing support.

Method Summary

Modifier and Type	Method	Description
void	postProcess(Map<String,String> params, E3ServerCompositionResult result, JarFile responseJar, E3Tracer tracer)	Called by the E3 client composer after a normal return from E3.
void	preProcess(File inputDir, E3ServerCompositionRequest request, Map localParms, E3Tracer tracer)	Called by the E3 client composer just before the parameter docuemnt is saved to disk.

Method Details

preProcess

void preProcess(File inputDir,
 E3ServerCompositionRequest request,
 Map localParms,
 E3Tracer tracer)
         throws Exception

Called by the E3 client composer just before the parameter docuemnt is saved to disk.

Parameters:

inputDir - directory of files that will be combined in a JAR and transmitted to E3

request - XML document containing composition parameters that will be written to inputDir under the name 'index.xml' and sent to E3 as part of the JAR

localParms - MAP of String names and values that will not be transmitted to E3.

tracer - object to use in tracing activity

Throws:

Exception - if error is detected

postProcess

void postProcess(Map<String,String> params,
 E3ServerCompositionResult result,
 JarFile responseJar,
 E3Tracer tracer)
          throws Exception

Called by the E3 client composer after a normal return from E3.

Parameters:

params - MAP of String names and values related to composition

result - result document describing operation output

responseJar - open JAR of files returned by E3

tracer - object to which to write tracing info

Throws:

Exception - upon any error