Package de.xima.fc.form.helper

Class URLHelper

java.lang.Object

de.xima.fc.form.helper.URLHelper

public class URLHelper
extends Object

Method Summary

Modifier and Type	Method	Description
static String	ajaxUploadServlet(String baseUrl, ValueParameters params)
static String	appointmentFreeSlotsServlet(String baseUrl, ValueParameters params)
static String	appointmentIcalServlet(String baseUrl, ValueParameters params)
static String	appointmentIcalServlet(String baseUrl, ValueParameters params, AppointmentTemplate template)
static String	attachmentFormActionURL(String baseUrl, ValueParameters requestParameters, String prozessId, FRQSession formRequestSession, String action)
static String	attachmentServlet(String baseUrl, ValueParameters params)
static String	authLoginUrlBaseFor(String baseUrl, ValueParameters params)
static String	buildFinalCallbackUrl(javax.servlet.http.HttpServletRequest request, FRQSession session)
static String	buildFinalCallbackUrl(javax.servlet.http.HttpServletRequest request, FRQSession session, boolean relative)
static String	clientCounterUrlFor(String baseUrl, ValueParameters params)
static String	completeSubmitUrl(String submitUrl, String language, FRQSession formRequestSession, String optionalSessionID)
static String	contextPart(String baseUrl, ValueParameters params)
static String	contextPart(javax.servlet.http.HttpServletRequest req)
static String	contextPart(javax.servlet.http.HttpServletRequest req, ValueParameters params)
static String	dataqueryDBUrlFor(String baseUrl, ValueParameters params)
static String	dataqueryLDAPUrlFor(String baseUrl, ValueParameters params)
static String	datasourceCSVUrlFor(String baseUrl, ValueParameters params)
static String	datasourceJSONUrlFor(String baseUrl, ValueParameters params)
static String	datasourceXMLUrlFor(String baseUrl, ValueParameters params)
static String	deleteAttachmentFormURL(String baseUrl, ValueParameters requestParameters, String prozessId, FRQSession formRequestSession)
static String	downloadAttachmentFormURL(String baseUrl, ValueParameters requestParameters, String prozessId, FRQSession formRequestSession)
static String	formPart(String baseUrl, ValueParameters params)
static String	formPart(javax.servlet.http.HttpServletRequest req)	Deprecated. Use formPart(HttpServletRequest, ValueParameters, Mandant).
static String	formPart(javax.servlet.http.HttpServletRequest req, ValueParameters params)	Deprecated. Use formPart(HttpServletRequest, ValueParameters, Mandant).
static String	formPart(javax.servlet.http.HttpServletRequest req, ValueParameters params, Mandant client)
static String	formRequestCopyFor(Projekt p, javax.servlet.http.HttpServletRequest request, ValueParameters params)
static String	formRequestCopyFor(String baseUrl, Projekt p, ValueParameters params, FormVersion formVersion, Vorgang v)	Builds a URL to the form copy servlet with a given process id of the process to copy
static String	formRequestFor(Projekt p, javax.servlet.http.HttpServletRequest request, ValueParameters params)
static String	forwardRequestFor(Projekt p, javax.servlet.http.HttpServletRequest request, ValueParameters params)
static String	getAbsoluteBaseUrl(javax.servlet.http.HttpServletRequest request)	Deprecated. Use one of the other overloads of getAbsoluteBaseUrl that let you specify the client, frontend server, or form request context.
static String	getAbsoluteBaseUrl(javax.servlet.http.HttpServletRequest request, Mandant client)
static String	getAbsoluteBaseUrl(javax.servlet.http.HttpServletRequest request, Mandant client, FrontendServer fs, boolean useUrlBase)
static String	getAbsoluteFullRequestUrl(javax.servlet.http.HttpServletRequest request)
static String	getAuthCallbackBaseUrl(IFormAuthContext authCtx)	Deprecated. Won't be available in version 8.0.0 anymore.
static String	getAuthCallbackBaseUrl(String baseUrl)
static String	getAuthCallbackBaseURL(String baseUrl, String authParam)	Deprecated. Use getAuthCallbackUrl(String, EAuthCallbackUrlType, String) instead.
static String	getAuthCallbackDefaultBaseURL(javax.servlet.http.HttpServletRequest request, Projekt project)
static String	getAuthCallbackUrl(String baseUrl, IAuthenticator<?> authenticator)
static String	getAuthCallbackUrl(String baseUrl, EAuthCallbackUrlType type, String clientName)
static String	getAuthCheckURL(IFormAuthContext authCtx)
static String	getAuthFormURL(IFormAuthContext authCtx)
static String	getAuthLoginURL(IFormAuthContext authCtx, IAuthenticatorConfig config, boolean asRedirect)
static String	getAuthLoginURL(IFormAuthContext authCtx, ProjectAuthenticatorConfig config, boolean asRedirect)	Deprecated.
static String	getAuthPasswordURL(IFormAuthContext authCtx)
static String	getBaseUrl(javax.servlet.http.HttpServletRequest request)	Deprecated. Use one of the other overloads of getBaseUrl that let you specify the client, frontend server, or form request context.
static String	getBaseUrl(javax.servlet.http.HttpServletRequest request, Mandant client)
static String	getBaseUrl(javax.servlet.http.HttpServletRequest request, Mandant client, FrontendServer fs, boolean useUrlBase)
static String	getClientResourceUrl(MandantRessource res, boolean noCache)
static String	getExternalAuthCallbackURL(IFormAuthContext authContext, String authParam)	Deprecated. Use getAuthCallbackUrl(String, EAuthCallbackUrlType, String) instead.
static String	getFullRequestUrl(javax.servlet.http.HttpServletRequest request)
static String	getProjectResourceUrl(ProjektRessource res, boolean noCache)
static String	getRelativeFullRequestUrl(javax.servlet.http.HttpServletRequest request)
static String	getSystemAuthCallbackUrl(IFormAuthContext authCtx, EAuthCallbackUrlType type, String clientName)
static String	getSystemAuthCallbackURL(IFormAuthContext authCtx, String authParam)	Deprecated. Use getSystemAuthCallbackUrl(IFormAuthContext, EAuthCallbackUrlType, String) instead.
static boolean	isExternalOrAjaxRequest(javax.servlet.http.HttpServletRequest request)
static String	keepaliveUrlFor(String baseUrl, ValueParameters params)
static String	loginRedirectUrl(String baseUrl, String frid, String queryString)
static String	mandantLoginRedirectUrl(Mandant man, String baseUrl, String frid, String queryString, String optionalSessionID)
static String	pluginServlet(String baseUrl, ValueParameters params)
static String	previewUrlFor(String baseUrl, Projekt project, ValueParameters params)	Deprecated. Use previewUrlFor(String, String, Projekt, ValueParameters, FormVersion, Vorgang, FRQSession)
static String	previewUrlFor(String baseUrl, Projekt project, ValueParameters params, FormVersion formVersion)	Deprecated. Use previewUrlFor(String, String, Projekt, ValueParameters, FormVersion, Vorgang, FRQSession)
static String	previewUrlFor(String context, String language, Projekt project, ValueParameters params)	Deprecated. Use previewUrlFor(String, String, Projekt, ValueParameters, FormVersion, Vorgang, FRQSession)
static String	previewUrlFor(String context, String language, Projekt projekt, ValueParameters params, FormVersion formVersion)	Deprecated. Use previewUrlFor(String, String, Projekt, ValueParameters, FormVersion, Vorgang, FRQSession)
static String	previewUrlFor(String baseUrl, String language, Projekt projekt, ValueParameters params, FormVersion formVersion, Vorgang formRecord, FRQSession frqsession)
static String	previewUrlFor(String baseUrl, String language, Projekt projekt, ValueParameters params, FormVersion formVersion, FRQSession frqsession)	Deprecated. Use previewUrlFor(String, String, Projekt, ValueParameters, FormVersion, Vorgang, FRQSession)
static String	provideUrlFor(String baseUrl, Projekt project)
static String	provideUrlFor(String baseUrl, Projekt p, ValueParameters params, FormVersion formVersion, Vorgang v)
static String	provideUrlFor(String baseUrl, Projekt p, ValueParameters params, Vorgang v)
static String	submitUrlFor(IFormRequestContext requestCtx)
static String	submitUrlFor(IFormRequestContext requestCtx, Vorgang vorgang)
static String	submitUrlFor(String baseUrl, Projekt p, ValueParameters params)
static String	submitUrlFor(String baseUrl, Projekt p, ValueParameters params, FormVersion formVersion)
static String	submitUrlForPreview(IFormRequestContext ctx)
static String	submitUrlForVorgang(String baseUrl, Projekt p, ValueParameters params, FormVersion formVersion, Vorgang vorgang)
static String	submitUrlForVorgang(String baseUrl, Projekt p, ValueParameters params, Vorgang vorgang)
static String	templateServlet(String baseUrl, ValueParameters params)
static String	urlFor(EFormRequestType formRequestType, String baseUrl, Projekt p, ValueParameters params, FormVersion formVersion)

