de.hybris.platform.webservices.impl

Class DefaultWsUtilService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.webservices.impl.DefaultWsUtilService

All Implemented Interfaces:

WsUtilService, java.io.Serializable

public class DefaultWsUtilService
extends AbstractBusinessService
implements WsUtilService

This class implements interface WsUtilService and temporarily inholds service method definitions, that was needed in restjersey and was not yet defined in expected platform service classes.

Since:

4.0

See Also:

WsUtilService.getAddress(java.lang.Long), Serialized Form

Spring Bean ID:

restjerseyService

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor and Description
DefaultWsUtilService()

Method Summary

Modifier and Type	Method and Description
CronJobModel	createCronJobBasedOnCurrent(CronJobModel model, java.lang.String code) Create a cronjob based on delivered cronjob.
void	createEnumerationType(java.lang.String typeCode) Create enumeration value of given enumeration type
EnumerationValueModel	createEnumerationValue(java.lang.String typeCode, java.lang.String valueCode, java.lang.String name) Create enumeration value of given enumeration type
NodeFactory	findNodeFactory(java.lang.Class dtoClass) Returns a NodeFactory for specified dtoClass
AddressModel	getAddress(java.lang.Long pk)
java.util.List<AddressModel>	getAllAddresses() Gets all addresses that belong to users
java.util.Collection<CartModel>	getAllCarts() Gets all carts of system.
java.util.Collection<CompanyModel>	getAllCompanies() Returns collection of all CompanyModel objects
java.util.Collection<CustomerModel>	getAllCustomers() Gets all customers of system.
java.util.Collection<DiscountModel>	getAllDiscounts() Gets all discounts of system.
java.util.Collection<EnumerationMetaTypeModel>	getAllEnumerationTypes() Gets back all enumeration types
java.util.Collection<KeywordModel>	getAllKeywords(CatalogVersionModel versionModel) Returns collection of all Keywords for a specific catalog version
java.util.Collection<RegionModel>	getAllRegions()
java.util.Set<RegionModel>	getAllRegions(java.lang.String countryCode)
java.util.Collection<UnitModel>	getAllUnits() Returns collection of all UnitModel objects
java.util.Collection<UserGroupModel>	getAllUserGroups() Returns collection of all UserGroupModel objects
CompanyModel	getCompany(java.lang.String uid) Returns single CompanyModel object based on CompanyModel uid attribute
java.util.Set<java.lang.String>	getConfigurationForType(int level, java.lang.Class<?> runtimeNodeType, java.util.Map<java.lang.String,java.util.List<java.lang.String>> httpQueryParameters, java.util.Set<java.lang.String> allowedAttributesNames, java.util.List<java.lang.String> possibleConfigNodeNames) Gets a "attribute selector API" configuration for attributes of currently processed graph node.
CustomerModel	getCustomer(java.lang.String login) Returns single CustomerModel object based on CostomerModel login attribute
DeliveryModeModel	getDeliveryModeByCode(java.lang.String code) Returns single DeliveryModeModel object based on DeliveryModeModel code attribute
java.util.Collection<DeliveryModeModel>	getDeliveryModesByCode(java.lang.String code) Returns collection of DeliveryModeModel objects based on DeliveryModeModel code attribute
DiscountModel	getDiscount(java.lang.String code) gets back the discount upon the code
I18NService	getI18nService()
KeywordModel	getKeyword(CatalogVersionModel versionModel, LanguageModel language, java.lang.String keyword) Returns a specified KeywordModel object based on its catalogVersion, Language and value of the keyword
KeywordModel	getKeyword(CatalogVersionModel versionModel, java.lang.String keyword) Returns a specified KeywordModel object based on its catalogVersion and value of the keyword
PaymentModeModel	getPaymentModeByCode(java.lang.String code) Returns single PaymentModeModel object based on PaymentModeModel code attribute
java.util.Collection<PaymentModeModel>	getPaymentModesByCode(java.lang.String code) Returns collection of PaymentModeModel objects based on PaymentModeModel code attribute
RegionModel	getRegion(java.lang.String isocode) gets back the region upon the iso code
RegionModel	getRegion(java.lang.String countryCode, java.lang.String isocode) gets back the region upon the iso code
boolean	isMemberOf(java.lang.String userID, java.lang.String userGroupID, boolean includingSupergroups) Checks whether the principal is member of the given group or any of its subgroups.
void	setCatalogVersionsIntoJaloSession() Set appropriate catalog versions to the jalosession for current authenticated user.
void	setCronJobService(CronJobService cronJobService)
void	setFlexibleSearchService(FlexibleSearchService flexibleSearchService)
void	setI18nDao(I18NDao dao)
void	setI18nService(I18NService i18nService)
void	setNodeFactoriesMap(java.util.Map<java.lang.Object,NodeFactory> nodeFactoriesMap)
void	setRequestUserIntoJaloSession(java.lang.String userID) Set request user to jalosession.
void	setUserService(UserService userService)

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, setTenantScope, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWsUtilService

