com.businessobjects.dsws.session
Interface EnterpriseCredential

All Superinterfaces:

Credential

public interface EnterpriseCredential
extends Credential

The EnterpriseCredential interface is used to pass Enterprise Authentication to the BusinessObjects server using the Session.Login function.

Example:

URL boConURL = new URL("http://boserver:port/dswsbobje/services/Session");
com.businessobjects.dsws.Connection boConnection = new Connection(boConURL);
EnterpriseCredential boCredential = EnterpriseCredential.Factory.newInstance();
boCredential.setLogin("Administrator");
boCredential.setPassword("password");
boCredential.setDomain("domain");
Session boSession = new Session(boConnection);
SessionInfo boSI = boSession.login(boCredential);


See Also:

Connection, ProxyParameters, Session, SSLWrapper

Nested Class Summary

static class

EnterpriseCredential.Factory A class with methods for creating instances of the EnterpriseCredential type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

java.lang.String	getAuthType() Return the current user's authentication type.
java.lang.String	getDomain() Return the current user's domain.
java.lang.String	getLocale() Returns the user's session locale.
java.lang.String	getLogin() Return the current user's login name.
java.lang.String	getPassword() Return the current user's password.
java.lang.String	getReportedHostName() Gets the ReportedHostName attribute.
java.lang.String	getReportedIPAddress() Gets the ReportedIPAddress attribute.
java.lang.String	getTimeZone() Return the current user's session time zone.
boolean	isSetAuthType() Checks if the AuthType attribute has been set.
boolean	isSetDomain() Checks if the Domain attribute has been set.
boolean	isSetLocale() Checks if the Locale attribute has been set.
boolean	isSetPassword() Checks if the Password attribute has been set.
boolean	isSetReportedHostName() Checks if the ReportedHostName attribute has been set.
boolean	isSetReportedIPAddress() Checks if the ReportedIPAddress attribute has been set.
boolean	isSetTimeZone() Checks if the TimeZone attribute has been set.
void	setAuthType(java.lang.String authType) Set the current user's authentication type.
void	setDomain(java.lang.String domain) Set the user's domain.
void	setLocale(java.lang.String locale) Set the user's session locale.
void	setLogin(java.lang.String login) Set the current user's login name.
void	setPassword(java.lang.String password) Set the current user's password.
void	setReportedHostName(java.lang.String reportedHostName) Sets the ReportedHostName attribute.
void	setReportedIPAddress(java.lang.String reportedIPAddress) Sets the ReportedIPAddress attribute.
void	setTimeZone(java.lang.String timeZone) Set the user's session time zone.
void	unsetAuthType() Deletes or unsets the AuthType attribute.
void	unsetDomain() Deletes or unsets the Domain attribute
void	unsetLocale() Deletes or unsets the Locale attribute
void	unsetPassword() Deletes or unsets the Password attribute
void	unsetReportedHostName() Deletes or unsets the ReportedHostName attribute.
void	unsetReportedIPAddress() Deletes or unsets the ReportedIPAddress attribute.
void	unsetTimeZone() Deletes or unsets the TimeZone attribute.
org.apache.xmlbeans.XmlString	xgetAuthType() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDomain() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetLocale() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetLogin() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetPassword() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetReportedHostName() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetReportedIPAddress() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetTimeZone() Internal Use Only.
void	xsetAuthType(org.apache.xmlbeans.XmlString authType) Internal Use Only.
void	xsetDomain(org.apache.xmlbeans.XmlString domain) Internal Use Only.
void	xsetLocale(org.apache.xmlbeans.XmlString locale) Internal Use Only.
void	xsetLogin(org.apache.xmlbeans.XmlString login) Internal Use Only.
void	xsetPassword(org.apache.xmlbeans.XmlString password) Internal Use Only.
void	xsetReportedHostName(org.apache.xmlbeans.XmlString reportedHostName) Internal Use Only.
void	xsetReportedIPAddress(org.apache.xmlbeans.XmlString reportedIPAddress) Internal Use Only.
void	xsetTimeZone(org.apache.xmlbeans.XmlString timeZone) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getLogin

java.lang.String getLogin()

Return the current user's login name.

Returns:

A String containing a users enterprise login name.

xgetLogin

org.apache.xmlbeans.XmlString xgetLogin()

Internal Use Only.

setLogin

void setLogin(java.lang.String login)

Set the current user's login name.

Parameters:

login - A String containing the user name.

xsetLogin

void xsetLogin(org.apache.xmlbeans.XmlString login)

Internal Use Only.

getPassword

java.lang.String getPassword()

Return the current user's password.

Returns:

A String containing the current users password.

xgetPassword

org.apache.xmlbeans.XmlString xgetPassword()

Internal Use Only.

isSetPassword

boolean isSetPassword()

Checks if the Password attribute has been set.

Returns:

true if the Password element has been set,otherwise false.

setPassword

void setPassword(java.lang.String password)

Set the current user's password.

Parameters:

password - A String containing the current user's password.

xsetPassword

void xsetPassword(org.apache.xmlbeans.XmlString password)

Internal Use Only.

unsetPassword

void unsetPassword()

Deletes or unsets the Password attribute

getLocale

java.lang.String getLocale()

Returns the user's session locale. If the locale is not set, then user logs in using the Web Services server's default locale.
Note:The locale has to be set before the user logs in.

Returns:

A string containing the locale to be used for the session.
For example, for American English, the locale is "en_US".

xgetLocale

org.apache.xmlbeans.XmlString xgetLocale()

Internal Use Only.

isSetLocale

boolean isSetLocale()

Checks if the Locale attribute has been set.

Returns:

true if the Locale element has been set,otherwise false.

setLocale

void setLocale(java.lang.String locale)

Set the user's session locale. If the locale is not set, then user logs in using the Web Services server's default locale.
Note:The locale has to be set before the user logs in.

Parameters:

locale - a string containing the locale to be used for the session.
For example, for American English, the locale is "en_US".

xsetLocale

void xsetLocale(org.apache.xmlbeans.XmlString locale)

Internal Use Only.

unsetLocale

void unsetLocale()

Deletes or unsets the Locale attribute

getTimeZone

java.lang.String getTimeZone()

Return the current user's session time zone. If no time zone is defined, the users time zone will be Web Service server's time zone.
Note:The time zone has to be set before the user logs in.

Returns:

A String containing the current users time zone.

xgetTimeZone

org.apache.xmlbeans.XmlString xgetTimeZone()

Internal Use Only.

isSetTimeZone

boolean isSetTimeZone()

Checks if the TimeZone attribute has been set.

Returns:

true if the TimeZone element has been set,otherwise false.

setTimeZone

void setTimeZone(java.lang.String timeZone)

Set the user's session time zone.

Parameters:

timeZone - A String containing the users desired time zone. For example "GMT+01:00".

xsetTimeZone

void xsetTimeZone(org.apache.xmlbeans.XmlString timeZone)

Internal Use Only.

unsetTimeZone

void unsetTimeZone()

Deletes or unsets the TimeZone attribute.

getDomain

java.lang.String getDomain()

Return the current user's domain.

Returns:

A String containing the current users domain.

xgetDomain

org.apache.xmlbeans.XmlString xgetDomain()

Internal Use Only.

isSetDomain

boolean isSetDomain()

Checks if the Domain attribute has been set.

Returns:

true if the Domain element has been set,otherwise false.

setDomain

void setDomain(java.lang.String domain)

Set the user's domain.
Note:The domain has to be set before the user logs in.

Parameters:

domain - a string containing the domain server to connect to.

xsetDomain

void xsetDomain(org.apache.xmlbeans.XmlString domain)

Internal Use Only.

unsetDomain

void unsetDomain()

Deletes or unsets the Domain attribute

getAuthType

java.lang.String getAuthType()

Return the current user's authentication type.

Returns:

the current user's authentication type.

xgetAuthType

org.apache.xmlbeans.XmlString xgetAuthType()

Internal Use Only.

isSetAuthType

boolean isSetAuthType()

Checks if the AuthType attribute has been set.

Returns:

true if the AuthType element has been set,otherwise false.

setAuthType

void setAuthType(java.lang.String authType)

Set the current user's authentication type. Business Objects supports the following authentication types:

• secEnterprise - Enterprise authentication
• secWinNT - Windows NT authentication
• secWinAD - Active Directory
• secLDAP - LDAP
• secSAP - SAP
• secPSFT - PeopleSoft

When using LDAP, if Single Sign On (SSO) is turned on, a SiteMinder token is used instead of the username and password. This token is obtained from the browser's SMSESSION cookie.

Parameters:

authType - the current user's authentication type.

xsetAuthType

void xsetAuthType(org.apache.xmlbeans.XmlString authType)

Internal Use Only.

unsetAuthType

void unsetAuthType()

Deletes or unsets the AuthType attribute.

getReportedIPAddress

java.lang.String getReportedIPAddress()

Gets the ReportedIPAddress attribute.

Returns:

A String containing the ReportedIPAddress.

xgetReportedIPAddress

org.apache.xmlbeans.XmlString xgetReportedIPAddress()

Internal Use Only.

isSetReportedIPAddress

boolean isSetReportedIPAddress()

Checks if the ReportedIPAddress attribute has been set.

Returns:

true if the ReportedIPAddress element has been set,otherwise false.

setReportedIPAddress

void setReportedIPAddress(java.lang.String reportedIPAddress)

Sets the ReportedIPAddress attribute.

Parameters:

reportedIPAddress - a String containing the ReportedIPAddress.

xsetReportedIPAddress

void xsetReportedIPAddress(org.apache.xmlbeans.XmlString reportedIPAddress)

Internal Use Only.

unsetReportedIPAddress

void unsetReportedIPAddress()

Deletes or unsets the ReportedIPAddress attribute.

getReportedHostName

java.lang.String getReportedHostName()

Gets the ReportedHostName attribute.

Returns:

The ReportedHostName object.

xgetReportedHostName

org.apache.xmlbeans.XmlString xgetReportedHostName()

Internal Use Only.

isSetReportedHostName

boolean isSetReportedHostName()

Checks if the ReportedHostName attribute has been set.

Returns:

true if the ReportedHostName element has been set,otherwise false.

setReportedHostName

void setReportedHostName(java.lang.String reportedHostName)

Sets the ReportedHostName attribute.

Parameters:

reportedHostName - The ReportedHostName object.

xsetReportedHostName

void xsetReportedHostName(org.apache.xmlbeans.XmlString reportedHostName)

Internal Use Only.

unsetReportedHostName

void unsetReportedHostName()

Deletes or unsets the ReportedHostName attribute.