Package velox.api.layer1.messages

Class Layer1ApiAdditionalLoginDataMessage

java.lang.Object

velox.api.layer1.messages.Layer1ApiAdditionalLoginDataMessage

All Implemented Interfaces:

Layer1ApiIgnorableDownwardMessage, UserProviderTargetedMessage

public class Layer1ApiAdditionalLoginDataMessage
extends Object
implements UserProviderTargetedMessage

Is received by providers when sending additional login data through Layer1ApiAdminProvider.sendUserMessage(Object). Can be received as response on Layer1ApiAdditionalLoginDataRequestMessage from the provider or independently. Provider should not perform and cancel additional login if the message was sent in response to Layer1ApiAdditionalLoginDataRequestMessage AND has cancelAdditionalLoginRequest with the value true. Provider should perform additional login and send a Layer1ApiAdditionalLoginDataMessage.Callback using Layer1ApiAdminListener.onUserMessage(Object) as a response to this message if cancelAdditionalLoginRequest is false. The message can be ignored if the provider doesn't support additional login. Also, the provider may enable some features after receiving this message in the case of successful login.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Layer1ApiAdditionalLoginDataMessage.Callback
static final class	Layer1ApiAdditionalLoginDataMessage.LoginFailedCallback
static final class	Layer1ApiAdditionalLoginDataMessage.LoginSuccessfulCallback

Field Summary

Fields

Modifier and Type	Field	Description
boolean	cancelAdditionalLoginRequest
final Map<String,CredentialsSerializationField>	extendedLoginData
final String	providerType

Constructor Summary

Constructors

Constructor	Description
Layer1ApiAdditionalLoginDataMessage(Map<String,CredentialsSerializationField> extendedLoginData, String providerType, boolean cancelAdditionalLoginRequest)

Method Summary

Modifier and Type	Method	Description
String	getProviderProgrammaticName()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

extendedLoginData

public final Map<String,CredentialsSerializationField> extendedLoginData

providerType

public final String providerType

cancelAdditionalLoginRequest

public boolean cancelAdditionalLoginRequest

Constructor Details

Layer1ApiAdditionalLoginDataMessage

public Layer1ApiAdditionalLoginDataMessage(Map<String,CredentialsSerializationField> extendedLoginData,
 String providerType,
 boolean cancelAdditionalLoginRequest)

Parameters:

extendedLoginData - a map <String, CredentialsSerializationField> of additional extended login data.

cancelAdditionalLoginRequest - if is true, additional login request asked by Layer1ApiAdditionalLoginDataRequestMessage was rejected, no additional login should be performed. If this value is true, no Layer1ApiAdditionalLoginDataMessage.Callback is expected in return

Method Details

getProviderProgrammaticName

public String getProviderProgrammaticName()

Specified by:

getProviderProgrammaticName in interface UserProviderTargetedMessage

toString

public String toString()

Overrides:

toString in class Object