public interface IProfileAdapter extends IServiceAdapter
Implementations of this interface must ensure that the following property can be retrieved from the IConfigManager implementation being used in the application's AdapterEnvironment:
Property: /config/soccom/adapter/impl/<name>/profile
Value: A string that contains the fully qualified name of the class that implements the IProfileAdapter interface.
Where: <name> is the short name used to identify this implementation.
Example: /config/soccom/adapter/impl/pluck/profile = "com.ibm.commerce.soccom.pluck.ProfileAdapterImpl"
Each user profile consists of a set of details that are specific to the profile service provider. These details are described using the JSON format. An example description is shown below.
[ { "screenname": { "name": "Screen name", "description": "The user's visible name", "type": "string" } }, { "birthday": { "name": "Birthday", "description": "The user's date of birth", "type": "date" } } ]
This example contains two details. They are placed in the order that they should be displayed to the user in the create and update forms. Each detail should have a single map with a single key. These keys will be used by the details arrays that are accepted and returned by the API methods.
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
Copy Right Statement
|
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,java.lang.Object> | fetch(java.lang.String userHandle)
Retrieves the user profile details for the user identified by userHandle.
|
java.util.Map<java.lang.String,java.lang.Object> | fetchProfileList(java.lang.String[] profileList)
Retrieves a list of user profile details for the users listed in profileList.
|
boolean | update(java.lang.String userHandle, java.util.Map<java.lang.String,java.lang.Object> details)
Creates or updates the user profile for userHandle.
|
static final java.lang.String COPYRIGHT
boolean update(java.lang.String userHandle, java.util.Map<java.lang.String,java.lang.Object> details) throws AdapterException
java.util.Map<java.lang.String,java.lang.Object> fetch(java.lang.String userHandle) throws AdapterException
java.util.Map<java.lang.String,java.lang.Object> fetchProfileList(java.lang.String[] profileList) throws AdapterException