| | | | SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
|
|
session
|
Class RegistrationSession
|
|
+--session.RegistrationSession
public class RegistrationSession
RegistrationSession represents the abstraction of the communication session through which SIP devices register/de-register. Specifically, the RegistrationSession provides four primitives for handling registration: accept, reject, forward and relay.
Links:
Generalization Generalization Link
RegistrationSession represents the abstraction of the communication session through which SIP devices register/de-register. Specifically, the RegistrationSession provides four primitives for handling registration: accept, reject, forward and relay.
| Field Summary |
private String |
|
private String |
|
private String |
|
private long |
|
private Status |
|
private String |
|
| Method Summary |
public void |
|
public void |
|
public void |
|
public void |
|
private String accessNetworkInfo
accessNetworkInfo relates information regarding the network through which the Endpoint may be accessed. This information is provided at Endpoint status registration time.
Constraints:
- [A-Za-z0-9]*{1,256}
Default:
- none
Multiplicity:
1
private String address
address represents the address of the Endpoint who's status is being registered
Constraints:
- see Address constraints
Default:
- none
Multiplicity:
1
private String contact
contact represents the address contents of the Contact header included in the SIP based Endpoint registration used in subsequent communications with the device.
Constraints:
- [A-Za-z0-9]*{1,256}
Default:
- none
Multiplicity:
1
private long expires
expires represent the time in seconds for which the registration is valid.
Constraints:
- [0-9]*{1,9}
Default:
- 0
Multiplicity:
1
private Status status
status represents the Endpoint's current reachability as ON_LINE (available/reachable), OFF_LINE (unavailable, not reachable) or UNKNOWN.
Constraints:
- "ON_LINE" | "OFF_LINE" | "UNKNOWN"
Default:
- none
Multiplicity:
1
private String visitedNetworkId
visitedNetworkId represents the identity of the visited network in which the Endpoint resides provided at Endpoint status registration time.
Constraints:
- [A-Za-z0-9]*{1,256}
Default:
- none
Multiplicity:
1
public void accept ()
accept propagates the registration locally and updates the corresponding Subscriber.Device.Endpoint.Status accordingly.
public void forward (String address)
forward propagates the SIP REGISTER message to the specified upstream address.
public void reject ()
reject causes the CSN to return a SIP XXX message in order to indicate that the registration was rejected.
public void relay (String address)
relay both processes locally by updating the corresponding Subscriber.Device.Endpoint.Status and forwarding the SIP REGISTER message to the specified Address.
| | | | SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
|
|