OpenScape
V3.2, Revision 044 20100322

com.siemens.symphonia.bcom.bcommon.external
Interface EndpointAddress

All Superinterfaces:
ComEndpoint
All Known Subinterfaces:
DeviceEndpointInternal, EndpointAddressInternal, InvalidNumber, InvalidNumberInternal, PassthroughNumber, PassthroughNumberInternal, PrivateAddress, PrivateAddressInternal, PublicAddress, PublicAddressInternal, UnknownAddress, UnknownAddressInternal
All Known Implementing Classes:
AbstractEndpointAddress, DeviceEndpointImpl, DeviceEndpointInternalImpl, EndpointAddressImpl, EndpointAddressInternalImpl, InvalidNumberImpl, InvalidNumberInternalImpl, PassthroughNumberImpl, PassthroughNumberInternalImpl, PrivateAddressImpl, PrivateAddressInternalImpl, PublicAddressImpl, PublicAddressInternalImpl, UnknownAddressInternalImpl

public interface EndpointAddress
extends ComEndpoint

Representation of a communication address.

An EndpointAddress object contains information about the communication address used. E.g. in case of a voice communication it is the phone number.

Dependent of the media type and the kind of addressing schema used there are certain characteristics.
The method getTypeOfNumber allows to retrieve the variant of this object. It is called "type of number". Furthermore there is an extension for each variant describing the characteristics of this variant. The following table gives an overview of the existing variants, their type of number and associated extension:

Type of number Extension Description
TON_GLOBAL_NUMBER PublicAddress Specifies an address which is worldwide unique and identifies one certain target for a communication.
TON_PRIVATE_NUMBER PrivateAddress Private numbers are only unique in a customer specific context. Typically they can't be used outside this context. Such a context is in most cases a company, but maybe even a smaller part (e.g. business group).
TON_PASS_THRU_NUMBER PassthroughNumber Interpretation of the address is left to the communication system. Used to avoid the overhead of an address translation.
TON_INVALID_NUMBER InvalidNumber Used only for addresses received from a communication system and which could not be decoded.

Remark:
It is also possible to use instanceof <object with type EndpointAddress> for determination of variant used instead of using getTypeOfNumber.


Field Summary
static int TON_GLOBAL_NUMBER
          Global number which is wordlwide unique.
static int TON_INVALID_NUMBER
          Invalid number.
static int TON_PASS_THRU_NUMBER
          Temporary representation of a number typed in by the user.
static int TON_PRIVATE_NUMBER
          Private number valid in given context.
 
Method Summary
 java.lang.String getNormalizedNumber()
          A normalized number is a unique representation of a communication address.
 int getTypeOfNumber()
          Describes the kind of this number.
 

Field Detail

TON_GLOBAL_NUMBER

static final int TON_GLOBAL_NUMBER
Global number which is wordlwide unique.

Normalized number doesn't contain a phone-context part and is formatted in the global number format (GNF) according to ECMA.
Example: +49897221234

See Also:
Constant Field Values

TON_PASS_THRU_NUMBER

static final int TON_PASS_THRU_NUMBER
Temporary representation of a number typed in by the user.

Its only purpose is to avoid an explicit address translation. After sending it to the communication system the responses from the communication system are used to get the global or private number thereof.
Normalized number contains context with the format: phone-context=direct.<office or private code>.<communication system>
Example: 123;phone-context=direct.mch-h.hp8k1

See Also:
Constant Field Values

TON_PRIVATE_NUMBER

static final int TON_PRIVATE_NUMBER
Private number valid in given context.

Normalized number contains context with the format: phone-context=private.<office or private code>
Example: 441234;phone-context=private.mch-priv

See Also:
Constant Field Values

TON_INVALID_NUMBER

static final int TON_INVALID_NUMBER
Invalid number.

A communication address provided by the communication system which doesn't adhere to the standards. This is typically the result of a missconfigured communication system.
Normalized number contains context with the format: phone-context=invalid. Original characters received from the communication system are converted to hex code.
Example: 3C44;phone_context=invalid

See Also:
Constant Field Values
Method Detail

getNormalizedNumber

java.lang.String getNormalizedNumber()
A normalized number is a unique representation of a communication address.

It allows to identify a certain target uniquely and might therefore also be used for look-up in directories.
It is therefore an unique identification for endoints and not to be used in human visible interfaces (e.g. GUI).

The representation of such an address is dependent of the media type and the kind of addressing schema used. In case of a voice communication the addressing schema might be either global or private. In any case the format used for representing such an address is according to the standard RFC 3966. The type of number (obtained by the method getTypeOfNumber) specifies the used format in more detail.

Returns:
Normalized Number.

getTypeOfNumber

int getTypeOfNumber()
Describes the kind of this number.

Possible values are: TON_GLOBAL_NUMBER, TON_PRIVATE_NUMBER, TON_PASS_THRU_NUMBER and TON_INVALID_NUMBER.

See the description of the constants and the corresponding extensions for further details.

Returns:
one of the above constants.

OpenScape
V3.2, Revision 044 20100322

Copyright (c) 2014 Unify, Germany
All rights reserved.

This software is the confidential and proprietary information of Unify, Germany