io.continual.iam.identity

Interface UserDataHolder

All Known Subinterfaces:

Group, Identity

All Known Implementing Classes:

CommonJsonGroup, CommonJsonIdentity, CommonJsonObject

public interface UserDataHolder

A container for user-oriented data. In addition to being extended by Identity, the Group interface can also hold user-oriented data.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAllUserData() Get all of the user data
String	getUserData(String key) Get a named data value.
void	putUserData(String key, String val) Put a named data value.
void	reload() reload this object from the server
void	removeUserData(String key) Remove a named data value.

Method Detail

reload

void reload()
     throws IamSvcException

reload this object from the server

Throws:

IamSvcException - if there's a problem in the IAM service

getUserData

String getUserData(String key)
            throws IamSvcException

Get a named data value.

Parameters:

key - a key for a user data entry

Returns:

a value or null

Throws:

IamSvcException - if there's a problem in the IAM service

putUserData

void putUserData(String key,
                 String val)
          throws IamSvcException

Put a named data value.

Parameters:

key - a key for the user data entry

val - a value to store

Throws:

IamSvcException - if there's a problem in the IAM service

removeUserData

void removeUserData(String key)
             throws IamSvcException

Remove a named data value.

Parameters:

key - a key for a user data entry

Throws:

IamSvcException - if there's a problem in the IAM service

getAllUserData

Map<String,String> getAllUserData()
                           throws IamSvcException

Get all of the user data

Returns:

a map of user data

Throws:

IamSvcException - if there's a problem in the IAM service