public DefaultWsUtilService()

Method Detail

findNodeFactory

public NodeFactory findNodeFactory(java.lang.Class dtoClass)

Description copied from interface: WsUtilService

Returns a NodeFactory for specified dtoClass

Specified by:

findNodeFactory in interface WsUtilService

Parameters:

dtoClass - the dtoClass to set

Returns:

the NodeFactory or null

setNodeFactoriesMap

public void setNodeFactoriesMap(java.util.Map<java.lang.Object,NodeFactory> nodeFactoriesMap)

Parameters:

nodeFactoriesMap - the nodeFactoriesMap to set

setCronJobService

public void setCronJobService(CronJobService cronJobService)

Parameters:

cronJobService - the cronJobService to set

setUserService

public void setUserService(UserService userService)

Parameters:

userService - the userService to set

getI18nService

public I18NService getI18nService()

Returns:

the i18nService

setI18nService

public void setI18nService(I18NService i18nService)

Parameters:

i18nService - the i18nService to set

getAddress

public AddressModel getAddress(java.lang.Long pk)

Specified by:

getAddress in interface WsUtilService

Parameters:

pk - pk of the address to obtain

Returns:

AddressModel

See Also:

WsUtilService.getAddress(java.lang.Long)

getAllAddresses

public java.util.List<AddressModel> getAllAddresses()

Description copied from interface: WsUtilService

Gets all addresses that belong to users

Specified by:

getAllAddresses in interface WsUtilService

Returns:

all addresses

See Also:

WsUtilService.getAllAddresses()

getAllRegions

public java.util.Set<RegionModel> getAllRegions(java.lang.String countryCode)

Specified by:

getAllRegions in interface WsUtilService

Parameters:

countryCode - ISO code of a country for which we're retrieving regions

Returns:

all regions

See Also:

WsUtilService.getAllRegions(java.lang.String)

getAllRegions

public java.util.Collection<RegionModel> getAllRegions()

Specified by:

getAllRegions in interface WsUtilService

getAllUnits

public java.util.Collection<UnitModel> getAllUnits()

Description copied from interface: WsUtilService

Returns collection of all UnitModel objects

Specified by:

getAllUnits in interface WsUtilService

Returns:

collection of UnitModel objects

See Also:

WsUtilService.getAllUnits()

getRegion

public RegionModel getRegion(java.lang.String isocode)

Description copied from interface: WsUtilService

gets back the region upon the iso code

Specified by:

getRegion in interface WsUtilService

Parameters:

isocode - code of the region

Returns:

found region

See Also:

WsUtilService.getRegion(java.lang.String)

getRegion

public RegionModel getRegion(java.lang.String countryCode,
                             java.lang.String isocode)

Description copied from interface: WsUtilService

gets back the region upon the iso code

Specified by:

getRegion in interface WsUtilService

