com.ibm.etill.framework.admin
Class PayServer

java.lang.Object
  |
  +--com.ibm.etill.framework.admin.AdminObject
        |
        +--com.ibm.etill.framework.admin.PayServer
All Implemented Interfaces:
Archivable, PSServerAdminConstants

public abstract class PayServer
extends AdminObject

PayServer represents the Commerce Payments instance. Only one of these objects will exist in a given Commerce Payments. Cassettes MAY NOT augment this object with their own properties and cassettes should NOT extend this class.


Fields inherited from interface com.ibm.etill.framework.xdm.PSServerAdminConstants
COL_ACTIVE, COL_ENABLED, COL_MESSAGESKEY, COL_PENDING, COL_VALID
 
Constructor Summary
PayServer()
           
 
Method Summary
 int getAdminAPIPort()
          Deprecated. All commands should be directed to the Payment Servlet using the HTTP-based API set.
 int getEngineAPIport()
          Deprecated. Commerce Payments does not use sockets to communicate with the engine any more.
 int getErrorLogPort()
          Deprecated. No replacement.
 String getETillHostname()
          Returns the IP hostname of the machine on which this Commerce Payments instance is running.
 String getFullLogPathDirectory()
          Deprecated. Cassettes should no longer use this method. All message and trace records will be written using WebSphere Application Server facilities and the location of these files is configurable using the WebSphere Application Server administrators console. This method will always return null.
 String getLogPath()
          Deprecated. Cassettes should no longer use this method. All message and trace records will be written using WebSphere Application Server facilities and the location of these files is configurable using the WebSphere Application Server administrators console. This method will always return null.
 int getPaymentAPIport()
          Deprecated. All commands should be directed to the Payment Servlet using the HTTP-based API set.
 String getTillName()
          Deprecated. No replacement
 long getTraceFileSize()
          Deprecated. Cassettes should no longer use this method. Trace settings are now controlled by the WebSphere Application Server trace facility. This method will always return zero.
 int getTraceSetting()
          Deprecated. Cassettes should no longer use this method. Trace settings are now controlled by the WebSphere Application Server trace facility. This method will always return zero.
 String getUserExitPassThru()
          Deprecated. No replacement.
 String toString()
          Returns a string representation of this account object for tracing purposes.
 
Methods inherited from class com.ibm.etill.framework.admin.AdminObject
addCassetteMessage, addFrameworkMessage, getActive, getEnabled, getInvalidList, getPending, processConfigurationChanges, processExtension, setActive, setEnabled, setEnabled, setPending, startObject, stopObject, validateExtension
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.etill.framework.archive.Archivable
createRecord, deleteRecord, updateRecord
 

Constructor Detail

PayServer

public PayServer()
Method Detail

toString

public String toString()
Returns a string representation of this account object for tracing purposes.
Overrides:
toString in class AdminObject
Returns:
String - a string representation of the key elements of this account object.

getETillHostname

public String getETillHostname()
Returns the IP hostname of the machine on which this Commerce Payments instance is running.
Returns:
String - the hostname

getEngineAPIport

public int getEngineAPIport()
Deprecated. Commerce Payments does not use sockets to communicate with the engine any more.

Returns the TCP port on which the Payment Engine is listening for new API commands.
Returns:
int - the configured API port

getTraceSetting

public int getTraceSetting()
Deprecated. Cassettes should no longer use this method. Trace settings are now controlled by the WebSphere Application Server trace facility. This method will always return zero.

Returns the currently configured trace setting for the Commerce Payments Framework.
Returns:
int - the current trace setting

getTraceFileSize

public long getTraceFileSize()
Deprecated. Cassettes should no longer use this method. Trace settings are now controlled by the WebSphere Application Server trace facility. This method will always return zero.

Returns the currently configured trace file size
Returns:
int - the current trace file size in bytes

getLogPath

public String getLogPath()
Deprecated. Cassettes should no longer use this method. All message and trace records will be written using WebSphere Application Server facilities and the location of these files is configurable using the WebSphere Application Server administrators console. This method will always return null.

Returns the directory path into which the the Commerce Payments' log files are currently being written. These files are only written if tracing is active.
Returns:
String - the currently configured logfile path

getFullLogPathDirectory

public String getFullLogPathDirectory()
Deprecated. Cassettes should no longer use this method. All message and trace records will be written using WebSphere Application Server facilities and the location of these files is configurable using the WebSphere Application Server administrators console. This method will always return null.

Returns the fully qualified directory path into which the the Commerce Payments' log files are currently being written. These files are only written if tracing is active.
Returns:
String - the fully qualified logfile path

getTillName

public String getTillName()
Deprecated. No replacement

Returns the "tillName" as currently configured in the ETILLCONFIG table. This field is maintained for historical reasons only and may be removed in the future.
Returns:
String - the tillName

getAdminAPIPort

public int getAdminAPIPort()
Deprecated. All commands should be directed to the Payment Servlet using the HTTP-based API set.

Returns the administration API port from the ETILLCONFIG table. This field is maintained for historical reasons only and may be removed in the future.
Returns:
int - the administration port

getPaymentAPIport

public int getPaymentAPIport()
Deprecated. All commands should be directed to the Payment Servlet using the HTTP-based API set.

Returns the payment API port from the ETILLCONFIG table. This field is maintained for historical reasons only and may be removed in the future.
Returns:
int - the payment port

getErrorLogPort

public int getErrorLogPort()
Deprecated. No replacement.

Returns the errorlog port from the ETILLCONFIG table. This field is maintained for historical reasons only and may be removed in the future.
Returns:
int - the errorlog port

getUserExitPassThru

public String getUserExitPassThru()
Deprecated. No replacement.

Returns the UserExitPassthru value from the ETILLCONFIG table. This field is maintained for historical reasons only and may be removed in the future.
Returns:
this method always returns empty String