Package com.sap.cds.services.application

Interface ApplicationLifecycleService

All Superinterfaces:

Service

public interface ApplicationLifecycleService
extends Service

The interface for the technical service which indicates application's lifecycle events. Handlers of the ApplicationLifecycleService are notified on several application events. E.g. ApplicationLifecycleService#EVENT_APPLICATION_PREPARED is sent when all application objects have been initialized but the adapters hasn't been started yet. For Spring applications all beans are available.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_NAME
static final String	EVENT_APPLICATION_PREPARED
static final String	EVENT_APPLICATION_STOPPED
static final String	EVENT_ERROR_RESPONSE

Method Summary

Modifier and Type	Method	Description
void	applicationPrepared()	Called when the application is fully initialized but not started yet.
void	applicationStopped()	Called when the application is stopped to allow termination of regular task threads.
ErrorResponseEventContext.ErrorResponse	errorResponse(ServiceException exception)	Called by protocol adapters to control transformation of exception and messages into an error response.

Methods inherited from interface com.sap.cds.services.Service

after, after, after, after, before, before, before, before, emit, getName, on, on, on, on

Field Details

DEFAULT_NAME

static final String DEFAULT_NAME

See Also:

• Constant Field Values

EVENT_APPLICATION_PREPARED

static final String EVENT_APPLICATION_PREPARED

See Also:

• Constant Field Values

EVENT_APPLICATION_STOPPED

static final String EVENT_APPLICATION_STOPPED

See Also:

• Constant Field Values

EVENT_ERROR_RESPONSE

static final String EVENT_ERROR_RESPONSE

See Also:

• Constant Field Values

Method Details

applicationPrepared

void applicationPrepared()

Called when the application is fully initialized but not started yet.

applicationStopped

void applicationStopped()

Called when the application is stopped to allow termination of regular task threads. Please note, that it is not guaranteed that this event is fired, if the application is terminated. This event is especially useful in Spring contexts, to gracefully handle closing of an ApplicationContext.

errorResponse

ErrorResponseEventContext.ErrorResponse errorResponse(ServiceException exception)

Called by protocol adapters to control transformation of exception and messages into an error response. This event can be used to augment standard response.

Parameters:

exception - the ServiceException

Returns:

the ErrorResponseEventContext.ErrorResponse