public abstract class AbstractConfigBasedClassicHandler
extends com.ibm.commerce.foundation.rest.resourcehandler.AbstractClassicResourceHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM Copyright notice field.
|
APPLICATION_ATOM_XML, APPLICATION_JSON, APPLICATION_XHTML_XML, APPLICATION_XML, CHANGE_VERB, PARAMETER_ACTION, PARAMETER_ACTION_DESCRIPTION, PARAMETER_CATALOG_ID, PARAMETER_CATALOG_ID_DESCRIPTION, PARAMETER_CURRENCY, PARAMETER_CURRENCY_DESCRIPTION, PARAMETER_FOR_USER, PARAMETER_FOR_USER_DESCRIPTION, PARAMETER_FOR_USER_ID, PARAMETER_FOR_USER_ID_DESCRIPTION, PARAMETER_LANG_ID, PARAMETER_LANG_ID_DESCRIPTION, PARAMETER_LOCALE, PARAMETER_LOCALE_DESCRIPTION, PARAMETER_MODE, PARAMETER_MODE_DESCRIPTION, PARAMETER_PAGE_NUMBER, PARAMETER_PAGE_NUMBER_DESCRIPTION, PARAMETER_PAGE_SIZE, PARAMETER_PAGE_SIZE_DESCRIPTION, PARAMETER_PROFILE_NAME, PARAMETER_PROFILE_NAME_DESCRIPTION, PARAMETER_QUERY, PARAMETER_QUERY_DESCRIPTION, PARAMETER_RESET_PASSWORD_DESCRIPTION, PARAMETER_RESPONSE_FORMAT, PARAMETER_RESPONSE_FORMAT_DESCRIPTION, PARAMETER_STORE_ID, PARAMETER_STORE_ID_DESCRIPTION, PARAMETER_WORKSPACE_IDENTIFIER, PARAMETER_WORKSPACE_IDENTIFIER_DESCRIPTION, PARAMETER_WORKSPACE_NAME, PARAMETER_WORKSPACE_NAME_DESCRIPTION, PARAMETER_WORKSPACE_TASK, PARAMETER_WORKSPACE_TASK_DESCRIPTION, PARAMETER_WORKSPACE_TASKGROUP, PARAMETER_WORKSPACE_TASKGROUP_DESCRIPTION, PROCESS_VERB, RESPONSE_200_DESCRIPTION, RESPONSE_201_DESCRIPTION, RESPONSE_204_DESCRIPTION, RESPONSE_400_DESCRIPTION, RESPONSE_401_DESCRIPTION, RESPONSE_403_DESCRIPTION, RESPONSE_404_DESCRIPTION, RESPONSE_500_DESCRIPTION
Modifier and Type | Method and Description |
---|---|
org.apache.commons.json.JSONObject |
executeConfigBasedBean(java.lang.String beanClassName,
java.lang.String profileName,
java.lang.String responseFormat,
java.util.Map<java.lang.String,java.lang.Object> paramOverrideMap)
Process a data bean request using the configuration-based profile
mappings.
|
org.apache.commons.json.JSONObject |
executeConfigBasedBean(java.lang.String beanClassName,
java.lang.String profileName,
java.lang.String responseFormat,
java.util.Map<java.lang.String,java.lang.Object> paramOverrideMap,
Protectable siteResource)
Process a data bean request using the configuration-based profile
mappings.
|
javax.ws.rs.core.Response |
executeConfigBasedBeanWithContext(java.lang.String beanClassName,
java.lang.String profileName,
java.lang.String responseFormat,
java.util.Map<java.lang.String,java.lang.Object> paramOverrideMap)
This methods sets up the
BusinessContextService start request,
then delegates to
executeConfigBasedBean(String, String, String, Map) , and finally
ends BCS the request. |
javax.ws.rs.core.Response |
executeConfigBasedBeanWithContext(java.lang.String beanClassName,
java.lang.String profileName,
java.lang.String responseFormat,
java.util.Map<java.lang.String,java.lang.Object> paramOverrideMap,
Protectable siteResource)
This methods sets up the
BusinessContextService start request,
then delegates to
executeConfigBasedBean(String, String, String, Map) , and finally
ends BCS the request. |
org.apache.commons.json.JSONObject |
executeConfigBasedCommand(java.lang.String pCmdInterfaceName,
java.lang.String profileName,
java.lang.String responseFormat,
java.lang.String storeId,
java.util.Map<java.lang.String,java.lang.Object> paramOverrideMap)
Process a controller command request using the configuration-based
profile mappings.
|
javax.ws.rs.core.Response |
executeConfigBasedCommandWithContext(java.lang.String commandInterfaceName,
java.lang.String profileName,
java.lang.String responseFormat,
java.lang.String storeId,
java.util.Map<java.lang.String,java.lang.Object> paramOverrideMap)
This methods sets up the
BusinessContextService start request,
then delegates to
AbstractClassicResourceHandler.executeControllerCommand(String, String, TypedProperty, String) ,
and finally ends BCS the request. |
createMapForProvider, createMapForProvider, generateResponseForEntireDataObject, getMapFromRequest, getStoreId, getUserId, isRequestInPreviewMode, mergeMapsForProvider, prepareAndValidate
addError, createMapForProviderWithResultData, documentApi, generateResponseFromHttpStatusCodeAndRespData, getActionRegistry, getBooleanParameterValue, getClassDescription, getDoubleParameterValue, getDoubleParameterValues, getEnumeratedParameterValue, getErrorCodeFromMessage, getExternalResourceName, getFormattedMessage, getFormattedMessageWithLocale, getFormattingGroupName, getInstrumentor, getIntegerParameterValue, getIntegerParameterValues, getLongParameterValue, getLongParameterValues, getParameterValue, getParameterValue, getParameterValues, getQueryRegistry, getRequest, getResponse, getUriInfo, handleException, initializeActionRegistry, initializeQueryRegistry, performAction, postProcess, preProcess, registerOperationWithMethodSignature, runQuery, staticConvertStreamToString, throwInvalidQueryNameException, throwInvalidQueryNameException, throwRestException, throwRestExceptionIfErrorsAreDetected, validatePageNumberPageSize
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getResourceName
public static final java.lang.String COPYRIGHT
public javax.ws.rs.core.Response executeConfigBasedBeanWithContext(java.lang.String beanClassName, java.lang.String profileName, java.lang.String responseFormat, java.util.Map<java.lang.String,java.lang.Object> paramOverrideMap)
BusinessContextService
start request,
then delegates to
executeConfigBasedBean(String, String, String, Map)
, and finally
ends BCS the request.beanClassName
- the command interface classprofileName
- profile for the bean in the configurationresponseFormat
- the response format to use when generating the resultparamOverrideMap
- Can be null
. Defines any parameters that you want
to add or override from the request object associated to this
handler. Generally this is used if there are path parameters
or entity data you would like included when it maps the query
parameters with the input for the command. The key must be a
string, the value can be any type object.executeConfigBasedBean(String, String, String, Map)
public javax.ws.rs.core.Response executeConfigBasedBeanWithContext(java.lang.String beanClassName, java.lang.String profileName, java.lang.String responseFormat, java.util.Map<java.lang.String,java.lang.Object> paramOverrideMap, Protectable siteResource)
BusinessContextService
start request,
then delegates to
executeConfigBasedBean(String, String, String, Map)
, and finally
ends BCS the request.beanClassName
- the command interface classprofileName
- profile for the bean in the configurationresponseFormat
- the response format to use when generating the resultparamOverrideMap
- Can be null
. Defines any parameters that you want
to add or override from the request object associated to this
handler. Generally this is used if there are path parameters
or entity data you would like included when it maps the query
parameters with the input for the command. The key must be a
string, the value can be any type object.siteResource
- The resource to be checked for access control for site resource.executeConfigBasedBean(String, String, String, Map)
public javax.ws.rs.core.Response executeConfigBasedCommandWithContext(java.lang.String commandInterfaceName, java.lang.String profileName, java.lang.String responseFormat, java.lang.String storeId, java.util.Map<java.lang.String,java.lang.Object> paramOverrideMap)
BusinessContextService
start request,
then delegates to
AbstractClassicResourceHandler.executeControllerCommand(String, String, TypedProperty, String)
,
and finally ends BCS the request.commandInterfaceName
- the command interface classprofileName
- profile for the command in the configurationresponseFormat
- the response format to use when generating the resultstoreId
- the store idparamOverrideMap
- Can be null
. Defines any parameters that you want
to add or override from the request object associated to this
handler. Generally this is used if there are query parameters
you would like included when it maps the entity data with the
input for the command. The key must be a string, the value can
be any type object.AbstractClassicResourceHandler.executeControllerCommand(String, String, TypedProperty, String)
public org.apache.commons.json.JSONObject executeConfigBasedBean(java.lang.String beanClassName, java.lang.String profileName, java.lang.String responseFormat, java.util.Map<java.lang.String,java.lang.Object> paramOverrideMap) throws java.lang.Exception
BusinessContextService
is dealt
with by the caller.
The input parameters will automatically be filled in based on any path parameters specified in the URL followed by any query parameters. An override map can be provided to inject more parameters or override pre-existing parameters.
beanClassName
- the command interface classprofileName
- profile for the bean in the configurationresponseFormat
- the response format to use when generating the resultparamOverrideMap
- Can be null
. Defines any parameters that you want
to add or override from the request object associated to this
handler. Generally this is used if there are path parameters
or entity data you would like included when it maps the query
parameters with the input for the command. The key must be a
string, the value can be any type object.java.lang.Exception
- If the request execution failed.public org.apache.commons.json.JSONObject executeConfigBasedBean(java.lang.String beanClassName, java.lang.String profileName, java.lang.String responseFormat, java.util.Map<java.lang.String,java.lang.Object> paramOverrideMap, Protectable siteResource) throws java.lang.Exception
BusinessContextService
is dealt
with by the caller.
The input parameters will automatically be filled in based on any path parameters specified in the URL followed by any query parameters. An override map can be provided to inject more parameters or override pre-existing parameters.
beanClassName
- the command interface classprofileName
- profile for the bean in the configurationresponseFormat
- the response format to use when generating the resultparamOverrideMap
- Can be null
. Defines any parameters that you want
to add or override from the request object associated to this
handler. Generally this is used if there are path parameters
or entity data you would like included when it maps the query
parameters with the input for the command. The key must be a
string, the value can be any type object.siteResource
- The resource to be checked for access control for site resource.java.lang.Exception
- If the request execution failed.public org.apache.commons.json.JSONObject executeConfigBasedCommand(java.lang.String pCmdInterfaceName, java.lang.String profileName, java.lang.String responseFormat, java.lang.String storeId, java.util.Map<java.lang.String,java.lang.Object> paramOverrideMap) throws java.lang.Exception
BusinessContextService
is
dealt with by the caller.
The input parameters will automatically be filled in based on any path parameters specified in the URL followed by any parameters found in the request body. An override map can be provided to inject more parameters or override pre-existing parameters.
Although the store ID is specified in the method call, it will not be automatically included in the list of parameters provided to populate the setters of the command. You must explicitly add it to the override map, or have it included via the URL path parameters or request body.
pCmdInterfaceName
- the command interface classprofileName
- profile for the command in the configurationresponseFormat
- the response format to use when generating the resultstoreId
- the store idparamOverrideMap
- Can be null
. Defines any parameters that you want
to add or override from the request object associated to this
handler. Generally this is used if there are query parameters
you would like included when it maps the entity data with the
input for the command. The key must be a string, the value can
be any type object.java.lang.Exception
- if execution of the command failed