Conventions to follow
You should follow certain conventions for method interface and method names:
-
The interface should be called
PushAPI
. For example,PushAPI
(Java),IPushAPI
(C#)… -
The
HttpPushAPI
class implementsPushAPI
. The constructor must be in the form:HttpPushAPI(PushAPIVersion version, String host, String port, String connectorName, String connectorType, String login, String password)
-
The
FakePushAPI
class implementsPushAPI
. This class is optional and should be a simulator for test. -
The
PushAPIFactory
class should be implemented to createHttpPushAPI
andFakePushAPI
-
PushAPI createFake()
(optional) -
PushAPI createHttp(PushAPIVersion version, String host, String port, String connectorName, String connectorType, String login, String password)
-
The following description is based on C# naming conventions.
Argument |
Description |
---|---|
|
The Push API server host name. |
|
The Push API server port number (by default,
|
|
The Push API version. For the moment, the only accepted value is
For example,
|
|
The name of the connector. |
|
The type of the connector. It is mainly used for license checking purpose (the available connector types are described in your product license). |
|
The basic authentication login string. If not null, the basic authentication mode will be enabled. |
|
The basic authentication password string. If not null, the basic authentication mode will be enabled. Login and Password must either be both null or not null. |