Package co.ecg.alpaca.toolkit.generated

Class Login.AuthenticationVerifyRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<Login.AuthenticationVerifyResponse>

co.ecg.alpaca.toolkit.generated.Login.AuthenticationVerifyRequest

Enclosing class:

Login

@ChoiceGroup({"userId","password"}) @ChoiceGroup({"phoneNumber","passcode"}) @ChoiceGroup({"linePort","password"}) @ChoiceGroup("loginToken") @ChoiceGroup({"sipAuthenticationUserName","sipAuthenticationPassword","userId"})
public static class Login.AuthenticationVerifyRequest
extends Request<Login.AuthenticationVerifyResponse>

AuthenticationVerifyRequest22 is used to authenticate a user either by userId/password, userId/sip username/sip password, dn/passcode, lineport/password or a token previously authorized with the ExternalAuthenticationAuthorizeTokenRequest. The phone number may be any DN associated with a user. The lineport may be any lineport associated with a user. The password used for the lineport is the user’s password associated with userId. The response is a AuthenticationVerifyResponse22 or an ErrorResponse

Author:

AlpacaGenerator

Nested Class Summary

Nested classes/interfaces inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

Request.Protocol

Field Summary

Fields

Modifier and Type	Field	Description
protected @Size(min=1,max=161) String	linePort
protected @Size(min=1) String	loginToken
protected @Size(min=1,max=30) String	passcode
protected @Size(min=1,max=60) String	password
protected @Size(min=1,max=23) String	phoneNumber
protected @Size(min=1,max=60) String	sipAuthenticationPassword
protected @Size(min=1,max=80) String	sipAuthenticationUserName
protected @Size(min=1,max=161) String	userId

Fields inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

log

Constructor Summary

Constructors

Constructor	Description
AuthenticationVerifyRequest()
AuthenticationVerifyRequest(BroadWorksServer broadWorksServer)
AuthenticationVerifyRequest(BroadWorksServer broadWorksServer, String loginToken)
AuthenticationVerifyRequest(BroadWorksServer broadWorksServer, String userId, String password)
AuthenticationVerifyRequest(BroadWorksServer broadWorksServer, String sipAuthenticationUserName, String sipAuthenticationPassword, String userId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getLinePort()
String	getLoginToken()
String	getPasscode()
String	getPassword()
String	getPhoneNumber()
String	getSipAuthenticationPassword()
String	getSipAuthenticationUserName()
String	getUserId()
Login.AuthenticationVerifyRequest	setLinePort(String linePort)
Login.AuthenticationVerifyRequest	setLoginToken(String loginToken)
Login.AuthenticationVerifyRequest	setPasscode(String passcode)
Login.AuthenticationVerifyRequest	setPassword(String password)
Login.AuthenticationVerifyRequest	setPhoneNumber(String phoneNumber)
Login.AuthenticationVerifyRequest	setSipAuthenticationPassword(String sipAuthenticationPassword)
Login.AuthenticationVerifyRequest	setSipAuthenticationUserName(String sipAuthenticationUserName)
Login.AuthenticationVerifyRequest	setUserId(String userId)

Methods inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createNilElement, createTextElement, equals, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRetries, getRetryCodes, getRootElement, getValidationErrorsAsString, hashCode, isIgnoreCache, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setIgnoreCache, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRetries, setRetryCodes, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

userId

@Size(min=1,
      max=161)
protected @Size(min=1,max=161) String userId

password

@Size(min=1,
      max=60)
protected @Size(min=1,max=60) String password

phoneNumber

@Size(min=1,
      max=23)
protected @Size(min=1,max=23) String phoneNumber

passcode

@Size(min=1,
      max=30)
protected @Size(min=1,max=30) String passcode

linePort

@Pattern(regexp="[a-zA-Z0-9._!~*\'()+-]+[@]{0,1}[a-zA-Z0-9.-]+")
@Size(min=1,
      max=161)
protected @Size(min=1,max=161) String linePort

loginToken

@Size(min=1)
protected @Size(min=1) String loginToken

sipAuthenticationUserName

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String sipAuthenticationUserName

sipAuthenticationPassword

@Size(min=1,
      max=60)
protected @Size(min=1,max=60) String sipAuthenticationPassword

Constructor Details

AuthenticationVerifyRequest

public AuthenticationVerifyRequest()

AuthenticationVerifyRequest

public AuthenticationVerifyRequest(BroadWorksServer broadWorksServer)

AuthenticationVerifyRequest

public AuthenticationVerifyRequest(BroadWorksServer broadWorksServer,
 String userId,
 String password)

AuthenticationVerifyRequest

public AuthenticationVerifyRequest(BroadWorksServer broadWorksServer,
 String loginToken)

AuthenticationVerifyRequest

public AuthenticationVerifyRequest(BroadWorksServer broadWorksServer,
 String sipAuthenticationUserName,
 String sipAuthenticationPassword,
 String userId)

Method Details

setUserId

public Login.AuthenticationVerifyRequest setUserId(String userId)

getUserId

public String getUserId()

setPassword

public Login.AuthenticationVerifyRequest setPassword(String password)

getPassword

public String getPassword()

setPhoneNumber

public Login.AuthenticationVerifyRequest setPhoneNumber(String phoneNumber)

getPhoneNumber

public String getPhoneNumber()

setPasscode

public Login.AuthenticationVerifyRequest setPasscode(String passcode)

getPasscode

public String getPasscode()

setLinePort

public Login.AuthenticationVerifyRequest setLinePort(String linePort)

getLinePort

public String getLinePort()

setLoginToken

public Login.AuthenticationVerifyRequest setLoginToken(String loginToken)

getLoginToken

public String getLoginToken()

setSipAuthenticationUserName

public Login.AuthenticationVerifyRequest setSipAuthenticationUserName(String sipAuthenticationUserName)

getSipAuthenticationUserName

public String getSipAuthenticationUserName()

setSipAuthenticationPassword

public Login.AuthenticationVerifyRequest setSipAuthenticationPassword(String sipAuthenticationPassword)

getSipAuthenticationPassword

public String getSipAuthenticationPassword()

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<Login.AuthenticationVerifyResponse>