com.bmc.arsys.pluginsvr.plugins
Class AREAResponse

java.lang.Object
  com.bmc.arsys.pluginsvr.plugins.AREAResponse

public class AREAResponse
extends Object

A simple bean object that encapsulates the return expected for authentication from AREA plugins. It contains the following items:

licenseMask

licenseWrite

Indicates the type of license for a user. Acceptable values are Constants.AR_LICENSE_TYPE_NONE or Constants.AR_LICENSE_TYPE_FLOATING.

licenseFTS

Indicates the type of FTS license for a user. Acceptable values are Constants.AR_LICENSE_TYPE_NONE or Constants.AR_LICENSE_TYPE_FLOATING.

licenseRes1

licenseApps

A semicolon-seperated list of application licenses.

groups

A semicolon-seperated list of group names the user belongs to. If null, the list from the User form is used.

notifyMech

The notification mechanism for this user. Acceptable values are Constants.AR_NOTIFY_NONE, Constants.AR_NOTIFY_VIA_NOTIFIER, Constants.AR_NOTIFY_VIA_EMAIL, or Constants.AR_NOTIFY_VIA_DEFAULT.

email

The email address for the user. If null, the value in the user User form is used.

loginStatus

Indicates the status of the login. Acceptable values are AREA_LOGIN_SUCCESS, AREA_LOGIN_UNKNOWN_USER, AREA_LOGIN_FAILED or AREA_LOGIN_LOCK_OUT.

messageText

A message passed back to the user. If loginStatus was AREA_LOGIN_UNKNOWN_USER, AREA_LOGIN_FAILED or AREA_LOGIN_LOCK_OUT then this displays as an error. If loginStatus was AREA_LOGIN_SUCCESS then this displays as a note.

logText

A log message that is not shown to the user, but logged in the aruser.log file.

modTime

The last time that the user's information changed.

Field Summary

static int	AREA_LOGIN_FAILED Indicates that the user failed to authenticate
static int	AREA_LOGIN_LOCK_OUT Indicates that the user is locked out
static int	AREA_LOGIN_SUCCESS Indicates a successfull login attempt
static int	AREA_LOGIN_UNKNOWN_USER Indicates that the user is not known to the system

Constructor Summary

AREAResponse()
Default constructor

AREAResponse(int mask, int licenseWrite, int licenseFTS, int licenseRes1, String licenseApps, String groups, int notifyMech, String email, int loginStatus, String messageText, String logText, com.bmc.arsys.api.Timestamp modTime)

Method Summary

String	getEmail() Get the email address.
String	getGroups() Get the groups.
String	getLicenseApps() Get the application licenses.
int	getLicenseFTS() Get the FTS license.
int	getLicenseMask() Get the license mask.
int	getLicenseRes1()
int	getLicenseWrite() Get the license.
int	getLoginStatus() Get the login status.
String	getLogText() Get the log text.
String	getMessageText() Get the message text.
com.bmc.arsys.api.Timestamp	getModTime() Get the modified time.
int	getNotifyMech() Get the notification mechanism.
void	setEmail(String email) Set the email address.
void	setGroups(String groups) Set the groups.
void	setLicenseApps(String licenseApps) Set the application licenses.
void	setLicenseFTS(int licenseFTS) Set the FTS license.
void	setLicenseMask(int mask) Set the license mask.
void	setLicenseRes1(int licenseRes1)
void	setLicenseWrite(int licenseWrite) Set the license.
void	setLoginStatus(int loginStatus) Set the login status.
void	setLogText(String logText) Set the log text.
void	setMessageText(String messageText) Set the message text.
void	setModTime(com.bmc.arsys.api.Timestamp modTime) Set the modified time.
void	setNotifyMech(int notifyMech) Set the notification mechanism.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AREA_LOGIN_SUCCESS

public static final int AREA_LOGIN_SUCCESS

Indicates a successfull login attempt

See Also:

Constant Field Values

