Skip navigation links

com.oracle.sft.api.bean
Annotation Type ServiceAttributes

@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface ServiceAttributes

A ServiceAttributes annotation can be placed on top a CommunicationBean annotation. There can be atmost only one ServiceAttribute annotation in an application. ServiceAttributes define the attributes of the application.

See Also:

CommunicationBean

Optional Element Summary

String	allowedModules Names of Java EE modules that are allowed to use this CommunicationBean.
String[]	chargingCollectionFunction Represents the Charging Collection Function (CCF) charging functional entity in P-Charging-Function-Addresses header.
int[]	conferenceEventConfig The configuration data for conference event.
String	domainName Default domain name that will be appended to any userName.
String	domainProxy Defines the Location of the Domain Proxy.
boolean	enableChangeBandwidth 3GPP 24.610 (Communication HOLD) defines the AS of the UE should change some band width attributes for each media stream marked "recvonly".
String[]	eventChargingFunction Represents the Event Charging Function (ECF) charging functional entity in P-Charging-Function-Addresses header.
int[]	messageObservationEventConfig The configuration data for message waitting event.
String	mscontrolJndiName JNDI name for looking up the MsControlFactory object configured in the application server.
int	referEventConfig The configuration data for refer event.
String	registrar Defines the Location of the Registrar.
String	restAuthorizationAdapter Defines the name of authorization adapter name of REST module.
int[]	sdpBandwidthAttributes 3GPP 24.610 Communication HOLD As a network option, the AS of the UE which invoke Communication HOLD shall for each media stream marked "recvonly" lower the bandwidth by setting the "b=AS:" parameter to a small value, e.g.
int	statusCode4InitiateEarlyMedia Specify status code of response by which AS initiate early media for certain UserParticipant as caller.
String	terminatingOperator Represents the term-ioi parameter in P-Charging-Vector header.
String	xcapRoot

registrar

public abstract String registrar

Defines the Location of the Registrar. The host name or IP address of the Registrar is specified.

Returns:

Location of the Registrar

Default:

""

domainProxy

public abstract String domainProxy

Defines the Location of the Domain Proxy. The host name or IP address of is specified.

Returns:

Location of the Domain Proxy

Default:

""

domainName

public abstract String domainName

Default domain name that will be appended to any userName. For example, if an application does Conference.addParticipant("alice") and the domainName is specified as "example.com", then effectively the api would be equivalent to Conference.addParticipant("alice@example.com");

Returns:

domain name

Default:

""

xcapRoot

public abstract String xcapRoot

Default:

""

mscontrolJndiName

public abstract String mscontrolJndiName

JNDI name for looking up the MsControlFactory object configured in the application server. This allow deployer to use a different Media Server or different Configuration for the default MsControlFactory.

Returns:

Name of the MsControlFactory JNDI Name.

Default:

""

sdpBandwidthAttributes

public abstract int[] sdpBandwidthAttributes

3GPP 24.610 Communication HOLD As a network option, the AS of the UE which invoke Communication HOLD shall for each media stream marked "recvonly" lower the bandwidth by setting the "b=AS:" parameter to a small value, e.g. "b=AS:0". The "b=RR:" and "b=RS:" parameters shall be set to values large enough to enable continuation of the RTCP flow, e.g. "b=RR:800" and "b=RS:800".

Returns:

Sdp Bandwidth Attributes, the order is {AS, RS,RR}

Default:

{0, 800, 800}

enableChangeBandwidth

public abstract boolean enableChangeBandwidth

3GPP 24.610 (Communication HOLD) defines the AS of the UE should change some band width attributes for each media stream marked "recvonly". By this element, application can disable this feature.

Returns:

enable Change RecvOnly Bandwidth

Default:

true

allowedModules

public abstract String allowedModules

Names of Java EE modules that are allowed to use this CommunicationBean. If the value is specified is "*", any Java EE module is allowed to access this bean. In a future version of the framework, it will be possible to use specific module names.

