public abstract class EPPEnv extends Environment
Modifier and Type | Field and Description |
---|---|
static int |
LOG_BASIC
Basic log mode.
|
static int |
LOG_CFG_FILE
Log4J configuration file mode.
|
static int |
LOG_CUSTOM
Custom logging mode.
|
static java.lang.String |
POOLMAN_CLIENT_PREFIX
Prefix for PoolMan Client
|
static java.lang.String |
POOLMAN_SERVER_PREFIX
Prefix for PoolMan Server
|
static java.lang.String |
POOLMAN_XMLSIGNATURE_PREFIX
Prefix for PoolMan XML Signature
|
properties
Constructor and Description |
---|
EPPEnv() |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
getClientHost()
Gets the client host name / IP address to connect from.
|
static boolean |
getClientParserDebug()
PoolMan Client Option.
|
static int |
getClientParserInitObjs()
PoolMan Client Option.
|
static java.lang.String |
getClientParserLogFile()
PoolMan Client Option.
|
static int |
getClientParserMaxSize()
PoolMan Client Option.
|
static boolean |
getClientParserMaxSoft()
PoolMan Client Option.
|
static int |
getClientParserMinSize()
PoolMan Client Option.
|
static int |
getClientParserObjTimeout()
PoolMan Client Option.
|
static int |
getClientParserShrinkBy()
PoolMan Client Option.
|
static int |
getClientParserSkimmerFreq()
PoolMan Client Option.
|
static int |
getClientParserUserTimeout()
PoolMan Client Option.
|
static java.lang.String |
getClientSocketName()
Returns the value of the EPP.ClientSocketName property specified in the
config file.
|
static java.util.Vector |
getCmdResponseExtensions()
Returns a vector of class names that are CommandResponseExtensions.
|
static int |
getConTimeOut()
Returns the connection timeout in number of seconds specified by the
EPP.ConTimeOut property in the config file.
|
static boolean |
getFullSchemaChecking()
Gets if FullSchemaChecking is enabled on the Xerces Parser instance.
|
static java.lang.String |
getGreetingServerName()
Gets the server name to use in the EPP greeting.
|
static java.lang.String |
getKeyStore()
SSL Socket Option.
|
static java.lang.String |
getLogCfgFile()
Returns the value of the EPP.LogCfgFile property specified in the config
file.
|
static java.lang.Long |
getLogCfgFileWatch()
Returns the value of the EPP.LogCfgFileWatch property specified in the
config file.
|
static java.lang.String |
getLogFile()
Returns the value of the EPP.LogFile property specified in the config
file.
|
static EPPLoginAdapter |
getLoginAdapter()
Get the
EPPLoginAdapter based on the optional "EPP.LoginAdapter"
property. |
static org.apache.log4j.Level |
getLogLevel()
Returns the value of the EPP.LogLevel property specified in the config
file.
|
static int |
getLogMode()
Returns the log facility mode defined by the EPP.LogMode configuration
parameter.
|
static java.util.Vector |
getMapFactories()
Returns a vector of class names that are factories for each EPP Mapping.
|
static java.util.Vector |
getPollHandlers()
Returns a vector of class names that are factories for each EPP Mapping.
|
static EPPPollMessageFilter |
getPollMessageFilter()
Get the
EPPPollMessageFilter based on the optional
"EPP.PollMessageFilter" property. |
static java.util.Vector |
getProtocolExtensions()
Returns a vector of class names that are ProtocolExtensions.
|
static java.lang.String |
getProxyServerLocator()
Gets the proxy server locator
Class as a String as defined
by the EPP.ProxyServersLcoator property. |
static java.lang.String |
getProxyServers()
Returns the list of proxy servers defined by the EPP.ProxyServers
property.
|
static boolean |
getProxyServersRandomize()
Returns whether not to randomize the proxy servers connected through.
|
static java.util.List<java.lang.String> |
getRegistryPolicyAdapters()
Returns a list of Registry Policy Adapter class names using the
"EPP.RegistryPolicyAdapters" property, which each must implement the
com.verisign.epp.framework.EPPRegistryPolicyAdapter class. |
static java.lang.String |
getSDKVersion()
Returns the value of the
EPP.SDKVersion property specified in the
epp.config file. |
static EPPSendReceiveLogger |
getSendReceiveLogger()
Get the
EPPSendReceiveLogger to use for logging packets being sent
or received. |
static java.lang.String |
getServerEPPAssembler()
Returns a vector of class names that are factories for each EPP Mapping.
|
static java.util.Vector |
getServerEventHandlers()
Returns a vector of class names that are factories for each EPP Mapping.
|
static java.lang.String |
getServerName()
Returns the value of the EPP.ServerName property specified in the config
file.
|
static boolean |
getServerParserDebug()
PoolMan Server Option.
|
static int |
getServerParserInitObjs()
PoolMan Server Option.
|
static java.lang.String |
getServerParserLogFile()
PoolMan Server Option.
|
static int |
getServerParserMaxSize()
PoolMan Server Option.
|
static boolean |
getServerParserMaxSoft()
PoolMan Server Option.
|
static int |
getServerParserMinSize()
PoolMan Server Option.
|
static int |
getServerParserObjTimeout()
PoolMan Server Option.
|
static int |
getServerParserShrinkBy()
PoolMan Server Option.
|
static int |
getServerParserSkimmerFreq()
PoolMan Server Option.
|
static int |
getServerParserUserTimeout()
PoolMan Server Option.
|
static int |
getServerPort()
Returns the value of the EPP.ServerPort property specified in the config
file.
|
static java.lang.String |
getServerSocketName()
Returns the value of the EPP.ServerSocketName property specified in the
config file.
|
static java.lang.String |
getSSLDebug()
Gets the SSL debug setting with the default of "none".
|
static java.lang.String[] |
getSSLEnabledCipherSuites()
Gets the optional SSL enabled cipher suites
|
static java.lang.String[] |
getSSLEnabledProtocols()
SSL Socket Option.
|
static java.lang.String |
getSSLKeyFileName()
SSL Socket Option.
|
static java.lang.String |
getSSLKeyManager()
Deprecated.
With change to JDK 1.4
|
static java.lang.String |
getSSLKeyPassPhrase()
SSL Socket Option.
|
static java.lang.String |
getSSLPassPhrase()
SSL Socket Option.
|
static java.lang.String |
getSSLProtocol()
SSL Socket Option.
|
static java.lang.String |
getSSLTrustStoreFileName()
Gets the SSL trust store file name.
|
static java.lang.String |
getSSLTrustStorePassPhrase()
Gets the SSL trust store passphrase.
|
static boolean |
getValidating()
Gets if XML Schema Validation is enabled.
|
static boolean |
getXMLSignatureParserDebug()
PoolMan XML Signature Option.
|
static int |
getXMLSignatureParserInitObjs()
PoolMan XML Signature Option.
|
static java.lang.String |
getXMLSignatureParserLogFile()
PoolMan XML Signature Option.
|
static int |
getXMLSignatureParserMaxSize()
PoolMan XML Signature Option.
|
static boolean |
getXMLSignatureParserMaxSoft()
PoolMan XML Signature Option.
|
static int |
getXMLSignatureParserMinSize()
PoolMan XML Signature Option.
|
static int |
getXMLSignatureParserObjTimeout()
PoolMan XML Signature Option.
|
static int |
getXMLSignatureParserShrinkBy()
PoolMan XML Signature Option.
|
static int |
getXMLSignatureParserSkimmerFreq()
PoolMan XML Signature Option.
|
static int |
getXMLSignatureParserUserTimeout()
PoolMan XML Signature Option.
|
void |
initialize(java.lang.String aConfigFileName)
Initialize the environment
|
void |
initialize(java.lang.String aConfigFileName,
java.lang.ClassLoader aClassLoader)
Initialize the environment
|
static boolean |
isContactRelaxedValidation()
Checks if relaxed contact validation is enabled or not.
|
static boolean |
isUseEntityResolver()
Checks if use of the entity resolver is enabled or not.
|
static boolean |
isUseUserAgent()
Checks if inclusion of the login security extension user agent is enabled
or not.
|
envInitialize, envInitialize, getEnv, getOption, getProperty, getProperty, setProperties, setProperty
public static final int LOG_BASIC
public static final int LOG_CFG_FILE
public static final int LOG_CUSTOM
public static final java.lang.String POOLMAN_SERVER_PREFIX
public static final java.lang.String POOLMAN_XMLSIGNATURE_PREFIX
public static final java.lang.String POOLMAN_CLIENT_PREFIX
public void initialize(java.lang.String aConfigFileName, java.lang.ClassLoader aClassLoader) throws EPPEnvException
aConfigFileName
- The config file read value pairs fromaClassLoader
- Java ClassLoader
to load the configuration fileEPPEnvException
- Error initializing the configuration settingspublic void initialize(java.lang.String aConfigFileName) throws EPPEnvException
aConfigFileName
- The configuration file to read fromEPPEnvException
- Error initializing the configuration settingspublic static java.lang.String getClientHost()
null
otherwisepublic static java.lang.String getServerName() throws EPPEnvException
EPPEnvException
- The "EPP.ServerName" property does not exist.public static java.lang.String getGreetingServerName()
"EPP Server Stub"
otherwise.public static int getServerPort() throws EPPEnvException
int
value for the propertyEPPEnvException
- The "EPP.ServerPort" property does not exist.public static int getConTimeOut() throws EPPEnvException
EPPEnvException
- The "EPP.ConTimeOut" property does not exist.public static java.lang.String getProxyServerLocator() throws EPPEnvException
Class
as a String
as defined
by the EPP.ProxyServersLcoator
property.Class
as a String
EPPEnvException
- The "EPP.ProxyServersLocator" property does not exist.public static java.lang.String getProxyServers() throws EPPEnvException
EPPEnvException
- The "EPP.ProxyServers" property does not exist.public static boolean getProxyServersRandomize() throws EPPEnvException
EPP.ProxyServersRandomize
configuration property is used and if it
is not set the default value of true
is returned.true
to randomize;false
otherwise.EPPEnvException
- The "EPP.ProxyServersRandomizes" property does not exist.public static java.lang.String getClientSocketName() throws EPPEnvException
EPPEnvException
- The "EPP.ClientSocketName" property does not exist.public static int getLogMode()
LOG_
constants if valid EPP.LogMode setting; -1 otherwise.public static org.apache.log4j.Level getLogLevel() throws EPPEnvException
initialize
will validate this condition.null
otherwiseEPPEnvException
- Invalid configuration parameter valuepublic static java.lang.String getLogFile() throws EPPEnvException
initialize
will validate this condition.null
otherwiseEPPEnvException
- The "EPP.LogFile" property does not exist.public static java.lang.String getLogCfgFile() throws EPPEnvException
initialize
will validate this condition.null
otherwiseEPPEnvException
- The "EPP.LogCfgFile" property does not exist.public static java.lang.Long getLogCfgFileWatch() throws EPPEnvException
null
otherwiseEPPEnvException
- Error with the "EPP.LogCfgFileWatch" property.public static java.lang.String getServerSocketName() throws EPPEnvException
EPPEnvException
- Error with "EPP.ServerSocketName" property.public static java.util.Vector getMapFactories() throws EPPEnvException
Vector
of fully qualified EPPMapFactory
class
Strings
.EPPEnvException
- Error with "EPP.MapFactories" property.public static java.util.Vector getProtocolExtensions() throws EPPEnvException
Vector
of fully qualified EPPProtocolExtension
class Strings
.EPPEnvException
- Error with "EPP.ProtocolExtensions" property.public static java.util.Vector getCmdResponseExtensions() throws EPPEnvException
Vector
of fully qualified EPPCmdRspExtensions
class Strings
.EPPEnvException
- Error with "EPP.CmdRspExtensions" property.public static java.util.Vector getServerEventHandlers() throws EPPEnvException
Vector
of fully qualified EPPMapFactory
class
Strings
.EPPEnvException
- Error with "EPP.ServerEventHandlers" property.public static java.lang.String getServerEPPAssembler()
Vector
of fully qualified EPPMapFactory
class
Strings
.public static java.lang.String getSSLProtocol()
public static java.lang.String[] getSSLEnabledProtocols()
String
array of protocols if defined; null
otherwisepublic static java.lang.String getSSLKeyManager()
public static java.lang.String getKeyStore()
public static java.lang.String getSSLKeyFileName()
public static java.lang.String getSSLTrustStoreFileName()
null
otherwise.public static java.lang.String getSSLTrustStorePassPhrase()
null
otherwise.public static java.lang.String getSSLDebug()
public static java.lang.String[] getSSLEnabledCipherSuites()
>String
array if defined; null
otherwise.public static java.lang.String getSSLPassPhrase()
public static java.lang.String getSSLKeyPassPhrase()
public static int getServerParserInitObjs()
public static int getServerParserMinSize()
public static int getServerParserMaxSize()
public static boolean getServerParserMaxSoft()
public static int getServerParserObjTimeout()
public static int getServerParserUserTimeout()
public static int getServerParserSkimmerFreq()
public static int getServerParserShrinkBy()
public static java.lang.String getServerParserLogFile()
public static boolean getServerParserDebug()
public static int getXMLSignatureParserInitObjs()
public static int getXMLSignatureParserMinSize()
public static int getXMLSignatureParserMaxSize()
public static boolean getXMLSignatureParserMaxSoft()
public static int getXMLSignatureParserObjTimeout()
public static int getXMLSignatureParserUserTimeout()
public static int getXMLSignatureParserSkimmerFreq()
public static int getXMLSignatureParserShrinkBy()
public static java.lang.String getXMLSignatureParserLogFile()
public static boolean getXMLSignatureParserDebug()
public static int getClientParserInitObjs()
public static int getClientParserMinSize()
public static int getClientParserMaxSize()
public static boolean getClientParserMaxSoft()
public static int getClientParserObjTimeout()
public static int getClientParserUserTimeout()
public static int getClientParserSkimmerFreq()
public static int getClientParserShrinkBy()
public static java.lang.String getClientParserLogFile()
public static boolean getClientParserDebug()
public static java.util.Vector getPollHandlers() throws EPPEnvException
Vector
of fully qualified EPPPollHandler
class
Strings
.EPPEnvException
- Error with "EPP.PollHandlers" property.public static boolean getValidating()
false
,
but this can be changed by setting the EPP.Validating
property.true
to enable XML Schema Validation; false
otherwise.public static boolean getFullSchemaChecking()
false
, but
this can be changed by setting the EPP.FullSchemaChecking
property.true
to enable Full XML Schema Checking; false
otherwise.public static boolean isContactRelaxedValidation()
false
, but this can be changed by setting the
EPP.Contact.RelaxedValidation
property.true
to enable relaxed contact validations; false
otherwise.public static boolean isUseEntityResolver()
EPPSchemaCachingEntityResolver
will be
set in the XML parsers and will dynamically load XML schemas that have not
already been loaded. If the entity resolver is not enabled, only the XML
schemas pre-loaded will be included in the XML parsing. The default is
true
, but this can be changed by setting the
EPP.UseEntityResolver
property.true
to enable use of the entity resolver; false
otherwise.public static EPPSendReceiveLogger getSendReceiveLogger()
EPPSendReceiveLogger
to use for logging packets being sent
or received. The default is to use EPPRawSendReceiveLogger
if not
overridden with the "EPP.SendReceiveLogger" property.EPPSendReceiveLogger
instance to use with the default of
EPPRawSendReceiveLogger
.public static EPPLoginAdapter getLoginAdapter()
EPPLoginAdapter
based on the optional "EPP.LoginAdapter"
property. If the property is not set, there will be no assigned
EPPLoginAdapter
.EPPLoginAdapter
instance to use when establishing an
EPPSession
if defined; null
otherwise.public static boolean isUseUserAgent()
true
, but this can be changed by setting
the EPP.UseUserAgent
property to false
.true
to enable use of the login security extension user
agent; false
otherwise.public static java.lang.String getSDKVersion()
EPP.SDKVersion
property specified in the
epp.config file.EPP.SDKVersion
property if defined;
null
otherwise.public static EPPPollMessageFilter getPollMessageFilter()
EPPPollMessageFilter
based on the optional
"EPP.PollMessageFilter" property. If the property is not set, there will
be no assigned EPPPollMessageFilter
.EPPPollMessageFilter
instance to use returning poll
messages based on the client login services.public static java.util.List<java.lang.String> getRegistryPolicyAdapters()
com.verisign.epp.framework.EPPRegistryPolicyAdapter
class.com.verisign.epp.framework.EPPRegistryPolicyAdapter
class
names if defined; null
otherwise.