Overview | Package | Class | Tree | Deprecated | Index | Help
| Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bea.wsrp.consumer.userproperty
Interface UserPropertyMapper

All Known Implementing Classes:
  AbstractUserPropertyMapper, DefaultUserPropertyMapper

    public interface UserPropertyMapper

Used to map consumer user properties to the properties the producer requested. To register an implementation of this interface, specify the implementation's class name in the WEB-INF/wsrp-user-property-config.xml file along with the producer handle the mapper should be applied to. For example:

        <producer-user-property-map>
            <producer-handle>remoteProducer2</producer-handle>
            <mapper-class-name>com.somecompany.CustomUserPropertyMapper</mapper-class-name>
        </producer-user-property-map>

Method Summary
`Collection<UserProperty>` | `mapProperties(RequiredUserProperties requiredProperties, Map<String,String> map, EntityPropertyCache profile)` Map the consumer's properties (profile) to the producer's (return).

Method Detail

### mapProperties

    Collection<UserProperty> mapProperties(RequiredUserProperties requiredProperties,
                                           Map<String,String> map,
                                           EntityPropertyCache profile)

  Map the consumer's properties (profile) to the producer's (return).

  Generally the map will be as follows:

  - Map a property to a constant value - key is propertySetName.propertyName - value is inside of quotes (")
  - Map a property to another property - key is propertySetName.propertyName - value is propertySetName.propertyName
  - Map a property set to another property set - key is propertySetName.* - value is propertySetName.*

  However the you may use whatever format strings your mapper understands.

  Parameters
    `requiredProperties` - the properties requested by the producer
    `map` - A map where the key is the producer's name and the value is the consumer's name
    `profile` - the User's profile on the consumer
  Returns
    the properties mapped to the producer or null for no mapped properties

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
Other names may be trademarks of their respective owners.