com.cloudhopper.smpp

Interface SmppServerHandler

public interface SmppServerHandler

Handles events received on an SmppServer. Handles events for processing new bind requests, associating them with sessions, and eventually destroying the sessions. The life cycle of a session is as follows: 1) New socket/channel connected 2) Assigned a sessionId and calls sessionBindRequested 3) If sessionBindRequested is ok, creates a new session, and calls sessionCreated 4) When socket/channel is closed, calls sessionDestroyed

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Method Summary

Methods

Modifier and Type	Method and Description
void	sessionBindRequested(Long sessionId, SmppSessionConfiguration sessionConfiguration, BaseBind bindRequest) Triggered when a new client connection has been created with this server and an SMPP bind request has been received.
void	sessionCreated(Long sessionId, SmppServerSession session, BaseBindResp preparedBindResponse) Triggered when a session is in-between a bound state and a processing state.
void	sessionDestroyed(Long sessionId, SmppServerSession session) Triggered when a session is unbound and closed with the client.

Method Detail

sessionBindRequested

void sessionBindRequested(Long sessionId,
                        SmppSessionConfiguration sessionConfiguration,
                        BaseBind bindRequest)
                          throws SmppProcessingException

Triggered when a new client connection has been created with this server and an SMPP bind request has been received. The bind request can either be a transceiver, receiver, or transmitter. If the bind request should be denied, then an exception should be thrown. The session configuration contains all the information copied directly from the bind request. Any changes required on the session should be made in this method. For example, the name of the session should be changed so that logging statements use the correct name.

Parameters:

sessionId - The unique numeric identifier assigned to the bind request. Will be the same value between sessionBindRequested, sessionCreated, and sessionDestroyed method calls.

sessionConfiguration - The session configuration object that will be associated with this session. Initially prepared to match the values contained in the bind request.

bindRequest - The bind request received from the client.

Throws:

SmppProcessingException - Thrown if the bind fails or should be rejected. If thrown, a bind response with the SMPP status code contained in this exception will be generated and returned back to the client.

sessionCreated

void sessionCreated(Long sessionId,
                  SmppServerSession session,
                  BaseBindResp preparedBindResponse)
                    throws SmppProcessingException

Triggered when a session is in-between a bound state and a processing state. After a new client connection as been successfully passed sessionBindRequested(), a session is created. This session must still have the "serverReady()" method called to actually trigger the final part of a server session.

Parameters:

sessionId - The unique numeric identifier assigned to the bind request. Will be the same value between sessionBindRequested, sessionCreated, and sessionDestroyed method calls.

session - The server session associated with the bind request and underlying channel.

preparedBindResponse - The prepared bind response that will eventually be returned to the client when "serverReady" is finally called on the session.

Throws:

SmppProcessingException - Thrown if the bind fails or should be rejected. If thrown, a bind response with the SMPP status code contained in this exception will be generated and returned back to the client.

sessionDestroyed

void sessionDestroyed(Long sessionId,
                    SmppServerSession session)

Triggered when a session is unbound and closed with the client.

Parameters:

sessionId - The unique numeric identifier assigned to the bind request. Will be the same value between sessionBindRequested, sessionCreated, and sessionDestroyed method calls.

session - The server session associated with the bind request and underlying channel.