public class DocTool
extends java.lang.Object
Document tools
Modifier and Type | Field and Description |
---|---|
static int |
INDEX_MODE_NONE |
static int |
INDEX_MODE_RICH |
static int |
INDEX_MODE_TEXT |
Constructor and Description |
---|
DocTool() |
Modifier and Type | Method and Description |
---|---|
static void |
clearCache() |
static java.lang.String |
createIndex(Grant g,
java.lang.String docId,
java.lang.String rpath,
java.lang.String bookshelf,
java.util.Vector<java.lang.String> fields) |
static java.lang.String |
delete(Grant g,
java.lang.String docId,
java.lang.String bookshelf,
java.lang.String rpath) |
static java.lang.String |
deleteBookshelf(ObjectDB bookshelf) |
static void |
deleteFile(java.lang.String path)
Delete a file in local file system
|
static java.lang.String |
deleteIndex(Grant g,
java.lang.String docId,
java.lang.String bookshelf,
java.lang.String rpath) |
static java.util.Hashtable<java.lang.String,Bookshelf> |
getAllBookshelfs()
Cache of bookshelf definitions
|
static java.util.Vector<java.lang.String> |
getAllGroups() |
static Bookshelf |
getBookshelf(java.lang.String name)
Retrieve a bookshelf definition
|
static java.lang.String |
getBookshelfOfDocId(java.lang.String docId)
Get the name of bookshelf linked to a doc, null otherwise
|
static java.lang.String |
getBookshelfOfField(java.lang.String fieldName)
Get the name of bookshelf linked to a field, null otherwise
|
static java.lang.String |
getContentType(java.lang.String mime)
Get content type from MIME type (adding chararcter encoding when required)
|
static java.lang.String |
getDocContent(DocumentDB doc)
Retrieve the doc content using document content parsers
(txt, xml, doc, docx, xls, xlsx, ppt, pptx, pdf...)
|
static int[] |
getDocGrant(Grant g,
java.lang.String docId) |
static java.lang.String |
getDocMime(java.lang.String docId) |
static DocumentDB |
getDocument(Grant g,
java.lang.String docId,
boolean bIndex,
boolean bGrant)
Instantiate a document
|
static java.lang.String |
getExtension(java.lang.String mime)
Get file extension from MIME type
|
static java.util.Hashtable<java.lang.String,Bookshelf> |
getExternalBookshelfs() |
static java.io.File |
getFile(java.lang.String path)
Get the document as a local file
|
static Message |
getFileInfo(java.lang.String docId)
Get a document
|
static java.lang.String |
getFileName(java.lang.String docId) |
static java.lang.String |
getFilePath(java.lang.String docId) |
static java.util.Vector<java.lang.String> |
getIndexedDocObjects()
Objects with simple indexable doc
|
static int |
getIndexMode(java.lang.String ext)
Get indexation mode (one of DocTool.INDEX_MOD_* constant) from file extension
|
static java.lang.String |
getMime(java.lang.String ext)
Deprecated.
|
static java.lang.String |
getMIMEType(java.lang.String ext)
Get MIME type from file extension
|
static java.lang.String |
getThumbnailOrigin(java.lang.String thumbnailPath) |
static java.lang.String |
getThumbnailPath(java.lang.String path)
Get thumbnail image path from specified document path (only relevant for images with thumbnail)
|
static java.lang.String |
getURL(DocumentDB doc,
java.lang.String cdisp,
boolean cache,
boolean thumbnail)
Get URL for specified document
|
static java.lang.String |
getURL(ObjectDB obj,
ObjectField field,
boolean cache,
boolean thumbnail)
Get URL for specified document
|
static java.lang.String |
getURL(java.lang.String path,
java.lang.String cdisp,
java.lang.String mime) |
static boolean |
isGrantActive() |
static boolean |
isGrantEnable(java.lang.String docId) |
static boolean |
isIndexActive() |
static boolean |
isThumbnailPath(java.lang.String path)
Is a thumbnail ?
|
static byte[] |
readFile(java.lang.String path)
Read a file from a document path
|
static java.io.ByteArrayInputStream |
readFileAsStream(java.lang.String path)
Read a file as an input stream from a document path
|
static java.lang.String |
rebuildIndex(ObjectDB docIndex,
Grant g,
java.lang.String bookshelf) |
static java.lang.String |
saveGrant(Grant g,
java.lang.String docId,
java.lang.String respLogin,
java.util.Hashtable<java.lang.String,java.lang.String> grp,
boolean ondemand) |
static java.lang.String |
sendDocDemand(Grant g,
java.lang.String docId,
java.lang.String email,
java.lang.String message) |
static java.lang.String |
synchronize(Grant g) |
static Message |
upload(Grant g,
java.lang.String docId,
java.lang.String path,
byte[] data,
boolean vers,
java.lang.String object,
java.lang.String field,
java.lang.String rowId,
java.lang.String bookshelf,
java.util.Vector<java.lang.String> indexValues,
java.lang.String respLogin,
java.util.Hashtable<java.lang.String,java.lang.String> group,
boolean ondemand)
Upload a document in DBDOC
|
static void |
writeFile(java.lang.String path,
byte[] data)
Write a file
|
static void |
writeFile(java.lang.String path,
byte[] data,
boolean append)
Write a file
|
public static final int INDEX_MODE_NONE
public static final int INDEX_MODE_RICH
public static final int INDEX_MODE_TEXT
public static boolean isIndexActive()
public static boolean isGrantActive()
public static java.util.Vector<java.lang.String> getIndexedDocObjects()
public static Bookshelf getBookshelf(java.lang.String name)
public static java.lang.String getBookshelfOfField(java.lang.String fieldName)
public static java.lang.String getBookshelfOfDocId(java.lang.String docId)
public static java.util.Hashtable<java.lang.String,Bookshelf> getAllBookshelfs()
public static java.util.Hashtable<java.lang.String,Bookshelf> getExternalBookshelfs()
public static java.util.Vector<java.lang.String> getAllGroups()
public static void clearCache()
public static DocumentDB getDocument(Grant g, java.lang.String docId, boolean bIndex, boolean bGrant)
g
- User rightsdocId
- Document IdbIndex
- Load indexes ?bGrant
- Load rights ?public static Message upload(Grant g, java.lang.String docId, java.lang.String path, byte[] data, boolean vers, java.lang.String object, java.lang.String field, java.lang.String rowId, java.lang.String bookshelf, java.util.Vector<java.lang.String> indexValues, java.lang.String respLogin, java.util.Hashtable<java.lang.String,java.lang.String> group, boolean ondemand)
g
- User rightsdocId
- Existing doc ID (optional to create or find the doc with the object row ID)path
- Original path to the filedata
- File bytes array when the path is not accessiblevers
- True to increment the version if doc already existsobject
- Object name (optional)field
- Object field name (optional)rowId
- Object row ID(optional)bookshelf
- Bookshelf name (optional)indexValues
- Indexed fields (optional)respLogin
- Owner login (optional)group
- Doc grantsondemand
- Manage the doc requestspublic static java.lang.String getThumbnailPath(java.lang.String path)
public static boolean isThumbnailPath(java.lang.String path)
public static java.lang.String getThumbnailOrigin(java.lang.String thumbnailPath)
public static java.lang.String createIndex(Grant g, java.lang.String docId, java.lang.String rpath, java.lang.String bookshelf, java.util.Vector<java.lang.String> fields)
public static java.lang.String deleteBookshelf(ObjectDB bookshelf) throws java.lang.Exception
java.lang.Exception
public static java.lang.String delete(Grant g, java.lang.String docId, java.lang.String bookshelf, java.lang.String rpath) throws java.lang.Exception
java.lang.Exception
public static java.lang.String deleteIndex(Grant g, java.lang.String docId, java.lang.String bookshelf, java.lang.String rpath) throws java.lang.Exception
java.lang.Exception
public static java.lang.String saveGrant(Grant g, java.lang.String docId, java.lang.String respLogin, java.util.Hashtable<java.lang.String,java.lang.String> grp, boolean ondemand)
public static int[] getDocGrant(Grant g, java.lang.String docId)
public static boolean isGrantEnable(java.lang.String docId)
public static java.lang.String getDocMime(java.lang.String docId)
public static java.lang.String getFileName(java.lang.String docId)
public static java.lang.String getFilePath(java.lang.String docId)
public static java.io.File getFile(java.lang.String path)
public static Message getFileInfo(java.lang.String docId)
docId
- Document idpublic static java.lang.String getURL(java.lang.String path, java.lang.String cdisp, java.lang.String mime)
public static java.lang.String getURL(DocumentDB doc, java.lang.String cdisp, boolean cache, boolean thumbnail)
doc
- Documentcdisp
- Content dispositioncache
- Allow HTTP cachethumbnail
- Thumbnail URLpublic static java.lang.String getURL(ObjectDB obj, ObjectField field, boolean cache, boolean thumbnail)
obj
- Objectfield
- Fieldcache
- Allow HTTP cachethumbnail
- Thumbnail URLpublic static byte[] readFile(java.lang.String path)
path
- Document pathpublic static java.io.ByteArrayInputStream readFileAsStream(java.lang.String path) throws java.io.IOException
path
- Document pathjava.io.IOException
public static void writeFile(java.lang.String path, byte[] data) throws java.lang.Exception
path
- Document pathdata
- Document datajava.lang.Exception
public static void writeFile(java.lang.String path, byte[] data, boolean append) throws java.lang.Exception
path
- Document pathdata
- Document dataappend
- Append file ?java.lang.Exception
public static void deleteFile(java.lang.String path) throws java.lang.Exception
path
- Document pathjava.lang.Exception
public static java.lang.String synchronize(Grant g) throws java.lang.Exception
java.lang.Exception
public static java.lang.String rebuildIndex(ObjectDB docIndex, Grant g, java.lang.String bookshelf) throws java.lang.Exception
java.lang.Exception
public static java.lang.String getDocContent(DocumentDB doc) throws java.lang.Exception
doc
- Documentjava.lang.Exception
public static java.lang.String getExtension(java.lang.String mime)
mime
- MIME typepublic static java.lang.String getContentType(java.lang.String mime)
mime
- Raw MIME type@Deprecated public static java.lang.String getMime(java.lang.String ext) throws java.lang.Exception
java.lang.Exception
public static java.lang.String getMIMEType(java.lang.String ext)
ext
- Extension or pathpublic static int getIndexMode(java.lang.String ext)
ext
- Extensionpublic static java.lang.String sendDocDemand(Grant g, java.lang.String docId, java.lang.String email, java.lang.String message) throws java.lang.Exception
java.lang.Exception
Copyright (c)2006-2014 Simplicite Software. All Rights Reserved.