Package co.ecg.alpaca.toolkit.generated

Class Login.ExternalAuthenticationAuthorizeTokenRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

co.ecg.alpaca.toolkit.generated.Login.ExternalAuthenticationAuthorizeTokenRequest

Enclosing class:

Login

public static class Login.ExternalAuthenticationAuthorizeTokenRequest
extends Request<DefaultResponse>

This command is part of the Portal API. Sent when a Web or CLI user logs in using external authentication. The hashed password value in the request is supported only when the request is sent from the CommPilot web portal. The response is either SuccessResponse or 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 Boolean	isPasswordHashed
protected @NotNull @Size(min=1) String	loginToken
protected @Size(min=1,max=256) String	password
protected @NotNull @Size(min=1,max=161) String	userId

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

log

Constructor Summary

Constructors

Constructor	Description
ExternalAuthenticationAuthorizeTokenRequest()
ExternalAuthenticationAuthorizeTokenRequest(BroadWorksServer broadWorksServer, String userId, String loginToken)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Login.ExternalAuthenticationAuthorizeTokenRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getIsPasswordHashed()
String	getLoginToken()
String	getPassword()
String	getUserId()
Login.ExternalAuthenticationAuthorizeTokenRequest	setIsPasswordHashed(Boolean isPasswordHashed)
Login.ExternalAuthenticationAuthorizeTokenRequest	setLoginToken(String loginToken)
Login.ExternalAuthenticationAuthorizeTokenRequest	setPassword(String password)
Login.ExternalAuthenticationAuthorizeTokenRequest	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

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

password

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

isPasswordHashed

protected Boolean isPasswordHashed

loginToken

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

Constructor Details

ExternalAuthenticationAuthorizeTokenRequest

public ExternalAuthenticationAuthorizeTokenRequest()

ExternalAuthenticationAuthorizeTokenRequest

public ExternalAuthenticationAuthorizeTokenRequest(BroadWorksServer broadWorksServer,
 String userId,
 String loginToken)

Method Details

setUserId

public Login.ExternalAuthenticationAuthorizeTokenRequest setUserId(String userId)

getUserId

public String getUserId()

setPassword

public Login.ExternalAuthenticationAuthorizeTokenRequest setPassword(String password)

getPassword

public String getPassword()

setIsPasswordHashed

public Login.ExternalAuthenticationAuthorizeTokenRequest setIsPasswordHashed(Boolean isPasswordHashed)

getIsPasswordHashed

public Boolean getIsPasswordHashed()

setLoginToken

public Login.ExternalAuthenticationAuthorizeTokenRequest setLoginToken(String loginToken)

getLoginToken

public String getLoginToken()

getEmptyObject

public static Login.ExternalAuthenticationAuthorizeTokenRequest getEmptyObject(BroadWorksServer broadWorksServer)

Retrieves this object with minimal setup.

Parameters:

broadWorksServer - The BroadWorksServer

formRequest

public void formRequest()

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

Overrides:

formRequest in class Request<DefaultResponse>