Introduction
This annex provides a cross-reference between interfaces by listing, for each of the API components and for the SLE Application:
-
the interfaces exported by the component (or the application);
-
the potential clients of the interface;
-
he interfaces required by the component (or the application);
-
the methods that can be used to obtain a reference to the interface;
-
the potential suppliers of the interface.
It is stressed that an implementation of a component should not make any assumption about the client of an exported interface or the supplier of a required interface. This information is supplied for the only purpose to verify completeness and consistency of the API specification.
Interfaces of individual operation objects exported by the component SLE Operations, and interfaces of individual utility objects exported by the component SLE Utilities, are not specifically considered. Because handling of the interfaces is identical for all these objects, the tables reference these interfaces by ‘interfaces of operation objects’ and ‘interfaces of utility objects’.
Clients (column marked ‘Clients’ in the table header) and suppliers (column marked ‘S’ in the table header) of interfaces are abbreviated as:
PX API Proxy
SE API Service Element
SO SLE Operations
SU SLE Utilities
SA SLE Application
The applicability of interfaces is indicated in a separate column (marked ‘A’ in the table header) as:
Mandatory (M) if the interface must be supported or used by all implementations.
Conditional (C) if the interface is associated with a set of options from which an implementation can select or depends on the service type supported by the component.
Optional (O) if the interface is needed for one of the other options specified in annex A.1.56.1.1.1.1.2.
An additional column (marked ‘N’ in the table header) references one or several notes, which are listed below the table.
The information in this annex has been derived from the specifications in section 3 and annexes A.1.1.1.1.1.1.1 and A.1.56.1.1.1.1.2. It does not provide any new specifications. In case of any discrepancies between this annex and the specifications in section 3 and annexes A.1.1.1.1.1.1.1 and A.1.56.1.1.1.1.2 the latter shall apply.
-
API Proxy
-
Exported Interfaces
Interface
|
Clients
|
A
|
N
|
ISLE_ProxyAdmin
|
SA and SE
|
M
|
1
|
ISLE_AssocFactory
|
SE
|
C
|
2
|
ISLE_SrvProxyInitiate
|
SE (service instance)
|
M
|
3
|
ISLE_Concurrent
|
SE
|
C
|
|
ISLE_Sequential
|
SE
|
C
|
|
ISLE_TimeoutProcessor
|
SA or SE
|
C
|
4
|
ISLE_EventProcessor
|
SA or SE
|
C
|
4
|
ISLE_TraceControl
|
SE
|
O
|
5
|
NOTES
-
The interface is used by the application for configuration of the component and by the service element for dynamic port registration if the service element supports responding associations.
-
The interface is required when the proxy supports associations in the initiator role.
-
The interface must be supported by every association object.
-
The interface is only required in combination with ISLE_Sequential. The client is the supplier of the corresponding interface ISLE_TimerHandler or ISLE_EventMonitor.
-
If tracing is supported, then the interface must be supported by the API Proxy and by every association object.
-
Required Interfaces
Interface
|
Interface reference obtained by
|
S
|
A
|
N
|
ISLE_Locator
|
input argument to ISLE_ProxyAdmin::Configure().
|
SE SA
|
C
|
1
|
ISLE_OperationFactory
|
input argument to ISLE_ProxyAdmin::Configure().
|
SO SA
|
M
|
2
|
ISLE_UtilFactory
|
input argument to ISLE_ProxyAdmin::Configure().
|
SU SA
|
M
|
3
|
ISLE_Reporter
|
input argument to ISLE_ProxyAdmin::Configure().
|
SA
|
M
|
|
ISLE_SrvProxyInform
|
a) input argument to ISLE_AssocFactory::CreateAssociation();
b) output argument of ISLE_Locator::LocateInstance().
|
SE SA
|
M
|
4
|
ISLE_EventMonitor
|
input argument to ISLE_Sequential::StartSequential().
|
SE SA
|
C
|
5
|
ISLE_TimerHandler
|
input argument to ISLE_Sequential::StartSequential().
|
SE SA
|
C
|
5
|
ISLE_Trace
|
input argument to ISLE_TraceControl::StartTrace().
|
SA
|
O
|
|
interfaces of operation objects
|
a) input argument of one of the methods in ISLE_SrvProxyInitiate;
b) call to ISLE_OperationFactory.
|
SE SO
|
M
|
6
|
interfaces of utility objects
|
a) passed by methods of other interfaces;
b) call to ISLE_UtilFactory.
|
|
M
|
7
|
NOTES
-
The interface is passed by the application but is actually supplied by the component API Service Element.
-
The interface is passed by the application but is actually supplied by the component SLE Operations.
-
The interface is passed by the application but is actually supplied by the component SLE Utilities.
-
Method a) applies to associations in the initiator role and method b) to associations in the responder role.
-
The interface is only needed in combination with ISLE_Sequential.
-
Operation objects might be passed by the service element; they are actually implemented by the component SLE Operations.
-
Utility objects can be passed to the proxy by various methods; they are implemented by the component SLE Utilities.
-
API Service Element
-
Exported Interfaces
Interface
|
Clients
|
A
|
N
|
ISLE_SEAdmin
|
SA
|
M
|
|
ISLE_SIFactory
|
SA
|
M
|
|
ISLE_SIAdmin
|
SA
|
M
|
1
|
I_SIAdmin
|
SA
|
C
|
2
|
I_SIUpdate
|
SA
|
C
|
2
|
ISLE_SIOpFactory
|
SA
|
M
|
1
|
ISLE_ServiceInitiate
|
SA
|
M
|
1
|
ISLE_Locator
|
SA and PX
|
C
|
3
|
ISLE_SrvProxyInform
|
PX (association)
|
M
|
1
|
ISLE_Concurrent
|
SA
|
C
|
|
ISLE_Sequential
|
SA
|
C
|
|
ISLE_TimeoutProcessor
|
SA
|
C
|
4
|
ISLE_EventProcessor
|
SA
|
C
|
4
|
ISLE_TraceControl
|
SA
|
O
|
5
|
NOTES
-
The interface is supported for every service instance.
-
The interface is supported for service instances in the provider role, if the interface is defined for the service type supported by that service instance.
-
The interface must be supported by a service element that uses associations in the responder role. The application requires the interface reference only for configuration of the component API Proxy; it does not use any of the methods in the interface.
-
The interface is only required in combination with ISLE_Sequential.
-
The interface must be supported by the API Service Element and by every service instance object.
-
Required Interfaces
Interface
|
Interface reference obtained by
|
S
|
A
|
N
|
ISLE_ProxyAdmin
|
input argument to ISLE_SEAdmin::AddProxy()
|
PX SA
|
M
|
1
|
ISLE_OperationFactory
|
input argument to ISLE_SEAdmin::Configure()
|
SO SA
|
M
|
2
|
ISLE_UtilFactory
|
input argument to ISLE_SEAdmin::Configure()
|
SU SA
|
M
|
3
|
ISLE_Reporter
|
input argument to ISLE_SEAdmin::Configure()
|
SA
|
M
|
|
ISLE_ServiceInform
|
input argument to ISLE_SIFactory::CreateServiceInstance()
|
SA
|
M
|
|
ISLE_AssocFactory
|
call to ISLE_ProxyAdmin::QueryInterface()
|
PX
|
M
|
4
|
ISLE_SrvProxyInitiate
|
a) output argument of ISLE_AssocFactory::CreateAssociation()
b) input argument to ISLE_Locator::LocateInstance()
|
PX
|
M
|
5
|
ISLE_EventMonitor
|
input argument to ISLE_Sequential::StartSequential()
|
SA
|
C
|
8
|
ISLE_TimerHandler
|
input argument to ISLE_Sequential::StartSequential()
|
SA
|
C
|
8
|
ISLE_Trace
|
input argument to ISLE_TraceControl::StartTrace()
|
SA
|
O
|
|
ISLE_Concurrent
|
call to ISLE_ProxyAdmin::QueryInterface()
|
PX
|
C
|
4 6
|
ISLE_Sequential
|
call to ISLE_ProxyAdmin::QueryInterface()
|
PX
|
C
|
4 6
|
ISLE_TraceControl
|
a) call to ISLE_ProxyAdmin::QueryInterface()
b) call to ISLE_SrvProxyInitiate::QueryInterface()
|
PX
|
O
|
4 7
|
interfaces of operation objects
|
a) input argument of one of the methods in ISLE_SrvProxyInform;
b) input argument to ISLE_Locator::LocateInstance();
c) input argument of one of the methods in ISLE_ServiceInitiate;
d) call to ISLE_OperationFactory.
|
PX SA SO
|
M
|
9
|
interfaces of utility objects
|
a) passed by methods of other interfaces;
b) call to ISLE_UtilFactory.
|
|
M
|
10
|
NOTES
-
The interface is passed by the application but is actually supplied by the component API Proxy.
-
The interface is passed by the application but is actually supplied by the component SLE Operations.
-
The interface is passed by the application but is actually supplied by the component SLE Utilities.
-
The interface can also be obtained by a call to QueryInterface() on any other interface exported by the same component object.
-
Method a) is used for associations in the initiator role; method b) applies to associations in the responder role.
-
The interface is needed for control of the proxies linked to the service element.
-
The interface is needed to forward trace requests to the proxies linked to the service element. An interface is required for the API Proxy (method a)) and for every association to support tracing of individual service instances (method b)).
-
The interface is only needed in combination with ISLE_Sequential.
-
Operation objects might be passed by the application or the proxy; they are actually implemented by the component SLE Operations.
-
Utility objects can be passed to the service element by various methods; they are implemented by the component SLE Utilities.
-
SLE Operations
-
Exported Interfaces
Interface
|
Clients
|
A
|
N
|
ISLE_OperationFactory
|
SE and PX
|
M
|
|
interfaces of operation objects
|
SA, SE and PX
|
M
|
| -
Required Interfaces
Interface
|
Interface reference obtained by
|
S
|
A
|
N
|
ISLE_UtilFactory
|
input argument to the bootstrap creator function _CreateOperationFactory()
|
SA SU
|
M
|
1
|
ISLE_Reporter
|
optional input argument to the bootstrap creator function _CreateOperationFactory
|
SA
|
O
|
2
|
interfaces of utility objects
|
call to ISLE_UtilFactory
|
SU
|
M
|
|
NOTES
-
The interface is passed by the application but is actually supplied by the component SLE Utilities.
-
Supply of the interface by the application is optional; i.e., the corresponding argument can be set to NULL. If supplied, implementation may use the interface to report errors and inconsistencies in the attributes of operation objects.
-
SLE Utilities
-
Exported Interfaces
Interface
|
Clients
|
A
|
N
|
ISLE_UtilFactory
|
SA, SE, PX and SO
|
M
|
|
interfaces of utility objects
|
SA, SE, PX and SO
|
M
|
| -
Required Interfaces
Interface
|
Interface reference obtained by
|
S
|
A
|
N
|
ISLE_TimeSource
|
input argument to the bootstrap creator function _CreateUtilFactory()
|
SA
|
O
|
|
Share with your friends: |
