Skip navigation links

com.bea.wlcp.wlng.plugin.payment.diameter.management
Interface PaymentMBean

public interface PaymentMBean

MBean interface for the example traffic path.

Field Summary

static String	chargingChannel OneAPI charging channels.
static boolean	connected True if the Node is connected.
static String	destinationAddresses The destination addresses separated by comma, in the format of <host>:<port>.
static String	destinationRealm Diameter Destination-Realm value.
static String	domain Service-Context-Id AVP's domain.
static boolean	includeXParamAVPListInResponse If true, the AVP-list in the response from charging server will be forwarded as an xparam in response to application.
static String	originHost Diameter Origin-Host value.
static int	originPort Plug-in node port value.
static String	originRealm Diameter Origin-Realm value.
static boolean	queryEnabled True to enable a OneAPI query.
static String	serviceContext Service-Context-Id AVP's service-context.
static boolean	splitChargeEnabled True to enable Volume Split Charging.

Method Summary

void	connect() Connects to the Diameter server.
void	disconnect() Disconnects from the Diameter server.
String	getChargingChannel() Returns the OneAPI charging channels.
String	getDestinationAddresses() Returns the Diameter server host addresses.
String	getDestinationRealm() Returns the Destination-Realm AVP in Diameter requests.
String	getDomain() Returns the Service-Context ID AVP.
String	getOriginHost() Returns the Origin-Host value in Diameter requests.
int	getOriginPort() Returns the local originator port to be used for the connection to the Diameter server.
String	getOriginRealm() Returns the Origin-Realm value in Diameter requests.
String	getServiceContext()
boolean	isConnected() Returns the status of the connection to the Diameter server, true if connected, false if not.
boolean	isIncludeXParamAVPListInResponse()
boolean	isQueryEnabled() Returns true if OneAPI queries are enabled, otherwise false.
boolean	isSplitChargeEnabled() Returns true Volume Split Charging is enabled, otherwise false.
void	setChargingChannel(String value) Sets the OneAPI charging channels.
void	setDestinationAddresses(String addresses) Sets the Diameter server host addresses.
void	setDestinationRealm(String value) Sets the the Destination-Realm AVP in Diameter requests.
void	setDomain(String value) Sets the Service-Context ID AVP.
void	setIncludeXParamAVPListInResponse(boolean value)
void	setOriginHost(String value) Sets the Origin-Host value in Diameter requests.
void	setOriginPort(int value) Sets the local originator port to be used for the connection to the Diameter server.
void	setOriginRealm(String value) Sets the Origin-Realm value in Diameter requests.
void	setQueryEnabled(boolean value) If true, OneAPI queries are enabled, if false, disabled.
void	setServiceContext(String value)
void	setSplitChargeEnabled(boolean value) If true, Volume Split Charging is enabled, if false, disabled.

Field Detail

chargingChannel

public static final String chargingChannel

OneAPI charging channels. Valid values are WAP, WEB, and SMS.

Scope: Cluster

See Also:

Constant Field Values

connected

public static final boolean connected

True if the Node is connected. False if not.

Scope: Cluster

See Also:

Constant Field Values

destinationAddresses

public static final String destinationAddresses

The destination addresses separated by comma, in the format of <host>:<port>.

Scope: Cluster

See Also:

Constant Field Values

destinationRealm

public static final String destinationRealm

Diameter Destination-Realm value.

Scope: Cluster

See Also:

Constant Field Values

domain

public static final String domain

Service-Context-Id AVP's domain. The default value is 'oracle.com'.

Scope: Cluster

See Also:

Constant Field Values

includeXParamAVPListInResponse

public static final boolean includeXParamAVPListInResponse

If true, the AVP-list in the response from charging server will be forwarded as an xparam in response to application. The xparam key name is AVP_LIST. Because of the complex structure of AVPs, the list is encoded into a XML string. Example:

 <Avp-List>    
   <Session-Id Flags="64">192.168.1.22;1417686781;1</Session-Id>    
   <Origin-Host Flags="64">127.0.0.1</Origin-Host>    
   <Origin-Realm Flags="64">destination.com</Origin-Realm>    
   <Result-Code Flags="64">2001</Result-Code>    
   <CC-Request-Type Flags="64">4</CC-Request-Type>    
   <CC-Request-Number Flags="64">0</CC-Request-Number>  
 </Avp-List>
 

Scope: Cluster

See Also:

Constant Field Values

originHost

public static final String originHost

Diameter Origin-Host value.

Scope: Server

See Also:

Constant Field Values

originPort

public static final int originPort

Plug-in node port value.

Scope: Server

See Also:

Constant Field Values

originRealm

public static final String originRealm

Diameter Origin-Realm value.

Scope: Server

See Also:

Constant Field Values

queryEnabled

public static final boolean queryEnabled

True to enable a OneAPI query.

Scope: Cluster

See Also:

Constant Field Values

serviceContext

public static final String serviceContext

Service-Context-Id AVP's service-context. If set as null or an empty string, the charge.code of ParlayX request will be used.

Scope: Cluster

See Also:

Constant Field Values

splitChargeEnabled

public static final boolean splitChargeEnabled

True to enable Volume Split Charging.

Scope: Cluster

See Also:

Constant Field Values

Method Detail

connect

public void connect()
             throws ManagementException

Connects to the Diameter server. Once connected, the plug-in will try to reconnect to the Diameter server if the server is restarted or the plug-in is redeployed.

