Package de.hybris.platform.billmanagementtmfwebservices.v2.controller

Class BmBaseController

java.lang.Object

de.hybris.platform.billmanagementtmfwebservices.v2.controller.BmBaseController

Direct Known Subclasses:

BmAppliedCustomerBillingRateController, BmCustomerBillController, BmCustomerBillOnDemandController

public class BmBaseController
extends Object

Abstract Base Controller defining common methods and fields to be used by other API controllers.

Since:

2208

Constructor Summary

Constructors

Constructor	Description
BmBaseController()

Method Summary

Modifier and Type	Method	Description
protected String	addDefaultFields(String fields)	Retrieves the attributes that the user wants to receive in response
protected String	filter(String value)
protected de.hybris.platform.webservicescommons.mapping.DataMapper	getDataMapper()
protected de.hybris.platform.servicelayer.i18n.I18NService	getI18nService()
protected org.springframework.context.MessageSource	getMessageSource()
protected com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
protected String	getQueryStringWithoutOffsetAndLimit(javax.servlet.http.HttpServletRequest request)
protected org.springframework.http.ResponseEntity	getUnsuccessfulResponse(String errorMessage, Exception e, org.springframework.http.HttpStatus httpStatus)
protected org.springframework.http.ResponseEntity	getUnsuccessfulResponse(String message, org.springframework.http.HttpStatus httpStatus)
Error	handleModelNotFoundException(Exception ex)
protected boolean	hasRole(String role, org.springframework.security.core.Authentication authentication)	Checks if the user has given role.
void	init()
protected String	sanitize(String input)
protected String	validate(Object object, String objectName, org.springframework.validation.Validator validator)

Methods inherited from class java.lang.Object

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

Constructor Details

BmBaseController

public BmBaseController()

Method Details

init

@PostConstruct
public void init()

handleModelNotFoundException

@ResponseStatus(NOT_FOUND)
@ResponseBody
@ExceptionHandler(de.hybris.platform.servicelayer.exceptions.ModelNotFoundException.class)
public Error handleModelNotFoundException(Exception ex)

getUnsuccessfulResponse

protected org.springframework.http.ResponseEntity getUnsuccessfulResponse(String errorMessage,
 Exception e,
 org.springframework.http.HttpStatus httpStatus)

getUnsuccessfulResponse

protected org.springframework.http.ResponseEntity getUnsuccessfulResponse(String message,
 org.springframework.http.HttpStatus httpStatus)

getQueryStringWithoutOffsetAndLimit

protected String getQueryStringWithoutOffsetAndLimit(javax.servlet.http.HttpServletRequest request)

filter

protected String filter(String value)

hasRole

protected boolean hasRole(String role,
 org.springframework.security.core.Authentication authentication)

Checks if the user has given role.

Parameters:

role - The role is provided as string

Returns:

False if logged in user doesn't have given role, otherwise true.

addDefaultFields

protected String addDefaultFields(String fields)

Retrieves the attributes that the user wants to receive in response

Parameters:

fields - a string representing attributes we want to receive in response

Returns:

a string consisting of default fields id,href and fields given by the user in request null, if user didn't provide any value for fields attribute

validate

protected String validate(Object object,
 String objectName,
 org.springframework.validation.Validator validator)

sanitize

protected String sanitize(String input)

getDataMapper

protected de.hybris.platform.webservicescommons.mapping.DataMapper getDataMapper()

getObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

getMessageSource

protected org.springframework.context.MessageSource getMessageSource()

getI18nService

protected de.hybris.platform.servicelayer.i18n.I18NService getI18nService()