Class MultiSpeakEndpoint

java.lang.Object

com.ecec.rweber.multispeak.MultiSpeakEndpoint

public class MultiSpeakEndpoint
extends Object

This class represents the connection information for a given Multispeak endpoint. This is the starting point for creating any type of service communication. Endpoints can be created with or without authentication information depending on how they are setup.

Author:

rweber

Constructor Summary

Constructors

Constructor	Description
MultiSpeakEndpoint(MultiSpeakVersion version, String company, String url)
MultiSpeakEndpoint(MultiSpeakVersion version, String company, String url, String username, String password)
MultiSpeakEndpoint(MultiSpeakVersion version, String company, String url, String username, String password, String app)
MultiSpeakEndpoint(File xmlFile)

Method Summary

Modifier and Type	Method	Description
protected Element	createHeader()
String	getAppName()
String	getCompany()
String	getPassword()
URL	getURL()
String	getUsername()
MultiSpeakVersion	getVersion()
void	setAppName(String app)	This could be used to set the app name after object creation, if necessary
void	setAuthentication(String username, String password)	This could be used to set authentication after object creation, if necessary
void	setCompany(String company)	This could be used to set the company name after object creation, if necessary

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MultiSpeakEndpoint

public MultiSpeakEndpoint(MultiSpeakVersion version,
 String company,
 String url)

Parameters:

version - the version of multispeak to use for SOAP requests

company - the name of the company as defined by the service endpoint

url - the full URL, including port if needed

MultiSpeakEndpoint

public MultiSpeakEndpoint(MultiSpeakVersion version,
 String company,
 String url,
 String username,
 String password)

Parameters:

version - the version of multispeak to use for SOAP requests

company - the name of the company as defined by the service endpoint

url - the full URL, including port if needed

username - username of the endpoint

password - password of the endpoint

MultiSpeakEndpoint

public MultiSpeakEndpoint(MultiSpeakVersion version,
 String company,
 String url,
 String username,
 String password,
 String app)

Parameters:

version - the version of multispeak to use for SOAP requests

company - the name of the company as defined by the service endpoint

url - the full URL, including port if needed

username - username of the endpoint

password - password of the endpoint

app - appname as defined by the endpoint setup

MultiSpeakEndpoint

public MultiSpeakEndpoint(File xmlFile)
                   throws JDOMException,
IOException,
MultiSpeakException

Parameters:

xmlFile - xml file containing the MultiSpeak connection information

Throws:

JDOMException

IOException

MultiSpeakException

Method Details

createHeader

protected Element createHeader()

getVersion

public MultiSpeakVersion getVersion()

getURL

public URL getURL()

getUsername

public String getUsername()

getPassword

public String getPassword()

getAppName

public String getAppName()

getCompany

public String getCompany()

setAuthentication

public void setAuthentication(String username,
 String password)

This could be used to set authentication after object creation, if necessary

Parameters:

username - username of the endpoint

password - passord of the endpoint

setAppName

public void setAppName(String app)

This could be used to set the app name after object creation, if necessary

Parameters:

app - appname as defined by the endpoint setup

setCompany

public void setCompany(String company)

This could be used to set the company name after object creation, if necessary

Parameters:

company - name of the company as defined by the endpoint setup