Scope: Server

Throws:

ManagementException

disconnect

public void disconnect()

Disconnects from the Diameter server. Once disconnected, the plug-in will not try to reconnect to the Diameter server if the server is restarted or the plug-in is redeployed.

Scope: Cluster

getChargingChannel

public String getChargingChannel()
                          throws ManagementException

Returns the OneAPI charging channels.

Scope: Cluster

Returns:

OneAPI charging channel

Throws:

ManagementException

getDestinationAddresses

public String getDestinationAddresses()
                               throws ManagementException

Returns the Diameter server host addresses.

Scope: Cluster

Returns:

host address of Diameter server

Throws:

ManagementException

getDestinationRealm

public String getDestinationRealm()
                           throws ManagementException

Returns the Destination-Realm AVP in Diameter requests.

Scope: Cluster

Returns:

Destination-Realm AVP

Throws:

ManagementException

getDomain

public String getDomain()
                 throws ManagementException

Returns the Service-Context ID AVP. The default value is 'oracle.com'.

Scope: Cluster

Returns:

Service-Context ID AVP

Throws:

ManagementException

getOriginHost

public String getOriginHost()
                     throws ManagementException

Returns the Origin-Host value in Diameter requests.

Scope: Server

Returns:

Origin-Host value

Throws:

ManagementException

getOriginPort

public int getOriginPort()
                  throws ManagementException

Returns the local originator port to be used for the connection to the Diameter server.

Scope: Server

Returns:

local originator port

Throws:

ManagementException

getOriginRealm

public String getOriginRealm()
                      throws ManagementException

Returns the Origin-Realm value in Diameter requests.

Scope: Server

Returns:

Origin-Realm value

Throws:

ManagementException

getServiceContext

public String getServiceContext()
                         throws ManagementException

Throws:

ManagementException

isConnected

public boolean isConnected()
                    throws ManagementException

Returns the status of the connection to the Diameter server, true if connected, false if not.

Scope: Cluster

Returns:

true if connected to the Diameter server, otherwise false

Throws:

ManagementException

isIncludeXParamAVPListInResponse

public boolean isIncludeXParamAVPListInResponse()
                                         throws ManagementException

Throws:

ManagementException

isQueryEnabled

public boolean isQueryEnabled()
                       throws ManagementException

Returns true if OneAPI queries are enabled, otherwise false.

Scope: Cluster

Returns:

true if OneAPI queries enabled, false if disabled

Throws:

ManagementException

isSplitChargeEnabled

public boolean isSplitChargeEnabled()
                             throws ManagementException

Returns true Volume Split Charging is enabled, otherwise false.

Scope: Cluster

Returns:

true if Volume Split Charging is enabled, false if disabled

Throws:

ManagementException

setChargingChannel

public void setChargingChannel(String value)
                        throws ManagementException

Sets the OneAPI charging channels. Channels are specified as a comma delimited list. Example values are WAP, WEB, and SMS.

Scope: Cluster

Parameters:

value - OneAPI charging channel

Throws:

ManagementException

setDestinationAddresses

public void setDestinationAddresses(String addresses)
                             throws ManagementException

Sets the Diameter server host addresses. Addresses are specified in a comma delimited list. Example:
host.destination1.com:3588,host.destination2.com:3588

Scope: Cluster

Parameters:

addresses - host addresses of Diameter servers

Throws:

ManagementException

setDestinationRealm

public void setDestinationRealm(String value)
                         throws ManagementException

Sets the the Destination-Realm AVP in Diameter requests. Example:
destination.com

Scope: Cluster

Parameters:

value - Destination-Realm AVP

Throws:

ManagementException

setDomain

public void setDomain(String value)
               throws ManagementException

Sets the Service-Context ID AVP. The default value is 'oracle.com'.

Scope: Cluster

Parameters:

value - Service-Context ID AVP

Throws:

ManagementException

setIncludeXParamAVPListInResponse

public void setIncludeXParamAVPListInResponse(boolean value)
                                       throws ManagementException

Throws:

ManagementException

setOriginHost

public void setOriginHost(String value)
                   throws ManagementException

Sets the Origin-Host value in Diameter requests. Example:
host.oracle.com

Scope: Server

Parameters:

value - Origin-Host AVP

Throws:

ManagementException

setOriginPort

public void setOriginPort(int value)
                   throws ManagementException

Sets the local originator port to be used for the connection to the Diameter server. Example:
7002

Scope: Server

Parameters:

value - local originator port

Throws:

ManagementException

setOriginRealm

public void setOriginRealm(String value)
                    throws ManagementException

Sets the Origin-Realm value in Diameter requests. Example:
oracle.com

Scope: Server

Parameters:

value - Origin-Realm value

Throws:

ManagementException

setQueryEnabled

public void setQueryEnabled(boolean value)
                     throws ManagementException

If true, OneAPI queries are enabled, if false, disabled.

Scope: Cluster

Parameters:

value - true if OneAPI queries enabled, false if disabled

Throws:

ManagementException

setServiceContext

public void setServiceContext(String value)
                       throws ManagementException

Throws:

ManagementException

setSplitChargeEnabled

public void setSplitChargeEnabled(boolean value)
                           throws ManagementException

If true, Volume Split Charging is enabled, if false, disabled.

Scope: Cluster

Parameters:

value - true if Volume Split Charging is enabled, false if disabled

Throws:

ManagementException

Skip navigation links