Package co.ecg.alpaca.toolkit.generated

Class Login.LoginRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Login.LoginRequest

Enclosing class:

Login

public static class Login.LoginRequest
extends Request<Login.LoginResponse>

Request to login to OCI. password is not required for external authentication login from a trusted host (ACL). The following data element is only used in XS data mode and will be ignored in AS data mode: signedPassword, ignored in AS data mode unless the password element is not present then an error is returned.

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=60) String	password
protected @Size(min=1) String	signedPassword
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
LoginRequest()
LoginRequest(BroadWorksServer broadWorksServer, String userId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Login.LoginRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getPassword()
String	getSignedPassword()
String	getUserId()
Login.LoginRequest	setPassword(String password)
Login.LoginRequest	setSignedPassword(String signedPassword)
Login.LoginRequest	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=60)
protected @Size(min=1,max=60) String password

signedPassword

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

Constructor Details

LoginRequest

public LoginRequest()

LoginRequest

public LoginRequest(BroadWorksServer broadWorksServer,
 String userId)

Method Details

setUserId

public Login.LoginRequest setUserId(String userId)

getUserId

public String getUserId()

setPassword

public Login.LoginRequest setPassword(String password)

getPassword

public String getPassword()

setSignedPassword

public Login.LoginRequest setSignedPassword(String signedPassword)

getSignedPassword

public String getSignedPassword()

getEmptyObject

public static Login.LoginRequest 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.LoginResponse>