com.businessobjects.dsws.session
Interface SessionInfo

public interface SessionInfo

The SessionInfo interface stores all the properties of a user session. It is returned using the Session.Login function.

Example:Create a session by logging into the CMS with username and password
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, EnterpriseCredential, SSLWrapper, Session

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

UserRight	addNewUserRights() Internal Use Only.
WSResource	addNewWSResourceList() Internal Use Only.
java.lang.String	getDefaultToken() Returns the DefaultToken attribute.
java.lang.String	getLocale() Returns the Locale attribute.
java.lang.String	getLoginInfo() Return session login information.
boolean	getMustChangePassword() Returns the MustChangePassword attribute.
java.lang.String	getPVLocale() Returns the PVLocale attribute.
java.lang.String	getSerializedSession() Returns the SerializedSession attribute.
java.lang.String	getSessionID() Returns the SessionID attribute.
int	getTimeOut() Internal Use Only.
java.lang.String	getUserCUID() Returns the UserCUID attribute.
UserRight[]	getUserRightsArray() Returns an array of UserRight, which contain session based rights of the current user.
UserRight	getUserRightsArray(int i) Returns an array of UserRight, which contain session based rights of the current user at a specified indexed position.
WSResource[]	getWSResourceListArray() Returns an array of web services associated to the current Session
WSResource	getWSResourceListArray(int i) Returns an array of web services associated to the current Session at a specified indexed position
UserRight	insertNewUserRights(int i) Internal Use Only.
WSResource	insertNewWSResourceList(int i) Internal Use Only.
boolean	isNilLoginInfo() Checks if the LoginInfo element is Nil.
boolean	isNilUserRightsArray(int i) Checks if the value of UserRights is set to nil.
boolean	isNilWSResourceListArray(int i) Checks if the WSResourceList element is set to nil at the specified indexed position.
boolean	isSetLoginInfo() Checks if the LoginInfo element has been set.
void	removeUserRights(int i) Removes the UserRights element at the specified indexed position.
void	removeWSResourceList(int i) Internal Use Only.
void	setDefaultToken(java.lang.String defaultToken) Sets the DefaultToken attribute.
void	setLocale(java.lang.String locale) Sets the Locale attribute.
void	setLoginInfo(java.lang.String loginInfo) Sets the LoginInfo element.
void	setMustChangePassword(boolean mustChangePassword) Internal Use Only.
void	setNilLoginInfo() Sets the LoginInfo element to Nil.
void	setNilUserRightsArray(int i) Internal Use Only.
void	setNilWSResourceListArray(int i) Internal Use Only.
void	setPVLocale(java.lang.String pvLocale) Sets the PVLocale attribute.
void	setSerializedSession(java.lang.String serializedSession) Sets the SerializedSession attribute.
void	setSessionID(java.lang.String sessionID) Sets the SessionID attribute.
void	setTimeOut(int timeOut) Internal Use Only.
void	setUserCUID(java.lang.String userCUID) Sets the UserCUID attribute.
void	setUserRightsArray(int i, UserRight userRights) Internal Use Only.
void	setUserRightsArray(UserRight[] userRightsArray) Internal Use Only.
void	setWSResourceListArray(int i, WSResource wsResourceList) Sets the WSResourceList element at the specified indexed position.
void	setWSResourceListArray(WSResource[] wsResourceListArray) Internal Use Only.
int	sizeOfUserRightsArray() Returns the size of the UserRightsArray.
int	sizeOfWSResourceListArray() Returns the size of the WSResourceListArray.
void	unsetLoginInfo() Deletes or unsets the LoginInfo element.
org.apache.xmlbeans.XmlString	xgetDefaultToken() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetLocale() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetLoginInfo() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetMustChangePassword() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetPVLocale() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetSerializedSession() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetSessionID() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetTimeOut() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetUserCUID() Internal Use Only.
void	xsetDefaultToken(org.apache.xmlbeans.XmlString defaultToken) Internal Use Only.
void	xsetLocale(org.apache.xmlbeans.XmlString locale) Internal Use Only.
void	xsetLoginInfo(org.apache.xmlbeans.XmlString loginInfo) Internal Use Only.
void	xsetMustChangePassword(org.apache.xmlbeans.XmlBoolean mustChangePassword) Internal Use Only.
void	xsetPVLocale(org.apache.xmlbeans.XmlString pvLocale) Internal Use Only.
void	xsetSerializedSession(org.apache.xmlbeans.XmlString serializedSession) Internal Use Only.
void	xsetSessionID(org.apache.xmlbeans.XmlString sessionID) Internal Use Only.
void	xsetTimeOut(org.apache.xmlbeans.XmlInt timeOut) Internal Use Only.
void	xsetUserCUID(org.apache.xmlbeans.XmlString userCUID) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getUserRightsArray

