DefaultDocumentManager (com.onlyoffice:docs-integration-sdk 1.3.0 API)

java.lang.Object
- com.onlyoffice.manager.document.DefaultDocumentManager

All Implemented Interfaces:: DocumentManager

public abstract class DefaultDocumentManager
extends Object
implements DocumentManager

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`DEFAULT_MAX_FILE_SIZE` Defines the default maximum file size, used if the "integration-sdk.data.filesize.editing.max" or "integration-sdk.data.filesize.conversion.max" properties are not specified in "settings.properties".
`private static String`	`DOCS_FORMATS_JSON_PATH` Path to the matrix of formats supported by the ONLYOFFICE Editor.
`private static List<Format>`	`formats` Defines a list containing data about supported formats.
`private SettingsManager`	`settingsManager` `SettingsManager`.

Constructor Summary

Constructors
Constructor and Description

DefaultDocumentManager()

Constructors
Constructor and Description
`DefaultDocumentManager()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBaseName(String fileName)` Returns the file base name without the full path and extension.
`List<String>`	`getCompareFileExtensions()` Returns a list of extensions that can be used for the document comparison functions.
`List<String>`	`getConvertExtensionList(String fileName)` Returns a list of extensions that the document with the name specified in the request can be converted to.
`String`	`getDefaultConvertExtension(String fileName)` Returns the default OOXML extension to which the document with the name specified in the request should be converted.
`String`	`getDefaultExtension(DocumentType documentType)` Returns the default OOXML extension by the specified document type.
`abstract String`	`getDocumentKey(String fileId, boolean embedded)` Generates a unique document identifier used by the service to recognize the document.
`abstract String`	`getDocumentName(String fileId)` Returns the document name by file ID.
`DocumentType`	`getDocumentType(String fileName)` Returns the document type by the file name.
`String`	`getExtension(String fileName)` Returns the file extension from the file name.
`List<Format>`	`getFormats()` Returns a list of file formats (electronic documents, forms, spreadsheets, presentations) supported by the ONLYOFFICE editors.
`List<String>`	`getInsertImageExtensions()` Returns a list of image extensions that can be inserted into the document.
`Map<String,Boolean>`	`getLossyEditableMap()` Returns a map of extensions that can be edited with the possible loss of information.
`List<String>`	`getMailMergeExtensions()` Returns a list of extensions that can be used for mail merge in the document.
`long`	`getMaxConversionFileSize()` Returns the maximum file size that can be converted in the ONLYOFFICE Conversion Service.
`long`	`getMaxFileSize()` Returns the maximum file size that can be opened in the ONLYOFFICE editor.
`InputStream`	`getNewBlankFile(String extension, Locale locale)` Returns `InputStream` of an empty file with the given extension and locale.
`boolean`	`hasAction(String fileName, String action)` Determines whether an action can be performed on a document with a name specified in the request.
`protected static void`	`init()`
`boolean`	`isEditable(String fileName)` Determines whether a document with a name specified in the request is editable.
`boolean`	`isFillable(String fileName)` Determines whether a document with a name specified in the request is fillable.
`boolean`	`isForm(InputStream inputStream)` Determines whether a file is form.
`boolean`	`isViewable(String fileName)` Determines whether a document with a name specified in the request is viewable.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DOCS_FORMATS_JSON_PATH
```
private static final String DOCS_FORMATS_JSON_PATH
```
    Path to the matrix of formats supported by the ONLYOFFICE Editor.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_FILE_SIZE
```
private static final int DEFAULT_MAX_FILE_SIZE
```
    Defines the default maximum file size, used if the "integration-sdk.data.filesize.editing.max" or "integration-sdk.data.filesize.conversion.max" properties are not specified in "settings.properties".
    
    See Also:
    
    Constant Field Values
  - settingsManager
```
private SettingsManager settingsManager
```
    SettingsManager.
  - formats
```
private static List<Format> formats
```
    Defines a list containing data about supported formats.
- Constructor Detail
  - DefaultDocumentManager
```
public DefaultDocumentManager()
```
- Method Detail
  - getFormats
```
public List<Format> getFormats()
```
    Description copied from interface: DocumentManager
    
    Returns a list of file formats (electronic documents, forms, spreadsheets, presentations) supported by the ONLYOFFICE editors. The properties of each file format type are described in the list. This information is taken from the Formats repository.
    
    Specified by:
    
    getFormats in interface DocumentManager
    
    Returns:
    
    A list containing data about the supported formats.
  - getDocumentKey
```
public abstract String getDocumentKey(String fileId,
                                      boolean embedded)
```
    Description copied from interface: DocumentManager
    
    Generates a unique document identifier used by the service to recognize the document.
    
    Specified by:
    
    getDocumentKey in interface DocumentManager
    
    Parameters:
    
    fileId - The file ID.
    
    embedded - Specifies if the editor is opened in the embedded mode (true) or not (false).
    
    Returns:
    
    The unique document identifier.
  - getDocumentName
```
public abstract String getDocumentName(String fileId)
```
    Description copied from interface: DocumentManager
    
    Returns the document name by file ID.
    
    Specified by:
    
    getDocumentName in interface DocumentManager
    
    Parameters:
    
    fileId - The file ID.
    
    Returns:
    
    The document name.
  - getExtension
```
public String getExtension(String fileName)
```
    Description copied from interface: DocumentManager
    
    Returns the file extension from the file name.
    
    Specified by:
    
    getExtension in interface DocumentManager
    
    Parameters:
    
    fileName - The file name to get the extension.
    
    Returns:
    
    The file extension, or null if it doesn't exist, or the file name is empty.
  - getBaseName
```
public String getBaseName(String fileName)
```
    Description copied from interface: DocumentManager
    
    Returns the file base name without the full path and extension.
    
    Specified by:
    
    getBaseName in interface DocumentManager
    
    Parameters:
    
    fileName - The file name to get the base name.
    
    Returns:
    
    The file name without the extension or null if the file name is empty.
  - getDocumentType
```
public DocumentType getDocumentType(String fileName)
```
    Description copied from interface: DocumentManager
    
    Returns the document type by the file name.
    
    Specified by:
    
    getDocumentType in interface DocumentManager
    
    Parameters:
    
    fileName - The file name to get the document type.
    
    Returns:
    
    The document type.
    
    See Also:
    
    DocumentType
  - isEditable
```
public boolean isEditable(String fileName)
```
    Description copied from interface: DocumentManager
    
    Determines whether a document with a name specified in the request is editable.
    
    Specified by:
    
    isEditable in interface DocumentManager
    
    Parameters:
    
    fileName - The file name.
    
    Returns:
    
    True if the document is editable.
  - isViewable
```
public boolean isViewable(String fileName)
```
    Description copied from interface: DocumentManager
    
    Determines whether a document with a name specified in the request is viewable.
    
    Specified by:
    
    isViewable in interface DocumentManager
    
    Parameters:
    
    fileName - The file name.
    
    Returns:
    
    True if the document is viewable.
  - isFillable
```
public boolean isFillable(String fileName)
```
    Description copied from interface: DocumentManager
    
    Determines whether a document with a name specified in the request is fillable.
    
    Specified by:
    
    isFillable in interface DocumentManager
    
    Parameters:
    
    fileName - The file name.
    
    Returns:
    
    True if the document is fillable.
  - hasAction
```
public boolean hasAction(String fileName,
                         String action)
```
    Description copied from interface: DocumentManager
    
    Determines whether an action can be performed on a document with a name specified in the request.
    
    Specified by:
    
    hasAction in interface DocumentManager
    
    Parameters:
    
    fileName - The file name.
    
    action - An action to perform.
    
    Returns:
    
    True if the action can be performed on a document.
    
    See Also:
    
    Formats repository
  - getNewBlankFile
```
public InputStream getNewBlankFile(String extension,
                                   Locale locale)
```
    Description copied from interface: DocumentManager
    
    Returns InputStream of an empty file with the given extension and locale.
    
    Specified by:
    
    getNewBlankFile in interface DocumentManager
    
    Parameters:
    
    extension - The file extension.
    
    locale - The file locale.
    
    Returns:
    
    InputStream of an empty file.
    
    See Also:
    
    Template repository
  - getDefaultExtension
```
public String getDefaultExtension(DocumentType documentType)
```
    Description copied from interface: DocumentManager
    
    Returns the default OOXML extension by the specified document type.
    
    Specified by:
    
    getDefaultExtension in interface DocumentManager
    
    Parameters:
    
    documentType - The document type.
    
    Returns:
    
    The default OOXML extension.
    
    See Also:
    
    DocumentType
  - getDefaultConvertExtension
