com.tsgrp.opencontent.core.openoverlay

Class OpenOverlayUtil

java.lang.Object

com.tsgrp.opencontent.core.openoverlay.OpenOverlayUtil

public class OpenOverlayUtil
extends java.lang.Object

Overlay util methods to apply document overlays.

Constructor Summary

Constructors

Constructor and Description
OpenOverlayUtil()

Method Summary

Modifier and Type	Method and Description
void	addAdditionalOverlayParams(java.lang.String ticket, OpenContentObject oco, java.util.Map<java.lang.String,java.lang.Object> params) Hotspot method that allows clients to add additional overlay parameters to the properties map as needed.
static byte[]	applyOverlays(byte[] pdf, java.util.Map<java.lang.String,java.lang.Object> overlayParameters) Helper method to generate a byte[] that has been passed through OpenOverlay with the overlay parameters passed in.
static void	applyOverlays(byte[] pdf, java.util.Map<java.lang.String,java.lang.Object> overlayParameters, java.io.OutputStream os) Helper method to generate a byte[] that has been passed through OpenOverlay with the overlay parameters passed in.
void	applyOverlays(java.lang.String ticket, ContentResult contentResult, java.io.OutputStream os) Gets the PDF content from the repository and Overlays it using OpenOverlay.
byte[]	applyOverlays(java.lang.String ticket, java.lang.String objectId) Gets the PDF content from the repository and Overlays it using OpenOverlay.
byte[]	applyOverlays(java.lang.String ticket, java.lang.String objectId, long lastModified) Helper method to generate a byte[] that has been passed through OpenOverlay.
static java.io.OutputStream	applyOverlaysFileStream(java.io.OutputStream overlayFos, java.io.File file, java.util.Map<java.lang.String,java.lang.Object> overlayParameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenOverlayUtil

public OpenOverlayUtil()

Method Detail

applyOverlays

public static void applyOverlays(byte[] pdf,
                                 java.util.Map<java.lang.String,java.lang.Object> overlayParameters,
                                 java.io.OutputStream os)
                          throws java.lang.Exception

Helper method to generate a byte[] that has been passed through OpenOverlay with the overlay parameters passed in. This method uses no caching, so if you call it, it will give you a brand new run of OpenOverlay with the given content

Parameters:

ticket -

pdf -

overlayParameters -

os -

Throws:

java.lang.Exception

applyOverlays

public static byte[] applyOverlays(byte[] pdf,
                                   java.util.Map<java.lang.String,java.lang.Object> overlayParameters)
                            throws java.lang.Exception

Helper method to generate a byte[] that has been passed through OpenOverlay with the overlay parameters passed in. This method uses no caching, so if you call it, it will give you a brand new run of OpenOverlay with the given content It duplicates memory, so don't use it if you are just attempting to write to an outputstream the result of the overlay process.

Parameters:

ticket -

pdf -

overlayParameters -

Returns:

overlaid PDF

Throws:

java.lang.Exception

applyOverlaysFileStream

public static java.io.OutputStream applyOverlaysFileStream(java.io.OutputStream overlayFos,
                                                           java.io.File file,
                                                           java.util.Map<java.lang.String,java.lang.Object> overlayParameters)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

applyOverlays

@Cacheable(value="oc-document-overlays",
           key="{#objectId, #lastModified}")
public byte[] applyOverlays(java.lang.String ticket,
                                                                                                                    java.lang.String objectId,
                                                                                                                    long lastModified)
                                                                                                             throws java.lang.Exception

Helper method to generate a byte[] that has been passed through OpenOverlay. This method employs caching, so requires that you pass in the lastModified ms since epoch which will force the cache to pull the byte[] again if you pass in a different lastModified than what is already in the cache. It duplicates memory, so don't use it if you are just attempting to write to an outputstream the result of the overlay process.

Parameters:

ticket -

pdf -

objectId -

lastModified -

Returns:

overlaid PDF!

Throws:

java.lang.Exception

applyOverlays

public void applyOverlays(java.lang.String ticket,
                          ContentResult contentResult,
                          java.io.OutputStream os)
                   throws java.lang.Exception

Gets the PDF content from the repository and Overlays it using OpenOverlay. Will error if there is no PDF content for this objectId. This method adds the OC default overlay parameters.

Parameters:

ticket - the OC ticket

contentResult - the PDF content

os - the OutputStream to stream the overlaid content to

Throws:

java.lang.Exception - if an error occurs

applyOverlays

public byte[] applyOverlays(java.lang.String ticket,
                            java.lang.String objectId)
                     throws java.lang.Exception

Gets the PDF content from the repository and Overlays it using OpenOverlay. Will error if there is no PDF content for this objectId. This method adds the OC default overlay parameters.

Parameters:

ticket -

objectId -

Returns:

overlaid pdf

Throws:

java.lang.Exception

addAdditionalOverlayParams

public void addAdditionalOverlayParams(java.lang.String ticket,
                                       OpenContentObject oco,
                                       java.util.Map<java.lang.String,java.lang.Object> params)

Hotspot method that allows clients to add additional overlay parameters to the properties map as needed. This core version does nothing.

Parameters:

ticket - the OC ticket

oco - the OCO

starting - properties