public class ConnectionServiceImpl
extends java.lang.Object
implements com.nortel.soa.oi.cct.connectionservice.ConnectionService
This service models a Connection in the system
It provides methods to read and set the attributes of the connection.
Prerequisites to usage: This represents the minimal data artifacts required to successfully invoke this web service.
SsoToken
(Represents a valid CCT user session)
Connection
(An existing connection)
Operations: View WSDL
Constructor and Description |
---|
ConnectionServiceImpl() |
Modifier and Type | Method and Description |
---|---|
void |
accept(ConnectionRequest parameters)
Accepts a telephone call incoming to an Address
|
void |
alert(ConnectionRequest parameters)
Place a connection into the alerting state
|
void |
disconnect(ConnectionRequest parameters)
Drops a Connection from an active contact
|
AddressResponse |
getAddress(ConnectionRequest parameters)
Returns the Address object associated with this Connection
|
ConnectionCapabilitiesResponse |
getConnectionCapabilities(ConnectionRequest parameters)
Returns the dynamic capabilities for the instance of the Connection object
|
ContactResponse |
getContact(ConnectionRequest parameters)
Returns the Contact object associated with this Connection.
|
RecordingState |
getRecordingState(ConnectionRequest parameters)
Returns the current recording state of the Connection
|
Reason |
getRecordingStateReason(ConnectionRequest parameters)
Returns the reason for the current recording state
|
ConnectionStateResponse |
getState(ConnectionRequest parameters)
Returns the current state information of the Connection
|
TerminalConnectionsResponse |
getTerminalConnections(ConnectionRequest parameters)
Returns a list of TerminalConnection objects associated with the specified Connection
|
GetVersionResponse |
getVersion(GetVersionRequest parameters) |
ParkResponse |
park(ParkRequest parameters)
Parks the specified Connection at the specified destination address
|
RedirectResponse |
redirect(RedirectRequest parameters)
Redirects an incoming call at an Address to another address.
|
void |
reject(ConnectionRequest parameters)
Rejects a contact incoming to an Address.
|
void |
startRecording(RecordingRequest parameters)
Starts recording a connection
|
void |
stopRecording(RecordingRequest parameters)
Stops recording a connection
|
public ContactResponse getContact(ConnectionRequest parameters) throws GetContactException, SessionNotCreatedException
Operation Summary:
Returns the Contact object associated with this Connection.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getContact
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the ConnectionRequest
containing the terminal connection idContactResponse
contains the contact informationGetContactException
SessionNotCreatedException
public AddressResponse getAddress(ConnectionRequest parameters) throws SessionNotCreatedException, GetAddressException
Operation Summary:
Returns the Address object associated with this Connection
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getAddress
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the ConnectionRequest
containing the Connection IDAddressResponse
contains the address objectSessionNotCreatedException
GetAddressException
public ConnectionCapabilitiesResponse getConnectionCapabilities(ConnectionRequest parameters) throws GetConnectionCapabilitiesException, SessionNotCreatedException
Operation Summary:
Returns the dynamic capabilities for the instance of the Connection object.
Dynamic capabilities tell the system which actions are possible at the time this method is invoked
based upon the implementations knowledge of its ability to successfully perform the action.
This determination may be based upon the current state of the contact model or some implementation-specific knowledge.
These indications do not guarantee that a particular method can be successfully invoked, however.
Connection Capabilities include the following:
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getConnectionCapabilities
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the ConnectionRequest
containing the Cconnection IDConnectionCapabilitiesResponse
contains the ConnectionCapabilitiesGetConnectionCapabilitiesException
SessionNotCreatedException
public TerminalConnectionsResponse getTerminalConnections(ConnectionRequest parameters) throws SessionNotCreatedException, GetTerminalConnectionsException
Operation Summary:
Returns a list of TerminalConnection objects associated with the specified Connection
TerminalConnection objects represent the relationship between a Connection and a specific Terminal endpoint.
There may be zero TerminalConnections associated with this Connection.
In that case, this method returns an empty list in the TerminalConnectionsResponse object
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getTerminalConnections
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the ConnectionRequest
containing the Connection IDTerminalConnectionsResponse
contains a list of terminal connections (@link TerminalConnection)SessionNotCreatedException
GetTerminalConnectionsException
public void accept(ConnectionRequest parameters) throws SessionNotCreatedException, AcceptException
Operation Summary:
Accepts a contact incoming to an Address.
Contacts into an Address may first be offered to that address for acceptance
before the standard notion of "alerting" takes place.
This method is valid on a Connection in the Connection.OFFERED state.
If successful, this method moves the Connection into the Connection.ALERTING state.
Sample Usage:
SOAP Request/Response:
Sample Request
accept
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the ConnectionRequest
containing the terminal connection idSessionNotCreatedException
AcceptException
public void disconnect(ConnectionRequest parameters) throws DisconnectException, SessionNotCreatedException
Operation Summary:
Drops a Connection from an active contact.
This service provides the ability to disconnect a specific party from a contact.
This method does not necessarily drop the entire contact.
The connections address will no longer be associated with the contact.
Disconnecting a Connection may sometimes cause the Contact to be placed in the Contact.INVALID state.
Sample Usage:
SOAP Request/Response:
Sample Request
disconnect
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the ConnectionRequest
containing the Connection IDDisconnectException
SessionNotCreatedException
public ConnectionStateResponse getState(ConnectionRequest parameters) throws GetStateException, SessionNotCreatedException
Operation Summary:
Returns the current state information of the Connection
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getState
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the ConnectionRequest
containing the Connection IDConnectionStateResponse
contains the state informationGetStateException
SessionNotCreatedException
public void alert(ConnectionRequest parameters) throws SessionNotCreatedException, AlertException
Operation Summary:
Places a connection into the alerting state
Sample Usage:
SOAP Request/Response:
Sample Request
alert
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the ConnectionRequest
containing the terminal connection idSessionNotCreatedException
AlertException
public RedirectResponse redirect(RedirectRequest parameters) throws RedirectException, SessionNotCreatedException
Operation Summary:
Redirects an incoming call at an Address to another address.
This service is similar to the transfer feature, however, applications may invoke this method
before first answering the telephone call.
This method redirects the call to another address string provided as the argument to this method.
This telephone address string must be valid and complete.
This Connection must either be in the Connection.OFFERED state or the Connection.ALERTING state.
If successful, this method moves the Connection to the Connection.DISCONNECTED state.
Additionally, any TerminalConnections associated with this Connection will move to the TerminalConnection.DROPPED state.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
redirect
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the RedirectRequest
containing the connection id and the address to redirect this connection toRedirectResponse
contains the connection associated with the new leg of the ContactRedirectException
SessionNotCreatedException
public void reject(ConnectionRequest parameters) throws RejectException, SessionNotCreatedException
Operation Summary:
Rejects a contact incoming to an Address.
Contacts coming into an Address may first be offered to that address for acceptance
before the standard notion of "alerting" takes place.
This method is valid on a Connection in the Connection.OFFERED state.
Sample Usage:
SOAP Request/Response:
Sample Request
reject
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the ConnectionRequest
containing the terminal connection idRejectException
SessionNotCreatedException
public ParkResponse park(ParkRequest parameters) throws SessionNotCreatedException, ParkException
Operation Summary:
Parks a Connection at a destination address.
This service is similar to the transfer feature, except the Connection at the new destination Address is in a special queued state.
Parking a Connection at a destination Address drops the Connection from the Contact,
it creates and returns a new Connection at the specified destination address in the Connection.QUEUED state.
The new destination address string is given as an argument to this method and must be a valid and complete address.
If this method is successful, this Connection moves to the Connection.DISCONNECTED state.
All of its associated TerminalConnections move to the TerminalConnection.DROPPED state.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
park
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the ParkRequest
contains the terminal connection id and the destination addressParkResponse
contains the newly created connection informationSessionNotCreatedException
ParkException
public GetVersionResponse getVersion(GetVersionRequest parameters) throws GetVersionException, SessionNotCreatedException
getVersion
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
GetVersionException
SessionNotCreatedException
public void startRecording(RecordingRequest parameters) throws StartRecordingException, SessionNotCreatedException
Operation Summary:
Initiates call recording on the connection.
Sample Usage:
SOAP Request/Response:
Sample Request
startRecording
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the StartRecordingRequest
containing the Connection
information and recording device with parametersStartRecordingException
SessionNotCreatedException
public void stopRecording(RecordingRequest parameters) throws StopRecordingException, SessionNotCreatedException
Operation Summary:
Terminates call recording on the connection.
Sample Usage:
SOAP Request/Response:
Sample Request
stopRecording
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the StopRecordingRequest
containing the Connection
information and recording device information to match the Start Recording requestStopRecordingException
SessionNotCreatedException
public RecordingState getRecordingState(ConnectionRequest parameters) throws SessionNotCreatedException, GetRecordingStateException
Operation Summary:
Returns the current recording state of the Connection.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getRecordingState
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the ConnectionRequest
containing the Connection IDRecordingState
containing the recording state informationSessionNotCreatedException
GetRecordingStateException
public Reason getRecordingStateReason(ConnectionRequest parameters) throws GetRecordingStateReasonException, SessionNotCreatedException
Operation Summary:
Returns the reason for the current recording state.
Sample Usage:
SOAP Request/Response:
Sample Request
Sample Response
getRecordingStateReason
in interface com.nortel.soa.oi.cct.connectionservice.ConnectionService
parameters
- the ConnectionRequest
containing the ConnectionReason
containing the recording state reason informationGetRecordingStateReasonException
SessionNotCreatedException
Copyright © 2010 All Rights Reserved.