Package org.broadleafcommerce.admin.server.provider.metadata

Class CustomerUsernameFieldMetadataProvider

java.lang.Object

org.broadleafcommerce.openadmin.server.dao.provider.metadata.AbstractMetadataProvider

org.broadleafcommerce.openadmin.server.dao.provider.metadata.AbstractFieldMetadataProvider

org.broadleafcommerce.admin.server.provider.metadata.CustomerUsernameFieldMetadataProvider

All Implemented Interfaces:

FieldMetadataProvider, org.springframework.core.Ordered

@Component("blCustomerUsernameFieldMetadataProvider")
@Scope("prototype")
public class CustomerUsernameFieldMetadataProvider
extends AbstractFieldMetadataProvider
implements FieldMetadataProvider

Modifies Username/EmailAddress fields based on the 'use.email.for.site.login' property

Author:

ckittrell

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	useEmailForLogin

Fields inherited from class org.broadleafcommerce.openadmin.server.dao.provider.metadata.AbstractFieldMetadataProvider

entityConfiguration, enumerationUtility

Fields inherited from class org.broadleafcommerce.openadmin.server.dao.provider.metadata.AbstractMetadataProvider

metadataOverrides

Fields inherited from interface org.broadleafcommerce.openadmin.server.dao.provider.metadata.FieldMetadataProvider

ADORNED_TARGET, BASIC, COLLECTION, MAP, MAP_FIELD

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
CustomerUsernameFieldMetadataProvider()

Method Summary

Modifier and Type	Method	Description
MetadataProviderResponse	addMetadata(AddFieldMetadataRequest addMetadataRequest, Map<String,FieldMetadata> metadata)	Contribute to metadata inspection for the Field instance in the request.
MetadataProviderResponse	addMetadataFromFieldType(AddMetadataFromFieldTypeRequest addMetadataFromFieldTypeRequest, Map<String,FieldMetadata> metadata)	Contribute to metadata inspection for the Field instance in the request.
MetadataProviderResponse	addMetadataFromMappingData(AddMetadataFromMappingDataRequest addMetadataFromMappingDataRequest, FieldMetadata metadata)	Contribute to metadata inspection using Hibernate column information.
protected boolean	canHandleRequest(LateStageAddMetadataRequest addMetadataRequest)
int	getOrder()
MetadataProviderResponse	lateStageAddMetadata(LateStageAddMetadataRequest addMetadataRequest, Map<String,FieldMetadata> metadata)	Contribute to metadata inspection for the Field instance in the request.
MetadataProviderResponse	overrideViaAnnotation(OverrideViaAnnotationRequest overrideViaAnnotationRequest, Map<String,FieldMetadata> metadata)	Contribute to metadata inspection for the entity in the request.
MetadataProviderResponse	overrideViaXml(OverrideViaXmlRequest overrideViaXmlRequest, Map<String,FieldMetadata> metadata)	Contribute to metadata inspection for the ceiling entity and config key.

Methods inherited from class org.broadleafcommerce.openadmin.server.dao.provider.metadata.AbstractFieldMetadataProvider

buildFieldInfo, convertType, getAdminPresentationEntries, getBasicJavaType, getTargetedOverride, setClassOwnership, setupBroadleafEnumeration

Methods inherited from class org.broadleafcommerce.openadmin.server.dao.provider.metadata.AbstractMetadataProvider

getTargetedOverride, setMetadataOverrides

Methods inherited from class java.lang.Object

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

Field Details

useEmailForLogin

@Value("${use.email.for.site.login:true}")
protected boolean useEmailForLogin

Constructor Details

CustomerUsernameFieldMetadataProvider

public CustomerUsernameFieldMetadataProvider()

Method Details

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

canHandleRequest

protected boolean canHandleRequest(LateStageAddMetadataRequest addMetadataRequest)

lateStageAddMetadata

public MetadataProviderResponse lateStageAddMetadata(LateStageAddMetadataRequest addMetadataRequest,
 Map<String,FieldMetadata> metadata)

Description copied from interface: FieldMetadataProvider

Contribute to metadata inspection for the Field instance in the request. Implementations should add values to the metadata parameter.

This method differs from FieldMetadataProvider.addMetadata(AddFieldMetadataRequest, Map) in that it will be invoked after the cacheable properties are assembled. It is therefore useful in scenarios where you may want to contribute properties to metadata that are dynamic and should not be cached normally.

Specified by:

lateStageAddMetadata in interface FieldMetadataProvider

Parameters:

addMetadataRequest - contains the requested field name and support classes.

metadata - implementations should add metadata for the requested field here

Returns:

whether or not this implementation adjusted metadata

addMetadataFromFieldType

public MetadataProviderResponse addMetadataFromFieldType(AddMetadataFromFieldTypeRequest addMetadataFromFieldTypeRequest,
 Map<String,FieldMetadata> metadata)

Description copied from interface: FieldMetadataProvider

Contribute to metadata inspection for the Field instance in the request. Implementations should add values to the metadata parameter. This is metadata based on the field type.

Specified by:

addMetadataFromFieldType in interface FieldMetadataProvider

Parameters:

addMetadataFromFieldTypeRequest - contains the requested field, property name and support classes.

metadata - implementations should add values for the field here

Returns:

whether or not this implementation adjusted metadata

addMetadata

public MetadataProviderResponse addMetadata(AddFieldMetadataRequest addMetadataRequest,
 Map<String,FieldMetadata> metadata)

Description copied from interface: FieldMetadataProvider

Contribute to metadata inspection for the Field instance in the request. Implementations should add values to the metadata parameter.

Specified by:

addMetadata in interface FieldMetadataProvider

Parameters:

addMetadataRequest - contains the requested field and support classes.

metadata - implementations should add metadata for the requested field here

Returns:

whether or not this implementation adjusted metadata

overrideViaAnnotation

public MetadataProviderResponse overrideViaAnnotation(OverrideViaAnnotationRequest overrideViaAnnotationRequest,
 Map<String,FieldMetadata> metadata)

Description copied from interface: FieldMetadataProvider

Contribute to metadata inspection for the entity in the request. Implementations should override values in the metadata parameter.

Specified by:

overrideViaAnnotation in interface FieldMetadataProvider

Parameters:

overrideViaAnnotationRequest - contains the requested entity and support classes.

metadata - implementations should override metadata here

Returns:

whether or not this implementation adjusted metadata

overrideViaXml

public MetadataProviderResponse overrideViaXml(OverrideViaXmlRequest overrideViaXmlRequest,
 Map<String,FieldMetadata> metadata)

Description copied from interface: FieldMetadataProvider

Contribute to metadata inspection for the ceiling entity and config key. Implementations should override values in the metadata parameter.

Specified by:

overrideViaXml in interface FieldMetadataProvider

Parameters:

overrideViaXmlRequest - contains the requested config key, ceiling entity and support classes.

metadata - implementations should override metadata here

Returns:

whether or not this implementation adjusted metadata

addMetadataFromMappingData

public MetadataProviderResponse addMetadataFromMappingData(AddMetadataFromMappingDataRequest addMetadataFromMappingDataRequest,
 FieldMetadata metadata)

Description copied from interface: FieldMetadataProvider

Contribute to metadata inspection using Hibernate column information. Implementations should impact values in the metadata parameter.

Specified by:

addMetadataFromMappingData in interface FieldMetadataProvider

Parameters:

addMetadataFromMappingDataRequest - contains the requested Hibernate type and support classes.

metadata - implementations should impact values for the metadata for the field here

Returns:

whether or not this implementation adjusted metadata