AREA_LOGIN_UNKNOWN_USER

public static final int AREA_LOGIN_UNKNOWN_USER

Indicates that the user is not known to the system

See Also:

Constant Field Values

AREA_LOGIN_FAILED

public static final int AREA_LOGIN_FAILED

Indicates that the user failed to authenticate

See Also:

Constant Field Values

AREA_LOGIN_LOCK_OUT

public static final int AREA_LOGIN_LOCK_OUT

Indicates that the user is locked out

See Also:

Constant Field Values

Constructor Detail

AREAResponse

public AREAResponse()

Default constructor

AREAResponse

public AREAResponse(int mask,
                    int licenseWrite,
                    int licenseFTS,
                    int licenseRes1,
                    String licenseApps,
                    String groups,
                    int notifyMech,
                    String email,
                    int loginStatus,
                    String messageText,
                    String logText,
                    com.bmc.arsys.api.Timestamp modTime)

Parameters:

mask -

licenseWrite - the type of license

licenseFTS - the type of FTS license

licenseRes1 -

licenseApps - the application licenses the user has

groups - the groups the user belongs to

notifyMech - the notification mechanism

email - the email address for the user

loginStatus - the status of the login

messageText - the message presented to the user

logText - the message logged to aruser.log

modTime - the last time the user's information changed

Method Detail

getLicenseMask

public int getLicenseMask()

Get the license mask.

Returns:

the licenseMask

setLicenseMask

public void setLicenseMask(int mask)

Set the license mask.

Parameters:

mask - to set

getEmail

public String getEmail()

Get the email address.

Returns:

the email

setEmail

public void setEmail(String email)

Set the email address.

Parameters:

email - the email to set

getGroups

public String getGroups()

Get the groups.

Returns:

the groups

setGroups

public void setGroups(String groups)

Set the groups.

Parameters:

groups - the groups to set

getLicenseApps

public String getLicenseApps()

Get the application licenses.

Returns:

the licenseApps

setLicenseApps

public void setLicenseApps(String licenseApps)

Set the application licenses.

Parameters:

licenseApps - the licenseApps to set

getLicenseFTS

public int getLicenseFTS()

Get the FTS license.

Returns:

the licenseFTS

setLicenseFTS

public void setLicenseFTS(int licenseFTS)

Set the FTS license.

Parameters:

licenseFTS - the licenseFTS to set

getLicenseRes1

public int getLicenseRes1()

Returns:

the licenseRes1

setLicenseRes1

public void setLicenseRes1(int licenseRes1)

Parameters:

licenseRes1 - the licenseRes1 to set

getLicenseWrite

public int getLicenseWrite()

Get the license.

Returns:

the licenseWrite

setLicenseWrite

public void setLicenseWrite(int licenseWrite)

Set the license.

Parameters:

licenseWrite - the licenseWrite to set

getLoginStatus

public int getLoginStatus()

Get the login status.

Returns:

the loginStatus

setLoginStatus

public void setLoginStatus(int loginStatus)

Set the login status.

Parameters:

loginStatus - the loginStatus to set

getLogText

public String getLogText()

Get the log text.

Returns:

the logText

setLogText

public void setLogText(String logText)

Set the log text.

Parameters:

logText - the logText to set

getMessageText

public String getMessageText()

Get the message text.

Returns:

the messageText

setMessageText

public void setMessageText(String messageText)

Set the message text.

Parameters:

messageText - the messageText to set

getModTime

public com.bmc.arsys.api.Timestamp getModTime()

Get the modified time.

Returns:

the modTime

setModTime

public void setModTime(com.bmc.arsys.api.Timestamp modTime)

Set the modified time.

Parameters:

modTime - the modTime to set

getNotifyMech

public int getNotifyMech()

Get the notification mechanism.

Returns:

the notifyMech

setNotifyMech

public void setNotifyMech(int notifyMech)

Set the notification mechanism.

Parameters:

notifyMech - the notifyMech to set