Parameters:

countryCode - code of the region's country

isocode - code of the region

Returns:

found region

See Also:

WsUtilService.getRegion(java.lang.String,java.lang.String)

setFlexibleSearchService

public void setFlexibleSearchService(FlexibleSearchService flexibleSearchService)

Parameters:

flexibleSearchService - the flexibleSearchService to set

setI18nDao

public void setI18nDao(I18NDao dao)

Parameters:

dao - the i18nDao to set

setRequestUserIntoJaloSession

public void setRequestUserIntoJaloSession(java.lang.String userID)

Description copied from interface: WsUtilService

Set request user to jalosession.

Specified by:

setRequestUserIntoJaloSession in interface WsUtilService

Parameters:

userID - authenticated user or anonymous user

See Also:

WsUtilService.setRequestUserIntoJaloSession(java.lang.String)

setCatalogVersionsIntoJaloSession

public void setCatalogVersionsIntoJaloSession()

Description copied from interface: WsUtilService

Set appropriate catalog versions to the jalosession for current authenticated user.

Specified by:

setCatalogVersionsIntoJaloSession in interface WsUtilService

See Also:

WsUtilService.setCatalogVersionsIntoJaloSession()

getAllCarts

public java.util.Collection<CartModel> getAllCarts()

Description copied from interface: WsUtilService

Gets all carts of system.

Specified by:

getAllCarts in interface WsUtilService

Returns:

all carts

See Also:

WsUtilService.getAllCarts()

getAllDiscounts

public java.util.Collection<DiscountModel> getAllDiscounts()

Description copied from interface: WsUtilService

Gets all discounts of system.

Specified by:

getAllDiscounts in interface WsUtilService

Returns:

all discounts

See Also:

WsUtilService.getAllDiscounts()

getDiscount

public DiscountModel getDiscount(java.lang.String code)

Description copied from interface: WsUtilService

gets back the discount upon the code

Specified by:

getDiscount in interface WsUtilService

Parameters:

code - code value of DiscountModel

Returns:

found discount

See Also:

WsUtilService.getDiscount(java.lang.String)

getAllCustomers

public java.util.Collection<CustomerModel> getAllCustomers()

Description copied from interface: WsUtilService

Gets all customers of system.

Specified by:

getAllCustomers in interface WsUtilService

Returns:

all customers

See Also:

WsUtilService.getAllCustomers()

getCustomer

public CustomerModel getCustomer(java.lang.String login)

Description copied from interface: WsUtilService

Returns single CustomerModel object based on CostomerModel login attribute

Specified by:

getCustomer in interface WsUtilService

Parameters:

login - login value of CustomerModel

Returns:

CustomerModel object

See Also:

WsUtilService.getCustomer(java.lang.String)

getAllUserGroups

public java.util.Collection<UserGroupModel> getAllUserGroups()

Description copied from interface: WsUtilService

Returns collection of all UserGroupModel objects

Specified by:

getAllUserGroups in interface WsUtilService

Returns:

collection of UserGroupModel objects

See Also:

WsUtilService.getAllUserGroups()

getDeliveryModeByCode

public DeliveryModeModel getDeliveryModeByCode(java.lang.String code)

Description copied from interface: WsUtilService

Returns single DeliveryModeModel object based on DeliveryModeModel code attribute

Specified by:

getDeliveryModeByCode in interface WsUtilService

Parameters:

code - code value of DeliveryModeModel

Returns:

DeliveryModeModel object

See Also:

WsUtilService.getDeliveryModeByCode(java.lang.String)

getDeliveryModesByCode

public java.util.Collection<DeliveryModeModel> getDeliveryModesByCode(java.lang.String code)

Description copied from interface: WsUtilService

Returns collection of DeliveryModeModel objects based on DeliveryModeModel code attribute

Specified by:

getDeliveryModesByCode in interface WsUtilService

Parameters:

code - code value of DeliveryModeModel

Returns:

collection of DeliveryModeModel objects

See Also:

WsUtilService.getDeliveryModesByCode(java.lang.String)

getPaymentModeByCode

public PaymentModeModel getPaymentModeByCode(java.lang.String code)

Description copied from interface: WsUtilService

Returns single PaymentModeModel object based on PaymentModeModel code attribute

Specified by:

getPaymentModeByCode in interface WsUtilService

Parameters:

code - code value of PaymentModeModel

Returns:

PaymentModeModel object

See Also:

WsUtilService.getPaymentModeByCode(java.lang.String)

getPaymentModesByCode

public java.util.Collection<PaymentModeModel> getPaymentModesByCode(java.lang.String code)

Description copied from interface: WsUtilService

Returns collection of PaymentModeModel objects based on PaymentModeModel code attribute

Specified by:

getPaymentModesByCode in interface WsUtilService

Parameters:

code - code value of PaymentModeModel

Returns:

collection of PaymentModeModel objects

See Also:

WsUtilService.getPaymentModesByCode(java.lang.String)

getAllEnumerationTypes

public java.util.Collection<EnumerationMetaTypeModel> getAllEnumerationTypes()

Description copied from interface: WsUtilService

Gets back all enumeration types

Specified by:

getAllEnumerationTypes in interface WsUtilService

Returns:

collection of EnumerationMetaTypeModel

See Also:

WsUtilService.getAllEnumerationTypes()

createEnumerationValue

public EnumerationValueModel createEnumerationValue(java.lang.String typeCode,
                                                    java.lang.String valueCode,
                                                    java.lang.String name)

Description copied from interface: WsUtilService

Create enumeration value of given enumeration type

Specified by:

createEnumerationValue in interface WsUtilService

Parameters:

typeCode - enumeration type code

valueCode - enumeration value

name - name of the enumeration value

Returns:

created enumeration value model

See Also:

WsUtilService.createEnumerationValue(java.lang.String, java.lang.String, java.lang.String)

createEnumerationType

public void createEnumerationType(java.lang.String typeCode)
                           throws JaloDuplicateCodeException

Description copied from interface: WsUtilService

Create enumeration value of given enumeration type

Specified by:

createEnumerationType in interface WsUtilService

Parameters:

typeCode - enumerationType type code

Throws:

JaloDuplicateCodeException

See Also:

WsUtilService.createEnumerationType(java.lang.String)

getCompany

public CompanyModel getCompany(java.lang.String uid)

Description copied from interface: WsUtilService

Returns single CompanyModel object based on CompanyModel uid attribute

Specified by:

getCompany in interface WsUtilService

Parameters:

uid - uid value of CustomerModel

Returns:

CompanyModel object

See Also:

WsUtilService.getCompany(java.lang.String)

getAllCompanies

public java.util.Collection<CompanyModel> getAllCompanies()

Description copied from interface: WsUtilService

Returns collection of all CompanyModel objects

Specified by:

getAllCompanies in interface WsUtilService

Returns:

collection of CompanyModel objects

See Also:

WsUtilService.getAllCompanies()

createCronJobBasedOnCurrent

public CronJobModel createCronJobBasedOnCurrent(CronJobModel model,
                                                java.lang.String code)

Description copied from interface: WsUtilService

Create a cronjob based on delivered cronjob.

Specified by:

createCronJobBasedOnCurrent in interface WsUtilService

Parameters:

model - current cronjob model

code - of the new cronjob

Returns:

new CronJobModel based on delivered cronjob

See Also:

WsUtilService.createCronJobBasedOnCurrent(CronJobModel, String)

getAllKeywords

public java.util.Collection<KeywordModel> getAllKeywords(CatalogVersionModel versionModel)

Description copied from interface: WsUtilService

Returns collection of all Keywords for a specific catalog version

Specified by:

getAllKeywords in interface WsUtilService

Parameters:

versionModel - catalogVersionModel for which we wish to get all Keywords

