com.exalead.mercury.mami.master.v10

Class AuthenticateUser

java.lang.Object

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

com.exalead.mercury.mami.master.v10.AuthenticateUser

All Implemented Interfaces:

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

public class AuthenticateUser
extends AuthenticateUserParams
implements com.exalead.util.Checkable, java.io.Serializable

Operations
Authenticates a user.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.master.v10.AuthenticateUserParams

AuthenticateUserParams.OptParams

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	securitySourceName

Fields inherited from class com.exalead.mercury.mami.master.v10.AuthenticateUserParams

checkUserPassword, DEFAULT_CHECK_USER_PASSWORD, optParams, userLogin, userPassword

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AuthenticateUser.
static AuthenticateUser	fromString(java.lang.String s) String representation of this AuthenticateUser.
java.lang.String	getSecuritySourceName() The security source on which the user should be identified.
AuthenticateUser	makeCopy() Creates and returns a deep copy of this AuthenticateUser.
static AuthenticateUser	readFrom(java.io.InputStream is) Read this AuthenticateUser from an XML fragment.
void	setSecuritySourceName(java.lang.String securitySourceName) The security source on which the user should be identified.
java.lang.String	toString() String representation of this AuthenticateUser.
AuthenticateUser	withCheckUserPassword(boolean checkUserPassword)
AuthenticateUser	withCheckUserPassword(java.lang.Boolean checkUserPassword)
AuthenticateUser	withOptParams(java.util.Collection<KeyValue> __values)
AuthenticateUser	withOptParams(KeyValue... __values)
AuthenticateUser	withSecuritySourceName(java.lang.String securitySourceName)
AuthenticateUser	withUserLogin(java.lang.String userLogin)
AuthenticateUser	withUserPassword(java.lang.String userPassword)
void	writeTo(java.io.OutputStream os) Write this AuthenticateUser as an XML fragment

Methods inherited from class com.exalead.mercury.mami.master.v10.AuthenticateUserParams

getOptParams, getUserLogin, getUserPassword, isCheckUserPassword, setCheckUserPassword, setOptParams, setUserLogin, setUserPassword, withOptParams

Methods inherited from class java.lang.Object

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

Field Detail

securitySourceName

public java.lang.String securitySourceName

Constructor Detail

AuthenticateUser

public AuthenticateUser()

AuthenticateUser

public AuthenticateUser(AuthenticateUser o)

Copy constructor

Method Detail

withUserLogin

public AuthenticateUser withUserLogin(java.lang.String userLogin)

Overrides:

withUserLogin in class AuthenticateUserParams

withUserPassword

public AuthenticateUser withUserPassword(java.lang.String userPassword)

Overrides:

withUserPassword in class AuthenticateUserParams

withCheckUserPassword

public AuthenticateUser withCheckUserPassword(boolean checkUserPassword)

Overrides:

withCheckUserPassword in class AuthenticateUserParams

withCheckUserPassword

public AuthenticateUser withCheckUserPassword(java.lang.Boolean checkUserPassword)

Overrides:

withCheckUserPassword in class AuthenticateUserParams

withOptParams

public AuthenticateUser withOptParams(KeyValue... __values)

Overrides:

withOptParams in class AuthenticateUserParams

withOptParams

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

Overrides:

withOptParams in class AuthenticateUserParams

setSecuritySourceName

public void setSecuritySourceName(java.lang.String securitySourceName)

The security source on which the user should be identified.

getSecuritySourceName

public java.lang.String getSecuritySourceName()

The security source on which the user should be identified.

withSecuritySourceName

public AuthenticateUser withSecuritySourceName(java.lang.String securitySourceName)

makeCopy

public AuthenticateUser makeCopy()

Creates and returns a deep copy of this AuthenticateUser.

Overrides:

makeCopy in class AuthenticateUserParams

readFrom

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

Read this AuthenticateUser 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

Write this AuthenticateUser as an XML fragment

Overrides:

writeTo in class AuthenticateUserParams

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AuthenticateUser.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AuthenticateUser.

Overrides:

toString in class AuthenticateUserParams

check

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

Checks this AuthenticateUser.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class AuthenticateUserParams

Throws:

com.exalead.util.TypedException