org.jdiameter.api
Class Realm

java.lang.Object
  org.jdiameter.api.Realm

public abstract class Realm
extends java.lang.Object

The Realm class implements rows in the Diameter Realm routing table.

Version:

1.5.1 Final

Field Summary

protected LocalAction	action
protected ApplicationId	appId
protected boolean	dynamic
protected long	expirationTime
protected java.lang.String	name

Constructor Summary

protected

Realm(java.lang.String name, ApplicationId appId, LocalAction action, boolean dynamic, long expirationTime)

Method Summary

abstract void	addPeerName(java.lang.String host) Append new host (peer) to this realm
ApplicationId	getApplicationId() Return applicationId associated with this realm
long	getExpirationTime() Return expiration time for this realm in milisec
LocalAction	getLocalAction() Return realm local action for this realm
java.lang.String	getName() Return name of this realm
abstract java.lang.String[]	getPeerHosts() Return list of real peers
boolean	isDynamic() Return true if this realm is dynamic updated
abstract void	removePeerName(java.lang.String host) Remove peer from this realm

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

appId

protected ApplicationId appId

action

protected LocalAction action

dynamic

protected boolean dynamic

expirationTime

protected long expirationTime

Constructor Detail

Realm

protected Realm(java.lang.String name,
                ApplicationId appId,
                LocalAction action,
                boolean dynamic,
                long expirationTime)

Method Detail

getName

public java.lang.String getName()

Return name of this realm

Returns:

name

getApplicationId

public ApplicationId getApplicationId()

Return applicationId associated with this realm

Returns:

applicationId

getLocalAction

public LocalAction getLocalAction()

Return realm local action for this realm

Returns:

realm local action

getPeerHosts

public abstract java.lang.String[] getPeerHosts()

Return list of real peers

Returns:

array of realm peers

addPeerName

public abstract void addPeerName(java.lang.String host)

Append new host (peer) to this realm

Parameters:

host - name of peer host

removePeerName

public abstract void removePeerName(java.lang.String host)

Remove peer from this realm

Parameters:

host - name of peer host

isDynamic

public boolean isDynamic()

Return true if this realm is dynamic updated

Returns:

true if this realm is dynamic updated

getExpirationTime

public long getExpirationTime()

Return expiration time for this realm in milisec

Returns:

expiration time