Returns:

Collection of Keywords

getKeyword

public KeywordModel getKeyword(CatalogVersionModel versionModel,
                               LanguageModel language,
                               java.lang.String keyword)

Description copied from interface: WsUtilService

Returns a specified KeywordModel object based on its catalogVersion, Language and value of the keyword

Specified by:

getKeyword in interface WsUtilService

Parameters:

versionModel - catalog version of the Keyword

language - language in which the keyword is specified

keyword - value of the keyword

Returns:

KeywordModel object

getKeyword

public KeywordModel getKeyword(CatalogVersionModel versionModel,
                               java.lang.String keyword)

Description copied from interface: WsUtilService

Returns a specified KeywordModel object based on its catalogVersion and value of the keyword

Specified by:

getKeyword in interface WsUtilService

Parameters:

versionModel - catalog version of the Keyword

keyword - value of the keyword

Returns:

KeywordModel object

getConfigurationForType

public java.util.Set<java.lang.String> getConfigurationForType(int level,
                                                               java.lang.Class<?> runtimeNodeType,
                                                               java.util.Map<java.lang.String,java.util.List<java.lang.String>> httpQueryParameters,
                                                               java.util.Set<java.lang.String> allowedAttributesNames,
                                                               java.util.List<java.lang.String> possibleConfigNodeNames)

Description copied from interface: WsUtilService

Gets a "attribute selector API" configuration for attributes of currently processed graph node. Node means a DTO instance. The implementation tries to match entries from dynamic or static configuration to the possible node names that are passed in possibleConfigurationNodeNames.

Specified by:

getConfigurationForType in interface WsUtilService

Parameters:

level - Level of graph processing at which the node appears. The same node may has different configurations on different levels. Level == 0 is for the nodes that represents root element in the output XML. This means that for root resources every element of collection has level == 1 (root element is the collection wrapper)

runtimeNodeType - actual runtime type of the currently processed node.

httpQueryParameters - query parameters as returned by de.hybris.platform.webservices.objectgraphtransformer.YObjectGraphContext .getUriInfo().getQueryParameters(). These are used to provide dynamic configuration entries.

allowedAttributesNames - set of attribute names that are detected by the graph library for current node. The set of attribute names returned by this method, if any, is a subset of allowedAttributes.

possibleConfigNodeNames - Ordered list of names to look for in configuration. Used to find configuration entries that are valid for currently processed node. More than one configuration entry can be valid for a node. Generally this list should contain node type names and name of the property that refers to the node. The reasons for this are explained below:

• 1.) Consider type hierarchy. A resource can be of type (the DTO type is important here) that is a subtype of some other type. Configuration may be specified for either of these types, or for both, or for any. To handle this scenario possibleConfigurationNodeNames must contain currently processed DTO's type name, and the names of all it's supertypes. The first match "wins", so if the list is sorted so that the most specific type is first, and the least specific type is last, we get automatically "best match" strategy.
• 2.) Consider complex property of a resource. If a resource has a complex property (a property that evaluates to DTO), then the property name is the natural way for users to configure attributes for the resource (DTO) returned by this property. So the property name is a candidate for configuration entry matching. If the property name is placed first on this list, it takes precedence over DTO type name matching.

Returns:

Set of attribute qualifiers that configurations permits for the given node at given level. The returned set is a subset of allowedAttributes. Returns null if no configuration for the node was found.

isMemberOf

public boolean isMemberOf(java.lang.String userID,
                          java.lang.String userGroupID,
                          boolean includingSupergroups)

Description copied from interface: WsUtilService

Checks whether the principal is member of the given group or any of its subgroups.

Specified by:

isMemberOf in interface WsUtilService

Parameters:

userID - the user ID.

userGroupID - the group to check membership for

includingSupergroups - if true indirect membership through group-in-group is evaluated, otherwise only direct membership

Returns:

true if this principal is member of the given group or any of its subgroups.