Methods inherited from class java.lang.Object

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

Method Detail

contextPart

public static String contextPart(javax.servlet.http.HttpServletRequest req)

contextPart

public static String contextPart(javax.servlet.http.HttpServletRequest req,
                                 ValueParameters params)

contextPart

public static String contextPart(String baseUrl,
                                 ValueParameters params)

formPart

@Deprecated
public static String formPart(javax.servlet.http.HttpServletRequest req)

Deprecated.

Use formPart(HttpServletRequest, ValueParameters, Mandant).

Parameters:

req - Request that was made.

Returns:

The form part (e.g. ) for the URL.

formPart

@Deprecated
public static String formPart(javax.servlet.http.HttpServletRequest req,
                              ValueParameters params)

Deprecated.

Use formPart(HttpServletRequest, ValueParameters, Mandant).

Parameters:

req - Request that was made.

params - Parameters from the request.

Returns:

The form part (e.g. ) for the URL.

formPart

public static String formPart(javax.servlet.http.HttpServletRequest req,
                              ValueParameters params,
                              Mandant client)

formPart

public static String formPart(String baseUrl,
                              ValueParameters params)

loginRedirectUrl

public static String loginRedirectUrl(String baseUrl,
                                      String frid,
                                      String queryString)

mandantLoginRedirectUrl

