|
Oracle Communications Converged Application Server Java API Reference 5.0 E18767-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.bea.wcp.diameter.Application
public abstract class Application
Base class for all Diameter applications. A Diameter application must extend this class to return the application identifier as well as provide optional handling for messages received without an associated session. The application class is also used as the factory for creating new Diameter session objects.
Constructor Summary | |
---|---|
Application() |
Method Summary | |
---|---|
Request |
createRequest(Command cmd) Creates a new Request for this application but with no associated session. |
protected java.lang.String |
createSessionId() Called by Session constructor when creating new session ids. |
java.lang.String |
getDestinationHost() Returns the defautl destination host for requests. |
java.lang.String |
getDestinationRealm() Returns the default destination realm for requests. |
abstract ApplicationId |
getId() Returns the ApplicationId for the application. |
java.lang.String |
getName() Returns the name of the application. |
Node |
getNode() Returns the Diameter Node hosting the application. |
java.lang.String |
getOriginHost() Returns the configured host name for the Diameter entity hosting this application. |
java.lang.String |
getOriginRealm() Returns the configured realm name for the Diameter entity hosting this application. |
java.lang.String |
getParameter(java.lang.String name) Returns the value of the initialization parameter with the specified name. |
java.lang.String |
getParameter(java.lang.String name, java.lang.String def) Returns the value of the initialization parameter with the specified name, or a default value if not found. |
protected void |
init() Called by the container to initialize the application. |
void |
log(java.lang.String msg) Writes the specified message to the application log. |
void |
log(java.lang.String msg, java.lang.Throwable e) Writes the specified message and exception to the application log. |
protected void |
rcvAnswer(Answer ans) Called by the container when a new Answer has been received for this application. |
void |
rcvMessage(Message msg) Called by the container when a new Message has been received for this application. |
protected void |
rcvRequest(Request req) Called by the container when a new Request has been received for this application. |
void |
setDestinationHost(java.lang.String host) Sets the default destination host for requests. |
void |
setDestinationRealm(java.lang.String realm) Sets the default destination realm for requests. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Application()
Method Detail |
---|
protected void init() throws DiameterException
DiameterException
- if the initialization failedpublic final java.lang.String getName()
public abstract ApplicationId getId()
public final java.lang.String getParameter(java.lang.String name)
name
- the parameter namepublic final java.lang.String getParameter(java.lang.String name, java.lang.String def)
name
- the parameter namedef
- the default value of the parameter if not foundpublic final Node getNode()
public void rcvMessage(Message msg) throws DiameterException, java.io.IOException
msg
- the Message that has been receivedDiameterException
- if an error occurred while processing the messagejava.io.IOException
- if an I/O error occurredprotected void rcvRequest(Request req) throws DiameterException, java.io.IOException
req
- the Request that was receivedDiameterException
- if an error occurred while processing the messagejava.io.IOException
- if an I/O error occurredprotected void rcvAnswer(Answer ans) throws DiameterException, java.io.IOException
ans
- the Answer that was receivedDiameterException
- if an error occurred while processing the answerjava.io.IOException
- if an I/O error occurredpublic Request createRequest(Command cmd)
cmd
- the Command for the requestprotected java.lang.String createSessionId()
public java.lang.String getOriginRealm()
public java.lang.String getOriginHost()
public void setDestinationRealm(java.lang.String realm)
realm
- the new default destination realmpublic void setDestinationHost(java.lang.String host)
host
- the new default destination hostpublic java.lang.String getDestinationRealm()
public java.lang.String getDestinationHost()
public void log(java.lang.String msg)
msg
- the message to be loggedpublic void log(java.lang.String msg, java.lang.Throwable e)
msg
- the message to be loggede
- the exception to be logged
|
Oracle Communications Converged Application Server Java API Reference 5.0 E18767-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |