SAP ABAP Class /UI2/CL_URL (URL Generator for different frames in one)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷ CA-UI2-INT-BE (Application Component) Backend Enablement
⤷ /UI2/NWBC_CORE (Package) NetWeaver Business Client - Core Functionality
⤷ CA-UI2-INT-BE (Application Component) Backend Enablement
⤷ /UI2/NWBC_CORE (Package) NetWeaver Business Client - Core Functionality
Properties
Class | /UI2/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 | /UI2/NWBC_CORE | NetWeaver Business Client - Core Functionality |
Created | 20120824 | 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 /UI2/CL_URL has no interface implemented.
Friends
Class /UI2/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 | 20120824 | ||||
2 | DEFAULT_HOST | Instance attribute | Public | Type reference (TYPE) | STRING | Computed http://server:port sequence | 20120824 | ||
3 | ICONS | Instance attribute | Private | Type reference (TYPE) | T_ICON_TAB | 20120824 | |||
4 | ITS_QUERY | Instance attribute | Private | Type reference (TYPE) | STRING | '' | Additional query string to add onto ITS URLs | 20120824 | |
5 | ITS_SYSTEM | Instance attribute | Private | Type reference (TYPE) | STRING | '' | ;~sysid=XXX;~instance=NN | 20120824 | |
6 | MC_APPLICATION | Constant | Public | Type reference (TYPE) | STRING | '/NWBC/' | 20120824 | ||
7 | MC_APPLICATION_EXTERNAL | Constant | Public | Type reference (TYPE) | STRING | '/NWBC_EXTERNAL/' | 20120824 | ||
8 | MC_ITS_DYNP_OKCODE | Constant | Public | Type reference (TYPE) | STRING | 'DYNP_OKCODE' | DYNP_OKCODE parameter | 20130418 | |
9 | MC_PAR_ITS_SKIP_SEL_SCREEN | Constant | Public | Type reference (TYPE) | STRING | '*' | Request ITS to skip selection screen | 20120824 | |
10 | MC_PAR_NOSPLASH | Constant | Public | Type reference (TYPE) | STRING | '~nosplash' | Name of flag controlling splashing string | 20120824 | |
11 | MC_PAR_TRANSACTION | Constant | Public | Type reference (TYPE) | STRING | '~transaction' | Name of ITS transaction parameter | 20120824 | |
12 | MC_PAR_WDA_CONFIG | Constant | Public | Type reference (TYPE) | STRING | 'WDCONFIGURATIONID' | WebDynpro Configuration parameter | 20130117 | |
13 | MC_PAR_WDA_CONFIG2 | Constant | Public | Type reference (TYPE) | STRING | 'sap-wd-configId' | 20130117 | ||
14 | MC_PATH_ITS | Constant | Public | Type reference (TYPE) | STRING | '/sap/bc/gui/sap/its/webgui' | Path to ITS | 20130117 | |
15 | MC_PATH_WDA | Constant | Public | Type reference (TYPE) | STRING | '/sap/bc/webdynpro' | Path to WebDynpro | 20130117 | |
16 | MO_SERVER | Instance attribute | Private | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20131216 | ||
17 | PREFER_HTTPS | Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | http:// or https:// | 20120824 | |
18 | PREFER_RELATIVE_URL | Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20120824 | ||
19 | PROXY_DETECTED | Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Do we have HTTP proxy active? | 20120824 | |
20 | SAP_ACCESSIBILITY | Instance attribute | Private | Type reference (TYPE) | STRING | &sap-accessibility=X | 20120824 | ||
21 | SAP_CLIENT | Instance attribute | Private | Type reference (TYPE) | STRING | &sap-client=NNN | 20120824 | ||
22 | SAP_LANGUAGE | Instance attribute | Private | Type reference (TYPE) | STRING | &sap-language=XX | 20120824 |
Methods
# | Method | Level | Visibility | Method type | Description | Created on |
---|---|---|---|---|---|---|
1 | BSP | Instance method | Public | Method | Construct URL: Business Server Pages | 20120824 |
2 | CONSTRUCTOR | Instance method | Public | Constructor | CONSTRUCTOR | 20120824 |
3 | GET_DEFAULT_HOST | Static method | Public | Method | Reads system default host form server object or HTTPURLLOC | 20140523 |
4 | GET_SAP_IE_FOR_WDA | Static method | Public | Method | Get the sap-ie parameter according to a wd app & config | 20140408 |
5 | GET_TRANSACTION_NAME | Static method | Public | Method | Extract transaction name from URL | 20130117 |
6 | GET_WDA_NAME | Static method | Public | Method | Extract WebDynpro Application name and configurationfrom URL | 20130117 |
7 | GET_WDA_NAME_AND_CONFIG | Static method | Public | Method | Extract WebDynpro Application name and configurationfrom URL | 20140408 |
8 | HOST | Instance method | Public | Method | Add http://server:port... | 20120824 |
9 | ICON | Instance method | Public | Method | Construct URL: ~Pictogram/name | 20120824 |
10 | ITS | Instance method | Public | Method | Construct URL: ITS | 20120824 |
11 | QUERY | Instance method | Public | Method | Add ?p1=v1&....&sap-* | 20120824 |
12 | RESOLVE_SM59_ALIAS | Static method | Public | Method | Resolve SM59 alias | 20120824 |
13 | RESOLVE_SM59_ALIAS_EX | Instance method | Public | Method | Resolve SM59 alias | 20130925 |
14 | URL | Instance method | Public | Method | Construct URL: (Hand-coded) URL | 20120824 |
15 | WDA | Instance method | Public | Method | Construct URL: Web Dynpro ABAP | 20120824 |
Events
Class /UI2/CL_URL has no event.
Types
# | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
---|---|---|---|---|---|---|---|
1 | T_ICON | Private | See coding | 20120824 | BEGIN OF t_icon,
icon_alias TYPE char64,
path TYPE string,
END OF t_icon
|
||
2 | T_ICON_TAB | Private | See coding | 20120824 | t_icon_tab type SORTED TABLE OF t_icon WITH UNIQUE key icon_alias
|
||
3 | T_RESOLVED_SM59_ALIAS | Private | See coding | 20120824 | 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 | 20120824 | 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 | 20120824 | 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 | 20120824 | ||
2 | Importing | APPLICATION | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120824 | |||
3 | Importing | GENERATE_ESID | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20120824 | ||
4 | Importing | QUERY_PARMS | Call by reference | Type reference (TYPE) | TIHTTPNVP | 20120824 | |||
5 | Importing | QUERY_STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120824 | |||
6 | Importing | SM59_ALIAS | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120824 | |||
7 | Returning | URL | Value transfer | Type reference (TYPE) | STRING | 20120824 |
Method BSP on class /UI2/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 | 20120824 | ||
2 | Importing | ADD_SAP_LANGUAGE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20120824 | ||
3 | Importing | FORCE_SAP_ACCESSIBILITY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20120824 | ||
4 | Importing | ITS_NO_SPLASH | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20120824 | ||
5 | Importing | ITS_SINGLE_TRANSACTION | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20120824 | ||
6 | Importing | PREFER_SERVER_RELATIVE_URL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20120824 | ||
7 | Importing | PRESERVE_SAP_ACCESSIBILITY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20120824 | ||
8 | Importing | PROXY_ACTIVE | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20120824 | |||
9 | Importing | SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | 20120824 |
Method CONSTRUCTOR on class /UI2/CL_URL has no exception.
Method GET_DEFAULT_HOST Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Returning | RV_VALUE | Value transfer | Type reference (TYPE) | STRING | Default protocol + host + server | 20140523 | ||
2 | Importing | SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | 20140523 |
Method GET_DEFAULT_HOST on class /UI2/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 | 20140408 | |||
2 | Importing | IV_APPLICATION | Call by reference | Type reference (TYPE) | STRING | 20140408 | |||
3 | Importing | IV_CONFIGURATION | Call by reference | Type reference (TYPE) | STRING | 20140408 |
Method GET_SAP_IE_FOR_WDA on class /UI2/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 | Transaction parameters | 20130418 | ||
2 | Exporting | ET_QUERY | Call by reference | Type reference (TYPE) | TIHTTPNVP | ITS parameters | 20130921 | ||
3 | Exporting | EV_NAME | Call by reference | Type reference (TYPE) | STRING | Transaction name | 20130418 | ||
4 | Exporting | EV_SKIP_SEL_SCREEN | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20130418 | |||
5 | Importing | IV_URL | Call by reference | Type reference (TYPE) | CSEQUENCE | Absolute ITS URL with path and query | 20130117 |
Method GET_TRANSACTION_NAME on class /UI2/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 | Importing | IV_URL | Call by reference | Type reference (TYPE) | CSEQUENCE | Absolute WDA URL with path and query | 20130117 | ||
2 | Returning | RV_NAME | Value transfer | Type reference (TYPE) | STRING | 20140408 |
Method GET_WDA_NAME on class /UI2/CL_URL has no exception.
Method GET_WDA_NAME_AND_CONFIG 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 | 20140408 | ||
2 | Exporting | EV_APP_AND_CONFIG | Call by reference | Type reference (TYPE) | STRING | 20140408 | |||
3 | Exporting | EV_CONFIGURATION | Call by reference | Type reference (TYPE) | STRING | 20140408 | |||
4 | Importing | IV_URL | Call by reference | Type reference (TYPE) | CSEQUENCE | Absolute WDA URL with path and query | 20140408 |
Method GET_WDA_NAME_AND_CONFIG on class /UI2/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 | 20120824 | ||
2 | Importing | ALIAS | Call by reference | Type reference (TYPE) | CSEQUENCE | '' | 20120824 | ||
3 | Importing | REQUIRE_BOE_HTTP | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20120824 | ||
4 | Changing | URL | Call by reference | Type reference (TYPE) | STRING | 20120824 |
Method HOST on class /UI2/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 | 20120824 | |||
2 | Importing | RTL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20120824 | ||
3 | Importing | THEME | Call by reference | Type reference (TYPE) | STRING | 20120824 | |||
4 | Returning | URL | Value transfer | Type reference (TYPE) | STRING | 20120824 |
Method ICON on class /UI2/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 | 20120824 | |||
2 | Importing | QUERY_PARMS | Call by reference | Type reference (TYPE) | TIHTTPNVP | 20120824 | |||
3 | Importing | QUERY_STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120824 | |||
4 | Importing | SM59_ALIAS | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120824 | |||
5 | Importing | TRANSACTION | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120824 | |||
6 | Returning | URL | Value transfer | Type reference (TYPE) | STRING | 20120824 |
Method ITS on class /UI2/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 | 20120824 | ||
2 | Importing | QUERY_PARMS | Call by reference | Type reference (TYPE) | TIHTTPNVP | 20120824 | |||
3 | Importing | QUERY_STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120824 | |||
4 | Changing | URL | Call by reference | Type reference (TYPE) | STRING | 20120824 |
Method QUERY on class /UI2/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 | '' | 20120824 | ||
2 | Importing | PREFER_HTTPS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20120824 | ||
3 | Importing | PROXY_ACTIVE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20120824 | ||
4 | Importing | REQUIRE_BOE_HTTP | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20120824 | ||
5 | Exporting | SM59_DESTINATION | Call by reference | Type reference (TYPE) | T_SM59_DESTINATION | 20120824 | |||
6 | Exporting | SM59_HTTPS_DESTINATION | Call by reference | Type reference (TYPE) | T_SINGLE_SM59_DESTINATION | 20120824 | |||
7 | Exporting | SM59_HTTP_DESTINATION | Call by reference | Type reference (TYPE) | T_SINGLE_SM59_DESTINATION | 20120824 | |||
8 | Exporting | SM59_RFC_DESTINATION | Call by reference | Type reference (TYPE) | T_SINGLE_SM59_DESTINATION | 20120824 |
Method RESOLVE_SM59_ALIAS on class /UI2/CL_URL has no exception.
Method RESOLVE_SM59_ALIAS_EX 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 | '' | 20130925 | ||
2 | Importing | PREFER_HTTPS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20130925 | ||
3 | Importing | PROXY_ACTIVE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20130925 | ||
4 | Importing | REQUIRE_BOE_HTTP | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20130925 | ||
5 | Exporting | SM59_DESTINATION | Call by reference | Type reference (TYPE) | T_SM59_DESTINATION | 20130925 | |||
6 | Exporting | SM59_HTTPS_DESTINATION | Call by reference | Type reference (TYPE) | T_SINGLE_SM59_DESTINATION | 20130925 | |||
7 | Exporting | SM59_HTTP_DESTINATION | Call by reference | Type reference (TYPE) | T_SINGLE_SM59_DESTINATION | 20130925 | |||
8 | Exporting | SM59_RFC_DESTINATION | Call by reference | Type reference (TYPE) | T_SINGLE_SM59_DESTINATION | 20130925 |
Method RESOLVE_SM59_ALIAS_EX on class /UI2/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 | 20120824 | ||
2 | Importing | PATH | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120824 | |||
3 | Importing | QUERY_PARMS | Call by reference | Type reference (TYPE) | TIHTTPNVP | 20120824 | |||
4 | Importing | QUERY_STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120824 | |||
5 | Importing | REQUIRE_BOE_HTTP | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20120824 | ||
6 | Importing | SM59_ALIAS | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120824 | |||
7 | Returning | URL | Value transfer | Type reference (TYPE) | STRING | 20120824 |
Method URL on class /UI2/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 | 20120824 | |||
2 | Importing | QUERY_PARMS | Call by reference | Type reference (TYPE) | TIHTTPNVP | 20120824 | |||
3 | Importing | QUERY_STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120824 | |||
4 | Importing | SM59_ALIAS | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120824 | |||
5 | Returning | URL | Value transfer | Type reference (TYPE) | STRING | 20120824 |
Method WDA on class /UI2/CL_URL has no exception.
History
Last changed by/on | SAP | 20141120 |
SAP Release Created in | 100 |