Package swiss.trustbroker.util

Class ApiSupport

java.lang.Object

swiss.trustbroker.util.ApiSupport

@Component
public class ApiSupport
extends Object

Build application and API URLs in a consistent way with properly encoded parameters.
Note: Only the URLs needed from business or test code have been added.
When changing values, also check usage in frontend routing and API service and skinny HTML pages!

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCESS_REQUEST_ABORT_URL
static final String	ACCESS_REQUEST_COMPLETE_URL
static final String	ACCESS_REQUEST_INITIATE_URL
static final String	ACCESS_REQUEST_TRIGGER_URL
static final String	ACCESS_REQUEST_URL
static final String	ADFS_ENTRY_PATH
static final String	ADFS_ENTRY_URL
static final String	ADFS_ENTRY_URL_TRAILING_SLASH
static final String	ADFS_PATH
static final String	ADFS_WS_TRUST_COMPAT_PATH
static final String	ADFS_WS_TRUST_COMPAT_URL
static final String	ADFS_WS_TRUST_ENTRY_URL
static final String	ANNOUNCEMENTS_PAGE
static final String	ANNOUNCEMENTS_URL
static final String	API_CONTEXT	Base URL of APIs, prefix for the following API paths.
static final String	ARP_API
static final String	ARP_URL
static final String	ASSETS_URL
static final String	CONFIG_API
static final String	CONFIG_FRONTEND_API
static final String	CONFIG_SCHEMAS_API
static final String	CONFIG_STATUS_API
static final String	DEVICE_INFO_URL
static final String	ERROR_PAGE
static final String	ERROR_PAGE_URL
static final String	FRONTEND_CONTEXT	Base URL of Angular application, prefix for the following page paths.
static final String	HRD_CP_URL
static final String	HRD_PAGE
static final String	HRD_RP_CONTINUE_API
static final String	HRD_RP_CONTINUE_URL
static final String	HRD_RP_URL
static final String	HRD_SID_PARAM
static final String	HRD_URL
static final String	IMAGES_URL
static final String	KEYCLOAK_AUTH
static final String	KEYCLOAK_CERTS
static final String	KEYCLOAK_REALMS
static final String	METADATA_URL
static final String	MONITORING_ACS_URL
static final String	OIDC_API
static final String	OIDC_AUTH
static final String	OIDC_CHECK_3PCOOKIE
static final String	OIDC_INTROSPECT
static final String	OIDC_KEYS
static final String	OIDC_LOGIN_STATUS
static final String	OIDC_LOGOUT
static final String	OIDC_RESPONSE_API
static final String	OIDC_RESPONSE_URL
static final String	OIDC_REVOKE
static final String	OIDC_TOKEN
static final String	OIDC_USERINFO
static final String	PROTOCOL_OPENIDCONNECT
static final String	PUBLIC_OIDC_CONFIG_PATH
static final String	RECONFIG_URL
static final String	SAML_API
static final String	SAML_METADATA_URL
static final String	SPRING_OAUTH2
static final String	SPRING_OAUTH2_AUTHORIZE_CTXPATH
static final String	SPRING_SAML_AUTHENTICATE_CTXPATH
static final String	SPRING_SAML_FEDERATION_CTXPATH
static final String	SPRING_SAML_LOGIN_CTXPATH
static final String	SSO_GROUP_URL
static final String	SSO_PARTICIPANTS_URL
static final String	SSO_RP_URL
static final String	SSO_URL
static final String	TRANSLATIONS_URL
static final String	VERSION_API
static final String	WEB_RESOURCE_PATH
static final String	WSFED_API
static final String	WSTRUST_API
static final String	XTB_ALTERNATE_METADATA_ENDPOINT
static final String	XTB_LEGACY_ADFS_PATH
static final String	XTB_LEGACY_ENTRY_URL
static final String	XTB_LOWER_CASE_ALTERNATE_METADATA_ENDPOINT
static final String	XTB_OIDC_CONFIG_PATH	OIDC support

Constructor Summary

Constructors

Constructor	Description
ApiSupport(TrustBrokerProperties trustBrokerProperties)

Method Summary

