io.javadog.cws.api

Interface Share

public interface Share

This interface contain the functionality to deal with data, dataTypes as well as signing and verifying data.

Since:

CWS 1.0

Author:

Kim Jensen

Method Summary

Modifier and Type	Method and Description
FetchDataResponse	fetchData(FetchDataRequest request) Allow retrieving data for a specific Circle from the System.
FetchDataTypeResponse	fetchDataTypes(FetchDataTypeRequest request) This request will retrieve a list of all currently available Data Types, which can be used to either add/update data to the system or identify how existing data should be processed.
FetchSignatureResponse	fetchSignatures(FetchSignatureRequest request) Retrieve a list of Signatures from the requesting Member Account.
ProcessDataResponse	processData(ProcessDataRequest request) Allow adding new Folders or Data records as well as update or remove existing records.
ProcessDataTypeResponse	processDataType(ProcessDataTypeRequest request) All stored data must have a data type, i.e.
SignResponse	sign(SignRequest request) Signs a Document using the requesting Accounts Private Key, and returning the Signature in the Response Object.
VerifyResponse	verify(VerifyRequest request) Verifies a Document with a given Signature.

Method Detail

processDataType

ProcessDataTypeResponse processDataType(ProcessDataTypeRequest request)

All stored data must have a data type, i.e. a way for an external client or system to identify and apply rules for how to work with the data. By default, two data types exist; "data" & "folder", which will allow any system to operate without adding additional types.

If more data types are needed, i.e. MIME Type data or Object Creation information - then these must be added before they can be used, which is done using this request.

The request takes both the name of a Data Type (typeName) and the type (type) itself, but to properly identify what action should be taken (added/updated or deleted), the proper Action must also be set.

Allowed Actions include the following:

• Action.PROCESS to either add or update an existing Data type, note that the two default types cannot be updated.
• Action.DELETE to remove an unused Data Type from the system. If a Type is still being used, then it cannot be removed. The two default types also cannot be removed.

As the data types are generally available, it is only allowed for Circle Administrators or the System Administrator to create new, update or delete existing.

Parameters:

request - Request Object

Returns:

Response Object with ReturnCode and Message

fetchDataTypes

FetchDataTypeResponse fetchDataTypes(FetchDataTypeRequest request)

This request will retrieve a list of all currently available Data Types, which can be used to either add/update data to the system or identify how existing data should be processed.

Parameters:

request - Request Object

Returns:

Response Object with ReturnCode and Message

processData

ProcessDataResponse processData(ProcessDataRequest request)

Allow adding new Folders or Data records as well as update or remove existing records. The data provided will be encrypted for the specified Circle and stored encrypted in the underlying database.

The Request supports the following Actions:

• Action.ADD a new, not existing record to the system with a given name. The name must be unique in the Folder where the data is stored. If no type is specified, then by default the "data" type is used, which is a general purpose type, indicating that the requesting system must have details about the actual data type.
• Action.UPDATE an existing record. It is possible to replace the encrypted data, rename the Data Object and move Data Objects between different Folders belonging to the same Circle. It is not possible to move Folders, as this will break the underlying data model since it can lead to recursive data structures, folders can thus only be renamed.
• Action.COPY an existing record from one Circle to a second Circle, requires that the requesting member have write access in both Circles.
• Action.MOVE an existing record from one Circle to a second Circle, requires that the requesting member have write access in both Circles.
• Action.DELETE an existing Data Object or an existing, empty, folder. It is not possible to delete folders with Data.

Parameters:

request - Request Object

Returns:

Response Object with ReturnCode and Message

fetchData

FetchDataResponse fetchData(FetchDataRequest request)

Allow retrieving data for a specific Circle from the System. Unless a specific Data Object is requested, the list of returned information will only be the Metadata for the Data Object. If a specific Data Object is requested, then the listing will contain a single entry with the Metadata for the Object, and the data is set in the Response Object as well.

By default, the content retrieved is a list of data for the root folder for the given Circle. If a specific Folder is given, then the list will be the content of the provided folder. The sorting of the content is always with the most recent data first. It is possible to specify how many Metadata Objects should be returned, and also which page number to read from.

Parameters:

request - Request Object

Returns:

Response Object with ReturnCode and Message

sign

SignResponse sign(SignRequest request)

Signs a Document using the requesting Accounts Private Key, and returning the Signature in the Response Object. The Signature is not stored in the underlying data model, rather a cryptographic fingerprint is saved to make sure that it can be retrieved for someone wishing to verify the document against the signature.

Parameters:

request - Request Object

Returns:

Response Object with ReturnCode and Message

verify

VerifyResponse verify(VerifyRequest request)

Verifies a Document with a given Signature. If the Signature is correct, then the Response Object will contain a True value, otherwise a False value.

Parameters:

request - Request Object

Returns:

Response Object with ReturnCode and Message

fetchSignatures

FetchSignatureResponse fetchSignatures(FetchSignatureRequest request)

Retrieve a list of Signatures from the requesting Member Account. The list contain information about number of successful verifications which has been made with each Signature.

Parameters:

request - Request Object

Returns:

Response Object with ReturnCode and Message