Package co.ecg.alpaca.toolkit.generated

Class Login.ExternalAuthenticationCreateLoginTokenRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Login.ExternalAuthenticationCreateLoginTokenRequest

Enclosing class:

Login

public static class Login.ExternalAuthenticationCreateLoginTokenRequest
extends Request<Login.ExternalAuthenticationCreateLoginTokenResponse>

This command allows a BroadWorks or Third-Party Client Application to create a Single Sign-On token for a user. The response is either ExternalAuthenticationCreateLoginTokenResponse 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 @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
ExternalAuthenticationCreateLoginTokenRequest()
ExternalAuthenticationCreateLoginTokenRequest(BroadWorksServer broadWorksServer, String userId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Login.ExternalAuthenticationCreateLoginTokenRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getUserId()
Login.ExternalAuthenticationCreateLoginTokenRequest	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

Constructor Details

ExternalAuthenticationCreateLoginTokenRequest

public ExternalAuthenticationCreateLoginTokenRequest()

ExternalAuthenticationCreateLoginTokenRequest

public ExternalAuthenticationCreateLoginTokenRequest(BroadWorksServer broadWorksServer,
 String userId)

Method Details

setUserId

public Login.ExternalAuthenticationCreateLoginTokenRequest setUserId(String userId)

getUserId

public String getUserId()

getEmptyObject

public static Login.ExternalAuthenticationCreateLoginTokenRequest 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<Login.ExternalAuthenticationCreateLoginTokenResponse>