Modifier and Type	Method	Description
static String	decodeUrlParameter(String encodedValue)
static String	encodeUrlParameter(String value)
String	getAccessRequestAbortApi(String requestId)
String	getAccessRequestAbortUrl(String sessionId)
String	getAccessRequestCompleteApi(String requestId)
String	getAccessRequestConfirmationUrl(String sessionId)
String	getAccessRequestInitiateApi(String requestId)
String	getAccessRequestInitiateUrl(String sessionId)
String	getAccessRequestInProgressUrl(String sessionId)
String	getAccessRequestOnboardingUrl(String sessionId)
String	getAccessRequestTriggerApi(String application, String returnUrl)
String	getAnnouncementsApi(String issuerId, String appName)
String	getAnnouncementsUrl(String issuer, String requestId, String appName)
String	getContinueToHrdApi(String sessionId)
String	getDeviceInfoApi()
String	getDeviceInfoUrl(String cpIssuer, String rpIssuer, String requestId)
String	getErrorPageUrl()
String	getErrorPageUrl(String errorType, String traceId)
String	getErrorPageUrlWithFlags(String errorType, String traceId, String sessionId, List<String> flags)
String	getFrontendUrl(String contextPath, String basePath, String... encodedParams)
String	getHrdCpApi(String issuer, String authnRequestId)
String	getHrdRpApi(String issuer, String authnRequestId)
String	getHrdRpContinueApi()
String	getHrdUrl(String issuer, String requestId)
String	getMonitoringAcsUrl()
String	getMonitoringAcsUrl(String rpIssuer)
String	getMonitoringAcsUrl(String rpIssuer, String cpIssuer)
String	getMonitoringAcsUrlWithQueryParameters(String rpIssuer, String cpIssuer)
String	getOidcResponseApi(String realm)
String	getProfileApi()
String	getProfilesApi()
String	getProfileSelectionUrl(String stateID)
String	getSkinnyHrd(String pageContent, String requestId, String skinnyHtml)
String	getSsoGroupApi(String groupName, String rpIssuerId, String cpIssuerId, String subjectNameId)
String	getSsoParticipantsApi()
String	getSsoParticipantsApi(String group)
String	getSsoRpApi(String rpId)
String	getSsoUrl()
String	getSsoUrl(String group)
String	getSupportInfoApi(String errorCode, String sessionId)
static boolean	isApiPath(String path)
static boolean	isFrontendPath(String path)
boolean	isInternalUrl(String uriString)
static boolean	isIntrospectRequest(String path)
static boolean	isKeycloakRealmsPath(String path)
static boolean	isLogoutRequest(String path)
static boolean	isOidcAuthPath(String path)
static boolean	isOidcCheck3pCookie(String path)
static boolean	isOidcConfigPath(String path)
static boolean	isOidcLoginStatus(String path)
static boolean	isOidcSessionPath(String path)
static boolean	isOidcSubSystemPath(String path)
static boolean	isReadyOnlyAccess(String path)
static boolean	isSamlOrOidcStaticContentPath(String path)
static boolean	isSamlPath(String path)
static boolean	isSpringFederationPath(String path)
static boolean	isUserInfoRequest(String path)
static boolean	isWebResourcePath(String path)
String	relativeUrl(String targetUrl)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FRONTEND_CONTEXT

public static final String FRONTEND_CONTEXT

Base URL of Angular application, prefix for the following page paths. See Angular app-routing module for URL mappings and their parameters.

See Also:

• Constant Field Values

ERROR_PAGE

public static final String ERROR_PAGE

See Also:

• Constant Field Values

ERROR_PAGE_URL

public static final String ERROR_PAGE_URL

See Also:

• Constant Field Values

HRD_PAGE

public static final String HRD_PAGE

See Also:

• Constant Field Values

ANNOUNCEMENTS_PAGE

public static final String ANNOUNCEMENTS_PAGE

See Also:

• Constant Field Values

API_CONTEXT

public static final String API_CONTEXT

Base URL of APIs, prefix for the following API paths. See controllers for URL mappings and their parameters.

See Also:

• WebResourceController
• HrdController
• AppController
• SsoController
• Constant Field Values

WEB_RESOURCE_PATH

public static final String WEB_RESOURCE_PATH

See Also:

• Constant Field Values

ASSETS_URL

public static final String ASSETS_URL

See Also:

• Constant Field Values

IMAGES_URL

public static final String IMAGES_URL

See Also:

• Constant Field Values

TRANSLATIONS_URL

public static final String TRANSLATIONS_URL

See Also:

