com.exalead.papi.helper

Class PushAPIFactory

java.lang.Object

com.exalead.papi.helper.PushAPIFactory

public class PushAPIFactory
extends java.lang.Object

Factory for creating push clients. Given the protocol supported by the push server, this factory will create the appropriate push client.

The created push client can be used in a multi-threaded context.

Field Summary

Fields

Modifier and Type	Field and Description
static FactoryImpl	impl

Constructor Summary

Constructors

Constructor and Description
PushAPIFactory()

Method Summary

Modifier and Type	Method and Description
static PushAPI	createHttp(PushAPIVersion version, java.lang.String host, java.lang.String port, java.lang.String connectorName, java.lang.String connectorType, java.lang.String login, java.lang.String password) Create a new push client instance.
static PushAPI	createHttp(PushAPIVersion version, java.lang.String host, java.lang.String port, java.lang.String connectorName, java.lang.String connectorType, java.lang.String login, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> extraParameters) Create a new push client instance.
static PushAPI	createHttp(java.lang.String host, java.lang.String port, java.lang.String connectorName, java.lang.String connectorType, java.lang.String login, java.lang.String password) Deprecated.
static PushAPI	createHttp(java.lang.String version, java.lang.String host, java.lang.String port, java.lang.String connectorName, java.lang.String connectorType, java.lang.String login, java.lang.String password) Create a new push client instance.
static PushAPI	createHttp(java.lang.String version, java.lang.String host, java.lang.String port, java.lang.String connectorName, java.lang.String connectorType, java.lang.String login, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> extraParameters) Create a new push client instance.
static PushAPI	createHttps(PushAPIVersion version, java.lang.String host, java.lang.String port, java.lang.String connectorName, java.lang.String connectorType, java.lang.String login, java.lang.String password) Create a new push client instance via HTTPS.
static PushAPI	createHttps(PushAPIVersion version, java.lang.String host, java.lang.String port, java.lang.String connectorName, java.lang.String connectorType, java.lang.String login, java.lang.String password, java.util.Map<java.lang.String,java.lang.String> extraParameters) Create a new push client instance via HTTPS.
static EndpointBuilder<PushAPI>	endpointBuilder() Builder to generate instances of end-point PushAPI.
static void	resetFactoryImpl() Reset the class instance implementing the factory behaviour to default impl.
static void	setFactoryImpl(FactoryImpl _impl) Set the class instance implementing the factory behaviour.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

impl

public static FactoryImpl impl

Constructor Detail

PushAPIFactory

public PushAPIFactory()

Method Detail

endpointBuilder

public static final EndpointBuilder<PushAPI> endpointBuilder()

Builder to generate instances of end-point PushAPI. Uses the default factory, which can be changed.

See Also:

resetFactoryImpl(), setFactoryImpl(FactoryImpl)

createHttp

public static PushAPI createHttp(PushAPIVersion version,
                                 java.lang.String host,
                                 java.lang.String port,
                                 java.lang.String connectorName,
                                 java.lang.String connectorType,
                                 java.lang.String login,
                                 java.lang.String password)
                          throws PushAPIException

Create a new push client instance.

Parameters:

version - the PushAPI version. Currently supported versions are PushAPIVersion.PAPI_V4 ("v4") and PushAPIVersion.PAPI_V2 ("v2")

host - the host name of the push server.

port - the port number of the push server.

connectorName - the name of the connector to be used. For more information on connectors, refer to the EXALEAD CloudView Connectors Guide.

