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

Class PasswordFieldMetadataProvider

java.lang.Object
org.broadleafcommerce.openadmin.server.dao.provider.metadata.AbstractMetadataProvider
org.broadleafcommerce.openadmin.server.dao.provider.metadata.AbstractFieldMetadataProvider
org.broadleafcommerce.openadmin.server.dao.provider.metadata.PasswordFieldMetadataProvider
All Implemented Interfaces:
FieldMetadataProvider, org.springframework.core.Ordered
@Component("blPasswordFieldMetadataProvider") @Scope("prototype") public class PasswordFieldMetadataProvider extends AbstractFieldMetadataProvider implements FieldMetadataProvider
Adds a new 'passwordConfirm' field to the metadata as well as ensures that the field type for the password field is actually a password
Author:
Phillip Verheyden (phillipuniverse)

  • Constructor Details

    • PasswordFieldMetadataProvider

      public PasswordFieldMetadataProvider()

  • Method Details

    • getOrder

      public int getOrder()
      Specified by:
      getOrder in interface org.springframework.core.Ordered

    • 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

    • 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

    • 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