• Constant Field Values

HRD_URL

public static final String HRD_URL

See Also:

• Constant Field Values

HRD_RP_URL

public static final String HRD_RP_URL

See Also:

• Constant Field Values

HRD_RP_CONTINUE_API

public static final String HRD_RP_CONTINUE_API

See Also:

• Constant Field Values

HRD_RP_CONTINUE_URL

public static final String HRD_RP_CONTINUE_URL

See Also:

• Constant Field Values

HRD_CP_URL

public static final String HRD_CP_URL

See Also:

• Constant Field Values

HRD_SID_PARAM

public static final String HRD_SID_PARAM

See Also:

• Constant Field Values

SSO_URL

public static final String SSO_URL

See Also:

• Constant Field Values

SSO_GROUP_URL

public static final String SSO_GROUP_URL

See Also:

• Constant Field Values

SSO_RP_URL

public static final String SSO_RP_URL

See Also:

• Constant Field Values

SSO_PARTICIPANTS_URL

public static final String SSO_PARTICIPANTS_URL

See Also:

• Constant Field Values

DEVICE_INFO_URL

public static final String DEVICE_INFO_URL

See Also:

• Constant Field Values

ANNOUNCEMENTS_URL

public static final String ANNOUNCEMENTS_URL

See Also:

• Constant Field Values

ACCESS_REQUEST_URL

public static final String ACCESS_REQUEST_URL

See Also:

• Constant Field Values

ACCESS_REQUEST_COMPLETE_URL

public static final String ACCESS_REQUEST_COMPLETE_URL

See Also:

• Constant Field Values

ACCESS_REQUEST_INITIATE_URL

public static final String ACCESS_REQUEST_INITIATE_URL

See Also:

• Constant Field Values

ACCESS_REQUEST_ABORT_URL

public static final String ACCESS_REQUEST_ABORT_URL

See Also:

• Constant Field Values

ACCESS_REQUEST_TRIGGER_URL

public static final String ACCESS_REQUEST_TRIGGER_URL

See Also:

• Constant Field Values

MONITORING_ACS_URL

public static final String MONITORING_ACS_URL

See Also:

• Constant Field Values

CONFIG_STATUS_API

public static final String CONFIG_STATUS_API

See Also:

• Constant Field Values

CONFIG_SCHEMAS_API

public static final String CONFIG_SCHEMAS_API

See Also:

• Constant Field Values

VERSION_API

public static final String VERSION_API

See Also:

• Constant Field Values

CONFIG_API

public static final String CONFIG_API

See Also:

• Constant Field Values

CONFIG_FRONTEND_API

public static final String CONFIG_FRONTEND_API

See Also:

• Constant Field Values

SAML_API

public static final String SAML_API

See Also:

• Constant Field Values

WSTRUST_API

public static final String WSTRUST_API

See Also:

• Constant Field Values

WSFED_API

public static final String WSFED_API

See Also:

• Constant Field Values

ARP_API

public static final String ARP_API

See Also:

• Constant Field Values

METADATA_URL

public static final String METADATA_URL

See Also:

• Constant Field Values

SAML_METADATA_URL

public static final String SAML_METADATA_URL

See Also:

• Constant Field Values

ARP_URL

public static final String ARP_URL

See Also:

• Constant Field Values

RECONFIG_URL

public static final String RECONFIG_URL

See Also:

• Constant Field Values

XTB_OIDC_CONFIG_PATH

public static final String XTB_OIDC_CONFIG_PATH

OIDC support

See Also:

• Constant Field Values

PUBLIC_OIDC_CONFIG_PATH

public static final String PUBLIC_OIDC_CONFIG_PATH

See Also:

• Constant Field Values

KEYCLOAK_REALMS

public static final String KEYCLOAK_REALMS

See Also:

• Constant Field Values

SPRING_OAUTH2

public static final String SPRING_OAUTH2

See Also:

• Constant Field Values

KEYCLOAK_AUTH

public static final String KEYCLOAK_AUTH

See Also:

• Constant Field Values

KEYCLOAK_CERTS

public static final String KEYCLOAK_CERTS

See Also:

• Constant Field Values

OIDC_AUTH

public static final String OIDC_AUTH

See Also:

• Constant Field Values

OIDC_TOKEN

public static final String OIDC_TOKEN

See Also:

• Constant Field Values

