All Classes Interface Summary Class Summary Enum Summary Exception Summary
Class |
Description |
Abort |
|
ActivityTestConfiguration |
|
ActivityTestTimerMode |
Represents the methods sentinel supports for controlling the activity test timer duration.
|
BaseFeature<SessionStateType,EndpointType extends FeatureEndpoint> |
Base class for POJO features.
|
BaseFeatureCreator |
Base class for types of FeatureCreator.
|
BaseFeatureSbbImpl<SessionStateType> |
Base class for implementation of feature SBBs
|
BaseInitialTriggerFeatureEndpoint |
The interface a feature running on a session start or initial trigger feature execution
point uses to provide feedback into the sentinel core.
|
CallType |
Java enum to represent the CallType enum values.
|
ChargingInstance |
|
ChargingInstance.ChargingType |
Identifies the type of the Charging: reserved or immediate charging.
|
ChargingInstance.Instruction |
Type of charging instructions.
|
ChargingInstance.State |
Represents the current state of a ChargingInstance, an instance is in the
Initial state prior to processing CCA-I, Mid state after processing CCA-I
and Final state after credit finalisation is instructed.
|
ChargingInstanceAlreadyFinalisedException |
Exception thrown if the charging instance is already finalised.
|
ChargingManager |
|
CommonInitialFeatureEndpoint |
Common interface for features being able request an immediate response in form of:
Redirect,
EndUserServiceDenied,
an error with a code from the DiameterBase protocol's 'DiameterResultCode' class.
|
CoreExecutionPhase |
Generic execution phases used by core features.
|
CreditCheckAlreadyInProgressException |
Exception thrown if there is already a credit check in progress.
|
DelegatingFeatureCollection |
This class will be used to bridge between the old style of feature collection and the new style
|
DiameterFeature |
Interface implemented by diameter features which wish to expose a toDiameterFeatureEndpoint interface
Typically only used by features which operate asynchronously: the toDiameterFeatureEndpoint interface is used by Sentinel
to notify the feature of events that concern it.
|
DiameterMediationChargingControlFeatureEndpoint |
Defines requests a feature may make to the sentinel core that are related to
control of interaction with the OCS
|
DiameterMediationEndFeatureEndpoint |
Interface for features running in the Mediation End execution point.
|
DiameterMediationFeature |
Interface implemented by diameter features which wish to expose a toDiameterMediationFeatureEndpoint interface
Typically only used by features which operate asynchronously: the toDiameterMediationFeatureEndpoint interface is used by Sentinel
to notify the feature of events that concern it.
|
DiameterMediationMappingPoint |
points in session where mapping may be required
|
DiameterMediationMidSessionFeatureEndpoint |
Interface for features running in the Mediation Pre Credit Control Request, Credit Allocated,
Credit Limit Reached, Credit Control Not Required and Credit Control Failure feature execution points.
|
DiameterMediationStartFeatureEndpoint |
Interface for features running in the Mediation Start execution point.
|
DiameterServiceMappingPoint |
points in session where mapping may be required
|
DirtyMonitor |
|
DuplicateLegException |
Exception thrown if a Leg already exists with the supplied name in during importing, creating or forking process.
|
DuplicateNameException |
Exception thrown if charging instance already exists with the supplied name.
|
ElapsedTime |
Simple elapsed time class for logging time elapsed from
creation date.
|
EndSessionEvent |
Interface for the EndSessionEvent
|
EndSessionHandler |
Interface used for callbacks from FSM action implementations to the hosting SBB to
free resources controlled by the SBB e.g. feature timer ACIs.
|
EtcAriCorrelationHelper |
|
EtcAriDialogHelper |
|
EventChargingMethod |
Defines the different methods supported for event charging
|
ExecutionPhase |
Phases of processing a session in the sentinel.
|
FailedInstruction |
Interface for FailedInstruction, containing information for Features
to determine if action is required when an instruction failed to execute.
|
FeatureCollectionImpl |
Feature collection implementation used by new dynamic assembled feature collections
|
FeatureCreatorLookupTable<T extends BaseFeatureCreator> |
|
FeatureEndpoint |
The interface a feature uses to provide feedback into the sentinel core.
|
FeatureError |
Represents an error that occurred in the Feature
|
FeatureError.Cause |
|
FeatureFactoryImpl<FeatureEndpointType extends FeatureEndpoint> |
|
FeatureLimiterFilterConditionAccess<MessageType> |
|
FeatureSbbFacade |
Facade feature that acts as a proxy for a feature sbb
|
FeatureSbbFacade.FeatureSbbInvoker |
Externalise interaction with the feature sbb as the sentinel front-ends and registrar have different interfaces
for interacting with the feature sbb
|
FeatureWarning |
Represents a warning to the sentinel core, e.g for a non-fatal error or situation that the feature
resolved in some way that the feature wants the sentinel core to note
|
FeatureWarning.Cause |
|
HeadersByLeg |
Stores per- Leg header values.
|
HeadersByLegCodec |
|
ImmediateChargingInstance |
|
ImsiSessionState |
For those features that read/write the IMSI
|
InitialLegPhase |
Represents the initial Sentinel leg phases that legs may be in.
|
InitialRequestMap |
Map of leg name to initial request
|
InjectAddressListCollection |
Features implement this if they require the use of AddressLists
|
InjectAddressListEntryReader<ExtendedListEntry extends com.opencloud.sentinel.feature.common.lists.AddressListEntry> |
Features implement this if they define a custom address list entry reader
|
InjectFeatureConfigurationReader<Reader> |
Features implement this interface to use a configuration reader
|
InjectFeatureLimiterFilterConditionAccess<MessageType> |
Features implement this interface if they need to manage limiter filter conditions.
|
InjectFeatureStats<Stats extends SentinelFeatureStats> |
Features implement this interface if they have defined their own statistics interface that
extends SentinelFeatureStats
|
InjectFsmBuilder<FSM> |
Features that are based on a POJO FSM, implement this to have access to an object they can use
to get FSM instances.
|
InjectMapperLibrary<MappingExecutionPoints extends java.lang.Enum<?>> |
Features implement this interface to use a Mapper Library
|
InjectResourceAdaptorProvider |
Features implement this interface if they require the use of an RA provider
|
InjectSentinelPlatformConfiguration |
Features implement this interface if they require access to platform level sentinel configuration
|
InstructionAlreadyPendingException |
Exception thrown if there is already an instruction pending.
|
InstructionExecutionFailedEvent |
Interface for InstructionExecutionFailedEvent, containing list of all FailedInstruction s.
|
InviteReplicationTrigger |
Indicates the point at which a call leg should trigger the start of session replication.
|
InviteSessionPhase |
|
Leg |
|
LegEndEvent |
Interface for the LegEndEvent
|
LegManager |
|
LegsAlreadyLinkedException |
Exception thrown if a Leg already linked to another Leg .
|
LegState |
|
LegStateMap |
|
LegSubscriptionID |
Represents a subscribed SIP event on a particular Leg
|
LegTransactionID |
Represents a SIP transaction on a particular Leg
|
LegUsageID |
LegUsageID should uniquely represent the SIP Usage.
|
LimiterFilterCondition<MessageType> |
Represents a condition to evaluate against an incoming message to determine if
the message can be considered for rate limiting or if it must be allowed through.
|
LimiterFilterConditionAccess |
Provides access to per-feature limiter filter conditions.
|
Mapper<SessionStateType> |
A Sentinel Mapper
|
MapperException |
Exception thrown by mappers which are unable to perform mapping due to missing message
content or incorrect configuration
|
MapperFacilities |
Facilities available to mapper methods
|
MapperLibrary<MapperExecutionPoint extends java.lang.Enum<?>> |
Provides access to available mappers.
|
MccMnc |
|
MessageBody |
|
MessageQueue<T> |
Interface for message queue.
|
MessageQueues |
Factory for producing message queues.
|
MultipartMessageBody |
|
NullSentinelFeature |
NullSentinelFeature is used by Sentinel if a feature that does not exist is referenced in a feature execution script.
|
NullSentinelSessionState |
An empty session state interface.
|
OcsSessionTerminationCause |
|
OpenCloudDiameter |
Utility class for inspecting Diameter messages.
|
ParameterValue |
Represents the value of a feature parameter
|
PeriodicWorkHandler |
This interface can be added to a SentinelFeature for out-of-session handling
of timer-driven periodic work.
|
PeriodicWorkHandlerStats |
|
PlmnIdAnalyser |
An interface for a provider that can be used by features to determine if a PLMN ID (combination of MCC and MNC)
is a home PLMN ID, or classify it as a Home PLMN ID, an MCC-only match, or no match.
|
PlmnIdAnalyser.PlmnIdMatch |
|
ProviderError |
|
ProxyResult |
|
ReauthorizeCredit |
Event indicating a credit reauthorization is being requested by the service.
|
RecognizedAddressHeaderNames |
|
RelayDialogSessionState |
For features that wish to define a specific destination sccp address for relaying the dialog
|
ReliableResponseID |
Represents the components that uniquely identify a reliable provisional SIP response.
|
ReservationChargingInstance |
|
ReservationChargingInstance.CreditResultExecutionPhase |
|
SentinelBaseEncodableContext |
|
SentinelByNameSessionState |
Defines the interface for populating session state fields by name.
|
SentinelChargingFeatureEndpoint |
The Sentinel Endpoint for this feature.
|
SentinelCommonSessionState |
Session state interface with the fields most commonly needed by features.
|
SentinelConfiguration |
Properties related to the sentinel installation and common to all Sentinel services.
|
SentinelDiameterEndSessionFeatureEndpoint |
Interface for features running in the EndSession feature execution point.
|
SentinelDiameterInitialTriggerFeatureEndpoint |
Interface for features running in the Network-, Session- and Subscriber-PreCC feature execution points.
|
SentinelDiameterMediationSessionState |
The Session state interface as it is available to the DiameterSentinel features.
|
SentinelDiameterSessionState |
The Session state interface as it is available to the DiameterSentinel features.
|
SentinelDiameterStartSessionFeatureEndpoint |
|
SentinelEndpoint |
|
SentinelFeature |
A Sentinel feature.
|
SentinelFeatureSbbAccess<SessionStateType> |
Provides access to certain core Sentinel SBB methods required by feature SBBs.
|
SentinelFeatureSbbLocal |
The SBB Local interface for SBB based features.
|
SentinelFeatureSbbSupportInvoker |
|
SentinelFeatureStats |
Statistics that are common to all features.
|
SentinelFireEventException |
|
SentinelLocal |
SBB Local interface that the Sentinel core provides to SBB features
|
SentinelMediationToPromotionsSessionState |
Session state that mediation and promotions features use to inter-communicate
|
SentinelPlatformConfigurationReader |
Provides access to platform level sentinel configuration
|
SentinelPromotionsSessionState |
Session state required by promotions
|
SentinelRoamingSessionState |
Session state interface for features that care about the roaming status of the subscriber.
|
SentinelSbbLocalObjectAccess |
|
SentinelSessionIdsSessionState |
For features that need access to ServiceIDLookup
|
SentinelSessionState |
|
SentinelSipAVPs |
When adding a new AVP here, you will also need to add it to the config in sentinel-core:
sentinel-core/sentinel-diameter-ra-deploy/config/profiles/DiameterExtension-AVP.yaml
sentinel-core/sentinel-diameter-ra-deploy/config/profiles/DiameterExtensions.yaml
And remember to update the docs in sentinel-documentation:
sentinel-documentation/sentinel-documentation/sentinel-administration-guide/resources/charging-information/charging-content-avps/opencloud-avp-table.txt
sentinel-documentation/sentinel-documentation/sentinel-administration-guide/resources/charging-information/charging-content-avps/sentinel-avp-definitions-resource.txt
|
SentinelSipEncodableContext |
|
SentinelSipMultiLegFeatureEndpoint |
|
SentinelSipSessionState |
|
SentinelSipStatsAccess |
For components to access sentinel-sip core stats
|
SentinelSipUsage |
Usage statistics collected by the Sentinel Sip service.
|
SentinelSs7CommonSessionState |
Session state typically required by SS7 initial trigger features
|
SentinelSs7EncodableContext |
|
SentinelSs7EndSessionFeatureEndpoint |
|
SentinelSs7InitialTriggerFeatureEndpoint |
|
SentinelSs7MidSessionFeatureEndpoint |
|
SentinelSs7SessionState |
session state required by the sentinel ss7 core
|
SentinelSs7StartSessionFeatureEndpoint |
|
SentinelSs7Usage |
Usage stats collected by the Sentinel SS7 service
|
ServiceIDLookup |
|
ServiceIDLookupImpl |
|
ServiceIDLookupProto |
|
ServiceIDLookupProto.ServiceIDLookupBuf |
|
ServiceIDLookupProto.ServiceIDLookupBuf.Builder |
|
ServiceIDLookupProto.ServiceIDLookupBuf.ServiceID |
|
ServiceIDLookupProto.ServiceIDLookupBuf.ServiceID.Builder |
|
ServiceTimerAlreadyExistsException |
|
ServiceTimerProvider |
An interface for a provider that can be used by features to raise timers.
|
ServiceType |
|
SessionCounter |
SessionCounter contains the charging counters related to a
unique SessionCounterAddress set of key/value pairs and provide
methods for incrementing the various charging counters and getting the
current values.
|
SessionCounterAddress |
SessionCounterAddress contains the set of key/value pairs which uniquely identify a
SessionCounter .
|
SessionCounterAddressNotFound |
|
SessionCounters |
SessionCounters provides access to the various SessionCounters which are current active for
this set of charging sessions in a Sentinel session.
|
SessionCountersSessionState |
For features, such as promotion features, that need access to SessionCounters
|
SessionReplicationMode |
|
SessionStateParameterException |
Exception that represents a failure updating a session state field by name.
|
SessionStatePromotionBucketsSessionState |
For promotions that run on session-state-based buckets
|
SessionType |
|
SharedCoreSasEvent |
Java enum to represent the SharedCoreSasEvent event types.
|
SipAddressString |
A sip address string
|
SipAddressStringNormalizer |
|
SipAddressUtil |
|
SipFeature |
Interface implemented by SIP features which need to expose a ToFeatureEndpoint interface.
|
SipFeatureScriptExecutionPoint |
Sentinel-SIP Supported execution points.
|
SipFeatureScriptExecutionPointCodec |
|
SipLegType |
Describes how a particular Leg is going to be used,
based on the initial request seen on that leg.
|
SipLimiterFilterCondition |
|
SipMappingPoint |
Points in session where mapping may be required.
|
SipMessageCodec |
A DatatypeCodec for SipMessages .
|
SipMessageQueue |
SipMessageQueue provides a collection for holding SipMessage
elements in a Queue (FIFO) order.
|
SipProfileVerifier |
|
SipRegistrationStatus |
|
SipSentinelFeatureSbbLocal |
For SIP Features implemented as SBBs that have a ToFeatureEndpoint implementation.
|
SipServiceType |
|
SipStatusUtil |
Utility class for SIP response status codes.
|
SipStatusUtil.SipStatusType |
Represents the Response SipStatusType.
|
SipSupportedTransport |
Enumeration of SIP transports supported by Sip Sentinel.
|
SipThirdPartyCallOutcomes |
Available result codes for third party call setup request
|
SipThirdPartyCallOutcomeToHttpResponseMapperInterface |
|
SipTimestampAvpPresenceMode |
This enum is used to determine the population mode of Sip Timestamp information in CCRs and ACRs.
|
SIPUtil |
Utility class for SIP Messages.
|
Ss7Feature |
Interface implemented by SS7 features which wish to expose a toFeatureEndpoint interface
Typically only used by features which operate asynchronously: the toFeatureEndpoint interface is used by Sentinel
to notify the feature of events that concern it.
|
SS7MappingPoint |
points in session where mapping may be required
|
Ss7SentinelFeatureSbbLocal |
For CDMA Features implemented as sbbs that have a ToFeatureEndpoint implementation
|
Ss7ThirdPartyCallOutcomes |
Available result codes for third party call setup request
|
Ss7ThirdPartyCallOutcomeToHttpResponseMapperInterface |
|
SubscribedEventID |
A value object representing a subscribed SIP event and optional ID parameter.
|
SubscriptionReplicationTrigger |
Indicates the point at which a subscription leg should trigger the start of session replication.
|
ToDiameterFeatureEndpoint |
The endpoint interface features provide.
|
ToDiameterMediationFeatureEndpoint |
The endpoint interface features provide.
|
ToSipFeatureEndpoint |
ToFeatureEndpoint interface for Sip service features
|
ToSs7FeatureEndpoint |
ToFeatureEndpoint interface for SS7 service features
|
TransactionInProgressException |
This exception is thrown by sentinel when there is already a re-invite transaction in progress
on this leg or there is a re-invite message in the MessagesToSend queue which will create this condition.
|
UserError |
|