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 and Description
static String	appointmentFreeSlotsServlet(String context, ValueParameters params)
static String	appointmentIcalServlet(String context, ValueParameters params)
static String	appointmentIcalServlet(String context, ValueParameters params, AppointmentTemplate template)
static String	attachmentFormActionURL(String context, ValueParameters requestParameters, String prozessId, FRQSession formRequestSession, String action)
static String	attachmentServlet(String context, ValueParameters params)
static String	buildFinalCallbackUrl(javax.servlet.http.HttpServletRequest request, FRQSession session)
static String	completeSubmitUrl(String submitUrl, String language, FRQSession formRequestSession, String optionalSessionID)
static String	contextPart(javax.servlet.http.HttpServletRequest req, ValueParameters params)
static String	contextPart(String contextPath, ValueParameters params)
static String	dataqueryDBUrlFor(String context, ValueParameters params)
static String	dataqueryLDAPUrlFor(String context, ValueParameters params)
static String	datasourceCSVUrlFor(String context, ValueParameters params)
static String	datasourceJSONUrlFor(String context, ValueParameters params)
static String	datasourceXMLUrlFor(String context, ValueParameters params)
static String	deleteAttachmentFormURL(String context, ValueParameters requestParameters, String prozessId, FRQSession formRequestSession)
static String	downloadAttachmentFormURL(String context, ValueParameters requestParameters, String prozessId, FRQSession formRequestSession)
static String	formPart(javax.servlet.http.HttpServletRequest req, ValueParameters params)
static String	formPart(String contextPath, ValueParameters params)
static String	formRequestCopyFor(Projekt p, javax.servlet.http.HttpServletRequest request, ValueParameters params)
static String	formRequestCopyFor(String context, 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	getAuthCallbackBaseURL(String baseUrl, String authParam)
static String	getAuthCallbackDefaultBaseURL(javax.servlet.http.HttpServletRequest request, Projekt project)
static String	getAuthCheckURL(IFormAuthContext authCtx)
static String	getAuthFormURL(IFormAuthContext authContext)
static String	getAuthLoginURL(IFormAuthContext authCtx, ProjectAuthenticatorConfig config, boolean asRedirect)
static String	getAuthLoginURL(ProjectAuthenticatorConfig config, FRQSession session)
static String	getAuthPasswordURL(IFormAuthContext authContext)
static String	getClientResourceUrl(MandantRessource res, boolean noCache)
static String	getExternalAuthCallbackURL(IFormAuthContext authContext, String authParam)
static String	getProjectResourceUrl(ProjektRessource res, boolean noCache)
static String	getSystemAuthCallbackURL(IFormAuthContext authContext, String authParam)
static String	keepaliveUrlFor(String context, ValueParameters params)
static String	loginRedirectUrl(String contextPath, String frid, String queryString)
static String	mandantLoginRedirectUrl(Mandant man, String contextPath, String frid, String queryString, String optionalSessionID)
static String	pluginServlet(String context, ValueParameters params)
static String	previewUrlFor(String context, Projekt p, ValueParameters params) Deprecated. use previewUrlFor(String, String, Projekt, ValueParameters)
static String	previewUrlFor(String context, Projekt p, ValueParameters params, FormVersion formVersion) Deprecated. use previewUrlFor(String, String, Projekt, ValueParameters, FormVersion)
static String	previewUrlFor(String context, String language, Projekt p, ValueParameters params)
static String	previewUrlFor(String context, String language, Projekt projekt, ValueParameters params, FormVersion formVersion)
static String	provideUrlFor(String context, Projekt project)
static String	provideUrlFor(String context, Projekt p, ValueParameters params, FormVersion formVersion, Vorgang v)
static String	provideUrlFor(String context, Projekt p, ValueParameters params, Vorgang v)
static String	submitUrlFor(IFormRequestContext requestCtx)
static String	submitUrlFor(IFormRequestContext requestCtx, Vorgang vorgang)
static String	submitUrlFor(String context, Projekt p, ValueParameters params)
static String	submitUrlFor(String context, Projekt p, ValueParameters params, FormVersion formVersion)
static String	submitUrlForPreview(IFormRequestContext ctx)
static String	submitUrlForVorgang(String context, Projekt p, ValueParameters params, FormVersion formVersion, Vorgang vorgang)
static String	submitUrlForVorgang(String context, Projekt p, ValueParameters params, Vorgang vorgang)
static String	urlFor(EFormRequestType formRequestType, String context, 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,
                                 ValueParameters params)

contextPart

public static String contextPart(String contextPath,
                                 ValueParameters params)

formPart

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

formPart

public static String formPart(String contextPath,
                              ValueParameters params)

loginRedirectUrl

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

mandantLoginRedirectUrl

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

submitUrlForVorgang

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

submitUrlForVorgang

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

submitUrlFor

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

submitUrlFor

public static String submitUrlFor(String context,
                                  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 context,
                            Projekt p,
                            ValueParameters params,
                            FormVersion formVersion)

previewUrlFor

public static String previewUrlFor(String context,
                                   String language,
                                   Projekt p,
                                   ValueParameters params)

previewUrlFor

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

previewUrlFor

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

Deprecated. use previewUrlFor(String, String, Projekt, ValueParameters)

previewUrlFor

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

Deprecated. use previewUrlFor(String, String, Projekt, ValueParameters, FormVersion)

provideUrlFor

public static String provideUrlFor(String context,
                                   Projekt project)

provideUrlFor

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

provideUrlFor

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

dataqueryDBUrlFor

public static String dataqueryDBUrlFor(String context,
                                       ValueParameters params)

datasourceXMLUrlFor

public static String datasourceXMLUrlFor(String context,
                                         ValueParameters params)

datasourceCSVUrlFor

public static String datasourceCSVUrlFor(String context,
                                         ValueParameters params)

datasourceJSONUrlFor

public static String datasourceJSONUrlFor(String context,
                                          ValueParameters params)

attachmentServlet

public static String attachmentServlet(String context,
                                       ValueParameters params)

appointmentFreeSlotsServlet

public static String appointmentFreeSlotsServlet(String context,
                                                 ValueParameters params)

appointmentIcalServlet

public static String appointmentIcalServlet(String context,
                                            ValueParameters params)

Parameters:

context - 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 context,
                                            ValueParameters params,
                                            AppointmentTemplate template)

