Interface IF_BSP_APPLICATION - SAP Documentation

Interface IF_BSP_APPLICATION

The interface IF_BSP_APPLICATION is implemented using class CL_BSP_APPLICATION. It provides methods that enable a BSP application to call up information about its runtime environment or influence this environment.

Inheritance Hierarchy/Interface Composition

Implementing Classes

CL_BSP_APPLICATION

Enhanced Interface

-

Specializing Interfaces

-

Attributes

-

Methods

Methode get_application_name

Signature	Syntax method get_application_name returning name type string . End of the code.
Description	This method returns the name of the BSP application as defined in the development environment (transaction `SE80`).
Parameters	-
Return Values/Exceptions	`NAME`	Name of the BSP application

Methode get_application_namespace

Signature	Syntax method get_application_namespace returning namespace type string . End of the code.
Description	This method returns the namespace of the corresponding BSP application as defined in the development environment (transaction `SE80`). For BSP applications that have no explicit name space specified, this is the SAP name space, in other words, the method returns “sap“.
Parameters	-
Return Values/Exceptions	`NAMESPACE`	Namespace of the BSP application

Methode get_application_start_page

Signature	Syntax method get_application_start_page returning start_page type string . End of the code.
Description	This method returns the start page of the corresponding BSP application as defined in the development environment (transaction `SE80`). If no page was explicitly specified, the method returns the name `default.htm`. The start page of a BSP application is called if no specific page is included in the URL when the application is started, in other words, when the URL ends with the application name.
Parameters	-
Return Values/Exceptions	`START_PAGE`	Start page of BSP application

Methode get_application_url

Signature	Syntax method get_application_url returning url type string . End of the code.
Description	This method returns a server-specific URL that references the current BSP application, for example `/sap/bc/bsp/sap/retailstore`.
Parameters	-
Return Values/Exceptions	`URL`	Server-specific URL of current BSP application

Methode get_request

Signature	Syntax method get_request returning request type ref to if_http_request . End of the code.
Description	This method returns an interface reference to the current HTTP request object.
Parameters	-
Return Values/Exceptions	`REQUEST`	Interface reference to the HTTP request object

Methode get_response

Signature	Syntax method get_response returning request type ref to if_http_response . End of the code.
Description	This method returns an interface reference to the current HTTP response object.
Parameters	-
Return Values/Exceptions	`RESPONSE`	Interface reference to the HTTP response object

Methode get_runtime

Signature	Syntax method get_runtime returning runtime type ref to if_bsp_runtime . End of the code.
Description	This method returns an interface reference to the current BSP runtime object.
Parameters	-
Return Values/Exceptions	`RUNTIME`	Interface reference to the BSP runtime object

Methode get_timeout

Signature	Syntax method get_timeout returning timeout type t . End of the code.
Description	This method returns the current timeout value (length of time). The timeout value is only important for stateful BSP applications. Stateful applications use this value to determine after what length of time the server should terminate a running application when no further requests are received. Note You can set timeout values in Transaction SICF for BSP applications, see also Creating an ICF Service. End of the note.
Parameters	-
Return Values/Exceptions	`TIMEOUT`	Maximum length of time which a BSP application may continue to run in the absence of requests. After this time the application is automatically terminated.
Cross References	Refer also to: `set_timeout`

Methode is_stateful

Signature	Syntax method is_stateful returning stateful type i . End of the code.
Description	You can use this method to determine whether a BSP application is working stateful or stateless.
Parameters	-
Return Values/Exceptions	`STATEFUL`	0: Application is stateless 1: Application is stateful
Cross References	See also: `set_stateful`, `set_stateless`

Methode set_stateless

Signature	Syntax method set_stateless. End of the code.
Description	This method sets the BSP application to stateless processing.
Parameters	-
Return Values/Exceptions	`STATEFUL`	0: Application is stateless 1: Application is stateful
Cross References	See also: `is_stateful`, `set_stateful`

Methode set_timeout

Signature	Syntax method set_timeout importing timeout type t . End of the code.
Description	This method sets the current timeout value (length of time). The timeout value is only important for stateful BSP applications. Stateful applications use this value to determine after what length of time the server should terminate a running application when no further requests are received. Note You can set timeout values in Transaction SICF for BSP applications, see also Creating an ICF Service. End of the note.
Parameters	`TIMEOUT`	Maximum length of time which a BSP application may continue to run in the absence of requests. After this time the application is automatically terminated.
Return Values/Exceptions	-
Cross References	See also: `get_timeout`