Returns:

Names of Java EE modules that are allowed to use this CommunicationBean

Default:

""

conferenceEventConfig

public abstract int[] conferenceEventConfig

The configuration data for conference event. there are four parameters, listed by sequence as following:

• The minimum expiration time allowed for subscriptions, default value is 100s.
• The default expiration time for subscriptions, default value is 1800s.
• The maximum expiration time allowed for subscriptions, default value is 3600s.
• The maximum number of subscriptions per resource allowed for this service, default value is 100.

Based on the incoming SUBSCRIBE request's Subscription-State expires header value:

• If expire time > 0 and < minimum expiration time, SFT Container will reject the the SUBSCRIBE with response code 423 - Interval Too Brief.
• If expire time < 0, the default expiration time will be used.
• If expire time > max expiration time, the max expiration time will be used.
• If the max number of subscriptions reached, the following SUBSCIRBE request will be rejected with response code 503 - Service Unavailable

Returns:

An array of configuration data for conference event package.

Default:

{100, 1800, 3600, 100}

messageObservationEventConfig

public abstract int[] messageObservationEventConfig

The configuration data for message waitting event. there are four parameters, listed by sequence as following:

• The minimum expiration time allowed for subscriptions, default value is 100s.
• The default expiration time for subscriptions, default value is 1800s.
• The maximum expiration time allowed for subscriptions, default value is 3600s.
• The maximum number of subscriptions per resource allowed for this service, default value is 100.

Based on the incoming SUBSCRIBE request's Subscription-State expires header value:

• If expire time > 0 and < minimum expiration time, SFT Container will reject the the SUBSCRIBE with response code 423 - Interval Too Brief.
• If expire time < 0, the default expiration time will be used.
• If expire time > max expiration time, the max expiration time will be used.
• If the max number of subscriptions reached, the following SUBSCIRBE request will be rejected with response code 503 - Service Unavailable

Returns:

An array of configuration data for message waitting event.

Default:

{100, 1800, 3600, 100}

referEventConfig

public abstract int referEventConfig

The configuration data for refer event.

Notice that unlike SUBSCRIBE, the REFER transaction does not contain a duration for the subscription in either the request or the response. application can set the default expiration time for refer event.

Returns:

configuration data for refer event

Default:

1800

terminatingOperator

public abstract String terminatingOperator

Represents the term-ioi parameter in P-Charging-Vector header. the term-ioi represents the network responsible for the charging records in the terminating part of the session or standalone request.

Returns:

the identifier of terminating network.

Default:

""

chargingCollectionFunction

public abstract String[] chargingCollectionFunction

Represents the Charging Collection Function (CCF) charging functional entity in P-Charging-Function-Addresses header.

Returns:

an string Array of CCF.

Default:

{}

eventChargingFunction

public abstract String[] eventChargingFunction

Represents the Event Charging Function (ECF) charging functional entity in P-Charging-Function-Addresses header.

Returns:

an string Array of ECF.

Default:

{}

statusCode4InitiateEarlyMedia

public abstract int statusCode4InitiateEarlyMedia

Specify status code of response by which AS initiate early media for certain UserParticipant as caller. Currently, we support two values: 183(Session Progress) or 180(Ringing). If it is not set, or its value is other than either 183 or 180, then 183 will be applied. setStatusCode4InitiateEarlyMedia(int statusCode) of UserParticipant is prior to this setting.

Returns:

status code of response by which AS initiate early media

Default:

183

restAuthorizationAdapter

public abstract String restAuthorizationAdapter

Defines the name of authorization adapter name of REST module. The name can be qualified Java class name, such as com.example.MyPolicy, or pre-defined name, such as PRINCIPAL_MATCHING or WITH_PRINCIPAL.

Returns:

the name of authorization adapter of REST module

Default:

""

Skip navigation links