org.kaaproject.kaa.client.profile

Class AbstractProfileContainer<T extends org.apache.avro.specific.SpecificRecordBase>

java.lang.Object

org.kaaproject.kaa.client.profile.AbstractProfileContainer<T>

All Implemented Interfaces:

ProfileContainer

public abstract class AbstractProfileContainer<T extends org.apache.avro.specific.SpecificRecordBase>
extends Object
implements ProfileContainer

Abstract container for a profile.

Should be used to implement user profile container.

It is responsible for serializing profile and notifying Kaa stuff about any updates (updateProfile()). A profile class is auto-generated according to a predefined Avro schema.

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

     \@Override
     public BasicEndpointProfile getProfile() {
         return profile;
     }

     \@Override
     protected Class<BasicEndpointProfile> getProfileClass() {
         return BasicEndpointProfile.class;
     }

     public void setNewProfile(BasicEndpointProfile profile) {
         this.profile = profile;
         // NOTE: Update method should be called to notify about changes in the profile.
         updateProfile();
     }
 }
 
 

Author:

Yaroslav Zeygerman

Constructor Summary

Constructors

Constructor and Description
AbstractProfileContainer() Constructor for the AbstractProfileContainer.

Method Summary

Methods

Modifier and Type	Method and Description
abstract T	getProfile() Retrieves user-defined profile object.
protected abstract Class<T>	getProfileClass() Retrieves profile class object.
byte[]	getSerializedProfile() Retrieves serialized profile.
void	setProfileListener(ProfileListener listener) Kaa specific stuff. NOTE: DO NOT use this API explicitly. This method is used for a post initialization of a user defined profile container.
protected void	updateProfile() Notify Kaa about profile updates. NOTE: Need to call this method every time when profile is updated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractProfileContainer

public AbstractProfileContainer()

Constructor for the AbstractProfileContainer.

Method Detail

getProfileClass

protected abstract Class<T> getProfileClass()

Retrieves profile class object.

Returns:

Class object of the user-defined profile

getSerializedProfile

public byte[] getSerializedProfile()
                            throws IOException

Retrieves serialized profile.

Specified by:

getSerializedProfile in interface ProfileContainer

Returns:

Byte array with avro serialized profile.

Throws:

IOException

updateProfile

protected final void updateProfile()
                            throws IOException

Notify Kaa about profile updates.

NOTE: Need to call this method every time when profile is updated.

Throws:

IOException

setProfileListener

public final void setProfileListener(ProfileListener listener)

Kaa specific stuff.

NOTE: DO NOT use this API explicitly.

This method is used for a post initialization of a user defined profile container.

Specified by:

setProfileListener in interface ProfileContainer

Parameters:

listener - New profile listener.

getProfile

public abstract T getProfile()

Retrieves user-defined profile object. Should be implemented by the user.

Returns:

Profile class object