public static String mandantLoginRedirectUrl(Mandant man,
                                             String baseUrl,
                                             String frid,
                                             String queryString,
                                             String optionalSessionID)

submitUrlForVorgang

public static String submitUrlForVorgang(String baseUrl,
                                         Projekt p,
                                         ValueParameters params,
                                         Vorgang vorgang)

submitUrlForVorgang

public static String submitUrlForVorgang(String baseUrl,
                                         Projekt p,
                                         ValueParameters params,
                                         FormVersion formVersion,
                                         Vorgang vorgang)

submitUrlFor

public static String submitUrlFor(String baseUrl,
                                  Projekt p,
                                  ValueParameters params)

submitUrlFor

public static String submitUrlFor(String baseUrl,
                                  Projekt p,
                                  ValueParameters params,
                                  FormVersion formVersion)

submitUrlFor

public static String submitUrlFor(IFormRequestContext requestCtx)

submitUrlForPreview

public static String submitUrlForPreview(IFormRequestContext ctx)

submitUrlFor

public static String submitUrlFor(IFormRequestContext requestCtx,
                                  Vorgang vorgang)

completeSubmitUrl

public static String completeSubmitUrl(String submitUrl,
                                       String language,
                                       FRQSession formRequestSession,
                                       String optionalSessionID)

urlFor

public static String urlFor(EFormRequestType formRequestType,
                            String baseUrl,
                            Projekt p,
                            ValueParameters params,
                            FormVersion formVersion)

previewUrlFor

public static String previewUrlFor(String baseUrl,
                                   String language,
                                   Projekt projekt,
                                   ValueParameters params,
                                   FormVersion formVersion,
                                   Vorgang formRecord,
                                   FRQSession frqsession)

Parameters:

baseUrl - Base URL to the FORMCYCLE server.

language - Language for the form.

projekt - Project with the form to display.

params - Value parameters from the form request.

formVersion - Form version to display.

formRecord - Optional form record for which to display the form. May be null when opening the form for the first time.

frqsession - Current form request session, if any.

Returns:

