| | | | SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
|
|
network.domain
public class Domain
Domain represents a logical group of Addresses who's inbound/outbound number translations and Endpoint connection establishment are governed by the same associated rules and parameters.
Links:
Kernel Association inboundCalledRules
inboundCalledRules defines the transformation RuleSequence which is applied to the address of the Called Endpoint of an inbound call.
Constraints:
- see RuleSequence constraints
Default:
- none
Associates type:
composition
Client cardinality:
1
Client navigability:
NOT NAVIGABLE
Client visibility:
private
Supplier cardinality:
0..1
Supplier navigability:
NAVIGABLE
Supplier visibility:
private
Custom properties
link:
composition
Kernel Association outboundCallingRules
outboundCallingRules defines the transformation RuleSequence which is applied to the address of the Calling Endpoint of an outbound call.
Constraints:
- see RuleSequence constraints
Default:
- none
Associates type:
composition
Client cardinality:
1
Client navigability:
NOT NAVIGABLE
Client visibility:
private
Supplier cardinality:
0..1
Supplier navigability:
NAVIGABLE
Supplier visibility:
private
Custom properties
link:
composition
Kernel Association outboundCalledRules
outboundCalledRules defines the transformation RuleSequence which is applied to the address of the Called Endpoint of an outbound call.
Constraints:
- see RuleSequence constraints
Default:
- none
Associates type:
composition
Client cardinality:
1
Client navigability:
NOT NAVIGABLE
Client visibility:
private
Supplier cardinality:
0..1
Supplier navigability:
NAVIGABLE
Supplier visibility:
private
Custom properties
link:
composition
| Nested Class Summary |
public class |
UriFormat |
public class |
ReferHandlingType |
| Field Summary |
private String |
|
|
|
private String |
|
private int |
|
private int |
|
private int |
|
private String |
|
|
|
|
|
private String |
|
private ReferHandlingType |
|
ReferHandlingType |
APPLY |
ReferHandlingType |
FORWARD |
private String |
|
private UriFormat |
|
UriFormat |
REUSE |
UriFormat |
SIP |
UriFormat |
SIPS |
UriFormat |
TEL |
private String |
|
private String id
id is the unique identifier for the Domain within the CSN.
Constraints:
- must be unique within the CSN
Default:
- none
Multiplicity:
1
inboundCalledRules defines the transformation RuleSequence which is applied to the address of the Called Endpoint of an inbound call.
Constraints:
- see RuleSequence constraints
Default:
- none
Multiplicity:
1
private String localCountryCode
localCountryCode is the country identifier used in prefixing the DirectoryNumber to indicate the home locale of the call.
Constraints:
- \d{1,8}
- may be null
Default:
- null
Multiplicity:
1
private int maxNationalNumberLength
The maxNationalNumberLength describes how the NatureOfAddress may be determined based on the number length. If the number is <= maxNationalNumberLength and >= minNationalNumberLength than the nature is NATIONAL.
Note: the constraints may be used to determine the nature of address as follows:
PRIVATE <= maxPrivateNumberLength < LOCAL < minNationalNumberLength <= NATIONAL <= maxNationalNumberLength < INTERNATIONAL
Constraints:
- [0-9]*{1,5}
- must be greater than or equal to minNationalNumberLength
Default:
- 0
Multiplicity:
1
private int maxPrivateNumberLength
The maxPrivateNumberLength describes how the NatureOfAddress may be determined based on the number length. If the number is <= maxPrivateNumberLenght than the nature is PRIVATE.
Note: the constraints may be used to determine the nature of address as follows:
PRIVATE <= maxPrivateNumberLength < LOCAL < minNationalNumberLength <= NATIONAL <= maxNationalNumberLength < INTERNATIONAL
Constraints:
- [0-9]*{1,5}
- must be less than minNationalNumberLength
Default:
- 0
Multiplicity:
1
private int minNationalNumberLength
The minNationalLength describes how the NatureOfAddress may be determined based on the number length. If the number is < minNationalNumberLength than the number is either LOCAL or PRIVATE.
Note: the constraints may be used to determine the nature of address as follows:
PRIVATE <= maxPrivateNumberLength < LOCAL < minNationalNumberLength <= NATIONAL <= maxNationalNumberLength < INTERNATIONAL
Constraints:
- [0-9]*{1,5}
- must be greater than maxPrivateNumberLength
- must be less than or equal to maxNationalNumberLength
Default:
- 0
Multiplicity:
1
private String name
name represents the logical unique name given to the Domain by the provisioner.
Constraints:
- .{1,64}
- must be unique within the CSN
Default:
- none
Multiplicity:
1
outboundCalledRules defines the transformation RuleSequence which is applied to the address of the Called Endpoint of an outbound call.
Constraints:
- see RuleSequence constraints
Default:
- none
Multiplicity:
1
outboundCallingRules defines the transformation RuleSequence which is applied to the address of the Calling Endpoint of an outbound call.
Constraints:
- see RuleSequence constraints
Default:
- none
Multiplicity:
1
private String outboundTrunkGroupInfo
outboundTrunkGroupInfo specifies a trunk context for the softswitch or media gateway controller
Constraints:
- \w{1,256}
Default:
- none
Multiplicity:
1
private ReferHandlingType referHandlingType
referHandlingType indicates how the CSN should process SIP REFER requests from Endpoints in the DirectDomain. Valid options for REFER handling are:
- FORWARD: forward the REFER to the opposing leg of the call allowing it to be processes down/up stream
- PROCESS: apply REFER locally
- REJECT: do not process the REFER, respond with error
Constraints:
- "FORWARD" | "PROCESS" | "REJECT"
Default:
- "PROCESS"
Multiplicity:
1
private String routingAddress
routingAddress represents the transport address for the entry point into the domain. The routingAddress contains either an IP address or a fully qualified directory number (FQDN). It is used as the outbound address on SIP INVITE messages sent out to an Endpoint associated with the Domain.
Constraints:
- see Address constraints
Default:
- none
Multiplicity:
1
private UriFormat uriFormat
uriFormat describes the intended format for outbound address transformation. uriFormat may be one of (sip, sips, tel, or reuse --> indicating that the outbound format should follow that of the inbound leg).
Constraints:
- "SIP" | "SIPS" | "TEL" | "REUSE"
Default:
- "SIP"
Multiplicity:
1
private String uriHostPart
uriHostPart describes the host value to be used in the transformation of and generation of outbound URI.
Constraints:
- \S{1,256}
- must be empty for TEL and REUSE
- must not be null for SIP and SIPS
Default:
- none
Multiplicity:
1
| | | | SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
|
|