```
public String getDefaultConvertExtension(String fileName)
```
    Description copied from interface: DocumentManager
    
    Returns the default OOXML extension to which the document with the name specified in the request should be converted.
    
    Specified by:
    
    getDefaultConvertExtension in interface DocumentManager
    
    Parameters:
    
    fileName - The file name.
    
    Returns:
    
    The default OOXML extension for conversion.
  - getConvertExtensionList
```
public List<String> getConvertExtensionList(String fileName)
```
    Description copied from interface: DocumentManager
    
    Returns a list of extensions that the document with the name specified in the request can be converted to.
    
    Specified by:
    
    getConvertExtensionList in interface DocumentManager
    
    Parameters:
    
    fileName - The file name.
    
    Returns:
    
    A list of extensions for conversion.
  - getLossyEditableMap
```
public Map<String,Boolean> getLossyEditableMap()
```
    Description copied from interface: DocumentManager
    
    Returns a map of extensions that can be edited with the possible loss of information. If the extension is contained in the "formats.lossy-edit" settings, the value is "true".
    
    Specified by:
    
    getLossyEditableMap in interface DocumentManager
    
    Returns:
    
    A map of extensions that can be edited with the possible loss of information.
  - getInsertImageExtensions
```
public List<String> getInsertImageExtensions()
```
    Description copied from interface: DocumentManager
    
    Returns a list of image extensions that can be inserted into the document.
    
    Specified by:
    
    getInsertImageExtensions in interface DocumentManager
    
    Returns:
    
    A list of image extensions.
    
    See Also:
    
    insertImage method in API ONLYOFFICE
  - getCompareFileExtensions
```
public List<String> getCompareFileExtensions()
```
    Description copied from interface: DocumentManager
    
    Returns a list of extensions that can be used for the document comparison functions.
    
    Specified by:
    
    getCompareFileExtensions in interface DocumentManager
    
    Returns:
    
    A list of extensions for the document comparison.
    
    See Also:
    
    setRequestedDocument method in API ONLYOFFICE
  - getMailMergeExtensions
```
public List<String> getMailMergeExtensions()
```
    Description copied from interface: DocumentManager
    
    Returns a list of extensions that can be used for mail merge in the document.
    
    Specified by:
    
    getMailMergeExtensions in interface DocumentManager
    
    Returns:
    
    A list of extensions for mail merge.
    
    See Also:
    
    setRequestedSpreadsheet method in API ONLYOFFICE
  - getMaxFileSize
```
public long getMaxFileSize()
```
    Description copied from interface: DocumentManager
    
    Returns the maximum file size that can be opened in the ONLYOFFICE editor.
    
    Specified by:
    
    getMaxFileSize in interface DocumentManager
    
    Returns:
    
    The maximum file size that can be opened.
  - getMaxConversionFileSize
```
public long getMaxConversionFileSize()
```
    Description copied from interface: DocumentManager
    
    Returns the maximum file size that can be converted in the ONLYOFFICE Conversion Service.
    
    Specified by:
    
    getMaxConversionFileSize in interface DocumentManager
    
    Returns:
    
    The maximum file size that can be converted.
  - isForm
```
public boolean isForm(InputStream inputStream)
```
    Description copied from interface: DocumentManager
    
    Determines whether a file is form.
    
    Specified by:
    
    isForm in interface DocumentManager
    
    Parameters:
    
    inputStream - The inputStream of file.
    
    Returns:
    
    True if the file is form.
  - init
```
protected static void init()
```

Class DefaultDocumentManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DOCS_FORMATS_JSON_PATH

DEFAULT_MAX_FILE_SIZE

settingsManager

formats

Constructor Detail

DefaultDocumentManager

Method Detail

getFormats

getDocumentKey

getDocumentName

getExtension

getBaseName

getDocumentType

isEditable

isViewable

isFillable

hasAction

getNewBlankFile

getDefaultExtension

getDefaultConvertExtension

getConvertExtensionList

getLossyEditableMap

getInsertImageExtensions

getCompareFileExtensions

getMailMergeExtensions

getMaxFileSize

getMaxConversionFileSize

isForm

init