com.businessobjects.dsws.session
Interface WSResource

public interface WSResource

A WSResource is a web service available to the current session. The Session web service provides a list to Web Services available to the user, for example BICatalog and ReportEngine. When a user logs in, an array of WSResource is accessible in the SessionInfo object.
Use the URL stored in the WSResource object to initialize instances of the named web service.

Example:List the web services available to the user.

 String endPointURL = "http://localhost:8080/dswsbobje/services/Session";
 com.businessobjects.dsws.Connection con = new Connection(new URL(endPointURL));
 Session objSession = new Session(con);
 EnterpriseCredential ec = EnterpriseCredential.Factory.newInstance();
 ec.setLogin("Administrator");
 ec.setPassword("");
 ec.setAuthType("secEnterprise");
 SessionInfo sessionInfo =  objSession.login(ec);
 WSResource[] objWSResources = sessionInfo.getWSResourceList();

 for(int i=0; i< objWSResources.length; i++)  

 {

         WSResource objWSResource = objWSResources[i];
         String strWSResourceDesc = objWSResource.getDescription();
         String strWSResourceURL = objWSResource.getURL();
     out.print(strWSResourceDesc);
     out.print(strWSResourceURL);
 }
 

See Also:

com.businessobjects.dsws.session.SessionInfo


Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

java.lang.String	getDescription() Returns a description of this web service.
java.lang.String	getURL() Returns the URL necessary to access the web service.
java.lang.String	getWSType() Returns the web service type.
boolean	isNilDescription() Checks if the Description element is nil.
boolean	isSetDescription() Checks if the Description element has been set.
void	setDescription(java.lang.String description) Sets a description of this web service.
void	setNilDescription() Nils the Description element.
void	setURL(java.lang.String url) Set the URL necessary to access the web service.
void	setWSType(java.lang.String wsType) Sets the web service type.
void	unsetDescription() Deletes or unsets the Description element.
org.apache.xmlbeans.XmlString	xgetDescription() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetURL() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetWSType() Internal Use Only.
void	xsetDescription(org.apache.xmlbeans.XmlString description) Internal Use Only.
void	xsetURL(org.apache.xmlbeans.XmlString url) Internal Use Only.
void	xsetWSType(org.apache.xmlbeans.XmlString wsType) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getDescription

java.lang.String getDescription()

Returns a description of this web service.

Returns:

A String containing the web service description.

xgetDescription

org.apache.xmlbeans.XmlString xgetDescription()

Internal Use Only.

isNilDescription

boolean isNilDescription()

Checks if the Description element is nil.

Returns:

true if the Description element has been set to nil,otherwise false.

isSetDescription

boolean isSetDescription()

Checks if the Description element has been set.

Returns:

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

setDescription

void setDescription(java.lang.String description)

Sets a description of this web service.

Parameters:

description - a string containing the web service description.

xsetDescription

void xsetDescription(org.apache.xmlbeans.XmlString description)

Internal Use Only.

setNilDescription

void setNilDescription()

Nils the Description element.

unsetDescription

void unsetDescription()

Deletes or unsets the Description element.

getURL

java.lang.String getURL()

Returns the URL necessary to access the web service.

Returns:

A String containing the web service URL.

xgetURL

org.apache.xmlbeans.XmlString xgetURL()

Internal Use Only.

setURL

void setURL(java.lang.String url)

Set the URL necessary to access the web service.

Parameters:

url - a string containing the web service URL.

xsetURL

void xsetURL(org.apache.xmlbeans.XmlString url)

Internal Use Only.

getWSType

java.lang.String getWSType()

Returns the web service type. For example, BICatalog, ReportEngine.

Returns:

A String containing the web service type.

xgetWSType

org.apache.xmlbeans.XmlString xgetWSType()

Internal Use Only.

setWSType

void setWSType(java.lang.String wsType)

Sets the web service type. For example, BICatalog, ReportEngine.

Parameters:

wsType - a string containing the web service type.

xsetWSType

void xsetWSType(org.apache.xmlbeans.XmlString wsType)

Internal Use Only.