EPP 0.2.3

com.neulevel.epp.transport
Class EppSession

java.lang.Object
  |
  +--com.neulevel.epp.transport.EppSession
Direct Known Subclasses:
EppSessionTcp

public abstract class EppSession
extends java.lang.Object

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

Version:
$Revision$ $Date$
Author:
Ning Zhang ning.zhang@neustar.com

Field Summary
static java.lang.String CLIENT_AUTH
          The property for enabling client side authentication, default true
static java.lang.String KM_ALGORITHM
          The property for key manager algorithm, default "SUNX509"
static java.lang.String KM_PROVIDER
          The property for key manager provider, default null
static java.lang.String KS_FORMAT
          The property for key store format, default "file"
static java.lang.String KS_KEYPASS
          The property for key password for recovering keys, default as the value of the key store password
static java.lang.String KS_NAME
          The property for key store name.
static java.lang.String KS_PROVIDER
          The property for key store provider, default null
static java.lang.String KS_STOREPASS
          The property for key store password, default null
static java.lang.String KS_TYPE
          The property for key store type, default "JKS"
static java.lang.String PK_CIPHER_SUITE
          The property for cipher suite, default null
static java.lang.String PK_PRIVATE_KEY
          The property for file name storing private key (PEM format)
static java.lang.String PK_PRIVATE_PASS
          The property for the passphrease of the file storing private key, default ""
static java.lang.String PK_PRIVATE_TYPE
          The property for the private key algorithm, default "RSA"
static java.lang.String PK_PUBLIC_KEY
          The property for file name storing public key (PEM format)
static java.lang.String PK_TRUSTED_CERTS
          The property for file name storing trusted certificates (PEM format)
static java.lang.String TM_ALGORITHM
          The property for trust manager algorithm, default "SUNX509"
static java.lang.String TM_PROVIDER
          The property for trust manager provider, default null
static java.lang.String TS_FORMAT
          The property for trust store format, default "file"
static java.lang.String TS_NAME
          The property for trust store name.
static java.lang.String TS_PROVIDER
          The property for trust store provider, default null
static java.lang.String TS_STOREPASS
          The property for trust store password, default null
static java.lang.String TS_TYPE
          The property for trust store type, default "JKS"
 
Constructor Summary
EppSession()
           
 
Method Summary
abstract  void close()
          Closes the EPP Session
abstract  EppGreeting connect(java.lang.String host, int port)
          Connects to the EPP Server and establishs an EPP Session
abstract  EppChannel getChannel()
          Allocates an EPP Channel
 java.lang.Exception getException()
          Gets the last exception received for the EPP Session
 java.lang.String getMessage()
          Gets the last message received for the EPP Session
abstract  EppGreeting hello()
          Sends an EPP Hello message to the EPP Server and returns back with an EppGreeting object
abstract  void init(java.lang.Object object)
          Initializes the run-time parameters related to an EPP Session.
 void setException(java.lang.Exception e)
          Sets the current exception received for the EPP Session
 void setMessage(java.lang.String message)
          Sets the current message received for the EPP Session
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLIENT_AUTH

public static final java.lang.String CLIENT_AUTH
The property for enabling client side authentication, default true

KM_ALGORITHM

public static final java.lang.String KM_ALGORITHM
The property for key manager algorithm, default "SUNX509"

KM_PROVIDER

public static final java.lang.String KM_PROVIDER
The property for key manager provider, default null

KS_TYPE

public static final java.lang.String KS_TYPE
The property for key store type, default "JKS"

KS_PROVIDER

public static final java.lang.String KS_PROVIDER
The property for key store provider, default null

KS_FORMAT

public static final java.lang.String KS_FORMAT
The property for key store format, default "file"

KS_NAME

public static final java.lang.String KS_NAME
The property for key store name. If the key store format is "file", the value of this property is the file name of the key store file.

KS_STOREPASS

public static final java.lang.String KS_STOREPASS
The property for key store password, default null

KS_KEYPASS

public static final java.lang.String KS_KEYPASS
The property for key password for recovering keys, default as the value of the key store password

TM_ALGORITHM

public static final java.lang.String TM_ALGORITHM
The property for trust manager algorithm, default "SUNX509"

TM_PROVIDER

public static final java.lang.String TM_PROVIDER
The property for trust manager provider, default null

TS_TYPE

public static final java.lang.String TS_TYPE
The property for trust store type, default "JKS"

TS_PROVIDER

public static final java.lang.String TS_PROVIDER
The property for trust store provider, default null

TS_FORMAT

public static final java.lang.String TS_FORMAT
The property for trust store format, default "file"

TS_NAME

public static final java.lang.String TS_NAME
The property for trust store name. If the key store format is "file", the value of this property is the file name of the trust store file.

TS_STOREPASS

public static final java.lang.String TS_STOREPASS
The property for trust store password, default null

PK_CIPHER_SUITE

public static final java.lang.String PK_CIPHER_SUITE
The property for cipher suite, default null

PK_PUBLIC_KEY

public static final java.lang.String PK_PUBLIC_KEY
The property for file name storing public key (PEM format)

PK_PRIVATE_KEY

public static final java.lang.String PK_PRIVATE_KEY
The property for file name storing private key (PEM format)

PK_PRIVATE_PASS

public static final java.lang.String PK_PRIVATE_PASS
The property for the passphrease of the file storing private key, default ""

PK_PRIVATE_TYPE

public static final java.lang.String PK_PRIVATE_TYPE
The property for the private key algorithm, default "RSA"

PK_TRUSTED_CERTS

public static final java.lang.String PK_TRUSTED_CERTS
The property for file name storing trusted certificates (PEM format)
Constructor Detail

EppSession

public EppSession()
Method Detail

init

public abstract void init(java.lang.Object object)
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 Element object, if the configuration file is in XML format, or an String 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

getException

public java.lang.Exception getException()
Gets the last exception received for the EPP Session

setException

public void setException(java.lang.Exception e)
Sets the current exception received for the EPP Session

getMessage

public java.lang.String getMessage()
Gets the last message received for the EPP Session

setMessage

public void setMessage(java.lang.String message)
Sets the current message received for the EPP Session

connect

public abstract EppGreeting connect(java.lang.String host,
                                    int port)
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

close

public abstract void close()
Closes the EPP Session

getChannel

public abstract EppChannel getChannel()
Allocates an EPP Channel
Returns:
an EppChannel object, or null if the EPP Channel cannot be allocated

hello

public abstract EppGreeting hello()
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

EPP 0.2.3

Copyright © 2001 NeuStar, Inc. All Rights Reserved.