Package com.avoka.fc.core.servlet.rest

Class RestApplicationPackageV1Servlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

com.avoka.fc.core.servlet.rest.AbstractRestServlet

com.avoka.fc.core.servlet.rest.RestApplicationPackageV1Servlet

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

public class RestApplicationPackageV1Servlet
extends AbstractRestServlet

Provides a Application Package REST API Servlet.

Since:

5.1.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_ARCHIVE_FILE	The parameter pointing to the archive file for upload operations
static final String	PARAM_IMPORT_DELIVERY_CHANNELS	The parameter indicating whether to import delivery channels
static final String	PARAM_IMPORT_FORMS	The parameter indicating whether to import forms
static final String	PARAM_IMPORT_ORG_PROPERTIES	The parameter indicating whether to import forms
static final String	PARAM_IMPORT_ORG_REFERENCE_DATA	The parameter indicating whether to import organization reference data
static final String	PARAM_IMPORT_SERVICE_CONNECTIONS	The parameter indicating whether to import service connections
static final String	PARAM_IMPORT_SERVICES	The parameter indicating whether to import service definitions
static final String	PARAM_INCLUDE_ALL_VERSIONS	The parameter indicating whether to export all form versions when creating an application archive to download
static final String	PARAM_OVERWRITE_EXISTING	The parameter indicating whether to overwrite existing application packages
static final String	PARAM_PRESERVE_DELIVERY_CHANNELS	The parameter indicating whether to preserve existing delivery channels and their configuration during import
static final String	PARAM_PRESERVE_ORG_REFERENCE_DATA	The parameter indicating whether to preserve existing organization reference data
static final String	PARAM_PRESERVE_SERVICE_CONNECTIONS	The parameter indicating whether to preserve existing service connections and their configuration during import
static final String	PARAM_PRESERVE_SERVICES	The parameter indicating whether to preserve existing service definitions and their configuration during import

Fields inherited from class com.avoka.fc.core.servlet.rest.AbstractRestServlet

CONTENT_TYPE_JSON, errorLogService, logger, userAccountDao

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
RestApplicationPackageV1Servlet()

Method Summary

Modifier and Type	Method	Description
protected void	doDelete(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected void	doGet(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected void	doPost(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected void	doPut(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected String	getRestBasePath()

Methods inherited from class com.avoka.fc.core.servlet.rest.AbstractRestServlet

getMultiPartRequestMap, getNonEmptyRequestPaths, getRequestParamsMap, getRequestPaths, getThreadObjectContext, getUserAccount, isAuthorized, isAuthorized, logRequest, marshallJsonObject, renderJsonResponse, renderResponse, setNoCacheHeaders

Methods inherited from class jakarta.servlet.http.HttpServlet

doHead, doOptions, doTrace, getLastModified, init, service, service

Methods inherited from class jakarta.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Details

PARAM_ARCHIVE_FILE

public static final String PARAM_ARCHIVE_FILE

The parameter pointing to the archive file for upload operations

See Also:

• Constant Field Values

PARAM_INCLUDE_ALL_VERSIONS

public static final String PARAM_INCLUDE_ALL_VERSIONS

The parameter indicating whether to export all form versions when creating an application archive to download

See Also:

• Constant Field Values

PARAM_IMPORT_DELIVERY_CHANNELS

public static final String PARAM_IMPORT_DELIVERY_CHANNELS

The parameter indicating whether to import delivery channels

See Also:

• Constant Field Values

PARAM_IMPORT_FORMS

public static final String PARAM_IMPORT_FORMS

The parameter indicating whether to import forms

See Also:

• Constant Field Values

PARAM_IMPORT_ORG_PROPERTIES

public static final String PARAM_IMPORT_ORG_PROPERTIES

The parameter indicating whether to import forms

See Also:

• Constant Field Values

PARAM_IMPORT_ORG_REFERENCE_DATA

public static final String PARAM_IMPORT_ORG_REFERENCE_DATA

The parameter indicating whether to import organization reference data

See Also:

• Constant Field Values

PARAM_PRESERVE_ORG_REFERENCE_DATA

public static final String PARAM_PRESERVE_ORG_REFERENCE_DATA

The parameter indicating whether to preserve existing organization reference data

See Also:

• Constant Field Values

PARAM_IMPORT_SERVICES

public static final String PARAM_IMPORT_SERVICES

The parameter indicating whether to import service definitions

See Also:

• Constant Field Values

PARAM_IMPORT_SERVICE_CONNECTIONS

public static final String PARAM_IMPORT_SERVICE_CONNECTIONS

The parameter indicating whether to import service connections

See Also:

• Constant Field Values

PARAM_PRESERVE_DELIVERY_CHANNELS

public static final String PARAM_PRESERVE_DELIVERY_CHANNELS

The parameter indicating whether to preserve existing delivery channels and their configuration during import

See Also:

• Constant Field Values

PARAM_PRESERVE_SERVICES

public static final String PARAM_PRESERVE_SERVICES

The parameter indicating whether to preserve existing service definitions and their configuration during import

See Also:

• Constant Field Values

PARAM_PRESERVE_SERVICE_CONNECTIONS

public static final String PARAM_PRESERVE_SERVICE_CONNECTIONS

The parameter indicating whether to preserve existing service connections and their configuration during import

See Also:

• Constant Field Values

PARAM_OVERWRITE_EXISTING

public static final String PARAM_OVERWRITE_EXISTING

The parameter indicating whether to overwrite existing application packages

See Also:

• Constant Field Values

Constructor Details

RestApplicationPackageV1Servlet

public RestApplicationPackageV1Servlet()

Method Details

getRestBasePath

protected String getRestBasePath()

Specified by:

getRestBasePath in class AbstractRestServlet

Returns:

the REST API base path

See Also:

• AbstractRestServlet.getRestBasePath()

doGet

protected void doGet(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
              throws jakarta.servlet.ServletException,
IOException

Overrides:

doGet in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

See Also:

• HttpServlet.doGet(HttpServletRequest, HttpServletResponse)

doPost

protected void doPost(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
               throws jakarta.servlet.ServletException,
IOException

Overrides:

doPost in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

See Also:

• HttpServlet.doPost(HttpServletRequest, HttpServletResponse)

doPut

protected void doPut(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
              throws jakarta.servlet.ServletException,
IOException

Overrides:

doPut in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

See Also:

• HttpServlet.doPut(HttpServletRequest, HttpServletResponse)

doDelete

protected void doDelete(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                 throws jakarta.servlet.ServletException,
IOException

Overrides:

doDelete in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

See Also:

• HttpServlet.doDelete(HttpServletRequest, HttpServletResponse)