public class ContactManagerServiceImpl
extends java.lang.Object
implements com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerService
This service provides a high level view of the system and provides functionality for querying for the complete
set of Agents, Addresses, Terminals, etc.
Particular resources from the system can be queried using optional field
to refine the search. The provider is often an optional field to query either a particular provider or across the entire set of providers
Prerequisites to usage: This represents the minimal data artifacts required to successfully invoke this web service.
SsoToken (Represents a valid superuser session)
Operations: View WSDL
Since this is a system level service, a standard CCT SSO Token will not authorize the use of these operations
| Constructor and Description |
|---|
ContactManagerServiceImpl() |
| Modifier and Type | Method and Description |
|---|---|
Address |
getAddress(AddressRequest parameters)
Returns a specified address
|
AddressesResponse |
getAddresses(AddressesRequest parameters)
Returns the list of all addresses
|
Agent |
getAgent(AgentRequest parameters)
Returns the specified agent
|
AgentsResponse |
getAgents(SsoToken parameters)
Returns a list of all agents
|
Contact |
getContact(ContactRequest parameters)
Returns a specified contact
|
ContactsResponse |
getContacts(ContactsRequest parameters)
Returns the list of all contacts
|
ContactTypesResponse |
getContactTypes(ContactTypesRequest parameters)
Returns the contact types available
|
ServiceInformation |
getInformation(InformationRequest parameters)
Returns service information
|
ProvidersReponse |
getProviders(SsoToken parameters)
Returns a list of all providers
|
Terminal |
getTerminal(TerminalRequest parameters)
Returns a specified terminal
|
TerminalsResponse |
getTerminals(TerminalsRequest parameters)
Returns the list of all terminals
|
GetVersionResponse |
getVersion(GetVersionRequest parameters) |
void |
sessionHeartbeat(SsoToken parameters)
Keeps the session alive
|
void |
startAddressCallEventListener(StartCallEventListenerRequest parameters)
Starts a call event listener which issues notification of call events
|
void |
startAgentEventListener(StartAgentEventListenerRequest parameters)
Starts an agent event listener which issues notification of agent events
|
void |
startCallEventListener(StartCallEventListenerRequest parameters)
Starts a call event listener which issues notification of call events
|
void |
startSystemEventListener(StartSystemEventListenerRequest parameters) |
void |
stopAddressCallEventListener(StopEventListenerRequest parameters)
Stops a call event listener that is currently issuing notifications
|
void |
stopAgentEventListener(StopEventListenerRequest parameters)
Stops an agent event listener that is currently issuing notifications
|
void |
stopCallEventListener(StopEventListenerRequest parameters)
Stops a call event listener that is currently issuing notifications
|
void |
stopSystemEventListener(StopEventListenerRequest parameters) |
public ProvidersReponse getProviders(SsoToken parameters) throws GetProvidersException, SessionNotCreatedException
Operation Summary:
Returns a list of all providers.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getProviders in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the SsoToken to authorise the requestProvidersReponse the set of providers availableGetProvidersExceptionSessionNotCreatedExceptionpublic AgentsResponse getAgents(SsoToken parameters) throws GetAgentsException, SessionNotCreatedException
Operation Summary:
Returns a list of all agents.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getAgents in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the SsoToken to authorise the requestAgentsResponse the set of agentsGetAgentsExceptionSessionNotCreatedExceptionpublic Agent getAgent(AgentRequest parameters) throws GetAgentException, SessionNotCreatedException
Operation Summary:
Retrieves the agent specified by the agent login ID and/or SIP URI.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getAgent in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the AgentRequest containing the Agent login ID and/or SIP URIAgent the retrieved agentGetAgentExceptionSessionNotCreatedExceptionpublic ContactTypesResponse getContactTypes(ContactTypesRequest parameters) throws GetContactTypesException, SessionNotCreatedException
Operation Summary:
Returns the contact types that are available. If the provider is specified then all the contact types available on that provider are returned.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getContactTypes in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the ContactTypesRequest containing the SSO Token and optional providerContactTypesResponse the contact types availableGetContactTypesExceptionSessionNotCreatedExceptionpublic AddressesResponse getAddresses(AddressesRequest parameters) throws GetAddressesException, SessionNotCreatedException
Operation Summary:
Returns all of the addresses in CCT. If the provider is specified then all of the addresses on that provider are returned.
Additionally the address type can be passed in order to restrict the addresses to a particular type.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getAddresses in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the AddressesRequest containing the SSO Token and optional provider and address typeAddressesResponse the list of addressesGetAddressesExceptionSessionNotCreatedExceptionpublic Address getAddress(AddressRequest parameters) throws GetAddressException, SessionNotCreatedException
Operation Summary:
Retrieves the address specified by the passed parameters. These parameters are the provider, address name, URI and type.
The provider and address type must be entered along the name and/or URI.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getAddress in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the AddressRequest containing the SSO token, provider, address name, address URI and address typeAddress the returned addressGetAddressExceptionSessionNotCreatedExceptionpublic TerminalsResponse getTerminals(TerminalsRequest parameters) throws GetTerminalsException, SessionNotCreatedException
Operation Summary:
Returns all of the terminals in CCT. If the provider is specified then all of the addresses on that provider are returned.
Additionally the terminal type can be passed in order to restrict the terminals to a particular type.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getTerminals in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the TerminalsRequest containing the SSO Token and optional provider and terminal typeTerminalsResponse the list of terminalsGetTerminalsExceptionSessionNotCreatedExceptionpublic Terminal getTerminal(TerminalRequest parameters) throws GetTerminalException, SessionNotCreatedException
Operation Summary:
Retrieves the terminal specified by the passed parameters. These parameters are the provider, terminal name and type.
The terminal name must be entered while the provider and terminal type refine the search.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getTerminal in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the TerminalRequest containing the SSO token, provider, terminal name and terminal typeTerminal the returned terminalGetTerminalExceptionSessionNotCreatedExceptionpublic ContactsResponse getContacts(ContactsRequest parameters) throws GetContactsException, SessionNotCreatedException
Operation Summary:
Returns all of the contacts in CCT. If the provider is specified then all of the contacts on that provider are returned.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getContacts in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the ContactsRequest containing the SSO Token and optional providerContactsResponse the list of contactsGetContactsExceptionSessionNotCreatedExceptionpublic Contact getContact(ContactRequest parameters) throws GetContactException, SessionNotCreatedException
Operation Summary:
Retrieves the contact specified by the passed parameters. These parameters are the provider, contact ID and external ID.
Either the contact ID or external ID must be provided. The provider parameter can restrict the search to particular provider.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getContact in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the ContactRequest containing the SSO token, provider, contact ID and external IDContact the returned contactGetContactExceptionSessionNotCreatedExceptionpublic void startCallEventListener(StartCallEventListenerRequest parameters) throws SessionNotCreatedException, StartCallEventListenerException
Operation Summary:
Starts a call event listener which issue notification of call events.
A list of address names to monitor can be specified otherwise all addresses are monitored.
Particular call events can be listed which trigger notification, if left unspecified all call events trigger notification.
Sample Usage:
SOAP Request/Response:
Sample Request
startCallEventListener in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the StartCallEventListenerRequest containing the subscription informationSessionNotCreatedExceptionStartCallEventListenerExceptionpublic void stopCallEventListener(StopEventListenerRequest parameters) throws StopCallEventListenerException, SessionNotCreatedException
Operation Summary:
Stops a call event listener that is issues notifications.
The subscription ID is passed in to identify the listener that will be terminated.
Sample Usage:
SOAP Request/Response:
Sample Request
stopCallEventListener in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the StopCallEventListenerRequest containing the subscription IDStopCallEventListenerExceptionSessionNotCreatedExceptionpublic void startAgentEventListener(StartAgentEventListenerRequest parameters) throws SessionNotCreatedException, StartAgentEventListenerException
Operation Summary:
Starts an agent event listener which issue notification of agent events.
These events include logins, logouts and ready / not ready status changes
A list of agents to monitor can be specified otherwise all agent are monitored.
Particular agent events can be listed which trigger notification, if left unspecified all agent events trigger notification.
Sample Usage:
SOAP Request/Response:
Sample Request
startAgentEventListener in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the StartAgentEventListenerRequest containing the subscription informationSessionNotCreatedExceptionStartAgentEventListenerExceptionpublic void stopAgentEventListener(StopEventListenerRequest parameters) throws SessionNotCreatedException, StopAgentEventListenerException
Operation Summary:
Stops an agent event listener that is issues notifications.
The subscription ID is passed in to identify the listener that will be terminated.
Sample Usage:
SOAP Request/Response:
Sample Request
stopAgentEventListener in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the StopAgentEventListenerRequest containing the subscription IDSessionNotCreatedExceptionStopAgentEventListenerExceptionpublic ServiceInformation getInformation(InformationRequest parameters) throws GetInformationException
Operation Summary:
This service is used by clients to ensure the service is operational. A client can regularly call the service to determine
that there are no fundamental network or service problems. The version and service uptime are returned is the service executes correctly.
By using the uptime it is possible to determine whether the service was down during the interval between calls to this operation.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getInformation in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceServiceInformation containing the service version and service uptime in millisecondsGetInformationExceptionpublic void startAddressCallEventListener(StartCallEventListenerRequest parameters) throws SessionNotCreatedException, StartCallEventListenerException
Operation Summary:
Starts a call event listener which issues notification of call events.
A list of address names to monitor can be specified otherwise all addresses are monitored.
Particular call events can be listed which trigger notification, if left unspecified all call events trigger notification.
Sample Usage:
SOAP Request/Response:
Sample Request
startAddressCallEventListener in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the StartCallEventListenerRequest containing the subscription informationSessionNotCreatedExceptionStartCallEventListenerExceptionpublic void stopAddressCallEventListener(StopEventListenerRequest parameters) throws StopCallEventListenerException, SessionNotCreatedException
Operation Summary:
Stops a call event listener that is issues notifications.
The subscription ID is passed in to identify the listener that will be terminated.
Sample Usage:
SOAP Request/Response:
Sample Request
stopAddressCallEventListener in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the StopCallEventListenerRequest containing the subscription IDStopCallEventListenerExceptionSessionNotCreatedExceptionpublic void startSystemEventListener(StartSystemEventListenerRequest parameters) throws SessionNotCreatedException, StartSystemEventListenerException
startSystemEventListener in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceSessionNotCreatedExceptionStartSystemEventListenerExceptionpublic void stopSystemEventListener(StopEventListenerRequest parameters) throws StopSystemEventListenerException, SessionNotCreatedException
stopSystemEventListener in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceStopSystemEventListenerExceptionSessionNotCreatedExceptionpublic void sessionHeartbeat(SsoToken parameters) throws SessionNotCreatedException
Operation Summary:
Keeps the SOA session aline.
sessionHeartbeat in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceparameters - the SsoToken to authorise the requestSessionNotCreatedExceptionpublic GetVersionResponse getVersion(GetVersionRequest parameters) throws SessionNotCreatedException, GetVersionException
getVersion in interface com.nortel.soa.oi.cct.contactmanagerservice.ContactManagerServiceSessionNotCreatedExceptionGetVersionExceptionCopyright © 2010 All Rights Reserved.