connectorType - the type of the connector to be used (mainly used for license checking purpose; the available connector types are described in your product's license).

login - identification login to be used if the target connector is secured.

password - password associated with the identification login.

Returns:

an new push client instance.

Throws:

PushAPIException - upon error.

createHttp

public static PushAPI createHttp(PushAPIVersion version,
                                 java.lang.String host,
                                 java.lang.String port,
                                 java.lang.String connectorName,
                                 java.lang.String connectorType,
                                 java.lang.String login,
                                 java.lang.String password,
                                 java.util.Map<java.lang.String,java.lang.String> extraParameters)
                          throws PushAPIException

Create a new push client instance.

Parameters:

version - the PushAPI version. Currently supported versions are PushAPIVersion.PAPI_V4 ("v4") and PushAPIVersion.PAPI_V2 ("v2")

host - the host name of the push server.

port - the port number of the push server.

connectorName - the name of the connector to be used. For more information on connectors, refer to the EXALEAD CloudView Connectors Guide.

connectorType - the type of the connector to be used (mainly used for license checking purpose; the available connector types are described in your product's license).

login - identification login to be used if the target connector is secured.

password - password associated with the identification login.

extraParameters - extra http parameters.

Returns:

an new push client instance.

Throws:

PushAPIException - upon error.

createHttps

public static PushAPI createHttps(PushAPIVersion version,
                                  java.lang.String host,
                                  java.lang.String port,
                                  java.lang.String connectorName,
                                  java.lang.String connectorType,
                                  java.lang.String login,
                                  java.lang.String password)
                           throws PushAPIException

Create a new push client instance via HTTPS.

Parameters:

version - the PushAPI version. Currently supported versions are PushAPIVersion.PAPI_V4 ("v4") and PushAPIVersion.PAPI_V2 ("v2")

host - the host name of the push server.

port - the port number of the push server.

connectorName - the name of the connector to be used. For more information on connectors, refer to the EXALEAD CloudView Connectors Guide.

connectorType - the type of the connector to be used (mainly used for license checking purpose; the available connector types are described in your product's license).

login - identification login to be used if the target connector is secured.

password - password associated with the identification login.

Returns:

an new push client instance.

Throws:

PushAPIException - upon error.

createHttps

public static PushAPI createHttps(PushAPIVersion version,
                                  java.lang.String host,
                                  java.lang.String port,
                                  java.lang.String connectorName,
                                  java.lang.String connectorType,
                                  java.lang.String login,
                                  java.lang.String password,
                                  java.util.Map<java.lang.String,java.lang.String> extraParameters)
                           throws PushAPIException

Create a new push client instance via HTTPS.

Parameters:

version - the PushAPI version. Currently supported versions are PushAPIVersion.PAPI_V4 ("v4") and PushAPIVersion.PAPI_V2 ("v2")

host - the host name of the push server.

port - the port number of the push server.

connectorName - the name of the connector to be used. For more information on connectors, refer to the EXALEAD CloudView Connectors Guide.

connectorType - the type of the connector to be used (mainly used for license checking purpose; the available connector types are described in your product's license).

login - identification login to be used if the target connector is secured.

password - password associated with the identification login.

extraParameters - extra http parameters.

Returns:

an new push client instance.

Throws:

PushAPIException - upon error.

createHttp

public static PushAPI createHttp(java.lang.String version,
                                 java.lang.String host,
                                 java.lang.String port,
                                 java.lang.String connectorName,
                                 java.lang.String connectorType,
                                 java.lang.String login,
                                 java.lang.String password)
                          throws PushAPIException

Create a new push client instance.

Parameters:

version - the PushAPI version, as string. Currently supported versions are "4" ("v4") and "2" ("v2")

host - the host name of the push server.

port - the port number of the push server.

connectorName - the name of the connector to be used. For more information on connectors, refer to the EXALEAD CloudView Connectors Guide.

connectorType - the type of the connector to be used (mainly used for license checking purpose; the available connector types are described in your product's license).

login - identification login to be used if the target connector is secured.

password - password associated with the identification login.

Returns:

an new push client instance.

Throws:

PushAPIException - upon error.

createHttp

public static PushAPI createHttp(java.lang.String version,
                                 java.lang.String host,
                                 java.lang.String port,
                                 java.lang.String connectorName,
                                 java.lang.String connectorType,
                                 java.lang.String login,
                                 java.lang.String password,
                                 java.util.Map<java.lang.String,java.lang.String> extraParameters)
                          throws PushAPIException

Create a new push client instance.

Parameters:

version - the PushAPI version, as string. Currently supported versions are "4" ("v4") and "2" ("v2")

host - the host name of the push server.

port - the port number of the push server.

connectorName - the name of the connector to be used. For more information on connectors, refer to the EXALEAD CloudView Connectors Guide.

connectorType - the type of the connector to be used (mainly used for license checking purpose; the available connector types are described in your product's license).

login - identification login to be used if the target connector is secured.

password - password associated with the identification login.

extraParameters - extra http parameters.

Returns:

an new push client instance.

Throws:

PushAPIException - upon error.

createHttp

@Deprecated
public static PushAPI createHttp(java.lang.String host,
                                             java.lang.String port,
                                             java.lang.String connectorName,
                                             java.lang.String connectorType,
                                             java.lang.String login,
                                             java.lang.String password)
                                      throws PushAPIException

Deprecated.

Create a new push client instance. This method is deprecated, as the version information is guessed dynamically. Use the previous method instead.

Parameters:

host - the host name of the push server.

port - the port number of the push server.

connectorName - the name of the connector to be used. For more information on connectors, refer to the EXALEAD CloudView Connectors Guide.

connectorType - the type of the connector to be used (mainly used for license checking purpose; the available connector types are described in your product's license).

login - identification login to be used if the target connector is secured.

password - password associated with the identification login.

Returns:

an new push client instance.

Throws:

PushAPIException - upon error.

setFactoryImpl

public static void setFactoryImpl(FactoryImpl _impl)

Set the class instance implementing the factory behaviour. Changing the factory implementation can be used for tests in connectors where there are calls to the factory, to use stubs.

resetFactoryImpl

public static void resetFactoryImpl()

Reset the class instance implementing the factory behaviour to default impl.