Package com.iizix.urn.user
Interface IUserProfileImageURNProvider
- All Known Implementing Classes:
UserProfileImageURNProvider
public interface IUserProfileImageURNProvider
The URN provider for user profiles.- Author:
- Christopher Mindus
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IUserProfileImageRequest
createRequest()
Creates an uninitialized profile image request.RuntimeImageDefinition
getProfileImage(IUserProfileImageRequest request)
Gets the profile image for the user for the specified request.
Method Detail
createRequest
IUserProfileImageRequest createRequest()
Creates an uninitialized profile image request.- Returns:
- The uninitialized request.
getProfileImage
RuntimeImageDefinition getProfileImage(IUserProfileImageRequest request) throws java.io.IOException
Gets the profile image for the user for the specified request. The image is created and cached in the requested size if not available.- Parameters:
request
- The request.- Returns:
- The image definition, or
null
if a profile image is not available. - Throws:
java.io.IOException
- For file I/O errors.java.lang.IllegalStateException
- If the request state is not valid, e.g. required settings are not specified.