The form/preview URL for the given project and form version.

previewUrlFor

@Deprecated
public static String previewUrlFor(String baseUrl,
                                   String language,
                                   Projekt projekt,
                                   ValueParameters params,
                                   FormVersion formVersion,
                                   FRQSession frqsession)

Deprecated.

Use previewUrlFor(String, String, Projekt, ValueParameters, FormVersion, Vorgang, FRQSession)

Parameters:

baseUrl - Base URL to the FORMCYCLE server.

language - Language for the form.

projekt - Project with the form to display.

params - Value parameters from the form request.

formVersion - Form version to display.

frqsession - Current form request session, if any.

Returns:

The form/preview URL for the given project and form version.

previewUrlFor

@Deprecated
public static String previewUrlFor(String baseUrl,
                                   Projekt project,
                                   ValueParameters params)

Deprecated.

Use previewUrlFor(String, String, Projekt, ValueParameters, FormVersion, Vorgang, FRQSession)

Parameters:

baseUrl - Base URL to the FORMCYCLE server.

project - Project with the form to display.

params - Value parameters from the form request. the first time.

Returns:

The form/preview URL for the given project and form version.

previewUrlFor

@Deprecated
public static String previewUrlFor(String context,
                                   String language,
                                   Projekt project,
                                   ValueParameters params)

Deprecated.

Use previewUrlFor(String, String, Projekt, ValueParameters, FormVersion, Vorgang, FRQSession)

Parameters:

context - Base URL to the FORMCYCLE server.

language - Language for the form.

project - Project with the form to display.

params - Value parameters from the form request.

Returns:

The form/preview URL for the given project and form version.

previewUrlFor

@Deprecated
public static String previewUrlFor(String context,
                                   String language,
                                   Projekt projekt,
                                   ValueParameters params,
                                   FormVersion formVersion)

Deprecated.

Use previewUrlFor(String, String, Projekt, ValueParameters, FormVersion, Vorgang, FRQSession)

Parameters:

context - Base URL to the FORMCYCLE server.

language - Language for the form.

projekt - Project with the form to display.

params - Value parameters from the form request.

formVersion - Form version to display.

Returns:

The form/preview URL for the given project and form version.

previewUrlFor

@Deprecated
public static String previewUrlFor(String baseUrl,
                                   Projekt project,
                                   ValueParameters params,
                                   FormVersion formVersion)

Deprecated.

Use previewUrlFor(String, String, Projekt, ValueParameters, FormVersion, Vorgang, FRQSession)

Parameters:

baseUrl - Base URL to the FORMCYCLE server.

project - Project with the form to display.

params - Value parameters from the form request.

formVersion - Form version to display.

Returns:

The form/preview URL for the given project and form version.

provideUrlFor

public static String provideUrlFor(String baseUrl,
                                   Projekt project)

provideUrlFor

public static String provideUrlFor(String baseUrl,
                                   Projekt p,
                                   ValueParameters params,
                                   Vorgang v)

provideUrlFor

public static String provideUrlFor(String baseUrl,
                                   Projekt p,
                                   ValueParameters params,
                                   FormVersion formVersion,
                                   Vorgang v)

dataqueryDBUrlFor

public static String dataqueryDBUrlFor(String baseUrl,
                                       ValueParameters params)

datasourceXMLUrlFor

public static String datasourceXMLUrlFor(String baseUrl,
                                         ValueParameters params)

datasourceCSVUrlFor

public static String datasourceCSVUrlFor(String baseUrl,
                                         ValueParameters params)

datasourceJSONUrlFor

public static String datasourceJSONUrlFor(String baseUrl,
                                          ValueParameters params)

attachmentServlet

public static String attachmentServlet(String baseUrl,
                                       ValueParameters params)

appointmentFreeSlotsServlet

public static String appointmentFreeSlotsServlet(String baseUrl,
                                                 ValueParameters params)

ajaxUploadServlet

public static String ajaxUploadServlet(String baseUrl,
                                       ValueParameters params)

templateServlet

public static String templateServlet(String baseUrl,
                                     ValueParameters params)

appointmentIcalServlet

public static String appointmentIcalServlet(String baseUrl,
                                            ValueParameters params)

Parameters:

