SAP ABAP Class CL_URL (URL Generator for different frames in one)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
BC-FES-BUS (Application Component) Netweaver Business Client
⤷
SICF_EXT_SERVICES (Package) SICF Services
SAP_UI (Software Component) User Interface Technology⤷
BC-FES-BUS (Application Component) Netweaver Business Client⤷
SICF_EXT_SERVICES (Package) SICF ServicesProperties
| Class | CL_URL | |
| Short Description | URL Generator for different frames in one | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SICF_EXT_SERVICES | SICF Services |
| Created | 20090315 | SAP |
| Last change | 20141120 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_URL has no interface implemented.
Friends
Class CL_URL has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CACHED_RESOLVED_SM59_ALIAS |
Static Attribute | Private | See coding | 20101202 | ||||
| 2 | DEFAULT_HOST |
Instance attribute | Private | Type reference (TYPE) | STRING | Computed http://server:port sequence | 20090320 | ||
| 3 | ICONS |
Instance attribute | Private | Type reference (TYPE) | T_ICON_TAB | 20111026 | |||
| 4 | ITS_QUERY |
Instance attribute | Private | Type reference (TYPE) | STRING | '' | Additional query string to add onto ITS URLs | 20090315 | |
| 5 | ITS_SYSTEM |
Instance attribute | Private | Type reference (TYPE) | STRING | '' | ;~sysid=XXX;~instance=NN | 20090318 | |
| 6 | MC_APPLICATION |
Constant | Public | Type reference (TYPE) | STRING | '/NWBC/' | 20120810 | ||
| 7 | MC_APPLICATION_EXTERNAL |
Constant | Public | Type reference (TYPE) | STRING | '/NWBC_EXTERNAL/' | 20120810 | ||
| 8 | MC_ITS_DYNP_OKCODE |
Constant | Public | Type reference (TYPE) | STRING | 'DYNP_OKCODE' | DYNP_OKCODE parameter | 20130314 | |
| 9 | MC_PAR_ITS_SKIP_SEL_SCREEN |
Constant | Public | Type reference (TYPE) | STRING | '*' | Request ITS to skip selection screen | 20110421 | |
| 10 | MC_PAR_NOSPLASH |
Constant | Public | Type reference (TYPE) | STRING | '~nosplash' | Name of flag controlling splashing string | 20110421 | |
| 11 | MC_PAR_TRANSACTION |
Constant | Public | Type reference (TYPE) | STRING | '~transaction' | Name of ITS transaction parameter | 20110421 | |
| 12 | MC_PAR_WDA_CONFIG |
Constant | Public | Type reference (TYPE) | STRING | 'WDCONFIGURATIONID' | WebDynpro Configuration parameter | 20121025 | |
| 13 | MC_PAR_WDA_CONFIG2 |
Constant | Public | Type reference (TYPE) | STRING | 'sap-wd-configId' | 20130129 | ||
| 14 | MC_PATH_ITS |
Constant | Public | Type reference (TYPE) | STRING | '/sap/bc/gui/sap/its/webgui' | Path to ITS | 20121025 | |
| 15 | MC_PATH_WDA |
Constant | Public | Type reference (TYPE) | STRING | '/sap/bc/webdynpro' | Path to WebDynpro | 20121025 | |
| 16 | MO_SERVER |
Instance attribute | Private | Object reference (TYPE REF TO) | IF_HTTP_SERVER | Server object instance | 20131230 | ||
| 17 | PREFER_HTTPS |
Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | http:// or https:// | 20090321 | |
| 18 | PREFER_RELATIVE_URL |
Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20120702 | ||
| 19 | PROXY_DETECTED |
Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Do we have HTTP proxy active? | 20091016 | |
| 20 | SAP_ACCESSIBILITY |
Instance attribute | Private | Type reference (TYPE) | STRING | &sap-accessibility=X | 20090318 | ||
| 21 | SAP_CLIENT |
Instance attribute | Private | Type reference (TYPE) | STRING | &sap-client=NNN | 20090318 | ||
| 22 | SAP_LANGUAGE |
Instance attribute | Private | Type reference (TYPE) | STRING | &sap-language=XX | 20090318 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | BSP |
Instance method | Public | Method | Construct URL: Business Server Pages | 20090317 |
| 2 | CONSTRUCTOR |
Instance method | Public | Constructor | CONSTRUCTOR | 20090315 |
| 3 | GET_SAP_IE_FOR_WDA |
Static method | Public | Method | Get the sap-ie parameter according to a wd app & config | 20140212 |
| 4 | GET_TRANSACTION_NAME |
Static method | Public | Method | Extract transaction name from URL | 20121025 |
| 5 | GET_WDA_NAME |
Static method | Public | Method | Extract WebDynpro Application name and configurationfrom URL | 20121025 |
| 6 | HOST |
Instance method | Public | Method | Add http://server:port... | 20090321 |
| 7 | ICON |
Instance method | Public | Method | Construct URL: ~Pictogram/name | 20090402 |
| 8 | ITS |
Instance method | Public | Method | Construct URL: ITS | 20090315 |
| 9 | QUERY |
Instance method | Public | Method | Add ?p1=v1&....&sap-* | 20090318 |
| 10 | RESOLVE_SM59_ALIAS |
Static method | Public | Method | SM59 Alias resolve of "ALIAS" & _RFC & _HTTP(S) | 20091112 |
| 11 | URL |
Instance method | Public | Method | Construct URL: (Hand-coded) URL | 20090317 |
| 12 | WDA |
Instance method | Public | Method | Construct URL: Web Dynpro ABAP | 20090316 |
Events
Class CL_URL has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | T_ICON | Private | See coding | 20111026 | BEGIN OF t_icon,
icon_alias TYPE char64,
path TYPE string,
END OF t_icon
|
||
| 2 | T_ICON_TAB | Private | See coding | 20111026 | t_icon_tab TYPE SORTED TABLE OF t_icon WITH UNIQUE KEY icon_alias
|
||
| 3 | T_RESOLVED_SM59_ALIAS | Private | See coding | 20101202 | BEGIN OF t_resolved_sm59_alias,
alias TYPE string,
prefer_https TYPE abap_bool,
proxy_active TYPE abap_bool,
require_boe_http TYPE abap_bool,
sm59_destination TYPE t_sm59_destination,
sm59_rfc_destination TYPE t_single_sm59_destination,
sm59_http_destination TYPE t_single_sm59_destination,
sm59_https_destination TYPE t_single_sm59_destination,
END OF t_resolved_sm59_alias
|
||
| 4 | T_SINGLE_SM59_DESTINATION | Public | See coding | 20101202 | BEGIN OF t_single_sm59_destination,
name TYPE rfcdes-rfcdest,
server_name TYPE rfcdisplay-rfchost,
system_id TYPE rfcopt-rfcsysid,
system_number TYPE rfcdisplay-rfcservice,
proxy_host TYPE rfcdisplay-rfcgwhost,
proxy_service_number TYPE rfcdisplay-rfcgwserv,
service_number TYPE rfcdisplay-rfcsysid,
path_prefix TYPE string,
client TYPE rfcdisplay-rfcclient,
ssl_active TYPE rfcdisplay-rfcsnc,
rc TYPE sysubrc,
END OF t_single_sm59_destination
|
||
| 5 | T_SM59_DESTINATION | Public | See coding | 20091112 | BEGIN OF t_sm59_destination,
valid TYPE abap_bool,
name TYPE string,
sm59_name TYPE string,
protocol TYPE string,
server TYPE string,
port TYPE string,
path_prefix TYPE string,
secure TYPE abap_bool,
client TYPE mandt,
url TYPE string, " protocol://server:port
system_id(10) TYPE c, " system id
system_nr(2) TYPE c, " system instance number
END OF t_sm59_destination
|
Method Signatures
Method BSP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
ADD_MANGLING | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20100217 | ||
| 2 | Importing |
APPLICATION | Call by reference | Type reference (TYPE) | CSEQUENCE | [/namespace/]name[?query_string] | 20090317 | ||
| 3 | Importing |
GENERATE_ESID | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20100217 | ||
| 4 | Importing |
QUERY_PARMS | Call by reference | Type reference (TYPE) | TIHTTPNVP | Query parameters, appended onto query_string | 20090317 | ||
| 5 | Importing |
QUERY_STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | Query string name=value format, already URL encoded | 20090317 | ||
| 6 | Importing |
SM59_ALIAS | Call by reference | Type reference (TYPE) | CSEQUENCE | Resolve host via SM59 | 20090317 | ||
| 7 |  Returning |
URL | Value transfer | Type reference (TYPE) | STRING | Server relative or absolute URL | 20090317 |
Method BSP on class CL_URL has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ADD_SAP_CLIENT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | /url?sap-client=sy-mandt | 20090315 | |
| 2 | Importing |
ADD_SAP_LANGUAGE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | /url?sap-language=sy-langu | 20090315 | |
| 3 | Importing |
FORCE_SAP_ACCESSIBILITY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | /url?sap-accessibility=X | 20090315 | |
| 4 | Importing |
ITS_NO_SPLASH | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | /url?~nosplash=1 | 20090315 | |
| 5 | Importing |
ITS_SINGLE_TRANSACTION | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | /url?~singletransaction=1 | 20090315 | |
| 6 | Importing |
PREFER_SERVER_RELATIVE_URL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | http://server:port/url | 20090315 | |
| 7 | Importing |
PRESERVE_SAP_ACCESSIBILITY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | /url?sap-accessibility=X only if active | 20090315 | |
| 8 | Importing |
PROXY_ACTIVE | Call by reference | Type reference (TYPE) | ABAP_BOOL | There is HTTP proxy in network | 20091016 | ||
| 9 | Importing |
SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | 20090321 |
Method CONSTRUCTOR on class CL_URL has no exception.
Method GET_SAP_IE_FOR_WDA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_SAP_IE | Call by reference | Type reference (TYPE) | STRING | 20140212 | |||
| 2 | Importing |
IV_APPLICATION | Call by reference | Type reference (TYPE) | STRING | 20140212 | |||
| 3 | Importing |
IV_CONFIGURATION | Call by reference | Type reference (TYPE) | STRING | 20140212 |
Method GET_SAP_IE_FOR_WDA on class CL_URL has no exception.
Method GET_TRANSACTION_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_PARAMETERS | Call by reference | Type reference (TYPE) | TIHTTPNVP | Parameters table | 20130314 | ||
| 2 | Exporting |
EV_NAME | Call by reference | Type reference (TYPE) | STRING | Transaction name | 20130314 | ||
| 3 | Exporting |
EV_SKIP_SEL_SCREEN | Call by reference | Type reference (TYPE) | ABAP_BOOL | Section skip flag | 20130314 | ||
| 4 | Importing |
IV_URL | Call by reference | Type reference (TYPE) | CSEQUENCE | Absolute ITS URL with path and query | 20121025 |
Method GET_TRANSACTION_NAME on class CL_URL has no exception.
Method GET_WDA_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_APPLICATION | Call by reference | Type reference (TYPE) | STRING | WebDynpro Application name and configuration | 20140212 | ||
| 2 | Exporting |
EV_APP_AND_CONFIG | Call by reference | Type reference (TYPE) | STRING | 20140212 | |||
| 3 | Exporting |
EV_CONFIGURATION | Call by reference | Type reference (TYPE) | STRING | 20140212 | |||
| 4 | Importing |
IV_URL | Call by reference | Type reference (TYPE) | CSEQUENCE | Absolute WDA URL with path and query | 20121025 |
Method GET_WDA_NAME on class CL_URL has no exception.
Method HOST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ADD_PREFIX | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20120702 | ||
| 2 | Importing |
ALIAS | Call by reference | Type reference (TYPE) | CSEQUENCE | '' | Resolve host via SM59 | 20090321 | |
| 3 | Importing |
REQUIRE_BOE_HTTP | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | require HTTP connection to BOE Server | 20100715 | |
| 4 |  Changing |
URL | Call by reference | Type reference (TYPE) | STRING | http(s)://server:port | 20090321 |
Method HOST on class CL_URL has no exception.
Method ICON Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | ~Pictogram/name | 20090402 | ||
| 2 | Importing |
RTL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20111027 | |
| 3 | Importing |
THEME | Call by reference | Type reference (TYPE) | STRING | 20111027 | |||
| 4 | Returning |
URL | Value transfer | Type reference (TYPE) | STRING | Server relative or absolute URL | 20090402 |
Method ICON on class CL_URL has no exception.
Method ITS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DYNP_OKCODE | Call by reference | Type reference (TYPE) | CSEQUENCE | DYNP OK Code | 20090315 | ||
| 2 | Importing |
QUERY_PARMS | Call by reference | Type reference (TYPE) | TIHTTPNVP | Query parameters, appended onto query_string | 20090315 | ||
| 3 | Importing |
QUERY_STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | Query string name=value format, already URL encoded | 20090315 | ||
| 4 | Importing |
SM59_ALIAS | Call by reference | Type reference (TYPE) | CSEQUENCE | Resolve host via SM59 | 20090315 | ||
| 5 | Importing |
TRANSACTION | Call by reference | Type reference (TYPE) | CSEQUENCE | Transaction Code | 20090315 | ||
| 6 | Returning |
URL | Value transfer | Type reference (TYPE) | STRING | Server relative or absolute URL | 20090315 |
Method ITS on class CL_URL has no exception.
Method QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ADD_SAP_QUERY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Add sap-* as well | 20090318 | |
| 2 | Importing |
QUERY_PARMS | Call by reference | Type reference (TYPE) | TIHTTPNVP | Query parameters, appended onto query_string | 20090318 | ||
| 3 | Importing |
QUERY_STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | Query string name=value format, already URL encoded | 20090318 | ||
| 4 | Changing |
URL | Call by reference | Type reference (TYPE) | STRING | Server relative or absolute URL | 20090318 |
Method QUERY on class CL_URL has no exception.
Method RESOLVE_SM59_ALIAS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ALIAS | Call by reference | Type reference (TYPE) | CSEQUENCE | '' | Resolve host via SM59 | 20091112 | |
| 2 | Importing |
PREFER_HTTPS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20091112 | ||
| 3 | Importing |
PROXY_ACTIVE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20091112 | ||
| 4 | Importing |
REQUIRE_BOE_HTTP | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | require HTTP connection to BOE Server | 20100715 | |
| 5 | Exporting |
SM59_DESTINATION | Call by reference | Type reference (TYPE) | T_SM59_DESTINATION | 20091112 | |||
| 6 | Exporting |
SM59_HTTPS_DESTINATION | Call by reference | Type reference (TYPE) | T_SINGLE_SM59_DESTINATION | 20101202 | |||
| 7 | Exporting |
SM59_HTTP_DESTINATION | Call by reference | Type reference (TYPE) | T_SINGLE_SM59_DESTINATION | 20101202 | |||
| 8 | Exporting |
SM59_RFC_DESTINATION | Call by reference | Type reference (TYPE) | T_SINGLE_SM59_DESTINATION | 20101202 |
Method RESOLVE_SM59_ALIAS on class CL_URL has no exception.
Method URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ADD_PREFIX | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20120702 | ||
| 2 | Importing |
ADD_SAP_QUERY | Value transfer | Type reference (TYPE) | ABAP_BOOL | Append standard SAP params as sap-language etc | 20140212 | ||
| 3 | Importing |
PATH | Call by reference | Type reference (TYPE) | CSEQUENCE | /path[?query_string] | 20090317 | ||
| 4 | Importing |
QUERY_PARMS | Call by reference | Type reference (TYPE) | TIHTTPNVP | Query parameters, appended onto query_string | 20090317 | ||
| 5 | Importing |
QUERY_STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | Query string name=value format, already URL encoded | 20090317 | ||
| 6 | Importing |
REQUIRE_BOE_HTTP | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | require HTTP connection to BOE Server | 20100715 | |
| 7 | Importing |
SM59_ALIAS | Call by reference | Type reference (TYPE) | CSEQUENCE | Resolve host via SM59 | 20090317 | ||
| 8 | Returning |
URL | Value transfer | Type reference (TYPE) | STRING | Server relative or absolute URL | 20090317 |
Method URL on class CL_URL has no exception.
Method WDA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
APPLICATION | Call by reference | Type reference (TYPE) | CSEQUENCE | [/namespace/]name[?query_string] | 20090316 | ||
| 2 | Importing |
QUERY_PARMS | Call by reference | Type reference (TYPE) | TIHTTPNVP | Query parameters, appended onto query_string | 20090316 | ||
| 3 | Importing |
QUERY_STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | Query string name=value format, already URL encoded | 20090316 | ||
| 4 | Importing |
SM59_ALIAS | Call by reference | Type reference (TYPE) | CSEQUENCE | Resolve host via SM59 | 20090316 | ||
| 5 | Returning |
URL | Value transfer | Type reference (TYPE) | STRING | Server relative or absolute URL | 20090316 |
Method WDA on class CL_URL has no exception.
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 720 |
