ibi.broker.api.data
Class Authenticate

java.lang.Object
  ibi.broker.api.data.Authenticate

All Implemented Interfaces:

java.io.Serializable

public class Authenticate
extends java.lang.Object
implements java.io.Serializable

This class is for use with the ReportCaster Web Services API and stateless applications. On first use it accepts a user name and password. Upon authentication the server generates a security token and sets it into this object. This token is similar to a cookie, enabling programmers re-authenticate in stateless applications without having to pass user names and passwords. It also allows the development of single sign-on techniques. In general, subsequent authentications, after the user name and passwords are accepted, should use the security token. This class is used in conjunction with LogonManagerIF which, when returned to the calling program from the server, will contain the security token that can be passed into the Authenticate object.

Version:

5.3

See Also:

LogonManagerIF, Serialized Form

Constructor Summary

Authenticate()

Method Summary

java.lang.String	getPassword() Returns the password associated with this authenticate object.
java.lang.String	getSecurityToken() Returns the security token associated with this authenticate object.
java.lang.String	getUser() Returns the user name associated with this authenticate object.
void	setPassword(java.lang.String password) Accepts the password necessary to authenticate.
void	setSecurityToken(java.lang.String securityToken) Sets the security token associated with this authenticate object.
void	setUser(java.lang.String user) Accepts the user name needed to authenticate

Methods inherited from class java.lang.Object

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

Constructor Detail

Authenticate

public Authenticate()

Method Detail

getSecurityToken

public java.lang.String getSecurityToken()

Returns the security token associated with this authenticate object. After a user authenticates via a name and password, the server generates a security token and sets it into this object. This token is similar to a cookie, enabling programmers re-authenticate in stateless applications without having to pass user names and passwords. It also allows the development single sign-on techniques.

Returns:

The security token associated with this Authenticate instance as a String.

setSecurityToken

public void setSecurityToken(java.lang.String securityToken)

Sets the security token associated with this authenticate object. After a user authenticates via a name and password, the server generates a security token and sets it into this object. This token is similar to a cookie, enabling programmers re-authenticate in stateless applications without having to pass user names and passwords. It also allows the development single sign-on techniques.

Parameters:

securityToken - The security token associate with this authenticate object as a String.

See Also:

Authenticate

getUser

public java.lang.String getUser()

Returns the user name associated with this authenticate object.

Returns:

The user associated with this authenticate object, as a String.

setUser

public void setUser(java.lang.String user)

Accepts the user name needed to authenticate

Parameters:

user - The user associated with this authenticate object, as a String.

getPassword

public java.lang.String getPassword()

Returns the password associated with this authenticate object.

Returns:

The password associated with this authenticate object, as a String.

setPassword

public void setPassword(java.lang.String password)

Accepts the password necessary to authenticate.

Parameters:

password - The password associated with this authenticate object, as a String.