UserRight[] getUserRightsArray()

Returns an array of UserRight, which contain session based rights of the current user.

Returns:

An Array of UserRight

See Also:

UserRight

getUserRightsArray

UserRight getUserRightsArray(int i)

Returns an array of UserRight, which contain session based rights of the current user at a specified indexed position.

Parameters:

i - The index position.

Returns:

An Array of UserRight

See Also:

UserRight

isNilUserRightsArray

boolean isNilUserRightsArray(int i)

Checks if the value of UserRights is set to nil.

Parameters:

i - The index position.

Returns:

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

sizeOfUserRightsArray

int sizeOfUserRightsArray()

Returns the size of the UserRightsArray.

Returns:

the size of the UserRightsArray.

setUserRightsArray

void setUserRightsArray(UserRight[] userRightsArray)

Internal Use Only.

setUserRightsArray

void setUserRightsArray(int i,
                        UserRight userRights)

Internal Use Only.

setNilUserRightsArray

void setNilUserRightsArray(int i)

Internal Use Only.

insertNewUserRights

UserRight insertNewUserRights(int i)

Internal Use Only.

addNewUserRights

UserRight addNewUserRights()

Internal Use Only.

removeUserRights

void removeUserRights(int i)

Removes the UserRights element at the specified indexed position.

Parameters:

i - The index position.

getWSResourceListArray

WSResource[] getWSResourceListArray()

Returns an array of web services associated to the current Session

Returns:

an array of web services associated to the current Session.

See Also:

WSResource

getWSResourceListArray

WSResource getWSResourceListArray(int i)

Returns an array of web services associated to the current Session at a specified indexed position

Parameters:

i - The index position.

Returns:

an array of web services associated to the current Session.

See Also:

WSResource

isNilWSResourceListArray

boolean isNilWSResourceListArray(int i)

Checks if the WSResourceList element is set to nil at the specified indexed position.

Parameters:

i - The index position.

Returns:

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

sizeOfWSResourceListArray

int sizeOfWSResourceListArray()

Returns the size of the WSResourceListArray.

Returns:

the size of the WSResourceListArray.

setWSResourceListArray

void setWSResourceListArray(WSResource[] wsResourceListArray)

Internal Use Only.

setWSResourceListArray

void setWSResourceListArray(int i,
                            WSResource wsResourceList)

Sets the WSResourceList element at the specified indexed position.

Parameters:

i - The index position.

wsResourceList - .

setNilWSResourceListArray

void setNilWSResourceListArray(int i)

Internal Use Only.

insertNewWSResourceList

WSResource insertNewWSResourceList(int i)

Internal Use Only.

addNewWSResourceList

WSResource addNewWSResourceList()

Internal Use Only.

removeWSResourceList

void removeWSResourceList(int i)

Internal Use Only.

getLoginInfo

java.lang.String getLoginInfo()

Return session login information.

Returns:

a String containing login information.

xgetLoginInfo

org.apache.xmlbeans.XmlString xgetLoginInfo()

Internal Use Only.

isNilLoginInfo

boolean isNilLoginInfo()

Checks if the LoginInfo element is Nil.

Returns:

true if the LoginInfo element is nil,otherwise false.

isSetLoginInfo

boolean isSetLoginInfo()

Checks if the LoginInfo element has been set.

Returns:

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

setLoginInfo

void setLoginInfo(java.lang.String loginInfo)

Sets the LoginInfo element.

Parameters:

loginInfo. -

xsetLoginInfo