baseUrl - Context path of the web application.

params - Additional URL parameters.

Returns:

The prefix for the URL for the appointment iCal servlet, such as http://localhost:8080/xima-formcycle/appointment/ical/

See Also:

appointmentIcalServlet(String, ValueParameters, AppointmentTemplate)

appointmentIcalServlet

public static String appointmentIcalServlet(String baseUrl,
                                            ValueParameters params,
                                            AppointmentTemplate template)

Parameters:

baseUrl - Context path of the web application.

params - Additional URL parameters.

template - Template for which to generate the URL.

Returns:

The full URL for the appointment iCal servlet, such as http://localhost:8080/xima-formcycle/appointment/ical/11cab23a-a36a-416b-bd5b-ae9d0003a30f/15504ad9-5287-4739-9e6c-fad66f67203e

pluginServlet

public static String pluginServlet(String baseUrl,
                                   ValueParameters params)

formRequestCopyFor

public static String formRequestCopyFor(Projekt p,
                                        javax.servlet.http.HttpServletRequest request,
                                        ValueParameters params)

formRequestCopyFor

public static String formRequestCopyFor(String baseUrl,
                                        Projekt p,
                                        ValueParameters params,
                                        FormVersion formVersion,
                                        Vorgang v)

Builds a URL to the form copy servlet with a given process id of the process to copy

Parameters:

baseUrl - the context path of the application

p - the project to which the process is assigned. The projekt id is part of the URL. Must not be null

params - additional URL parameters. Can be null.

formVersion - if set the form of a given form version will be used. Id the param is null the currently active form version will be used

v - the process that data will be put put to the new form. Must not be null

Returns:

the url

Since:

5.0.9

formRequestFor

public static String formRequestFor(Projekt p,
                                    javax.servlet.http.HttpServletRequest request,
                                    ValueParameters params)

forwardRequestFor

public static String forwardRequestFor(Projekt p,
                                       javax.servlet.http.HttpServletRequest request,
                                       ValueParameters params)

attachmentFormActionURL

public static String attachmentFormActionURL(String baseUrl,
                                             ValueParameters requestParameters,
                                             String prozessId,
                                             FRQSession formRequestSession,
                                             String action)

deleteAttachmentFormURL

public static String deleteAttachmentFormURL(String baseUrl,
                                             ValueParameters requestParameters,
                                             String prozessId,
                                             FRQSession formRequestSession)

downloadAttachmentFormURL

public static String downloadAttachmentFormURL(String baseUrl,
                                               ValueParameters requestParameters,
                                               String prozessId,
                                               FRQSession formRequestSession)

dataqueryLDAPUrlFor

public static String dataqueryLDAPUrlFor(String baseUrl,
                                         ValueParameters params)

clientCounterUrlFor

public static String clientCounterUrlFor(String baseUrl,
                                         ValueParameters params)

keepaliveUrlFor

public static String keepaliveUrlFor(String baseUrl,
                                     ValueParameters params)

authLoginUrlBaseFor

public static String authLoginUrlBaseFor(String baseUrl,
                                         ValueParameters params)

getClientResourceUrl

public static String getClientResourceUrl(MandantRessource res,
                                          boolean noCache)

getProjectResourceUrl

public static String getProjectResourceUrl(ProjektRessource res,
                                           boolean noCache)

getAuthCallbackUrl

public static String getAuthCallbackUrl(String baseUrl,
                                        IAuthenticator<?> authenticator)

getSystemAuthCallbackUrl

public static String getSystemAuthCallbackUrl(IFormAuthContext authCtx,
                                              EAuthCallbackUrlType type,
                                              String clientName)

getAuthCallbackUrl

public static String getAuthCallbackUrl(String baseUrl,
                                        EAuthCallbackUrlType type,
                                        String clientName)

getAuthCallbackBaseUrl

public static String getAuthCallbackBaseUrl(String baseUrl)

buildFinalCallbackUrl

public static String buildFinalCallbackUrl(javax.servlet.http.HttpServletRequest request,
                                           FRQSession session)

buildFinalCallbackUrl

public static String buildFinalCallbackUrl(javax.servlet.http.HttpServletRequest request,
                                           FRQSession session,
                                           boolean relative)

