Package nis.svc.ccs.api
Interface ConnectionService
-
- All Superinterfaces:
ConnectionSession
public interface ConnectionService extends ConnectionSession
The ConnectionService provides User programs with access to configured and operational ASP services such as the optimizer service. User programs can only access the ASP Service APIs from this interfaces. This component wraps the complexity of the underlying service provider objects that perform service instantiation and configuration. It also handles license management, remote connections, and inter service integrations, should they be required.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
close()
Should be called when the Connection is no longer needed.void
open()
Open the connection service for use.ConnectionSession
open(ConnectionCredential cred)
Open a child session with credentials information.void
open(ConnectionListener listener)
Used in server processes that embed the connection service.This method opens the connection service for use and registers for a callback for when the connection is closed by an internal component.-
Methods inherited from interface nis.svc.ccs.api.ConnectionSession
get
-
-
-
-
Method Detail
-
open
ConnectionSession open(ConnectionCredential cred) throws ConnectionException
Open a child session with credentials information. Used for providing credentials from a peer call. User program must close.- Parameters:
cred
-- Returns:
- Throws:
ConnectionException
-
open
void open() throws ConnectionException
Open the connection service for use. MUST be called. Uses the node credential.- Throws:
ConnectionException
- if already open or a connection error occurs.
-
open
void open(ConnectionListener listener) throws ConnectionException
Used in server processes that embed the connection service.This method opens the connection service for use and registers for a callback for when the connection is closed by an internal component.- Parameters:
listener
- A hook to provide a shutdown call to the holding thread.- Throws:
ConnectionException
- if already open or a connection error occurs.
-
close
void close() throws ConnectionException
Should be called when the Connection is no longer needed.- Throws:
ConnectionException
-
-