com.exalead.mercury.mami.master.v10

Class AuthenticateUserWithConfig

java.lang.Object

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

com.exalead.mercury.mami.master.v10.AuthenticateUserWithConfig

All Implemented Interfaces:

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

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

Operations
Authenticates a user with a specific config for a given source.

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	classId
java.util.List<KeyValue>	keyValue

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
AuthenticateUserWithConfig()
AuthenticateUserWithConfig(AuthenticateUserWithConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AuthenticateUserWithConfig.
static AuthenticateUserWithConfig	fromString(java.lang.String s) String representation of this AuthenticateUserWithConfig.
java.lang.String	getClassId() The source class on which the user should be identified.
java.util.List<KeyValue>	getKeyValue()
AuthenticateUserWithConfig	makeCopy() Creates and returns a deep copy of this AuthenticateUserWithConfig.
static AuthenticateUserWithConfig	readFrom(java.io.InputStream is) Read this AuthenticateUserWithConfig from an XML fragment.
void	setClassId(java.lang.String classId) The source class on which the user should be identified.
java.lang.String	toString() String representation of this AuthenticateUserWithConfig.
AuthenticateUserWithConfig	withCheckUserPassword(boolean checkUserPassword)
AuthenticateUserWithConfig	withCheckUserPassword(java.lang.Boolean checkUserPassword)
AuthenticateUserWithConfig	withClassId(java.lang.String classId)
AuthenticateUserWithConfig	withKeyValue(java.util.Collection<KeyValue> __values)
AuthenticateUserWithConfig	withKeyValue(KeyValue... __values)
AuthenticateUserWithConfig	withOptParams(java.util.Collection<KeyValue> __values)
AuthenticateUserWithConfig	withOptParams(KeyValue... __values)
AuthenticateUserWithConfig	withUserLogin(java.lang.String userLogin)
AuthenticateUserWithConfig	withUserPassword(java.lang.String userPassword)
void	writeTo(java.io.OutputStream os) Write this AuthenticateUserWithConfig 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

classId

public java.lang.String classId

keyValue

public java.util.List<KeyValue> keyValue

Constructor Detail

AuthenticateUserWithConfig

public AuthenticateUserWithConfig()

AuthenticateUserWithConfig

public AuthenticateUserWithConfig(AuthenticateUserWithConfig o)

Copy constructor

Method Detail

withUserLogin

public AuthenticateUserWithConfig withUserLogin(java.lang.String userLogin)

Overrides:

withUserLogin in class AuthenticateUserParams

withUserPassword

public AuthenticateUserWithConfig withUserPassword(java.lang.String userPassword)

Overrides:

withUserPassword in class AuthenticateUserParams

withCheckUserPassword

public AuthenticateUserWithConfig withCheckUserPassword(boolean checkUserPassword)

Overrides:

withCheckUserPassword in class AuthenticateUserParams

withCheckUserPassword

public AuthenticateUserWithConfig withCheckUserPassword(java.lang.Boolean checkUserPassword)

Overrides:

withCheckUserPassword in class AuthenticateUserParams

withOptParams

public AuthenticateUserWithConfig withOptParams(KeyValue... __values)

Overrides:

withOptParams in class AuthenticateUserParams

withOptParams

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

Overrides:

withOptParams in class AuthenticateUserParams

setClassId

public void setClassId(java.lang.String classId)

The source class on which the user should be identified.

getClassId

public java.lang.String getClassId()

The source class on which the user should be identified.

withClassId

public AuthenticateUserWithConfig withClassId(java.lang.String classId)

getKeyValue

public java.util.List<KeyValue> getKeyValue()

withKeyValue

public AuthenticateUserWithConfig withKeyValue(KeyValue... __values)

withKeyValue

public AuthenticateUserWithConfig withKeyValue(java.util.Collection<KeyValue> __values)

makeCopy

public AuthenticateUserWithConfig makeCopy()

Creates and returns a deep copy of this AuthenticateUserWithConfig.

Overrides:

makeCopy in class AuthenticateUserParams

readFrom

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

Read this AuthenticateUserWithConfig 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 AuthenticateUserWithConfig as an XML fragment

Overrides:

writeTo in class AuthenticateUserParams

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AuthenticateUserWithConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AuthenticateUserWithConfig.

Overrides:

toString in class AuthenticateUserParams

check

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

Checks this AuthenticateUserWithConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class AuthenticateUserParams

Throws:

com.exalead.util.TypedException