OIDC_USERINFO

public static final String OIDC_USERINFO

See Also:

• Constant Field Values

OIDC_KEYS

public static final String OIDC_KEYS

See Also:

• Constant Field Values

OIDC_INTROSPECT

public static final String OIDC_INTROSPECT

See Also:

• Constant Field Values

OIDC_REVOKE

public static final String OIDC_REVOKE

See Also:

• Constant Field Values

OIDC_LOGOUT

public static final String OIDC_LOGOUT

See Also:

• Constant Field Values

OIDC_CHECK_3PCOOKIE

public static final String OIDC_CHECK_3PCOOKIE

See Also:

• Constant Field Values

OIDC_LOGIN_STATUS

public static final String OIDC_LOGIN_STATUS

See Also:

• Constant Field Values

PROTOCOL_OPENIDCONNECT

public static final String PROTOCOL_OPENIDCONNECT

See Also:

• Constant Field Values

SPRING_OAUTH2_AUTHORIZE_CTXPATH

public static final String SPRING_OAUTH2_AUTHORIZE_CTXPATH

See Also:

• Constant Field Values

SPRING_SAML_LOGIN_CTXPATH

public static final String SPRING_SAML_LOGIN_CTXPATH

See Also:

• Constant Field Values

SPRING_SAML_FEDERATION_CTXPATH

public static final String SPRING_SAML_FEDERATION_CTXPATH

See Also:

• Constant Field Values

SPRING_SAML_AUTHENTICATE_CTXPATH

public static final String SPRING_SAML_AUTHENTICATE_CTXPATH

See Also:

• Constant Field Values

OIDC_API

public static final String OIDC_API

See Also:

• Constant Field Values

OIDC_RESPONSE_API

public static final String OIDC_RESPONSE_API

See Also:

• Constant Field Values

OIDC_RESPONSE_URL

public static final String OIDC_RESPONSE_URL

See Also:

• Constant Field Values

ADFS_PATH

public static final String ADFS_PATH

See Also:

• Constant Field Values

ADFS_ENTRY_PATH

public static final String ADFS_ENTRY_PATH

See Also:

• Constant Field Values

ADFS_ENTRY_URL

public static final String ADFS_ENTRY_URL

See Also:

• Constant Field Values

ADFS_ENTRY_URL_TRAILING_SLASH

public static final String ADFS_ENTRY_URL_TRAILING_SLASH

See Also:

• Constant Field Values

ADFS_WS_TRUST_ENTRY_URL

public static final String ADFS_WS_TRUST_ENTRY_URL

See Also:

• Constant Field Values

ADFS_WS_TRUST_COMPAT_PATH

public static final String ADFS_WS_TRUST_COMPAT_PATH

See Also:

• Constant Field Values

ADFS_WS_TRUST_COMPAT_URL

public static final String ADFS_WS_TRUST_COMPAT_URL

See Also:

• Constant Field Values

XTB_LEGACY_ADFS_PATH

public static final String XTB_LEGACY_ADFS_PATH

See Also:

• Constant Field Values

XTB_LEGACY_ENTRY_URL

public static final String XTB_LEGACY_ENTRY_URL

See Also:

• Constant Field Values

XTB_ALTERNATE_METADATA_ENDPOINT

public static final String XTB_ALTERNATE_METADATA_ENDPOINT

See Also:

• Constant Field Values

XTB_LOWER_CASE_ALTERNATE_METADATA_ENDPOINT

public static final String XTB_LOWER_CASE_ALTERNATE_METADATA_ENDPOINT

See Also:

• Constant Field Values

Constructor Details

ApiSupport

public ApiSupport(TrustBrokerProperties trustBrokerProperties)

Method Details

isApiPath

public static boolean isApiPath(String path)

isWebResourcePath

public static boolean isWebResourcePath(String path)

isSamlPath

public static boolean isSamlPath(String path)

isFrontendPath

public static boolean isFrontendPath(String path)

isKeycloakRealmsPath

public static boolean isKeycloakRealmsPath(String path)

isOidcSubSystemPath

public static boolean isOidcSubSystemPath(String path)

isOidcAuthPath

public static boolean isOidcAuthPath(String path)

isSpringFederationPath

public static boolean isSpringFederationPath(String path)

isOidcSessionPath

public static boolean isOidcSessionPath(String path)

isOidcConfigPath

