com.crystaldecisions.sdk.occa.security
Interface IEnterpriseLogonInformation

public interface IEnterpriseLogonInformation

IEnterpriseLogonInformation is an object that store extra logon information.

Method Summary

java.lang.String	getClientType() Returns the client type set in the IEnterpriseLogonInformation object.
java.lang.String	getReportedHostname() Returns the reported hostname set in the IEnterpriseLogonInformation object.
java.lang.String	getReportedIP() Returns the reported IP set in the IEnterpriseLogonInformation object.
java.lang.String	getResolvedHostname() Returns the resolved hostname set in the IEnterpriseLogonInformation object.
java.lang.String	getResolvedIP() Returns the resolved IP set in the IEnterpriseLogonInformation object.
void	setClientType(java.lang.String clientType) Sets the client type for the logon.
void	setReportedHostname(java.lang.String hostname) Changes the reported hostname.
void	setReportedIP(java.lang.String ip) Changes the reported IP.
void	setResolvedHostname(java.lang.String hostname) Changes the resolved hostname.
void	setResolvedIP(java.lang.String ip) Changes the resolved IP.

Method Detail

setReportedIP

void setReportedIP(java.lang.String ip)

Changes the reported IP.
This is the IP as reported by the client.
Once set and Logon using ISessionMgr object logonEx or logonWithTokenEx,
if auditing is enabled, the BIP shall generate LOGIN auditing event.

Parameters:

reported - IP of the client making the logon.

setReportedHostname

void setReportedHostname(java.lang.String hostname)

Changes the reported hostname. This is the hostname as reported by client
Once set and Logon using ISessionMgr object logonEx or logonWithTokenEx,
if auditing is enabled, the BIP shall generate LOGIN auditing event.

Parameters:

reported - hostname of the client making the logon.

setResolvedIP

void setResolvedIP(java.lang.String ip)

Changes the resolved IP.
This is the IP resolved by client.
eg. In 3 tier case, eg. web application, in this case reported IP will be empty, but resolved IP shall be correct address of the browser unless proxy is used between browser and app server - in that case proxy IP address will be resolved.
Once set and Logon using ISessionMgr object logonEx or logonWithTokenEx,
if auditing is enabled, the BIP shall generate LOGIN auditing event.

Parameters:

resolved - IP of the client making the logon.

setResolvedHostname

void setResolvedHostname(java.lang.String hostname)

Changes the resolved hostname. This is the IP resolved by client.
eg. In 3 tier case, eg. web application, in this case reported IP will be empty, but resolved IP shall be correct address of the browser unless proxy is used between browser and app server - in that case proxy IP address will be resolved. Once set and Logon using ISessionMgr object logonEx or logonWithTokenEx,
if auditing is enabled, the BIP shall generate LOGIN auditing event.

Parameters:

resolved - hostname of the client making the logon.

getReportedIP

java.lang.String getReportedIP()
                               throws SDKException

Returns the reported IP set in the IEnterpriseLogonInformation object.

Returns:

A string specifying the reported IP.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getReportedHostname

java.lang.String getReportedHostname()
                                     throws SDKException

Returns the reported hostname set in the IEnterpriseLogonInformation object.

Returns:

A string specifying the reported hostname.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getResolvedIP

java.lang.String getResolvedIP()
                               throws SDKException

Returns the resolved IP set in the IEnterpriseLogonInformation object.

Returns:

A string specifying the resolved IP.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getResolvedHostname

java.lang.String getResolvedHostname()
                                     throws SDKException

Returns the resolved hostname set in the IEnterpriseLogonInformation object.

Returns:

A string specifying the resolved hostname.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getClientType

java.lang.String getClientType()
                               throws SDKException

Returns the client type set in the IEnterpriseLogonInformation object.

Returns:

A string specifying the client type.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setClientType

void setClientType(java.lang.String clientType)

Sets the client type for the logon.

Parameters:

clientType - client type for the logon