getAuthLoginURL

public static String getAuthLoginURL(IFormAuthContext authCtx,
                                     IAuthenticatorConfig config,
                                     boolean asRedirect)

getAuthLoginURL

@Deprecated
public static String getAuthLoginURL(IFormAuthContext authCtx,
                                     ProjectAuthenticatorConfig config,
                                     boolean asRedirect)

Deprecated.

getAuthCheckURL

public static String getAuthCheckURL(IFormAuthContext authCtx)

getAuthFormURL

public static String getAuthFormURL(IFormAuthContext authCtx)

getAuthPasswordURL

public static String getAuthPasswordURL(IFormAuthContext authCtx)

getAuthCallbackDefaultBaseURL

public static String getAuthCallbackDefaultBaseURL(javax.servlet.http.HttpServletRequest request,
                                                   Projekt project)

getBaseUrl

public static String getBaseUrl(javax.servlet.http.HttpServletRequest request,
                                Mandant client,
                                FrontendServer fs,
                                boolean useUrlBase)

getBaseUrl

public static String getBaseUrl(javax.servlet.http.HttpServletRequest request,
                                Mandant client)

getBaseUrl

@Deprecated
public static String getBaseUrl(javax.servlet.http.HttpServletRequest request)

Deprecated.

Use one of the other overloads of getBaseUrl that let you specify the client, frontend server, or form request context.

Parameters:

request - Request that was made to the server

Returns:

The base URL for the request.

getFullRequestUrl

public static String getFullRequestUrl(javax.servlet.http.HttpServletRequest request)

Parameters:

request - The current HTTP servlet request.

Returns:

The full request URL, including all query parameters. For AJAX or external request an absolute URL is returned. Otherwise, a relative URL without the host and protocol is returned.

getRelativeFullRequestUrl

public static String getRelativeFullRequestUrl(javax.servlet.http.HttpServletRequest request)

Parameters:

request - The current HTTP servlet request.

Returns:

The full request URL, including all query parameters. This is a relative URL without the host and protocol.

getAbsoluteFullRequestUrl

public static String getAbsoluteFullRequestUrl(javax.servlet.http.HttpServletRequest request)

Parameters:

request - The current HTTP servlet request.

Returns:

The full request URL, including all query parameters. This is an absolute URL with the host and protocol is returned.

getAbsoluteBaseUrl

public static String getAbsoluteBaseUrl(javax.servlet.http.HttpServletRequest request,
                                        Mandant client)

getAbsoluteBaseUrl

public static String getAbsoluteBaseUrl(javax.servlet.http.HttpServletRequest request,
                                        Mandant client,
                                        FrontendServer fs,
                                        boolean useUrlBase)

getAbsoluteBaseUrl

@Deprecated
public static String getAbsoluteBaseUrl(javax.servlet.http.HttpServletRequest request)

Deprecated.

Use one of the other overloads of getAbsoluteBaseUrl that let you specify the client, frontend server, or form request context.

Parameters:

request - Request that was made to the server

Returns:

The absolute base URL for the request.

isExternalOrAjaxRequest

public static boolean isExternalOrAjaxRequest(javax.servlet.http.HttpServletRequest request)

getAuthCallbackBaseUrl

@Deprecated
public static String getAuthCallbackBaseUrl(IFormAuthContext authCtx)

Deprecated.

Won't be available in version 8.0.0 anymore.

getSystemAuthCallbackURL

@Deprecated
public static String getSystemAuthCallbackURL(IFormAuthContext authCtx,
                                              String authParam)

Deprecated.

Use getSystemAuthCallbackUrl(IFormAuthContext, EAuthCallbackUrlType, String) instead.

getExternalAuthCallbackURL

@Deprecated
public static String getExternalAuthCallbackURL(IFormAuthContext authContext,
                                                String authParam)

Deprecated.

Use getAuthCallbackUrl(String, EAuthCallbackUrlType, String) instead.

getAuthCallbackBaseURL

@Deprecated
public static String getAuthCallbackBaseURL(String baseUrl,
                                            String authParam)

Deprecated.

Use getAuthCallbackUrl(String, EAuthCallbackUrlType, String) instead.