| | | | SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
|
|
network
public class Endpoint
Endpoint represents the logical manifestation of the terminal of a connection (i.e. a location identified by an address). Endpoint reflects its status as ON_LINE, OFF_LINE, or UNKOWN. In addition Endpoint carries the associated Credentials and network information (e.g. accessNetworkInfo). Endpoints are provisionable and clonable.
Links:
Kernel Association Association Link
An Endpoint may have zero or more StatusSubscriptions. Each subscription may belong to a single Endpoint.
Constraints:
- see StatusSubscription constraints
Default:
- none
Clone:
- yes, deep. The Endpoint references a deep clone of the associated StatusSubscription
Associates type:
association
Client cardinality:
1
Client navigability:
NOT NAVIGABLE
Client visibility:
private
Supplier cardinality:
0..1
Supplier navigability:
NAVIGABLE
Supplier visibility:
private
Kernel Association Association Link
An Endpoint may have an AuthenticationContext. An AuthenticationContext defines the authentication parameters for a single Endpoint.
Constraints:
- see AuthenticationContext constraints
Default:
- none
Clone:
- no, the AuthenticationContext must be supplied by the provisioner
Associates type:
association
Client cardinality:
1
Client navigability:
NOT NAVIGABLE
Client visibility:
private
Supplier cardinality:
0..1
Supplier navigability:
NAVIGABLE
Supplier visibility:
private
Kernel Association are identified by
An Endpoint is uniquely identified by a exactly one Address. In addition, an Address uniquely identifies at most one Endpoint. In practice the value of the Endpoint is dependent on the Endpoint.type. For CELLULAR, DID_AIN, and PSTN the address is the RoutableNumber associated with the Endpoint. For PBX Endpoints the address is the PBX extension. Finally, the address attribute represents the user part of the URI for DIRECT Endpoints. In practice, the user part of the DIRECT URI is always a RoutableNumber.
Constraints:
- must be unique across all Devices
- must be unique across Endpoint types of multi-mode devices. I.e. A multi-mode device may have multiple Endpoints with the same address only if each Endpoint has a different endpointType.
--> constraint deferred to future release: must be unique across all service invocation numbers (personal and global)
- see RoutableNumber constraints
- see URI user part constraints
Default:
- none
Clone:
- no, this attribute must be unique and must be supplied by the provisioner
Associates type:
association
Client cardinality:
0..1
Client navigability:
NOT NAVIGABLE
Client visibility:
private
Supplier cardinality:
1
Supplier navigability:
NAVIGABLE
Supplier visibility:
private
| Nested Class Summary |
public class |
Type |
public class |
Status |
| Field Summary |
private transient String |
|
|
|
|
|
private transient String |
|
private Type |
|
private transient String |
|
private boolean |
|
private transient Status |
|
Status |
OFF_LINE |
Status |
ON_LINE |
Status |
UNKNOWN |
|
|
private boolean |
|
Type |
CELLULAR |
Type |
DID_AIN |
Type |
DIRECT |
Type |
PBX |
Type |
PSTN |
private transient String |
|
private boolean |
|
private transient 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:
- .{1,256}
Default:
- none
Clone:
- no, this is not a provisionable attribute (runtime only)
Multiplicity:
1
Transient:
true
An Endpoint is uniquely identified by a exactly one Address. In addition, an Address uniquely identifies at most one Endpoint. In practice the value of the Endpoint is dependent on the Endpoint.type. For CELLULAR, DID_AIN, and PSTN the address is the RoutableNumber associated with the Endpoint. For PBX Endpoints the address is the PBX extension. Finally, the address attribute represents the user part of the URI for DIRECT Endpoints. In practice, the user part of the DIRECT URI is always a RoutableNumber.
Constraints:
- must be unique across all Devices
- must be unique across Endpoint types of multi-mode devices. I.e. A multi-mode device may have multiple Endpoints with the same address only if each Endpoint has a different endpointType.
--> constraint deferred to future release: must be unique across all service invocation numbers (personal and global)
- see RoutableNumber constraints
- see URI user part constraints
Default:
- none
Clone:
- no, this attribute must be unique and must be supplied by the provisioner
Multiplicity:
1
An Endpoint may have an AuthenticationContext. An AuthenticationContext defines the authentication parameters for a single Endpoint.
Constraints:
- see AuthenticationContext constraints
Default:
- none
Clone:
- no, the AuthenticationContext must be supplied by the provisioner
Multiplicity:
1
private transient 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:
- .{1,256}
Default:
- none
Clone:
- no, this is not a provisionable attribute (runtime only)
Multiplicity:
1
Transient:
true
private Type endpointType
Endpoint endpointType describes the endpointType of Endpoint. Type is used to validate that the associated Domain is valid by ensuring that the Domain is of the same endpointType as the Endpoint. The following endpointType values are valid:
- PSTN: indicates that the Endpoint is in a PSTN network (or network with basic functionality)
- CELLULAR: indicates that the Endpoint is in a CELLULAR network
- DIRECT: indicates that the Endpoint is in a WiFi network (with SIP registration)
- DID_AIN: indicates that the Endpoint is behind an AIN PBX reachable with DID
- PBX: indicates that the Endpoint is serviced by an IP PBX
Constraints:
- "PSTN" | "CELLULAR" | "DIRECT" | "DID_AIN" | "PBX" | null
Defaults:
- none
Clone:
- yes, verbatim
Multiplicity:
1
private transient String miscNetworkInfo
miscNetworkInfo represents other miscelaneous network information provided at Endpoint status registration time.
Constraints:
- .{1,256}
Default:
- none
Clone:
- no, this is not a provisionable attribute (runtime only)
Multiplicity:
1
Transient:
true
private boolean ringingEnabled
ringingEnabled indicates whether (TRUE) the Endpoint should be included in subscriber termination case such as simring and ringing profiles or (FALSE) that the Endpoint should not be alerted in subscriber termination cases.
For Endpoints of Devices whos origin is SUBSCRIBER the ringEnabled=false case indicates that the CSN should handle originations from the Endpoint. As such it is restricted for use with the One Button Transfer feature.
Constraints:
- true | false
Default:
- true
Clone:
- yes, verbatim
Multiplicity:
1
private transient 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:
- "UNKNOWN"
Clone:
- no, this is not a provisionable attribute (runtime only)
Multiplicity:
1
Transient:
true
An Endpoint may have zero or more StatusSubscriptions. Each subscription may belong to a single Endpoint.
Constraints:
- see StatusSubscription constraints
Default:
- none
Clone:
- yes, deep. The Endpoint references a deep clone of the associated StatusSubscription
Multiplicity:
1
private boolean statusTrackingEnabled
statusTrackingEnabled flag indicates whether (TRUE) the CSN expects
status information for the Endpoint. In release 3.5, status tracking is
provided through SIP registration and SIP subscribe/notify mechanisms.
Constraints:
- must be true or false
- must be true if statusSubscription is not null
Default:
- false
Clone:
- yes, verbatim
Multiplicity:
1
private transient String visitedNetworkId
visitedNetworkId represents the identity of the visited network in which the Endpoint resides provided at Endpoint status registration time.
Constraints:
- .{1,256}
Default:
- none
Clone:
- no, this is not a provisionable attribute (runtime only)
Multiplicity:
1
Transient:
true
private boolean voiceMailEnabled
voiceMailEnabled indicates whether (TRUE) the Endpoint is associated with a voice mail system or (FALSE) the Endpoint is NOT associated with a voice mail system. The implication of voice mail association is that calls directed to the Endpoint my be answered by the voice mail system (e.g. if the Subscriber does not answer or forwarding is enabled).
Constraints:
- true | false
Default:
- false
Clone:
- yes, verbatim
Multiplicity:
1
| | | | SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
|
|