com.cisco.scabb.servconf.mgmt
Class ConnectionApi

java.lang.Object
  com.cisco.scabb.servconf.mgmt.ConnectionApi

public class ConnectionApi
extends java.lang.Object

A connection handle to the SCE. Used by all of the Service-Configuration and Subscriber API functions.

Constructor Summary

ConnectionApi(Connection connection)
ConnectionApi Constructor, initializes a connection to the box

ConnectionApi(com.pcube.management.framework.client.SessionObject session)
ConnectionApi Constructor, initializes a connection to the box

Method Summary

void	addConnectionStateNotificationListener(ConnectionStateChangedListener listener) Deprecated. no longer supported
void	authenticate(java.lang.String hostName, java.lang.String deviceType, java.lang.String userName, java.lang.String password) Authenticate the user at the specified device
com.pcube.management.framework.client.SessionObject	getSessionObject() Gets the SessionObject to the SCABB device
boolean	isConnected() Checks if the connection is valid.
void	removeConnectionStateNotificationListener(ConnectionStateChangedListener listener) Deprecated. no longer supported

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionApi

public ConnectionApi(Connection connection)

ConnectionApi Constructor, initializes a connection to the box

Parameters:

session -

ConnectionApi

public ConnectionApi(com.pcube.management.framework.client.SessionObject session)

ConnectionApi Constructor, initializes a connection to the box

Parameters:

session -

Method Detail

addConnectionStateNotificationListener

public void addConnectionStateNotificationListener(ConnectionStateChangedListener listener)

Deprecated. no longer supported

Registers the listener to recieve the connection's state notifications. The listener implements the javax.management.NotificationListener interface.

Parameters:

listener - the listener

authenticate

public void authenticate(java.lang.String hostName,
                         java.lang.String deviceType,
                         java.lang.String userName,
                         java.lang.String password)
                  throws java.io.IOException,
                         com.pcube.management.common.WrapperException,
                         com.pcube.management.tools.ftpclient.net.ftp.FTPException

Authenticate the user at the specified device

Parameters:

hostName - the device's host-name

deviceType - one of LoginApi.SE_SERVICE_NAME, LoginApi.EMS_SERVICE_NAME

userName - the username

password - the password

Throws:

java.io.IOException

com.pcube.management.common.WrapperException

com.pcube.management.tools.ftpclient.net.ftp.FTPException

getSessionObject

public com.pcube.management.framework.client.SessionObject getSessionObject()

Gets the SessionObject to the SCABB device

Returns:

the session object

isConnected

public boolean isConnected()

Checks if the connection is valid.

Returns:

true if connected to the device, false otherwise

removeConnectionStateNotificationListener

public void removeConnectionStateNotificationListener(ConnectionStateChangedListener listener)

Deprecated. no longer supported

Unregisters the listener from recieving the connection's state notifications.

Parameters:

listener - the listener to unregister