JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000

jain.protocol.ip.mgcp.message.parms
Class NotifiedEntity

java.lang.Object
  |
  +--jain.protocol.ip.mgcp.message.parms.NotifiedEntity
All Implemented Interfaces:
java.io.Serializable

public final class NotifiedEntity
extends java.lang.Object
implements java.io.Serializable

Specifies where notifications should be sent.

See Also:
Serialized Form

Constructor Summary
NotifiedEntity(java.lang.String domainName)
          Constructs a new Notified Entity object.
NotifiedEntity(java.lang.String localName, java.lang.String domainName)
          Constructs a new Notified Entity object.

NotifiedEntity(java.lang.String localName, java.lang.String domainName, int portNumber)
          Constructs a new Notified Entity object.

 
Method Summary
 java.lang.String getDomainName()
          Gets the Domain Name of the Notified Entity.

 java.lang.String getLocalName()
          Gets the Local Name of the Notified Entity.

 int getPortNumber()
          Gets the Port Number of the Notified Entity.

 java.lang.String toString()
          Gets the complete Notified Entity string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NotifiedEntity

public NotifiedEntity(java.lang.String domainName)
               throws java.lang.IllegalArgumentException
Constructs a new Notified Entity object. Local Name is assumed to be null and port number is implicitly set to the default value of 2427.

Parameters:
domainName - A string that designates the Domain Name of the notified entity. Must be non-null and must conform to RFC 821 syntax.
Throws:
java.lang.IllegalArgumentException - Thrown if the Domain Name is null or does not conform to RFC 821 syntax.

NotifiedEntity

public NotifiedEntity(java.lang.String localName,
                      java.lang.String domainName)
               throws java.lang.IllegalArgumentException
Constructs a new Notified Entity object.

Parameters:
localName - A string that designates the Local Name of the notified entity. Must be non-null and must conform to RFC 2705 syntax for a Local Name.
domainName - A string that designates the Domain Name of the notified entity. Must be non-null and must conform to RFC 821 syntax.
Throws:
java.lang.IllegalArgumentException - Thrown if either parameter is null or if either parameter does not conform to the syntax as defined in the appropriate RFC.

NotifiedEntity

public NotifiedEntity(java.lang.String localName,
                      java.lang.String domainName,
                      int portNumber)
               throws java.lang.IllegalArgumentException
Constructs a new Notified Entity object.

Parameters:
localName - A string that designates the Local Name of the notified entity. Must be non-null and must conform to RFC 2705 syntax for a Local Name.
domainName - A string that designates the Domain Name of the notified entity. Must be non-null and must conform to RFC 821 syntax.
portNumber - The port number on the notified entity. Must be a positive integer from 1 through 5 digits in length.
Throws:
java.lang.IllegalArgumentException - Thrown if either parameter is null or if either parameter does not conform to the syntax as defined in the appropriate RFC or if the port number is not a positive integer from 1 through 5 digits in length.
Method Detail

getDomainName

public java.lang.String getDomainName()
Gets the Domain Name of the Notified Entity.

Returns:
A string that designates the Domain Name of the notified entity.

getLocalName

public java.lang.String getLocalName()
Gets the Local Name of the Notified Entity.

Returns:
A string that designates the Local Name of the notified entity. If null, none was set.

getPortNumber

public int getPortNumber()
Gets the Port Number of the Notified Entity.

Returns:
The Port Number of the Notified Entity.

toString

public java.lang.String toString()
Gets the complete Notified Entity string.
Overrides:
toString in class java.lang.Object
Returns:
LocalName@DomainName:PortNumber

JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000

Copyright © 2000 Sun Microsystems, Inc.