public static boolean isOidcConfigPath(String path)

isUserInfoRequest

public static boolean isUserInfoRequest(String path)

isIntrospectRequest

public static boolean isIntrospectRequest(String path)

isReadyOnlyAccess

public static boolean isReadyOnlyAccess(String path)

isLogoutRequest

public static boolean isLogoutRequest(String path)

isOidcCheck3pCookie

public static boolean isOidcCheck3pCookie(String path)

isSamlOrOidcStaticContentPath

public static boolean isSamlOrOidcStaticContentPath(String path)

isOidcLoginStatus

public static boolean isOidcLoginStatus(String path)

getHrdUrl

public String getHrdUrl(String issuer,
 String requestId)

getSkinnyHrd

public String getSkinnyHrd(String pageContent,
 String requestId,
 String skinnyHtml)

getDeviceInfoUrl

public String getDeviceInfoUrl(String cpIssuer,
 String rpIssuer,
 String requestId)

getProfileSelectionUrl

public String getProfileSelectionUrl(String stateID)

getErrorPageUrl

public String getErrorPageUrl()

getErrorPageUrl

public String getErrorPageUrl(String errorType,
 String traceId)

getErrorPageUrlWithFlags

public String getErrorPageUrlWithFlags(String errorType,
 String traceId,
 String sessionId,
 List<String> flags)

getSsoUrl

public String getSsoUrl()

getSsoUrl

public String getSsoUrl(String group)

getAnnouncementsUrl

public String getAnnouncementsUrl(String issuer,
 String requestId,
 String appName)

getAccessRequestInitiateUrl

public String getAccessRequestInitiateUrl(String sessionId)

getAccessRequestInProgressUrl

public String getAccessRequestInProgressUrl(String sessionId)

getAccessRequestOnboardingUrl

public String getAccessRequestOnboardingUrl(String sessionId)

getAccessRequestAbortUrl

public String getAccessRequestAbortUrl(String sessionId)

getAccessRequestConfirmationUrl

public String getAccessRequestConfirmationUrl(String sessionId)

getAccessRequestCompleteApi

public String getAccessRequestCompleteApi(String requestId)

getAccessRequestInitiateApi

public String getAccessRequestInitiateApi(String requestId)

getAccessRequestTriggerApi

public String getAccessRequestTriggerApi(String application,
 String returnUrl)

getAccessRequestAbortApi

public String getAccessRequestAbortApi(String requestId)

getSsoParticipantsApi

public String getSsoParticipantsApi()

getSsoParticipantsApi

public String getSsoParticipantsApi(String group)

getSsoGroupApi

public String getSsoGroupApi(String groupName,
 String rpIssuerId,
 String cpIssuerId,
 String subjectNameId)

getSsoRpApi

public String getSsoRpApi(String rpId)

getDeviceInfoApi

public String getDeviceInfoApi()

getHrdRpApi

public String getHrdRpApi(String issuer,
 String authnRequestId)

getHrdRpContinueApi

public String getHrdRpContinueApi()

getHrdCpApi

public String getHrdCpApi(String issuer,
 String authnRequestId)

getMonitoringAcsUrl

public String getMonitoringAcsUrl()

getMonitoringAcsUrl

public String getMonitoringAcsUrl(String rpIssuer)

getMonitoringAcsUrl

public String getMonitoringAcsUrl(String rpIssuer,
 String cpIssuer)

getMonitoringAcsUrlWithQueryParameters

public String getMonitoringAcsUrlWithQueryParameters(String rpIssuer,
 String cpIssuer)

getProfilesApi

public String getProfilesApi()

getProfileApi

public String getProfileApi()

getAnnouncementsApi

public String getAnnouncementsApi(String issuerId,
 String appName)

getContinueToHrdApi

public String getContinueToHrdApi(String sessionId)

getSupportInfoApi

public String getSupportInfoApi(String errorCode,
 String sessionId)

getOidcResponseApi

public String getOidcResponseApi(String realm)

isInternalUrl

public boolean isInternalUrl(String uriString)

getFrontendUrl

public String getFrontendUrl(String contextPath,
 String basePath,
 String... encodedParams)

encodeUrlParameter

public static String encodeUrlParameter(String value)

decodeUrlParameter

public static String decodeUrlParameter(String encodedValue)

relativeUrl

public String relativeUrl(String targetUrl)