Interface IIntegrationServer

All Superinterfaces:

IDisposable, IEntity

public interface IIntegrationServer
extends IEntity

Integration Server class.

Method Summary

Modifier and Type	Method	Description
IAgent	attachToAgentByUrl(String agentUrl, boolean enableKeepLogged)	Connects to a remote IAgent object.
IInstance	attachToInstance(String instanceAddress, boolean secure, String agentName, AuthenticationType authenticationType, String password, String securityToken, boolean enableKeepLogged)	Logs in the agent to a specific Altitude uCI Server with full permission.
ISession	attachToSessionByUrl(String sessionUrl, boolean enableKeepLogged)	Connects to a remote ISession object.
IContactCenterManager	getContactCenterManager()	Gets the contact center used to manage the contact center.
String[]	getVirtualDirectories()	Gets the virtual directories of the Integration Servers used to log in the agents.
IInstance	login(String instanceAddress, boolean secure, String agentName, AuthenticationType authenticationType, String password, String securityToken, String computerName, boolean forced)	Logs in the agent to the Altitude uCI Server.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

getContactCenterManager

IContactCenterManager getContactCenterManager()
                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the contact center used to manage the contact center.

Returns:

The contact center manager.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

login

IInstance login(String instanceAddress,
 boolean secure,
 String agentName,
 AuthenticationType authenticationType,
 String password,
 String securityToken,
 String computerName,
 boolean forced)
         throws Exception,
altitude.integrationServer.exceptions.ISException

Logs in the agent to the Altitude uCI Server.

Parameters:

instanceAddress - Altitude uCI Server (host:port).

secure - If true, the connections opened between the Integration Server and the instance are secure.

agentName - Name of the agent.

authenticationType - Authentication method.

password - Password used to authenticate the agent when the authenticationType is AuthenticationType.Uci

securityToken - Security token used when authenticationType is AuthenticationType.External

computerName - Name of the workstation of the agent.

forced - If true, and if the agent is already logged in the Altitude uCI Server, then the login is forced.

Returns:

The object IInstance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

attachToInstance

IInstance attachToInstance(String instanceAddress,
 boolean secure,
 String agentName,
 AuthenticationType authenticationType,
 String password,
 String securityToken,
 boolean enableKeepLogged)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Logs in the agent to a specific Altitude uCI Server with full permission.

Parameters:

instanceAddress - Altitude uCI Server (host:port).

secure - If true, the connections opened between the Integration Server and the instance are secure.

agentName - Name of the agent.

authenticationType - Authentication method.

password - Password used to authenticate the agent when the authenticationType is AuthenticationType.Uci

securityToken - Security token used when authenticationType is AuthenticationType.External

enableKeepLogged - If true the JavaApi will internally register a Sponsor object to keep the agent logged in the instance.

Returns:

The object IInstance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

attachToAgentByUrl

IAgent attachToAgentByUrl(String agentUrl,
 boolean enableKeepLogged)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Connects to a remote IAgent object.

Parameters:

agentUrl - The URL of the remote agent.

enableKeepLogged - If true the JavaApi will internally register a Sponsor object to keep the agent logged in the instance.

Returns:

A reference to the IAgent object.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

attachToSessionByUrl

ISession attachToSessionByUrl(String sessionUrl,
 boolean enableKeepLogged)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Connects to a remote ISession object.

Parameters:

sessionUrl - The URL of the remote session.

enableKeepLogged - If true the JavaApi will internally register a Sponsor object to keep the agent logged in the instance.

Returns:

A reference to the ISession object.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getVirtualDirectories

String[] getVirtualDirectories()
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the virtual directories of the Integration Servers used to log in the agents.

Returns:

The virtual directories.

Throws:

Exception

altitude.integrationServer.exceptions.ISException