Package com.iizix.server.user
Class UserProfileImageURNProvider
- java.lang.Object
- com.iizix.server.user.UserProfileImageURNProvider
- All Implemented Interfaces:
IUserProfileImageURNProvider
public class UserProfileImageURNProvider extends java.lang.Object implements IUserProfileImageURNProvider
The URN User Profile Image Provider singleton class.- Author:
- Christopher Mindus
Constructor Summary
Constructors Constructor Description UserProfileImageURNProvider()
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description UserProfileImageRequest
createRequest()
Creates an uninitialized profile image request.static UserProfileImageURNProvider
getInstance()
Gets the singleton instance.RuntimeImageDefinition
getProfileImage(IUserProfileImageRequest request)
Gets the profile image for the user for the specified request.
Method Detail
getInstance
public static UserProfileImageURNProvider getInstance()
Gets the singleton instance.- Returns:
- The IURNUserProfileProvider instance.
createRequest
public UserProfileImageRequest createRequest()
Creates an uninitialized profile image request.- Specified by:
createRequest
in interfaceIUserProfileImageURNProvider
- Returns:
- The uninitialized request.
getProfileImage
public 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.- Specified by:
getProfileImage
in interfaceIUserProfileImageURNProvider
- 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.