@Path(value="store/{storeId}/cart/@self/payment_instruction") @Encoded public class PaymentInstructionHandler extends AbstractConfigBasedClassicHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM Copyright notice field.
|
static java.lang.String |
FIND_PUNCHOUT_PAYMENTINFO_BY_ORDERID_AND_PIID
The XPATH for finding punch out payment instruction by orderId and piId
|
static java.lang.String |
FORMAT_GROUP_NAME
The constant FORMAT_GROUP_NAME
|
static java.lang.String |
PARAMETER_ORDER_ID
order identifier
|
static java.lang.String |
PARAMETER_ORDER_ID_DESCRIPTION
order identifier description
|
static java.lang.String |
PARAMETER_PI_ID
payment instruction identifier
|
static java.lang.String |
PARAMETER_PI_ID_DESCRIPTION
payment instruction description
|
static java.lang.String |
RESOURCE_MAPPING_KEY
The Constant RESOURCE_MAPPING_KEY.
|
static java.lang.String |
RESOURCE_NAME
The Constant RESOURCE_NAME.
|
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
Constructor and Description |
---|
PaymentInstructionHandler() |
Modifier and Type | Method and Description |
---|---|
void |
addDataToRequestMapIfNeeded(BusinessContextType bContext,
javax.security.auth.callback.CallbackHandler cbh,
java.util.Map<java.lang.String,java.lang.Object> requestMap)
Add orderId and billing_address_id to the request map if they are not present.
|
javax.ws.rs.core.Response |
addPaymentInstruction(java.lang.String storeId,
java.lang.String responseFormat)
This method adds payment instruction to the shopping cart.
|
javax.ws.rs.core.Response |
deleteAllPaymentInstructions(java.lang.String storeId,
java.lang.String responseFormat)
This method deletes all payment Instructions from the shopping cart.
|
javax.ws.rs.core.Response |
deletePaymentInstruction(java.lang.String storeId,
java.lang.String paymentInstruction_id,
java.lang.String responseFormat)
Delete a payment Instruction from the shopping cart.
|
javax.ws.rs.core.Response |
fetchPaymentToken(java.lang.String storeId,
java.lang.String payment_token,
java.lang.String payment_method,
java.lang.String responseFormat)
Fetch Payment Token.
|
java.lang.String |
getExternalResourceName()
Get the resource name to show externally.
|
java.lang.String |
getFormattingGroupName()
This method returns the format group name to locate JSP template.
|
OrderHelper |
getHelper()
This method returns the Payment instruction helper used to payment instructions (PI) contents
|
javax.ws.rs.core.Response |
getPaymentInfo(java.lang.String storeId,
java.lang.String responseFormat)
Get payment instruction for the shopping cart.
|
javax.ws.rs.core.Response |
getPunchoutPaymentInfo(java.lang.String storeId,
java.lang.String orderId,
java.lang.String piId,
java.lang.String responseFormat)
Get payment instruction for the punch out payment.
|
java.lang.String |
getResourceName()
This method returns the name of the resource used primarily to determine
the representation of the resource.
|
javax.ws.rs.core.Response |
getSensitiveDataMaskByPlainString(java.lang.String storeId,
java.lang.String responseFormat,
java.lang.String profileName)
Gets sensitive data mask information for plain string.
|
javax.ws.rs.core.Response |
punchoutPaymentCallBack(java.lang.String storeId,
java.lang.String responseFormat)
Processes the punch-out call back requests.
|
javax.ws.rs.core.Response |
repay(java.lang.String storeId,
java.lang.String orderId,
java.lang.String piId,
java.lang.String responseFormat)
This method processes the Punch-out payment request.
|
javax.ws.rs.core.Response |
updatePaymentInstruction(java.lang.String storeId,
java.lang.String responseFormat)
This method updates an existing payment instruction in the shopping cart.
|
executeConfigBasedBean, executeConfigBasedBean, executeConfigBasedBeanWithContext, executeConfigBasedBeanWithContext, executeConfigBasedCommand, executeConfigBasedCommandWithContext
createMapForProvider, createMapForProvider, generateResponseForEntireDataObject, getMapFromRequest, getStoreId, getUserId, isRequestInPreviewMode, mergeMapsForProvider, prepareAndValidate
addError, createMapForProviderWithResultData, documentApi, generateResponseFromHttpStatusCodeAndRespData, getActionRegistry, getBooleanParameterValue, getClassDescription, getDoubleParameterValue, getDoubleParameterValues, getEnumeratedParameterValue, getErrorCodeFromMessage, getFormattedMessage, getFormattedMessageWithLocale, 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
public static final java.lang.String COPYRIGHT
public static final java.lang.String RESOURCE_NAME
public static final java.lang.String RESOURCE_MAPPING_KEY
public static final java.lang.String FORMAT_GROUP_NAME
public static final java.lang.String PARAMETER_ORDER_ID
public static final java.lang.String PARAMETER_ORDER_ID_DESCRIPTION
public static final java.lang.String PARAMETER_PI_ID
public static final java.lang.String PARAMETER_PI_ID_DESCRIPTION
public static final java.lang.String FIND_PUNCHOUT_PAYMENTINFO_BY_ORDERID_AND_PIID
public java.lang.String getResourceName()
IResourceHandler
public java.lang.String getFormattingGroupName()
getFormattingGroupName
in interface IResourceHandler
getFormattingGroupName
in class AbstractBaseResourceHandler
public OrderHelper getHelper()
@GET public javax.ws.rs.core.Response getPaymentInfo(@PathParam(value="storeId") java.lang.String storeId, @QueryParam(value="responseFormat") java.lang.String responseFormat)
storeId
- the store idresponseFormat
- the response format@GET @Path(value="punchoutPaymentInfo") public javax.ws.rs.core.Response getPunchoutPaymentInfo(@PathParam(value="storeId") java.lang.String storeId, @QueryParam(value="orderId") java.lang.String orderId, @QueryParam(value="piId") java.lang.String piId, @QueryParam(value="responseFormat") java.lang.String responseFormat)
storeId
- the store idorderId
- the order idpiId
- the payment instruction idresponseFormat
- the response format@POST @Consumes(value={"application/json","application/xml"}) public javax.ws.rs.core.Response addPaymentInstruction(@PathParam(value="storeId") java.lang.String storeId, @QueryParam(value="responseFormat") java.lang.String responseFormat)
storeId
- the store Id.responseFormat
- the response format (xml, json, or atom).@PUT @Consumes(value={"application/json","application/xml"}) public javax.ws.rs.core.Response updatePaymentInstruction(@PathParam(value="storeId") java.lang.String storeId, @QueryParam(value="responseFormat") java.lang.String responseFormat)
storeId
- the store Id.responseFormat
- the response format (xml, json, or atom).@DELETE @Path(value="{paymentInstruction_id}") public javax.ws.rs.core.Response deletePaymentInstruction(@PathParam(value="storeId") java.lang.String storeId, @PathParam(value="paymentInstruction_id") java.lang.String paymentInstruction_id, @QueryParam(value="responseFormat") java.lang.String responseFormat)
storeId
- the store Id.paymentInstruction_id
- the payment instruction_idresponseFormat
- the response format (xml, json, or atom).@DELETE public javax.ws.rs.core.Response deleteAllPaymentInstructions(@PathParam(value="storeId") java.lang.String storeId, @QueryParam(value="responseFormat") java.lang.String responseFormat)
storeId
- the store Id.responseFormat
- the response format (xml, json, or atom).@GET @Path(value="sensitive_data_mask_by_plain_string") public javax.ws.rs.core.Response getSensitiveDataMaskByPlainString(@PathParam(value="storeId") java.lang.String storeId, @QueryParam(value="responseFormat") java.lang.String responseFormat, @QueryParam(value="profileName") java.lang.String profileName) throws com.ibm.commerce.foundation.rest.resourcehandler.RestException
storeId
- the store idplainString
- the plain stringresponseFormat
- the format of the responseprofileName
- the profile namecom.ibm.commerce.foundation.rest.resourcehandler.RestException
public void addDataToRequestMapIfNeeded(BusinessContextType bContext, javax.security.auth.callback.CallbackHandler cbh, java.util.Map<java.lang.String,java.lang.Object> requestMap) throws PersonException, OrderException
bContext
- business contextcbh
- callback handlerrequestMap
- request mapPersonException
- PersonExceptionOrderException
- OrderExceptionpublic java.lang.String getExternalResourceName()
AbstractBaseResourceHandler
getExternalResourceName
in class AbstractBaseResourceHandler
@POST @Path(value="repay") @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"}) public javax.ws.rs.core.Response repay(@PathParam(value="storeId") java.lang.String storeId, @QueryParam(value="orderId") java.lang.String orderId, @QueryParam(value="piId") java.lang.String piId, @QueryParam(value="responseFormat") java.lang.String responseFormat)
storeId
- the store Id.orderId
- the order Id.piId
- the payment instruction id.responseFormat
- the response format (xml, json, or atom).@POST @Path(value="callback") @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"}) public javax.ws.rs.core.Response punchoutPaymentCallBack(@PathParam(value="storeId") java.lang.String storeId, @QueryParam(value="responseFormat") java.lang.String responseFormat)
storeId
- the store idsearchTerm
- the search termresponseFormat
- the response format@GET @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"}) @Path(value="payment_token") public javax.ws.rs.core.Response fetchPaymentToken(@PathParam(value="storeId") java.lang.String storeId, @QueryParam(value="payment_token") java.lang.String payment_token, @QueryParam(value="payment_method") java.lang.String payment_method, @QueryParam(value="responseFormat") java.lang.String responseFormat) throws java.lang.Exception
storeId
- responseFormat
- java.lang.Exception