com.businessobjects.dsws.session
Interface ServerInfo

All Known Subinterfaces:

ServerInfoDetails

public interface ServerInfo

The ServerInfo interface stores all properties of a Web Services Server. This object is returned using the Session.getServerInfo function.

Example:
URL boConURL = new URL("http://boserver:port/dswsbobje/services/Session");
com.businessobjects.dsws.Connection boConnection = new Connection(boConURL);
Session boSession = new Session(boConnection);
ServerInfo boSI = boSession.getServerInfo();


See Also:

Connection, ProxyParameters, SSLWrapper, Session

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

void	addAvailableAuthentications(java.lang.String availableAuthentications) Appends the value as the last AvailableAuthentications element.
org.apache.xmlbeans.XmlString	addNewAvailableAuthentications() Appends and returns a new empty value (as xml) as the last AvailableAuthentications element.
java.lang.String[]	getAvailableAuthenticationsArray() Returns an array of authentication modes supported by the server.
java.lang.String	getAvailableAuthenticationsArray(int i) Returns the authentication modes supported by the server at a specified indexed position.
boolean	getClustered() Returns the Clustered attribute.
java.lang.String	getVersion() Returns the version number.
void	insertAvailableAuthentications(int i, java.lang.String availableAuthentications) Inserts the value of a AvailableAuthentications element at a specified indexed position.
org.apache.xmlbeans.XmlString	insertNewAvailableAuthentications(int i) Inserts a new empty value of the AvailableAuthentications element at a specified indexed position.
boolean	isNilAvailableAuthenticationsArray(int i) Checks if the value of AvailableAuthentications is nil at a specified indexed position.
void	removeAvailableAuthentications(int i) Removes the AvailableAuthentications element at the specified index position.
void	setAvailableAuthenticationsArray(int i, java.lang.String availableAuthentications) Internal Use Only.
void	setAvailableAuthenticationsArray(java.lang.String[] availableAuthenticationsArray) Internal Use Only.
void	setClustered(boolean clustered) Sets the Clustered attribute.
void	setNilAvailableAuthenticationsArray(int i) Internal Use Only.
void	setVersion(java.lang.String version) Internal Use Only.
int	sizeOfAvailableAuthenticationsArray() Returns the size of the AvailableAuthentications element.
org.apache.xmlbeans.XmlString[]	xgetAvailableAuthenticationsArray() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetAvailableAuthenticationsArray(int i) Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetClustered() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetVersion() Internal Use Only.
void	xsetAvailableAuthenticationsArray(int i, org.apache.xmlbeans.XmlString availableAuthentications) Internal Use Only.
void	xsetAvailableAuthenticationsArray(org.apache.xmlbeans.XmlString[] availableAuthenticationsArray) Internal Use Only.
void	xsetClustered(org.apache.xmlbeans.XmlBoolean clustered) Internal Use Only.
void	xsetVersion(org.apache.xmlbeans.XmlString version) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getAvailableAuthenticationsArray

java.lang.String[] getAvailableAuthenticationsArray()

Returns an array of authentication modes supported by the server.

Returns:

an array of authentication modes.

See Also:

EnterpriseCredential.getAuthType()

getAvailableAuthenticationsArray

java.lang.String getAvailableAuthenticationsArray(int i)

Returns the authentication modes supported by the server at a specified indexed position.

Returns:

an array of authentication modes.

See Also:

EnterpriseCredential.getAuthType()

xgetAvailableAuthenticationsArray

org.apache.xmlbeans.XmlString[] xgetAvailableAuthenticationsArray()

Internal Use Only.

xgetAvailableAuthenticationsArray

org.apache.xmlbeans.XmlString xgetAvailableAuthenticationsArray(int i)

Internal Use Only.

isNilAvailableAuthenticationsArray

boolean isNilAvailableAuthenticationsArray(int i)

Checks if the value of AvailableAuthentications is nil at a specified indexed position.

Parameters:

i - The index position.

Returns:

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

sizeOfAvailableAuthenticationsArray

int sizeOfAvailableAuthenticationsArray()

Returns the size of the AvailableAuthentications element.

Returns:

the size of the AvailableAuthentications element.

setAvailableAuthenticationsArray

void setAvailableAuthenticationsArray(java.lang.String[] availableAuthenticationsArray)

Internal Use Only.

setAvailableAuthenticationsArray

void setAvailableAuthenticationsArray(int i,
                                      java.lang.String availableAuthentications)

Internal Use Only.

xsetAvailableAuthenticationsArray

void xsetAvailableAuthenticationsArray(org.apache.xmlbeans.XmlString[] availableAuthenticationsArray)

Internal Use Only.

xsetAvailableAuthenticationsArray

void xsetAvailableAuthenticationsArray(int i,
                                       org.apache.xmlbeans.XmlString availableAuthentications)

Internal Use Only.

setNilAvailableAuthenticationsArray

void setNilAvailableAuthenticationsArray(int i)

Internal Use Only.

insertAvailableAuthentications

void insertAvailableAuthentications(int i,
                                    java.lang.String availableAuthentications)

Inserts the value of a AvailableAuthentications element at a specified indexed position.

Parameters:

i - The index position.

availableAuthentications - A String containing the available authentications.

addAvailableAuthentications

void addAvailableAuthentications(java.lang.String availableAuthentications)

Appends the value as the last AvailableAuthentications element.

Parameters:

availableAuthentications - A String containing the available authentications.

insertNewAvailableAuthentications

org.apache.xmlbeans.XmlString insertNewAvailableAuthentications(int i)

Inserts a new empty value of the AvailableAuthentications element at a specified indexed position.

Parameters:

i - The index position.

addNewAvailableAuthentications

org.apache.xmlbeans.XmlString addNewAvailableAuthentications()

Appends and returns a new empty value (as xml) as the last AvailableAuthentications element.

Returns:

a new empty value (as xml) as the last AvailableAuthentications element.

removeAvailableAuthentications

void removeAvailableAuthentications(int i)

Removes the AvailableAuthentications element at the specified index position.

Parameters:

i - The index position.

getVersion

java.lang.String getVersion()

Returns the version number.

Returns:

A Stringcontaining the version number.

xgetVersion

org.apache.xmlbeans.XmlString xgetVersion()

Internal Use Only.

setVersion

void setVersion(java.lang.String version)

Internal Use Only.

xsetVersion

void xsetVersion(org.apache.xmlbeans.XmlString version)

Internal Use Only.

getClustered

boolean getClustered()

Returns the Clustered attribute.

Returns:

true if the Clustered attribute exists, otherwise false.

xgetClustered

org.apache.xmlbeans.XmlBoolean xgetClustered()

Internal Use Only.

setClustered

void setClustered(boolean clustered)

Sets the Clustered attribute.

Parameters:

clustered - A boolean value.

xsetClustered

void xsetClustered(org.apache.xmlbeans.XmlBoolean clustered)

Internal Use Only.