Parameters:

context - 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 context,
                                   ValueParameters params)

formRequestCopyFor

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

formRequestCopyFor

public static String formRequestCopyFor(String context,
                                        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:

context - 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 context,
                                             ValueParameters requestParameters,
                                             String prozessId,
                                             FRQSession formRequestSession,
                                             String action)

deleteAttachmentFormURL

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

downloadAttachmentFormURL

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

dataqueryLDAPUrlFor

public static String dataqueryLDAPUrlFor(String context,
                                         ValueParameters params)

keepaliveUrlFor

public static String keepaliveUrlFor(String context,
                                     ValueParameters params)

getClientResourceUrl

public static String getClientResourceUrl(MandantRessource res,
                                          boolean noCache)

getProjectResourceUrl

public static String getProjectResourceUrl(ProjektRessource res,
                                           boolean noCache)

getExternalAuthCallbackURL

public static String getExternalAuthCallbackURL(IFormAuthContext authContext,
                                                String authParam)

getAuthCallbackBaseURL

public static String getAuthCallbackBaseURL(String baseUrl,
                                            String authParam)

getSystemAuthCallbackURL

public static String getSystemAuthCallbackURL(IFormAuthContext authContext,
                                              String authParam)

buildFinalCallbackUrl

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

getAuthLoginURL

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

getAuthLoginURL

public static String getAuthLoginURL(ProjectAuthenticatorConfig config,
                                     FRQSession session)

getAuthCheckURL

public static String getAuthCheckURL(IFormAuthContext authCtx)

getAuthFormURL

public static String getAuthFormURL(IFormAuthContext authContext)

getAuthPasswordURL

public static String getAuthPasswordURL(IFormAuthContext authContext)

getAuthCallbackDefaultBaseURL

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