void xsetLoginInfo(org.apache.xmlbeans.XmlString loginInfo)

Internal Use Only.

setNilLoginInfo

void setNilLoginInfo()

Sets the LoginInfo element to Nil.

unsetLoginInfo

void unsetLoginInfo()

Deletes or unsets the LoginInfo element.

getLocale

java.lang.String getLocale()

Returns the Locale attribute.

Returns:

the Locale attribute.

xgetLocale

org.apache.xmlbeans.XmlString xgetLocale()

Internal Use Only.

setLocale

void setLocale(java.lang.String locale)

Sets the Locale attribute.

Parameters:

locale - A String that contains the locale.

xsetLocale

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

Internal Use Only.

getPVLocale

java.lang.String getPVLocale()

Returns the PVLocale attribute.

Returns:

the PVLocale attribute.

xgetPVLocale

org.apache.xmlbeans.XmlString xgetPVLocale()

Internal Use Only.

setPVLocale

void setPVLocale(java.lang.String pvLocale)

Sets the PVLocale attribute.

Parameters:

pvLocale - A String that contains the preferred value of locale.

xsetPVLocale

void xsetPVLocale(org.apache.xmlbeans.XmlString pvLocale)

Internal Use Only.

getMustChangePassword

boolean getMustChangePassword()

Returns the MustChangePassword attribute.

Returns:

the MustChangePassword attribute.

xgetMustChangePassword

org.apache.xmlbeans.XmlBoolean xgetMustChangePassword()

Internal Use Only.

setMustChangePassword

void setMustChangePassword(boolean mustChangePassword)

Internal Use Only.

xsetMustChangePassword

void xsetMustChangePassword(org.apache.xmlbeans.XmlBoolean mustChangePassword)

Internal Use Only.

getSessionID

java.lang.String getSessionID()

Returns the SessionID attribute.

Returns:

the SessionID attribute.

xgetSessionID

org.apache.xmlbeans.XmlString xgetSessionID()

Internal Use Only.

setSessionID

void setSessionID(java.lang.String sessionID)

Sets the SessionID attribute.

Parameters:

sessionID. -

xsetSessionID

void xsetSessionID(org.apache.xmlbeans.XmlString sessionID)

Internal Use Only.

getDefaultToken

java.lang.String getDefaultToken()

Returns the DefaultToken attribute.

Returns:

the DefaultToken attribute.

xgetDefaultToken

org.apache.xmlbeans.XmlString xgetDefaultToken()

Internal Use Only.

setDefaultToken

void setDefaultToken(java.lang.String defaultToken)

Sets the DefaultToken attribute.

Parameters:

defaultToken -

xsetDefaultToken

void xsetDefaultToken(org.apache.xmlbeans.XmlString defaultToken)

Internal Use Only.

getTimeOut

int getTimeOut()

Internal Use Only.

xgetTimeOut

org.apache.xmlbeans.XmlInt xgetTimeOut()

Internal Use Only.

setTimeOut

void setTimeOut(int timeOut)

Internal Use Only.

xsetTimeOut

void xsetTimeOut(org.apache.xmlbeans.XmlInt timeOut)

Internal Use Only.

getUserCUID

java.lang.String getUserCUID()

Returns the UserCUID attribute.

Returns:

the UserCUID attribute.

xgetUserCUID

org.apache.xmlbeans.XmlString xgetUserCUID()

Internal Use Only.

setUserCUID

void setUserCUID(java.lang.String userCUID)

Sets the UserCUID attribute.

Parameters:

userCUID. -

xsetUserCUID

void xsetUserCUID(org.apache.xmlbeans.XmlString userCUID)

Internal Use Only.

getSerializedSession

java.lang.String getSerializedSession()

Returns the SerializedSession attribute.

Returns:

the SerializedSession attribute.

xgetSerializedSession

org.apache.xmlbeans.XmlString xgetSerializedSession()

Internal Use Only.

setSerializedSession

void setSerializedSession(java.lang.String serializedSession)

Sets the SerializedSession attribute.

Parameters:

serializedSession -

xsetSerializedSession

void xsetSerializedSession(org.apache.xmlbeans.XmlString serializedSession)

Internal Use Only.