com.onlyoffice.service.documenteditor.callback

Interface CallbackService

All Known Implementing Classes:

DefaultCallbackService

public interface CallbackService

Method Summary

Modifier and Type	Method and Description
void	handlerClosed(Callback callback, String fileId) Starts the handler that is called if the callback status is 4 (CLOSED).
void	handlerEditing(Callback callback, String fileId) Starts the handler that is called if the callback status is 1 (EDITING).
void	handlerForcesave(Callback callback, String fileId) Starts the handler that is called if the callback status is 6 (FORCESAVE).
void	handlerForcesaveCurrupted(Callback callback, String fileId) Starts the handler that is called if the callback status is 7 (FORCESAVE_CORRUPTED).
void	handlerSave(Callback callback, String fileId) Starts the handler that is called if the callback status is 2 (SAVE).
void	handlerSaveCorrupted(Callback callback, String fileId) Starts the handler that is called if the callback status is 3 (SAVE_CORRUPTED).
void	processCallback(Callback callback, String fileId) Starts the callback handler.
Callback	verifyCallback(Callback callback, String authorizationHeader) Verifies the Callback object.

Method Detail

verifyCallback

Callback verifyCallback(Callback callback,
                        String authorizationHeader)
                 throws com.fasterxml.jackson.core.JsonProcessingException

Verifies the Callback object.

Parameters:

callback - The Callback object with the callback handler parameters.

authorizationHeader - The authorization header from the callback request.

Returns:

The verified callback object.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - An error occurred when processing the JSON data.

processCallback

void processCallback(Callback callback,
                     String fileId)
              throws Exception

Starts the callback handler.

Parameters:

callback - The Callback object with the callback handler parameters.

fileId - The file ID.

Throws:

Exception - If the processing fails unexpectedly.

handlerEditing

void handlerEditing(Callback callback,
                    String fileId)
             throws Exception

Starts the handler that is called if the callback status is 1 (EDITING).

Parameters:

callback - The Callback object with the callback handler parameters.

fileId - The file ID.

Throws:

Exception - If the processing fails unexpectedly.

handlerSave

void handlerSave(Callback callback,
                 String fileId)
          throws Exception

Starts the handler that is called if the callback status is 2 (SAVE).

Parameters:

callback - The Callback object with the callback handler parameters.

fileId - The file ID.

Throws:

Exception - If the processing fails unexpectedly.

handlerSaveCorrupted

void handlerSaveCorrupted(Callback callback,
                          String fileId)
                   throws Exception

Starts the handler that is called if the callback status is 3 (SAVE_CORRUPTED).

Parameters:

callback - The Callback object with the callback handler parameters.

fileId - The file ID.

Throws:

Exception - If the processing fails unexpectedly.

handlerClosed

void handlerClosed(Callback callback,
                   String fileId)
            throws Exception

Starts the handler that is called if the callback status is 4 (CLOSED).

Parameters:

callback - The Callback object with the callback handler parameters.

fileId - The file ID.

Throws:

Exception - If the processing fails unexpectedly.

handlerForcesave

void handlerForcesave(Callback callback,
                      String fileId)
               throws Exception

Starts the handler that is called if the callback status is 6 (FORCESAVE).

Parameters:

callback - The Callback object with the callback handler parameters.

fileId - The file ID.

Throws:

Exception - If the processing fails unexpectedly.

handlerForcesaveCurrupted

void handlerForcesaveCurrupted(Callback callback,
                               String fileId)
                        throws Exception

Starts the handler that is called if the callback status is 7 (FORCESAVE_CORRUPTED).

Parameters:

callback - The Callback object with the callback handler parameters.

fileId - The file ID.

Throws:

Exception - If the processing fails unexpectedly.