class EppSession

This EppSession class is designed to handle a session connected to the EPP Server.

Inheritance:


Public Methods

[more] EppSession()
Creates an EppSession object
[more]virtual ~EppSession()
Destructor
[more]virtual void init( void* object ) = 0
Initializes the run-time parameters related to an EPP Session.
[more]const char* getException()
Gets the last exception received for the EPP Session
[more]void setException( const char* e )
Sets the current exception received for the EPP Session
[more]const char* getMessage()
Gets the last message received for the EPP Session
[more]void setMessage( const char* message )
Sets the current message received for the EPP Session
[more]virtual EppGreeting* connect( const char* host, const int port ) = 0
Connects to the EPP Server and establishs an EPP Session
[more]virtual void close() = 0
Closes the EPP Session
[more]virtual EppChannel* getChannel() = 0
Allocates an EPP Channel
[more]virtual EppGreeting* hello() = 0
Sends an EPP Hello message to the EPP Server and returns back with an EppGreeting object


Documentation

This EppSession class is designed to handle a session connected to the EPP Server.

o EppSession()
Creates an EppSession object

ovirtual ~EppSession()
Destructor

ovirtual void init( void* object ) = 0
Initializes the run-time parameters related to an EPP Session. This method must be called before the EPP Session is started. The configuration object can be a Properties object if the implementation choose to use Java Property file, or an DOM_Element object, if the configuration file is in XML format, or an const char * that represents the name of the configuration file in any format.

Parameters:
object - the configuration object for setting up run-time parameters related to the EPP Session

oconst char* getException()
Gets the last exception received for the EPP Session

ovoid setException( const char* e )
Sets the current exception received for the EPP Session

oconst char* getMessage()
Gets the last message received for the EPP Session

ovoid setMessage( const char* message )
Sets the current message received for the EPP Session

ovirtual EppGreeting* connect( const char* host, const int port ) = 0
Connects to the EPP Server and establishs an EPP Session

Parameters:
host - the host name of the EPP server to be connected
port - the port number of the EPP server to be connected
Returns:
an EppGreeting object returned by the EPP server if the connection is successfully established, or null if there is any error
Note: if there is any error occurred during the process of establishing the connection, this method will return null, and getException method should be called for obtaining the details of the error. If the exception returned is null, then the getMessage for obtaining the last message received from the EPP Server.

ovirtual void close() = 0
Closes the EPP Session


Note: if there is any error occurred during the process of closing the EPP Session, getException method should be called for obtaining the details of the error

ovirtual EppChannel* getChannel() = 0
Allocates an EPP Channel

Returns:
an EppChannel object, or null if the EPP Channel cannot be allocated
Note: different transport mechanisms may allow different numbers of EPP Channels to be established with one EPP Session.

ovirtual EppGreeting* hello() = 0
Sends an EPP Hello message to the EPP Server and returns back with an EppGreeting object

Returns:
an EppGreeting returned by the EPP Server, or null if there is any error


Direct child classes:
EppSessionTcp
Author:
Ning Zhang ning.zhang@neustar.com
Version:
$Revision: 1.1 $ $Date: 2001/11/05 20:20:36 $

Alphabetic index HTML hierarchy of classes or Java


Copyright © 2001-2002 NeuStar, Inc. All Rights Reserved.