|
Oracle Communications Converged Application Server Java API Reference 5.1 E36938-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
com.bea.wcp.diameter.ClientApplication
com.bea.wcp.diameter.sh.ShApplication
public class ShApplication
Sh client application. See 3GPP TS 29.328 v6.8.0 and 3GPP TS 29.329 v6.6.0 for Sh protocol details.
Field Summary | |
---|---|
static ApplicationId |
ID Sh application identifier |
Constructor Summary | |
---|---|
ShApplication() |
Method Summary | |
---|---|
ShSession |
createSession() Creates a new client ShSession. |
Document |
getDocument(AccessKey key) Retrieves the data associated with the specified AccessKey by sending a UDR request and waiting for the corresponding UDA. |
ApplicationId |
getId() Returns the Sh application identifier. |
RepositoryData |
getRepositoryData(AccessKey key) Returns the RepositoryData for the specified Sh AccessKey. |
long |
getTimeout() Returns the current request timeout. |
void |
init() Initializes the ShApplication. |
void |
putDocument(AccessKey key, Document doc) Updates data for the specified AccessKey by sending a PDR request and waiting for the corresponding PDA. |
void |
putRepositoryData(AccessKey key, RepositoryData rd) Updates repository data for specified AccessKey. |
protected void |
rcvPush(AccessKey key, Document doc) Called whenever a new PNR message has been received. |
protected void |
rcvRequest(Request req) Called by the container when a new Sh request has been received. |
void |
setTimeout(long msec) Sets the maximum number of millisecons to wait for an answer from the HSS. |
void |
subscribe(AccessKey key) Starts subscription for the data referred to by the specified AccessKey. |
void |
unsubscribe(AccessKey key) Unsubscribes from the data referred to by the specified AccessKey. |
Methods inherited from class com.bea.wcp.diameter.Application |
---|
createRequest, createSessionId, getDestinationHost, getDestinationRealm, getName, getNode, getOriginHost, getOriginRealm, getParameter, getParameter, log, log, rcvAnswer, rcvMessage, setDestinationHost, setDestinationRealm |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final ApplicationId ID
Constructor Detail |
---|
public ShApplication()
Method Detail |
---|
public void init() throws DiameterException
init
in class ClientApplication
DiameterException
- if the initialization failedpublic ApplicationId getId()
getId
in class Application
public RepositoryData getRepositoryData(AccessKey key) throws DiameterException, IOException
key
- the AccessKey for the requested dataIllegalArgumentException
- if not a repository data AccessKeyMessageException
- if the answer from the HSS indicated an errorIOException
- if an I/O error occurredDiameterException
public void putRepositoryData(AccessKey key, RepositoryData rd) throws DiameterException, IOException
key
- the AccessKey for the datard
- the new RepositoryDataMessageException
- if the answer from the HSS indicated an errorIOException
- if an I/O error occurredDiameterException
public Document getDocument(AccessKey key) throws DiameterException, IOException
key
- the AccessKey for the dataMessageException
- if the answer from the HSS indicated an errorIOException
- if an I/O error occurredDiameterException
public void putDocument(AccessKey key, Document doc) throws DiameterException, IOException
key
- the AccessKey for the datadoc
- the updated user dataIllegalArgumentException
- if the document format was invalidMessageException
- if the answer from the HSS indicated an errorIOException
- if an I/O error occurredDiameterException
public void subscribe(AccessKey key) throws DiameterException, IOException
key
- the AccessKey for the dataMessageException
- if the answer from the HSS indicated an errorIOException
- if an I/O error occurredDiameterException
public void unsubscribe(AccessKey key) throws DiameterException, IOException
key
- the AccessKey for the dataMessageException
- if the answer from the HSS indicated an errorIOException
- if an I/O error occurredDiameterException
public ShSession createSession()
public void setTimeout(long msec)
msec
- the request timeout in millisecondspublic long getTimeout()
protected void rcvRequest(Request req) throws DiameterException, IOException
rcvRequest
in class Application
req
- the Sh PNR requestsDiameterException
- if an error occurred while processingIOException
- if an I/O error occurredprotected void rcvPush(AccessKey key, Document doc)
key
- the AccessKey for the user datadoc
- the updated user data
|
Oracle Communications Converged Application Server Java API Reference 5.1 E36938-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2012 Oracle Corporation. All Rights Reserved.