Package com.logicaldoc.stamp.automation
Class StampTool
java.lang.Object
com.logicaldoc.stamp.automation.StampTool
Class to apply stamps into documents from inside the Automation
- Since:
- 7.5.1
- Author:
- Marco Meschieri - LogicalDOC
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetSignature
(String username) Retrieves the Base64-encoded image representing the signature of the gien uservoid
stamp
(com.logicaldoc.core.document.Document doc, Stamp stamp, com.logicaldoc.core.security.user.User user) Applies a stamp in the given document in the name of the given uservoid
stamp
(com.logicaldoc.core.document.Document doc, String stampName, com.logicaldoc.core.security.user.User user) Applies a stamp in the given document in the name of the given uservoid
Applies a stamp in the given document in the name of the given uservoid
stamp
(com.logicaldoc.core.document.Document doc, String stampName, Map<String, Object> parameters, com.logicaldoc.core.security.user.User user) Applies a stamp in the given document in the name of the given uservoid
stamp
(com.logicaldoc.core.document.Document doc, String stampName, Map<String, Object> parameters, String username) Applies a stamp in the given document in the name of the given user
-
Constructor Details
-
StampTool
public StampTool()
-
-
Method Details
-
stamp
public void stamp(com.logicaldoc.core.document.Document doc, Stamp stamp, com.logicaldoc.core.security.user.User user) throws com.logicaldoc.core.PersistenceException, FeatureNotEnabledException, IOException, com.logicaldoc.util.crypt.CryptUtil.EncryptionException Applies a stamp in the given document in the name of the given user- Parameters:
doc
- the document to stampstamp
- the stamp to apply (use stamp.parameters to pass your dynamic parameters to the stamp automation)user
- the current user- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.util.crypt.CryptUtil.EncryptionException
- Cannot decrypt the stamp imageIOException
- I/O errorFeatureNotEnabledException
- The feature is not enabled in the license
-
stamp
public void stamp(com.logicaldoc.core.document.Document doc, String stampName, Map<String, Object> parameters, com.logicaldoc.core.security.user.User user) throws com.logicaldoc.core.PersistenceException, FeatureNotEnabledException, IOException, com.logicaldoc.util.crypt.CryptUtil.EncryptionExceptionApplies a stamp in the given document in the name of the given user- Parameters:
doc
- the document to stampstampName
- name of the stamp to applyuser
- the current userparameters
- optional map of parameters to pass to the Stamp automation- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.util.crypt.CryptUtil.EncryptionException
- Cannot decrypt the stamp imageIOException
- I/O errorFeatureNotEnabledException
- The feature is not enabled in the license
-
stamp
public void stamp(com.logicaldoc.core.document.Document doc, String stampName, com.logicaldoc.core.security.user.User user) throws com.logicaldoc.core.PersistenceException, FeatureNotEnabledException, IOException, com.logicaldoc.util.crypt.CryptUtil.EncryptionException Applies a stamp in the given document in the name of the given user- Parameters:
doc
- the document to stampstampName
- name of the stamp to applyuser
- the current user- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.util.crypt.CryptUtil.EncryptionException
- Cannot decrypt the stamp imageIOException
- I/O errorFeatureNotEnabledException
- The feature is not enabled in the license
-
stamp
public void stamp(com.logicaldoc.core.document.Document doc, String stampName, Map<String, Object> parameters, String username) throws com.logicaldoc.core.PersistenceException, FeatureNotEnabledException, IOException, com.logicaldoc.util.crypt.CryptUtil.EncryptionExceptionApplies a stamp in the given document in the name of the given user- Parameters:
doc
- the document to stampstampName
- name of the stamp to applyparameters
- optional map of parameters to pass to the Stamp automationusername
- the username of the current user- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.util.crypt.CryptUtil.EncryptionException
- Cannot decrypt the stamp imageIOException
- I/O errorFeatureNotEnabledException
- The feature is not enabled in the license
-
stamp
public void stamp(com.logicaldoc.core.document.Document doc, String stampName, String username) throws com.logicaldoc.core.PersistenceException, FeatureNotEnabledException, IOException, com.logicaldoc.util.crypt.CryptUtil.EncryptionException Applies a stamp in the given document in the name of the given user- Parameters:
doc
- the document to stampstampName
- name of the stamp to applyusername
- the username of the current user- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.util.crypt.CryptUtil.EncryptionException
- Cannot decrypt the stamp imageIOException
- I/O errorFeatureNotEnabledException
- The feature is not enabled in the license
-
getSignature
Retrieves the Base64-encoded image representing the signature of the gien user- Parameters:
username
- The username of the user- Returns:
- Base64-encoded image
- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layer
-