com.exalead.mercury.mami.master.v10

Class AuthenticateUserParams

java.lang.Object

com.exalead.mercury.mami.master.v10.AuthenticateUserParams

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

Direct Known Subclasses:

AuthenticateUser, AuthenticateUserWithConfig

public abstract class AuthenticateUserParams
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthenticateUserParams.OptParams

Field Summary

Fields

Modifier and Type	Field and Description
boolean	checkUserPassword
static boolean	DEFAULT_CHECK_USER_PASSWORD
protected AuthenticateUserParams.OptParams	optParams
java.lang.String	userLogin
java.lang.String	userPassword

Constructor Summary

Constructors

Constructor and Description
AuthenticateUserParams()
AuthenticateUserParams(AuthenticateUserParams o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AuthenticateUserParams.
static AuthenticateUserParams	fromString(java.lang.String s) String representation of this AuthenticateUserParams.
AuthenticateUserParams.OptParams	getOptParams()
java.lang.String	getUserLogin() User name
java.lang.String	getUserPassword() User password
boolean	isCheckUserPassword() Should the user password be checked?
AuthenticateUserParams	makeCopy()
static AuthenticateUserParams	readFrom(java.io.InputStream is) Read this AuthenticateUserParams from an XML fragment.
void	setCheckUserPassword(boolean checkUserPassword) Should the user password be checked?
void	setOptParams(AuthenticateUserParams.OptParams __value)
void	setUserLogin(java.lang.String userLogin) User name
void	setUserPassword(java.lang.String userPassword) User password
java.lang.String	toString() String representation of this AuthenticateUserParams.
AuthenticateUserParams	withCheckUserPassword(boolean checkUserPassword)
AuthenticateUserParams	withCheckUserPassword(java.lang.Boolean checkUserPassword)
AuthenticateUserParams	withOptParams(AuthenticateUserParams.OptParams __value)
AuthenticateUserParams	withOptParams(java.util.Collection<KeyValue> __values)
AuthenticateUserParams	withOptParams(KeyValue... __values)
AuthenticateUserParams	withUserLogin(java.lang.String userLogin)
AuthenticateUserParams	withUserPassword(java.lang.String userPassword)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

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

Field Detail

userLogin

public java.lang.String userLogin

userPassword

public java.lang.String userPassword

checkUserPassword

public boolean checkUserPassword

DEFAULT_CHECK_USER_PASSWORD

public static final boolean DEFAULT_CHECK_USER_PASSWORD

See Also:

Constant Field Values

optParams

protected AuthenticateUserParams.OptParams optParams

Constructor Detail

AuthenticateUserParams

public AuthenticateUserParams()

AuthenticateUserParams

public AuthenticateUserParams(AuthenticateUserParams o)

Copy constructor

Method Detail

setUserLogin

public void setUserLogin(java.lang.String userLogin)

User name

getUserLogin

public java.lang.String getUserLogin()

User name

withUserLogin

public AuthenticateUserParams withUserLogin(java.lang.String userLogin)

setUserPassword

public void setUserPassword(java.lang.String userPassword)

User password

getUserPassword

public java.lang.String getUserPassword()

User password

withUserPassword

public AuthenticateUserParams withUserPassword(java.lang.String userPassword)

setCheckUserPassword

public void setCheckUserPassword(boolean checkUserPassword)

Should the user password be checked?

isCheckUserPassword

public boolean isCheckUserPassword()

Should the user password be checked?

withCheckUserPassword

public AuthenticateUserParams withCheckUserPassword(boolean checkUserPassword)

withCheckUserPassword

public AuthenticateUserParams withCheckUserPassword(java.lang.Boolean checkUserPassword)

getOptParams

public AuthenticateUserParams.OptParams getOptParams()

setOptParams

public void setOptParams(AuthenticateUserParams.OptParams __value)

withOptParams

public AuthenticateUserParams withOptParams(KeyValue... __values)

withOptParams

public AuthenticateUserParams withOptParams(java.util.Collection<KeyValue> __values)

withOptParams

public AuthenticateUserParams withOptParams(AuthenticateUserParams.OptParams __value)

makeCopy

public AuthenticateUserParams makeCopy()

readFrom

public static AuthenticateUserParams readFrom(java.io.InputStream is)
                                       throws javax.xml.bind.JAXBException

Read this AuthenticateUserParams from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static AuthenticateUserParams fromString(java.lang.String s)
                                         throws javax.xml.bind.JAXBException,
                                                java.io.UnsupportedEncodingException

String representation of this AuthenticateUserParams.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AuthenticateUserParams.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this AuthenticateUserParams.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException