Package com.bea.wcp.diameter.cc

Class ClientSession

java.lang.Object

com.bea.wcp.diameter.Session

com.bea.wcp.diameter.cc.ClientSession

All Implemented Interfaces:

Externalizable, Serializable

Direct Known Subclasses:

RoSession

public class ClientSession
extends Session

Diameter credit control application client session. See RFC 4006 for details.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ClientSession()	Used by Externalizable.
ClientSession(Application app)	Creates a new ClientSession for the specified application.
ClientSession(Application app, String id)
ClientSession(Application app, String id, Object parent)

Method Summary

Modifier and Type	Method	Description
CCR	createCCR(RequestType type)	Creates a new credit-control request (CCR) for the specified request type.
void	rcvAnswer(Answer ans)	Receives a credit-control answer (CCA) message for this session.
void	rcvRequest(Request req)	Called by the container when a new request has been received.
void	readExternal(ObjectInput is)
void	sndMessage(Message msg)	Called by the container just before a CCR/CCA message has been sent.
void	writeExternal(ObjectOutput out)

Methods inherited from class com.bea.wcp.diameter.Session

appendXml, createRequest, getAdapter, getApplication, getAttribute, getId, getListener, isTerminated, notifyListener, rcvMessage, removeAttribute, setAdapter, setAttribute, setListener, terminate, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ClientSession

public ClientSession()

Used by Externalizable.

ClientSession

public ClientSession(Application app)

Creates a new ClientSession for the specified application.

ClientSession

public ClientSession(Application app,
 String id)

ClientSession

public ClientSession(Application app,
 String id,
 Object parent)

Method Details

createCCR

public CCR createCCR(RequestType type)

Creates a new credit-control request (CCR) for the specified request type.

Parameters:

type - the credit-control request type

Returns:

the new CCR for this session

sndMessage

public void sndMessage(Message msg)
                throws IOException

Called by the container just before a CCR/CCA message has been sent. Updates the current credit-control state machine accordingly.

Overrides:

sndMessage in class Session

Parameters:

msg - the CCR/CCA message to be sent

Throws:

IOException - if an I/O error occurred while sending the message

IllegalStateException - if the session is terminated, a request is pending, or a request is out of sequence (invalid request number)

rcvRequest

public void rcvRequest(Request req)
                throws DiameterException,
IOException

Called by the container when a new request has been received. Provides handling for ACR requests sent by the server which are then optionally delivered to a session listener if configured for handling.

Overrides:

rcvRequest in class Session

Parameters:

req - the request being received

Throws:

DiameterException - if a protocol error has occurred

IOException - if an I/O error has occurred

rcvAnswer

public void rcvAnswer(Answer ans)
               throws DiameterException,
IOException

Receives a credit-control answer (CCA) message for this session. The session state will be updated according to the CCA request number and type. If the CCA request type is EVENT or TERMINATION, then the session will be automatically terminated.

Overrides:

rcvAnswer in class Session

Parameters:

ans - the CCA message

Throws:

DiameterException - if a protocol error has occurred

IOException - if an I/O error has occurred

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class Session

Throws:

IOException

readExternal

public void readExternal(ObjectInput is)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class Session

Throws:

IOException

ClassNotFoundException