com.pcube.apps.engage
Class Connection

java.lang.Object
  com.pcube.apps.engage.Connection

public class Connection
extends java.lang.Object

A connection handle to the SE. Used by all of the Policy and Subscriber API functions.

Field Summary

static int	ADMIN_LEVEL_AUTHENTICATION
static byte	DC_DEVICE Data-Collector device type
static byte	EMS_DEVICE smartSUB Manager device type
static int	ROOT_LEVEL_AUTHENTICATION
static byte	SE_DEVICE SE Platform device type

Constructor Summary

Connection(com.pcube.management.framework.client.SessionObject session)
Connection Constructor

Method Summary

void	addConnectionStateNotificationListener(ConnectionStateChangedListener listener) Deprecated. use getSessionObject().addConnectionStateNotificationListener instead
void	authenticate(java.lang.String hostName, java.lang.String deviceType, java.lang.String userName, java.lang.String password)
com.pcube.management.framework.client.SessionObject	getSessionObject() Gets the SessionObject to the Engage device
boolean	isConnected() Checks if the connection is valid.
void	removeConnectionStateNotificationListener(ConnectionStateChangedListener listener) Deprecated. use getSessionObject().removeConnectionStateNotificationListener instead

Methods inherited from class java.lang.Object

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

Field Detail

DC_DEVICE

public static final byte DC_DEVICE

Data-Collector device type

See Also:

Constant Field Values

EMS_DEVICE

public static final byte EMS_DEVICE

smartSUB Manager device type

See Also:

Constant Field Values

SE_DEVICE

public static final byte SE_DEVICE

SE Platform device type

See Also:

Constant Field Values

ADMIN_LEVEL_AUTHENTICATION

public static final int ADMIN_LEVEL_AUTHENTICATION

See Also:

Constant Field Values

ROOT_LEVEL_AUTHENTICATION

public static final int ROOT_LEVEL_AUTHENTICATION

See Also:

Constant Field Values

Constructor Detail

Connection

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

Connection Constructor

Parameters:

session -

Method Detail

addConnectionStateNotificationListener

public void addConnectionStateNotificationListener(ConnectionStateChangedListener listener)

Deprecated. use getSessionObject().addConnectionStateNotificationListener instead

Registers the listener to receive 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

Parameters:

hostName -

deviceType -

userName -

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 Engage 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. use getSessionObject().removeConnectionStateNotificationListener instead

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

Parameters:

listener - the listener to unregister