org.kaaproject.kaa.client.profile

Interface ProfileManager

All Known Implementing Classes:

DefaultProfileManager

public interface ProfileManager

Interface for the profile manager.

Profile manager is used to track any profile updates. If no container is set, Kaa won't be able to process these updates.

 
 // Assume, BasicEndpointProfile is a profile class auto-generated according to predefined Avro schema
 public class BasicProfileContainer extends AbstractProfileContainer<BasicEndpointProfile> {
     private BasicEndpointProfile profile = new BasicEndpointProfile();

     public BasicProfileContainer() {}
     public BasicEndpointProfile getProfile() {
         return profile;
     }
     protected Class<BasicEndpointProfile> getProfileClass() {
         return BasicEndpointProfile.class;
     }
     // User-define method
     public void setNewProfile(BasicEndpointProfile profile) {
         this.profile = profile;
         // Update method should be called to notify about changes in the profile.
         updateProfile();
     }
 }

 BasicProfileContainer container = new BasicProfileContainer();
 ProfileManager manager = kaaClient.getProfileManager();
 manager.setProfileContainer(container);

 // Assume, profile is changed. Current implementation of the profile container
 // notifies Kaa inner stuff about profile update.
 container.setNewProfile(new BasicEndpointProfile());
 
 

Author:

Yaroslav Zeygerman, Andrew Shvayka

Method Summary

Modifier and Type	Method and Description
byte[]	getSerializedProfile() Retrieves serialized profile
boolean	isInitialized() Retrieves ready-to-use state.
void	setProfileContainer(ProfileContainer container) Sets profile container implemented by the user.
void	updateProfile() Force sync of updated profile with server

Method Detail

setProfileContainer

void setProfileContainer(ProfileContainer container)

Sets profile container implemented by the user.

Parameters:

container - User-defined container

getSerializedProfile

byte[] getSerializedProfile()
                     throws IOException

Retrieves serialized profile

Returns:

serialized profile data

Throws:

IOException - the io exception

updateProfile

void updateProfile()

Force sync of updated profile with server

isInitialized

boolean isInitialized()

Retrieves ready-to-use state. A user should provide a profile container in case of a non-default profile schema.

Returns:

True if ready.