EndpointRegistrationManager (Kaa Client (Java Core) 0.6.1 API)

All Known Implementing Classes:

DefaultEndpointRegistrationManager
```
public interface EndpointRegistrationManager
```
Module that manages endpoint-initiated attaching and detaching endpoints to (from) user.

To assign endpoints to user current endpoint has to be already attached, otherwise attach/detach operations will fail.
Current endpoint can be attached to user in two ways:
By calling attachUser(String, String, UserAuthResultListener)
Attached from another endpoint

 EndpointRegistrationManager registrationManager = kaaClient.getEndpointRegistrationManager();
 registrationManager.attachUser("userExternalId", "userAccessToken", new UserAuthResultListener() { ... });

isAttachedToUser()

 EndpointRegistrationManager registrationManager = kaaClient.getEndpointRegistrationManager();
 registrationManager.attachEndpoint(new EndpointAccessToken("accessToken"), new EndpointOperationResultListener() {...});

EndpointKeyHash

 EndpointRegistrationManager registrationManager = kaaClient.getEndpointRegistrationManager();
 registrationManager.detachEndpoint((new EndpointKeyHash("keyHash"), new EndpointOperationResultListener() {...});

EndpointOperationResultListener

CurrentEndpointAttachListener

CurrentEndpointDetachListener

UserTransport

ProfileTransport

Author:: Taras Lemkin
See Also:: EndpointAccessToken, EndpointKeyHash, EndpointOperationResultListener, UserAuthResultListener, AttachedEndpointListChangedListener, CurrentEndpointAttachListener, CurrentEndpointDetachListener, UserTransport, ProfileTransport

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAttachedEndpointListChangeListener(AttachedEndpointListChangedListener listener)` Updates with listener for attached endpoint list updates
`void`	`attachEndpoint(EndpointAccessToken endpointAccessToken, EndpointOperationResultListener resultListener)` Updates with new endpoint attach request `EndpointOperationResultListener` is populated with `EndpointKeyHash` of an attached endpoint.
`void`	`attachUser(String userExternalId, String userAccessToken, UserAuthResultListener callback)` Creates user attach request
`void`	`detachEndpoint(EndpointKeyHash endpointKeyHash, EndpointOperationResultListener resultListener)` Updates with new endpoint detach request
`Map<EndpointAccessToken,EndpointKeyHash>`	`getAttachedEndpointList()` Retrieves list of attached endpoints
`String`	`getEndpointAccessToken()` Retrieve an access token for a current endpoint
`boolean`	`isAttachedToUser()` Checks if current endpoint is attached to user.
`void`	`regenerateEndpointAccessToken()` Generate new access token for a current endpoint
`void`	`removeAttachedEndpointListChangeListener(AttachedEndpointListChangedListener listener)` Removes listener of attached endpoint list changes
`void`	`setAttachedListener(CurrentEndpointAttachListener listener)` Sets callback for notifications when current endpoint is attached to user
`void`	`setDetachedListener(CurrentEndpointDetachListener listener)` Sets callback for notifications when current endpoint is detached from user
`void`	`setProfileTransport(ProfileTransport transport)` Sets the Profile transport for the current manager to communicate with remote server.
`void`	`setUserTransport(UserTransport transport)` Sets the User transport for the current manager to communicate with remote server.

- Method Detail
  - regenerateEndpointAccessToken
```
void regenerateEndpointAccessToken()
```
    Generate new access token for a current endpoint
  - getEndpointAccessToken
```
String getEndpointAccessToken()
```
    Retrieve an access token for a current endpoint
  - attachEndpoint
```
void attachEndpoint(EndpointAccessToken endpointAccessToken,
                  EndpointOperationResultListener resultListener)
```
    Updates with new endpoint attach request
    
    EndpointOperationResultListener is populated with EndpointKeyHash of an attached endpoint.
    
    Parameters:
    endpointAccessToken - Access token of the attaching endpoint
    resultListener - Listener to notify about result of the endpoint attaching
    See Also:
    EndpointAccessToken, EndpointOperationResultListener
  - detachEndpoint
```
void detachEndpoint(EndpointKeyHash endpointKeyHash,
                  EndpointOperationResultListener resultListener)
```
    Updates with new endpoint detach request
    
    Parameters:
    endpointKeyHash - Key hash of the detaching endpoint
    resultListener - Listener to notify about result of the enpoint attaching
    See Also:
    EndpointKeyHash, EndpointOperationResultListener
  - attachUser
```
void attachUser(String userExternalId,
              String userAccessToken,
              UserAuthResultListener callback)
```
    Creates user attach request
    
    Parameters:
    userExternalId -
    userAccessToken -
    callback - called when authentication result received
    See Also:
    UserAuthResultListener
  - getAttachedEndpointList
```
Map<EndpointAccessToken,EndpointKeyHash> getAttachedEndpointList()
```
    Retrieves list of attached endpoints
    
    Returns:
    list of enpointKeyHash of attached endpoints mapped by their access tokens.
    See Also:
    EndpointAccessToken, EndpointKeyHash
  - addAttachedEndpointListChangeListener
```
void addAttachedEndpointListChangeListener(AttachedEndpointListChangedListener listener)
```
    Updates with listener for attached endpoint list updates
    
    Parameters:
    listener - Attached endpoints list change listener
    See Also:
    AttachedEndpointListChangedListener
  - removeAttachedEndpointListChangeListener
```
void removeAttachedEndpointListChangeListener(AttachedEndpointListChangedListener listener)
```
    Removes listener of attached endpoint list changes
    
    Parameters:
    listener - Attached endpoints list change listener
    See Also:
    AttachedEndpointListChangedListener
  - setUserTransport
```
void setUserTransport(UserTransport transport)
```
    Sets the User transport for the current manager to communicate with remote server.
    
    Parameters:
    transport - the User transport object which is going to be set.
    See Also:
    UserTransport
  - setProfileTransport
```
void setProfileTransport(ProfileTransport transport)
```
    Sets the Profile transport for the current manager to communicate with remote server.
    
    Parameters:
    transport - the Profile transport object which is going to be set.
    See Also:
    ProfileTransport
  - isAttachedToUser
```
boolean isAttachedToUser()
```
    Checks if current endpoint is attached to user.
    
    Returns:
    true if current endpoint is attached to any user, false otherwise.
  - setAttachedListener
```
void setAttachedListener(CurrentEndpointAttachListener listener)
```
    Sets callback for notifications when current endpoint is attached to user
    
    Parameters:
    listener -
    See Also:
    CurrentEndpointAttachListener
  - setDetachedListener
```
void setDetachedListener(CurrentEndpointDetachListener listener)
```
    Sets callback for notifications when current endpoint is detached from user
    
    Parameters:
    listener -
    See Also:
    CurrentEndpointDetachListener

Interface EndpointRegistrationManager

Method Summary

Method Detail

regenerateEndpointAccessToken

getEndpointAccessToken

attachEndpoint

detachEndpoint

attachUser

getAttachedEndpointList

addAttachedEndpointListChangeListener

removeAttachedEndpointListChangeListener

setUserTransport

setProfileTransport

isAttachedToUser

setAttachedListener

setDetachedListener