Package de.aeb.xnsg.storage.bf
Interface IStorageBF
-
@BusinessFacade(extraPackages="de.aeb.xnsg.foundation.af") @MTOM @StreamingAttachment(parseEagerly=true, memoryThreshold=1048576L) public interface IStorageBF
This is the storage interface for all business applications, either NSG or XNSG applications.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IStorageBF.BUSINESS_AREA
-
Field Summary
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description StorageGetAdaptersResponseDTO
getAdapters(StorageGetAdaptersRequestDTO request)
Returns a list of all configured storage adapters.StorageGetDataResponseDTO
getData(StorageGetDataRequestDTO request)
Reads the data with the given unique ID from the storage system.StorageGetDataResponseDTO[]
getDataWithMetaInfo(String clientIdentCode, String adapterIdentCode, String objectType, StorageKeyFieldDTO[] keyFieldDTOs, Integer maxCount)
Reads the data entry, with the given meta-keys/-values.ApplicationFacadeDTO
getSearchApplication(StorageGetSearchApplicationRequestDTO request)
Search for specific data in the storage system - will return an URL for the search applicationStorageGetUrlResponseDTO
getStorageSystemURL(StorageGetUrlRequestDTO request)
Deprecated.ApplicationFacadeDTO
getViewDataApplication(StorageGetViewDataApplicationRequestDTO request)
Shows the data with the given unique ID from the storage system - will return an URL for the view data applicationStorageStoreDataResponseDTO
storeData(StorageStoreDataRequestDTO request)
Writes data to the storage system.
-
-
-
Field Detail
-
KEY_PROPERTY_REQUEST_BUSINESSCLIENTIDENTCODE
static final String KEY_PROPERTY_REQUEST_BUSINESSCLIENTIDENTCODE
- See Also:
- Constant Field Values
-
KEY_PROPERTY_REQUEST_CLIENTIDENTCODE
static final String KEY_PROPERTY_REQUEST_CLIENTIDENTCODE
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_ARCHIVEDAT
static final String KEY_PROPERTY_DATAOBJECT_ARCHIVEDAT
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_OBJECT_TITLE
static final String KEY_PROPERTY_DATAOBJECT_OBJECT_TITLE
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_OBJECT_DESCRIPTION
static final String KEY_PROPERTY_DATAOBJECT_OBJECT_DESCRIPTION
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_OBJECTTYPE
static final String KEY_PROPERTY_DATAOBJECT_OBJECTTYPE
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_OBJECTIDENTIFIER
static final String KEY_PROPERTY_DATAOBJECT_OBJECTIDENTIFIER
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_RETENTIONTIMESTAMP
static final String KEY_PROPERTY_DATAOBJECT_RETENTIONTIMESTAMP
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_SYSTEMID
static final String KEY_PROPERTY_DATAOBJECT_SYSTEMID
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_SYSTEMVERSION
static final String KEY_PROPERTY_DATAOBJECT_SYSTEMVERSION
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_BUSINESSAREA
static final String KEY_PROPERTY_DATAOBJECT_BUSINESSAREA
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_COMPANYNAME
static final String KEY_PROPERTY_DATAOBJECT_COMPANYNAME
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_OBJECTDATE
static final String KEY_PROPERTY_DATAOBJECT_OBJECTDATE
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_STORAGEID
static final String KEY_PROPERTY_DATAOBJECT_STORAGEID
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_TRANSACTIONID
static final String KEY_PROPERTY_DATAOBJECT_TRANSACTIONID
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_REVISIONNOTE
static final String KEY_PROPERTY_DATAOBJECT_REVISIONNOTE
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_FULLTEXT
static final String KEY_PROPERTY_DATAOBJECT_FULLTEXT
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_STRUCTURE_MAJOR_VERSION
static final String KEY_PROPERTY_DATAOBJECT_STRUCTURE_MAJOR_VERSION
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DATAOBJECT_STRUCTURE_MINOR_VERSION
static final String KEY_PROPERTY_DATAOBJECT_STRUCTURE_MINOR_VERSION
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DOCUMENT_SIZE
static final String KEY_PROPERTY_DOCUMENT_SIZE
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DOCUMENT_NAME
static final String KEY_PROPERTY_DOCUMENT_NAME
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DOCUMENT_SEQUENCE
static final String KEY_PROPERTY_DOCUMENT_SEQUENCE
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DOCUMENT_MIMETYPE
static final String KEY_PROPERTY_DOCUMENT_MIMETYPE
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DOCUMENT_SUBTYPE
static final String KEY_PROPERTY_DOCUMENT_SUBTYPE
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DOCUMENT_DATE
static final String KEY_PROPERTY_DOCUMENT_DATE
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DOCUMENT_FULLINDEX
static final String KEY_PROPERTY_DOCUMENT_FULLINDEX
- See Also:
- Constant Field Values
-
KEY_PROPERTY_DOCUMENT_ENCODING
static final String KEY_PROPERTY_DOCUMENT_ENCODING
- See Also:
- Constant Field Values
-
-
Method Detail
-
storeData
StorageStoreDataResponseDTO storeData(StorageStoreDataRequestDTO request)
Writes data to the storage system.- Parameters:
request
-StorageStoreDataRequestDTO
- Returns:
- the
StorageStoreDataResponseDTO
objects containing the UUID of the stored data and the timestamp, when this data is physically stored in the storage system
-
getData
StorageGetDataResponseDTO getData(StorageGetDataRequestDTO request)
Reads the data with the given unique ID from the storage system.- Parameters:
request
-StorageGetDataRequestDTO
- Returns:
- the
StorageGetDataResponseDTO
object with the foundStorageObjectDTO
-
getViewDataApplication
ApplicationFacadeDTO getViewDataApplication(StorageGetViewDataApplicationRequestDTO request)
Shows the data with the given unique ID from the storage system - will return an URL for the view data application- Parameters:
request
-StorageGetViewDataApplicationRequestDTO
- Returns:
- the
ApplicationFacadeDTO
object with the URL for the search application
-
getSearchApplication
ApplicationFacadeDTO getSearchApplication(StorageGetSearchApplicationRequestDTO request)
Search for specific data in the storage system - will return an URL for the search application- Parameters:
request
-StorageGetSearchApplicationRequestDTO
- Returns:
- the
ApplicationFacadeDTO
object with the URL for the search application
-
getAdapters
StorageGetAdaptersResponseDTO getAdapters(StorageGetAdaptersRequestDTO request)
Returns a list of all configured storage adapters.- Returns:
- a list of
StorageAdapterDTO
elements.
-
getDataWithMetaInfo
StorageGetDataResponseDTO[] getDataWithMetaInfo(String clientIdentCode, String adapterIdentCode, String objectType, StorageKeyFieldDTO[] keyFieldDTOs, Integer maxCount)
Reads the data entry, with the given meta-keys/-values.- Parameters:
clientIdentCode
-objectType
- , the type of the archived object.keyFieldDTOs
- , the key/values to search for.maxCount
- for SuperUser calls the maximum number (<= 50) of returned results (Default: 50)- Returns:
- The found storage data or an exception if no entry or more than one entry was found.
For SuperUser calls the found entries or an exception if no entry was found is returned.
-
getStorageSystemURL
@Deprecated StorageGetUrlResponseDTO getStorageSystemURL(StorageGetUrlRequestDTO request)
Deprecated.Method not supported.
-
-