org.jdiameter.client.api.router
Interface IRouter

All Known Subinterfaces:
IRouter
All Known Implementing Classes:
RouterImpl, RouterImpl

public interface IRouter

This class describe Router functionality


Method Summary
 void destroy()
          Release all resources
 IPeer getPeer(IMessage message, IPeerTable manager)
          Return peer from inner peer table by predefined pameters
 java.lang.String getRealmForPeer(java.lang.String fqdn)
          Return realm of peer by fqdn
 java.lang.String[] getRequestRouteInfo(long hopByHopIndentifier)
          Return Request route info
 void registerRequestRouteInfo(IMessage request)
          Register route information by received request.
 void start()
          Start inner time facilities
 void stop()
          Stop inner time facilities
 void updateRedirectInformation(IMessage answer)
          Update redirect information
 

Method Detail

getPeer

IPeer getPeer(IMessage message,
              IPeerTable manager)
              throws org.jdiameter.api.RouteException,
                     org.jdiameter.api.AvpDataException
Return peer from inner peer table by predefined pameters

Parameters:
message - message with routed avps
manager - instance of peer manager
Returns:
peer instance
Throws:
org.jdiameter.api.RouteException
org.jdiameter.api.AvpDataException

getRealmForPeer

java.lang.String getRealmForPeer(java.lang.String fqdn)
Return realm of peer by fqdn

Parameters:
fqdn - host name
Returns:
realm of peer

registerRequestRouteInfo

void registerRequestRouteInfo(IMessage request)
Register route information by received request. This information will be used during answer routing.

Parameters:
request - request

getRequestRouteInfo

java.lang.String[] getRequestRouteInfo(long hopByHopIndentifier)
Return Request route info

Parameters:
hopByHopIndentifier - hop By Hop Indentifier
Returns:
Array (host and realm)

updateRedirectInformation

void updateRedirectInformation(IMessage answer)
                               throws org.jdiameter.api.InternalException,
                                      org.jdiameter.api.RouteException
Update redirect information

Parameters:
answer - redirect answer message
Throws:
org.jdiameter.api.InternalException
org.jdiameter.api.RouteException

start

void start()
Start inner time facilities


stop

void stop()
Stop inner time facilities


destroy

void destroy()
Release all resources



Copyright © 2008. All Rights Reserved.